gitlab-qa 7.24.2 → 7.24.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 862c31bca6760f872b719b43ff2acc508f5155af1ad8a8763ff9acec9097629f
-  data.tar.gz: fb705f83636c4702e7f307b5fa445146227bd81525f6bce14dcd82e1da225a2d
+  metadata.gz: 68f574050bbfc1f6ede0a0bb9f87b5e5c1e8f5403739f56294cae2fb1e60fccc
+  data.tar.gz: 57a53ed8a9e1f1071a38bfb96ad46ed13fd566023ac9460751f0dc3da4874291
 SHA512:
-  metadata.gz: edd01e95ac436a768eaf06b6b84ef19b9e07a95067a8e48244cc96450168606741cd75c111517209a4a8c3d58ca41883684b76ad974426fae5b345fbdd15f8dc
-  data.tar.gz: d49d870521be04c0a729841c9bc51d6610049eac7df2274ff7f87d18cefe4f98bebede511982bd819e618c664b102578ddc152249ff1e3ad1f8e8db5717bec95
+  metadata.gz: da89e0ab1a89cefa915d6b734867a78fd6d8e66725d9ba75dac1eeae8faa007cf7fd8fe97372a5f5919a08a8cc482694cc2d9eab25083fc5502d26c3425e082e
+  data.tar.gz: a293a8034877b7f64718e18969809e25dac26943667aafed41e93a433677369ee956707d447234c3d75d5112011d9423a9f4f46102ad4817f833122004d3f560

data/.gitlab/issue_templates/Default.md

@@ -0,0 +1,13 @@
+<!--
+Before raising an issue to the GitLab issue tracker, please read through our guide for finding help to determine the best place to post:
+
+* https://about.gitlab.com/getting-help/
+
+If you are experiencing an issue when using GitLab.com, your first port of call should be the Community Forum. Your issue may have already been reported there by another user. Please check:
+
+* https://forum.gitlab.com/
+
+If you feel that your issue can be categorized as a reproducible bug or a feature proposal, please use one of the issue templates provided and include as much information as possible.
+
+Thank you for helping to make GitLab a better product.
+-->

data/.gitlab/merge_request_templates/Default.md

@@ -0,0 +1,46 @@
+## What does this MR do and why?
+
+_Describe in detail what your merge request does and why._
+
+<!--
+Please keep this description updated with any discussion that takes place so
+that reviewers can understand your intent. Keeping the description updated is
+especially important if they didn't participate in the discussion.
+-->
+
+## Screenshots or screen recordings 
+
+_These are strongly recommended to assist reviewers and reduce the time to merge your change._
+
+<!-- 
+Please include any relevant screenshots or screen recordings that will assist
+reviewers and future readers. If you need help visually verifying the change,
+please leave a comment and ping a GitLab reviewer, maintainer, or MR coach.
+-->
+
+## How to set up and validate locally 
+
+_Numbered steps to set up and validate the change are strongly suggested._
+
+<!-- 
+Example below:
+ 
+1. Enable the invite modal
+   ```ruby
+   Feature.enable(:invite_members_group_modal)
+   ```
+1. In rails console enable the experiment fully
+   ```ruby
+   Feature.enable(:member_areas_of_focus)
+   ```
+1. Visit any group or project member pages such as `http://127.0.0.1:3000/groups/flightjs/-/group_members`
+1. Click the `invite members` button.
+-->
+
+## MR acceptance checklist
+
+This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability. 
+
+* [ ] I have evaluated the [MR acceptance checklist](https://docs.gitlab.com/ee/development/code_review.html#acceptance-checklist) for this MR.
+
+/label ~QA ~Quality

data/gitlab-qa.gemspec

@@ -21,7 +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-dangerfiles', '~> 2.11'
   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/gitlab_issue_client.rb

@@ -77,12 +77,24 @@ module Gitlab
           end
         end
 
+        def find_issue_notes(iid:)
+          handle_gitlab_client_exceptions do
+            Gitlab.issue_notes(project, iid, order_by: 'created_at', sort: 'asc').auto_paginate
+          end
+        end
+
         def create_issue_note(iid:, note:)
           handle_gitlab_client_exceptions do
             Gitlab.create_issue_note(project, iid, note)
           end
         end
 
+        def edit_issue_note(issue_iid:, note_id:, note:)
+          handle_gitlab_client_exceptions do
+            Gitlab.edit_issue_note(project, issue_iid, note_id, note)
+          end
+        end
+
         def add_note_to_issue_discussion_as_thread(iid:, discussion_id:, body:)
           handle_gitlab_client_exceptions do
             Gitlab.add_note_to_issue_discussion_as_thread(project, iid, discussion_id, body: body)

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

@@ -61,7 +61,7 @@ module Gitlab
 
           if issue
             puts "  => Found issue #{issue.web_url} for test '#{test.name}' with a diff ratio of #{(diff_ratio * 100).round(2)}%."
-            @commented_issue_list.include?(issue.web_url) ? (puts " => Failure already commented on issue.") : post_failed_job_note(issue, test)
+            @commented_issue_list.include?(issue.web_url) ? (puts " => Failure already commented on issue.") : post_or_update_failed_job_note(issue, test)
             @commented_issue_list.add(issue.web_url)
           end
 
@@ -164,14 +164,30 @@ module Gitlab
           super << pipeline_name_label
         end
 
-        def post_failed_job_note(issue, test)
-          gitlab.create_issue_note(iid: issue.iid, note: "Failure occurred in #{pipeline} pipeline: #{test.ci_job_url}")
+        def post_or_update_failed_job_note(issue, test)
+          current_note = "Failed most recently in #{pipeline} pipeline: #{test.ci_job_url}"
+          existing_note = existing_failure_note(issue)
+
+          if existing_note
+            gitlab.edit_issue_note(issue_iid: issue.iid, note_id: existing_note.id, note: current_note)
+          else
+            gitlab.create_issue_note(iid: issue.iid, note: current_note)
+          end
+
           puts "  => Linked #{test.ci_job_url} to #{issue.web_url}."
         end
 
         def new_issue_title(test)
           "Failure in #{super}"
         end
+
+        def existing_failure_note(issue)
+          gitlab.find_issue_notes(iid: issue.iid).each do |note|
+            return note if note.body.include?('Failed most recently in')
+          end
+
+          false
+        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/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.2'
+    VERSION = '7.24.5'
   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.2
+  version: 7.24.5
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-03 00:00:00.000000000 Z
+date: 2022-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: gitlab-styles
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +220,8 @@ files:
 - ".gitlab-ci.yml"
 - ".gitlab/ci/danger.gitlab-ci.yml"
 - ".gitlab/ci/rules.gitlab-ci.yml"
+- ".gitlab/issue_templates/Default.md"
+- ".gitlab/merge_request_templates/Default.md"
 - ".gitlab/merge_request_templates/Release.md"
 - ".rspec"
 - ".rubocop.yml"
@@ -356,6 +358,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