dri 0.4.0 → 0.6.0

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

@@ -2,34 +2,29 @@
 
 require_relative '../../command'
 require_relative '../../utils/table'
+require_relative '../../utils/feature_flag_consts'
+require_relative '../../feature_flag_report'
 
 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'
+        include Dri::Utils::FeatureFlagConsts
 
         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
+        def execute(input: $stdin, output: $stdout) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
           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 = []
+          report = Dri::FeatureFlagReport.new
 
           headers = [summary, changed_on, url]
 
@@ -37,42 +32,23 @@ module Dri
 
           spinner.run do
             response = api_client.fetch_feature_flag_logs(@today_iso_format)
+
             if response.empty?
               logger.info 'It\'s been quiet...no feature flag changes for today 👀'
               break
             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('')
+              next unless TITLE_SUBSTRINGS.any? { |substr| feature_flag.title.include?(substr) }
 
-              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
+              report.add_change(feature_flag)
             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?
+          print_results('Production', headers, report.prod, output) unless report.prod.empty?
+          print_results('Staging', headers, report.staging, output) unless report.staging.empty?
+          print_results('Staging Ref', headers, report.staging_ref, output) unless report.staging_ref.empty?
+          print_results('Preprod', headers, report.preprod, output) unless report.preprod.empty?
         end
 
         private

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

