gitlab-qa 7.24.1 → 7.24.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16d436d7dcc1ff54323d22b1ced1c4685c78b2ac4290e4deea6f4720b26c7bda
-  data.tar.gz: 8250c321d7130510768ea563bda98978f9ca53c6eac55344ad7475aa4c771324
+  metadata.gz: 86868c3764df21242c8600de6406579ebb747a7d8efcb1aa04393e49af8cf10d
+  data.tar.gz: bb659bc291814572d6fdb6f73b77ef6c8a57eb52d10d2412f96b8998f5ba166a
 SHA512:
-  metadata.gz: bc86efe53b8067cdf2bcf0788dc9c740bbdf32a8cb0be16d5c3dfee4e5b774f2c4f0ec4787169805d5ca04a075fd0ea3b35bca5b20ae5657906efc8be50eff80
-  data.tar.gz: 306ee5e2b20f62f50249a5741471a41904e071656b81168e11236398d3b9d3a933419055b84f7667dc23e642163a83ee66aee29c6f3cc0745251cbdcc5b3e696
+  metadata.gz: f4e796a110f8044e5eed1b99154672b6371ebb23c41b055e7302295bf2c1cfc5ea8c043c23040385a46340ad02bc07372d307e38e28f1585027047663a824be6
+  data.tar.gz: e77ffb360b79a845d000411b55748efa3e7bb4c0bdebfe725ee40dafddc75102cd9cdb86d2e0570c04edb9cad6fbe04193c55a84f35f1304697a505415e32ea6

data/.gitlab/ci/danger.gitlab-ci.yml

@@ -0,0 +1,25 @@
+danger-review:
+  image: ruby:3.0
+  stage: check
+  rules:
+    - if: '$CI_MERGE_REQUEST_IID'
+  needs: []
+  retry:
+    max: 2
+    when:
+      - unknown_failure
+      - api_failure
+      - runner_system_failure
+      - stuck_or_timeout_failure
+  before_script:
+    - bundle install
+  script:
+    - >
+      if [ -z "$DANGER_GITLAB_API_TOKEN" ]; then
+        # Force danger to skip CI source GitLab and fallback to "local only git repo".
+        unset GITLAB_CI
+        # We need the base SHA of the merge request diff to help danger determine the base commit for this shallow clone.
+        bundle exec danger dry_run --fail-on-errors=true --verbose --base='$CI_MERGE_REQUEST_DIFF_BASE_SHA' --head='${CI_MERGE_REQUEST_SOURCE_BRANCH_SHA:-$CI_COMMIT_SHA}'
+      else
+        bundle exec danger --fail-on-errors=true --verbose
+      fi

data/.gitlab-ci.yml

