Merge branch '396474-geo-add-silent-mode-option-to-promotion-command' into 'master'

Add Silent mode option to Geo promotion command

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

Merged-by: Balasankar 'Balu' C <[email protected]>
Approved-by: Andrew Patterson <[email protected]>
Approved-by: Balasankar 'Balu' C <[email protected]>
Reviewed-by: Balasankar 'Balu' C <[email protected]>
Co-authored-by: Douglas Barbosa Alexandre <[email protected]>

Author: balasankarc

files/gitlab-ctl-commands-ee/lib/geo.rb

@@ -45,6 +45,10 @@ def self.parse_options(args)
           Utils.warn_and_exit opts
         end
 
+        opts.on('--enable-silent-mode', 'Enable GitLab Silent Mode') do |e|
+          options[:enable_silent_mode] = e
+        end
+
         opts.on('-f', '--force', 'Proceed with no confirmation') do |f|
           options[:force] = f
         end

files/gitlab-ctl-commands-ee/lib/geo/promote.rb

@@ -164,7 +164,7 @@ def promote_to_primary
       log('Detected an application node.')
 
       unless progress_message('Promoting secondary site to primary site') do
-        !run_task('geo:set_secondary_as_primary').error?
+        !run_task('geo:set_secondary_as_primary', env: { ENABLE_SILENT_MODE: options[:enable_silent_mode].to_s }).error?
       end
         die("Unable to promote secondary site to primary site.")
       end
@@ -305,16 +305,16 @@ def attributes
       @attributes ||= GitlabCtl::Util.get_node_attributes(base_path)
     end
 
-    def run_command(cmd, live: true)
-      GitlabCtl::Util.run_command(cmd, live: live)
+    def run_command(cmd, live: true, env: {})
+      GitlabCtl::Util.run_command(cmd, live: live, env: env)
     end
 
-    def run_query(query, live: false)
-      run_command("#{base_path}/bin/gitlab-psql -c \"#{query}\" -q -t", live: live)
+    def run_query(query, live: false, env: {})
+      run_command("#{base_path}/bin/gitlab-psql -c \"#{query}\" -q -t", live: live, env: env)
     end
 
-    def run_task(task, live: true)
-      run_command("#{base_path}/bin/gitlab-rake #{task}", live: live)
+    def run_task(task, live: true, env: {})
+      run_command("#{base_path}/bin/gitlab-rake #{task}", live: live, env: env)
     end
 
     def sv_progress(action, service)

files/gitlab-ctl-commands/lib/gitlab_ctl/util.rb

@@ -23,9 +23,9 @@ def get_command_output(command, user = nil, timeout = nil)
         shell_out.stdout
       end
 
-      def run_command(command, live: false, user: nil, timeout: nil)
+      def run_command(command, live: false, user: nil, timeout: nil, env: {})
         timeout = Mixlib::ShellOut::DEFAULT_READ_TIMEOUT if timeout.nil?
-        shell_out = Mixlib::ShellOut.new(command, timeout: timeout)
+        shell_out = Mixlib::ShellOut.new(command, timeout: timeout, environment: env)
         shell_out.user = user unless user.nil?
         shell_out.live_stdout = $stdout if live
         shell_out.live_stderr = $stderr if live

spec/chef/gitlab-ctl-commands-ee/geo_spec.rb

@@ -11,11 +11,11 @@
   commands = %w(promote)
 
   command_lines = {
-    'promote' => []
+    'promote' => ['--enable-silent-mode']
   }
 
   command_options = {
-    'promote' => {}
+    'promote' => { enable_silent_mode: true }
   }
 
   describe '.parse_options' do

spec/chef/gitlab-ctl-commands-ee/lib/geo/promote_spec.rb

@@ -81,7 +81,9 @@
             allow(command).to receive(:run_reconfigure)
             allow(command).to receive(:restart_services)
 
-            expect(command).not_to receive(:run_command).with("#{base_path}/bin/gitlab-rake geo:set_secondary_as_primary", live: true)
+            expect(command)
+              .not_to receive(:run_command)
+              .with("#{base_path}/bin/gitlab-rake geo:set_secondary_as_primary", live: true, env: {})
 
             command.execute
           end
@@ -96,15 +98,39 @@
           it 'promotes the secondary site to primary site' do
             allow(command).to receive(:restart_services)
 
-            expect(command).to receive(:run_command).with("#{base_path}/bin/gitlab-rake geo:set_secondary_as_primary", live: true).once.and_return(double(error?: false))
+            expect(command)
+              .to receive(:run_command)
+              .with("#{base_path}/bin/gitlab-rake geo:set_secondary_as_primary", { live: true, env: an_instance_of(Hash) })
+              .once
+              .and_return(double(error?: false))
 
             command.execute
           end
 
+          context 'with enable_silent_mode option set' do
+            let(:options) { { enable_silent_mode: 'true', force: false } }
+
+            it 'calls the underlying rake task with ENABLE_SILENT_MODE env var set' do
+              allow(command).to receive(:restart_services)
+
+              expect(command)
+                .to receive(:run_command)
+                .with("#{base_path}/bin/gitlab-rake geo:set_secondary_as_primary", { live: true, env: a_hash_including(ENABLE_SILENT_MODE: 'true') })
+                .once
+                .and_return(double(error?: false))
+
+              command.execute
+            end
+          end
+
           it 'restarts the puma service' do
             allow(command).to receive(:promote_to_primary)
 
-            expect(ctl).to receive(:run_sv_command_for_service).with('restart', 'puma').once.and_return(double(zero?: true))
+            expect(ctl)
+              .to receive(:run_sv_command_for_service)
+              .with('restart', 'puma')
+              .once
+              .and_return(double(zero?: true))
 
             command.execute
           end
@@ -465,15 +491,24 @@ def stub_service_enabled(service)
     end
 
     def stub_primary_node
-      allow(command).to receive(:run_command).with("#{base_path}/bin/gitlab-rake geo:site:role", live: true).and_return(double(error?: false, stdout: 'primary'))
+      allow(command)
+        .to receive(:run_command)
+        .with("#{base_path}/bin/gitlab-rake geo:site:role", live: true, env: {})
+        .and_return(double(error?: false, stdout: 'primary'))
     end
 
     def stub_secondary_node
-      allow(command).to receive(:run_command).with("#{base_path}/bin/gitlab-rake geo:site:role", live: true).and_return(double(error?: false, stdout: 'secondary'))
+      allow(command)
+        .to receive(:run_command)
+        .with("#{base_path}/bin/gitlab-rake geo:site:role", live: true, env: {})
+        .and_return(double(error?: false, stdout: 'secondary'))
     end
 
     def stub_misconfigured_node
-      allow(command).to receive(:run_command).with("#{base_path}/bin/gitlab-rake geo:site:role", live: true).and_return(double(error?: true, stdout: 'misconfigured'))
+      allow(command)
+        .to receive(:run_command)
+        .with("#{base_path}/bin/gitlab-rake geo:site:role", live: true, env: {})
+        .and_return(double(error?: true, stdout: 'misconfigured'))
     end
 
     def stub_single_server_secondary_site