@@ -0,0 +1,254 @@
+# frozen_string_literal: true
+
+require 'date'
+require_relative '../../command'
+require_relative '../../utils/table'
+require_relative '../../utils/constants'
+
+module Dri
+  module Commands
+    class Fetch
+      class Pipelines < Dri::Command # rubocop:disable Metrics/ClassLength
+        include Dri::Utils::Table
+        using Refinements
+
+        NUM_OF_TESTS_LIVE_ENV = 1000
+        NOT_FOUND = "Not found"
+
+        def initialize(options)
+          @options = options
+        end
+
+        def execute(input: $stdin, output: $stdout)
+          verify_config_exists
+          logger.info "Fetching pipelines' status, this might take a while..."
+          pipelines = []
+          table_labels = define_table_labels
+
+          spinner.run do
+            Dri::Utils::Constants::PIPELINE_ENVIRONMENTS.each do |environment, details|
+              logger.info "Fetching last executed #{environment} pipeline"
+              pipelines << fetch_pipeline(pipeline_name: environment.to_s, details: details)
+              logger.info "Fetching complete for #{environment}"
+            end
+          end
+
+          print_table(table_labels, pipelines, alignments: [:left, :center, :center, :left])
+          pipelines # Returning the array mainly for spec
+        end
+
+        private
+
+        # Format a past date
+        # @param [Integer] hours_ago the amount of hours from now
+        # @return [String] formatted datetime
+        def past_timestamp(hours_ago)
+          timestamp = Time.now - (hours_ago * 60 * 60)
+          timestamp.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
+        end
+
+        # Get the first downstream pipeline of a project
+        # @param [Integer] project_id the id of the project
+        # @param [Integer] pipeline_id the pipeline id
+        # @return [Gitlab::ObjectifiedHash,nil] nil if downstream (bridge) pipeline does not exist
+        def bridge_pipeline(project_id, pipeline_id)
+          bridges = api_client.pipeline_bridges(project_id, pipeline_id)
+          return if bridges.empty? # If downstream pipeline doesn't exist, which triggers the QA tests, return
+
+          bridges.first["downstream_pipeline"]
+        end
+
+        # Get jobs from a pipeline
+        # @param [Integer] project_id the id of the project
+        # @param [Integer] pipeline_id the pipeline id
+        # @param [Boolean] ops  true if ops instance
+        # @return [Array::ObjectifiedHash,nil] nil if downstream (bridge) pipeline does not exist
+        def jobs(project_id:, pipeline_id:, ops: false)
+          api_client(ops: ops).pipeline_jobs(project_id, pipeline_id)
+        end
+
+        # Checks if tests count exceeds threshold in a pipeline
+        # @param [Integer] project_id the id of the project
+        # @param [Integer] pipeline_id the pipeline id
+        # @param [Boolean] ops  true if ops instance
+        # @return [Boolean] true if count exceeds threshold defined in constant NUM_OF_TESTS_LIVE_ENV
+        def tests_exceed_threshold?(project_id:, pipeline_id:, ops: true)
+          api_client(ops: ops).pipeline_test_report(project_id, pipeline_id).total_count > NUM_OF_TESTS_LIVE_ENV
+        end
+
+        # Checks if a job is present in an array of jobs
+        # @param [Array] jobs
+        # @param [String] job_name name of the job
+        # @return [Boolean] true if job is present
+        def contains_job?(jobs, job_name:)
+          jobs.any? { |job| job["name"].include?(job_name) }
+        end
+
+        # Checks if a stage is present from a list of jobs
+        # @param [Array] jobs
+        # @param [String] stage_name name of the stage
+        # @return [Boolean] true if stage is present
+        def contains_stage?(jobs, stage_name)
+          jobs.any? { |job| job["stage"].include?(stage_name) }
+        end
+
+        # Checks if pipeline ran only the QA smoke tests
+        # @param [Array] jobs
+        # @param [Integer] project_id
+        # @param [Integer] pipeline_id
+        # @param [Boolean] ops  true if ops instance
+        def smoke_run?(jobs:, project_id:, pipeline_id:, ops:)
+          contains_stage?(jobs, "sanity") &&
+            !tests_exceed_threshold?(project_id: project_id, pipeline_id: pipeline_id, ops: ops)
+        end
+
+        # Checks if pipeline ran full suite of qa tests
+        # @param [Array] jobs
+        # @param [Integer] project_id
+        # @param [Integer] pipeline_id
+        # @param [Boolean] ops  true if ops instance
+        def full_run?(jobs:, project_id:, pipeline_id:, ops:)
+          if ops
+            (contains_stage?(jobs, "qa") || contains_stage?(jobs, "test")) &&
+              tests_exceed_threshold?(project_id: project_id, pipeline_id: pipeline_id, ops: ops)
+          else
+            contains_stage?(jobs, "qa") || contains_stage?(jobs, "test")
+            # Nightly pipeline does not execute full E2E suite if sanity fails so can't check tests count
+          end
+        end
+
+        # Combined logic to check if a pipeline was a sanity run for all pipeline types - ie.,  live environment
+        # and gitlab-qa-mirror pipelines
+        # @param [Array] pipeline_jobs
+        # @param [Object] pipeline
+        # @param [Boolean] ops
+        def sanity?(pipeline_jobs:, pipeline:, ops:)
+          return true if ops && smoke_run?(jobs: pipeline_jobs, project_id: pipeline.project_id,
+                                           pipeline_id: pipeline.id, ops: ops)
+
+          false if full_run?(jobs: pipeline_jobs, project_id: pipeline.project_id,
+                             pipeline_id: pipeline.id, ops: ops)
+        end
+
+        # Constructs allure report url for each pipeline
+        # @param [String] pipeline_name
+        # @param [Integer] pipeline_id
+        # @param [Boolean] sanity
+        def allure_report(pipeline_name:, pipeline_id:, sanity:)
+          "https://storage.googleapis.com/gitlab-qa-allure-reports/#{allure_bucket_name(pipeline_name, sanity)}"\
+           "/master/#{pipeline_id}/index.html"
+        end
+
+        # Returns the GCP bucket name for different pipeline types
+        # @param [String] pipeline_name
+        # @param [Boolean] sanity
+        def allure_bucket_name(pipeline_name, sanity)
+          case pipeline_name
+          when "master"
+            "package-and-qa"
+          when "nightly"
+            pipeline_name
+          when "pre_prod"
+            "preprod-#{run_type(sanity)}"
+          else
+            "#{pipeline_name.sub('_', '-')}-#{run_type(sanity)}"
+          end
+        end
+
+        def run_type(sanity)
+          sanity == true ? "sanity" : "full"
+        end
+
+        # Returns table headers
+        # @return [Array]
+        def define_table_labels
+          name = add_color("Pipeline", :magenta)
+          pipeline_last_executed = add_color("Last executed at", :magenta)
+          url = add_color("Pipeline Url", :magenta)
+          report = add_color("Last report", :magenta)
+          result = add_color("Result", :magenta)
+          [name, pipeline_last_executed, url, report, result]
+        end
+
+        # Checks if pipeline is running on ops.gitlab.net or gitlab.com
+        # @param [String] url
+        def ops_pipeline?(url)
+          url.include?("ops.gitlab.net")
+        end
+
+        def notify_slack_job_name(pipeline_name, ops)
+          return "notify-slack-qa-fail" if ops
+
+          pipeline_name.to_s.include?("master") ? "notify_slack" : "notify-slack-fail"
+        end
+
+        # Returns child pipeline if it is master pipeline
+        # @param [Gitlab::ObjectifiedHash] pipeline
+        def pipeline_with_qa_tests(pipeline)
+          if pipeline.web_url.to_s.include?("gitlab-qa-mirror")
+            bridge_pipeline(pipeline.project_id, pipeline.id)
+          else
+            pipeline
+          end
+        end
+
+        # Returns query options for pipelines api call
+        # @param [Hash] details
+        # @param [Boolean] ops
+        def options(details, ops)
+          options = { order_by: "updated_at", scope: "finished",
+                      updated_after: past_timestamp(details[:search_hours_ago]) }
+          options.merge(username: "gitlab-bot") if ops
+          options
+        end
+
+        def emoji_for_success_failure(status)
+          return add_color("✓", :green) if status.include?("success")
+
+          add_color("x", :red)
+        end
+
+        # @param [String] pipeline_name
+        # @param [Hash] details Pipeline environment details
+        # @return [Array] Array of last executed pipeline details
+        # rubocop:disable Metrics/PerceivedComplexity
+        def fetch_pipeline(pipeline_name:, details:) # rubocop:disable Metrics/CyclomaticComplexity
+          ops = ops_pipeline?(details[:url])
+          options = options(details, ops)
+          # instance is ops.gitlab.net or gitlab.com
+          response = api_client(ops: ops).pipelines(project_id: details[:project_id],
+                                                    options: options, auto_paginate: true)
+          return [pipeline_name, NOT_FOUND, NOT_FOUND, NOT_FOUND, NOT_FOUND] if response.empty?
+
+          # Return empty data to the table if no matching pipelines were found from the query
+          response.each do |pipeline|
+            pipeline_to_scan = pipeline_with_qa_tests(pipeline) # Fetch child pipeline if it is master
+            next if pipeline_to_scan.nil?
+
+            pipeline_jobs = jobs(project_id: pipeline.project_id, pipeline_id: pipeline_to_scan.id, ops: ops)
+            next unless contains_job?(pipeline_jobs, job_name: notify_slack_job_name(pipeline_name, ops))
+
+            # Need to know if it is a sanity or a full run to construct allure report url
+            sanity = sanity?(pipeline_jobs: pipeline_jobs, pipeline: pipeline_to_scan,
+                             ops: ops)
+
+            next if sanity.nil? # To filter out some "clean up" pipelines present in live environments
+
+            next if sanity && @options[:full_runs_only] # Filter out sanity runs if --full-runs-only option is passed
+
+            name = ops ? "#{pipeline_name}_#{run_type(sanity)}" : pipeline_name
+            pipeline_last_executed = pipeline_to_scan.updated_at
+            url = pipeline_to_scan.web_url
+            report = allure_report(pipeline_name: pipeline_name, pipeline_id: pipeline_to_scan.id, sanity: sanity)
+            result = emoji_for_success_failure(pipeline_to_scan.status)
+            return [name, pipeline_last_executed, url, report, result]
+          end
+
+          [pipeline_name, NOT_FOUND, NOT_FOUND, NOT_FOUND, NOT_FOUND] # Parsed through all of the response and
+          # no matching pipelines found
+        end
+        # rubocop:enable Metrics/PerceivedComplexity
+      end
+    end
+  end
+end

