gitlab_quality-test_tooling 2.8.0 → 2.10.0

data/lib/gitlab_quality/test_tooling/gitlab_client/work_items_client.rb

@@ -0,0 +1,240 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      # The GitLab client is used for API access: https://github.com/NARKOZ/gitlab
+      class WorkItemsClient < GitlabGraphqlClient
+        def work_item(workitem_iid: nil)
+          query = <<~GQL
+            query {
+              namespace(fullPath: "#{group}") {
+                workItem(iid: "#{workitem_iid}") {
+                  #{work_item_fields}
+                  #{work_item_widgets}
+                }
+              }
+            }
+          GQL
+          post(query)[:workItem]
+        end
+
+        def group_work_items(labels: [], cursor: '', state: 'opened', created_after: nil, extras: [])
+          query = <<~GQL
+            query {
+              group(fullPath: "#{group}") {
+                workItems(after: "#{cursor}",#{created_after ? " createdAfter: \"#{created_after}\"," : ''} labelName: [#{labels.map { |label| "\"#{label}\"" }.join(', ')}], state: #{state}) {
+                  nodes {
+                    #{construct_extras(extras)}
+                  }
+                  pageInfo {
+                    hasNextPage
+                    endCursor
+                  }
+                }
+              }
+            }
+          GQL
+          begin
+            post(query)[:workItems]
+          rescue StandardError => e
+            puts "Error: #{e}"
+          end
+        end
+
+        def create_discussion(id:, note:)
+          post(
+            <<~GQL
+              mutation CreateDiscussion {
+                  createDiscussion(input: {noteableId: "#{id}", body: "#{note}"}) {
+                      clientMutationId
+                      errors
+                      note {
+                          #{note_fields}
+                      }
+                  }
+              }
+            GQL
+          )
+        end
+
+        def create_discussion_note(work_item_id:, discussion_id:, text:)
+          query = <<~GQL
+            mutation CreateNote {
+                createNote(input: { discussionId: "#{discussion_id}", noteableId: "#{work_item_id}", body: "#{text}" }) {
+                    clientMutationId
+                    errors
+                    note {
+                        #{note_fields}
+                    }
+                }
+            }
+          GQL
+          post(query)
+        end
+
+        def create_linked_items(work_item_id:, item_ids:, link_type:)
+          query = <<~GQL
+            mutation WorkItemAddLinkedItems {
+                workItemAddLinkedItems(
+                    input: { id: "#{work_item_id}", workItemsIds: [#{item_ids.map { |id| "\"#{id}\"" }.join(', ')}], linkType: #{link_type} }
+                ) {
+                    clientMutationId
+                }
+            }
+          GQL
+          post(query)
+        end
+
+        def add_labels(work_item_id:, label_ids:)
+          query =
+            <<~GQL
+              mutation WorkItemUpdate {
+                  workItemUpdate(input: { id: "#{work_item_id}", labelsWidget: { addLabelIds: [#{label_ids.map { |id| "\"#{id}\"" }.join(', ')}] } }) {
+                      clientMutationId
+                      errors
+                  }
+              }
+            GQL
+          post(query)
+        end
+
+        def paginated_call(method_name, args)
+          results = []
+
+          # Check if the method exists
+          raise ArgumentError, "Unknown method: #{method_name}" unless respond_to?(method_name, true)
+
+          method_obj = method(method_name)
+
+          loop do
+            # Call the method directly using the method object
+            response = method_obj.call(**args)
+
+            break unless response
+
+            results += response[:nodes]
+            break unless response[:pageInfo][:hasNextPage]
+
+            args[:cursor] = response[:pageInfo][:endCursor]
+          end
+
+          results
+        end
+
+        private
+
+        attr_reader :group
+
+        def construct_extras(extras)
+          extras_string = ""
+          extras.each do |extra|
+            next unless respond_to?(extra, true)
+
+            method_obj = method(extra)
+            extras_string += method_obj.call
+            extras_string += "\n"
+          end
+          extras_string
+        end
+
+        # https://docs.gitlab.com/api/graphql/reference/#workitem
+        def work_item_fields
+          <<~GQL
+            author {
+              username
+            }
+            createdAt
+            iid
+            id
+            project {
+              fullPath
+              id
+            }
+            state
+            title
+            webUrl
+            workItemType {
+              name
+            }
+          GQL
+        end
+
+        def work_item_widgets
+          <<~GQL
+            widgets(onlyTypes: [LINKED_ITEMS, NOTES, LABELS, HIERARCHY]) {
+              ... on WorkItemWidgetNotes {
+                discussions(filter: ONLY_COMMENTS) {
+                  nodes {
+                          notes {
+                            nodes {
+                            #{note_fields}
+                            }
+                          }
+                        }
+                }
+              }
+              ... on WorkItemWidgetLinkedItems {
+                  linkedItems {
+                      nodes {
+                          linkType
+                          workItem {
+                              #{work_item_fields}
+                          }
+                      }
+                  }
+              }
+
+              ... on WorkItemWidgetLabels{
+                labels{
+                   nodes{
+                       title
+                   }
+                }
+              }
+
+              ... on WorkItemWidgetHierarchy {
+                children {
+                    nodes{
+                     #{work_item_fields}
+                    }
+                }
+              }
+            }
+          GQL
+        end
+
+        # https://docs.gitlab.com/api/graphql/reference/#note
+        def note_fields
+          <<~GQL
+            author {
+              username
+            }
+            awardEmoji {
+              nodes {
+              #{emoji_fields}
+              }
+            }
+            body
+            id
+            url
+            discussion {
+              id
+            }
+          GQL
+        end
+
+        # https://docs.gitlab.com/api/graphql/reference/#awardemoji
+        def emoji_fields
+          <<~GQL
+            emoji
+            name
+            user {
+                username
+            }
+          GQL
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/gitlab_client/work_items_dry_client.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      class WorkItemsDryClient < WorkItemsClient
+        def create_discussion(id:, note:)
+          puts "The following discussion would have been posted on #{project}##{id} epic:\n\n #{note}"
+        end
+
+        def create_discussion_note(work_item_id:, discussion_id:, text:)
+          puts "The following discussion note would have been posted on #{project}##{work_item_id} (discussion #{discussion_id}) text:\n\n #{text}"
+        end
+
+        def create_linked_items(work_item_id:, item_ids:, link_type: 'BLOCKED_BY')
+          puts "The following items would have been linked on #{project}##{work_item_id} (link type: #{link_type}) item_ids: #{item_ids.join(', ')}"
+        end
+
+        def add_labels(work_item_id:, label_ids:)
+          puts "The following labels would have been added to #{project}##{work_item_id} work item: #{label_ids.join(', ')}"
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/labels_inference.rb

@@ -22,6 +22,10 @@ module GitlabQuality
         ].compact.to_set
       end
 
+      def product_group_from_feature_category(feature_category)
+        categories_mapping.dig(feature_category, 'group')
+      end
+
       private
 
       def categories_mapping

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

@@ -190,7 +190,7 @@ module GitlabQuality
           note_stacktrace = sanitize_stacktrace(stacktrace: note.body, regex: ISSUE_STACKTRACE_REGEX)
           return note_stacktrace if note_stacktrace
 
-          puts "  => [DEBUG] Stacktrace couldn't be found for #{issue.web_url}#note_#{note.id}!"
+          Runtime::Logger.debug "  => Stacktrace couldn't be found for #{issue.web_url}#note_#{note.id}!"
         end
 
         def sanitize_stacktrace(stacktrace:, regex:)
@@ -199,7 +199,7 @@ module GitlabQuality
           if stacktrace_match
             stacktrace_match[:stacktrace].gsub(/^\s*#.*$/, '').gsub(/^[[:space:]]+/, '').strip
           else
-            puts "  => [DEBUG] Stacktrace doesn't match the regex (#{regex})!"
+            Runtime::Logger.debug "  => Stacktrace doesn't match the regex (#{regex})!"
           end
         end
 
@@ -209,7 +209,7 @@ module GitlabQuality
           stack_trace_comparator = StackTraceComparator.new(test_stacktrace, note_stacktrace)
 
           if stack_trace_comparator.lower_or_equal_to_diff_ratio?(max_diff_ratio)
-            puts "  => [DEBUG] Note #{issue.web_url}#note_#{note.id} has an acceptable diff ratio of #{stack_trace_comparator.diff_percent}%."
+            Runtime::Logger.debug "  => Note #{issue.web_url}#note_#{note.id} has an acceptable diff ratio of #{stack_trace_comparator.diff_percent}%."
             # The `Gitlab::ObjectifiedHash` class overrides `#hash` which is used by `Hash#[]=` to compute the hash key.
             # This leads to a `TypeError Exception: no implicit conversion of Hash into Integer` error, so we convert the object to a hash before using it as a Hash key.
             # See:
@@ -217,9 +217,9 @@ module GitlabQuality
             # - https://github.com/NARKOZ/gitlab/commit/cbdbd1e32623f018a8fae39932a8e3bc4d929abb?_pjax=%23js-repo-pjax-container#r44484494
             stack_trace_comparator.diff_ratio
           else
-            puts "  => [DEBUG] Found note #{issue.web_url}#note_#{note.id} but stacktraces are too different (#{stack_trace_comparator.diff_percent}%).\n"
-            puts "  => [DEBUG] Issue stacktrace:\n----------------\n#{note_stacktrace}\n----------------\n"
-            puts "  => [DEBUG] Failure stacktrace:\n----------------\n#{test_stacktrace}\n----------------\n"
+            Runtime::Logger.debug "  => Found note #{issue.web_url}#note_#{note.id} but stacktraces are too different (#{stack_trace_comparator.diff_percent}%).\n"
+            Runtime::Logger.debug "  => Issue stacktrace:\n----------------\n#{note_stacktrace}\n----------------\n"
+            Runtime::Logger.debug "  => Failure stacktrace:\n----------------\n#{test_stacktrace}\n----------------\n"
           end
         end
       end

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/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/test_result/base_test_result.rb

@@ -13,7 +13,8 @@ module GitlabQuality
           "could not be found (502)",
           "Error reference number: 502",
           "(502): `GitLab is not responding`",
-          "<head><title>502 Bad Gateway</title></head>"
+          "<head><title>502 Bad Gateway</title></head>",
+          "14:connections to all backends failing"
         ].freeze
 
         SHARED_EXAMPLES_CALLERS = %w[include_examples it_behaves_like].freeze

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "2.8.0"
+    VERSION = "2.10.0"
   end
 end