gitlab-qa 4.3.3 → 4.4.0

data/.rubocop.yml

@@ -20,9 +20,6 @@ Metrics/MethodLength:
 Rails:
   Enabled: false
 
-Style/ExtendSelf:
-  Enabled: false
-
 Style/ModuleFunction:
   Enabled: false
 

data/bin/merge_html_reports

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+
+require 'nokogiri'
+
+main_report_file = ARGV.shift
+unless main_report_file
+  puts 'usage: merge_html_reports <main-report> <base-artifact-url> [parallel reports...]'
+  exit 1
+end
+
+base_artifact_url = ARGV.shift
+unless base_artifact_url
+  puts 'usage: merge_html_reports <main-report> <base-artifact-url> [parallel reports...]'
+  exit 1
+end
+
+# Create the base report with empty body tag
+new_report = Nokogiri::HTML.parse(File.read(ARGV[0]))
+new_report.at_css('body').remove
+empty_body = Nokogiri::XML::Node.new('body', new_report)
+new_report.at_css('head').add_next_sibling(empty_body)
+
+ARGV.each do |report_file|
+  report = Nokogiri::HTML.parse(File.read(report_file))
+
+  report.css('a').each do |link|
+    link_suffix = link['href'].slice(19..-1)
+    link['href'] = base_artifact_url + link_suffix
+  end
+
+  header = report.css('div #rspec-header')
+  tests = report.css('dt[id^="example_group_"]')
+
+  header.search("//h1/text()").first.content = "Test results for job: #{report_file.slice(/rspec-(.*)\.htm/, 1)}"
+
+  tests.each do |test|
+    title = test.parent
+    group = title.parent
+    script = title.css('script')
+
+    if script.inner_html.include? 'makeYellow'
+      test.remove_class('passed')
+      test.add_class('not_implemented')
+
+      group.remove_class('passed')
+      group.add_class('not_implemented')
+      header.add_class('not_implemented')
+
+      script.remove
+      test.next_sibling.remove
+      test.next_sibling.remove
+
+    elsif script.inner_html.include? 'makeRed'
+      test.remove_class('passed')
+      test.add_class('failed')
+
+      group.remove_class('passed')
+      group.add_class('failed')
+      header.add_class('failed')
+
+      script.remove
+      test.next_sibling.remove
+      test.next_sibling.remove
+    end
+  end
+
+  duration = report.at_css('p#duration')
+  totals = report.at_css('p#totals')
+
+  duration_script = report.css('div.results script')[-2]
+  totals_script = report.css('div.results script')[-1]
+
+  duration_text = duration_script.text.slice(49..-3)
+  totals_text = totals_script.text.slice(47..-3)
+
+  duration.inner_html = duration_text
+  totals.inner_html = totals_text
+
+  duration_script.remove
+  totals_script.remove
+
+  # Add the new result after the last one to keep the test order
+  new_report.css('body')[-1].add_next_sibling(report.at_css('body'))
+end
+
+File.write(main_report_file, new_report)

data/bin/notify_upstream_commit

@@ -10,7 +10,7 @@ Gitlab.configure do |config|
 end
 
 class CommitComment
-  def self.post!(status)
+  def self.post!(status, report_file_name)
     unless ENV['TOP_UPSTREAM_SOURCE_SHA']
       puts "The 'TOP_UPSTREAM_SOURCE_SHA' environment variable is missing, cannot post a comment on a missing upstream commit."
       return
@@ -33,18 +33,26 @@ class CommitComment
         "failed! :boom:"
       end
 
