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

Split Git related information to own class

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

Merged-by: DJ Mountney <[email protected]>
Approved-by: Andrew Patterson <[email protected]>
Approved-by: DJ Mountney <[email protected]>
Co-authored-by: Balasankar "Balu" C <[email protected]>

Author: twk3

lib/gitlab/build/check.rb

@@ -1,4 +1,5 @@
 require_relative "info.rb"
+require_relative "info/git"
 require_relative "../util.rb"
 
 module Build
@@ -46,7 +47,7 @@ def is_auto_deploy?
       end
 
       def is_auto_deploy_tag?
-        AUTO_DEPLOY_TAG_REGEX.match?(Build::Info.current_git_tag)
+        AUTO_DEPLOY_TAG_REGEX.match?(Build::Info::Git.tag_name)
       end
 
       def is_auto_deploy_branch?
@@ -59,19 +60,19 @@ def is_patch_release?
       end
 
       def is_rc_tag?
-        Build::Info.current_git_tag.include?("+rc")
+        Build::Info::Git.tag_name&.include?("+rc")
       end
 
       def ci_commit_tag?
         Gitlab::Util.get_env('CI_COMMIT_TAG')
       end
 
       def is_latest_stable_tag?
-        match_tag?(Info.latest_stable_tag)
+        match_tag?(Info::Git.latest_stable_tag)
       end
 
       def is_latest_tag?
-        match_tag?(Info.latest_tag)
+        match_tag?(Info::Git.latest_tag)
       end
 
       def is_nightly?
@@ -91,11 +92,11 @@ def on_regular_tag?
       end
 
       def on_stable_branch?
-        Build::Info.branch_name&.match?(/^\d+-\d+-stable$/)
+        Build::Info::Git.branch_name&.match?(/^\d+-\d+-stable$/)
       end
 
       def on_regular_branch?
-        Build::Info.branch_name && !on_stable_branch?
+        Build::Info::Git.branch_name && !on_stable_branch?
       end
     end
   end

lib/gitlab/build/facts.rb

@@ -1,3 +1,5 @@
+require_relative 'info/git'
+
 module Build
   class Facts
     class << self
@@ -12,7 +14,7 @@ def generate_tag_files
           :latest_stable_tag,
           :latest_tag
         ].each do |fact|
-          content = Build::Info.send(fact) # rubocop:disable GitlabSecurity/PublicSend
+          content = Build::Info::Git.send(fact) # rubocop:disable GitlabSecurity/PublicSend
           File.write("build_facts/#{fact}", content) unless content.nil?
         end
       end
@@ -74,7 +76,7 @@ def qa_trigger_vars
           QA_IMAGE=#{Build::Info.qa_image}
           QA_TESTS=#{Gitlab::Util.get_env('QA_TESTS')}
           ALLURE_JOB_NAME=#{allure_job_name}-#{Build::Info.edition}
-          GITLAB_SEMVER_VERSION=#{Build::Info.latest_stable_tag.tr('+', '-')}
+          GITLAB_SEMVER_VERSION=#{Build::Info::Git.latest_stable_tag.tr('+', '-')}
           RAT_REFERENCE_ARCHITECTURE=#{Gitlab::Util.get_env('RAT_REFERENCE_ARCHITECTURE') || 'omnibus-gitlab-mrs'}
           RAT_FIPS_REFERENCE_ARCHITECTURE=#{Gitlab::Util.get_env('RAT_FIPS_REFERENCE_ARCHITECTURE') || 'omnibus-gitlab-mrs-fips-ubuntu'}
           RAT_PACKAGE_URL=#{Gitlab::Util.get_env('PACKAGE_URL') || Build::Info::CI.triggered_package_download_url(fips: false)}

lib/gitlab/build/info.rb

@@ -1,5 +1,6 @@
 require 'omnibus'
 
+require_relative 'info/git'
 require_relative '../build_iteration'
 require_relative "../util.rb"
 require_relative './info/ci'
@@ -16,13 +17,6 @@ class Info
     PACKAGE_GLOB = "pkg/**/*.{deb,rpm}".freeze
 
     class << self
-      def fetch_fact_from_file(fact)
-        return unless File.exist?("build_facts/#{fact}")
-
-        content = File.read("build_facts/#{fact}").strip
-        return content unless content.empty?
-      end
-
       def package
         return "gitlab-fips" if Check.use_system_ssl?
         return "gitlab-ee" if Check.is_ee?
@@ -46,86 +40,20 @@ def semver_version
           Omnibus.load_configuration('omnibus.rb')
           Omnibus::BuildVersion.semver
         else
-          latest_git_tag = Info.latest_tag.strip
+          latest_git_tag = Info::Git.latest_tag.strip
           latest_version = latest_git_tag && !latest_git_tag.empty? ? latest_git_tag[0, latest_git_tag.match("[+]").begin(0)] : '0.0.1'
