dri 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8718d907e41f0cfb472a255898ed513af0fe81ae4cfe782c7aa7d270cb0c2b9f
-  data.tar.gz: 718f976b309b6eb0cab9f65b32e58de5876edd5507aafcc20a2f098068bb5929
+  metadata.gz: 9f99fb005dc6cbc12b4fe9b8b131680c09474c125d7fe396fa3b0fadd8804dba
+  data.tar.gz: dfa14e8f527bfed0d17a428d81ac16955251cba3ef19907016a19bc43901e768
 SHA512:
-  metadata.gz: 643631388b378a127bca182911c9dfb304a1134b568fb71c716976f637f31f2a8d5056c2e30f0f9e2a72e7528e9e7f58a0bda4c0cbc1066efab02c3159353777
-  data.tar.gz: 46514571671417008fe79dadc26cee33b97ad642e61822e2a2097f4e83d774290d1389f3d7d5c6a8ddf7be7a1974d733b4f5cacef3e7c0084af16a37db30ee0d
+  metadata.gz: f7e619cb7241e804810b8cdd97759df84c98aada62c975e0d39fa9f9125219846f5e8bddb50624ce22cc1f836006b023d49375f0a17e298d0f0086d220390e87
+  data.tar.gz: '09e94ad8bc08ffb95839e01456703e81f8ed262c7c925beadeb21d71a816f6632b5772b91af5700901331c5e7560af56b1398ed41ac6dc04d884f61b6ab6043b'

data/.gitignore

