fixing tests, extracting git utility to Utils::Git module, fix signat…

…ures
DataDog · Sep 6, 2023 · 7066de3 · 7066de3
1 parent 2487504
commit 7066de3
Show file tree

Hide file tree

Showing 60 changed files with 396 additions and 483 deletions.
diff --git a/lib/datadog/ci/ext/environment.rb b/lib/datadog/ci/ext/environment.rb
@@ -2,6 +2,8 @@
 
 require_relative "git"
 require_relative "environment/extractor"
+require_relative "environment/providers/local_git"
+require_relative "environment/providers/user_defined_tags"
 
 module Datadog
   module CI
@@ -31,11 +33,11 @@ def tags(env)
 
           # If user defined metadata is defined, overwrite
           tags.merge!(
-            Environment::Extractor.new(env, provider: Providers::UserDefinedTags).tags
+            Environment::Extractor.new(env, provider: Providers::UserDefinedTags.new(env)).tags
           )
 
           # Fill out tags from local git as fallback
-          local_git_tags = Environment::Extractor.new(env, provider: Providers::LocalGit).tags
+          local_git_tags = Environment::Extractor.new(env, provider: Providers::LocalGit.new(env)).tags
           local_git_tags.each do |key, value|
             tags[key] ||= value
           end

diff --git a/lib/datadog/ci/ext/environment/extractor.rb b/lib/datadog/ci/ext/environment/extractor.rb
@@ -2,6 +2,7 @@
 
 require_relative "../environment"
 require_relative "../git"
+require_relative "../../utils/git"
 require_relative "providers"
 
 module Datadog
@@ -68,13 +69,13 @@ def tags
 
           def normalize_git!
             branch_ref = @tags[Git::TAG_BRANCH]
-            if is_git_tag?(branch_ref)
+            if Datadog::CI::Utils::Git.is_git_tag?(branch_ref)
               @tags[Git::TAG_TAG] = branch_ref
               @tags.delete(Git::TAG_BRANCH)
             end
 
-            @tags[Git::TAG_TAG] = normalize_ref(@tags[Git::TAG_TAG])
-            @tags[Git::TAG_BRANCH] = normalize_ref(@tags[Git::TAG_BRANCH])
+            @tags[Git::TAG_TAG] = Datadog::CI::Utils::Git.normalize_ref(@tags[Git::TAG_TAG])
+            @tags[Git::TAG_BRANCH] = Datadog::CI::Utils::Git.normalize_ref(@tags[Git::TAG_BRANCH])
             @tags[Git::TAG_REPOSITORY_URL] = filter_sensitive_info(
               @tags[Git::TAG_REPOSITORY_URL]
             )
@@ -88,19 +89,6 @@ def expand_workspace!
             end
           end
 
-          def is_git_tag?(ref)
-            !ref.nil? && ref.include?("tags/")
-          end
-
-          def normalize_ref(name)
-            return nil if name.nil?
-
-            refs = %r{^refs/(heads/)?}
-            origin = %r{^origin/}
-            tags = %r{^tags/}
-            name.gsub(refs, "").gsub(origin, "").gsub(tags, "")
-          end
-
           def filter_sensitive_info(url)
             return nil if url.nil?
 

diff --git a/lib/datadog/ci/ext/environment/providers.rb b/lib/datadog/ci/ext/environment/providers.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "providers/default"
+require_relative "providers/base"
 require_relative "providers/appveyor"
 require_relative "providers/azure"
 require_relative "providers/bitbucket"
@@ -38,7 +38,7 @@ module Providers
 
           def self.for_environment(env)
             _, provider_klass = PROVIDERS.find { |provider_env_var, _| env.key?(provider_env_var) }
-            provider_klass = Providers::Default if provider_klass.nil?
+            provider_klass = Providers::Base if provider_klass.nil?
 
             provider_klass.new(env)
           end

diff --git a/lib/datadog/ci/ext/environment/providers/appveyor.rb b/lib/datadog/ci/ext/environment/providers/appveyor.rb
@@ -10,9 +10,6 @@ module Providers
           # Appveyor: https://www.appveyor.com/
           # Environment variables docs: https://www.appveyor.com/docs/environment-variables/
           class Appveyor < Base
-            private
-
-            # overridden methods
             def provider_name
               "appveyor"
             end
@@ -82,7 +79,7 @@ def git_commit_message
               commit_message
             end
 
-            # appveyor-specific methods
+            private
 
             def github_repo_provider?
               return @github_repo_provider if defined?(@github_repo_provider)

diff --git a/lib/datadog/ci/ext/environment/providers/azure.rb b/lib/datadog/ci/ext/environment/providers/azure.rb
@@ -12,9 +12,6 @@ module Providers
           # Azure Pipelines: https://azure.microsoft.com/en-us/products/devops/pipelines
           # Environment variables docs: https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml
           class Azure < Base
-            private
-
-            # overridden methods
             def provider_name
               "azurepipelines"
             end
@@ -87,7 +84,7 @@ def ci_env_vars
               }.to_json
             end
 
-            # azure-specific methods
+            private
 
             def build_id
               env["BUILD_BUILDID"]

diff --git a/lib/datadog/ci/ext/environment/providers/base.rb b/lib/datadog/ci/ext/environment/providers/base.rb
@@ -90,10 +90,13 @@ def git_commit_message
             def git_commit_sha
             end
 
+            private
+
             def set_branch_and_tag
               branch_or_tag_string = git_branch_or_tag
               @branch = @tag = nil
 
