gitlab-qa 8.4.2 → 8.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae27f1af0edb9ce83b3ba33e8f18ddb155b62a786b7977d93ab74dfe2ba33e77
-  data.tar.gz: 45f26af4e1796502625888791990c16403654f1abe9558deca1d7fc351135383
+  metadata.gz: dca93a1000f4f0b6db2759a97ae3a6a7edf18e06576d689edd42180d794da943
+  data.tar.gz: bcd56912a666905a27513c07c24ef1ae72c24b463d68aba9b2dcff84e0011743
 SHA512:
-  metadata.gz: 4b7e606c2e6966d29ddc414e512ad7c2ce19a67dcf9ef20fcdaec5575219aa82631cb77c486e35c74f1a4c956004b6f7519f6422838a09d8e43873a5e9c4bbb4
-  data.tar.gz: 7ebbdd74ef735ecbdcb107bafa1418754f3cc89b18d72da2986b0d0d455145e25e4e4c812ab2d2dcbc72e4d50b2337d5f60d66100d715bbd6d3e4750f9eb9c22
+  metadata.gz: 0563f087686a1bf24c5fa1581993897d0cf553465636748d51929bcdad1b35d2a26362c7f40849cd5979ecb9eb4b476f3efde52f1c59142892fddbb497b254fb
+  data.tar.gz: 50f84dd5ae8abca78d6b2488e9213c1f1195e0c58279697eac7a2d943c7dd147f857a328840f9369d16829b2fc581c882a1bcee28093ee1b68400d924897f5f3

data/.rubocop_todo.yml

@@ -57,12 +57,6 @@ Naming/RescuedExceptionsVariableName:
   Exclude:
     - 'lib/gitlab/qa/component/staging.rb'
 
-# Offense count: 3
-# Cop supports --auto-correct.
-RSpec/EmptyLineAfterLetBlock:
-  Exclude:
-    - 'spec/gitlab/qa/support/dev_ee_qa_image_spec.rb'
-
 # Offense count: 4
 # Cop supports --auto-correct.
 # Configuration parameters: CustomTransform, IgnoredWords.
@@ -70,12 +64,6 @@ RSpec/ExampleWording:
   Exclude:
     - 'spec/gitlab/qa/component/gitlab_spec.rb'
 
-# Offense count: 1
-# Configuration parameters: CustomTransform, IgnoreMethods, SpecSuffixOnly.
-RSpec/FilePath:
-  Exclude:
-    - 'spec/gitlab/qa/support/dev_ee_qa_image_spec.rb'
-
 # Offense count: 2
 RSpec/LeakyConstantDeclaration:
   Exclude:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-qa (8.4.2)
+    gitlab-qa (8.5.0)
       activesupport (~> 6.1)
       gitlab (~> 4.18.0)
       http (~> 5.0)

data/exe/gitlab-qa

@@ -6,4 +6,4 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'gitlab/qa'
 
-Gitlab::QA::Runner.run(ARGV)
+Gitlab::QA::Runner.run(ARGV.dup)

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

@@ -157,11 +157,11 @@ module Gitlab
             reconfigure
             wait_until_ready
             process_exec_commands
-          rescue Docker::Shellout::StatusError => e
+          rescue Support::ShellCommand::StatusError => e
             # for scenarios where a service fails during startup, attempt to retry to avoid flaky failures
             if (retries += 1) < 3
               Runtime::Logger.warn(
-                "Retry instance_no_teardown due to Docker::Shellout::StatusError -- attempt #{retries}"
+                "Retry instance_no_teardown due to Support::ShellCommand::StatusError -- attempt #{retries}"
               )
               teardown!
               retry

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

@@ -338,7 +338,7 @@ module Gitlab
             output = docker.inspect(name) { |command| command << "--format='{{json .State.Health.Status}}'" }
 
             output == '"healthy"'
-          rescue Docker::Shellout::StatusError
+          rescue Support::ShellCommand::StatusError
             false
           end
         end

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

@@ -20,31 +20,21 @@ module Gitlab
         end
 
         def self.image
