gitlab-qa 7.29.0 → 7.29.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d4ca3feba042298fe467133b5f576653b553af61ac01a0b72a1a970917e3711
-  data.tar.gz: 61ee29dbe4355bcbc18d8e164b97f1453c461419fcf6bd70543a659e5029d333
+  metadata.gz: 6f3a8d250f26a5899d776475ac349829311045b51aeed7b73f1a40fc41cd23dc
+  data.tar.gz: 2258303729505a302fe0a6d05b57f5deee6efe21f0d7cbfb2542e92febfe2dc7
 SHA512:
-  metadata.gz: 5ddff780b5188c489bec89ce0b475096ac707f9e2e5138cc400efeef9fbd576b4c5bebc77f43af207109503e08e1c1efaf2813e3666bd9d88d5807f7c9691891
-  data.tar.gz: 34b7eacbd20c81f264aaf478f35e9ed78d5c7e185b18178bd55fa1c5fc37b0053f54bd49027d994cf91d6d69120c3371fdb818727419c17ef10ea7f373a4c91d
+  metadata.gz: 2ad81f0b8d7bcb59ff76963f0463ae2d221be28b262455c22e6ee11ad91a9c6b768291639ed25b9ff756c9b319566f4aa596281ca2c09d470a5a1374174f3929
+  data.tar.gz: 6e5a9601b50167f4cae9c87fe1415b1a6a740c855e56580cc553559d481842f6ed9feced7760a0403bb7993ef5ba7e11c1fd5723d2812a06227d1a64b87aefd1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-qa (7.29.0)
+    gitlab-qa (7.29.1)
       activesupport (~> 6.1)
       gitlab (~> 4.18.0)
       http (~> 5.0)
@@ -219,7 +219,7 @@ GEM
       concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.8.1)
+    unf_ext (0.0.8.2)
     unicode-display_width (1.8.0)
     webmock (3.7.0)
       addressable (>= 2.3.6)

data/docs/what_tests_can_be_run.md

@@ -712,6 +712,23 @@ in the GitLab project).
   This is used to retrieve the version that staging is currently running.
   This can be found in the shared 1Password vault.
 
+- `GITLAB_USERNAME`: An existing user.
+
+- `GITLAB_PASSWORD`: The user's password.
+
+**Required by specific tests:**
+
+- `QA_PRAEFECT_REPOSITORY_STORAGE`: The name of a Gitaly Cluster storage.
+
+- `GITLAB_ADMIN_USERNAME`: An existing user with administrator access. Required by tests that set feature flags or
+  perform other admin actions.
+
+- `GITLAB_ADMIN_PASSWORD`: The administrator user's password.
+
+- `GITLAB_QA_USERNAME_X`: The username of a pre-generated test user, where `X` is `1` to `6`.
+
+- `GITLAB_QA_PASSWORD_X`: The pre-generated test user's password.
+
 **Optional environment variables:**
 
 - `GITLAB_QA_DEV_ACCESS_TOKEN`: A valid personal access token for the
@@ -719,17 +736,24 @@ in the GitLab project).
   This is used to pull the QA Docker image from the Omnibus GitLab `dev` Container Registry.
   If the variable isn't present, the QA image from Docker Hub will be used.
   This can be found in the shared 1Password vault.
+  Please note that this variable must be provided when you need to be sure the version of the
+  tests matches the version of GitLab on Staging. If the version from Docker Hub is used it might not include changes deployed to Staging very recently.
 
