gitlab_quality-test_tooling 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6aca93da1e251be67dab8c377c542ddfdba84392efb41949b62b42fabb283d3
-  data.tar.gz: 32d0c338138afaeaf0f47a38cced840387ed07c55e63631847bc59a3bfb20842
+  metadata.gz: 4e917eea87f25727b389510a47d70ec930f02c201acf889efcb43b89b3d7060e
+  data.tar.gz: c7be66d7d4fdec18b8814c010e58a8a95474d9e6977e787c3b673d65892ea07c
 SHA512:
-  metadata.gz: 3af4b645bb8c495ed38ce06964de0008e31fbd2a097f374339874aa9f7d9b1967cd6b7c3fae7ad46188120ece0103058864e9601a68e38812002529df6ac89c0
-  data.tar.gz: 6c1670e30153abb2af66e098c6a89fc13140d71bf1b7aa82ed06793006c8c702bfd5d4345ced0737168f7efb6c288734828a1726a905e16d4d97f2785bc9692b
+  metadata.gz: 53b9854fb10540f4bff43a820f9fb4b13d6cd6f9e551390c0fba36a1a5a82db00bd701b84ffd4039b574c1d0504923232507428c2101bd61f893518ae6185fa0
+  data.tar.gz: 0d8847faab298bf0c9ed4a3174cc8bfa6d82c1392dd87cbe7ea8f5c88d48ace766d5018c14faeb4bb936236d027eed33e82b6744daaf527850726779da3fa433

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (0.2.2)
+    gitlab_quality-test_tooling (0.4.0)
       activesupport (~> 6.1)
       gitlab (~> 4.18.0)
       http (~> 5.0)

data/README.md

@@ -31,9 +31,13 @@ The gem provides the following executables.
 ```shell
 Purpose: Generate test session report based on RSpec report files (JSON or JUnit XML)
 Usage: exe/generate-test-session [options]
-    -i, --input-files FILES          RSpec report files (JSON or JUnit XML)
+    -i, --input-files INPUT_FILES    RSpec report files (JSON or JUnit XML)
     -p, --project PROJECT            Can be an integer or a group/project string
-    -t, --token ACCESS_TOKEN         A valid access token with Reporter permission in PROJECT
+    -t, --token TOKEN                A valid access token with `api` scope and Reporter permission in PROJECT
+    -c CI_PROJECT_TOKEN,             A valid access token with `read_api` scope permission in current ENV["CI_PROJECT_ID"]
+        --ci-project-token
+    -f ISSUE_URL_FILE,               Output the created test session issue URL
+        --issue-url-file
         --dry-run                    Perform a dry-run (don't create or update issues or test cases)
     -v, --version                    Show the version
     -h, --help                       Show the usage
@@ -63,7 +67,7 @@ Usage: exe/post-to-slack [options]
 $ exe/prepare-stage-reports -h
 Purpose: Prepare separate reports for each DevOps stage from the provided RSpec report files (JUnit XML)
 Usage: exe/prepare-stage-reports [options]
-    -j, --junit-files FILES          RSpec report files (JUnit XML)
+    -i, --input-files INPUT_FILES    RSpec report files (JUnit XML)
     -v, --version                    Show the version
     -h, --help                       Show the usage
 ```
@@ -74,10 +78,11 @@ Usage: exe/prepare-stage-reports [options]
 $ exe/relate-failure-issue -h
 Purpose: Relate test failures to failure issues from RSpec report files (JSON or JUnit XML)
 Usage: exe/relate-failure-issue [options]
-    -i, --input-files FILES          RSpec report files (JSON or JUnit XML)
-        --max-diff-ratio DIFF_RATO   Max stacktrace diff ratio for QA failure issues detection
+    -i, --input-files INPUT_FILES    RSpec report files (JSON or JUnit XML)
+        --max-diff-ratio MAX_DIFF_RATO
+                                     Max stacktrace diff ratio for QA failure issues detection
     -p, --project PROJECT            Can be an integer or a group/project string