+    # The HTML report can't be opened as a web page so we're forced to
+    # download it. See https://gitlab.com/gitlab-org/gitlab/issues/25192
     Gitlab.create_commit_comment(
       top_upstream_source_project,
       top_upstream_source_sha,
-      "The [`gitlab-qa` downstream pipeline](#{ENV['CI_PIPELINE_URL']}) #{status_with_icon}")
+      <<~COMMENT
+        The [`gitlab-qa` downstream pipeline](#{ENV['CI_PIPELINE_URL']}) #{status_with_icon}.
+
+        You can download a report of the test results: [`#{report_file_name}`](#{ENV['CI_JOB_URL']}/artifacts/raw/#{report_file_name})
+      COMMENT
+    )
   rescue Gitlab::Error::Error => error
     puts "Ignoring the following error: #{error}"
   end
 end
 
-status = ARGV[0].to_s.strip
-if status != ''
-  CommitComment.post!(status.to_sym)
-else
-  puts "Please provide a status!"
-end
+status = ARGV.shift.to_s.strip
+report_file_name = ARGV.shift.to_s.strip
+
+abort "Please provide a status!" if status == ''
+abort "Please provide a file name for the report!" if report_file_name == ''
+
+CommitComment.post!(status.to_sym, report_file_name)

data/docs/run_qa_against_gdk.md

@@ -5,16 +5,18 @@ make a few changes to your `gdk/gitlab/config/gitlab.yml` file.
 
 1. Retrieve your current local IP with `ifconfig`, e.g. `192.168.0.12`.
 1. Create a file named `host` in your GDK directory containing your IP. E.g.:
-   `echo 192.168.0.12 > host`
-1. Edit `gdk/gitlab/config/gitlab.yml` and replace `host: localhost` with
-   `host: 192.168.0.12`.
-1. Also replace `ssh_host: localhost` (found under `gitlab_shell`) with
+   `echo "192.168.0.12" > host`
+1. Edit `gdk/gitlab/config/gitlab.yml` and
+   - replace `host: localhost` under `production:gitlab` with `host: 192.168.0.12`.
+   - replace `ssh_host: localhost` under `production:gitlab_shell` with
    `ssh_host: 192.168.0.12`.
-1. Enable the `sshd` service by uncommenting the relevant line in your
-   `Procfile`.
-1. Edit `openssh/sshd_config` and
+   - replace `host: localhost` under `production:webpack:dev_server` with
+   `host: 192.168.0.12`.
+1. Edit `Procfile` in your GDK directory and
+   - enable the `sshd` service by uncommenting the relevant line
+1. Edit `openssh/sshd_config` in your GDK directory and
    - set `ListenAddress` to `192.168.0.12:2222`
-   - add `AcceptEnv GIT_PROTOCOL` to allow use of [Git protocol v2][Git protocol]
+   - add `AcceptEnv GIT_PROTOCOL` to allow the use of the [Git protocol v2][Git protocol]
 1. Restart your GDK
 1. Run the QA scenario as follows:
 

data/docs/what_tests_can_be_run.md

@@ -36,6 +36,14 @@ For more details on the internals, please read the
 * `GITLAB_QA_PASSWORD_1` - password for `GITLAB_QA_USERNAME_1` available in environments where signup is disabled (e.g. staging.gitlab.com)
 * `GITLAB_QA_USERNAME_2` - another username available in environments where signup is disabled
 * `GITLAB_QA_PASSWORD_2` - password for `GITLAB_QA_USERNAME_2` available in environments where signup is disabled (e.g. staging.gitlab.com)
+* `GITLAB_QA_USERNAME_3` - another username available in environments where signup is disabled
+* `GITLAB_QA_PASSWORD_3` - password for `GITLAB_QA_USERNAME_3` available in environments where signup is disabled (e.g. staging.gitlab.com)
+* `GITLAB_QA_USERNAME_4` - another username available in environments where signup is disabled
+* `GITLAB_QA_PASSWORD_4` - password for `GITLAB_QA_USERNAME_4` available in environments where signup is disabled (e.g. staging.gitlab.com)
+* `GITLAB_QA_USERNAME_5` - another username available in environments where signup is disabled
+* `GITLAB_QA_PASSWORD_5` - password for `GITLAB_QA_USERNAME_5` available in environments where signup is disabled (e.g. staging.gitlab.com)
+* `GITLAB_QA_USERNAME_6` - another username available in environments where signup is disabled
+* `GITLAB_QA_PASSWORD_6` - password for `GITLAB_QA_USERNAME_6` available in environments where signup is disabled (e.g. staging.gitlab.com)
 * `GITLAB_LDAP_USERNAME` - LDAP username to use when signing into GitLab
 * `GITLAB_LDAP_PASSWORD` - LDAP password to use when signing into GitLab
 * `GITLAB_ADMIN_USERNAME` - Admin username to use when adding a license

data/gitlab-qa.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gitlab/qa/version'
 
@@ -20,11 +20,11 @@ Gem::Specification.new do |spec|
 
   # Some dependencies are pinned, to prevent new cops from breaking the CI pipelines
   spec.add_development_dependency 'climate_control', '~> 0.2'
-  spec.add_development_dependency 'gitlab-styles', '2.2.0'
+  spec.add_development_dependency 'gitlab-styles', '2.4.0'
   spec.add_development_dependency 'pry', '~> 0.11'
   spec.add_development_dependency 'rake', '~> 12.2'
   spec.add_development_dependency 'rspec', '~> 3.7'
-  spec.add_development_dependency 'rubocop', '0.52.0'
+  spec.add_development_dependency 'rubocop', '~> 0.54.0'
   spec.add_development_dependency 'rubocop-rspec', '1.20.1'
   spec.add_development_dependency 'webmock', '3.7.0'
 end

data/lib/gitlab/qa.rb

@@ -64,6 +64,12 @@ module Gitlab
       autoload :Elasticsearch, 'gitlab/qa/component/elasticsearch'
     end
 
+    module Support
+      autoload :GetRequest, 'gitlab/qa/support/get_request'
+      autoload :DevEEQAImage, 'gitlab/qa/support/dev_ee_qa_image'
+      autoload :InvalidResponseError, 'gitlab/qa/support/invalid_response_error'
+    end
+
     module Docker
       autoload :Command, 'gitlab/qa/docker/command'
       autoload :Engine, 'gitlab/qa/docker/engine'

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

@@ -97,6 +97,17 @@ module Gitlab
         def start # rubocop:disable Metrics/AbcSize
           ensure_configured!
 
+          if release.dev_gitlab_org?
+            Docker::Command.execute(
+              [
+                'login',
+                '--username gitlab-qa-bot',
+                %(--password "#{Runtime::Env.dev_access_token_variable}"),
+                Release::DEV_REGISTRY
+              ]
+            )
+          end
+
           docker.run(image, tag) do |command|
             command << "-d -p #{port}"
             command << "--name #{name}"

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

@@ -18,6 +18,17 @@ module Gitlab
         def perform # rubocop:disable Metrics/AbcSize
           raise ArgumentError unless [suite, release].all?
 
+          if release.dev_gitlab_org?
+            Docker::Command.execute(
+              [
+                'login',
+                '--username gitlab-qa-bot',
+                %(--password "#{Runtime::Env.dev_access_token_variable}"),
+                Release::DEV_REGISTRY
+              ]
+            )
+          end
+
           puts "Running test suite `#{suite}` for #{release.project_name}"
 
           name = "#{release.project_name}-qa-#{SecureRandom.hex(4)}"

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

@@ -8,19 +8,9 @@ module Gitlab
       class Staging
         ADDRESS = 'https://staging.gitlab.com'.freeze
 
-        class InvalidResponseError < StandardError
-          attr_reader :response
-
-          def initialize(address, response)
-            @response = response
-
-            super "Invalid response received from #{address}"
-          end
-        end
-
         def self.release
           Release.new(image)
-        rescue InvalidResponseError => ex
+        rescue Support::InvalidResponseError => ex
           warn ex.message
           warn "#{ex.response.code} #{ex.response.message}: #{ex.response.body}"
           exit 1
@@ -40,7 +30,7 @@ module Gitlab
             #  - https://gitlab.com/gitlab-org/quality/staging/issues/56
             #  - https://gitlab.com/gitlab-org/release/framework/issues/421
             #  - https://gitlab.com/gitlab-org/gitlab-qa/issues/398
-            DevEEQAImage.new.retrieve_image_from_container_registry!(staging_revision)
+            Support::DevEEQAImage.new.retrieve_image_from_container_registry!(staging_revision)
           else
             # Auto-deploy builds have a tag formatted like 12.0.12345+5159f2949cb.59c9fa631
             # but the version api returns a semver version like 12.0.1
@@ -84,88 +74,13 @@ module Gitlab
           private
 
           def api_get!
-            @response_body ||=
+            @response_body ||= # rubocop:disable Naming/MemoizedInstanceVariableName
               begin
-                response = GetRequest.new(uri, Runtime::Env.qa_access_token).execute!
+                response = Support::GetRequest.new(uri, Runtime::Env.qa_access_token).execute!
                 JSON.parse(response.body)
               end
           end
         end
-
-        class DevEEQAImage
-          attr_reader :base_url
-
-          DEV_ADDRESS = 'https://dev.gitlab.org'.freeze
-          GITLAB_EE_QA_REPOSITORY_ID = 55
-          QAImageNotFoundError = Class.new(StandardError)
-
-          def initialize
-            @base_url = "#{DEV_ADDRESS}/api/v4/projects/gitlab%2Fomnibus-gitlab/registry/repositories/#{GITLAB_EE_QA_REPOSITORY_ID}/tags?per_page=100"
-
-            Runtime::Env.require_qa_dev_access_token!
-          end
-
-          def retrieve_image_from_container_registry!(revision)
-            request_url = base_url
-
-            begin
-              response = api_get!(URI.parse(request_url))
-              tags = JSON.parse(response.body)
-
-              matching_qa_image_tag = find_matching_qa_image_tag(tags, revision)
-              return matching_qa_image_tag['location'] if matching_qa_image_tag
-
-              request_url = next_page_url_from_response(response)
-            end while request_url
-
-            raise QAImageNotFoundError, "No `gitlab-ee-qa` image could be found for the revision `#{revision}`."
-          end
-
-          private
-
-          def api_get!(uri)
-            GetRequest.new(uri, Runtime::Env.qa_dev_access_token).execute!
-          end
-
-          def next_page_url_from_response(response)
-            response['x-next-page'].to_s != '' ? "#{base_url}&page=#{response['x-next-page']}" : nil
-          end
-
-          def find_matching_qa_image_tag(tags, revision)
-            tags.find { |tag| tag['name'].end_with?(revision) }
-          end
-        end
-
-        class GetRequest
-          attr_reader :uri, :token
-
-          def initialize(uri, token)
-            @uri = uri
-            @token = token
-          end
-
-          def execute!
-            response =
-              Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-                http.request(build_request)
-              end
-
-            case response
-            when Net::HTTPSuccess
-              response
-            else
-              raise InvalidResponseError.new(uri.to_s, response)
-            end
-          end
-
-          private
-
-          def build_request
-            Net::HTTP::Get.new(uri).tap do |req|
-              req['PRIVATE-TOKEN'] = token
-            end
-          end
-        end
       end
     end
   end

data/lib/gitlab/qa/release.rb

@@ -20,6 +20,21 @@ module Gitlab
           (:(?<tag>.+))?
         \z
       }xi
