dri 0.10.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 958c7eb6122525773d9bde35f97de76f3a30cb0377a9379805dd7967a92b69ec
-  data.tar.gz: 47982fd399963bfc28559a1c7b6f7305da3167f2eb787ab4a71f7a571d87d171
+  metadata.gz: 030e595feea9f3659c75e7079815b88eb654b124a338211f9226cb979ad73a5c
+  data.tar.gz: 29ff03db73c44f4aee4d905820e423477e43a182cbc85677ff21a0ea54c98a28
 SHA512:
-  metadata.gz: a7d0d91a974b2070b1137d8f88bc515823b1279c0fcc8a4768d9d4ad5ce498f0400d8e0fac988a74ab0847edf111c9438d87678aa560d3167d95a6937a4f8096
-  data.tar.gz: f167422d5531320a5eb0efd4efa9f1c77c7bed7d7eba0432c3c9235330e9511aa657a19fc8a77b043e139c4b217e0886424aa1d2cbb5c925b8a702ff1b2085cc
+  metadata.gz: cf0b085cff259d0e0bb3f3cffe31699bb50c6b900239d1cad1cd270333097094ae73d0478fe870681d8609f968bbea8a26c85c900c8717c65447e3c5266672cc
+  data.tar.gz: 0da07b06c6052457549eac9b7f116248dd4d534dee659a3fa8bcccb4d55fd796fd4ae4d328914d6ed1e4cf7026fe1fab9cfda2f9bced61d0848eb4276c49ba08

data/.gitlab-ci.yml

@@ -26,7 +26,7 @@ include:
       - /ci/ref-update.gitlab-ci.yml
 
 variables:
-  RUBY_VERSION: "3.0"
+  RUBY_VERSION: "3.1"
 
 stages:
   - build
@@ -53,6 +53,6 @@ rspec:
   extends: .job_base
   parallel:
     matrix:
-      - RUBY_VERSION: ['2.7', '3.0']
+      - RUBY_VERSION: ['3.0', '3.1']
   script:
     - bundle exec rspec --force-color

data/.rubocop.yml

@@ -10,7 +10,9 @@ inherit_gem:
     - rubocop-style.yml
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
+  SuggestExtensions: false
+  NewCops: enable
 
 RSpec/MultipleMemoizedHelpers:
   Max: 25
@@ -51,3 +53,9 @@ Lint/RedundantSafeNavigation:
 
 Style/ClassEqualityComparison:
   Enabled: true
+
+InternalAffairs/MissingCopDepartment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-3.0.5
+3.1.4

data/.tool-versions

@@ -1 +1 @@
-ruby 3.0.5
+ruby 3.1.4

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    dri (0.10.2)
+    dri (0.11.0)
       amatch (~> 0.4.1)
       gitlab (~> 4.19)
       httparty (~> 0.21.0)
+      influxdb-client (~> 2.9)
       json (~> 2.6.1)
       launchy (~> 2.4)
       markdown-tables (~> 1.1.1)