+          # QA images are tagged with the following logic
+          # 1. For auto-deploy versions, they are tagged with their corresponding commit SHA
+          #    That is, if auto-deploy version is `15.4.202209150620+70251a89db4.a625f183e2e`,
+          #    the QA image tag will be `70251a89db4`
+          # 2. For stable/RC versions, they are tagged with the version with `v` prefix.
+          #    That is, if the version is `15.3.3-ee`, the QA image tag will be `v15.3.3-ee`
+          # These images are available from the GitLab project's container registry.
+
+          # If token to access dev.gitlab.org registry is provided, we will
+          # fetch from there. Else, we will try to fetch from GitLab.com
+          # registry.
           if Runtime::Env.dev_access_token_variable
-            # Auto-deploy builds have a tag formatted like 12.1.12345+5159f2949cb.59c9fa631
-            # where `5159f2949cb` is the EE commit SHA. QA images are tagged using
-            # the version from the VERSION file and this commit SHA, e.g.
-            # `12.0-5159f2949cb` (note that the `major.minor` doesn't necessarily match).
-            # To work around that, we're fetching the `revision` from the version API
-            # and then find the corresponding QA image in the
-            # `dev.gitlab.org:5005/gitlab/omnibus-gitlab/gitlab-ee-qa` container
-            # registry, based on this revision.
-            # See:
-            #  - https://gitlab.com/gitlab-org/quality/staging/issues/56
-            #  - https://gitlab.com/gitlab-org/release/framework/issues/421
-            #  - https://gitlab.com/gitlab-org/gitlab-qa/issues/398
-            #
-            # For official builds (currently deployed on preprod) we use the version
-            # string e.g. '12.5.4-ee' for tag matching
-            Support::DevEEQAImage.new.retrieve_image_from_container_registry!(tag_end)
+            "dev.gitlab.org:5005/gitlab/gitlab-ee/gitlab-ee-qa:#{tag}"
           else
-            # Auto-deploy builds have a tag formatted like 12.0.12345+5159f2949cb.59c9fa631
-            # but the version api returns a semver version like 12.0.1
-            # so images are tagged using minor and major semver components plus
-            # the EE commit ref, which is the 'revision' returned by the API
-            # and so the version used for the docker image tag is like 12.0-5159f2949cb
-            # See: https://gitlab.com/gitlab-org/quality/staging/issues/56
-            "ee:#{Version.new(address).major_minor_revision}"
+            "registry.gitlab.com/gitlab-org/gitlab/gitlab-ee-qa:#{tag}"
           end
         end
 
@@ -52,8 +42,8 @@ module Gitlab
           self::ADDRESS
         end
 
-        def self.tag_end
-          @tag_end ||= Version.new(address).tag_end
+        def self.tag
+          @tag ||= Version.new(address).tag
         end
 
         class Version
@@ -65,16 +55,8 @@ module Gitlab
             Runtime::Env.require_qa_access_token!
           end
 
-          def tag_end
-            official? ? version : revision
-          end
-
-          def major_minor_revision
-            api_response = api_get!
-            version_regexp = /^v?(?<major>\d+)\.(?<minor>\d+)\.\d+/
-            match = version_regexp.match(api_response.fetch('version'))
-
-            "#{match[:major]}.#{match[:minor]}-#{api_response.fetch('revision')}"
+          def tag
+            official? ? "v#{version}" : revision
           end
 
           private

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module Component
+      class SuggestedReviewer
+        include Scenario::Actable
+
+        # Source: https://gitlab.com/gitlab-org/modelops/applied-ml/review-recommender/cluster-management
+        MANIFESTS_PATH = File.expand_path('../../../../support/manifests/suggested_reviewer', __dir__)
+
+        def initialize
+          @cluster = Service::KubernetesCluster.new(provider_class: Service::ClusterProvider::K3d)
+        end
+
+        def name
+          @name ||= "suggested_reviewer"
+        end
+
+        def prepare
+          @cluster.create_registry_mirror
+        end
+
+        def create_cluster
+          @cluster.create!
+        end
+
+        def deploy_services
+          Dir.glob(File.join(MANIFESTS_PATH, '**/*')).each do |file|
+            Runtime::Logger.info("Applying manifest #{file}")
+            @cluster.apply_manifest(File.read(file))
+          end
+        end
+
+        def teardown
+          @cluster.remove!
+        end
+
+        def wait_until_ready; end
+
+        def teardown?
+          !Runtime::Scenario.attributes.include?(:teardown) || Runtime::Scenario.teardown
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/docker/command.rb