-          commit_sha = Build::Info.commit_sha
+          commit_sha = Build::Info::Git.commit_sha
           ver_tag = "#{latest_version}+" + (Build::Check.is_nightly? ? "rnightly" : "rfbranch")
           ver_tag += ".fips" if Build::Check.use_system_ssl?
           [ver_tag, Gitlab::Util.get_env('CI_PIPELINE_ID'), commit_sha].compact.join('.')
         end
       end
 
-      def branch_name
-        Gitlab::Util.get_env('CI_COMMIT_BRANCH')
-      end
-
-      def commit_sha
-        commit_sha_raw = Gitlab::Util.get_env('CI_COMMIT_SHA') || `git rev-parse HEAD`.strip
-        commit_sha_raw[0, 8]
-      end
-
       def release_version
         semver = Info.semver_version
         "#{semver}-#{Gitlab::BuildIteration.new.build_iteration}"
       end
 
-      def sorted_tags_for_edition
-        `git -c versionsort.prereleaseSuffix=rc tag -l '#{Info.tag_match_pattern}' --sort=-v:refname`.split("\n")
-      end
-
-      # TODO, merge latest_tag with latest_stable_tag
-      # TODO, add tests, needs a repo clone
-      def latest_tag
-        unless (fact_from_file = fetch_fact_from_file(__method__)).nil?
-          return fact_from_file
-        end
-
-        tags = sorted_tags_for_edition
-
-        return if tags.empty?
-
-        version = branch_name.delete_suffix('-stable').tr('-', '.') if Build::Check.on_stable_branch?
-        output = tags.find { |t| t.start_with?(version) } if version
-
-        # If no tags corresponding to the stable branch version was found, we
-        # fall back to the latest available tag
-        output || tags.first
-      end
-
-      def latest_stable_tag(level: 1)
-        unless (fact_from_file = fetch_fact_from_file(__method__)).nil?
-          return fact_from_file
-        end
-
-        # Exclude RC tags so that we only have stable tags.
-        stable_tags = sorted_tags_for_edition.reject { |t| t.include?('rc') }
-
-        return if stable_tags.empty?
-
-        version = branch_name.delete_suffix('-stable').tr('-', '.') if Build::Check.on_stable_branch?
-
-        results = stable_tags.select { |t| t.start_with?(version) } if version
-
-        # If no tags corresponding to the stable branch version was found, we
-        # fall back to the latest available stable tag
-        output = if results.nil? || results.empty?
-                   stable_tags
-                 else
-                   results
-                 end
-
-        # Level decides tag at which position you want. Level one gives you
-        # latest stable tag, two gives you the one just before it and so on.
-        # Since arrays start from 0, we subtract 1 from the specified level to
-        # get the index. If the specified level is more than the number of
-        # tags, we return the last tag.
-        if level >= output.length
-          output.last
-        else
-          output[level - 1]
-        end
-      end
-
       def docker_tag
         Gitlab::Util.get_env('IMAGE_TAG') || Info.release_version.tr('+', '-')
       end
@@ -162,12 +90,6 @@ def gitlab_rails_ref(prepend_version: true)
         Gitlab::Version.new('gitlab-rails').print(prepend_version)
       end
 
-      def previous_version
-        # Get the second latest git tag
-        previous_tag = Info.latest_stable_tag(level: 2)
-        previous_tag.tr("+", "-")
-      end
-
       def gitlab_rails_project_path
         if Gitlab::Util.get_env('CI_SERVER_HOST') == 'dev.gitlab.org'
           package == "gitlab-ee" ? 'gitlab/gitlab-ee' : 'gitlab/gitlabhq'
@@ -243,12 +165,6 @@ def ami_deb_package_download_url(arch: 'amd64')
         "https://#{Info.release_bucket}.#{Info.release_bucket_s3_endpoint}/#{folder}/#{Info.package}_#{package_filename_url_safe}_#{arch}.deb"
       end
 
-      def tag_match_pattern
-        return '*[+.]ee.*' if Check.is_ee?
-
-        '*[+.]ce.*'
-      end
-
       def release_file_contents
         repo = Gitlab::Util.get_env('PACKAGECLOUD_REPO') # Target repository
 
@@ -269,10 +185,6 @@ def release_file_contents
         contents.join
       end
 
-      def current_git_tag
-        `git describe --exact-match 2>/dev/null`.chomp
-      end
-
       def image_reference
         "#{Build::GitlabImage.gitlab_registry_image_address}:#{Info.docker_tag}"
       end

lib/gitlab/build/info/git.rb

