Merge branch 'support-local-gems' into 'master'

Support loading of locally installed gems

See merge request https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/7101

Merged-by: Daniel Duvall <dan@mutual.io>
Co-authored-by: Dan Duvall <dduvall@wikimedia.org>

config/software/registry.rb

@@ -19,7 +19,7 @@
 require "#{Omnibus::Config.project_root}/lib/gitlab/version"
 
 name 'registry'
-version = Gitlab::Version.new('registry', 'v3.93.0-gitlab')
+version = Gitlab::Version.new('registry', 'v4.0.0-gitlab')
 
 default_version version.print(false)
 display_version version.print(false).delete_suffix('-gitlab')

files/gitlab-config-template/gitlab.rb.template

@@ -609,6 +609,15 @@ external_url 'GENERATED_EXTERNAL_URL'
 # gitlab_rails['duo_auth_secret_key'] = 'duo_auth_secret_key'
 # gitlab_rails['duo_auth_hostname'] = 'duo_auth.example.com'
 
+### Additional gems to load during initialization
+###! Note, all gems must be present in the given path already, for example
+###  using `bundle install` or some other means. Nothing will be installed
+###  from external sources by gitlab-ctl.
+###! Docs (TODO): https://docs.gitlab.com/omnibus/settings/gems.html
+# gitlab_rails['gems'] = {
+#   '/opt/local/gitlab/gems' => ['some_gem_name'],
+# }
+
 ### Backup Settings
 ###! Docs: https://docs.gitlab.com/omnibus/settings/backups.html
 

files/gitlab-cookbooks/gitlab/recipes/gitlab-rails.rb

@@ -31,6 +31,8 @@ gitlab_rails_working_dir = File.join(gitlab_rails_dir, "working")
 gitlab_rails_tmp_dir = File.join(gitlab_rails_dir, "tmp")
 gitlab_rails_public_uploads_dir = node['gitlab']['gitlab_rails']['uploads_directory']
 gitlab_rails_uploads_storage_path = node['gitlab']['gitlab_rails']['uploads_storage_path']
+gitlab_rails_gemfile = GitlabRailsEnvHelper.bundle_gemfile(gitlab_rails_source_dir)
+gitlab_rails_gemfile_local = File.join(gitlab_rails_source_dir, "Gemfile.local")
 gitlab_ci_dir = node['gitlab']['gitlab_ci']['dir']
 gitlab_ci_builds_dir = node['gitlab']['gitlab_ci']['builds_directory']
 gitlab_rails_shared_tmp_dir = File.join(node['gitlab']['gitlab_rails']['shared_path'], 'tmp')
@@ -487,11 +489,47 @@ end
 
 gitlab_relative_url = node['gitlab']['gitlab_rails']['gitlab_relative_url']
 rails_env['RAILS_RELATIVE_URL_ROOT'] = gitlab_relative_url if gitlab_relative_url
-
-rails_env['BUNDLE_GEMFILE'] = GitlabRailsEnvHelper.bundle_gemfile(gitlab_rails_source_dir)
-
 rails_env['PUMA_WORKER_MAX_MEMORY'] = node['gitlab']['puma']['per_worker_max_memory_mb']
 
+if node['gitlab']['gitlab_rails'].include?('gems')
+  # Additional gems are configured. Create a Gemfile.local that wraps the
+  # original Gemfile and includes local gems
+  template "Creating Gemfile.local for local gems" do
+    path gitlab_rails_gemfile_local
+    source "gemfile.local.erb"
+    variables node['gitlab']['gitlab_rails'].to_hash.merge(gemfile: gitlab_rails_gemfile)
+    notifies :run, "bash[Update Gemfile.local.lock]", :immediately
+  end
+
+  bash "Update Gemfile.local.lock" do
+    cwd File.dirname(gitlab_rails_gemfile_local)
+    code <<~CODE
+      cp #{gitlab_rails_gemfile.inspect}.lock Gemfile.local.lock
+      /opt/gitlab/embedded/bin/bundle lock --local
+    CODE
+    environment(
+      {
+        BUNDLE_IGNORE_CONFIG: "1", # this is necessary to bypass the frozen state
+        BUNDLE_GEMFILE: gitlab_rails_gemfile_local,
+      }
+    )
+    action :nothing
+    dependent_services.each { |svc| notifies :restart, svc }
+  end
+
+  rails_env['BUNDLE_GEMFILE'] = gitlab_rails_gemfile_local
+else
+  file gitlab_rails_gemfile_local do
+    action :delete
+  end
+
+  file "#{gitlab_rails_gemfile_local}.lock" do
+    action :delete
+  end
+
+  rails_env['BUNDLE_GEMFILE'] = gitlab_rails_gemfile
+end
+
 env_dir File.join(gitlab_rails_static_etc_dir, 'env') do
   variables(
     rails_env.merge(node['gitlab']['gitlab_rails']['env'])

files/gitlab-cookbooks/gitlab/templates/default/gemfile.local.erb

@@ -0,0 +1,13 @@
+# This file is managed by gitlab-ctl. Manual changes will be
+# erased! To change the contents below, edit /etc/gitlab/gitlab.rb
+# and run `sudo gitlab-ctl reconfigure`.
+
+eval_gemfile(<%= @gemfile.inspect %>)
+
+<% @gems.each do |path, gems| %>
+path <%= path.inspect %> do
+  <%- gems.each do |gem| %>
+  gem <%= gem.inspect %>
+  <%- end %>
+end
+<% end %>