gitlab_quality-test_tooling 2.9.0 → 2.11.0

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

@@ -15,13 +15,29 @@ module GitlabQuality
       class HealthProblemReporter < ReportAsIssue
         include Concerns::GroupAndCategoryLabels
         include Concerns::IssueReports
+        include TestMetricsExporter::Support::GcsTools
 
         BASE_SEARCH_LABELS    = ['test'].freeze
         FOUND_IN_MR_LABEL     = '~"found:in MR"'
         FOUND_IN_MASTER_LABEL = '~"found:master"'
 
-        def initialize(input_files: [], **kwargs)
-          super(input_files: input_files, **kwargs)
+        def initialize(
+          input_files: [],
+          dry_run: false,
+          issue_update_enabled: true,
+          gcs_enabled: false,
+          gcs_project_id: nil,
+          gcs_bucket: nil,
+          gcs_credentials: nil,
+          **kwargs)
+          super(input_files: input_files, dry_run: dry_run, **kwargs)
+
+          @dry_run               = dry_run
+          @issue_update_enabled  = issue_update_enabled
+          @gcs_enabled           = gcs_enabled
+          @gcs_project_id        = gcs_project_id
+          @gcs_bucket            = gcs_bucket
+          @gcs_credentials       = gcs_credentials
         end
 
         def most_recent_report_date_for_issue(issue_iid:)
@@ -33,6 +49,8 @@ module GitlabQuality
 
         private
 
+        attr_reader :dry_run, :issue_update_enabled, :gcs_enabled, :gcs_project_id, :gcs_bucket, :gcs_credentials
+
         def problem_type
           'unhealthy'
         end
@@ -70,43 +88,89 @@ module GitlabQuality
         end
 
         def run!
-          puts "Reporting tests in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
+          Runtime::Logger.info "issue creation/update is disabled." unless issue_update_enabled
+          Runtime::Logger.info "push to GCS is disabled." unless gcs_enabled
+          return unless test_reporting_enabled?
 
+          Runtime::Logger.info "Reporting tests in `#{files.join(',')}`."
           TestResults::Builder.new(file_glob: files, token: token, project: project).test_results_per_file do |test_results|
-            puts "=> Processing #{test_results.count} tests in #{test_results.path}"
+            Runtime::Logger.info "=> Processing #{test_results.count} tests in #{test_results.path}"
 
             process_test_results(test_results)
           end
         end
 
         def process_test_results(test_results)
-          reported_test_count = 0
+          applicable_tests = test_results.select { |test| test_is_applicable?(test) }
+          return if applicable_tests.empty?
+
+          process_issues_for_tests(applicable_tests) if issue_update_enabled
 
-          test_results.each do |test|
-            next unless test_is_applicable?(test)
+          if gcs_enabled
+            tests_data            = build_tests_data(applicable_tests)
+            test_results_filename = File.basename(test_results.path)
+
+            push_test_to_gcs(tests_data, test_results_filename)
+          end
 
-            puts " => Reporting #{problem_type} test '#{test.name}'..."
+          Runtime::Logger.info " => Reported #{applicable_tests.size} #{problem_type} tests."
+        end
+
+        def process_issues_for_tests(tests)
+          tests.each do |test|
+            Runtime::Logger.info " => Processing issues for #{problem_type} test '#{test.name}'..."
+            issues = existing_test_health_issues_for_test(test)
+            create_or_update_test_health_issues(issues, test)
+          end
+        end
 
-            issues = find_issues_by_hash(test_hash(test), state: 'opened', labels: search_labels)
+        def existing_test_health_issues_for_test(test)
+          find_issues_by_hash(test_hash(test), state: 'opened', labels: search_labels)
+        end
 
-            if issues.empty?
-              issues << create_issue(test)
-            else
-              # Keep issues description up-to-date
-              update_issues(issues, test)
-            end
+        def build_tests_data(tests)
+          tests.map do |test|
+            Runtime::Logger.info " => Building data for #{problem_type} test '#{test.name}'..."
+            issues = existing_test_health_issues_for_test(test)
+            test_datum(test, issues)
+          end
+        end
 
-            update_reports(issues, test)
-            collect_issues(test, issues)
-            reported_test_count += 1
+        def create_or_update_test_health_issues(issues, test)
+          if issues.empty?
+            issues << create_issue(test)
+          else
+            # Keep issues description up-to-date
+            update_issues(issues, test)
           end
 
-          puts " => Reported #{reported_test_count} #{problem_type} tests."
+          update_reports(issues, test)
+          collect_issues(test, issues)
+        end
+
+        def push_test_to_gcs(tests_data, test_results_filename)
+          Runtime::Logger.info "will push the test data to GCS"
+
+          gcs_client(project_id: gcs_project_id, credentials: gcs_credentials, dry_run: dry_run).put_object(
+            gcs_bucket,
+            gcs_metrics_file_name(test_results_filename),
+            tests_data.to_json,
+            force: true,
+            content_type: 'application/json'
+          )
+
+          Runtime::Logger.info "Successfully pushed the #{gcs_metrics_file_name(test_results_filename)} file to the GCS bucket."
+        end
+
+        def gcs_metrics_file_name(test_results_filename)
+          today = Time.now.strftime('%Y-%m-%d')
+
+          "#{today}-#{test_results_filename}"
         end
 
         def update_reports(issues, test)
           issues.each do |issue|
