gitlab-qa 5.0.3 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bada173257833055a80ce95da0bdedff9f80e491996d4ffc2afa08045c05fec
-  data.tar.gz: f1c39835f8183544ebba39c1eb81c0cdc73820dfc66e67f9e74ee61ff5dad3d5
+  metadata.gz: 77a9207808fc033a918c2096734e3511fe8cf5126ddc791f16477c4062c13e8f
+  data.tar.gz: 62c66c8604fcb5a73825a0e0e8e8c34aec1eca0e58e20c5effe17d2078fc82c6
 SHA512:
-  metadata.gz: d2e190ef3baadd7620d8798e7f37be50a41a0ca12abd5f4672233d0fe5939c7bd448f59d881a9792a6157708b06f503c4623a8c03f6a6d6065cad537b6c0712a
-  data.tar.gz: 673340d27e71c31787185d7f50868ab2cf3828a036b4de530d20b30816ef53932b60ca94ddfecb08a55a25e90919249da8de2b68b87b6dd8cf630bb968305bd1
+  metadata.gz: db859779d4aba13388c527e9183998d80e64422fa30fabd1446af46d2a6af540165ae3d0b5932059159c245104ecb528213977d281684fb75034e240efe48807
+  data.tar.gz: 5f3160b6db99a7c4f0ae247b4990971a162b4728560c353842b79cf872a348c915ecf836be1549547aedd29ea4d0c2ea358276fe03a1e3df2c7fa3008f9a7d93

data/gitlab-qa.gemspec

@@ -29,5 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock', '3.7.0'
   spec.add_runtime_dependency 'activesupport', '~>  6.0.2'
   spec.add_runtime_dependency 'gitlab', '~>  4.11.0'
+  spec.add_runtime_dependency 'http', '4.3.0'
   spec.add_runtime_dependency 'nokogiri', '~> 1.10'
+  spec.add_runtime_dependency 'table_print', '1.5.6'
 end

data/lib/gitlab/qa.rb

@@ -75,6 +75,7 @@ module Gitlab
 
     module Support
       autoload :GetRequest, 'gitlab/qa/support/get_request'
+      autoload :HttpRequest, 'gitlab/qa/support/http_request'
       autoload :DevEEQAImage, 'gitlab/qa/support/dev_ee_qa_image'
       autoload :InvalidResponseError, 'gitlab/qa/support/invalid_response_error'
     end
@@ -89,6 +90,11 @@ module Gitlab
     module Report
       autoload :PrepareStageReports, 'gitlab/qa/report/prepare_stage_reports'
       autoload :ResultsInIssues, 'gitlab/qa/report/results_in_issues'
+      autoload :SummaryTable, 'gitlab/qa/report/summary_table'
+    end
+
+    module Slack
+      autoload :PostToSlack, 'gitlab/qa/slack/post_to_slack'
     end
   end
 end

data/lib/gitlab/qa/report/summary_table.rb

@@ -0,0 +1,41 @@
+require 'nokogiri'
+require 'table_print'
+
+module Gitlab
+  module QA
+    module Report
+      class SummaryTable
+        def self.create(input_files:)
+          "```\n#{TablePrint::Printer.table_print(collect_results(input_files))}```\n"
+        end
+
+        # rubocop:disable Metrics/AbcSize
+        def self.collect_results(input_files)
+          stage_wise_results = []
+
+          Dir.glob(input_files).each do |report_file|
+            stage_hash = {}
+            stage_hash["Dev Stage"] = File.basename(report_file, ".*").capitalize
+
+            report_stats = Nokogiri::XML(File.open(report_file)).children[0].attributes
+
+            stage_hash["Total"] = report_stats["tests"].value
+            stage_hash["Failures"] = report_stats["failures"].value
+            stage_hash["Errors"] = report_stats["errors"].value
+            stage_hash["Skipped"] = report_stats["skipped"].value
+            stage_hash["Result"] = result_emoji(report_stats)
+
+            stage_wise_results << stage_hash
+          end
+
+          stage_wise_results
+        end
+        # rubocop:enable Metrics/AbcSize
+
+        def self.result_emoji(report_stats)
+          report_stats["failures"].value.to_i.positive? || report_stats["errors"].value.to_i.positive? ? "❌" : "✅"
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/reporter.rb

@@ -6,6 +6,7 @@ module Gitlab
       # rubocop:disable Metrics/AbcSize
       def self.invoke(args)
         report_options = {}
+        slack_options = {}
 
         options = OptionParser.new do |opts|
           opts.banner = 'Usage: gitlab-qa-reporter [options]'
@@ -28,6 +29,17 @@ module Gitlab
             report_options[:token] = value
           end
 
+          opts.on('--post-to-slack MSG', 'Post message to slack') do |msg|
+            slack_options[:post_to_slack] = true
+            slack_options[:message] = msg
+          end
+
+          opts.on('--include-summary-table FILES', 'Create a results summary table to post to slack. To be used with --post-to-slack.') do |files|
+            raise 'This option should be used with --post-to-slack.' unless slack_options[:post_to_slack]
+
+            slack_options[:message] = slack_options[:message] + "\n\n" + Gitlab::QA::Report::SummaryTable.create(input_files: files)
+          end
+
           opts.on_tail('-v', '--version', 'Show the version') do
             require 'gitlab/qa/version'
             puts "#{$PROGRAM_NAME} : #{VERSION}"