data/lib/dri/commands/fetch.rb

@@ -82,6 +82,18 @@ module Dri
         require_relative 'fetch/quarantines'
         Dri::Commands::Fetch::Quarantines.new(options, search: '[DEQUARANTINE]').execute
       end
+
+      desc 'pipelines', 'Display status of pipelines'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display pipelines usage information'
+      method_option :full_runs_only, type: :boolean,
+                                     desc: 'Displays full pipeline runs only'
+      def pipelines(*)
+        return invoke :help, %w[pipelines] if options[:help]
+
+        require_relative 'fetch/pipelines'
+        Dri::Commands::Fetch::Pipelines.new(options).execute
+      end
     end
   end
 end

data/lib/dri/commands/init.rb

@@ -31,16 +31,18 @@ module Dri
 
         @username = prompt.ask("What is your GitLab username?")
         @token = prompt.mask("Please provide your GitLab personal access token:")
+        @ops_token = prompt.mask("Please provide your ops.gitlab.net personal access token:")
         @timezone = prompt.select("Choose your current timezone?", %w[EMEA AMER APAC])
         @emoji = prompt.ask("Have a triage emoji?")
 
-        if (@emoji || @token || @username).nil?
-          logger.error "Please provide a username, token, timezone and emoji used for triage."
+        if (@emoji || @token || @username || @ops_token).nil?
+          logger.error "Please provide a username, gitlab token, ops token, timezone and emoji used for triage."
           exit 1
         end
 
         config.set(:settings, :user, value: @username)
         config.set(:settings, :token, value: @token)