@@ -23,7 +24,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.5)
+    activesupport (7.0.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -42,19 +43,19 @@ GEM
     gitlab (4.19.0)
       httparty (~> 0.20)
       terminal-table (>= 1.5.1)
-    gitlab-styles (7.0.0)
-      rubocop (~> 0.91, >= 0.91.1)
-      rubocop-gitlab-security (~> 0.1.1)
-      rubocop-graphql (~> 0.10)
-      rubocop-performance (~> 1.9.2)
-      rubocop-rails (~> 2.9)
-      rubocop-rspec (~> 1.44)
+    gitlab-styles (10.1.0)
+      rubocop (~> 1.50.2)
+      rubocop-graphql (~> 0.18)
+      rubocop-performance (~> 1.15)
+      rubocop-rails (~> 2.17)
+      rubocop-rspec (~> 2.22)
     hashdiff (1.0.1)
     httparty (0.21.0)
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    i18n (1.13.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
+    influxdb-client (2.9.0)
     json (2.6.3)
     kramdown (2.4.0)
       rexml
@@ -63,13 +64,14 @@ GEM
     markdown-tables (1.1.1)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    minitest (5.18.0)
+    minitest (5.18.1)
     mize (0.4.1)
       protocol (~> 2.0)
     multi_xml (0.6.0)
     parallel (1.23.0)
-    parser (3.2.2.1)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     pastel (0.8.0)
       tty-color (~> 0.5)
     protocol (2.0.0)
@@ -78,10 +80,11 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (5.0.1)
-    rack (3.0.7)
+    racc (1.7.1)
+    rack (3.0.8)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.8.0)
+    regexp_parser (2.8.1)
     rexml (3.2.5)
     rouge (4.1.1)
     rspec (3.10.0)
@@ -97,31 +100,35 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
-    rubocop (0.93.1)
+    rubocop (1.50.2)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
-      rexml
-      rubocop-ast (>= 0.6.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.28.1)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
-    rubocop-gitlab-security (0.1.1)
-      rubocop (>= 0.51)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
     rubocop-graphql (0.19.0)
       rubocop (>= 0.87, < 2)
-    rubocop-performance (1.9.2)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.9.1)
+    rubocop-rails (2.20.2)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
-    rubocop-rspec (1.44.1)
-      rubocop (~> 0.87)
-      rubocop-ast (>= 0.7.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
     ruby_parser (3.20.1)
       sexp_processor (~> 4.16)
@@ -173,7 +180,7 @@ GEM
       tty-screen (~> 0.8)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.8.0)
+    unicode-display_width (2.4.2)
     unicode_utils (1.4.0)
     webmock (3.18.1)
       addressable (>= 2.8.0)
@@ -186,7 +193,7 @@ PLATFORMS
 
 DEPENDENCIES
   dri!
-  gitlab-styles (~> 7.0.0)
+  gitlab-styles (~> 10)
   pry (~> 0.14.1)
   rake (~> 13.0)
   rspec (~> 3.10.0)

data/README.md

@@ -56,8 +56,6 @@ $ dri profile
   - failures
   - testcases
   - triaged
