dri 0.10.2 → 1.1.0

data/README.md

@@ -1,95 +1,88 @@
-# DRI
+# DRI Gem
 
-So, are you the **D**irectly **R**esponsible **I**ndividual for GitLab's QA pipelines this week? Looking for a gem to help triage and report failing tests? Look no further.
-
-Welcome to your new gem! DRI is a CLI ready to help:
+The DRI (Directly Responsible Individual) gem is your CLI companion for managing GitLab's QA pipelines. Tailored for those in charge of pipeline quality assurance, it simplifies the triage and reporting of failing tests. Key features include:
 
 - Fetching failing test cases by pipeline
-- Reporting at the end of the timezone shift
-- View today's newest and untriaged failures
-- Mark actions on failures
+- Reporting failures at the end of the timezone shift
+- Viewing today's newest and untriaged failures
+- Marking actions on failures
 
-... and more
 
 ## Installation
 
-To install the `dri` gem:
+Install dri using the following command:
 
 ```shell
 $ gem install dri
 ```
 
-And then execute `dri` to see all available options:
+Execute `dri` to see all available options:
 
 ```shell
 $ dri
 ```
 
-## Usage
+## Installing from source
 
-### Configuration
+After cloning this repository, build dri from source using the following command:
+
+```shell
+$ gem build dri.gemspec
+```
 
-To use `dri` fully it is necessary to have:
+A gemfile will be generated with the current version number, e.g. `dri-0.11.0.gem`. Install using the command:
 
-- a Personal Access Token
-- a triage emoji
+```shell
+$ gem install dri-0.11.0.gem
+```
 