@@ -1384,8 +1384,7 @@ generate-knapsack-report:
 include:
   - local: .gitlab/ci/*.gitlab-ci.yml
   - project: 'gitlab-org/quality/pipeline-common'
-    file: '/ci/gem-release.yml'
-  - project: 'gitlab-org/quality/pipeline-common'
-    file: '/ci/allure-report.yml'
-  - project: 'gitlab-org/quality/pipeline-common'
-    file: '/ci/knapsack-report.yml'
+    file:
+      - '/ci/gem-release.yml'
+      - '/ci/allure-report.yml'
+      - '/ci/knapsack-report.yml'

data/Dangerfile

@@ -0,0 +1,9 @@
+require 'gitlab-dangerfiles'
+
+Gitlab::Dangerfiles.for_project(self) do |dangerfiles|
+  # Import all plugins from the gem
+  dangerfiles.import_plugins
+
+  # Import only a subset of rules
+  dangerfiles.import_dangerfiles(only: %w[changes_size commit_messages simple_roulette])
+end

data/gitlab-qa.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'climate_control', '~> 1.0.1'
+  spec.add_development_dependency 'gitlab-dangerfiles', '~> 2.10'
   spec.add_development_dependency 'gitlab-styles', '~> 6.2.1'
   spec.add_development_dependency 'pry', '~> 0.11'
   spec.add_development_dependency 'rake', '~> 13.0'

data/lib/gitlab/qa/component/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module QA
     module Component

data/lib/gitlab/qa/component/gitlab.rb

@@ -18,9 +18,7 @@ module Gitlab
 
         def_delegators :release, :tag, :image, :edition
 
-        AUTHORITY_CERTIFICATES_PATH = File.expand_path('../../../../tls_certificates/authority', __dir__)
-        GITLAB_CERTIFICATES_PATH = File.expand_path('../../../../tls_certificates/gitlab', __dir__)
-        GITALY_CERTIFICATES_PATH = File.expand_path('../../../../tls_certificates/gitaly', __dir__)
+        CERTIFICATES_PATH = File.expand_path('../../../../tls_certificates', __dir__)
 
         SSL_PATH = '/etc/gitlab/ssl'
         TRUSTED_PATH = '/etc/gitlab/trusted-certs'
@@ -31,10 +29,15 @@ module Gitlab
           @skip_availability_check = false
           @omnibus_gitlab_rails_env = {}
 
-          @volumes[GITLAB_CERTIFICATES_PATH] = SSL_PATH
-          @volumes[AUTHORITY_CERTIFICATES_PATH] = TRUSTED_PATH
+          @omnibus_configuration = Runtime::OmnibusConfiguration.new(Runtime::Scenario.omnibus_configuration)
 
-          @omnibus_configuration ||= Runtime::OmnibusConfiguration.new(Runtime::Scenario.omnibus_configuration)
+          @working_dir_tmp_cert_path = Dir.mktmpdir('certs', FileUtils.mkdir_p("#{Dir.pwd}/tmp"))
+          @authority_cert_path = "#{@working_dir_tmp_cert_path}/authority"
+          @gitlab_cert_path = "#{@working_dir_tmp_cert_path}/gitlab"
+          @gitaly_cert_path = "#{@working_dir_tmp_cert_path}/gitaly"
+
+          @volumes[@gitlab_cert_path] = SSL_PATH
+          @volumes[@authority_cert_path] = TRUSTED_PATH
 
           self.release = 'CE'
         end
@@ -77,8 +80,8 @@ module Gitlab
         end
 
         def gitaly_tls
-          @volumes.delete(GITLAB_CERTIFICATES_PATH)
-          @volumes[GITALY_CERTIFICATES_PATH] = SSL_PATH
+          @volumes.delete(@gitlab_cert_path)
+          @volumes[@gitaly_cert_path] = SSL_PATH
         end
 
         def relative_path
@@ -91,6 +94,13 @@ module Gitlab
 
         def prepare
           prepare_gitlab_omnibus_config
+          copy_certificates
+
+          super
+        end
+
+        def teardown!
+          FileUtils.rm_rf(@working_dir_tmp_cert_path)
 
           super
         end
@@ -168,6 +178,14 @@ module Gitlab
 
         private
 
+        # Copy certs to a temporary directory in current working directory.
+        # This is needed for docker-in-docker ci environments where mount points outside of build dir are not accessible
+        #
+        # @return [void]
+        def copy_certificates
+          FileUtils.cp_r("#{CERTIFICATES_PATH}/.", @working_dir_tmp_cert_path)
+        end
+
         def ensure_configured!
           raise 'Please configure an instance first!' unless [name, release, network].all?
         end

data/lib/gitlab/qa/component/ldap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 
 # This component sets up the docker-openldap (https://github.com/osixia/docker-openldap)
@@ -16,18 +18,12 @@ module Gitlab
   module QA
     module Component
       class LDAP < Base
-        DOCKER_IMAGE = 'osixia/openldap'.freeze
-        DOCKER_IMAGE_TAG = 'latest'.freeze
-        LDAP_USER = 'tanuki'.freeze
-        LDAP_PASSWORD = 'password'.freeze
-        BOOTSTRAP_LDIF = '/container/service/slapd/assets/config/bootstrap/ldif/custom'.freeze
-        FIXTURE_PATH = File.expand_path('../../../../fixtures/ldap'.freeze, __dir__)
-
-        def initialize
-          super
-
-          @volumes[FIXTURE_PATH] = BOOTSTRAP_LDIF
-        end
+        DOCKER_IMAGE = 'osixia/openldap'
+        DOCKER_IMAGE_TAG = 'latest'
+        LDAP_USER = 'tanuki'
+        LDAP_PASSWORD = 'password'
+        BOOTSTRAP_LDIF = '/container/service/slapd/assets/config/bootstrap/ldif/custom'
+        FIXTURE_PATH = File.expand_path('../../../../fixtures/ldap', __dir__)
 
         # LDAP_TLS is true by default
         def tls=(status)
@@ -59,6 +55,19 @@ module Gitlab
           super
         end
 
+        def prepare
+          copy_fixtures
+          @volumes["#{working_dir_tmp_fixture_path}/ldap"] = BOOTSTRAP_LDIF
+
+          super
+        end
+
+        def teardown!
+          FileUtils.rm_rf(working_dir_tmp_fixture_path)
+
+          super
+        end
+
         # rubocop:disable Metrics/AbcSize
         def start
           # copy-service needed for bootstraping LDAP user:
@@ -88,6 +97,23 @@ module Gitlab
           ::Gitlab::QA::Runtime::Env.ldap_username = username
           ::Gitlab::QA::Runtime::Env.ldap_password = password
         end
+
+        private
+
+        # Temporary fixture dir in working directory
+        #
+        # @return [String]
+        def working_dir_tmp_fixture_path
+          @local_fixture_path ||= Dir.mktmpdir('ldap', FileUtils.mkdir_p("#{Dir.pwd}/tmp"))
+        end
+
+        # Copy fixtures to current working directory
+        # This is needed for docker-in-docker ci environments where mount points outside of build dir are not accessible
+        #
+        # @return [void]
+        def copy_fixtures
+          FileUtils.cp_r(FIXTURE_PATH, working_dir_tmp_fixture_path)
+        end
       end
     end
   end

data/lib/gitlab/qa/report/report_as_issue.rb

@@ -106,8 +106,14 @@ module Gitlab
         def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
           labels = issue_labels(issue)
           labels |= new_labels
-          ee_test?(test) ? labels << "Enterprise Edition" : labels.delete("Enterprise Edition")
-          quarantine_job? ? labels << "quarantine" : labels.delete("quarantine")
+          ee_test?(test) ? labels << 'Enterprise Edition' : labels.delete('Enterprise Edition')
+
+          if test.quarantine?
+            labels << 'quarantine'
+            labels << "quarantine::#{test.quarantine_type}"
+          else
+            labels.delete_if { |label| label.include?('quarantine') }
+          end
 
           labels
         end
@@ -133,10 +139,6 @@ module Gitlab
           test.file =~ %r{features/ee/(api|browser_ui)}
         end
 
-        def quarantine_job?
-          Runtime::Env.ci_job_name&.include?('quarantine')
-        end
-
         def partial_file_path(path)
           path.match(/((api|browser_ui).*)/i)[1]
         end

data/lib/gitlab/qa/report/results_in_issues.rb

@@ -100,7 +100,6 @@ module Gitlab
 
         def failure_summary
           summary = [":x: ~\"#{pipeline}::failed\""]
-          summary << "~\"quarantine\"" if quarantine_job?
           summary << "in job `#{Runtime::Env.ci_job_name}` in #{Runtime::Env.ci_job_url}"
           summary.join(' ')
         end

data/lib/gitlab/qa/report/results_in_testcases.rb

@@ -30,6 +30,7 @@ module Gitlab
 
         def update_testcase(testcase, test)
           puts "Test case labels updated." if update_labels(testcase, test)
+          puts "Test case quarantine section updated." if update_quarantine_link(testcase, test)
         end
 
         private
@@ -61,7 +62,9 @@ module Gitlab
         end
 
         def new_issue_description(test)
-          "#{super}\n\n#{execution_graph_section(test)}"
+          quarantine_section = test.quarantine? && test.quarantine_issue ? "\n\n### Quarantine issue\n\n#{test.quarantine_issue}" : ''
+
+          "#{super}#{quarantine_section}\n\n#{execution_graph_section(test)}"
         end
 
         def execution_graph_section(test)
@@ -84,6 +87,24 @@ module Gitlab
         def issue_title_needs_updating?(testcase, test)
           super || !testcase.description.include?(execution_graph_section(test)) && !%w[canary production preprod release].include?(pipeline)
         end
+
+        def quarantine_link_needs_updating?(testcase, test)
+          if test.quarantine? && test.quarantine_issue
+            return false if testcase.description.include?(test.quarantine_issue)
+          else
+            return false unless testcase.description.include?('Quarantine issue')
+          end
+
+          true
+        end
+
+        def update_quarantine_link(testcase, test)
+          return unless quarantine_link_needs_updating?(testcase, test)
+
+          new_description = updated_description(testcase, test)
+
+          gitlab.edit_issue(iid: testcase.iid, options: { description: new_description })
+        end
       end
     end
   end

data/lib/gitlab/qa/report/test_result.rb

@@ -87,6 +87,14 @@ module Gitlab
             report['quarantine'].present?
           end
 
+          def quarantine_type
+            report['quarantine']['type'] if quarantine?
+          end
+
+          def quarantine_issue
+            report['quarantine']['issue'] if quarantine?
+          end
+
           private
 
           # rubocop:disable Metrics/AbcSize

data/lib/gitlab/qa/runtime/env.rb

@@ -149,12 +149,14 @@ module Gitlab
             value = env_var_name_if_defined(name) || send(attribute) # rubocop:disable GitlabSecurity/PublicSend
             vars[name] = value if value
           end
-          qa_variables = ENV.select { |k, _v| k.start_with?('QA_') }
+          qa_variables = ENV.each_with_object({}) do |(name, value), vars|
+            next unless name.start_with?('QA_')
 
-          {
-            **qa_variables,
-            **defined_variables
-          }
+            var_name = env_var_name_if_defined(name)
+            vars[name] = var_name if var_name
+          end
+
+          qa_variables.merge(defined_variables)
         end
 
         def debug?

data/lib/gitlab/qa/runtime/logger.rb

@@ -1,34 +1,17 @@
 # frozen_string_literal: true
 
-require 'logger'
 require 'forwardable'
-require'rainbow/refinement'
 
 module Gitlab
   module QA
     module Runtime
-      module Logger
+      class Logger
         extend SingleForwardable
-        using Rainbow
 
         def_delegators :logger, :debug, :info, :warn, :error, :fatal, :unknown
 
-        singleton_class.module_eval do
-          attr_writer :logger
-
-          def logger
-            Rainbow.enabled = Runtime::Env.colorized_logs?
-
-            @logger ||= ::Logger.new($stdout).tap do |logger|
-              logger.level = Runtime::Env.debug? ? ::Logger::DEBUG : ::Logger::INFO
-
-              logger.formatter = proc do |severity, datetime, progname, msg|
-                date_format = datetime.strftime("%Y-%m-%d %H:%M:%S")
-
-                "[date=#{date_format} from=GitLab QA] #{severity.ljust(5)}-- ".yellow + "#{msg}\n"
-              end
-            end
-          end
+        def self.logger
+          @logger ||= QA::TestLogger.logger(level: Runtime::Env.debug? ? ::Logger::DEBUG : ::Logger::INFO)
         end
       end
     end

data/lib/gitlab/qa/test_logger.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'rainbow'
+
+module Gitlab
+  module QA
+    # Common test logger implementation
+    #
+    class TestLogger
+      LEVEL_COLORS = {
+        "DEBUG" => :magenta,
+        "INFO" => :green,
+        "WARN" => :yellow,
+        "ERROR" => :red,
+        "FATAL" => :indianred
+      }.freeze
+
+      Rainbow.enabled = Runtime::Env.colorized_logs?
+
+      def self.logger(level: ::Logger::INFO, source: 'Gitlab QA')
+        ::Logger.new($stdout).tap do |logger|
+          logger.level = level
+
+          logger.formatter = proc do |severity, datetime, progname, msg|
+            date_format = datetime.strftime("%Y-%m-%d %H:%M:%S")
+            msg_prefix = "[date=#{date_format} from=#{source}] #{severity.ljust(5)} -- "
+
+            Rainbow(msg_prefix).public_send(LEVEL_COLORS.fetch(severity, :silver)) + "#{msg}\n" # rubocop:disable GitlabSecurity/PublicSend
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module QA
-    VERSION = '7.24.1'
+    VERSION = '7.24.4'
   end
 end

data/lib/gitlab/qa.rb

@@ -3,6 +3,7 @@ module Gitlab
     autoload :Release, 'gitlab/qa/release'
     autoload :Reporter, 'gitlab/qa/reporter'
     autoload :Runner, 'gitlab/qa/runner'
+    autoload :TestLogger, 'gitlab/qa/test_logger'
 
     module Runtime
       autoload :Env, 'gitlab/qa/runtime/env'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 7.24.1
+  version: 7.24.4
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-02 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: gitlab-dangerfiles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: gitlab-styles
   requirement: !ruby/object:Gem::Requirement
@@ -204,12 +218,14 @@ files:
 - ".dockerignore"
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".gitlab/ci/danger.gitlab-ci.yml"
 - ".gitlab/ci/rules.gitlab-ci.yml"
 - ".gitlab/merge_request_templates/Release.md"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CONTRIBUTING.md
+- Dangerfile
 - Gemfile
 - LICENSE
 - README.md
@@ -340,6 +356,7 @@ files:
 - lib/gitlab/qa/support/get_request.rb
 - lib/gitlab/qa/support/http_request.rb
 - lib/gitlab/qa/support/invalid_response_error.rb
+- lib/gitlab/qa/test_logger.rb
 - lib/gitlab/qa/version.rb
 - tls_certificates/authority/ca.crt
 - tls_certificates/authority/ca.key