gitlab-qa 4.20.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 066aa882ca586d0186ec53fb1cb7e55276a5081280993568e681c73ffa760bfb
-  data.tar.gz: 11b473e0b82f5842de908b43dad5699dcdd07fd2d444228548bdd7b21cde2639
+  metadata.gz: cbeeb65a1b5a859f9908822611d61985da8ba9dd3118a56fe9e52ce0e645e09b
+  data.tar.gz: 78f96fa6fe4c8d7e4139e689ff08fd8c71df18d3d111917c9c672b36b6376936
 SHA512:
-  metadata.gz: d9298cbb9e265a96d9f969919992920046f8566452af76252008b2ae7500350965168844bf7bca0d9632163ad34b457dc21b623912b32091f8c6c683932dcf54
-  data.tar.gz: b7cc0ebfd6b6c35085ab94ada285238e68b5577318d16b559fbb2c28b884d9e9135093749627d7fd02a27543ab4d343a26616cc694027146ab9b5997b0bfb6e9
+  metadata.gz: 1b43e0971ca42b9a1fe77475ee94c92c164e3f0a3d8f6a45129f899f67a4708d469b36509df84614d33763d6f469d9702d86ab498aa1151fadfc4297c0b96b5f
+  data.tar.gz: cbbd9b29c55a243614d127b9e6840f6b8a1241e8984d87b05c0c728ac445f0c6e4b8d3cdb85f0a8dc45e1cb6dd82350eb52237354792f292a63a3e6cbd3806ff

data/.gitlab-ci.yml

@@ -1,7 +1,12 @@
-image: ruby:2.6
+.default-rules:
+  rules:
+    - if: '$CI_COMMIT_TAG || $RELEASE'
+      when: never
+    - if: '$RELEASE == null && $CI_JOB_NAME =~ /staging/'
+      when: manual
+    - if: '$CI_MERGE_REQUEST_ID || $CI_COMMIT_REF_NAME == "master"'
 
-services:
- - docker:19.03.0-dind
+image: registry.gitlab.com/gitlab-org/gitlab-build-images:gitlab-qa-ruby-2.6
 
 stages:
   - check
@@ -10,11 +15,10 @@ stages:
   - notify
 
 variables:
-  TEST_IMAGE: registry.gitlab.com/gitlab-org/gitlab-build-images:gitlab-qa-ruby-2.6
-  DOCKER_DRIVER: overlay
+  DOCKER_DRIVER: overlay2
   DOCKER_HOST: tcp://docker:2375
   QA_ARTIFACTS_DIR: $CI_PROJECT_DIR
-  QA_CAN_TEST_GIT_PROTOCOL_V2: 'false'
+  QA_CAN_TEST_GIT_PROTOCOL_V2: 'true'
 
 cache:
   key: "ruby:2.6"
@@ -29,27 +33,37 @@ before_script:
     fi
   - export LANG=C.UTF-8
 
-check:rubocop:
+.check-base:
+  extends: .default-rules
   stage: check
-  image: $TEST_IMAGE
-  script: bundle exec rubocop
-  except:
-    - triggers
-  tags:
-    - docker
+  script:
+    - bundle exec $CI_JOB_NAME
 
-check:rspec:
-  stage: check
-  image: $TEST_IMAGE
-  script: bundle exec rspec
-  except:
-    - triggers
-  tags:
-    - docker
+rubocop:
+  extends: .check-base
+
+rspec:
+  extends: .check-base
+
+release:
+  stage: release
+  rules:
+    - if: '$CI_COMMIT_TAG'
+  script:
+    - gem update --system
+    - ruby --version
+    - gem env version
+    - gem build gitlab-qa.gemspec
+    - gem push gitlab-qa*.gem
+  artifacts:
+    paths:
+      - gitlab-qa*.gem
+    expire_in: 30 days
 
 .test:
   stage: test
-  image: $TEST_IMAGE
+  services:
+    - docker:19.03.0-dind
   tags:
     - docker
   artifacts:
