gitlab-qa 7.18.0 → 7.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 879e5a3fcce24d31675bfc149497fbf8bcff3a30c7ad0e130fe8c0c5dff066bf
-  data.tar.gz: 00c054d0c7e8b7835dddbbbb7f984add3e7bb6c5373e1818100a1ad1cc0d4dfa
+  metadata.gz: 7df136e02dc7640dd456d9e6f0f089cfdf105c7e8d4983ee41e487081eadb3eb
+  data.tar.gz: 9ab31d33024c1a2e6826213028e4a1f1c3ab69c8ece4d230be79a4f3b1f15108
 SHA512:
-  metadata.gz: ce337cb8932389b8911f53c81d31d9ef53f999beb3bb33a39834fc33166a1bc682fe211b41f8128090a4553dc11049d36ea2e94789f8a850ad28a36ebabceec2
-  data.tar.gz: 2257bba9c635c0cff8998df076a2560dd2c8c07a51536e24414a9bdccebe1a1342bed8fba8a2ecaae7baa5e3743ec554f246ff5b06407c656396d2eff04f934a
+  metadata.gz: 5420d4ffea08d120903f51fa9d590b20cfee1686ecdff384ac2ff931ba1ead170409a412e3c45cb96f6310359540d245624bf05fce654f106030550d68ff8928
+  data.tar.gz: 459ce3e23b1113bcb52b2413d6cae58dc9946976e7615833fd5fbe9d0b979d0894c964fc6565cb2a0e13e9953369c4073b6a5ec00510b24edec3cd4b2ad00a61

data/.gitlab-ci.yml

@@ -21,9 +21,6 @@ default:
     - bundle version
     - bundle config path vendor
     - bundle install --jobs=$(nproc) --retry=3 --quiet && bundle check
-    - if [ -n "$TRIGGERED_USER" ] && [ -n "$TRIGGER_SOURCE" ]; then
-        echo "Pipeline triggered by $TRIGGERED_USER at $TRIGGER_SOURCE";
-      fi
     - export LANG=C.UTF-8
 
 workflow:
@@ -1212,7 +1209,6 @@ ee:large-setup:
 ee:cloud-activation:
   before_script:
     - unset EE_LICENSE
-    - unset GITLAB_QA_FORMLESS_LOGIN_TOKEN
     - !reference [default, before_script]
   extends:
     - .rules:ee-never-when-triggered-by-feature-flag-definition-change
@@ -1221,12 +1217,11 @@ ee:cloud-activation:
     - .ee-variables
     - .rspec-report-opts
   variables:
-    QA_SCENARIO: "Test::Integration::CloudActivation"
+    QA_RSPEC_TAGS: "--tag cloud_activation"
 
 ee:cloud-activation-quarantine:
   before_script:
     - unset EE_LICENSE
-    - unset GITLAB_QA_FORMLESS_LOGIN_TOKEN
     - !reference [default, before_script]
   extends:
     - .rules:ee-never-when-triggered-by-feature-flag-definition-change
@@ -1236,7 +1231,7 @@ ee:cloud-activation-quarantine:
     - .quarantine
     - .rspec-report-opts
   variables:
-    QA_SCENARIO: "Test::Integration::CloudActivation"
+    QA_RSPEC_TAGS: "--tag cloud_activation"
 
 # This job requires the `GITLAB_QA_ACCESS_TOKEN` and `GITLAB_QA_DEV_ACCESS_TOKEN`
 # variable to be passed when triggered.

data/docs/what_tests_can_be_run.md