-    -t, --token ACCESS_TOKEN         A valid access token with Reporter permission in PROJECT
+    -t, --token TOKEN                A valid access token with `api` scope and Reporter permission in PROJECT
         --system-log-files SYSTEM_LOG_FILES
                                      Include errors from system logs in failure issues
         --dry-run                    Perform a dry-run (don't create or update issues)
@@ -91,13 +96,16 @@ Usage: exe/relate-failure-issue [options]
 $ exe/report-results -h
 Purpose: Report test results from RSpec report files (JSON or JUnit XML) in GitLab test cases and result issues
 Usage: exe/report-results [options]
-    -i, --input-files FILES          RSpec report files (JSON or JUnit XML)
+    -i, --input-files INPUT_FILES    RSpec report files (JSON or JUnit XML)
         --test-case-project TEST_CASE_PROJECT
                                      Can be an integer or a group/project string
+    -t TEST_CASE_PROJECT_TOKEN,      A valid access token with `api` scope and Reporter permission in TEST_CASE_PROJECT
+        --test-case-project-token
         --results-issue-project RESULTS_ISSUE_PROJECT
                                      Can be an integer or a group/project string
-    -t, --token ACCESS_TOKEN         A valid access token
-        --dry-run                    Perform a dry-run (don't create or update issues or test cases)
+    -r RESULTS_ISSUE_PROJECT_TOKEN,  A valid access token with `api` scope and Reporter permission in RESULTS_ISSUE_PROJECT
+        --results-issue-project-token
+        --dry-run                    Perform a dry-run (don't create/update issues or test cases)
     -v, --version                    Show the version
     -h, --help                       Show the usage
 ```
@@ -108,7 +116,7 @@ Usage: exe/report-results [options]
 $ exe/update-screenshot-paths -h
 Purpose: Update the path to screenshots to container's host from RSpec report files (JSON or JUnit XML)
 Usage: exe/update-screenshot-paths [options]
-    -i, --input-files FILES          RSpec report files (JSON or JUnit XML)
+    -i, --input-files INPUT_FILES    RSpec report files (JSON or JUnit XML)
     -v, --version                    Show the version
     -h, --help                       Show the usage
 ```

data/exe/generate-test-session

@@ -11,7 +11,7 @@ params = {}
 options = OptionParser.new do |opts|
   opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
 
-  opts.on('-i', '--input-files FILES', String, 'RSpec report files (JSON or JUnit XML)') do |input_files|
+  opts.on('-i', '--input-files INPUT_FILES', String, 'RSpec report files (JSON or JUnit XML)') do |input_files|
     params[:input_files] = input_files
   end
 
@@ -19,8 +19,16 @@ options = OptionParser.new do |opts|
     params[:project] = project
   end
 
-  opts.on('-t', '--token ACCESS_TOKEN', String, 'A valid access token with Reporter permission in PROJECT') do |token|
-    params[:token] = GitlabQuality::TestTooling::Runtime::TokenFinder.find_token!(token)
+  opts.on('-t', '--token TOKEN', String, 'A valid access token with `api` scope and Reporter permission in PROJECT') do |token|
+    params[:token] = token
+  end
+
+  opts.on('-c', '--ci-project-token CI_PROJECT_TOKEN', String, 'A valid access token with `read_api` scope permission in current ENV["CI_PROJECT_ID"]') do |ci_project_token|
+    params[:ci_project_token] = ci_project_token
+  end
+
+  opts.on('-f', '--issue-url-file ISSUE_URL_FILE', 'Output the created test session issue URL') do |issue_url_file|
+    params[:issue_url_file] = issue_url_file
   end
 
   opts.on('--dry-run', "Perform a dry-run (don't create or update issues or test cases)") do
@@ -42,8 +50,12 @@ options = OptionParser.new do |opts|
   opts.parse(ARGV)
 end
 
+issue_url_file = params.delete(:issue_url_file)
+
 if params.any?
-  GitlabQuality::TestTooling::Report::GenerateTestSession.new(**params).invoke!
+  issue_url = GitlabQuality::TestTooling::Report::GenerateTestSession.new(**params).invoke!
+
+  File.write(issue_url_file, issue_url) if issue_url_file && issue_url
 else
   puts options
   exit 1

data/exe/prepare-stage-reports

@@ -11,8 +11,8 @@ params = {}
 options = OptionParser.new do |opts|
   opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
 
-  opts.on('-j', '--junit-files FILES', String, 'RSpec report files (JUnit XML)') do |junit_files|
-    params[:junit_files] = junit_files
+  opts.on('-i', '--input-files INPUT_FILES', String, 'RSpec report files (JUnit XML)') do |input_files|
+    params[:input_files] = input_files
   end
 
   opts.on_tail('-v', '--version', 'Show the version') do

data/exe/relate-failure-issue

@@ -11,20 +11,20 @@ params = {}
 options = OptionParser.new do |opts|
   opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
 
-  opts.on('-i', '--input-files FILES', String, 'RSpec report files (JSON or JUnit XML)') do |input_files|
+  opts.on('-i', '--input-files INPUT_FILES', String, 'RSpec report files (JSON or JUnit XML)') do |input_files|
     params[:input_files] = input_files
   end
 
-  opts.on('--max-diff-ratio DIFF_RATO', Float, 'Max stacktrace diff ratio for QA failure issues detection') do |value|
-    params[:max_diff_ratio] = value
+  opts.on('--max-diff-ratio MAX_DIFF_RATO', Float, 'Max stacktrace diff ratio for QA failure issues detection') do |max_diff_ratio|
+    params[:max_diff_ratio] = max_diff_ratio
   end
 
   opts.on('-p', '--project PROJECT', String, 'Can be an integer or a group/project string') do |project|
     params[:project] = project
   end
 
-  opts.on('-t', '--token ACCESS_TOKEN', String, 'A valid access token with Reporter permission in PROJECT') do |token|
-    params[:token] = GitlabQuality::TestTooling::Runtime::TokenFinder.find_token!(token)
+  opts.on('-t', '--token TOKEN', String, 'A valid access token with `api` scope and Reporter permission in PROJECT') do |token|
+    params[:token] = token
   end
 
   opts.on('--system-log-files SYSTEM_LOG_FILES', String,

data/exe/report-results

@@ -11,7 +11,7 @@ params = {}
 options = OptionParser.new do |opts|
   opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
 
-  opts.on('-i', '--input-files FILES', String, 'RSpec report files (JSON or JUnit XML)') do |input_files|
+  opts.on('-i', '--input-files INPUT_FILES', String, 'RSpec report files (JSON or JUnit XML)') do |input_files|
     params[:input_files] = input_files
   end
 
@@ -20,16 +20,22 @@ options = OptionParser.new do |opts|
     params[:test_case_project] = test_case_project
   end
 
+  opts.on('-t', '--test-case-project-token TEST_CASE_PROJECT_TOKEN', String,
+    'A valid access token with `api` scope and Reporter permission in TEST_CASE_PROJECT') do |test_case_project_token|
+    params[:test_case_project_token] = test_case_project_token
+  end
+
   opts.on('--results-issue-project RESULTS_ISSUE_PROJECT', String,
     'Can be an integer or a group/project string') do |results_issue_project|
     params[:results_issue_project] = results_issue_project
   end
 
-  opts.on('-t', '--token ACCESS_TOKEN', String, 'A valid access token') do |token|
-    params[:token] = GitlabQuality::TestTooling::Runtime::TokenFinder.find_token!(token)
+  opts.on('-r', '--results-issue-project-token RESULTS_ISSUE_PROJECT_TOKEN', String,
+    'A valid access token with `api` scope and Reporter permission in RESULTS_ISSUE_PROJECT') do |results_issue_project_token|
+    params[:results_issue_project_token] = results_issue_project_token
   end
 
-  opts.on('--dry-run', "Perform a dry-run (don't create or update issues or test cases)") do
+  opts.on('--dry-run', "Perform a dry-run (don't create/update issues or test cases)") do
     params[:dry_run] = true
   end
 

data/exe/update-screenshot-paths

@@ -11,8 +11,8 @@ params = {}
 options = OptionParser.new do |opts|
   opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
 
-  opts.on('-i', '--input-files FILES', String, 'RSpec report files (JSON or JUnit XML)') do |input_files|
-    params[:junit_files] = input_files
+  opts.on('-i', '--input-files INPUT_FILES', String, 'RSpec report files (JSON or JUnit XML)') do |input_files|
+    params[:input_files] = input_files
   end
 
   opts.on_tail('-v', '--version', 'Show the version') do

data/lib/gitlab_quality/test_tooling/report/generate_test_session.rb

@@ -7,13 +7,16 @@ module GitlabQuality
   module TestTooling
     module Report
       class GenerateTestSession < ReportAsIssue
-        def initialize(**kwargs)
+        def initialize(ci_project_token:, **kwargs)
           super
+          @ci_project_token = ci_project_token
           @issue_type = 'issue'
         end
 
         private
 
+        attr_reader :ci_project_token
+
         # rubocop:disable Metrics/AbcSize
         def run!
           puts "Generating test results in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
@@ -37,7 +40,7 @@ module GitlabQuality
               note: "/relate #{Runtime::Env.qa_issue_url}")
           end
 
-          File.write('REPORT_ISSUE_URL', issue.web_url)
+          issue&.web_url # Issue isn't created in dry-run mode
         end
         # rubocop:enable Metrics/AbcSize
 
@@ -78,12 +81,12 @@ module GitlabQuality
         def generate_failed_jobs_listing
           failed_jobs = []
 
-          client = Gitlab.client(
+          ci_project_client = Gitlab.client(
             endpoint: Runtime::Env.ci_api_v4_url,
-            private_token: Runtime::Env.gitlab_ci_api_token)
+            private_token: ci_project_token)
 
           gitlab.handle_gitlab_client_exceptions do
-            failed_jobs = client.pipeline_jobs(
+            failed_jobs = ci_project_client.pipeline_jobs(
               Runtime::Env.ci_project_id,
               Runtime::Env.ci_pipeline_id,
               scope: 'failed')

data/lib/gitlab_quality/test_tooling/report/prepare_stage_reports.rb

@@ -8,8 +8,8 @@ module GitlabQuality
       class PrepareStageReports
         EXTRACT_STAGE_FROM_TEST_FILE_REGEX = %r{(?:api|browser_ui)/(?:[0-9]+_)?(?<stage>[_\w]+)/}i
 
-        def initialize(junit_files:)
-          @junit_files = junit_files
+        def initialize(input_files:)
+          @input_files = input_files
         end
 
         def invoke!
@@ -24,13 +24,13 @@ module GitlabQuality
 
         private
 
-        attr_reader :junit_files
+        attr_reader :input_files
 
         # Collect the test cases from the original reports and group them by Stage
         def collate_test_cases
-          Dir.glob(junit_files)
-            .each_with_object(Hash.new { |h, k| h[k] = [] }) do |junit_file, test_cases|
-            report = Nokogiri::XML(File.open(junit_file))
+          Dir.glob(input_files)
+            .each_with_object(Hash.new { |h, k| h[k] = [] }) do |input_file, test_cases|
+            report = Nokogiri::XML(File.open(input_file))
             report.xpath('//testcase').each do |test_case|
               # The test file paths could start with any of
               #  /qa/specs/features/api/<stage>

data/lib/gitlab_quality/test_tooling/report/report_results.rb

@@ -12,12 +12,12 @@ module GitlabQuality
           :results_issue_project, :gitlab
 
         def initialize(
-          token:, input_files:, test_case_project: nil, results_issue_project: nil, dry_run: false,
+          test_case_project_token:, results_issue_project_token:, input_files:, test_case_project: nil, results_issue_project: nil, dry_run: false,
           **kwargs)
           @testcase_project_reporter = GitlabQuality::TestTooling::Report::ResultsInTestCases.new(
-            token: token, input_files: input_files, project: test_case_project, dry_run: dry_run, **kwargs)
+            token: test_case_project_token, input_files: input_files, project: test_case_project, dry_run: dry_run, **kwargs)
           @results_issue_project_reporter = GitlabQuality::TestTooling::Report::ResultsInIssues.new(
-            token: token, input_files: input_files, project: results_issue_project, dry_run: dry_run, **kwargs)
+            token: results_issue_project_token, input_files: input_files, project: results_issue_project, dry_run: dry_run, **kwargs)
           @test_case_project = test_case_project
           @results_issue_project = results_issue_project
           @files = Array(input_files)

data/lib/gitlab_quality/test_tooling/report/update_screenshot_path.rb

@@ -8,28 +8,28 @@ module GitlabQuality
   module TestTooling
     module Report
       class UpdateScreenshotPath
-        def initialize(junit_files:)
-          @junit_files = junit_files
+        def initialize(input_files:)
+          @input_files = input_files
         end
 
         REGEX = %r{(?<gitlab_qa_run>gitlab-qa-run-.*?(?=/))/(?<gitlab_ce_ee_qa>gitlab-(?:ee|ce)-qa-.*?(?=/))}
         CONTAINER_PATH = File.join('/home', 'gitlab', 'qa', 'tmp').freeze
 
         def invoke!
-          Dir.glob(junit_files).each do |junit_file|
-            match_data = junit_file.match(REGEX)
+          Dir.glob(input_files).each do |input_file|
+            match_data = input_file.match(REGEX)
             next unless match_data
 
             host_relative_path = "#{match_data[:gitlab_qa_run]}/#{match_data[:gitlab_ce_ee_qa]}"
 
-            rewrite_schreenshot_paths_in_junit_file(junit_file, host_relative_path)
-            rewrite_schreenshot_paths_in_json_file(junit_file.gsub('.xml', '.json'), host_relative_path)
+            rewrite_schreenshot_paths_in_junit_file(input_file, host_relative_path)
+            rewrite_schreenshot_paths_in_json_file(input_file.gsub('.xml', '.json'), host_relative_path)
           end
         end
 
         private
 
-        attr_reader :junit_files
+        attr_reader :input_files
 
         def rewrite_schreenshot_paths_in_junit_file(junit_file, host_relative_path)
           File.write(

data/lib/gitlab_quality/test_tooling/runtime/env.rb

@@ -11,9 +11,7 @@ module GitlabQuality
         using Rainbow
 
         ENV_VARIABLES = {
-          'GITLAB_API_BASE' => :api_base,
           'GITLAB_QA_ISSUE_URL' => :qa_issue_url,
-          'GITLAB_CI_API_TOKEN' => :gitlab_ci_api_token,
           'CI_COMMIT_REF_NAME' => :ci_commit_ref_name,
           'CI_JOB_NAME' => :ci_job_name,
           'CI_JOB_URL' => :ci_job_url,
@@ -21,7 +19,6 @@ module GitlabQuality
           'CI_PROJECT_NAME' => :ci_project_name,
           'CI_PIPELINE_ID' => :ci_pipeline_id,
           'CI_PIPELINE_URL' => :ci_pipeline_url,
-          'CI_API_V4_URL' => :ci_api_v4_url,
           'SLACK_QA_CHANNEL' => :slack_qa_channel,
           'DEPLOY_VERSION' => :deploy_version
         }.freeze
@@ -44,8 +41,12 @@ module GitlabQuality
           env_var_value_if_defined('QA_DEFAULT_BRANCH') || 'main'
         end
 
+        def ci_api_v4_url
+          env_var_value_if_defined('CI_API_V4_URL') || 'https://gitlab.com/api/v4'
+        end
+
         def gitlab_api_base
-          env_var_value_if_defined('GITLAB_API_BASE') || 'https://gitlab.com/api/v4'
+          env_var_value_if_defined('GITLAB_API_BASE') || ci_api_v4_url
         end
 
         def pipeline_from_project_name

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "0.2.2"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-10 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -357,7 +357,6 @@ files:
 - lib/gitlab_quality/test_tooling/report/update_screenshot_path.rb
 - lib/gitlab_quality/test_tooling/runtime/env.rb
 - lib/gitlab_quality/test_tooling/runtime/logger.rb
-- lib/gitlab_quality/test_tooling/runtime/token_finder.rb
 - lib/gitlab_quality/test_tooling/slack/post_to_slack.rb
 - lib/gitlab_quality/test_tooling/summary_table.rb
 - lib/gitlab_quality/test_tooling/support/http_request.rb

data/lib/gitlab_quality/test_tooling/runtime/token_finder.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module GitlabQuality
-  module TestTooling
-    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.gitlab_ci_api_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_CI_API_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