@@ -63,23 +77,33 @@ check:rspec:
 .ce-qa:
   variables:
     DEFAULT_RELEASE: "CE"
-  only:
-    variables:
-      - $RELEASE == null
-      - $RELEASE =~ /gitlab-ce/
+  rules:
+    - if: '$CI_COMMIT_TAG || $RELEASE =~ /gitlab-ee/'
+      when: never
+    - if: '$RELEASE == null && $CI_JOB_NAME =~ /quarantine|praefect|custom/'
+      when: manual
+    - if: '$RELEASE =~ /gitlab-ce/ && $CI_JOB_NAME =~ /quarantine|praefect|custom/'
+      when: manual
+    - if: '$CI_MERGE_REQUEST_ID && $CI_JOB_NAME =~ /quarantine|praefect|custom/'
+      when: manual
+    - if: '$RELEASE == null || $RELEASE =~ /gitlab-ce/ || $CI_MERGE_REQUEST_ID || $CI_COMMIT_REF_NAME == "master"'
 
 .ee-qa:
   variables:
     DEFAULT_RELEASE: "EE"
-  only:
-    variables:
-      - $RELEASE == null
-      - $RELEASE =~ /gitlab-ee/
+  rules:
+    - if: '$CI_COMMIT_TAG || $RELEASE =~ /gitlab-ce/'
+      when: never
+    - if: '$RELEASE == null && $CI_JOB_NAME =~ /quarantine|praefect|custom/'
+      when: manual
+    - if: '$RELEASE =~ /gitlab-ee/ && $CI_JOB_NAME =~ /quarantine|praefect|custom/'
+      when: manual
+    - if: '$CI_MERGE_REQUEST_ID && $CI_JOB_NAME =~ /quarantine|praefect|custom/'
+      when: manual
+    - if: '$RELEASE == null || $RELEASE =~ /gitlab-ee/ || $CI_MERGE_REQUEST_ID || $CI_COMMIT_REF_NAME == "master"'
 
 .only-qa:
-  except:
-    variables:
-      - $RELEASE
+  extends: .default-rules
 
 .high-capacity:
   tags:
@@ -100,7 +124,6 @@ check:rspec:
 
 .quarantine:
   allow_failure: true
-  when: manual
 
 .echo-custom-variables-before-calling-gitlab-qa:
   script:
@@ -133,7 +156,7 @@ ce:custom-parallel:
     - .ce-qa
     - .rspec-report-opts
     - .echo-custom-variables-before-calling-gitlab-qa
-  when: manual
+  allow_failure: true
   parallel: 10
 
 ee:custom-parallel:
@@ -143,7 +166,7 @@ ee:custom-parallel:
     - .ee-qa
     - .rspec-report-opts
     - .echo-custom-variables-before-calling-gitlab-qa
-  when: manual
+  allow_failure: true
   parallel: 10
 
 ce:instance:
@@ -188,24 +211,6 @@ ee:instance-quarantine:
     - .quarantine
     - .rspec-report-opts
 
-ce:docker:
-  script:
-    - exe/gitlab-qa Test::Instance::Image ${RELEASE:=CE} -- --tag docker $RSPEC_REPORT_OPTS
-  extends:
-    - .test
-    - .high-capacity
-    - .ce-qa
-    - .rspec-report-opts
-
-ee:docker:
-  script:
-    - exe/gitlab-qa Test::Instance::Image ${RELEASE:=EE} -- --tag docker $RSPEC_REPORT_OPTS
-  extends:
-    - .test
-    - .high-capacity
-    - .ee-qa
-    - .rspec-report-opts
-
 ce:relative_url:
   script:
     - exe/gitlab-qa Test::Instance::RelativeUrl ${RELEASE:=CE} -- $RSPEC_REPORT_OPTS
@@ -753,7 +758,7 @@ ce:praefect:
     - .knapsack-variables
     - .rspec-report-opts
   parallel: 5
