dri 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1c589c770547e0142cb5b2942316e41af19cad293ed2e141d95e54a7379f741
-  data.tar.gz: b1cc881757273745c40485c469b34abb642a8edcda18ae1baf22bfe80ed8bacd
+  metadata.gz: 3ae68ce5f20bab397121604708b813e8f488316559f82392a389f1750e57c89c
+  data.tar.gz: 30b16b0291beb7e18cc74acb9c54100c869544bba883c79729f577c8bda5dd7f
 SHA512:
-  metadata.gz: 0fa73e3af14a31bcf96f919c1b37465695a52a7db5d0fcaedf8ee36e51c817bf4c789c3fe24bc2169de0b385b83d0ec92ae716f8da6fbb55cb134c6219a0b26a
-  data.tar.gz: 880ae4a81c350dcfe7b49c9db00c3760d7f98b56383b7516d0c890dae24034fc3d8ebb86f37592c8d65655c3cbe8671bddf3c26327d49a6006b0e9f5f0313afa
+  metadata.gz: ad35cf45172de050ecd86c376527abc98ba535f9ad97f54f84f7be3875882c46ae897039d26a4c9f4db3c7df598608c81e8613518b7c7eeb44b7903610899406
+  data.tar.gz: a790667c5528fc3ad94f610b2add55b36a4fb5efd9bad3e8e10a78d44e58a8140721d4717a75def60ca829715389bebf001704a38a1a8127e1e6872228dd0fe6

data/.gitlab-ci.yml

@@ -1,9 +1,10 @@
 .job_base:
-  image: ruby:3.1
+  image: ruby:2.7
   variables:
     BUNDLE_PATH: vendor/bundle
     BUNDLE_SUPPRESS_INSTALL_USING_MESSAGES: "true"
   before_script:
+    - gem install bundler -v 2.3.9 --no-document
     - bundle install
   cache:
     key:
@@ -33,8 +34,14 @@ build_gem:
   script:
     - gem build
 
+rubocop:
+  stage: test
+  extends: .job_base
+  script:
+    - bundle exec rubocop --color
+
 rspec:
   stage: test
   extends: .job_base
   script:
-    - bundle exec rspec
+    - bundle exec rspec --color

data/.rubocop.yml

@@ -0,0 +1,53 @@
+inherit_gem:
+  gitlab-styles:
+    - rubocop-all.yml
+    - rubocop-gemspec.yml
+    - rubocop-lint.yml
+    - rubocop-naming.yml
+    - rubocop-performance.yml
+    - rubocop-rspec.yml
+    - rubocop-security.yml
+    - rubocop-style.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 25
+  AllowSubject: true
+
+CodeReuse/ActiveRecord:
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 30
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*.rb
+    - dri.gemspec
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 30
+
+Layout/BeginEndAlignment:
+  Enabled: true
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/HashCompareByIdentity:
+  Enabled: true
+
+Lint/RedundantSafeNavigation:
+  Enabled: true
+
+Style/ClassEqualityComparison:
+  Enabled: true

data/.ruby-version

@@ -0,0 +1 @@
+2.7.5

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in dri.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dri (0.1.2)
+    dri (0.1.3)
       httparty (~> 0.20.0)
       json (~> 2.6.1)
       markdown-tables (~> 1.1.1)
@@ -19,39 +19,88 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.0.2.3)
+      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)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
+    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)
     hashdiff (1.0.1)
     httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
     json (2.6.1)
     markdown-tables (1.1.1)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2022.0105)
+    minitest (5.15.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)
     public_suffix (4.0.6)