@@ -4,7 +4,7 @@ module Gitlab
   module QA
     module Docker
       class Command
-        attr_reader :args, :stream_output
+        attr_reader :args
 
         # Shell command
         #
@@ -41,24 +41,13 @@ module Gitlab
           "docker #{@args.join(' ')}"
         end
 
-        # Returns a masked string form of a Command
-        #
-        # @example
-        #   Command.new('a docker command', mask_secrets: 'command').mask_secrets #=> 'a docker *****'
-        #   Command.new('a docker command', mask_secrets: %w[docker command]).mask_secrets #=> 'a ***** *****'
-        #
-        # @return [String] The masked command string
-        def mask_secrets
-          @mask_secrets.each_with_object(+to_s) { |secret, s| s.gsub!(secret, '*****') }
-        end
-
         def ==(other)
           to_s == other.to_s
         end
 
         def execute!(&block)
-          Docker::Shellout.new(self).execute!(&block)
-        rescue Docker::Shellout::StatusError => e
+          Support::ShellCommand.new(to_s, mask_secrets: @mask_secrets, stream_output: @stream_output).execute!(&block)
+        rescue Support::ShellCommand::StatusError => e
           e.set_backtrace([])
 
           raise e

data/lib/gitlab/qa/docker/engine.rb

@@ -112,7 +112,7 @@ module Gitlab
 
         def manifest_exists?(name)
           Docker::Command.execute("manifest inspect #{name}")
-        rescue Docker::Shellout::StatusError
+        rescue Support::ShellCommand::StatusError
           false
         else
           true

data/lib/gitlab/qa/release.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/module/delegation"
+
 module Gitlab
   module QA
     class Release
@@ -23,6 +25,8 @@ module Gitlab
         \z
       }xi.freeze
 
+      delegate :ci_project_path, to: Gitlab::QA::Runtime::Env
+
       # Official dev tag example:
       #  12.5.4(-rc42)-ee
       # |-------------|--|
@@ -109,7 +113,7 @@ module Gitlab
       def qa_image
         @qa_image ||= if omnibus_mirror?
                         omnibus_project = image.match(CUSTOM_GITLAB_IMAGE_REGEX)[:project]
-                        gitlab_project = "/gitlab-org/gitlab/"
+                        gitlab_project = ci_project_path ? "/#{ci_project_path}/" : "/gitlab-org/gitlab/"
 
                         "#{image.gsub(omnibus_project, gitlab_project)}-qa"
                       else
@@ -139,7 +143,7 @@ module Gitlab
       # Tag scheme for gitlab-{ce,ee}-qa images is like 11.1.0-rc12-ee
       def qa_tag
         if dev_gitlab_org? && (match_data = tag.match(DEV_TAG_REGEX))
-          "#{match_data[:version]}-#{match_data[:gitlab_ref]}"
+          match_data[:gitlab_ref]
         else
           tag.sub(/[-.]([ce]e)(\.(\d+))?\z/, '-\1')
         end

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

@@ -32,7 +32,7 @@ module Gitlab
         end
 
         def new_issue_labels(test)
-          ['Quality', "devops::#{test.stage}", 'status::automated']
+          %w[Quality status::automated]
         end
 
         def search_term(test)

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

@@ -94,6 +94,7 @@ module Gitlab
           'CI_NODE_TOTAL' => :ci_node_total,
           'CI_PROJECT_ID' => :ci_project_id,
           'CI_PROJECT_NAME' => :ci_project_name,
+          'CI_PROJECT_PATH' => :ci_project_path,
           'CI_SLACK_WEBHOOK_URL' => :ci_slack_webhook_url,
           'CI_PIPELINE_ID' => :ci_pipeline_id,
           'CI_PIPELINE_SOURCE' => :ci_pipeline_source,
@@ -272,6 +273,12 @@ module Gitlab
           raise ArgumentError, "Please provide CI_SLACK_WEBHOOK_URL"
         end
 