-  when: manual
+  allow_failure: true
 
 ee:praefect:
   script:
@@ -765,7 +770,7 @@ ee:praefect:
     - .knapsack-variables
     - .rspec-report-opts
   parallel: 5
-  when: manual
+  allow_failure: true
 
 ce:smtp:
   script:
@@ -785,29 +790,6 @@ ee:smtp:
     - .ee-qa
     - .rspec-report-opts
 
-.notify_upstream_commit:
-  stage: notify
-  except:
-    variables:
-      - $TOP_UPSTREAM_SOURCE_PROJECT == null
-      - $TOP_UPSTREAM_SOURCE_SHA == null
-  before_script:
-    - gem install gitlab --no-document
-
-notify_upstream_commit:success:
-  extends:
-    - .notify_upstream_commit
-  script:
-    - bin/notify_upstream_commit success
-  when: on_success
-
-notify_upstream_commit:failure:
-  extends:
-    - .notify_upstream_commit
-  script:
-    - bin/notify_upstream_commit failure
-  when: on_failure
-
 # This job requires the `GITLAB_QA_ACCESS_TOKEN` and `GITLAB_QA_DEV_ACCESS_TOKEN`
 # variable to be passed when triggered.
 staging:
@@ -818,23 +800,29 @@ staging:
     - .test
     - .high-capacity
     - .only-qa
-  when: manual
+  allow_failure: true
 
-release:
-  stage: release
+.notify_upstream_commit:
+  stage: notify
+  image: ruby:2.6
+  before_script:
+    - gem install gitlab --no-document
+
+notify_upstream_commit:success:
+  extends: .notify_upstream_commit
+  script:
+    - bin/notify_upstream_commit success
   rules:
-    - if: '$CI_COMMIT_TAG'
+    - if: '$TOP_UPSTREAM_SOURCE_PROJECT && $TOP_UPSTREAM_SOURCE_SHA'
       when: on_success
+
+notify_upstream_commit:failure:
+  extends: .notify_upstream_commit
   script:
-    - gem update --system
-    - ruby --version
-    - gem env version
-    - gem build gitlab-qa.gemspec
-    - gem push gitlab-qa*.gem
-  artifacts:
-    paths:
-      - gitlab-qa*.gem
-    expire_in: 30 days
+    - bin/notify_upstream_commit failure
+  rules:
+    - if: '$TOP_UPSTREAM_SOURCE_PROJECT && $TOP_UPSTREAM_SOURCE_SHA'
+      when: on_failure
 
 .notify_slack:
   image: alpine
@@ -847,10 +835,11 @@ release:
 notify_slack:
   extends:
     - .notify_slack
-  only:
-    variables:
-      - $TOP_UPSTREAM_SOURCE_JOB && $NOTIFY_CHANNEL
-      - $TOP_UPSTREAM_SOURCE_JOB && $TOP_UPSTREAM_SOURCE_REF == 'master'
+  rules:
+    - if: '$TOP_UPSTREAM_SOURCE_JOB && $NOTIFY_CHANNEL'
+      when: on_failure
+    - if: '$TOP_UPSTREAM_SOURCE_JOB && $TOP_UPSTREAM_SOURCE_REF == "master"'
+      when: on_failure
   script:
     - export RELEASE=${TOP_UPSTREAM_SOURCE_REF:-$RELEASE}
     - echo "NOTIFY_CHANNEL is ${NOTIFY_CHANNEL:=qa-$TOP_UPSTREAM_SOURCE_REF}"
@@ -858,4 +847,3 @@ notify_slack:
     - echo "CI_PIPELINE_URL is $CI_PIPELINE_URL"
     - echo "TOP_UPSTREAM_SOURCE_JOB is $TOP_UPSTREAM_SOURCE_JOB"
     - bin/slack $NOTIFY_CHANNEL "☠️ QA against $RELEASE failed! ☠️ See $CI_PIPELINE_URL (triggered from $TOP_UPSTREAM_SOURCE_JOB)" ci_failing