+
+      # Dev tag example:
+      #  12.1.201906121026-325a6632895.b340d0bd35d
+      # |----|------------|-----------|-----------|
+      #   |         |           |           |
+      #   |         |           |      omnibus-ref
+      #   |         |       gitlab-ee ref
+      #   |     timestamp
+      # version
+      DEV_TAG_REGEX = /
+        \A
+          (?<version>\d+\.\d+(.\d+)?)\.(?<timestamp>\d+)\-(?<gitlab_ref>[A-Za-z0-9]+)\.(?<omnibus_ref>[A-Za-z0-9]+)
+        \z
+      /xi
+
       DEFAULT_TAG = 'latest'.freeze
       DEFAULT_CANONICAL_TAG = 'nightly'.freeze
       DEV_REGISTRY = 'dev.gitlab.org:5005'.freeze
@@ -98,7 +113,11 @@ module Gitlab
 
       # Tag scheme for gitlab-{ce,ee}-qa images is like 11.1.0-rc12-ee
       def qa_tag
-        tag.sub(/[-\.]([ce]e)(\.(\d+))?\z/, '-\1')
+        if dev_gitlab_org? && (match_data = tag.match(DEV_TAG_REGEX))
+          "#{match_data[:version]}-#{match_data[:gitlab_ref]}"
+        else
+          tag.sub(/[-\.]([ce]e)(\.(\d+))?\z/, '-\1')
+        end
       end
 
       def dev_gitlab_org?