+              # @type var branch_or_tag_string: untyped
               if branch_or_tag_string && branch_or_tag_string.include?("tags/")
                 @tag = branch_or_tag_string
               else

diff --git a/lib/datadog/ci/ext/environment/providers/bitbucket.rb b/lib/datadog/ci/ext/environment/providers/bitbucket.rb
@@ -10,8 +10,6 @@ module Providers
           # Bitbucket Pipelines: https://bitbucket.org/product/features/pipelines
           # Environment variables docs: https://support.atlassian.com/bitbucket-cloud/docs/variables-and-secrets/
           class Bitbucket < Base
-            private
-
             # overridden methods
             def provider_name
               "bitbucket"
@@ -57,7 +55,7 @@ def git_tag
               env["BITBUCKET_TAG"]
             end
 
-            # bitbucket-specific methods
+            private
 
             def url
               "https://bitbucket.org/#{env["BITBUCKET_REPO_FULL_NAME"]}/addon/pipelines/home#" \

diff --git a/lib/datadog/ci/ext/environment/providers/bitrise.rb b/lib/datadog/ci/ext/environment/providers/bitrise.rb
@@ -10,9 +10,6 @@ module Providers
           # Bitrise: https://bitrise.io/
           # Environment variables docs: https://devcenter.bitrise.io/en/references/available-environment-variables.html
           class Bitrise < Base
-            private
-
-            # overridden methods
             def provider_name
               "bitrise"
             end

diff --git a/lib/datadog/ci/ext/environment/providers/buddy.rb b/lib/datadog/ci/ext/environment/providers/buddy.rb
@@ -10,9 +10,6 @@ module Providers
           # Buddy: https://buddy.works/
           # Environment variables docs: https://buddy.works/docs/pipelines/environment-variables
           class Buddy < Base
-            private
-
-            # overridden methods
             def provider_name
               "buddy"
             end

diff --git a/lib/datadog/ci/ext/environment/providers/buildkite.rb b/lib/datadog/ci/ext/environment/providers/buildkite.rb
@@ -12,9 +12,6 @@ module Providers
           # Buildkite: https://buildkite.com/
           # Environment variables docs: https://buildkite.com/docs/pipelines/environment-variables
           class Buildkite < Base
-            private
-
-            # overridden methods
             def provider_name
               "buildkite"
             end

diff --git a/lib/datadog/ci/ext/environment/providers/circleci.rb b/lib/datadog/ci/ext/environment/providers/circleci.rb
@@ -12,9 +12,6 @@ module Providers
           # Circle CI: https://circleci.com/
           # Environment variables docs: https://circleci.com/docs/variables/#built-in-environment-variables
           class Circleci < Base
-            private
-
-            # overridden methods
             def provider_name
               "circleci"
             end

diff --git a/lib/datadog/ci/ext/environment/providers/codefresh.rb b/lib/datadog/ci/ext/environment/providers/codefresh.rb
@@ -12,9 +12,6 @@ module Providers
           # Codefresh: https://codefresh.io/
           # Environment variables docs: https://codefresh.io/docs/docs/pipelines/variables/#export-variables-to-all-steps-with-cf_export
           class Codefresh < Base
-            private
-
-            # overridden methods
             def provider_name
               "codefresh"
             end

diff --git a/lib/datadog/ci/ext/environment/providers/default.rb b/lib/datadog/ci/ext/environment/providers/default.rb
diff --git a/lib/datadog/ci/ext/environment/providers/github_actions.rb b/lib/datadog/ci/ext/environment/providers/github_actions.rb
@@ -12,9 +12,6 @@ module Providers
           # Github Actions: https://github.com/features/actions
           # Environment variables docs: https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
           class GithubActions < Base
-            private
-
-            # overridden methods
             def provider_name
               "github"
             end

diff --git a/lib/datadog/ci/ext/environment/providers/gitlab.rb b/lib/datadog/ci/ext/environment/providers/gitlab.rb
@@ -10,9 +10,6 @@ module Providers
           # Gitlab CI: https://docs.gitlab.com/ee/ci/
           # Environment variables docs: https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
           class Gitlab < Base
-            private
-
-            # overridden methods
             def provider_name
               "gitlab"
             end
@@ -99,7 +96,7 @@ def ci_env_vars
               }.to_json
             end
 
-            # gitlab-specific methods
+            private
 
             def extract_name_email
               return @name_email_tuple if defined?(@name_email_tuple)

diff --git a/lib/datadog/ci/ext/environment/providers/jenkins.rb b/lib/datadog/ci/ext/environment/providers/jenkins.rb
@@ -3,6 +3,7 @@
 require "json"
 
 require_relative "base"
+require_relative "../../../utils/git"
 
 module Datadog
   module CI
@@ -12,9 +13,6 @@ module Providers
           # Jenkins: https://www.jenkins.io/
           # Environment variables docs: https://www.jenkins.io/doc/book/pipeline/jenkinsfile/#using-environment-variables
           class Jenkins < Base
-            private
-
-            # overridden methods
             def provider_name
               "jenkins"
             end
@@ -25,7 +23,7 @@ def pipeline_id
 
             def pipeline_name
               if (name = env["JOB_NAME"])
-                name = name.gsub("/#{normalize_ref(git_branch)}", "") if git_branch
+                name = name.gsub("/#{Datadog::CI::Utils::Git.normalize_ref(git_branch)}", "") if git_branch
                 name = name.split("/").reject { |v| v.nil? || v.include?("=") }.join("/")
               end
               name