-  when: on_failure

data/docs/what_tests_can_be_run.md

@@ -613,6 +613,24 @@ Example:
 $ gitlab-qa Test::Instance::Smoke ee:<tag> https://staging.gitlab.com
 ```
 
+### `Test::Instance::RepositoryStorage`
+
+This scenario will run a limited number of tests that are tagged with `:repository_storage`.
+
+These tests verify features related to multiple repository storages.
+
+**Required environment variables:**
+
+- `QA_ADDITIONAL_REPOSITORY_STORAGE`: The name of the non-default repository storage.
+
+Example:
+
+```
+$ export QA_ADDITIONAL_REPOSITORY_STORAGE=secondary
+
+$ gitlab-qa Test::Instance::RepositoryStorage
+```
+
 ----
 
 [Back to README.md](../README.md)

data/exe/gitlab-qa-report

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'gitlab/qa'
+
+Gitlab::QA::Reporter.invoke(ARGV)

data/gitlab-qa.gemspec

@@ -27,5 +27,7 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_runtime_dependency 'activesupport', '~>  6.0.2'
+  spec.add_runtime_dependency 'gitlab', '~>  4.11.0'
   spec.add_runtime_dependency 'nokogiri', '~> 1.10'
 end

data/lib/gitlab/qa.rb

@@ -1,10 +1,12 @@
 module Gitlab
   module QA
     autoload :Release, 'gitlab/qa/release'
+    autoload :Reporter, 'gitlab/qa/reporter'
     autoload :Runner, 'gitlab/qa/runner'
 
     module Runtime
       autoload :Env, 'gitlab/qa/runtime/env'
+      autoload :TokenFinder, 'gitlab/qa/runtime/token_finder'
     end
 
     module Scenario
@@ -86,6 +88,7 @@ module Gitlab
 
     module Report
       autoload :PrepareStageReports, 'gitlab/qa/report/prepare_stage_reports'
+      autoload :ResultsInIssues, 'gitlab/qa/report/results_in_issues'
     end
   end
 end

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

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require 'gitlab'
+require 'active_support/core_ext/enumerable'
+
+module Gitlab
+  # Monkey patch the Gitlab client to use the correct API path
+  class Client
+    def team_member(project, id)
+      get("/projects/#{url_encode project}/members/all/#{id}")
+    end
+  end
+
+  module QA
+    module Report
+      # Uses the API to create or update GitLab issues with the results of tests from RSpec report files.
+      # The GitLab client is used for API access: https://github.com/NARKOZ/gitlab
+      class ResultsInIssues
+        MAINTAINER_ACCESS_LEVEL = 40
+        MAX_TITLE_LENGTH = 255
+
+        def initialize(token:, input_files:, project: nil)
+          @token = token
+          @files = Array(input_files)
+          @project = project
+        end
+
+        def invoke!
+          configure_gitlab_client
+
+          validate_input!
+
+          puts "Reporting test results in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
+
+          Dir.glob(files).each do |file|
+            puts "Reporting tests in #{file}"
+            Nokogiri::XML(File.open(file)).xpath('//testcase').each do |test|
+              report_test(test)
+            end
+          end
+        end
+
+        private
+
+        attr_reader :files, :token, :project
+
+        def validate_input!
+          assert_project!
+          assert_input_files!(files)
+          assert_user_permission!
+        end
+
+        def assert_project!
+          return if project
+
+          abort "Please provide a valid project ID or path with the `-p/--project` option!"
+        end
+
+        def assert_input_files!(files)
+          return if Dir.glob(files).any?
+
+          abort "Please provide valid JUnit report files. No files were found matching `#{files.join(',')}`"
+        end
+
+        def assert_user_permission!
+          user = Gitlab.user
+          member = Gitlab.team_member(project, user.id)
+
+          abort_not_permitted if member.access_level < MAINTAINER_ACCESS_LEVEL
+        rescue Gitlab::Error::NotFound
+          abort_not_permitted
+        end
+
+        def abort_not_permitted
+          abort "You must have at least Maintainer access to the project to use this feature."
+        end
+
+        def configure_gitlab_client
+          Gitlab.configure do |config|
+            config.endpoint = Runtime::Env.gitlab_api_base
+            config.private_token = token
+          end
+        end
+
+        def report_test(test)
+          return if test.search('skipped').any?
+
+          puts "Reporting test name: #{test['name']} | #{test['file']}"
+
+          issue = find_issue(test)
+          if issue
+            puts "Found existing issue: #{issue.web_url}"
+          else
+            issue = create_issue(test)
+            puts "Created new issue: #{issue.web_url}"
+          end
+
+          update_labels(issue, test)
+          note_status(issue, test)
+
+          puts "Issue updated"
+        end
+
+        def create_issue(test)
+          puts "Creating issue for file: #{test['file']} | name: #{test['name']}"
+
+          Gitlab.create_issue(
+            project,
+            title_from_test(test),
+            { description: "### Full description\n\n#{search_safe(test['name'])}\n\n### File path\n\n#{test['file']}", labels: 'status::automated' }
+          )
+        end
+
+        def find_issue(test)
+          issues = Gitlab.search_in_project(project, 'issues', search_term(test))
+            .auto_paginate
+            .select { |issue| issue.state == 'opened' && issue.title.strip == title_from_test(test) }
+
+          warn(%(Too many issues found with the file path "#{test['file']}" and name "#{test['name']}")) if issues.many?
+
+          issues.first
+        end
+
+        def search_term(test)
+          %("#{test['file']}" "#{search_safe(test['name'])}")
+        end
+
+        def title_from_test(test)
+          title = "Results for #{test['file']} | #{search_safe(test['name'])}".strip
+
+          return title unless title.length > MAX_TITLE_LENGTH
+
+          "#{title[0...MAX_TITLE_LENGTH - 3]}..."
+        end
+
+        def search_safe(value)
+          value.delete('"')
+        end
+
+        def note_status(issue, test)
+          return if failures(test).empty?
+
+          errors = failures(test).each_with_object([]) do |failure, text|
+            text << <<~TEXT
+              Error:
+              ```
+              #{failure['message']}
+              ```
+
+              Stacktrace:
+              ```
+              #{failure.content}
+              ```
+            TEXT
+          end.join("\n\n")
+
+          Gitlab.create_issue_note(project, issue.iid, ":x: ~\"#{pipeline}::failed\" in job `#{Runtime::Env.ci_job_name}` in #{Runtime::Env.ci_job_url}\n\n#{errors}")
+        end
+
+        def update_labels(issue, test)
+          labels = issue.labels
+          labels.delete_if { |label| label.start_with?("#{pipeline}::") }
+          labels << (failures(test).empty? ? "#{pipeline}::passed" : "#{pipeline}::failed")
+
+          Gitlab.edit_issue(project, issue.iid, labels: labels)
+        end
+
+        def failures(test)
+          test.search('failure')
+        end
+
+        def pipeline
+          # Gets the name of the pipeline the test was run in, to be used as the key of a scoped label
+          #
+          # Tests can be run in several pipelines:
+          #   gitlab-qa, nightly, master, staging, canary, production, preprod, and MRs
+          #
+          # Some of those run in their own project, so CI_PROJECT_NAME is the name we need. Those are:
+          #   nightly, staging, canary, production, and preprod
+          #
+          # MR, master, and gitlab-qa tests run in gitlab-qa, but we only want to report tests run on master
+          # because the other pipelines will be monitored by the author of the MR that triggered them.
+          # So we assume that we're reporting a master pipeline if the project name is 'gitlab-qa'.
+
+          Runtime::Env.ci_project_name == 'gitlab-qa' ? 'master' : Runtime::Env.ci_project_name
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/reporter.rb