@@ -13,4 +13,5 @@
 
 .dri_profile.yml
 handover_reports/*
+analyze_reports/*
 .idea/

data/.gitlab-ci.yml

@@ -1,10 +1,10 @@
 .job_base:
-  image: ruby:2.7
+  image: registry.gitlab.com/gitlab-org/gitlab-build-images/debian-bullseye-ruby-${RUBY_VERSION}:bundler-2.3
   variables:
     BUNDLE_PATH: vendor/bundle
     BUNDLE_SUPPRESS_INSTALL_USING_MESSAGES: "true"
+    BUNDLE_FROZEN: "true"
   before_script:
-    - gem install bundler -v 2.3.9 --no-document
     - bundle install
   cache:
     key:
@@ -13,26 +13,34 @@
         - Gemfile.lock
     paths:
       - vendor/bundle
+    policy: pull
   rules:
     - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
     - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
 
 include:
   - project: gitlab-org/quality/pipeline-common
-    ref: 0.3.4
+    ref: 0.15.1
     file:
       - /ci/gem-release.yml
+      - /ci/ref-update.gitlab-ci.yml
+
+variables:
+  RUBY_VERSION: "2.7"
 
 stages:
   - build
   - test
   - deploy
+  - update
 
 build_gem:
   stage: build
   extends: .job_base
   script:
     - gem build
+  cache:
+    policy: pull-push
 
 rubocop:
   stage: test
@@ -43,13 +51,8 @@ rubocop:
 rspec:
   stage: test
   extends: .job_base
+  parallel:
+    matrix:
+      - RUBY_VERSION: ['2.7', '3.0']
   script:
-    - bundle exec rspec --color
-
-rspec 3.0:
-  stage: test
-  extends: .job_base
-  image: ruby:3.0
-  script:
-    - bundle exec rspec --color
-
+    - bundle exec rspec --force-color

data/.tool-versions

@@ -1 +1 @@
-ruby 3.0.2
+ruby 3.0.4

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    dri (0.3.1)
+    dri (0.6.0)
+      amatch (~> 0.4.1)
       gitlab (~> 4.18)
       httparty (~> 0.20.0)
       json (~> 2.6.1)
@@ -27,14 +28,17 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    amatch (0.4.1)
+      mize
+      tins (~> 1.0)
     ast (2.4.2)
     coderay (1.1.3)
     concurrent-ruby (1.1.10)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
-    gitlab (4.18.0)
-      httparty (~> 0.18)
+    gitlab (4.19.0)
+      httparty (~> 0.20)
       terminal-table (>= 1.5.1)
     gitlab-styles (7.0.0)
       rubocop (~> 0.91, >= 0.91.1)
@@ -56,12 +60,16 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2022.0105)
     minitest (5.15.0)
+    mize (0.4.0)
+      protocol (~> 2.0)
     multi_xml (0.6.0)
     parallel (1.22.1)
     parser (3.1.1.0)
       ast (~> 2.4.1)
     pastel (0.8.0)
       tty-color (~> 0.5)
+    protocol (2.0.0)
+      ruby_parser (~> 3.0)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -110,15 +118,21 @@ GEM
       rubocop (~> 0.87)
       rubocop-ast (>= 0.7.1)
     ruby-progressbar (1.11.0)
+    ruby_parser (3.19.1)
+      sexp_processor (~> 4.16)
+    sexp_processor (4.16.1)
     strings (0.2.1)
       strings-ansi (~> 0.2)
       unicode-display_width (>= 1.5, < 3.0)
       unicode_utils (~> 1.4)
     strings-ansi (0.2.0)
+    sync (0.5.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.0.1)
     timecop (0.9.5)
+    tins (1.31.1)
+      sync
     tty-box (0.7.0)
       pastel (~> 0.8)
       strings (~> 0.2.0)
@@ -162,10 +176,10 @@ DEPENDENCIES
   dri!
   gitlab-styles (~> 7.0.0)
   pry (~> 0.14.1)
-  rake
+  rake (~> 13.0)
   rspec (~> 3.10.0)
   timecop (~> 0.9.1)
   webmock (~> 3.5)
 
 BUNDLED WITH
-   2.3.9
+   2.3.16

data/README.md

@@ -66,7 +66,9 @@ $ dri profile
   - profile
   - reports
 - [6. incidents](#6-incidents)
-- [7. version](#7-version)
+- [7. analyze](#7-analyze)
+  - stacktraces
+- [8. version](#8-version)
 
 #### 1. init
 
@@ -123,12 +125,19 @@ $ 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.
-Results are organized by environment (production, staging, staging ref and preprod).
+
+```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
 
 #### 4. publish
 
@@ -145,6 +154,7 @@ $ dri publish report --format=list # formats the report in a list
 $ dri publish report --format=table # formats the report in a table (default)
 $ dri publish report --dry-run # the report is only generated locally
 $ 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
 ```
 
 **Note:** These options above can be combined like:
@@ -190,7 +200,17 @@ $ dri incidents
 
 Have a quick look at currently active/mitigated incidents on GitLab services.
 
-#### 7. version
+#### 7. analyze
+
+```shell
+$ dri analyze stacktraces
+```
+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
 
 ```shell
 $ dri version

data/dri.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'amatch', '~> 0.4.1'
   spec.add_dependency "gitlab", "~> 4.18"
   spec.add_dependency 'httparty', '~> 0.20.0'
   spec.add_dependency 'json', '~> 2.6.1'
@@ -39,7 +40,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'gitlab-styles', '~> 7.0.0'
   spec.add_development_dependency "pry", "~> 0.14.1"
-  spec.add_development_dependency 'rake'
+  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 'webmock', '~> 3.5'

data/lib/dri/api_client.rb

@@ -3,20 +3,28 @@
 require "httparty"
 require "json"
 require "tty-config"
-require 'cgi'
-require 'gitlab'
+require "cgi"
+require "gitlab"
 
 module Dri
-  class ApiClient
-    API_URL                     = 'https://gitlab.com/api/v4'
-    TESTCASES_PROJECT_ID        = '11229385'
-    TRIAGE_PROJECT_ID           = '15291320'
-    GITLAB_PROJECT_ID           = '278964'
-    FEATURE_FLAG_LOG_PROJECT_ID = '15208716'
-    INFRA_TEAM_PROD_PROJECT_ID  = '7444821'
-
-    def initialize(config)
+  TokenNotProvidedError = Class.new(StandardError)
+  class ApiClient # rubocop:disable Metrics/ClassLength
+    API_URL                     = "https://gitlab.com/api/v4"
+    OPS_API_URL                 = "https://ops.gitlab.net/api/v4"
+    TESTCASES_PROJECT_ID        = "11229385"
+    TRIAGE_PROJECT_ID           = "15291320"
+    GITLAB_PROJECT_ID           = "278964"
+    FEATURE_FLAG_LOG_PROJECT_ID = "15208716"
+    INFRA_TEAM_PROD_PROJECT_ID  = "7444821"
+    def initialize(config, ops = false)
       @token = config.read.dig("settings", "token")
+      @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"
+      end
+
+      @ops_instance = ops
     end
 
     # Fetch triaged failures
@@ -57,6 +65,18 @@ module Dri
       ).auto_paginate
     end
 
+    # Fetch issues related to failing test cases
+    #
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def fetch_test_failure_issues(labels: 'failure::new')
+      gitlab.issues(
+        GITLAB_PROJECT_ID,
+        labels: labels,
+        state: 'opened',
+        scope: "all"
+      ).auto_paginate
+    end
+
     # Fetch related issue mrs
     #
     # @param [Integer] issue_iid
@@ -149,18 +169,73 @@ module Dri
       gitlab.issues(INFRA_TEAM_PROD_PROJECT_ID, order_by: "updated_at", state: "opened", labels: "incident")
     end
 
+    # Fetch pipelines
+    #
+    # @param [Integer] project_id
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def pipelines(project_id:, options:, auto_paginate: false)
+      if auto_paginate
+        gitlab.pipelines(project_id, options).auto_paginate
+      else
+        gitlab.pipelines(project_id, options)
+      end
+    end
+
+    # Fetch single pipeline
+    #
+    # @param [Integer] project_id
+    # @param [Integer] pipeline_id
+    # @return [<Gitlab::ObjectifiedHash>]
+    def pipeline(project_id, pipeline_id)
+      gitlab.pipeline(project_id, pipeline_id)
+    end
+
+    # Fetch test report from a pipeline
+    #
+    # @param [Integer] project_id
+    # @param [Integer] pipeline_id
+    # @return [<Gitlab::ObjectifiedHash>]
+    def pipeline_test_report(project_id, pipeline_id)
+      gitlab.pipeline_test_report(project_id, pipeline_id)
+    end
+
+    # Fetch pipeline bridges/downstream pipelines
+    #
+    # @param [Integer] project_id
+    # @param [Integer] pipeline_id
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def pipeline_bridges(project_id, pipeline_id, options = {})
+      gitlab.pipeline_bridges(project_id, pipeline_id, options).auto_paginate
+    end
+
+    # Fetch jobs from a pipeline
+    #
+    # @param [Integer] project_id
+    # @param [Integer] pipeline_id
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def pipeline_jobs(project_id, pipeline_id, options = {})
+      gitlab.pipeline_jobs(project_id, pipeline_id, options).auto_paginate
+    end
+
     private
 
-    attr_reader :token
+    attr_reader :token, :ops_token
 
     # Gitlab client
     #
     # @return [Gitlab::Client]
     def gitlab
-      @gitlab ||= Gitlab.client(
-        endpoint: API_URL,
-        private_token: token
-      )
+      if @ops_instance
+        @ops_client ||= Gitlab.client(
+          endpoint: OPS_API_URL,
+          private_token: ops_token
+        )
+      else
+        @gitlab_client ||= Gitlab.client(
+          endpoint: API_URL,
+          private_token: token
+        )
+      end
     end
   end
 end

data/lib/dri/cli.rb

@@ -82,5 +82,8 @@ module Dri
 
     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'
   end
 end

data/lib/dri/command.rb

@@ -26,14 +26,14 @@ module Dri
         config = TTY::Config.new
         config.filename = ".dri_profile"
         config.extname = ".yml"
-        config.append_path Dir.pwd
         config.append_path Dir.home
+        config.append_path Dir.pwd
         config
       end
     end
 
-    def api_client
-      ApiClient.new(config)
+    def api_client(ops: false)
+      ApiClient.new(config, ops)
     end
 
     def profile
@@ -52,6 +52,10 @@ module Dri
       @token ||= profile["settings"]["token"]
     end
 
+    def ops_token
+      @ops_token ||= profile["settings"]["ops_token"]
+    end
+
     def timezone
       @timezone ||= profile["settings"]["timezone"]
     end

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+require_relative '../../utils/table'
+require 'amatch'
+require 'fileutils'
+
+module Dri
+  module Commands
+    class Analyze
+      class StackTraces < Dri::Command
+        include Amatch
+        include Dri::Utils::Table
+
+        def initialize(options)
+          @options = options
+          @labels = options[:labels] || 'failure::new'
+          @similarity_score_threshold = options[:similarity_score_threshold] || 0.9
+        end
+
+        def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize
+          verify_config_exists
+          logger.info "#{Time.now.utc} Fetching issues"
+
+          data = []
+
+          spinner.run do
+            response = api_client.fetch_test_failure_issues(labels: @labels)
+            logger.info "#{Time.now.utc} API response completed"
+
+            if response.empty?
+              logger.info 'There are no failure::new issues identified!'
+              exit 0
+            end
+
+            data = identify_similar_issues(response)
+
+            logger.info "#{Time.now.utc} Processing Data Complete"
+          end
+
+          similar_stack_traces = data.each_with_object([]) do |item, similar_items|
+            next if item[:stack_trace].empty?
+            next if item[:related_errors].length < 2
+
+            similar_items << [item[:stack_trace], item[:related_errors]]
+          end
+
+          FileUtils.mkdir_p("#{Dir.pwd}/analyze_reports/stacktraces")
+          report_path = "analyze_reports/stacktraces/report-#{Time.now.utc.to_i}.md"
+          write_report(similar_stack_traces, report_path)
+          logger.success "Analyze StackTraces report is ready at: #{report_path}"
+
+          errors_count = similar_stack_traces.count
+          issues_count = similar_stack_traces.sum { |st| st[1].size }
+          output.puts "Found #{errors_count} common errors across a combination of #{issues_count} issues"
+        end
+
+        private
+
+        def write_report(similar_stack_traces, report_path)
+          File.open(report_path, 'a') do |out_file|
+            out_file.puts "## Stack Trace Analysis"
+            similar_stack_traces.each do |st|
+              out_file.puts "### StackTrace"
+              out_file.puts st[0]
+              out_file.puts "### Related issues"
+              st[1].each { |err| out_file.puts "* #{err}" }
+              out_file.puts "-" * 80
+            end
+          end
+        end
+
+        def identify_similar_issues(response)
+          data = []
+          response.each do |item|
+            stack_trace = extract_stack_trace(item['description'])
+
+            data.find(-> { add_stack_trace(data, stack_trace) }) do |row|
+              calc_similarity(row[:stack_trace], stack_trace) >= @similarity_score_threshold
+            end[:related_errors].append(item['web_url'])
+          end
+          data
+        end
+
+        def add_stack_trace(data, st)
+          obj = { stack_trace: st, related_errors: [] }
+          data.append(obj)
+          obj
+        end
+
+        def extract_stack_trace(description)
+          stack_trace = description[/```(.*)```/m]
+          # Remove common patterns that may impact matching
+          stack_trace&.gsub!(/^*Correlation Id: \S*$/, '')
+          stack_trace&.gsub!(/^*Sentry Url: \S*$/, '')
+          stack_trace&.gsub!(/^*Kibana Url: \S*$/, '')
+          stack_trace || ''
+        end
+
+        def calc_similarity(s1, s2)
+          JaroWinkler.new(s1).match(s2)
+        end
+      end
+    end
+  end
+end

data/lib/dri/commands/analyze.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Dri
+  module Commands
+    class Analyze < Thor
+      namespace :analyze
+
+      desc 'stacktraces', 'Identify commonalities and patterns between stack traces'
+      method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
+      def stacktraces(*)
+        return invoke :help, %w[stacktraces] if options[:help]
+
+        require_relative 'analyze/stack_traces'
+        Dri::Commands::Analyze::StackTraces.new(options).execute
+      end
+    end
+  end
+end

data/lib/dri/commands/fetch/failures.rb

@@ -13,8 +13,9 @@ module Dri
         SORT_BY_OPTIONS = {
           title: 0,
           triaged: 1,
-          author: 2,
-          url: 3
+          environment: 2,
+          author: 3,
+          url: 4
         }.freeze
 
         def initialize(options)
@@ -25,14 +26,16 @@ module Dri
         def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
           verify_config_exists
 
+          urgent_environments = %w[canary canary.staging]
+
           title = add_color('Title', :bright_yellow)
           triaged = add_color('Triaged?', :bright_yellow)
+          environment = add_color('Environment', :bright_yellow)
           author = add_color('Author', :bright_yellow)
           url = add_color('URL', :bright_yellow)
 
           failures = []
-          urgent = []
-          labels = [title, triaged, author, url]
+          labels = [title, triaged, environment, author, url]
           triaged_counter = 0
 
           logger.info "Fetching today's failures..."
@@ -50,6 +53,12 @@ module Dri
               author = failure.to_h.dig('author', 'username')
               url = failure.web_url
               triaged = add_color('x', :red)
+              envs = failure.labels.select { |l| l.include?('found:') }.map do |l|
+                env = l.split(':').last.gsub('.gitlab.com', '')
+
+                env == 'gitlab.com' ? 'production' : env
+              end
+              urgent = urgent_environments.all? { |env| envs.include?(env) }
 
               emoji_awards = api_client.fetch_awarded_emojis(failure.iid).find do |e|
                 e.name == emoji && e.to_h.dig('user', 'username') == username
@@ -61,32 +70,27 @@ module Dri
               end
 
               if @options[:urgent]
-                labels = failure.labels
-
-                labels.each do |label|
-                  if label.include?('found:canary.gitlab.com' && 'found:canary.staging.gitlab.com')
-                    urgent << [title, triaged, author, url]
-                  end
-                end
+                failures << [title, triaged, envs.first, author, url] if urgent
+              else
+                failures << [title, triaged, envs.first, author, url]
               end
-
-              failures << [title, triaged, author, url]
-
-              failures.sort_by! { |e| e[SORT_BY_OPTIONS[@options[:sort_by].to_sym]] } if @options[:sort_by]
             end
-          end
 
-          if @options[:urgent]
-            print_table(labels, urgent, alignments: [:left, :center, :center, :left])
-            output.puts(<<~MSG)
-              Found: #{urgent.size} urgent failures, occurring in both canary.gitlab.com and canary.staging.gitlab.com.
-            MSG
-          else
-            print_table(labels, failures, alignments: [:left, :center, :center, :left])
-            output.puts(<<~MSG)
-              Found: #{failures.size} failures, of these #{triaged_counter} have been triaged with a #{emoji}.
-            MSG
+            failures.sort_by! { |failure| failure[SORT_BY_OPTIONS[@options[:sort_by]&.to_sym || :environment]] }
           end
+
+          msg = if @options[:urgent]
+                  <<~MSG
+                    Found: #{failures.size} urgent failures, occurring in both canary.gitlab.com and canary.staging.gitlab.com.
+                  MSG
+                else
+                  <<~MSG
+                    Found: #{failures.size} failures, of these #{triaged_counter} have been triaged with a #{emoji}.
+                  MSG
+                end
+
+          print_table(labels, failures, alignments: [:left, :center, :center, :left])
+          output.puts(msg)
         end
       end
     end