Merge branch '8117-no-restart-for-stopped-service' into 'master'

Do not restart gitlab-kas service if stopped

Closes #8117

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

Merged-by: Balasankar 'Balu' C <[email protected]>
Approved-by: Balasankar 'Balu' C <[email protected]>
Approved-by: João Alexandre Cunha <[email protected]>
Co-authored-by: Andrew Patterson <[email protected]>
Co-authored-by: DJ Mountney <[email protected]>

Author: 3 people

files/gitlab-cookbooks/gitlab-kas/recipes/enable.rb

@@ -79,31 +79,31 @@
 version_file 'Create version file for Gitlab KAS' do
   version_file_path File.join(working_dir, 'VERSION')
   version_check_cmd '/opt/gitlab/embedded/bin/gitlab-kas --version'
-  notifies :restart, 'runit_service[gitlab-kas]'
+  notifies :restart, 'runit_service[gitlab-kas]' if omnibus_helper.should_notify?('gitlab-kas')
 end
 
 file gitlab_kas_authentication_secret_file do
   content node['gitlab_kas']['api_secret_key']
   owner 'root'
   group account_helper.gitlab_group
   mode '0640'
-  notifies :restart, 'runit_service[gitlab-kas]'
+  notifies :restart, 'runit_service[gitlab-kas]' if omnibus_helper.should_notify?('gitlab-kas')
 end
 
 file gitlab_kas_private_api_authentication_secret_file do
   content node['gitlab_kas']['private_api_secret_key']
   owner 'root'
   group account_helper.gitlab_group
   mode '0640'
-  notifies :restart, 'runit_service[gitlab-kas]'
+  notifies :restart, 'runit_service[gitlab-kas]' if omnibus_helper.should_notify?('gitlab-kas')
 end
 
 file gitlab_kas_redis_password_file do
   content redis_password
   owner 'root'
   group account_helper.gitlab_group
   mode '0640'
-  notifies :restart, 'runit_service[gitlab-kas]'
+  notifies :restart, 'runit_service[gitlab-kas]' if omnibus_helper.should_notify?('gitlab-kas')
   only_if { redis_password_present }
   sensitive true
 end
@@ -113,7 +113,7 @@
   owner 'root'
   group account_helper.gitlab_group
   mode '0640'
-  notifies :restart, 'runit_service[gitlab-kas]'
+  notifies :restart, 'runit_service[gitlab-kas]' if omnibus_helper.should_notify?('gitlab-kas')
   only_if { redis_sentinels_password_present }
   sensitive true
 end
@@ -137,7 +137,7 @@
       redis_sentinels_password_file: redis_sentinels_password_present ? gitlab_kas_redis_sentinels_password_file : nil
     )
   )
-  notifies :restart, 'runit_service[gitlab-kas]'
+  notifies :restart, 'runit_service[gitlab-kas]' if omnibus_helper.should_notify?('gitlab-kas')
 end
 
 env_dir env_directory do

spec/chef/cookbooks/gitlab-kas/recipes/gitlab-kas_spec.rb

@@ -24,6 +24,8 @@
     end
 
     it 'creates a default VERSION file and restarts service' do
+      allow_any_instance_of(OmnibusHelper).to receive(:should_notify?).and_call_original
+      allow_any_instance_of(OmnibusHelper).to receive(:should_notify?).with('gitlab-kas').and_return(true)
       expect(chef_run).to create_version_file('Create version file for Gitlab KAS').with(
         version_file_path: '/var/opt/gitlab/gitlab-kas/VERSION',
         version_check_cmd: '/opt/gitlab/embedded/bin/gitlab-kas --version'
@@ -32,6 +34,17 @@
       expect(chef_run.version_file('Create version file for Gitlab KAS')).to notify('runit_service[gitlab-kas]').to(:restart)
     end
 
+    it 'creates a default VERSION file and does not restart the service if stopped' do
+      allow_any_instance_of(OmnibusHelper).to receive(:should_notify?).and_call_original
+      allow_any_instance_of(OmnibusHelper).to receive(:should_notify?).with('gitlab-kas').and_return(false)
+      expect(chef_run).to create_version_file('Create version file for Gitlab KAS').with(
+        version_file_path: '/var/opt/gitlab/gitlab-kas/VERSION',
+        version_check_cmd: '/opt/gitlab/embedded/bin/gitlab-kas --version'
+      )
+
+      expect(chef_run.version_file('Create version file for Gitlab KAS')).to_not notify('runit_service[gitlab-kas]').to(:restart)
+    end
+
     it 'correctly renders the KAS service run file' do
       expect(chef_run).to render_file("/opt/gitlab/sv/gitlab-kas/run").with_content(%r{--configuration-file /var/opt/gitlab/gitlab-kas/gitlab-kas-config.yml})
     end
@@ -636,6 +649,45 @@
     end
   end
 
+  describe 'chef_run.file calls' do
+    def files
+      @files ||= %w(
+        /var/opt/gitlab/gitlab-kas/authentication_secret_file
+        /var/opt/gitlab/gitlab-kas/private_api_authentication_secret_file
+        /var/opt/gitlab/gitlab-kas/redis_password_file
+        /var/opt/gitlab/gitlab-kas/redis_sentinels_password_file
+      )
+    end
+
+    before do
+      allow_any_instance_of(OmnibusHelper).to receive(:should_notify?).and_call_original
+    end
+
+    context "when omnibus_helper.should_notify?('gitlab-kas') returns true" do
+      before do
+        allow_any_instance_of(OmnibusHelper).to receive(:should_notify?).with('gitlab-kas').and_return(true)
+      end
+
+      it 'chef_run.file calls notify gitlab-kas to restart' do
+        files.each do |file|
+          expect(chef_run.file(file)).to notify('runit_service[gitlab-kas]').to(:restart)
+        end
+      end
+    end
+
+    context "when omnibus_helper.should_notify?('gitlab-kas') returns false" do
+      before do
+        allow_any_instance_of(OmnibusHelper).to receive(:should_notify?).with('gitlab-kas').and_return(false)
+      end
+
+      it 'chef_run.file calls do not notify gitlab-kas to restart' do
+        files.each do |file|
+          expect(chef_run.file(file)).to_not notify('runit_service[gitlab-kas]').to(:restart)
+        end
+      end
+    end
+  end
+
   def chef_run_load_yaml_template(chef_run, path)
     template = chef_run.template(path)
     file_content = ChefSpec::Renderer.new(chef_run, template).content