-  - quarantines
-  - dequarantines
   - featureflags
   - runbooks
 - [4. publish](#4-publish)
@@ -103,8 +101,8 @@ There is the possibility to customise the timeframe for such failures by passing
 a `--cutoff=HH:MM` to just show failures after a certain period of the day. The cutoff
 time will be converted to UTC.
 
-To surface most urgent issues pass the `--urgent` flag to see issues that are both
-in `canary` and `staging-canary` pipelines just during today's timespan.
+Smoke and Reliable failures will be highlighted in bold and in between *'s. These require
+to have set `QA_INFLUXDB_URL` and `QA_INFLUXDB_TOKEN` environment variables to be found in 1Password.
 
 ```shell
 $ dri fetch testcases
@@ -120,19 +118,6 @@ $ dri fetch triaged
 
 Fetches triaged failures which use the triage emoji specified in `dri profile`.
 
-```shell
-$ dri fetch quarantines
-```
-
-Fetches open quarantine Merge Requests to be reviewed
-
-```shell
-$ dri fetch dequarantines
-```
-
-Fetches open dequarantine Merge Requests to be reviewed
-
-Results are organized by environment (production, staging, staging ref and preprod).
 ```shell
 $ dri fetch featureflags
 ```

data/dri.gemspec

@@ -6,12 +6,12 @@ Gem::Specification.new do |spec|
   spec.name          = 'dri'
   spec.license       = 'MIT'
   spec.version       = Dri::VERSION
-  spec.authors       = ['GitLab Quality']
+  spec.authors       = ['Test Platform']
   spec.email         = ['quality+dri@gitlab.com']
 
   spec.summary       = 'CLI app to help triage GitLab QA pipelines'
-  spec.homepage      = 'https://gitlab.com/gitlab-org/quality/dri'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+  spec.homepage      = 'https://gitlab.com/gitlab-org/ruby/gems/dri'
+  spec.required_ruby_version = '>= 3.0.0'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'amatch', '~> 0.4.1'
   spec.add_dependency "gitlab", "~> 4.19"
   spec.add_dependency 'httparty', '~> 0.21.0'
+  spec.add_dependency 'influxdb-client', '~> 2.9'
   spec.add_dependency 'json', '~> 2.6.1'
   spec.add_dependency 'launchy', '~> 2.4'
   spec.add_dependency 'markdown-tables', '~> 1.1.1'
@@ -40,7 +41,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'tty-spinner', '~> 0.9'
   spec.add_dependency 'tty-table', '~> 0.12.0'
 
-  spec.add_development_dependency 'gitlab-styles', '~> 7.0.0'
+  spec.add_development_dependency 'gitlab-styles', '~> 10'
   spec.add_development_dependency "pry", "~> 0.14.1"
   spec.add_development_dependency 'rake', "~> 13.0"
   spec.add_development_dependency 'rspec', '~> 3.10.0'

data/faq.yaml

@@ -1,21 +1,21 @@
 ---
 - question: "Which pipelines we currently have and what is their running cadence?"
-  link: "https://about.gitlab.com/handbook/engineering/quality/quality-engineering/debugging-qa-test-failures/#qa-test-pipelines"
+  link: "https://about.gitlab.com/handbook/engineering/infrastructure/test-platform/debugging-qa-test-failures/#qa-test-pipelines"
 - question: "Where can I find the rotation schedule?"
   link: "https://gitlab.com/gitlab-org/quality/pipeline-triage#dri-weekly-rotation-schedule"
 - question: "What is the process to quarantine a test?"
-  link: "https://about.gitlab.com/handbook/engineering/quality/quality-engineering/debugging-qa-test-failures/#quarantining-tests"
+  link: "https://about.gitlab.com/handbook/engineering/infrastructure/test-platform/debugging-qa-test-failures/#quarantining-tests"
 - question: "What is the process to dequarantine a test?"
-  link: "https://about.gitlab.com/handbook/engineering/quality/quality-engineering/debugging-qa-test-failures/#dequarantining-tests"
+  link: "https://about.gitlab.com/handbook/engineering/infrastructure/test-platform/debugging-qa-test-failures/#dequarantining-tests"
 - question: "What are the failure classification labels?"
-  link: "https://about.gitlab.com/handbook/engineering/quality/quality-engineering/debugging-qa-test-failures/#classify-and-triage-the-test-failure"
+  link: "https://about.gitlab.com/handbook/engineering/infrastructure/test-platform/debugging-qa-test-failures/#classify-and-triage-the-test-failure"
 - question: "I have a correlation ID. How to find logs from various GitLab components?"
-  link: "https://about.gitlab.com/handbook/engineering/quality/quality-engineering/debugging-qa-test-failures/#kibana-correlation-dashboards"
+  link: "https://about.gitlab.com/handbook/engineering/infrastructure/test-platform/debugging-qa-test-failures/#kibana-correlation-dashboards"
 - question: "Where do I find the MR that introduced a feature flag?"
   link: "https://samdbeckham.gitlab.io/feature-flags/#%5B%7B%22type%22:%22filtered-search-term%22,%22value%22:%7B%22data%22:%22%22%7D%7D%5D"
 - question: "What to do when a failure needs escalation?"
-  link: "https://about.gitlab.com/handbook/engineering/quality/quality-engineering/debugging-qa-test-failures/#failure-needs-escalation"
+  link: "https://about.gitlab.com/handbook/engineering/infrastructure/test-platform/debugging-qa-test-failures/#failure-needs-escalation"
 - question: "I have an MR to fix the failure. How I make sure it is merged as soon as possible?"
-  link: "https://about.gitlab.com/handbook/engineering/quality/quality-engineering/debugging-qa-test-failures/#fixing-the-test"
+  link: "https://about.gitlab.com/handbook/engineering/infrastructure/test-platform/debugging-qa-test-failures/#fixing-the-test"
 
 

data/lib/dri/api_client.rb

@@ -22,7 +22,7 @@ module Dri
       @ops_token = config.read.dig("settings", "ops_token")
       if @token.nil? || @ops_token.nil?
         raise TokenNotProvidedError, "Gitlab API client cannot be initialized without both access tokens. " \
-                              "Run `dri init` again or `dri profile --edit` to add an ops_token entry."
+                                     "Run `dri init` again or `dri profile --edit` to add an ops_token entry."
       end
 
       @ops_instance = ops
@@ -93,7 +93,7 @@ module Dri
         labels: "#{pipeline}::failed",
         state: state,
         scope: "all",
-        "not[labels]": QUARANTINE
+        'not[labels]': QUARANTINE
       ).auto_paginate
     end
 
@@ -313,6 +313,52 @@ module Dri
       gitlab.get_file(project_id, path, ref)
     end
 
+    def get_fast_quarantine_tests
+      gitlab.file_contents(
+        FAST_QUARANTINE_PROJECT_ID,
+        'rspec/fast_quarantine-gitlab.txt',
+        'main'
+      )
+    end
+
+    def get_failure_issue_title(issue_id)
+      issue = gitlab.issue(GITLAB_PROJECT_ID, issue_id)
+      issue.title
+    end
+
+    def add_test_to_fast_quarantine(failure_url, new_branch, test_path, new_file_content)
+      gitlab.create_branch(
+        FAST_QUARANTINE_PROJECT_ID,
+        new_branch,
+        'main'
+      )
+
+      gitlab.edit_file(
+        FAST_QUARANTINE_PROJECT_ID,
+        'rspec/fast_quarantine-gitlab.txt',
+        new_branch,
+        new_file_content,
+        'Add test to quarantine'
+      )
+
+      gitlab.create_merge_request(
+        FAST_QUARANTINE_PROJECT_ID,
+        "Quarantine #{test_path}", {
+          source_branch: new_branch,
+          target_branch: 'main',
+          description: "Fast quarantine for `#{test_path}`. Failure: #{failure_url}."
+        }
+      )
+    end
+
+    def add_note_failure_issue(issue_id, merge_request)
+      gitlab.create_issue_note(
+        GITLAB_PROJECT_ID,
+        issue_id,
+        "Applying fast quarantine at #{merge_request.web_url}."
+      )
+    end
+
     private
 
     attr_reader :token, :ops_token