@@ -57,6 +69,13 @@ module Gitlab
 
             exit
           end
+
+          if slack_options[:post_to_slack]
+            slack_options.delete(:post_to_slack)
+            Gitlab::QA::Slack::PostToSlack.new(**slack_options).invoke!
+
+            exit
+          end
         else
           puts options
           exit 1

data/lib/gitlab/qa/runtime/env.rb

@@ -71,7 +71,9 @@ module Gitlab
           'GITLAB_QA_1P_GITHUB_UUID' => :gitlab_qa_1p_github_uuid,
           'GITLAB_QA_LOOP_RUNNER_MINUTES' => :gitlab_qa_loop_runner_minutes,
           'QA_CAN_TEST_ADMIN_FEATURES' => :qa_can_test_admin_features,
-          'MAILHOG_HOSTNAME' => :mailhog_hostname
+          'MAILHOG_HOSTNAME' => :mailhog_hostname,
+          'SLACK_QA_CHANNEL' => :slack_qa_channel,
+          'SLACK_QA_BOT_TOKEN' => :slack_qa_bot_token
         }.freeze
 
         ENV_VARIABLES.each_value do |accessor|
@@ -157,6 +159,18 @@ module Gitlab
           end
         end
 
+        def require_slack_qa_channel!
+          return unless ENV['SLACK_QA_CHANNEL'].to_s.strip.empty?
+
+          raise ArgumentError, "Please provide SLACK_QA_CHANNEL"
+        end
+
+        def require_slack_qa_bot_token!
+          return unless ENV['SLACK_QA_BOT_TOKEN'].to_s.strip.empty?
+
+          raise ArgumentError, "Please provide SLACK_QA_BOT_TOKEN"
+        end
+
         def require_kubernetes_environment!
           %w[GCLOUD_ACCOUNT_EMAIL GCLOUD_ACCOUNT_KEY CLOUDSDK_CORE_PROJECT].each do |env_key|
             raise ArgumentError, "Environment variable #{env_key} must be set to run kubernetes specs" unless ENV.key?(env_key)

data/lib/gitlab/qa/slack/post_to_slack.rb

@@ -0,0 +1,25 @@
+module Gitlab
+  module QA
+    module Slack
+      class PostToSlack
+        def initialize(message:)
+          @message = message
+        end
+
+        def invoke!
+          Runtime::Env.require_slack_qa_channel!
+          Runtime::Env.require_slack_qa_bot_token!
+
+          params = {}
+          params['token'] = Runtime::Env.slack_qa_bot_token
+          params['channel'] = Runtime::Env.slack_qa_channel
+          params['text'] = @message
+
+          url = "https://slack.com/api/chat.postMessage"
+
+          Support::HttpRequest.make_http_request(method: 'post', url: url, params: params)
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/support/http_request.rb

@@ -0,0 +1,32 @@
+require 'http'
+require 'json'
+
+module Gitlab
+  module QA
+    module Support
+      class HttpRequest
+        # rubocop:disable Metrics/AbcSize
+        def self.make_http_request(method: 'get', url: nil, params: {}, headers: {}, show_response: false, fail_on_error: true)
+          raise "URL not defined for making request. Exiting..." unless url
+
+          res = HTTP.follow.method(method).call(url, form: params, headers: headers)
+
+          if show_response
+            if res.content_type.mime_type == "application/json"
+              res_body = JSON.parse(res.body.to_s)
+              pp res_body
+            else
+              res_body = res.body.to_s
+              puts res_body
+            end
+          end
+
+          raise "#{method.upcase} request failed!\nCode: #{res.code}\nResponse: #{res.body}\n" if fail_on_error && !res.status.success?
+
+          res
+        end
+        # rubocop:enable Metrics/AbcSize
+      end
+    end
+  end
+end

data/lib/gitlab/qa/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module QA
-    VERSION = '5.0.3'.freeze
+    VERSION = '5.1.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 5.0.3
+  version: 5.1.0
 platform: ruby
 authors:
 - Grzegorz Bizon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2020-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.11.0
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.3.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: table_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
 description: 
 email:
 - grzesiek.bizon@gmail.com
@@ -226,6 +254,7 @@ files:
 - lib/gitlab/qa/release.rb
 - lib/gitlab/qa/report/prepare_stage_reports.rb
 - lib/gitlab/qa/report/results_in_issues.rb
+- lib/gitlab/qa/report/summary_table.rb
 - lib/gitlab/qa/reporter.rb
 - lib/gitlab/qa/runner.rb
 - lib/gitlab/qa/runtime/env.rb
@@ -263,8 +292,10 @@ files:
 - lib/gitlab/qa/scenario/test/omnibus/update.rb
 - lib/gitlab/qa/scenario/test/omnibus/upgrade.rb
 - lib/gitlab/qa/scenario/test/sanity/version.rb
+- lib/gitlab/qa/slack/post_to_slack.rb
 - lib/gitlab/qa/support/dev_ee_qa_image.rb
 - lib/gitlab/qa/support/get_request.rb
+- lib/gitlab/qa/support/http_request.rb
 - lib/gitlab/qa/support/invalid_response_error.rb
 - lib/gitlab/qa/version.rb
 - tls_certificates/gitlab/gitlab.test.crt