dri 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b4a86b6e658b2426bfce682d92f34f1441a9a1812f0cc805088b8c250991d4d
-  data.tar.gz: 3cf2b62c9aa5b1ef8de5cd51f8fdd927fa5335c9a1299b4947ab162b8afe2526
+  metadata.gz: 2b398cef45fa101592e0abecf4d014969e4e26dac5b5e3fd9f7f774b6108618f
+  data.tar.gz: 96a6b402d7dfcccf9fe2e69e01a4ece8af13d56be0213dc8ffa3824ea9a5ed2a
 SHA512:
-  metadata.gz: 4d79cdc2db7e1f959fee5b80988516677455a1d18e151a300923b2d19a58f0bb4fc4342db5e3785c34b5ef4475655b37cb10ad8850e488429ab12cfd8ad03fb8
-  data.tar.gz: 5120e934a2e8a45a51b4328bf5a1ae3af1a55b19e42023e538f65c958bfad0a8810f89844b7f2ef40608d0c7233d64f652ba9f101cff37f203a900d940084771
+  metadata.gz: 9d94573de9142a648b643819381244382a65fedd7c180ae5b78013ea2738204e54e543e43ed5ad6209c2a3ae5a3af4cd1ecb2a7937afa5607b3c04435ce5a2a2
+  data.tar.gz: 48e010a476d8b1a2b48b3b74ba485e7a9c533aa17f96e4639eead23e486f2a309a8f60fed3c282a9b85ec38154cc2bb0b26fdbf28d3389981d1bf26578336b87

data/.gitlab/merge_request_templates/Release.md