@@ -0,0 +1,68 @@
+require 'optparse'
+
+module Gitlab
+  module QA
+    class Reporter
+      # rubocop:disable Metrics/AbcSize
+      def self.invoke(args)
+        report_options = {}
+
+        options = OptionParser.new do |opts|
+          opts.banner = 'Usage: gitlab-qa-reporter [options]'
+
+          opts.on('--prepare-stage-reports FILES', 'Prepare separate reports for each Stage from the provided JUnit XML files') do |files|
+            report_options[:prepare_stage_reports] = true
+            report_options[:input_files] = files if files
+          end
+
+          opts.on('--report-in-issues FILES', String, 'Report test results from JUnit XML files in GitLab issues') do |files|
+            report_options[:report_in_issues] = true
+            report_options[:input_files] = files if files
+          end
+
+          opts.on('-p', '--project PROJECT_ID', String, 'A valid project ID. Can be an integer or a group/project string. Required by --report-in-issues') do |value|
+            report_options[:project] = value
+          end
+
+          opts.on('-t', '--token ACCESS_TOKEN', String, 'A valid access token. Used by --report-in-issues') do |value|
+            report_options[:token] = value
+          end
+
+          opts.on_tail('-v', '--version', 'Show the version') do
+            require 'gitlab/qa/version'
+            puts "#{$PROGRAM_NAME} : #{VERSION}"
+            exit
+          end
+
+          opts.on_tail('-h', '--help', 'Show the usage') do
+            puts opts
+            exit
+          end
+
+          opts.parse(args)
+        end
+
+        if args.any?
+          if report_options[:prepare_stage_reports]
+            report_options.delete(:prepare_stage_reports)
+            Gitlab::QA::Report::PrepareStageReports.new(**report_options).invoke!
+
+            exit
+          end
+
+          if report_options[:report_in_issues]
+            report_options.delete(:report_in_issues)
+            report_options[:token] = Runtime::TokenFinder.find_token!(report_options[:token])
+            Gitlab::QA::Report::ResultsInIssues.new(**report_options).invoke!
+
+            exit
+          end
+        else
+          puts options
+          exit 1
+        end
+      end
+      # rubocop:enable Metrics/AbcSize
+    end
+  end
+end