data/lib/dri/cli.rb

@@ -102,5 +102,11 @@ module Dri
 
     require_relative 'commands/analyze'
     register Dri::Commands::Analyze, 'analyze', 'analyze [SUBCOMMAND]', 'Analysis of test failures and issues'
+
+    require_relative 'commands/view'
+    register Dri::Commands::View, 'view', 'view [SUBCOMMAND]', 'View relevant items to help triage'
+
+    require_relative 'commands/add'
+    register Dri::Commands::Add, 'add', 'add [SUBCOMMAND]', 'Add relevant items to help triage'
   end
 end

data/lib/dri/command.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'command'
 require_relative 'api_client'
 require_relative 'gitlab/issues'
 
@@ -79,6 +78,10 @@ module Dri
       @options[:no_color] ? str : pastel.decorate(str, *color)
     end
 
+    def bold(str)
+      pastel.bold(str)
+    end
+
     # Execute this command
     #
     # @api public

data/lib/dri/commands/add/fast_quarantine.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+
+module Dri
+  module Commands
+    class Add
+      class FastQuarantine < Dri::Command
+        def initialize(options)
+          @options = options
+        end
+
+        def execute(*) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          verify_config_exists
+
+          logger.info "Adding to fast quarantined tests..."
+          current_content = api_client.get_fast_quarantine_tests
+          current_content += "\n" unless current_content.end_with?("\n")
+
+          if @options[:failure_url]
+            failure_url = @options[:failure_url]
+            issue_id = extract_issue_id_from_url(failure_url)
+
+            issue_title = api_client.get_failure_issue_title(issue_id)
+            test_path = extract_file_path(issue_title)
+
+            full_path = "qa/specs/features/#{test_path}"
+            new_file_content = "#{current_content}#{full_path}\n"
+
+            new_branch = "fast-quarantine-failure-#{issue_id}"
+
+            merge_request = api_client.add_test_to_fast_quarantine(
+              failure_url,
+              new_branch,
+              test_path,
+              new_file_content
+            )
+
+            logger.info "Opened an MR to review at #{merge_request.web_url}"
+
+            api_client.add_note_failure_issue(issue_id, merge_request)
+            logger.success "Note added to failure issue with link to fastquarantine merge request"
+          elsif @options[:test_id]
+            test_id = @options[:test_id]
+            parsed_test_name = test_id.match(%r{([^/]+)_spec})[1]
+            new_branch = "fast-quarantine-failure-#{parsed_test_name.tr('_', '-')}"
+
+            new_file_content = "#{current_content}#{test_id}\n"
+            merge_request = api_client.add_test_to_fast_quarantine(
+              "N/A",
+              new_branch,
+              test_id,
+              new_file_content
+            )
+
+            logger.info "Opened an MR to review at #{merge_request.web_url}"
+          end
+        end
+
+        private
+
+        def extract_issue_id_from_url(url)
+          match = url.match(%r{/issues/(\d+)$})
+          match ? match[1].to_i : nil
+        end
+
+        def extract_file_path(title)
+          match = title.match(/Failure in (.*?\.rb)/)
+          match ? match[1] : nil
+        end
+      end
+    end
+  end
+end