@@ -0,0 +1,28 @@
+## Diff
+<!-- Replace `v0.9.0` with the previous DRI release, and `6a9c4fcc150741d578ec75141d3706891b6694bc` with the latest commit from https://gitlab.com/gitlab-org/quality/dri/-/commits/master that will be included in the release -->
+https://gitlab.com/gitlab-org/quality/dri/-/compare/v0.9.0...6a9c4fcc150741d578ec75141d3706891b6694bc
+
+## Release Notes
+
+```markdown
+### Features
+- !aaa <Title of the aaa MR>
+
+### Bug Fixes
+- !bbb <Title of the bbb MR>
+
+### Maintenance
+- !ccc <Title of the ccc MR>
+```
+
+## Checklists 
+
+### Before merging:
+  - [ ] MR title is set to `Bump version to <version>`, where `<version>` is the new version, according to [SemVer](https://semver.org/).
+  - [ ] Diff link is up-to-date.
+  - [ ] Release notes are accurate.
+  - [ ] `lib/dri/version.rb` is updated with the new version number.
+  - [ ] `bundle update` was run to update `Gemfile.lock` with the new version number.
+
+### After merging:
+  - [ ] Update the release notes for the [newly created tag](https://gitlab.com/gitlab-org/quality/dri/-/tags) with the release notes from this MR.

data/.gitlab-ci.yml

@@ -26,7 +26,7 @@ include:
       - /ci/ref-update.gitlab-ci.yml
 
 variables:
-  RUBY_VERSION: "2.7"
+  RUBY_VERSION: "3.0"
 
 stages:
   - build

data/.ruby-version

@@ -1 +1 @@
-3.0.4
+3.0.5

data/.tool-versions

@@ -1 +1 @@
-ruby 3.0.4
+ruby 3.0.5

data/Gemfile.lock

@@ -1,19 +1,20 @@
 PATH
   remote: .
   specs:
-    dri (0.8.0)
+    dri (0.9.0)
       amatch (~> 0.4.1)
-      gitlab (~> 4.18)
-      httparty (~> 0.20.0)
+      gitlab (~> 4.19)
+      httparty (~> 0.21.0)
       json (~> 2.6.1)
       markdown-tables (~> 1.1.1)
       pastel (~> 0.8.0)
-      thor (~> 1.0.1)
+      thor (~> 1.2.0)
       tty-box (~> 0.7.0)
-      tty-config (~> 0.4.0)
-      tty-editor (~> 0.6)
+      tty-config (~> 0.6.0)
+      tty-editor (~> 0.7)
       tty-font (~> 0.5)
       tty-logger (~> 0.6.0)
+      tty-markdown (~> 0.7.0)
       tty-prompt (~> 0.23.1)
       tty-spinner (~> 0.9)
       tty-table (~> 0.12.0)
@@ -21,19 +22,19 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.3)
+    activesupport (7.0.4.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     amatch (0.4.1)
       mize
       tins (~> 1.0)
     ast (2.4.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
@@ -48,37 +49,38 @@ GEM
       rubocop-rails (~> 2.9)
       rubocop-rspec (~> 1.44)
     hashdiff (1.0.1)
-    httparty (0.20.0)
-      mime-types (~> 3.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    json (2.6.2)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
     markdown-tables (1.1.1)
     method_source (1.0.0)
-    mime-types (3.4.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2022.0105)
-    minitest (5.15.0)
-    mize (0.4.0)
+    mini_mime (1.1.2)
+    minitest (5.18.0)
+    mize (0.4.1)
       protocol (~> 2.0)
     multi_xml (0.6.0)
     parallel (1.22.1)
-    parser (3.1.1.0)
+    parser (3.2.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)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.6)
-    rack (2.2.3)
+    public_suffix (5.0.1)
+    rack (3.0.4.2)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
+    rouge (3.30.0)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -101,11 +103,11 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.16.0)
-      parser (>= 3.1.1.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
     rubocop-gitlab-security (0.1.1)
       rubocop (>= 0.51)
-    rubocop-graphql (0.14.2)
+    rubocop-graphql (0.19.0)
       rubocop (>= 0.87, < 2)
     rubocop-performance (1.9.2)
       rubocop (>= 0.90.0, < 2.0)
@@ -117,8 +119,8 @@ GEM
     rubocop-rspec (1.44.1)
       rubocop (~> 0.87)
       rubocop-ast (>= 0.7.1)
-    ruby-progressbar (1.11.0)
-    ruby_parser (3.19.1)
+    ruby-progressbar (1.13.0)
+    ruby_parser (3.20.0)
       sexp_processor (~> 4.16)
     sexp_processor (4.16.1)
     strings (0.2.1)
@@ -129,22 +131,29 @@ GEM
     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)
+    thor (1.2.1)
+    timecop (0.9.6)
+    tins (1.32.1)
       sync
     tty-box (0.7.0)
       pastel (~> 0.8)
       strings (~> 0.2.0)
       tty-cursor (~> 0.7)
     tty-color (0.6.0)
-    tty-config (0.4.0)
+    tty-config (0.6.0)
     tty-cursor (0.7.1)
     tty-editor (0.7.0)
       tty-prompt (~> 0.22)
     tty-font (0.5.0)
     tty-logger (0.6.0)
       pastel (~> 0.8)
+    tty-markdown (0.7.1)
+      kramdown (>= 1.16.2, < 3.0)
+      pastel (~> 0.8)
+      rouge (~> 3.14)
+      strings (~> 0.2.0)
+      tty-color (~> 0.5)
+      tty-screen (~> 0.8)
     tty-prompt (0.23.1)
       pastel (~> 0.8)
       tty-reader (~> 0.8)
@@ -159,11 +168,11 @@ GEM
       pastel (~> 0.8)
       strings (~> 0.2.0)
       tty-screen (~> 0.8)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.8.0)
     unicode_utils (1.4.0)
-    webmock (3.14.0)
+    webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -182,4 +191,4 @@ DEPENDENCIES
   webmock (~> 3.5)
 
 BUNDLED WITH
-   2.3.16
+   2.4.7

data/README.md

@@ -59,6 +59,7 @@ $ dri profile
   - quarantines
   - dequarantines
   - featureflags
+  - runbooks
 - [4. publish](#4-publish)
   - report
 - [5. rm](#5-rm)
@@ -139,6 +140,13 @@ $ 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]
+```
+
+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

data/dri.gemspec

@@ -23,17 +23,18 @@ Gem::Specification.new do |spec|
   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 "gitlab", "~> 4.19"
+  spec.add_dependency 'httparty', '~> 0.21.0'
   spec.add_dependency 'json', '~> 2.6.1'
   spec.add_dependency 'markdown-tables', '~> 1.1.1'
   spec.add_dependency 'pastel', '~> 0.8.0'
-  spec.add_dependency 'thor', '~> 1.0.1'
+  spec.add_dependency 'thor', '~> 1.2.0'
   spec.add_dependency 'tty-box', '~> 0.7.0'
-  spec.add_dependency 'tty-config', '~> 0.4.0'
-  spec.add_dependency 'tty-editor', '~> 0.6'
+  spec.add_dependency 'tty-config', '~> 0.6.0'
+  spec.add_dependency 'tty-editor', '~> 0.7'
   spec.add_dependency 'tty-font', '~> 0.5'
   spec.add_dependency 'tty-logger', '~> 0.6.0'
+  spec.add_dependency 'tty-markdown', '~> 0.7.0'
   spec.add_dependency 'tty-prompt', '~> 0.23.1'
   spec.add_dependency 'tty-spinner', '~> 0.9'
   spec.add_dependency 'tty-table', '~> 0.12.0'

data/lib/dri/api_client.rb

@@ -279,6 +279,28 @@ module Dri
       gitlab.pipeline_jobs(project_id, pipeline_id, options).auto_paginate
     end
 
+    # Fetch runbooks from the runbooks project
+    #
+    # @param [Integer] project_id
+    # @return [Array<Gitlab::ObjectifedHash>]
+    def list_runbooks(project_id = RUNBOOKS_PROJECT_ID)
+      tree = gitlab.tree(project_id, { recursive: true, ref: 'main' }).auto_paginate
+
+      tree.select do |node|
+        node.type == 'tree' && !node.name.start_with?('_')
+      end
+    end
+
+    # Fetches file contents at <path>
+    #
+    # @param [String] path
+    # @param [String] ref
+    # @param [Integer] project_id
+    # @return [Gitlab::ObjectifiedHash]
+    def get_file(path, ref:, project_id:)
+      gitlab.get_file(project_id, path, ref)
+    end
+
     private
 
     attr_reader :token, :ops_token

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+require_relative '../../utils/constants'
+require 'tty-markdown'
+require 'tty-prompt'
+require 'base64'
+
+module Dri
+  module Commands
+    class Fetch
+      class Runbooks < Dri::Command
+        def initialize(options)
+          @options = options
+        end
+
+        def execute(folder: nil, input: $stdin, output: $stdout)
+          return fetch_summary(output: output) unless folder
+
+          fetch_runbook("#{folder}/index.md", output: output)
+        end
+
+        def fetch_summary(output:)
+          logger.info 'Fetching runbooks'
+          prompt = TTY::Prompt.new
+          runbooks = api_client.list_runbooks
+
+          return output.puts 'No runbooks could be found' if runbooks.empty?
+
+          choices = runbooks.map(&:path)
+          path = prompt.select('Which runbook would you like to look at?', choices)
+
+          fetch_runbook("#{path}/index.md", output: output)
+        end
+
+        def fetch_runbook(path, output:)
+          runbook = nil
+          spinner.run do
+            runbook = api_client.get_file(
+              path,
+              ref: 'main',
+              project_id: Utils::Constants::ProjectIDs::RUNBOOKS_PROJECT_ID
+            )
+          rescue Gitlab::Error::NotFound
+            logger.error "The runbook #{path} could not be found."
+          end
+
+          return unless runbook
+
+          content = Base64.decode64(runbook.content)
+          markdown(content, output)
+        end
+
+        private
+
+        def markdown(str, io)
+          io.puts TTY::Markdown.parse(str, symbols: :ascii)
+        end
+      end
+    end
+  end
+end

data/lib/dri/commands/fetch.rb

@@ -94,6 +94,17 @@ module Dri
         require_relative 'fetch/pipelines'
         Dri::Commands::Fetch::Pipelines.new(options).execute
       end
+
+      desc 'runbooks', 'Fetch runbooks'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+
+      def runbooks(*args)
+        return invoke :help, %w[runbooks] if options[:help]
+
+        require_relative 'fetch/runbooks'
+        Dri::Commands::Fetch::Runbooks.new(options).execute(folder: args.first)
+      end
     end
   end
 end

data/lib/dri/utils/constants.rb

@@ -10,6 +10,7 @@ module Dri
         CUSTOMERSDOT_PROJECT_ID     = 2670515
         FEATURE_FLAG_LOG_PROJECT_ID = 15208716
         INFRA_TEAM_PROD_PROJECT_ID  = 7444821
+        RUNBOOKS_PROJECT_ID         = 41045213
       end
 
       module Triage

data/lib/dri/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dri
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dri
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.18'
+        version: '4.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.18'
+        version: '4.19'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.21.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: tty-box
   requirement: !ruby/object:Gem::Requirement
@@ -128,28 +128,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: tty-editor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: tty-font
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: tty-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
@@ -315,6 +329,7 @@ files:
 - ".editorconfig"
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".gitlab/merge_request_templates/Release.md"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
@@ -339,6 +354,7 @@ files:
 - lib/dri/commands/fetch/featureflags.rb
 - lib/dri/commands/fetch/pipelines.rb
 - lib/dri/commands/fetch/quarantines.rb
+- lib/dri/commands/fetch/runbooks.rb
 - lib/dri/commands/fetch/testcases.rb
 - lib/dri/commands/fetch/triaged.rb
 - lib/dri/commands/incidents.rb