Merge branch 'split-info-deploy' into 'master'

Split Deploy related information to own class

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

Merged-by: Robert Marshall <[email protected]>
Approved-by: Robert Marshall <[email protected]>
Approved-by: Andrew Patterson <[email protected]>
Reviewed-by: Robert Marshall <[email protected]>
Co-authored-by: Balasankar "Balu" C <[email protected]>

Author: Robert Marshall

lib/gitlab/build/info.rb

@@ -8,12 +8,6 @@
 
 module Build
   class Info
-    DEPLOYER_OS_MAPPING = {
-      'AUTO_DEPLOY_ENVIRONMENT' => 'ubuntu-xenial',
-      'PATCH_DEPLOY_ENVIRONMENT' => 'ubuntu-bionic',
-      'RELEASE_DEPLOY_ENVIRONMENT' => 'ubuntu-focal',
-    }.freeze
-
     class << self
       def gcp_release_bucket
         # All tagged builds are pushed to the release bucket
@@ -34,30 +28,6 @@ def log_level
           'info'
         end
       end
-
-      def deploy_env_key
-        if Build::Check.is_auto_deploy_tag?
-          'AUTO_DEPLOY_ENVIRONMENT'
-        elsif Build::Check.is_rc_tag?
-          'PATCH_DEPLOY_ENVIRONMENT'
-        elsif Build::Check.is_latest_stable_tag?
-          'RELEASE_DEPLOY_ENVIRONMENT'
-        end
-      end
-
-      def deploy_env
-        key = deploy_env_key
-
-        return nil if key.nil?
-
-        env = Gitlab::Util.get_env(key)
-
-        abort "Unable to determine which environment to deploy too, #{key} is empty" unless env
-
-        puts "Ready to send trigger for environment(s): #{env}"
-
-        env
-      end
     end
   end
 end

lib/gitlab/build/info/deploy.rb

@@ -0,0 +1,37 @@
+module Build
+  class Info
+    class Deploy
+      class << self
+        OS_MAPPING = {
+          'AUTO_DEPLOY_ENVIRONMENT' => 'ubuntu-xenial',
+          'PATCH_DEPLOY_ENVIRONMENT' => 'ubuntu-bionic',
+          'RELEASE_DEPLOY_ENVIRONMENT' => 'ubuntu-focal',
+        }.freeze
+
+        def environment_key
+          if Build::Check.is_auto_deploy_tag?
+            'AUTO_DEPLOY_ENVIRONMENT'
+          elsif Build::Check.is_rc_tag?
+            'PATCH_DEPLOY_ENVIRONMENT'
+          elsif Build::Check.is_latest_stable_tag?
+            'RELEASE_DEPLOY_ENVIRONMENT'
+          end
+        end
+
+        def environment
+          key = environment_key
+
+          return nil if key.nil?
+
+          env = Gitlab::Util.get_env(key)
+
+          abort "Unable to determine which environment to deploy too, #{key} is empty" unless env
+
+          puts "Ready to send trigger for environment(s): #{env}"
+
+          env
+        end
+      end
+    end
+  end
+end

lib/gitlab/tasks/gitlab_com.rake

@@ -1,3 +1,4 @@
+require_relative '../build/info/deploy'
 require_relative '../deployer_helper.rb'
 require_relative "../util.rb"
 
@@ -11,10 +12,10 @@ namespace :gitlab_com do
       exit
     end
 
-    deploy_env = Build::Info.deploy_env
+    deploy_env = Build::Info::Deploy.environment
     operating_systems = Build::Info::Package.file_list.map { |path| path.split("/")[1] }.uniq
 
-    unless operating_systems.include?(Build::Info::DEPLOYER_OS_MAPPING[Build::Info.deploy_env_key])
+    unless operating_systems.include?(Build::Info::Deploy::OS_MAPPING[Build::Info::Deploy.environment_key])
       puts "Deployment to #{deploy_env} not to be triggered from this build (#{operating_systems.join(',')})."
       exit
     end