+        def require_qa_container_registry_access_token!
+          return unless env_var_value_if_defined('GITLAB_QA_CONTAINER_REGISTRY_ACCESS_TOKEN').to_s.strip.empty?
+
+          raise ArgumentError, "Please provide GITLAB_QA_CONTAINER_REGISTRY_ACCESS_TOKEN"
+        end
+
         def require_kubernetes_environment!
           %w[GCLOUD_ACCOUNT_EMAIL GCLOUD_ACCOUNT_KEY CLOUDSDK_CORE_PROJECT].each do |env_key|
             unless ENV.key?(env_key)

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module Scenario
+      module Test
+        module Integration
+          class SuggestedReviewer < Scenario::Template
+            attr_reader :spec_suite
+
+            def initialize
+              @spec_suite = 'Test::Instance::All'
+              @network = 'test'
+              @env = {}
+              @tag = 'suggested_reviewer'
+              @gitlab_name = 'gitlab-suggested-reviewer'
+            end
+
+            def perform(release, *rspec_args)
+              Component::Gitlab.perform do |gitlab|
+                gitlab.release = QA::Release.new(release)
+                gitlab.name = @gitlab_name
+                gitlab.network = @network
+
+                gitlab.instance do
+                  # Wait for the suggested reviewer services to be ready before attempting to run specs
+                  @cluster = suggested_reviewer_cluster
+                  @cluster.wait_until_ready
+
+                  Runtime::Logger.info('Running Suggested Reviewer specs!')
+
+                  if @tag
+                    rspec_args << "--" unless rspec_args.include?('--')
+                    rspec_args << "--tag" << @tag
+                  end
+
+                  Component::Specs.perform do |specs|
+                    specs.suite = spec_suite
+                    specs.release = gitlab.release
+                    specs.network = gitlab.network
+                    specs.args = [gitlab.address, *rspec_args]
+                    specs.env = @env
+                  end
+                end
+              end
+            ensure
+              @cluster&.teardown if @cluster&.teardown?
+            end
+
+            def suggested_reviewer_cluster
+              Component::SuggestedReviewer.new.tap do |sr|
+                sr.prepare
+                sr.create_cluster
+                sr.deploy_services
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/scenario/test/omnibus/update_from_previous.rb

@@ -94,7 +94,7 @@ module Gitlab
                 specs.network = gitlab.network
                 specs.args = [gitlab.address, *rspec_args]
               end
-            rescue Docker::Shellout::StatusError => e
+            rescue Support::ShellCommand::StatusError => e
               raise e if release == current_release # only fail on current release
 
               Runtime::Logger.warn("Test run for release '#{gitlab.release}' finished with errors!")