-Example:
+An example of how to run the smoke tests:
 
 ```
-$ export GITLAB_QA_USER_AGENT="$GITLAB_QA_USER_AGENT"
-$ export GITLAB_QA_ACCESS_TOKEN=your_api_access_token
-$ export GITLAB_QA_DEV_ACCESS_TOKEN=your_dev_registry_access_token
+$ export GITLAB_QA_USER_AGENT="<value from 1Password>"
+$ export GITLAB_QA_ACCESS_TOKEN="<value from 1Password>"
+$ export GITLAB_QA_DEV_ACCESS_TOKEN="<value from 1Password>"
 $ export GITLAB_USERNAME="gitlab-qa"
-$ export GITLAB_PASSWORD="$GITLAB_QA_PASSWORD"
+$ export GITLAB_PASSWORD="<value from 1Password>"
+$ export GITLAB_ADMIN_USERNAME="<value from 1Password>"
+$ export GITLAB_ADMIN_PASSWORD="<value from 1Password>"
+$ export GITLAB_QA_USERNAME_1="gitlab-qa-user1"
+$ export GITLAB_QA_PASSWORD_1="<value from 1Password>"
+$ export QA_PRAEFECT_REPOSITORY_STORAGE="nfs-file22"
 
-$ gitlab-qa Test::Instance::Staging
+$ gitlab-qa Test::Instance::Staging -- --tag smoke
 ```
 
 ### `Test::Instance::StagingRef`
@@ -828,6 +852,52 @@ by setting `QA_COOKIES=gitlab_canary=true`. This adds a cookie
 to all web requests which will result in them being routed
 to the canary fleet.
 
+**Required environment variables:**
+
+- `GITLAB_QA_USER_AGENT`: The browser user-agent to use instead of the default Chrome user-agent.
+  This is needed for the automated tests to bypass the WAF
+
+- `GITLAB_QA_ACCESS_TOKEN`: A valid personal access token with the `api` scope.
+  This is used to retrieve the version that staging is currently running.
+  This can be found in the shared 1Password vault.
+
+- `GITLAB_USERNAME`: An existing user.
+
+- `GITLAB_PASSWORD`: The user's password.
+
+**Required by specific tests:**
+
+- `GITLAB_QA_USERNAME_X`: The username of a pre-generated test user, where `X` is `1` to `6`.
+
+- `GITLAB_QA_PASSWORD_X`: The pre-generated test user's password.
+
+**Optional environment variables:**
+
+- `GITLAB_QA_DEV_ACCESS_TOKEN`: A valid personal access token for the
+  `gitlab-qa-bot` on `dev.gitlab.org` with the `registry` scope.
+  This is used to pull the QA Docker image from the Omnibus GitLab `dev` Container Registry.
+  If the variable isn't present, the QA image from Docker Hub will be used.
+  This can be found in the shared 1Password vault.
+  Please note that this variable should be provided when you need to be sure the version of the
+  tests matches the version of GitLab on Staging. If the version from Docker Hub is used it might not include changes deployed to Staging very recently.
+
+An example of how to run the smoke tests:
+
+```
+$ export GITLAB_QA_USER_AGENT="<value from 1Password>"
+$ export GITLAB_QA_ACCESS_TOKEN="<value from 1Password>"
+$ export GITLAB_QA_DEV_ACCESS_TOKEN="<value from 1Password>"
+$ export GITLAB_USERNAME="gitlab-qa"
+$ export GITLAB_PASSWORD="<value from 1Password>"
+$ export GITLAB_QA_USERNAME_1="gitlab-qa-user1"
+$ export GITLAB_QA_PASSWORD_1="<value from 1Password>"
+$ export QA_CAN_TEST_GIT_PROTOCOL_V2="false"
+$ export QA_CAN_TEST_ADMIN_FEATURES="false"
+$ export QA_CAN_TEST_PRAEFECT="false"
+
+$ gitlab-qa Test::Instance::Production -- --tag smoke
+```
+
 ### `Test::Instance::Preprod`
 
 This scenario functions the same as `Test::Instance::Staging`

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

@@ -11,7 +11,7 @@ module Gitlab
         attr_accessor :suite, :release, :network, :args, :volumes, :env, :runner_network, :hostname
 
         def initialize
-          @docker = Docker::Engine.new
+          @docker = Docker::Engine.new(stream_output: true) # stream test output directly instead of through logger
           @volumes = {}
           @env = {}
         end

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

@@ -2,11 +2,17 @@ module Gitlab
   module QA
     module Docker
       class Command