-            puts "   => Reporting #{problem_type} test to existing issue: #{issue.web_url}"
+            Runtime::Logger.info "   => Reporting #{problem_type} test to existing issue: #{issue.web_url}"
             add_report_to_issue(issue: issue, test: test, related_issues: (issues - [issue]))
           end
         end
@@ -162,6 +226,42 @@ module GitlabQuality
           end
         end
 
+        # We report a test if we have issue update and/or push to GCS enabled.
+        def test_reporting_enabled?
+          issue_update_enabled || gcs_enabled
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        def test_datum(test, issues)
+          feature_category = test.feature_category.to_s.strip.empty? ? nil : test.feature_category
+          product_group    = test.product_group.to_s.strip.empty? ? nil : test.product_group
+
+          if !product_group && feature_category
+            labels_inference = GitlabQuality::TestTooling::LabelsInference
+            product_group = labels_inference.new.product_group_from_feature_category(feature_category)
+          end
+
+          {
+            feature_category: feature_category,
+            created_at: Time.now.utc.iso8601,
+            description: test.name,
+            filename: test.file,
+            gitlab_project_id: Runtime::Env.ci_project_id,
+            product_group: product_group,
+            id: test.example_id,
+            hash: test_hash(test),
+            issue_url: issues.first&.web_url,
+            job_id: Runtime::Env.ci_job_id,
+            job_web_url: test.ci_job_url,
+            pipeline_id: Runtime::Env.ci_pipeline_id,
+            pipeline_ref: Runtime::Env.ci_commit_ref_name,
+            pipeline_web_url: Runtime::Env.ci_pipeline_url,
+            stacktrace: test.full_stacktrace,
+            test_level: test.level
+          }
+        end
+        # rubocop:enable Metrics/AbcSize
+
         def found_label
           if ENV.key?('CI_MERGE_REQUEST_IID')
             FOUND_IN_MR_LABEL

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

@@ -17,7 +17,7 @@ module GitlabQuality
         include Concerns::GroupAndCategoryLabels
 
         NEW_ISSUE_LABELS = Set.new([
-          'test', 'automation::bot-authored', 'type::maintenance', 'maintenance::performance',
+          'test', 'automation:bot-authored', 'type::maintenance', 'maintenance::performance',
           'priority::3', 'severity::3', 'knapsack_report'
         ]).freeze
         SEARCH_LABELS = %w[test maintenance::performance knapsack_report].freeze

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

@@ -6,7 +6,7 @@ module GitlabQuality
   module TestTooling
     module Report
       class PrepareStageReports
-        EXTRACT_STAGE_FROM_TEST_FILE_REGEX = %r{(?:api|browser_ui)/(?:[0-9]+_)?(?<stage>[_\w]+)/}i
+        EXTRACT_STAGE_FROM_TEST_FILE_REGEX = %r{(?:api|browser_ui)/(?:[0-9]+_)?(?<stage>[\w]+)/}i
 
         def initialize(input_files:)
           @input_files = input_files

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

@@ -318,7 +318,7 @@ module GitlabQuality
           initialize_gitlab_ops_client
 
           if Runtime::Env.ci_pipeline_url.include?('ops.gitlab.net')
-            pipeline = ops_gitlab_client.find_pipeline(project, Runtime::Env.ci_pipeline_id.to_i)
+            pipeline = ops_gitlab_client.find_pipeline(Runtime::Env.ci_project_path, Runtime::Env.ci_pipeline_id.to_i)
             generate_ops_gitlab_diff(pipeline)
           else
             pipeline = gitlab.find_pipeline(project, Runtime::Env.ci_pipeline_id.to_i)

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

@@ -11,19 +11,20 @@ module GitlabQuality
         using Rainbow
 
         ENV_VARIABLES = {
-          'GITLAB_QA_ISSUE_URL' => :qa_issue_url,
           'CI_COMMIT_REF_NAME' => :ci_commit_ref_name,
+          'CI_JOB_ID' => :ci_job_id,
           'CI_JOB_NAME' => :ci_job_name,
           'CI_JOB_URL' => :ci_job_url,
-          'CI_PROJECT_ID' => :ci_project_id,
-          'CI_PROJECT_NAME' => :ci_project_name,
-          'CI_PROJECT_PATH' => :ci_project_path,
           'CI_PIPELINE_ID' => :ci_pipeline_id,
           'CI_PIPELINE_NAME' => :ci_pipeline_name,
           'CI_PIPELINE_URL' => :ci_pipeline_url,
-          'SLACK_QA_CHANNEL' => :slack_qa_channel,
+          'CI_PROJECT_ID' => :ci_project_id,
+          'CI_PROJECT_NAME' => :ci_project_name,
+          'CI_PROJECT_PATH' => :ci_project_path,
           'DEPLOY_VERSION' => :deploy_version,
-          'QA_GITLAB_CI_TOKEN' => :gitlab_ci_token
+          'GITLAB_QA_ISSUE_URL' => :qa_issue_url,
+          'QA_GITLAB_CI_TOKEN' => :gitlab_ci_token,
+          'SLACK_QA_CHANNEL' => :slack_qa_channel
         }.freeze
 
         ENV_VARIABLES.each do |env_name, method_name|