data/lib/dri/commands/add.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Dri
+  module Commands
+    class Add < Thor
+      namespace :add
+      # rubocop:disable Layout/LineLength
+      full_description = <<-DESC
+      Creates a fast-quarantine merge request
+
+      Examples:#{'  '}
+        dri add fastquarantine -f https://gitlab.com/gitlab-org/gitlab/-/issues/431736 # using failure issue
+        dri add fastquarantine -t qa/specs/features/ee/api/14_model_ops/code_suggestions_spec.rb # using test file
+        dri add fastquarantine -t ee/spec/features/boards/swimlanes/epics_swimlanes_sidebar_spec.rb:42 # using test file and line number
+        dri add fastquarantine -t "spec/tasks/gitlab/usage_data_rake_spec.rb[1:5:2:1]" # using test id
+      DESC
+      desc 'fastquarantine', full_description
+      method_option :failure_url, aliases: '-f', type: :string,
+                                  desc: 'Failure URL, for example: https://gitlab.com/gitlab-org/gitlab/-/issues/431736'
+      method_option :test_id, aliases: '-t', type: :string,
+                              desc: 'Test path, for example:  qa/specs/features/ee/api/14_model_ops/code_suggestions_spec.rb'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      # rubocop:enable Layout/LineLength
+      def fastquarantine(*)
+        if options[:help]
+          invoke :help, ['fastquarantine']
+          return
+        end
+
+        if options[:failure_url].nil? && options[:test_id].nil?
+          say 'Validation error: either failure_url or test_id is required.', :red
+          return
+        elsif options[:failure_url] && options[:test_id]
+          say 'Validation error: only one of failure_url or test_id should be provided, not both.', :red
+          return
+        end
+
+        require_relative 'add/fast_quarantine'
+        Dri::Commands::Add::FastQuarantine.new(options).execute
+      end
+    end
+  end
+end

data/lib/dri/commands/analyze/stack_traces.rb

@@ -20,7 +20,7 @@ module Dri
           @similarity_score_threshold = options[:similarity_score_threshold] || 0.9
         end
 
-        def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize
+        def execute(_input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize
           verify_config_exists
           logger.info "#{Time.now.utc} Fetching issues"
 

data/lib/dri/commands/faq.rb

@@ -9,7 +9,7 @@ module Dri
     class FAQ < Dri::Command
       ExitCommand = Class.new(StandardError)
 
-      def execute(input: $stdin, output: $stdout)
+      def execute(*)
         root_dir = File.expand_path('../../..', __dir__)
         faq_file = File.join(root_dir, 'faq.yaml')
         faq_data = YAML.load_file(faq_file)