+        config.set(:settings, :ops_token, value: @ops_token)
         config.set(:settings, :timezone, value: @timezone)
         config.set(:settings, :emoji, value: @emoji)
         config.write(force: true)

data/lib/dri/commands/profile.rb

@@ -38,6 +38,7 @@ module Dri
       def pretty_print_profile
         <<~PROFILE
           #{add_color('User:', :bright_cyan)} #{username}\n #{add_color('Token:', :bright_cyan)} #{token}
+          #{add_color('OpsToken:', :bright_cyan)} #{ops_token}
           #{add_color('Timezone:', :bright_cyan)} #{timezone}
           #{add_color('Emoji:', :bright_cyan)} #{emoji}
         PROFILE

data/lib/dri/commands/publish/report.rb

@@ -2,21 +2,26 @@
 
 require_relative '../../command'
 require_relative '../../utils/markdown_lists'
-require_relative "../../report"
+require_relative '../../utils/feature_flag_consts'
+require_relative '../../report'
+require_relative '../../feature_flag_report'
 
 require 'markdown-tables'
 require 'fileutils'
-require "uri"
+require 'uri'
 
 module Dri
   module Commands
     class Publish
-      class Report < Dri::Command
+      class Report < Dri::Command # rubocop:disable Metrics/ClassLength
+        include Dri::Utils::FeatureFlagConsts
+
         def initialize(options)
           @options = options
 
           @date = Date.today
           @time = Time.now.to_i
+          @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
@@ -26,7 +31,9 @@ module Dri
           logger.info "Fetching triaged failures with award emoji #{emoji}..."
 
           spinner.start
+
           issues = api_client.fetch_triaged_failures(emoji: emoji, state: 'opened')
+
           spinner.stop
 
           if issues.empty?
@@ -34,27 +41,28 @@ module Dri
             exit 1
           end
 
-          logger.info "Assembling the report... "
+          logger.info 'Assembling the failures report... '
           # sets each failure on the table
           action_options = [
-            "pinged SET",
-            "reproduced",
-            "transient",
-            "quarantined",
-            "active investigation",
-            "blocking pipelines",
-            "awaiting for a fix to merge",
-            "notified the team",
-            "due to feature flag"
+            'pinged SET',
+            'reproduced',
+            'transient',
+            'quarantined',
+            'active investigation',
+            'blocking pipelines',
+            'awaiting for a fix to merge',
+            'notified the team',
+            'due to feature flag'
           ]
 
           spinner.start
+
           issues.each do |issue|
             actions = []
 
             if @options[:actions]
               actions = prompt.multi_select(
-                "Please mark the actions on #{add_color(issue['title'], :yellow)}: ",
+                "Please mark the actions on #{add_color(issue.title, :yellow)}: ",
                 action_options,
                 per_page: 9
               )
@@ -77,14 +85,59 @@ module Dri
             end
           end
 