@@ -56,6 +57,10 @@ module GitlabQuality
           env_var_value_if_defined('GITLAB_API_BASE') || ci_api_v4_url
         end
 
+        def gitlab_graphql_api_base
+          env_var_value_if_defined('GITLAB_GRAPHQL_API_BASE')
+        end
+
         def pipeline_from_project_name
           %w[gitlab gitaly].any? { |str| ci_project_name.to_s.start_with?(str) } ? default_branch : ci_project_name
         end

data/lib/gitlab_quality/test_tooling/test_metrics_exporter/support/gcs_tools.rb

@@ -12,11 +12,15 @@ module GitlabQuality
           # @param project_id [String]
           # @param credentials [String]
           # @return [Fog::Storage::Google]
-          def gcs_client(project_id:, credentials:)
-            Fog::Storage::Google.new(
-              google_project: project_id || raise("Missing Google project_id"),
-              **gcs_creds(credentials)
-            )
+          def gcs_client(project_id:, credentials:, dry_run: false)
+            if dry_run
+              GCSMockClient.new
+            else
+              Fog::Storage::Google.new(
+                google_project: project_id || raise("Missing Google project_id"),
+                **gcs_creds(credentials)
+              )
+            end
           end
 
           # GCS Credentials
@@ -29,6 +33,15 @@ module GitlabQuality
 
             { google_json_key_string: json_key }
           end
+
+          class GCSMockClient
+            def initialize(*_args, **_kwargs); end
+
+            def put_object(gcs_bucket, filename, data, **_kwargs)
+              Runtime::Logger.info "The #{filename} file would have been pushed to the #{gcs_bucket} bucket, with this content:"
+              Runtime::Logger.info data
+            end
+          end
         end
       end
     end

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "2.9.0"
+    VERSION = "2.11.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.11.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-08 00:00:00.000000000 Z
+date: 2025-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -206,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -417,6 +431,8 @@ executables:
 - detect-infrastructure-failures
 - existing-test-health-issue
 - failed-test-issues
+- feature-readiness-checklist
+- feature-readiness-evaluation
 - flaky-test-issues
 - generate-test-session
 - knapsack-report-issues
@@ -448,6 +464,8 @@ files:
 - exe/detect-infrastructure-failures
 - exe/existing-test-health-issue
 - exe/failed-test-issues
+- exe/feature-readiness-checklist
+- exe/feature-readiness-evaluation
 - exe/flaky-test-issues
 - exe/generate-test-session
 - exe/knapsack-report-issues
@@ -463,18 +481,29 @@ files:
 - lib/gitlab_quality/test_tooling.rb
 - lib/gitlab_quality/test_tooling/concerns/find_set_dri.rb
 - lib/gitlab_quality/test_tooling/failed_jobs_table.rb
+- lib/gitlab_quality/test_tooling/feature_readiness/analyzed_items/analyzed_epic.rb
+- lib/gitlab_quality/test_tooling/feature_readiness/analyzed_items/analyzed_issue.rb
+- lib/gitlab_quality/test_tooling/feature_readiness/analyzed_items/analyzed_merge_request.rb
+- lib/gitlab_quality/test_tooling/feature_readiness/concerns/issue_concern.rb
+- lib/gitlab_quality/test_tooling/feature_readiness/concerns/work_item_concern.rb
+- lib/gitlab_quality/test_tooling/feature_readiness/evaluation.rb
+- lib/gitlab_quality/test_tooling/feature_readiness/operational_readiness_check.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/branches_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/branches_dry_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/commits_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/commits_dry_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/gitlab_client.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/gitlab_graphql_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/issues_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/issues_dry_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/job_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/jobs_client.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/labels_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/merge_requests_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/merge_requests_dry_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/repository_files_client.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/work_items_client.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/work_items_dry_client.rb
 - lib/gitlab_quality/test_tooling/job_trace_analyzer.rb
 - lib/gitlab_quality/test_tooling/knapsack_reports/spec_run_time.rb
 - lib/gitlab_quality/test_tooling/knapsack_reports/spec_run_time_report.rb
@@ -484,6 +513,7 @@ files:
 - lib/gitlab_quality/test_tooling/report/concerns/results_reporter.rb
 - lib/gitlab_quality/test_tooling/report/concerns/utils.rb
 - lib/gitlab_quality/test_tooling/report/failed_test_issue.rb
+- lib/gitlab_quality/test_tooling/report/feature_readiness/report_on_epic.rb
 - lib/gitlab_quality/test_tooling/report/flaky_test_issue.rb
 - lib/gitlab_quality/test_tooling/report/generate_test_session.rb
 - lib/gitlab_quality/test_tooling/report/health_problem_reporter.rb