@@ -59,6 +59,7 @@ All environment variables used by GitLab QA should be defined in [`lib/gitlab/qa
 | `GITLAB_QA_ADMIN_ACCESS_TOKEN` |-  | A valid personal access token with the `api` scope from a user with admin access. Used for API access as an admin during tests. | No|
 | `GITLAB_QA_CONTAINER_REGISTRY_ACCESS_TOKEN` | - | A valid personal access token with the `read_registry` scope. Used to [access the container registry on `registry.gitlab.com` when tests run in a CI job that _is not_ triggered via another pipeline](https://gitlab.com/gitlab-org/gitlab-qa/-/blob/364addb83e7b136ff0f9d8719ca9553d290aa9ab/lib/gitlab/qa/release.rb#L152). For example, if you manually run a [new Staging pipeline](https://ops.gitlab.net/gitlab-org/quality/staging/-/pipelines/new), this token will be used. | No |
 | `EE_LICENSE` |-  | Enterprise Edition license. | No|
+| `QA_EE_ACTIVATION_CODE` |-  | Cloud activation code to enable Enterprise Edition features. | No|
 | `QA_ARTIFACTS_DIR` |`/tmp/gitlab-qa`| Path to a directory where artifacts (logs and screenshots) for failing tests will be saved. | No|
 | `DOCKER_HOST` |`http://localhost`| Docker host to run tests against. | No|
 | `WEBDRIVER_HEADLESS` |-  | When running locally, set to `false` to allow Chrome tests to be visible - watch your tests being run. | No|

data/lib/gitlab/qa/component/gitlab.rb

@@ -12,7 +12,7 @@ module Gitlab
       class Gitlab < Base
         extend Forwardable
 
-        attr_reader :release, :omnibus_configuration
+        attr_reader :release, :omnibus_configuration, :omnibus_gitlab_rails_env
         attr_accessor :tls, :skip_availability_check, :runner_network
         attr_writer :name, :relative_path
 
@@ -29,6 +29,7 @@ module Gitlab
           super
 
           @skip_availability_check = false
+          @omnibus_gitlab_rails_env = {}
 
           @volumes[GITLAB_CERTIFICATES_PATH] = SSL_PATH
           @volumes[AUTHORITY_CERTIFICATES_PATH] = TRUSTED_PATH
@@ -41,7 +42,14 @@ module Gitlab
         def set_formless_login_token
           return if Runtime::Env.gitlab_qa_formless_login_token.to_s.strip.empty?
 
-          @omnibus_configuration << "gitlab_rails['env'] = { 'GITLAB_QA_FORMLESS_LOGIN_TOKEN' => '#{Runtime::Env.gitlab_qa_formless_login_token}' }"
+          @omnibus_gitlab_rails_env['GITLAB_QA_FORMLESS_LOGIN_TOKEN'] = Runtime::Env.gitlab_qa_formless_login_token
+        end
+
+        def set_license_mode
+          return unless Runtime::Env.test_license_mode?
+
+          @omnibus_gitlab_rails_env['GITLAB_LICENSE_MODE'] = 'test'
+          @omnibus_gitlab_rails_env['CUSTOMER_PORTAL_URL'] = 'https://customers.staging.gitlab.com'
         end
 
         def elastic_url=(url)
@@ -95,6 +103,9 @@ module Gitlab
 
         def prepare_gitlab_omnibus_config
           set_formless_login_token
+          set_license_mode
+
+          @omnibus_configuration << "gitlab_rails['env'] = #{@omnibus_gitlab_rails_env}" unless omnibus_gitlab_rails_env.empty?
         end
 
         def start # rubocop:disable Metrics/AbcSize

data/lib/gitlab/qa/component/telegraf.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
+module Gitlab
+  module QA
+    module Component
+      # Component to collect docker metrics
+      #
+      class Telegraf < Base
+        DOCKER_IMAGE = 'telegraf'
+        DOCKER_IMAGE_TAG = '1.21-alpine'
+        LOG_DIR = '/etc/telegraf/log'
+
+        def initialize
+          super
+
+          @name = DOCKER_IMAGE
+          @host_log_dir = "#{Runtime::Env.host_artifacts_dir}/#{@name}"
+          @environment = Runtime::Env.variables.slice(
+            'QA_INFLUXDB_TOKEN',
+            'QA_INFLUXDB_URL',
+            'QA_RUN_TYPE',
+            'CI_JOB_NAME',
+            'CI_PIPELINE_ID'
+          )
+        end
+
+        attr_reader :name, :host_log_dir, :telegraf_config
+
+        # Start container
+        #
+        # @return [void]
+        def start
+          docker.run(image: image, tag: tag) do |command|
+            set_command_args(command)
+            set_volumes(command)
+            set_environment(command)
+          end
+        end
+
+        # Run prepare commands
+        #
+        # @return [void]
+        def prepare
+          @telegraf_config = File.open("#{Dir.mktmpdir(nil, ENV['CI_BUILDS_DIR'])}/telegraf.conf", 'w') do |file|
+            file.write(config)
+            file.path
+          end
+          FileUtils.mkdir_p(host_log_dir)
+
+          prepare_docker_image
+          prepare_docker_container
+        end
+
+        # Run teardown
+        #
+        # @return [void]
+        def teardown
+          return unless run_telegraf?
+
+          super
+        end
+
+        private
+
+        # Set custom run command arguments
+        #
+        # @param [Docker::Command] command
+        # @return [void]
+        def set_command_args(command)
+          command << '-d'
+          command << "--name #{name}"
+          command << "--user root"
+          command << "--entrypoint telegraf"
+        end
+
+        # Set volumes
+        #
+        # @param [Docker::Command] command
+        # @return [void]
+        def set_volumes(command)
+          command.volume(host_log_dir, LOG_DIR)
+          command.volume('/var/run/docker.sock', '/var/run/docker.sock')
+          command.volume(telegraf_config, '/etc/telegraf/telegraf.conf', :ro)
+        end
+
+        # Set environment variables
+        #
+        # @param [Docker::Command] command
+        # @return [void]
+        def set_environment(command)
+          environment.each { |k, v| command.env(k, v) }
+        end
+
+        # Run main entrypoint
+        #
+        # @return [void]
+        def instance_no_teardown
+          if run_telegraf?
+            super
+          else
+            Runtime::Logger.debug("Skipping starting telegraf container!")
+            yield self if block_given?
+          end
+        end
+
+        # Should telegraf be started
+        #
+        # Run only on CI and skip if metrics explicitly disabled, run_type not set or influx params missing
+        #
+        # @return [Boolean]
+        def run_telegraf?
+          Runtime::Env.ci && Runtime::Env.qa_export_test_metrics? && Runtime::Env.qa_run_type && !missing_influx_config?
+        end
+
+        # Influxdb config params missing
+        #
+        # @return [Boolean]
+        def missing_influx_config?
+          environment.slice('QA_INFLUXDB_TOKEN', 'QA_INFLUXDB_URL').any? { |_k, v| v.blank? }
+        end
+
+        # Telegraf configuration
+        #
+        # @return [String]
+        def config
+          <<~CONFIG
+            [global_tags]
+              run_type = "${QA_RUN_TYPE}"
+              pipeline_id = "${CI_PIPELINE_ID}"
+              job_name = "${CI_JOB_NAME}"
+
+            [agent]
+              interval = "1s"
+              round_interval = true
+              metric_batch_size = 1000
+              metric_buffer_limit = 10000
+              collection_jitter = "0s"
+              flush_interval = "10s"
+              flush_jitter = "0s"
+              precision = ""
+              debug = true
+              logtarget = "file"
+              logfile = "#{LOG_DIR}/telegraf.log"
+              hostname = ""
+              omit_hostname = false
+
+            [[outputs.influxdb_v2]]
+              urls = ["${QA_INFLUXDB_URL}"]
+              token = "${QA_INFLUXDB_TOKEN}"
+              organization = "gitlab-qa"
+              bucket = "test-env-stats"
+
+            [[inputs.docker]]
+              endpoint = "unix:///var/run/docker.sock"
+              gather_services = false
+              container_names = []
+              source_tag = false
+              container_name_include = ["gitlab-{ce,ee}-*", "gitlab-{ce,ee}-qa-*"]
+              container_name_exclude = []
+              timeout = "5s"
+              perdevice = false
+              perdevice_include = []
+              total = true
+              total_include = ["cpu", "blkio", "network"]
+              docker_label_include = []
+              docker_label_exclude = []
+          CONFIG
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'erb'
+require 'date'
 
 module Gitlab
   module QA
@@ -24,7 +25,7 @@ module Gitlab
           end
 
           issue = gitlab.create_issue(
-            title: "Test session report | #{pipeline}",
+            title: "#{Time.now.strftime('%Y-%m-%d')} Test session report | #{pipeline}",
             description: generate_description(tests),
             labels: ['Quality', 'QA', 'triage report', pipeline_name_label]
           )

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

@@ -122,7 +122,7 @@ module Gitlab
             "found:canary.staging.gitlab.com"
           when 'preprod'
             'found:pre.gitlab.com'
-          when 'staging-orchestrated', 'nightly', QA::Runtime::Env.default_branch, 'staging-ref', 'release'
+          when 'nightly', QA::Runtime::Env.default_branch, 'staging-ref', 'release'
             "found:#{pipeline}"
           else
             raise "No `found:*` label for the `#{pipeline}` pipeline!"

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

@@ -117,6 +117,10 @@ module Gitlab
         def error_and_stack_trace(text)
           text.strip[/Error:(.*)/m, 1].to_s
         end
+
+        def updated_description(issue, test)
+          new_issue_description(test)
+        end
       end
     end
   end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'erb'
+
 module Gitlab
   module QA
     module Report
@@ -59,7 +61,28 @@ module Gitlab
         end
 
         def new_issue_description(test)
-          "#{super}#{TEST_CASE_RESULTS_SECTION_TEMPLATE}"
+          "#{super}\n\n#{execution_graph_section(test)}"
+        end
+
+        def execution_graph_section(test)
+          formatted_title = ERB::Util.url_encode(test.name)
+
+          <<~MKDOWN.strip
+            ### Executions
+
+            package-and-qa:
+            <img src="https://dashboards.quality.gitlab.net/render/d-solo/cW0UMgv7k/spec-health?orgId=1&var-run_type=package-and-qa&var-name=#{formatted_title}&panelId=4&width=1000&height=500" />
+          MKDOWN
+        end
+
+        def updated_description(testcase, test)
+          historical_results_section = testcase.description.match(/### DO NOT EDIT BELOW THIS LINE[\s\S]+/)
+
+          "#{new_issue_description(test)}\n\n#{historical_results_section}"
+        end
+
+        def issue_title_needs_updating?(testcase, test)
+          super || !testcase.description.include?(execution_graph_section(test)) && !%w[canary production preprod release].include?(pipeline)
         end
       end
     end

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

@@ -47,9 +47,14 @@ module Gitlab
         end
 
         def update_issue_title(issue, test)
-          warn(%(#{issue_type} title needs to be updated from '#{issue.title.strip}' to '#{title_from_test(test)}'))
+          old_title = issue.title.strip
+          new_title = title_from_test(test)
 
-          gitlab.edit_issue(iid: issue.iid, options: { title: title_from_test(test) })
+          warn(%(#{issue_type} title needs to be updated from '#{old_title}' to '#{new_title}'))
+
+          new_description = updated_description(issue, test)
+
+          gitlab.edit_issue(iid: issue.iid, options: { title: new_title, description: new_description })
         end
 
         private

data/lib/gitlab/qa/runner.rb

@@ -62,16 +62,17 @@ module Gitlab
         args = remove_gitlab_qa_args(args)
 
         if args.size >= 1
+          scenario = Scenario.const_get(args.shift)
+
           load_omnibus_configurations
+          load_telegraf(scenario)
 
           begin
             @active_configurators.compact.each do |configurator|
               configurator.instance(skip_teardown: true)
             end
 
-            Scenario
-              .const_get(args.shift)
-              .perform(*args)
+            scenario.perform(*args)
           ensure
             @active_configurators.compact.each(&:teardown)
           end
@@ -100,6 +101,18 @@ module Gitlab
         end.compact
       end
 
+      # Start telegraf agent for metrics collection
+      #
+      # Do not load when running against external instance
+      #
+      # @param [Class] scenario
+      # @return [void]
+      def self.load_telegraf(scenario)
+        return if scenario <= Scenario::Test::Instance::DeploymentBase || scenario == Scenario::Test::Instance::Any
+
+        @active_configurators << Component::Telegraf.new
+      end
+
       def self.load_omnibus_configurations
         # OmnibusConfiguration::Test       => --test
         # OmnibusConfiguration::HelloThere => --hello_there

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

@@ -36,6 +36,7 @@ module Gitlab
           'QA_SLOW_CONNECTION_LATENCY_MS' => :qa_slow_connection_latency_ms,
           'QA_SLOW_CONNECTION_THROUGHPUT_KBPS' => :qa_slow_connection_throughput_kbps,
           'QA_GENERATE_ALLURE_REPORT' => :generate_allure_report,
+          'QA_EE_ACTIVATION_CODE' => :ee_activation_code,
           'QA_EXPORT_TEST_METRICS' => :qa_export_test_metrics,
           'QA_INFLUXDB_URL' => :qa_influxdb_url,
           'QA_INFLUXDB_TOKEN' => :qa_influxdb_token,
@@ -141,16 +142,12 @@ module Gitlab
         end
 
         def variables
-          vars = {}
-
-          ENV_VARIABLES.each do |name, attribute|
+          ENV_VARIABLES.each_with_object({}) do |(name, attribute), vars|
             # Variables that are overridden in the environment take precedence
             # over the defaults specified by the QA runtime.
             value = env_var_name_if_defined(name) || send(attribute) # rubocop:disable GitlabSecurity/PublicSend
             vars[name] = value if value
           end
-
-          vars
         end
 
         def debug?
@@ -178,15 +175,7 @@ module Gitlab
         end
 
         def pipeline_from_project_name
-          if ci_project_name.to_s.start_with?('gitlab-qa')
-            if env_var_value_if_defined('TOP_UPSTREAM_SOURCE_JOB').to_s.start_with?('https://ops.gitlab.net')
-              'staging-orchestrated'
-            else
-              QA::Runtime::Env.default_branch
-            end
-          else
-            ci_project_name
-          end
+          ci_project_name.to_s.start_with?('gitlab-qa') ? QA::Runtime::Env.default_branch : ci_project_name
         end
 
         def run_id
@@ -309,6 +298,14 @@ module Gitlab
           enabled?(env_var_value_if_defined('GEO_FAILOVER'), default: false)
         end
 
+        def test_license_mode?
+          enabled?(env_var_value_if_defined('TEST_LICENSE_MODE'), default: false)
+        end
+
+        def qa_export_test_metrics?
+          enabled?(env_var_value_if_defined('QA_EXPORT_TEST_METRICS'), default: true)
+        end
+
         private
 
         def enabled?(value, default: true)

data/lib/gitlab/qa/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module QA
-    VERSION = '7.18.0'
+    VERSION = '7.21.0'
   end
 end

data/lib/gitlab/qa.rb

@@ -74,7 +74,6 @@ module Gitlab
           autoload :Registry, 'gitlab/qa/scenario/test/integration/registry'
           autoload :RegistryTLS, 'gitlab/qa/scenario/test/integration/registry_tls'
           autoload :ServicePingDisabled, 'gitlab/qa/scenario/test/integration/service_ping_disabled'
-          autoload :CloudActivation, 'gitlab/qa/scenario/test/integration/cloud_activation'
         end
 
         module Sanity
@@ -100,6 +99,7 @@ module Gitlab
       autoload :MailHog, 'gitlab/qa/component/mail_hog'
       autoload :Jira, 'gitlab/qa/component/jira'
       autoload :PostgreSQL, 'gitlab/qa/component/postgresql'
+      autoload :Telegraf, 'gitlab/qa/component/telegraf'
     end
 
     module Support

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 7.18.0
+  version: 7.21.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -256,6 +256,7 @@ files:
 - lib/gitlab/qa/component/specs.rb
 - lib/gitlab/qa/component/staging.rb
 - lib/gitlab/qa/component/staging_ref.rb
+- lib/gitlab/qa/component/telegraf.rb
 - lib/gitlab/qa/docker/command.rb
 - lib/gitlab/qa/docker/engine.rb
 - lib/gitlab/qa/docker/shellout.rb
@@ -310,7 +311,6 @@ files:
 - lib/gitlab/qa/scenario/test/instance/staging_ref.rb
 - lib/gitlab/qa/scenario/test/integration/actioncable.rb
 - lib/gitlab/qa/scenario/test/integration/client_ssl.rb
-- lib/gitlab/qa/scenario/test/integration/cloud_activation.rb
 - lib/gitlab/qa/scenario/test/integration/elasticsearch.rb
 - lib/gitlab/qa/scenario/test/integration/geo.rb
 - lib/gitlab/qa/scenario/test/integration/gitaly_cluster.rb

data/lib/gitlab/qa/scenario/test/integration/cloud_activation.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module QA
-    module Scenario
-      module Test
-        module Integration
-          class CloudActivation < Scenario::Template
-            def perform(release, *rspec_args)
-              Component::Gitlab.perform do |gitlab|
-                gitlab.release = release
-                gitlab.network = 'test'
-
-                gitlab.omnibus_configuration << <<~OMNIBUS
-                  gitlab_rails['env'] = { 'GITLAB_LICENSE_MODE' => 'test', 'CUSTOMER_PORTAL_URL' => 'https://customers.staging.gitlab.com' }
-                OMNIBUS
-
-                gitlab.instance do
-                  rspec_args << "--" unless rspec_args.include?('--')
-                  rspec_args << %w[--tag cloud_activation]
-
-                  Component::Specs.perform do |specs|
-                    specs.suite = 'Test::Instance::All'
-                    specs.release = gitlab.release
-                    specs.network = gitlab.network
-                    specs.args = [gitlab.address, *rspec_args]
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end