data/lib/gitlab/qa/service/cluster_provider/base.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module Service
+      module ClusterProvider
+        class Base
+          include Support::Shellout
+
+          GITLAB_REGISTRY = 'registry.gitlab.com'
+
+          attr_accessor :create_args
+
+          def cluster_name
+            @cluster_name ||= "qa-cluster-#{Time.now.utc.strftime('%Y%m%d')}-#{SecureRandom.hex(4)}"
+          end
+
+          def validate_dependencies
+            raise NotImplementedError
+          end
+
+          def setup
+            raise NotImplementedError
+          end
+
+          def teardown
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/service/cluster_provider/k3d.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module Service
+      module ClusterProvider
+        class K3d < Base
+          def create_registry_mirror
+            return if registry_mirror_exists?('registry-gitlab')
+
+            Runtime::Env.require_qa_container_registry_access_token!
+
+            shell <<~CMD
+              k3d registry create registry-gitlab \
+                -p 5000 \
+                --proxy-remote-url https://#{GITLAB_REGISTRY} \
+                --proxy-password #{Runtime::Env.gitlab_username} \
+                --proxy-username #{Runtime::Env.qa_container_registry_access_token} \
+                -v tmp/registry-gitlab:/var/lib/registry
+            CMD
+
+            File.write('tmp/registry-mirror.yml', registry_mirror)
+
+            create_args << %w[--registry-use k3d-registry-gitlab:5000 --registry-config tmp/registry-mirror.yml]
+          end
+
+          def validate_dependencies
+            find_executable('k3d') || raise("You must first install `k3d` executable to run these tests.")
+          end
+
+          def setup
+            shell "k3d cluster create #{cluster_name} #{create_args&.join(' ')}"
+
+            install_local_storage
+          end
+
+          def teardown
+            shell "k3d cluster delete #{cluster_name}"
+          end
+
+          private
+
+          def registry_mirror_exists?(name)
+            shell('k3d registry list').include?("k3d-#{name}")
+          end
+
+          def retry_until(max_attempts: 10, wait: 1)
+            max_attempts.times do
+              result = yield
+              return result if result
+
+              sleep wait
+            end
+
+            raise "Retried #{max_attempts} times. Aborting"
+          end
+
+          def install_local_storage
+            shell('kubectl apply -f -', stdin_data: local_storage_config)
+          end
+
+          # See https://github.com/rancher/k3d/issues/67
+          def local_storage_config
+            <<~YAML
+              ---
+              apiVersion: v1
+              kind: ServiceAccount
+              metadata:
+                name: storage-provisioner
+                namespace: kube-system
+              ---
+              apiVersion: rbac.authorization.k8s.io/v1
+              kind: ClusterRoleBinding
+              metadata:
+                name: storage-provisioner
+              roleRef:
+                apiGroup: rbac.authorization.k8s.io
+                kind: ClusterRole
+                name: system:persistent-volume-provisioner
+              subjects:
+                - kind: ServiceAccount
+                  name: storage-provisioner
+                  namespace: kube-system
+              ---
+              apiVersion: v1
+              kind: Pod
+              metadata:
+                name: storage-provisioner
+                namespace: kube-system
+              spec:
+                serviceAccountName: storage-provisioner
+                tolerations:
+                - effect: NoExecute
+                  key: node.kubernetes.io/not-ready
+                  operator: Exists
+                  tolerationSeconds: 300
+                - effect: NoExecute
+                  key: node.kubernetes.io/unreachable
+                  operator: Exists
+                  tolerationSeconds: 300
+                hostNetwork: true
+                containers:
+                - name: storage-provisioner
+                  image: gcr.io/k8s-minikube/storage-provisioner:v1.8.1
+                  command: ["/storage-provisioner"]
+                  imagePullPolicy: IfNotPresent
+                  volumeMounts:
+                  - mountPath: /tmp
+                    name: tmp
+                volumes:
+                - name: tmp
+                  hostPath:
+                    path: /tmp
+                    type: Directory
+              ---
+              kind: StorageClass
+              apiVersion: storage.k8s.io/v1
+              metadata:
+                name: standard
+                namespace: kube-system
+                annotations:
+                  storageclass.kubernetes.io/is-default-class: "true"
+                labels:
+                  addonmanager.kubernetes.io/mode: EnsureExists
+              provisioner: k8s.io/minikube-hostpath
+            YAML
+          end
+
+          def registry_mirror
+            <<~YAML
+              mirrors:
+                "registry.gitlab.com":
+                  endpoint:
+                    - http://k3d-registry-gitlab:5000
+            YAML
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/service/kubernetes_cluster.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+
+module Gitlab
+  module QA
+    module Service
+      class KubernetesCluster
+        include Support::Shellout
+
+        attr_reader :provider
+
+        def initialize(provider_class: QA::Service::ClusterProvider::K3d)
+          @provider = provider_class.new
+        end
+
+        def create!
+          validate_dependencies
+
+          @provider.validate_dependencies
+          @provider.setup
+
+          self
+        end
+
+        def remove!
+          @provider.teardown
+        end
+
+        def cluster_name
+          @provider.cluster_name
+        end
+
+        def to_s
+          cluster_name
+        end
+
+        def create_registry_mirror
+          @provider.create_registry_mirror
+        end
+
+        def create_secret(secret, secret_name)
+          shell("kubectl create secret generic #{secret_name} --from-literal=token='#{secret}'", mask_secrets: [secret])
+        end
+
+        def apply_manifest(manifest)
+          shell('kubectl apply -f -', stdin_data: manifest)
+        end
+
+        private
+
+        def admin_user
+          @admin_user ||= "#{@provider.cluster_name}-admin"
+        end
+
+        def validate_dependencies
+          find_executable('kubectl') || raise("You must first install `kubectl` executable to run these tests.")
+        end
+      end
+    end
+  end
+end