spec/lib/gitlab/build/info/deploy_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'gitlab/build/info/deploy'
+
+RSpec.describe Build::Info::Deploy do
+  before do
+    stub_default_package_version
+    stub_env_var('GITLAB_ALTERNATIVE_REPO', nil)
+    stub_env_var('ALTERNATIVE_PRIVATE_TOKEN', nil)
+  end
+
+  describe '.environment' do
+    before do
+      allow(ENV).to receive(:[]).with('AUTO_DEPLOY_ENVIRONMENT').and_return('ad')
+      allow(ENV).to receive(:[]).with('PATCH_DEPLOY_ENVIRONMENT').and_return('patch')
+      allow(ENV).to receive(:[]).with('RELEASE_DEPLOY_ENVIRONMENT').and_return('r')
+    end
+
+    context 'on auto-deploy tag' do
+      before do
+        allow(Build::Check).to receive(:is_auto_deploy_tag?).and_return(true)
+      end
+      it 'returns the auto-deploy environment' do
+        expect(described_class.environment).to eq('ad')
+      end
+    end
+
+    context 'on RC tag' do
+      before do
+        allow(Build::Check).to receive(:is_auto_deploy_tag?).and_return(false)
+        allow(Build::Check).to receive(:is_rc_tag?).and_return(true)
+      end
+      it 'returns the patch-deploy environment' do
+        expect(described_class.environment).to eq('patch')
+      end
+    end
+
+    context 'on latest tag' do
+      before do
+        allow(Build::Check).to receive(:is_auto_deploy_tag?).and_return(false)
+        allow(Build::Check).to receive(:is_rc_tag?).and_return(false)
+        allow(Build::Check).to receive(:is_latest_stable_tag?).and_return(true)
+      end
+      it 'returns the release-deploy environment' do
+        expect(described_class.environment).to eq('r')
+      end
+    end
+
+    context 'when unable to determine the desired env' do
+      before do
+        allow(Build::Check).to receive(:is_auto_deploy_tag?).and_return(false)
+        allow(Build::Check).to receive(:is_rc_tag?).and_return(false)
+        allow(Build::Check).to receive(:is_latest_stable_tag?).and_return(false)
+      end
+      it 'it returns nil' do
+        expect(described_class.environment).to eq(nil)
+      end
+    end
+  end
+end

spec/lib/gitlab/build/info_spec.rb

@@ -9,55 +9,6 @@
     stub_env_var('ALTERNATIVE_PRIVATE_TOKEN', nil)
   end
 
-  describe '.deploy_env' do
-    before do
-      allow(ENV).to receive(:[]).with('AUTO_DEPLOY_ENVIRONMENT').and_return('ad')
-      allow(ENV).to receive(:[]).with('PATCH_DEPLOY_ENVIRONMENT').and_return('patch')
-      allow(ENV).to receive(:[]).with('RELEASE_DEPLOY_ENVIRONMENT').and_return('r')
-    end
-
-    context 'on auto-deploy tag' do
-      before do
-        allow(Build::Check).to receive(:is_auto_deploy_tag?).and_return(true)
-      end
-      it 'returns the auto-deploy environment' do
-        expect(described_class.deploy_env).to eq('ad')
-      end
-    end
-
-    context 'on RC tag' do
-      before do
-        allow(Build::Check).to receive(:is_auto_deploy_tag?).and_return(false)
-        allow(Build::Check).to receive(:is_rc_tag?).and_return(true)
-      end
-      it 'returns the auto-deploy environment' do
-        expect(described_class.deploy_env).to eq('patch')
-      end
-    end
-
-    context 'on latest tag' do
-      before do
-        allow(Build::Check).to receive(:is_auto_deploy_tag?).and_return(false)
-        allow(Build::Check).to receive(:is_rc_tag?).and_return(false)
-        allow(Build::Check).to receive(:is_latest_stable_tag?).and_return(true)
-      end
-      it 'returns the auto-deploy environment' do
-        expect(described_class.deploy_env).to eq('r')
-      end
-    end
-
-    context 'when unable to determine the desired env' do
-      before do
-        allow(Build::Check).to receive(:is_auto_deploy_tag?).and_return(false)
-        allow(Build::Check).to receive(:is_rc_tag?).and_return(false)
-        allow(Build::Check).to receive(:is_latest_stable_tag?).and_return(false)
-      end
-      it 'it returns nil' do
-        expect(described_class.deploy_env).to eq(nil)
-      end
-    end
-  end
-
   describe '.gcp_release_bucket' do
     it 'returns the release bucket when on a tag' do
       allow(Build::Check).to receive(:on_tag?).and_return(true)