data/lib/gitlab/qa/scenario/test/instance/deployment_base.rb

@@ -18,17 +18,6 @@ module Gitlab
 
               args.unshift(release_name) if release_name&.start_with?('--')
 
-              if release.dev_gitlab_org?
-                Docker::Command.execute(
-                  [
-                    'login',
-                    '--username gitlab-qa-bot',
-                    %(--password "#{Runtime::Env.dev_access_token_variable}"),
-                    Release::DEV_REGISTRY
-                  ]
-                )
-              end
-
               Component::Specs.perform do |specs|
                 specs.suite = 'Test::Instance::All'
                 specs.release = release

data/lib/gitlab/qa/scenario/test/integration/geo.rb

@@ -8,7 +8,6 @@ module Gitlab
 
             ##
             # rubocop:disable Lint/MissingCopEnableDirective
-            # rubocop:disable Metrics/MethodLength
             # rubocop:disable Metrics/AbcSize
             #
             def perform(release, *rspec_args)

data/lib/gitlab/qa/scenario/test/integration/object_storage.rb

@@ -6,7 +6,6 @@ module Gitlab
       module Test
         module Integration
           class ObjectStorage < Scenario::Template
-            # rubocop:disable Metrics/AbcSize
             def perform(release, *rspec_args)
               Component::Gitlab.perform do |gitlab|
                 gitlab.release = release
@@ -41,7 +40,6 @@ module Gitlab
                 end
               end
             end
-            # rubocop:enable Metrics/AbcSize
           end
         end
       end