data/lib/gitlab/qa/runner.rb

@@ -2,6 +2,7 @@ require 'optparse'
 
 module Gitlab
   module QA
+    # rubocop:disable Metrics/AbcSize
     class Runner
       # These options are implemented in the QA framework (i.e., in the CE/EE codebase)
       # They're included here so that gitlab-qa treats them as valid options
@@ -13,10 +14,7 @@ module Gitlab
         ['--loop', 'Execute tests in a loop']
       ].freeze
 
-      # rubocop:disable Metrics/AbcSize
       def self.run(args)
-        report_options = {}
-
         options = OptionParser.new do |opts|
           opts.banner = 'Usage: gitlab-qa [options] Scenario URL [[--] path] [rspec_options]'
 
@@ -24,11 +22,6 @@ module Gitlab
             opts.on(*opt)
           end
 
-          opts.on('--prepare-stage-reports FILES', 'Prepare separate reports for each Stage from the provided JUnit XML files') do |files|
-            report_options[:prepare_stage_reports] = true
-            report_options[:input_files] = files if files
-          end
-
           opts.on_tail('-v', '--version', 'Show the version') do
             require 'gitlab/qa/version'
             puts "#{$PROGRAM_NAME} : #{VERSION}"
@@ -44,13 +37,6 @@ module Gitlab
         end
 
         if args.size >= 1
-          if report_options[:prepare_stage_reports]
-            report_options.delete(:prepare_stage_reports)
-            Gitlab::QA::Report::PrepareStageReports.new(**report_options).invoke!
-
-            exit
-          end
-
           Scenario
             .const_get(args.shift)
             .perform(*args)

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

@@ -12,6 +12,7 @@ module Gitlab
           'QA_REMOTE_GRID_ACCESS_KEY' => :remote_grid_access_key,
           'QA_REMOTE_GRID_PROTOCOL' => :remote_grid_protocol,
           'QA_BROWSER' => :browser,