-The emoji is the [Award/My Reaction](https://docs.gitlab.com/ee/user/award_emojis.html) emoji associated with the failure issues to group all failures triaged on a given day. This emoji is a personal choice. Note that the same emoji should be used only while triaging failures and not associated with other issues out of the scope of triage.
+## Getting Started
 
-To set up your personal profile:
+### Configuration
+
+Before diving into dri, ensure you have:
+
+* A Personal Access Token for authentication.
+* A triage emoji to mark triaged failures
+
+Configure your profile with:
 
 ```shell
 $ dri init
 ```
 
-To verify the profile is correctly set:
+To view or edit your profile:
 
 ```shell
 $ dri profile
 ```
 
-### Commands
-
-- [1. init](#1-init)
-- [2. profile](#2-profile)
-- [3. fetch](#3-fetch)
-  - failures
-  - testcases
-  - triaged
-  - quarantines
-  - dequarantines
-  - featureflags
-  - runbooks
-- [4. publish](#4-publish)
-  - report
-- [5. rm](#5-rm)
-  - emoji
-  - profile
-  - reports
-- [6. incidents](#6-incidents)
-- [7. analyze](#7-analyze)
-  - stacktraces
-- [8. version](#8-version)
-- [9. faq](#8-faq)
-
-#### 1. init
+### Usage
 
 ```shell
-$ dri init
+$ dri help
 ```
 
-Initializes the `dri` CLI with necessary configurations to run smoothly.
+`dri` supports a variety of commands to streamline your workflow:
 
-#### 2. profile
+- init: Set up dri with necessary configurations.
+- profile: Display or edit your user profile.
+- fetch: Retrieve information on failures, test cases, triaged issues, feature flags, and more.
+- publish: Generate and publish reports.
+- rm: Remove emojis, profiles, or reports.
+- incidents: View active or mitigated incidents.
+- analyze: Analyze stack traces for common failures.
+- version: Check the installed version of dri.
+- faq: Access FAQs related to on-call operations.
 
-```shell
-$ dri profile
-```
 
-Shows the current profile associated after initial configuration.
-Pass the option `--edit` to edit the current profile.
+#### Command Details
 
-#### 3. fetch
+- fetch: Use options like --start_date, --end_date, and --cutoff to customize your queries.
+- publish report: Customize reports with --format, --dry-run, --actions, and --feature-flags options.
+- rm: Manage your environment by cleaning up emojis, profiles, or locally stored reports.
+
+Example Commands:
 
 ```shell
 $ dri fetch failures
@@ -98,13 +91,8 @@ $ dri fetch failures
 Fetches today's opened failures and lists them according to their triage status.
 Helpful to understand if there are missing recent failures to be reviewed.
 
-There is the possibility to customise the timeframe for such failures by passing a
-`--start_date=DD-MM-YYYY` and `--end_date=DD-MM-YYYY`. It is also possible to pass
-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.
+**Note:**  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
@@ -118,33 +106,13 @@ To filter the pipelines, pass the `--filter-pipelines` options to multi-select t
 $ 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
-```
-
-Fetches a list of today's feature flag changes, including the date and time in UTC of when the change occurred as well as a link to the corresponding issue from the feature-flag-log project.
+Fetches triaged failures.
 
 ```shell
 $ dri fetch pipelines
 ```
 
 Fetches a table containing last executed pipeline and its test report link for all monitored pipelines.
-The timestamps are in UTC
 
 ```shell
 $ dri fetch runbooks [runbook]
@@ -153,14 +121,11 @@ $ dri fetch runbooks [runbook]
 Fetches a runbook from the [runbooks](https://gitlab.com/gitlab-org/quality/runbooks) project.
 If `[runbook]` is omitted, the command will prompt the user to select from a list of available runbooks.
 
-#### 4. publish
-
 ```shell
 $ dri publish report
 ```
 
-Publishes a handover report on the latest triage issue, in the [pipeline-triage](https://gitlab.com/gitlab-org/quality/pipeline-triage) project.
-The report includes automatically both triaged failures and incidents.
+Publishes a handover report on the latest weekly triage issue.
 
 **Options**
 
@@ -172,22 +137,13 @@ $ dri publish report --actions # activate the actions prompt for each failure
 $ dri publish report --feature-flags # includes a summary of the feature flag changes on each environment
 $ dri publish report --update # update the report note if has already been posted
 ```
-
+---
 **Note:** These options above can be combined like:
 
 ```shell
 $ dri publish report --format=list --dry-run --actions --update
 ```
-
-**Actions**
-
-When using `--actions` a set of actions are prompt on each failure. Use `Space` to
-mark several actions: `pinged SET`, `quarantined`, `reproduced`, `transient`.
-Hitting `Enter` without a selected action will skip marking the actions for a given
-failure.
-
-#### 5. rm
-
+---
 ```shell
 $ dri rm emoji
 ```
@@ -208,41 +164,60 @@ $ dri rm profile
 
 Removes the profile currently in use.
 
-#### 6. incidents
-
 ```shell
 $ dri incidents
 ```
 
 Have a quick look at currently active/mitigated incidents on GitLab services.
 
-#### 7. analyze
-
 ```shell
-$ dri analyze stacktraces
+$ dri faq
 ```
-Searches through any open test failure issues and publishes a report that identifies
-issues that have similar stack traces. 
-This may be useful to identify situations where a common test failure is presenting 
-itself across multiple individual test cases, over a period of time. 
 
-#### 8. version
+Returns a list of questions and answers related to on-call operations. This leverages
+existing pages of documentation, redirecting directly to the relevant section to help
+with a problem.
+
+## Development
+
+### Initial setup
+- Check out the repo [dri](https://gitlab.com/gitlab-org/ruby/gems/dri)
+- Then run 
 
 ```shell
-$ dri version
+bundle install
 ```
 
-`dri` gem version.
-
-#### 9. faq
+### Activate lefthook locally
 
 ```shell
-$ dri faq
+lefthook install
 ```
 
-Returns a list of questions and answers related to on-call operations. This leverages
-existing pages of documentation, redirecting directly to the relevant section to help
-with a problem.
+## Release
+
+[Automated gem release process](https://gitlab.com/gitlab-org/components/gem-release/-/tree/main?ref_type=heads#gem-release-component) is used to release new version of `dri` through pipelines, and this will:
+
+- Publish the gem: https://rubygems.org/gems/dri
+- Add a release in the `dri` project: https://gitlab.com/gitlab-org/ruby/gems/dri/-/releases
+- Populate the release log with the API contents. For example: https://gitlab.com/api/v4/projects/52612795/repository/changelog?version=1.0.0
+
+### Before release
+
+Make sure to include a changelog entry in your commit message and read the [changelog entries section](https://docs.gitlab.com/ee/development/changelog.html).
+
+If you forget to set the changelog entry in your commit messages, you can also edit the release notes after it's being released.
+
+### Steps to release
+
+- Update the version number in `lib/dri/version.rb` with the new gem version.
+- Run `bundle install` locally to update gem version in `Gemfile.lock` .
+- Use the `Release` merge request template and create a merge request to submit these changes. Then get the merge request merged by a maintainer.
+
+This will then be packaged into a gem and pushed to [rubygems.org](https://rubygems.org) by the CI/CD.
+
+For example: [Upgrades gem from 2.7.0 to 2.8.0](https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling/-/merge_requests/286).
+
 ## Copyright
 
 Copyright (c) 2022 GitLab, Inc. See [MIT License](LICENSE.txt) for further details.

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.
@@ -22,9 +22,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activesupport', '~> 7.1'
   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'
@@ -39,11 +41,14 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'tty-prompt', '~> 0.23.1'
   spec.add_dependency 'tty-spinner', '~> 0.9'
   spec.add_dependency 'tty-table', '~> 0.12.0'
+  spec.add_dependency 'zeitwerk', '~> 2.6'
 
-  spec.add_development_dependency 'gitlab-styles', '~> 7.0.0'
+  spec.add_development_dependency 'gitlab-styles', '~> 10'
+  spec.add_development_dependency "lefthook", "~> 1.3"
   spec.add_development_dependency "pry", "~> 0.14.1"
   spec.add_development_dependency 'rake', "~> 13.0"
   spec.add_development_dependency 'rspec', '~> 3.10.0'
   spec.add_development_dependency "timecop", "~> 0.9.1"
+  spec.add_development_dependency 'vcr', '~> 6.2.0'
   spec.add_development_dependency 'webmock', '~> 3.5'
 end

data/exe/dri

@@ -3,7 +3,8 @@
 
 lib_path = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
-require 'dri/cli'
+
+require 'dri'
 
 Signal.trap('INT') do
   warn("\n#{caller.join("\n")}: interrupted")

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/lefthook.yml

@@ -0,0 +1,24 @@
+# Lefthook configuration. For more information, see:
+# https://lefthook.dev/configuration/index.html
+
+pre-push:
+  parallel: true
+  commands:
+    # Run ruby linting
+    rubocop:
+      run: bundle exec rubocop
+      glob: '*.rb'
+
+    # Changelog git trailer for the first commit of the branch
+    changelog-on-first-commit:
+      run: |
+        git fetch origin main
+        first_commit_message=$(git log --format=%B -n 1 $(git log origin/main..HEAD --pretty=format:"%h" | tail -1))
+        if ! echo ${first_commit_message} | grep "Changelog:"; then
+          echo Could not find a Changelog: git trailer on the first commit for this branch.
+          echo
+          echo Please add a trailer by amending the git commit message.
+          echo
+          echo See https://docs.gitlab.com/ee/development/changelog.html#overview for more info.
+          exit 1
+        fi

data/lib/dri/api_client.rb

@@ -6,13 +6,12 @@ require "tty-config"
 require "cgi"
 require "gitlab"
 
-require_relative './utils/constants'
-
 module Dri
   TokenNotProvidedError = Class.new(StandardError)
   class ApiClient # rubocop:disable Metrics/ClassLength
     include Dri::Utils::Constants::ProjectIDs
     include Dri::Utils::Constants::Triage::Labels
+    using Refinements::Gitlab
 
     API_URL                     = "https://gitlab.com/api/v4"
     OPS_API_URL                 = "https://ops.gitlab.net/api/v4"
@@ -22,7 +21,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 +92,7 @@ module Dri
         labels: "#{pipeline}::failed",
         state: state,
         scope: "all",
-        "not[labels]": QUARANTINE
+        'not[labels]': QUARANTINE
       ).auto_paginate
     end
 
@@ -136,7 +135,11 @@ module Dri
     #
     # @return [Gitlab::ObjectifiedHash]
     def fetch_current_triage_issue
-      gitlab.issues(TRIAGE_PROJECT_ID, state: "opened", order_by: "updated_at")
+      issues = gitlab.issues(TRIAGE_PROJECT_ID, labels: "triage report", state: "opened")
+
+      issues.find do |issue|
+        issue.title.include?('Pipeline Triage Report')
+      end
     end
 
     # Create triage report note
@@ -160,34 +163,26 @@ module Dri
 
     # Fetch all new failures
     #
-    # @param [String] start_date
-    # @param [String] end_date
+    # @param [Time] start_date
+    # @param [Time] end_date
     # @param [String] state
     # @return [Array<Gitlab::ObjectifiedHash>]
     def fetch_all_new_failures(start_date:, end_date:, state:)
-      project_ids = [GITLAB_PROJECT_ID, CUSTOMERSDOT_PROJECT_ID]
-      failures = []
-
-      start_date_iso = start_date.strftime('%Y-%m-%dT00:00:00Z')
-      end_date_iso = end_date.strftime('%Y-%m-%dT23:59:59Z')
-
-      project_ids.each do |project_id|
-        failures += fetch_new_failures(
+      [GITLAB_PROJECT_ID, CUSTOMERSDOT_PROJECT_ID].flat_map do |project_id|
+        fetch_new_failures(
           project_id: project_id,
-          start_date: start_date_iso,
-          end_date: end_date_iso,
+          start_date: start_date,
+          end_date: end_date,
           state: state
         )
       end
-
-      failures
     end
 
     # Fetch new failures for a given project
     #
     # @param [Integer] project_id
-    # @param [String] start_date
-    # @param [String] end_date
+    # @param [Time] start_date
+    # @param [Time] end_date
     # @param [String] state
     # @return [Array<Gitlab::ObjectifiedHash>]
     def fetch_new_failures(project_id:, start_date:, end_date:, state:)
@@ -198,8 +193,8 @@ module Dri
         sort: 'desc',
         state: state,
         scope: "all",
-        created_after: start_date,
-        created_before: end_date,
+        created_after: start_date.dup.utc.iso8601, # utc modifies the receiver, so making a copy
+        created_before: end_date.dup.utc.iso8601,
         per_page: 100
       )
     end
@@ -313,6 +308,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
@@ -322,12 +363,12 @@ module Dri
     # @return [Gitlab::Client]
     def gitlab
       if @ops_instance
-        @ops_client ||= Gitlab.client(
+        @ops_client ||= ::Gitlab.client(
           endpoint: OPS_API_URL,
           private_token: ops_token
         )
       else
-        @gitlab_client ||= Gitlab.client(
+        @gitlab_client ||= ::Gitlab.client(
           endpoint: API_URL,
           private_token: token
         )

data/lib/dri/cli.rb

@@ -29,7 +29,6 @@ module Dri
 
     desc 'version', 'dri version'
     def version
-      require_relative 'version'
       puts "v#{Dri::VERSION}"
     end
     map %w[--version -v] => :version
@@ -41,12 +40,10 @@ module Dri
       if options[:help]
         invoke :help, ['incidents']
       else
-        require_relative 'commands/incidents'
         Dri::Commands::Incidents.new(options).execute
       end
     end
 
-    require_relative 'commands/rm'
     register Dri::Commands::Rm, 'rm', 'rm [SUBCOMMAND]', 'Remove triage-related items'
 
     desc 'profile', 'View current user settings'
@@ -60,7 +57,6 @@ module Dri
       if options[:help]
         invoke :help, ['profile']
       else
-        require_relative 'commands/profile'
         Dri::Commands::Profile.new(options).execute
       end
     end
@@ -72,7 +68,6 @@ module Dri
       if options[:help]
         invoke :help, ['init']
       else
-        require_relative 'commands/init'
         Dri::Commands::Init.new(options).execute
       end
     end
@@ -86,7 +81,6 @@ module Dri
         invoke :help, ['faq']
       else
         begin
-          require_relative 'commands/faq'
           Dri::Commands::FAQ.new(options).execute
         rescue Dri::Commands::FAQ::ExitCommand
           puts "Exiting faq command..."
@@ -94,13 +88,10 @@ module Dri
       end
     end
 
-    require_relative 'commands/fetch'
     register Dri::Commands::Fetch, 'fetch', 'fetch [SUBCOMMAND]', 'Fetch failures & testcases'
-
-    require_relative 'commands/publish'
     register Dri::Commands::Publish, 'publish', 'publish [SUBCOMMAND]', 'Publish report for handover'
-
-    require_relative 'commands/analyze'
     register Dri::Commands::Analyze, 'analyze', 'analyze [SUBCOMMAND]', 'Analysis of test failures and issues'
+    register Dri::Commands::View, 'view', 'view [SUBCOMMAND]', 'View relevant items to help triage'
+    register Dri::Commands::Add, 'add', 'add [SUBCOMMAND]', 'Add relevant items to help triage'
   end
 end