@@ -0,0 +1,104 @@
+require_relative '../../util'
+require_relative '../check'
+require_relative 'ci'
+
+module Build
+  class Info
+    class Git
+      class << self
+        def branch_name
+          # If on CI, branch name from `CI_COMMIT_BRANCH` wins
+          result = Build::Info::CI.branch_name
+
+          return result if result
+
+          # If not on CI, attempt to detect branch name
+          head_reference = Gitlab::Util.shellout_stdout('git rev-parse --abbrev-ref HEAD')
+
+          # On tags, the shell command will return `HEAD`. If that is not the
+          # case, we are on a branch and can return the output we received.
+          return head_reference unless head_reference == "HEAD"
+        end
+
+        def tag_name
+          Build::Info::CI.tag_name || Gitlab::Util.shellout_stdout('git describe --tags --exact-match')
+        rescue Gitlab::Util::ShellOutExecutionError => e
+          return nil if /fatal: no tag exactly matches/.match?(e.stderr)
+
+          raise "#{e.message}\nSTDOUT: #{e.stdout}\nSTDERR: #{e.stderr}"
+        end
+
+        def commit_sha
+          commit_sha_raw = Gitlab::Util.get_env('CI_COMMIT_SHA') || Gitlab::Util.shellout_stdout('git rev-parse HEAD')
+
+          commit_sha_raw[0, 8]
+        end
+
+        # TODO, merge latest_tag with latest_stable_tag
+        # TODO, add tests, needs a repo clone
+        def latest_tag
+          unless (fact_from_file = Gitlab::Util.fetch_fact_from_file(__method__)).nil?
+            return fact_from_file
+          end
+
+          tags = sorted_tags_for_edition
+
+          return if tags.empty?
+
+          version = branch_name.delete_suffix('-stable').tr('-', '.') if Build::Check.on_stable_branch?
+          output = tags.find { |t| t.start_with?(version) } if version
+
+          # If no tags corresponding to the stable branch version was found, we
+          # fall back to the latest available tag
+          output || tags.first
+        end
+
+        def latest_stable_tag(level: 1)
+          unless (fact_from_file = Gitlab::Util.fetch_fact_from_file(__method__)).nil?
+            return fact_from_file
+          end
+
+          # Exclude RC tags so that we only have stable tags.
+          stable_tags = sorted_tags_for_edition.reject { |t| t.include?('rc') }
+
+          return if stable_tags.empty?
+
+          version = branch_name.delete_suffix('-stable').tr('-', '.') if Build::Check.on_stable_branch?
+
+          results = stable_tags.select { |t| t.start_with?(version) } if version
+
+          # If no tags corresponding to the stable branch version was found, we
+          # fall back to the latest available stable tag
+          output = if results.nil? || results.empty?
+                     stable_tags
+                   else
+                     results
+                   end
+
+          # Level decides tag at which position you want. Level one gives you
+          # latest stable tag, two gives you the one just before it and so on.
+          # Since arrays start from 0, we subtract 1 from the specified level to
+          # get the index. If the specified level is more than the number of
+          # tags, we return the last tag.
+          if level >= output.length
+            output.last
+          else
+            output[level - 1]
+          end
+        end
+
+        private
+
+        def sorted_tags_for_edition
+          Gitlab::Util.shellout_stdout("git -c versionsort.prereleaseSuffix=rc tag -l '#{tag_match_pattern}' --sort=-v:refname")&.split("\n")
+        end
+
+        def tag_match_pattern
+          return '*[+.]ee.*' if Build::Check.is_ee?
+
+          '*[+.]ce.*'
+        end
+      end
+    end
+  end
+end

lib/gitlab/tasks/build.rake

@@ -2,6 +2,7 @@ require 'fileutils'
 require_relative "../build.rb"
 require_relative "../build/check.rb"
 require_relative "../build/info.rb"
+require_relative "../build/info/git"
 require_relative '../build/facts'
 require_relative "../gcloud_helper.rb"
 require_relative "../ohai_helper.rb"
@@ -27,12 +28,12 @@ namespace :build do
   namespace :docker do
     desc 'Show latest available tag. Includes unstable releases.'
     task :latest_tag do
-      puts Build::Info.latest_tag
+      puts Build::Info::Git.latest_tag
     end
 
     desc 'Show latest stable tag.'
     task :latest_stable_tag do
-      puts Build::Info.latest_stable_tag
+      puts Build::Info::Git.latest_stable_tag
     end
   end
 

lib/gitlab/tasks/qa.rake

@@ -3,6 +3,7 @@ require_relative '../docker_operations'
 require_relative '../build/qa'
 require_relative '../build/check'
 require_relative '../build/info'
+require_relative "../build/info/git"
 require_relative '../build/gitlab_image'
 require_relative '../build/qa_image'
 require_relative '../build/rat'
@@ -64,7 +65,7 @@ namespace :qa do
     task :staging do
       Gitlab::Util.section('qa:push:staging') do
         Build::QAImage.tag_and_push_to_gitlab_registry(Build::Info.gitlab_version)
-        Build::QAImage.tag_and_push_to_gitlab_registry(Build::Info.commit_sha)
+        Build::QAImage.tag_and_push_to_gitlab_registry(Build::Info::Git.commit_sha)
       end
     end