-        attr_reader :args
+        attr_reader :args, :stream_output
 
-        def initialize(cmd = nil, mask_secrets: nil)
+        # Shell command
+        #
+        # @param [<String, Array>] cmd
+        # @param [<String, Array>] mask_secrets
+        # @param [Boolean] stream_output stream command output to stdout directly instead of logger
+        def initialize(cmd = nil, mask_secrets: nil, stream_output: false)
           @args = Array(cmd)
           @mask_secrets = Array(mask_secrets)
+          @stream_output = stream_output
         end
 
         def <<(*args)

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

@@ -7,6 +7,12 @@ module Gitlab
         DOCKER_HOST = ENV['DOCKER_HOST'] || 'http://localhost'
         PRIVILEGED_COMMANDS = [/^iptables.*/].freeze
 
+        attr_reader :stream_output
+
+        def initialize(stream_output: false)
+          @stream_output = stream_output
+        end
+
         def hostname
           URI(DOCKER_HOST).host
         end
@@ -25,7 +31,7 @@ module Gitlab
         end
 
         def run(image:, tag: nil, args: [])
-          Docker::Command.new('run').tap do |command|
+          Docker::Command.new('run', stream_output: stream_output).tap do |command|
             yield command if block_given?
 
             command << full_image_name(image, tag)

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

@@ -17,25 +17,33 @@ module Gitlab
           @logger = Runtime::Logger.logger
         end
 
+        attr_reader :command, :logger
+
         def execute! # rubocop:disable Metrics/AbcSize
           raise StatusError, 'Command already executed' if @output.any?
 
-          @logger.info("Docker shell command: `#{@command.mask_secrets}`".cyan)
+          logger.info("Docker shell command: `#{@command.mask_secrets.cyan}`")
 
           Open3.popen2e(@command.to_s) do |_in, out, wait|
             out.each do |line|
               @output.push(line)
-              print "." unless Runtime::Env.ci # indicate progress for local run
+
+              if stream_progress
+                print "."
+              elsif command.stream_output
+                puts line
+              end
+
               yield line, wait if block_given?
             end
-            puts unless Runtime::Env.ci # add newline after progress dots
+            puts if stream_progress
 
             if wait.value.exited? && wait.value.exitstatus.nonzero?
-              @logger.error("Docker shell command output:\n#{output}")
-              raise StatusError, "Docker command `#{@command.mask_secrets}` failed! ✘"
+              logger.error("Docker shell command output:\n#{output}") unless command.stream_output
+              raise StatusError, "Docker command `#{@command.mask_secrets[0..100]}` failed! ✘"
             end
 
-            @logger.debug("Docker shell command output:\n#{output}") unless output.empty?
+            logger.debug("Docker shell command output:\n#{output}") unless command.stream_output || output.empty?
           end
 
           output
@@ -43,6 +51,13 @@ module Gitlab
 
         private
 
+        # Stream only command execution progress and log output when command finished
+        #
+        # @return [Boolean]
+        def stream_progress
+          !(Runtime::Env.ci || command.stream_output)
+        end
+
         def output
           @output.join.chomp
         end

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

@@ -12,13 +12,10 @@ module Gitlab
 
         def self.logger
           @logger ||= begin
-            log_path = Runtime::Env.log_path
-            FileUtils.mkdir_p(log_path) unless File.exist?(log_path)
+            log_path = Env.log_path
+            ::FileUtils.mkdir_p(log_path) unless File.exist?(log_path)
 
-            QA::TestLogger.logger(
-              level: Runtime::Env.debug? ? "DEBUG" : Runtime::Env.log_level,
-              path: log_path
-            )
+            TestLogger.logger(level: Env.debug? ? "DEBUG" : Env.log_level, path: log_path)
           end
         end
       end

data/lib/gitlab/qa/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module QA
-    VERSION = '7.29.0'
+    VERSION = '7.29.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 7.29.0
+  version: 7.29.1
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control