+          spinner.stop
+
+          if @options[:feature_flags]
+            logger.info 'Fetching today\'s feature flag changes...'
+
+            feature_flag_report = Dri::FeatureFlagReport.new
+
+            spinner.start
+
+            feature_flags = api_client.fetch_feature_flag_logs(@today_iso_format)
+
+            feature_flags.each do |feature_flag|
+              next unless TITLE_SUBSTRINGS.any? { |substr| feature_flag.title.include?(substr) }
+
+              feature_flag_report.add_change(feature_flag)
+            end
+
+            spinner.stop
+
+            logger.info 'Assembling the feature flags report...'
+
+            spinner.start
+
+            feature_flag_note = "\n\n## Feature Flag Changes"
+            feature_flag_changes = ''
+
+            format_type = @options[:format] == 'list' ? :list : :table
+
+            feature_flag_report.get_all_flag_changes.each do |env, changes|
+              next if changes.empty?
+
+              feature_flag_changes += format_feature_flag_changes(
+                env, changes, feature_flag_report.labels, format_type
+              )
+            end
+
+            feature_flag_note += if feature_flag_changes.empty?
+                                   "\n\nNo changes found today"
+                                 else
+                                   "\n\n<details><summary>Click to expand</summary>#{feature_flag_changes}</details>"
+                                 end
+
+            spinner.stop
+          end
+
           report.set_header(timezone, username)
           note = "#{report.header}\n\n#{format_style}"
 
-          spinner.stop
+          note += feature_flag_note if @options[:feature_flags]
 
           # creates an .md file with the report locally in /handover_reports
           if @options[:dry_run]
-            logger.info "Downloading the report... "
+            logger.info 'Downloading the report... '
 
             spinner.start
 
@@ -104,7 +157,7 @@ module Dri
 
           # sends note to the weekly triage report
           issues = api_client.fetch_current_triage_issue
-          current_issue_iid = issues[0]["iid"]
+          current_issue_iid = issues.first.iid
 
           api_client.post_triage_report_note(iid: current_issue_iid, body: note)
 
@@ -113,6 +166,27 @@ module Dri
             Thanks @#{username}, your report was posted at https://gitlab.com/gitlab-org/quality/pipeline-triage/-/issues/#{current_issue_iid} 🎉
           MSG
         end
+
+        private
+
+        def format_feature_flag_changes(env, changes, labels, format_type)
+          unless format_type == :table || format_type == :list
+            raise ArgumentError, 'format_type must be one of type :table or :list'
+          end
+
+          case format_type
+          when :list
+            formatted_changes = Utils::MarkdownLists.make_list(labels, changes)
+          when :table
+            formatted_changes = MarkdownTables.make_table(
+              labels,
+              changes,
+              is_rows: true, align: %w[l l l]
+            )
+          end
+
+          "\n\n### #{env.to_s.capitalize.tr('_', ' ')}\n\n#{formatted_changes}"
+        end
       end
     end
   end

data/lib/dri/commands/publish.rb

@@ -14,6 +14,8 @@ module Dri
                              desc: 'Formats the report'
       method_option :actions, type: :boolean,
                               desc: 'Updates actions on failures'
+      method_option :feature_flags, type: :boolean,
+                                    desc: 'Adds summary of feature flag changes'
       def report(*)
         if options[:help]
           invoke :help, ['report']

data/lib/dri/feature_flag_report.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative './utils/feature_flag_consts'
+
+module Dri
+  class FeatureFlagReport
+    include Dri::Utils::FeatureFlagConsts
+
+    attr_reader :header, :labels, :prod, :staging, :staging_ref, :preprod
+
+    def initialize
+      @header = '## Feature Flag Changes'
+      @labels = %w[Summary Changed(UTC) URL]
+      @prod = []
+      @staging = []
+      @staging_ref = []
+      @preprod = []
+    end
+
+    def add_change(feature_flag)
+      summary = feature_flag.title
+
+      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_flag_data
+      when STAGING
+        @staging << feature_flag_data
+      when STAGING_REF
+        @staging_ref << feature_flag_data
+      when PREPROD
+        @preprod << feature_flag_data
+      end
+    end
+
+    def get_all_flag_changes
+      { production: @prod, staging: @staging, staging_ref: @staging_ref, preprod: @preprod }
+    end
+  end
+end

data/lib/dri/report.rb

@@ -95,7 +95,7 @@ module Dri
         end
 
         unless pipeline_link.empty?
-          pipeline_link_sanitized = pipeline_link.join.strip.chop
+          pipeline_link_sanitized = pipeline_link.join.strip
           pipeline_markdown = "[#{pipeline_markdown}](#{pipeline_link_sanitized})"
         end