gitlab-qa 7.20.0 → 7.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7b10d593ddaeee4b4e931904d7332f845b1fb8f816e5e42d3c79e22634ff680
-  data.tar.gz: 93b081c8de2108f2b9f17462319b3ac5467671a3b775ab597fbe317b0f7646aa
+  metadata.gz: 7df136e02dc7640dd456d9e6f0f089cfdf105c7e8d4983ee41e487081eadb3eb
+  data.tar.gz: 9ab31d33024c1a2e6826213028e4a1f1c3ab69c8ece4d230be79a4f3b1f15108
 SHA512:
-  metadata.gz: 1f590d463f6fea2e69dba2ad64ac15274011a63863db9c8d9544e24e07c91a683a92709b96f0628d114da4d825bc5a4e5104bdf9c6bbd57750ef2b3f20007ee8
-  data.tar.gz: 681dd9b8d51cc491a75a4beba08391ffecbb7ecef6218c9db51854d452e4a7a2bf9e9fe36e7e9603608be4d5468d6ecf0462951004eb1f68155715d2a9497216
+  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:

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/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

@@ -142,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?
@@ -179,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
@@ -314,6 +302,10 @@ module Gitlab
           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.20.0'
+    VERSION = '7.21.0'
   end
 end

data/lib/gitlab/qa.rb

@@ -99,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.20.0
+  version: 7.21.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-25 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