+          'GITLAB_API_BASE' => :api_base,
           'GITLAB_ADMIN_USERNAME' => :admin_username,
           'GITLAB_ADMIN_PASSWORD' => :admin_password,
           'GITLAB_USERNAME' => :user_username,
@@ -22,7 +23,6 @@ module Gitlab
           'GITLAB_FORKER_PASSWORD' => :forker_password,
           'GITLAB_USER_TYPE' => :user_type,
           'GITLAB_SANDBOX_NAME' => :gitlab_sandbox_name,
-          'GITLAB_QA_ACCESS_TOKEN' => :qa_access_token,
           'GITLAB_QA_ADMIN_ACCESS_TOKEN' => :qa_admin_access_token,
           'GITHUB_ACCESS_TOKEN' => :github_access_token,
           'GITLAB_URL' => :gitlab_url,
@@ -78,6 +78,22 @@ module Gitlab
           send(:attr_accessor, accessor) # rubocop:disable GitlabSecurity/PublicSend
         end
 
+        def gitlab_api_base
+          ENV['GITLAB_API_BASE'] || 'https://gitlab.com/api/v4'
+        end
+
+        def ci_job_name
+          ENV['CI_JOB_NAME']
+        end
+
+        def ci_job_url
+          ENV['CI_JOB_URL']
+        end
+
+        def ci_project_name
+          ENV['CI_PROJECT_NAME']
+        end
+
         def run_id
           @run_id ||= "gitlab-qa-run-#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}-#{SecureRandom.hex(4)}"
         end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module Runtime
+      class TokenFinder
+        def self.find_token!(token, suffix: nil)
+          new(token, suffix).find_token!
+        end
+
+        attr_reader :token, :suffix
+
+        def initialize(token, suffix)
+          @token = token
+          @suffix = suffix
+        end
+
+        def find_token!
+          find_token_from_attrs || find_token_from_env || find_token_from_file
+        end
+
+        def find_token_from_attrs
+          token
+        end
+
+        def find_token_from_env
+          Env.qa_access_token
+        end
+
+        def find_token_from_file
+          @token_from_file ||= File.read(token_file_path).strip
+        rescue Errno::ENOENT
+          fail "Please provide a valid access token with the `-t/--token` option, the `GITLAB_QA_ACCESS_TOKEN` environment variable, or in the `#{token_file_path}` file!"
+        end
+
+        private
+
+        def token_file_path
+          @token_file_path ||= File.expand_path("../api_token#{"_#{suffix}" if suffix}", __dir__)
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module QA
-    VERSION = '4.20.0'.freeze
+    VERSION = '5.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 4.20.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Grzegorz Bizon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2020-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -122,6 +122,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +169,7 @@ email:
 - grzesiek.bizon@gmail.com
 executables:
 - gitlab-qa
+- gitlab-qa-report
 extensions: []
 extra_rdoc_files: []
 files:
@@ -172,6 +201,7 @@ files:
 - docs/waits.md
 - docs/what_tests_can_be_run.md
 - exe/gitlab-qa
+- exe/gitlab-qa-report
 - fixtures/ldap/1_add_nodes.ldif
 - fixtures/ldap/2_add_users.ldif
 - fixtures/ldap/3_add_groups.ldif
@@ -195,8 +225,11 @@ files:
 - lib/gitlab/qa/docker/volumes.rb
 - lib/gitlab/qa/release.rb
 - lib/gitlab/qa/report/prepare_stage_reports.rb
+- lib/gitlab/qa/report/results_in_issues.rb
+- lib/gitlab/qa/reporter.rb
 - lib/gitlab/qa/runner.rb
 - lib/gitlab/qa/runtime/env.rb
+- lib/gitlab/qa/runtime/token_finder.rb
 - lib/gitlab/qa/scenario/actable.rb
 - lib/gitlab/qa/scenario/cli_commands.rb
 - lib/gitlab/qa/scenario/template.rb