-    rake (12.3.3)
+    rack (2.2.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
+    rspec-core (3.10.2)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+    rspec-mocks (3.10.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+    rspec-support (3.10.3)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      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-gitlab-security (0.1.1)
+      rubocop (>= 0.51)
+    rubocop-graphql (0.14.2)
+      rubocop (>= 0.87, < 2)
+    rubocop-performance (1.9.2)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      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)
+    ruby-progressbar (1.11.0)
     strings (0.2.1)
       strings-ansi (~> 0.2)
       unicode-display_width (>= 1.5, < 3.0)
@@ -85,7 +134,9 @@ GEM
       pastel (~> 0.8)
       strings (~> 0.2.0)
       tty-screen (~> 0.8)
-    unicode-display_width (2.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.8.0)
     unicode_utils (1.4.0)
     webmock (3.14.0)
       addressable (>= 2.8.0)
@@ -98,6 +149,7 @@ PLATFORMS
 
 DEPENDENCIES
   dri!
+  gitlab-styles (~> 7.0.0)
   rake
   rspec (~> 3.10.0)
   timecop (~> 0.9.1)

data/README.md

@@ -56,6 +56,9 @@ $ dri profile
   - failures
   - testcases
   - triaged
+  - quarantines
+  - dequarantines
+  - featureflags
 - [4. publish](#4-publish)
   - report
 - [5. rm](#5-rm)
@@ -107,6 +110,25 @@ $ 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
+
+```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).
+
 #### 4. publish
 
 ```shell

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "dri"

data/dri.gemspec

@@ -1,41 +1,44 @@
+# frozen_string_literal: true
+
 require_relative 'lib/dri/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "dri"
-  spec.license       = "MIT"
+  spec.name          = 'dri'
+  spec.license       = 'MIT'
   spec.version       = Dri::VERSION
-  spec.authors       = ["GitLab Quality"]
-  spec.email         = ["quality+dri@gitlab.com"]
+  spec.authors       = ['GitLab Quality']
+  spec.email         = ['quality+dri@gitlab.com']
 
-  spec.summary       = %q{CLI app to help triage GitLab QA pipelines}
+  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.required_ruby_version = Gem::Requirement.new('>= 2.7.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.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "tty-config", "~> 0.4.0"
-  spec.add_dependency "tty-font", "~> 0.5"
-  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 'httparty', '~> 0.20.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 'tty-box', '~> 0.7.0'
+  spec.add_dependency 'tty-config', '~> 0.4.0'
+  spec.add_dependency 'tty-editor', '~> 0.6'
+  spec.add_dependency 'tty-font', '~> 0.5'
   spec.add_dependency 'tty-logger', '~> 0.6.0'
-  spec.add_dependency "tty-editor", "~> 0.6"
-  spec.add_dependency "pastel", "~> 0.8.0"
-  spec.add_dependency "thor", "~> 1.0.1"
-  spec.add_dependency "markdown-tables", "~> 1.1.1"
-  spec.add_dependency 'json', '~> 2.6.1'
-  spec.add_dependency 'httparty', '~> 0.20.0'
+  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_development_dependency "rake"
+  spec.add_development_dependency 'gitlab-styles', '~> 7.0.0'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.10.0'
-  spec.add_development_dependency 'webmock', '~> 3.5'
   spec.add_development_dependency "timecop", "~> 0.9.1"
+  spec.add_development_dependency 'webmock', '~> 3.5'
 end

data/exe/dri

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 lib_path = File.expand_path('../lib', __dir__)
-$:.unshift(lib_path) if !$:.include?(lib_path)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
 require 'dri/cli'
 
 Signal.trap('INT') do
@@ -12,7 +12,7 @@ end
 
 begin
   Dri::CLI.start
-rescue Dri::CLI::Error => err
-  puts "ERROR: #{err.message}"
+rescue Dri::CLI::Error => e
+  puts "ERROR: #{e.message}"
   exit 1
 end

data/lib/dri/api_client.rb

@@ -6,12 +6,12 @@ require "tty-config"
 require 'cgi'
 
 module Dri
-  class ApiClient
-
-    API_URL              = 'https://gitlab.com/api/v4'
-    TESTCASES_PROJECT_ID = '11229385'
-    TRIAGE_PROJECT_ID    = '15291320'
-    GITLAB_PROJECT_ID    = '278964'
+  class ApiClient # rubocop:disable Metrics/ClassLength
+    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'
 
     def initialize(config)
       profile = config.read
@@ -64,7 +64,9 @@ module Dri
     def fetch_mrs(project_id:, **options)
       uri = URI(API_URL)
       uri.query = HTTParty::HashConversions.to_params(options)
-      uri.path = File.join(uri.path, 'projects', CGI.escape(project_id), 'merge_requests') # CGI.escape('gitlab-org/gitlab') => 'gitlab-org%2Fgitlab'
+
+      # CGI.escape('gitlab-org/gitlab') => 'gitlab-org%2Fgitlab'
+      uri.path = File.join(uri.path, 'projects', CGI.escape(project_id), 'merge_requests')
 
       fetch_json(uri.to_s)
     end
@@ -106,6 +108,16 @@ module Dri
       delete_json(url)
     end
 
+    def fetch_feature_flag_logs(date:, page:)
+      url = ["#{API_URL}/projects/"]
+      url << "#{FEATURE_FLAG_LOG_PROJECT_ID}/issues"
+      url << "?created_after=#{date}"
+      url << "&per_page=100"
+      url << "&page=#{page}"
+
+      fetch_json(url.join)
+    end
+
     private
 
     def post_json(url, body)
@@ -116,7 +128,7 @@ module Dri
         }
       }
 
-      response =  HTTParty.post(url, options)
+      response = HTTParty.post(url, options)
       handle_response(response)
     end
 
@@ -126,12 +138,12 @@ module Dri
     end
 
     def handle_response(response)
-      #puts response.to_json
+      # puts response.to_json
       response
     end
 
     def fetch_json(url)
-      response =  HTTParty.get(url, headers: header)
+      response = HTTParty.get(url, headers: header)
 
       if response.code != 200
         puts "Response error code \"#{response.code}\" - Unable to sync with GitLab"

data/lib/dri/cli.rb

@@ -25,14 +25,14 @@ module Dri
     end
 
     class_option :no_color, type: :boolean, default: false,
-                              desc: "Disable colorization in output"
+                            desc: "Disable colorization in output"
 
     desc 'version', 'dri version'
     def version
       require_relative 'version'
       puts "v#{Dri::VERSION}"
     end
-    map %w(--version -v) => :version
+    map %w[--version -v] => :version
 
     require_relative 'commands/rm'
     register Dri::Commands::Rm, 'rm', 'rm [SUBCOMMAND]', 'Remove triage-related items'

data/lib/dri/command.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'command'
 require_relative 'api_client'
 
@@ -13,7 +14,6 @@ module Dri
     extend Forwardable
 
     def_delegators :command, :run
-    attr_reader :config, :emoji, :token, :username, :timezone, :profile
 
     def pastel(**options)
       Pastel.new(**options)
@@ -56,10 +56,10 @@ module Dri
     end
 
     def verify_config_exists
-      if !config.exist?
-        logger.error "Oops, could not find a configuration. Try using #{add_color('dri init', :yellow)} first."
-        exit 1
-      end
+      return if config.exist?
+
+      logger.error "Oops, could not find a configuration. Try using #{add_color('dri init', :yellow)} first."
+      exit 1
     end
 
     def add_color(str, *color)

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 require_relative '../../command'
-
-require 'tty-table'
+require_relative '../../utils/table'
 
 module Dri
   module Commands
     class Fetch
       class Failures < Dri::Command
+        include Dri::Utils::Table
         using Refinements
 
         def initialize(options)
@@ -15,7 +15,7 @@ module Dri
           @today_iso_format = Time.now.strftime('%Y-%m-%dT00:00:00Z')
         end
 
-        def execute(input: $stdin, output: $stdout)
+        def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
           verify_config_exists
 
           title = add_color('Title', :bright_yellow)
@@ -25,13 +25,12 @@ module Dri
 
           failures = []
           urgent = []
-          labels = [ title, triaged, author, url ]
+          labels = [title, triaged, author, url]
           triaged_counter = 0
 
           logger.info "Fetching today's failures..."
 
-          spinner.run do
-
+          spinner.run do # rubocop:disable Metrics/BlockLength
             response = api_client.fetch_failures(date: @today_iso_format, state: 'opened')
 
             if response.nil?
@@ -47,7 +46,7 @@ module Dri
               triaged = add_color('x', :red)
 
               emoji_awards = api_client.fetch_awarded_emojis(award_emoji_url).find do |e|
-                e['name'] == emoji && e['user']['username'] == username
+                (e['name'] == emoji) && (e['user']['username'] == username)
               end
 
               if emoji_awards
@@ -59,7 +58,7 @@ module Dri
                 labels = failure['labels']
 
                 labels.each do |label|
-                  if label.include? ('found:canary.gitlab.com' && 'found:canary.staging.gitlab.com')
+                  if label.include?('found:canary.gitlab.com' && 'found:canary.staging.gitlab.com')
                     urgent << [title, triaged, author, url]
                   end
                 end
@@ -70,13 +69,15 @@ module Dri
           end
 
           if @options[:urgent]
-            table = TTY::Table.new(labels, urgent)
-            puts table.render(:ascii, resize: true, alignments: [:center, :center, :center, :center])
-            output.puts "\nFound: #{urgent.size} urgent failures, occurring in both canary.gitlab.com and canary.staging.gitlab.com."
+            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
-            table = TTY::Table.new(labels, failures)
-            puts table.render(:ascii, resize: true, alignments: [:center, :center, :center, :center])
-            output.puts "\nFound: #{failures.size} failures, of these #{triaged_counter} have been triaged with a #{emoji}."
+            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
           end
         end
       end

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+require_relative '../../utils/table'
+
+module Dri
+  module Commands
+    class Fetch
+      class FeatureFlags < Dri::Command
+        include Dri::Utils::Table
+
+        PRODUCTION  = 'host::gitlab.com'
+        STAGING     = 'host::staging.gitlab.com'
+        STAGING_REF = 'host::staging-ref.gitlab.com'
+        PREPROD     = 'host::pre.gitlab.com'
+
+        def initialize(options)
+          @options = options
+          @today_iso_format = Time.now.strftime('%Y-%m-%dT00:00:00Z')
+        end
+
+        def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
+          verify_config_exists
+
+          summary = add_color('Summary', :bright_yellow)
+          changed_on = add_color('Changed(UTC)', :bright_yellow)
+          url = add_color('URL', :bright_yellow)
+
+          prod_feature_flags = []
+          staging_feature_flags = []
+          staging_ref_feature_flags = []
+          preprod_feature_flags = []
+
+          headers = [summary, changed_on, url]
+
+          logger.info "Fetching today's feature flag changes..."
+
+          spinner.run do # rubocop:disable Metrics/BlockLength
+            page = 1
+            loop do # rubocop:disable Metrics/BlockLength
+              response = api_client.fetch_feature_flag_logs(date: @today_iso_format, page: page)
+
+              if response.nil? && page == 1
+                logger.info 'It\'s been quiet...no feature flag changes for today 👀'
+                exit 0
+              end
+
+              response.each do |feature_flag|
+                summary = feature_flag['title']
+
+                substrings = ["set to \"true\"", "set to \"false\""]
+                next unless substrings.any? { |substr| summary.include?(substr) }
+
+                changed_on = feature_flag['description'][/(?<=Changed on \(in UTC\): ).+?(?=\n)/].delete('`')
+                url = feature_flag['web_url']
+
+                feature_flag_data = [summary, changed_on, url]
+
+                labels = feature_flag['labels']
+                host_label = labels.select { |label| /^host::/.match(label) }.join('')
+
+                case host_label
+                when PRODUCTION
+                  prod_feature_flags << feature_flag_data
+                when STAGING
+                  staging_feature_flags << feature_flag_data
+                when STAGING_REF
+                  staging_ref_feature_flags << feature_flag_data
+                when PREPROD
+                  preprod_feature_flags << feature_flag_data
+                end
+              end
+
+              page += 1
+              break if response.count < 100 || response.nil?
+            end
+          end
+
+          print_results('Production', headers, prod_feature_flags, output) unless prod_feature_flags.empty?
+          print_results('Staging', headers, staging_feature_flags, output) unless staging_feature_flags.empty?
+          print_results('Staging Ref', headers, staging_ref_feature_flags, output) unless staging_ref_feature_flags.empty? # rubocop:disable Layout/LineLength
+          print_results('Preprod', headers, preprod_feature_flags, output) unless preprod_feature_flags.empty?
+        end
+
+        private
+
+        def print_results(env, headers, rows, output_src)
+          puts "\n#{add_color(env, :bright_blue)}"
+          print_table(headers, rows)
+          output_src.puts "\nFound: #{rows.count} feature flag change(s) set to true or false on #{env}."
+        end
+      end
+    end
+  end
+end