gitlab-qa 5.13.0 → 5.13.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94ac8993fb7c19d11ab0345971f2ca8ff00c65ab0e6f89bc59b368b8df04a676
-  data.tar.gz: 484c627fd9f85f8ece3a4a2c2370053841caefbe629e72f25f3b2d39c4b9ba33
+  metadata.gz: 176ad29bc36b0c276fd9f0addab99fbc57b3cfc7cc4edec364921e7b2ed9d80a
+  data.tar.gz: 3cd4551211e72968b2403f58e3f0583f588cc3f4496e7da8fc31cd484e6ba013
 SHA512:
-  metadata.gz: b4b35673cd80bdbfae8ba22a48d4949e367fdbecbf86355be5139b381e2b3ab85b3c5da6996acaac4b25a2044298a51766d20fb6337769bf4449dc3f9ddb6e77
-  data.tar.gz: 89e28812ae5e2c4981af8b91bf736051affda188e6b785db94ea532ecbd7d26c977313e8fd861c34fbc3f4fdd3bfd5cb6bc6d84a77cc462ed623793e278cac5d
+  metadata.gz: 64f2a6f26ade53e538405d3f4f4a7d516205079add946969f2855a27a36e217b93dc6793b5bb2e1365edf0820518ed2e2510a46295903c44099b5fc8d829e652
+  data.tar.gz: f034880d5eee0b1f00b1ab9a60394203cfbd05d0d895f0a26b782f22baec0634880007be944a53a6aa565db908a064a04442041f02f7735fd4f7f83859f9c02d

data/docs/what_tests_can_be_run.md

@@ -28,60 +28,56 @@ For more details on the internals, please read the
 
 ## Supported GitLab environment variables
 
-* `GITLAB_USERNAME` - username to use when signing into GitLab
-* `GITLAB_PASSWORD` - password to use when signing into GitLab
-* `GITLAB_FORKER_USERNAME` - username to use for forking a project
-* `GITLAB_FORKER_PASSWORD` - password to use for forking a project
-* `GITLAB_QA_USERNAME_1` - username available in environments where signup is disabled
-* `GITLAB_QA_PASSWORD_1` - password for `GITLAB_QA_USERNAME_1` available in environments where signup is disabled (e.g. staging.gitlab.com)
-* `GITLAB_QA_USERNAME_2` - another username available in environments where signup is disabled
-* `GITLAB_QA_PASSWORD_2` - password for `GITLAB_QA_USERNAME_2` available in environments where signup is disabled (e.g. staging.gitlab.com)
-* `GITLAB_QA_USERNAME_3` - another username available in environments where signup is disabled
-* `GITLAB_QA_PASSWORD_3` - password for `GITLAB_QA_USERNAME_3` available in environments where signup is disabled (e.g. staging.gitlab.com)
-* `GITLAB_QA_USERNAME_4` - another username available in environments where signup is disabled
-* `GITLAB_QA_PASSWORD_4` - password for `GITLAB_QA_USERNAME_4` available in environments where signup is disabled (e.g. staging.gitlab.com)
-* `GITLAB_QA_USERNAME_5` - another username available in environments where signup is disabled
-* `GITLAB_QA_PASSWORD_5` - password for `GITLAB_QA_USERNAME_5` available in environments where signup is disabled (e.g. staging.gitlab.com)
-* `GITLAB_QA_USERNAME_6` - another username available in environments where signup is disabled
-* `GITLAB_QA_PASSWORD_6` - password for `GITLAB_QA_USERNAME_6` available in environments where signup is disabled (e.g. staging.gitlab.com)
-* `GITLAB_LDAP_USERNAME` - LDAP username to use when signing into GitLab
-* `GITLAB_LDAP_PASSWORD` - LDAP password to use when signing into GitLab
-* `GITLAB_ADMIN_USERNAME` - Admin username to use when adding a license
-* `GITLAB_ADMIN_PASSWORD` - Admin password to use when adding a license
-* `GITLAB_SANDBOX_NAME` - The sandbox group name the test suite is going to use (default: `gitlab-qa-sandbox`)
-* `GITLAB_QA_ACCESS_TOKEN` -  A valid personal access token with the `api` scope.
-  This is used for API access during tests, and is used in the
-  [`Test::Instance::Staging`](#testinstancestaging) scenario to retrieve the
-  version that staging is currently running. An existing token that is valid on
-  staging can be found in the shared 1Password vault.
-* `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.
-* `EE_LICENSE` - Enterprise Edition license
-* `QA_ARTIFACTS_DIR` - Path to a directory where artifacts (logs and screenshots)
-  for failing tests will be saved (default: `/tmp/gitlab-qa`)
-* `DOCKER_HOST` - Docker host to run tests against (default: `http://localhost`)
-* `CHROME_HEADLESS` - when running locally, set to `false` to allow Chrome tests to be visible - watch your tests being run
-* `QA_ADDITIONAL_REPOSITORY_STORAGE` - the name of additional, non-default storage to be used with tests tagged `repository_storage`, run via the `Test::Instance::RepositoryStorage` scenario
-* `QA_PRAEFECT_REPOSITORY_STORAGE` - the name of repository storage using Praefect.
-* `QA_COOKIES` - optionally set to "cookie1=value;cookie2=value" in order to add a cookie to every request. This can be used to set the canary cookie by setting it to "gitlab_canary=true"
-* `QA_DEBUG` - set to `true` to verbosely log page object actions. Note: if enabled be aware that sensitive data might be logged. If an input element has a QA selector with `password` in the name, data entered into the input element will be masked. If the element doesn't have `password` in its name it won't be masked.
-* `QA_LOG_PATH` - path to output debug logging to. If not set logging will be output to STDOUT
-* `QA_CAN_TEST_GIT_PROTOCOL_V2` - set to `false` to skip tests that require Git protocol v2 if your environment doesn't support it.
-* `QA_CAN_TEST_ADMIN_FEATURES` - set to `false` to skip tests that require admin access.
-* `QA_CAN_TEST_PRAEFECT` - set to `false` to skip tests that require Praefect to be running.
-* `QA_DISABLE_RSPEC_RETRY` - set to `true` to turn off retrying tests on failure.
-* `QA_SIMULATE_SLOW_CONNECTION` - set to `true` to configure Chrome's network settings to simulate a slow connection.
-* `QA_SLOW_CONNECTION_LATENCY_MS` - the additional latency (in ms) of the simulated slow connection (default 2000 ms).
-* `QA_SLOW_CONNECTION_THROUGHPUT_KBPS` - the maximum throughput (in kbps) of the simulated slow connection (default 32 kbps).
-* `QA_SKIP_PULL` - set to `true` to skip pulling docker images (e.g., to use one you built locally).
-* `GITHUB_USERNAME` - Username for authenticating with GitHub.
-* `GITHUB_PASSWORD` - Password for authenticating with GitHub.
-* `GITLAB_QA_LOOP_RUNNER_MINUTES` - Minutes to run and repeat a spec while using the '--loop' option; default value is 1 minute.
-* `CI_SERVER_PERSONAL_ACCESS_TOKEN` - Personal access token of the server that is running the CI pipeline. This is used for pulling CI_RUNNER information in certain tests.
-* `GEO_MAX_FILE_REPLICATION_TIME` - maximum time that a test will wait for a replicated file to appear on a Geo secondary node (default 120 seconds)
-* `GEO_MAX_DB_REPLICATION_TIME` - maximum time that a test will wait for database data to appear on a Geo secondary node (default 120 seconds)
-* `JIRA_ADMIN_USERNAME` - Username for authenticating with Jira server as admin.
-* `JIRA_ADMIN_PASSWORD` - Password for authenticating with Jira server as admin.
+|        Variable       | Default   | Description           | Required |
+|-----------------------|-----------|-----------------------|----------|
+| `GITLAB_USERNAME`       | `root`  | Username to use when signing into GitLab. | Yes|
+| `GITLAB_PASSWORD`       | `5iveL!fe` | Password to use when signing into GitLab. | Yes|
+| `GITLAB_FORKER_USERNAME`|-  | Username to use for forking a project. | Yes|
+| `GITLAB_FORKER_PASSWORD`|-  | Password to use for forking a project. | Yes|
+| `GITLAB_QA_USERNAME_1`  |-  | Username available in environments where signup is disabled. | No|
+| `GITLAB_QA_PASSWORD_1`  |-  | Password for `GITLAB_QA_USERNAME_1` available in environments where signup is disabled (e.g. staging.gitlab.com). | No|
+| `GITLAB_QA_USERNAME_2`  |-  | Another username available in environments where signup is disabled. | No|
+| `GITLAB_QA_PASSWORD_2`  |-  | Password for `GITLAB_QA_USERNAME_2` available in environments where signup is disabled (e.g. staging.gitlab.com). | No|
+| `GITLAB_QA_USERNAME_3`  |-  | Another username available in environments where signup is disabled. | No|
+| `GITLAB_QA_PASSWORD_3`  |-  | Password for `GITLAB_QA_USERNAME_3` available in environments where signup is disabled (e.g. staging.gitlab.com). | No|
+| `GITLAB_QA_USERNAME_4`  |-  | Another username available in environments where signup is disabled. | No|
+| `GITLAB_QA_PASSWORD_4`  |-  | Password for `GITLAB_QA_USERNAME_4` available in environments where signup is disabled (e.g. staging.gitlab.com). | No|
+| `GITLAB_QA_USERNAME_5`  |-  | Another username available in environments where signup is disabled. | No|
+| `GITLAB_QA_PASSWORD_5`  |-  | Password for `GITLAB_QA_USERNAME_5` available in environments where signup is disabled (e.g. staging.gitlab.com). | No|
+| `GITLAB_QA_USERNAME_6`  |-  | Another username available in environments where signup is disabled. | No|
+| `GITLAB_QA_PASSWORD_6`  |-  | Password for `GITLAB_QA_USERNAME_6` available in environments where signup is disabled (e.g. staging.gitlab.com). | No|
+| `GITLAB_LDAP_USERNAME`  |-  | LDAP username to use when signing into GitLab. | No|
+| `GITLAB_LDAP_PASSWORD`  |-  | LDAP password to use when signing into GitLab. | No|
+| `GITLAB_ADMIN_USERNAME` |-  | Admin username to use when adding a license. | No|
+| `GITLAB_ADMIN_PASSWORD` |-  | Admin password to use when adding a license. | No|
+| `GITLAB_SANDBOX_NAME`   | `gitlab-qa-sandbox` | The sandbox group name the test suite is going to use. | No|
+| `GITLAB_QA_ACCESS_TOKEN`|-  | A valid personal access token with the `api` scope. This is used for API access during tests, and is used in the version that staging is currently running. An existing token that is valid on [`Test::Instance::Staging`](#testinstancestaging) scenario to retrieve the staging can be found in the shared 1Password vault. |No|
+| `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|
+| `EE_LICESEN` |-  | Enterprise Edition license. | 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|
+| `CHROME_HEADLESS` |-  | When running locally, set to `false` to allow Chrome tests to be visible - watch your tests being run. | No|
+| `QA_ADDITIONAL_REPOSITORY_STORAGE` |-  | The name of additional, non-default storage to be used with tests tagged `repository_storage`, run via the `Test::Instance::RepositoryStorage` scenario. | No|
+| `QA_PRAEFECT_REPOSITORY_STORAGE` |-  | The name of repository storage using Praefect. | No|
+| `QA_COOKIES` |-  | Optionally set to "cookie1=value;cookie2=value" in order to add a cookie to every request. This can be used to set the canary cookie by setting it to "gitlab_canary=true". | No|
+| `QA_DEBUG` |-  | Set to `true` to verbosely log page object actions. Note: if enabled be aware that sensitive data might be logged. If an input element has a QA selector with `password` in the name, data entered into the input element will be masked. If the element doesn't have `password` in its name it won't be masked. | No|
+| `QA_LOG_PATH` |-  | Path to output debug logging to. If not set logging will be output to STDOUT. | No|
+| `QA_CAN_TEST_GIT_PROTOCOL_V2` |-  | Set to `false` to skip tests that require Git protocol v2 if your environment doesn't support it. | No|
+| `QA_CAN_TEST_ADMIN_FEATURES` |-  | Set to `false` to skip tests that require admin access. | No|
+| `QA_CAN_TEST_PRAEFECT` |-  | Set to `false` to skip tests that require Praefect to be running. | No|
+| `QA_DISABLE_RSPEC_RETRY` |-  | Set to `true` to turn off retrying tests on failure. | No|
+| `QA_SIMULATE_SLOW_CONNECTION` |-  | Set to `true` to configure Chrome's network settings to simulate a slow connection. | No|
+| `QA_SLOW_CONNECTION_LATENCY_MS` | `2000` | The additional latency (in ms) of the simulated slow connection. | No|
+| `QA_SLOW_CONNECTION_THROUGHPUT_KBPS` | `32` | The maximum throughput (in kbps) of the simulated slow connection. | No|
+| `QA_SKIP_PULL` | `false` | Set to `true` to skip pulling docker images (e.g., to use one you built locally). | No|
+| `GITHUB_USERNAME` |-  | Username for authenticating with GitHub. | No|
+| `GITHUB_PASSWORD` |-  | Password for authenticating with GitHub. | No|
+| `GITLAB_QA_LOOP_RUNNER_MINUTES` | `1` | Minutes to run and repeat a spec while using the '--loop' option; default value is 1 minute. | No|
+| `CI_SERVER_PERSONAL_ACCESS_TOKEN` |-  | Personal access token of the server that is running the CI pipeline. This is used for pulling CI_RUNNER information in certain tests. | No|
+| `GEO_MAX_FILE_REPLICATION_TIME` | `120` | Maximum time that a test will wait for a replicated file to appear on a Geo secondary node. | No|
+| `GEO_MAX_DB_REPLICATION_TIME` | `120` | Maximum time that a test will wait for database data to appear on a Geo secondary node. | No|
+| `JIRA_ADMIN_USERNAME` |-  | Username for authenticating with Jira server as admin. | No|
+| `JIRA_ADMIN_PASSWORD` |-  | Password for authenticating with Jira server as admin. | No|
 
 ## [Supported Remote Grid environment variables](./running_against_remote_grid.md)
 

data/lib/gitlab/qa.rb

@@ -6,6 +6,7 @@ module Gitlab
 
     module Runtime
       autoload :Env, 'gitlab/qa/runtime/env'
+      autoload :Scenario, 'gitlab/qa/runtime/scenario'
       autoload :TokenFinder, 'gitlab/qa/runtime/token_finder'
     end
 
@@ -63,6 +64,7 @@ module Gitlab
     end
 
     module Component
+      autoload :Base, 'gitlab/qa/component/base'
       autoload :Gitlab, 'gitlab/qa/component/gitlab'
       autoload :InternetTunnel, 'gitlab/qa/component/internet_tunnel'
       autoload :LDAP, 'gitlab/qa/component/ldap'

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

@@ -0,0 +1,131 @@
+module Gitlab
+  module QA
+    module Component
+      class Base
+        include Scenario::Actable
+
+        attr_reader :docker
+        attr_accessor :volumes, :network, :environment
+        attr_writer :name, :exec_commands
+
+        def initialize
+          @docker = Docker::Engine.new
+          @environment = {}
+          @volumes = {}
+          @network_aliases = []
+
+          self.exec_commands = []
+        end
+
+        def add_network_alias(name)
+          @network_aliases.push(name)
+        end
+
+        def name
+          raise NotImplementedError, "#{self.class.name} must specify a default name"
+        end
+
+        def hostname
+          "#{name}.#{network}"
+        end
+
+        def image
+          return self.class.const_get('DOCKER_IMAGE') if self.class.const_defined?('DOCKER_IMAGE')
+
+          raise NotImplementedError, "#{self.class.name} must specify a docker image as DOCKER_IMAGE"
+        end
+
+        def tag
+          return self.class.const_get('DOCKER_IMAGE_TAG') if self.class.const_defined?('DOCKER_IMAGE_TAG')
+
+          raise NotImplementedError, "#{self.class.name} must specify a docker image tag as DOCKER_IMAGE_TAG"
+        end
+
+        def instance
+          prepare
+          start
+          reconfigure
+          wait_until_ready
+          process_exec_commands
+
+          yield self if block_given?
+        ensure
+          teardown
+        end
+
+        alias_method :launch_and_teardown_instance, :instance
+
+        def prepare
+          prepare_docker_image
+          prepare_network
+        end
+
+        def prepare_docker_image
+          return if Runtime::Env.skip_pull?
+
+          pull
+        end
+
+        def prepare_network
+          return if docker.network_exists?(network)
+
+          docker.network_create(network)
+        end
+
+        def start # rubocop:disable Metrics/AbcSize
+          docker.run(image, tag) do |command|
+            command << "-d"
+            command << "--name #{name}"
+            command << "--net #{network}"
+            command << "--hostname #{hostname}"
+
+            @volumes.to_h.each do |to, from|
+              command.volume(to, from, 'Z')
+            end
+
+            command.volume(File.join(Runtime::Env.host_artifacts_dir, name, 'logs'), '/var/log/gitlab', 'Z')
+
+            @environment.to_h.each do |key, value|
+              command.env(key, value)
+            end
+
+            @network_aliases.to_a.each do |network_alias|
+              command << "--network-alias #{network_alias}"
+            end
+          end
+        end
+
+        def restart
+          assert_name!
+
+          docker.restart(name)
+        end
+
+        def teardown
+          assert_name!
+
+          return unless docker.running?(name)
+
+          docker.stop(name)
+          docker.remove(name)
+        end
+
+        def pull
+          docker.pull(image, tag)
+        end
+
+        def process_exec_commands
+          exec_commands.each { |command| docker.exec(name, command) }
+        end
+
+        private
+
+        attr_reader :exec_commands, :wait_until_ready, :reconfigure
+
+        def assert_name!
+          raise 'Invalid instance name!' unless name
+        end
+      end
+    end
+  end
+end

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

@@ -1,41 +1,19 @@
 module Gitlab
   module QA
     module Component
-      class Elasticsearch
-        include Scenario::Actable
-
-        ELASTIC_IMAGE = 'docker.elastic.co/elasticsearch/elasticsearch'.freeze
-
-        attr_reader :docker
-        attr_accessor :environment, :network
-        attr_writer :name
-
-        def initialize
-          @docker = Docker::Engine.new
-          @environment = {}
-        end
+      class Elasticsearch < Base
+        DOCKER_IMAGE = 'docker.elastic.co/elasticsearch/elasticsearch'.freeze
 
         def name
           @name ||= "elastic68"
         end
 
-        def instance
-          prepare
-          start
-          yield self
-        ensure
-          teardown
-        end
-
-        def prepare
-          @docker.pull(ELASTIC_IMAGE, Runtime::Env.elastic_version)
-          return if @docker.network_exists?(network)
-
-          @docker.network_create(network)
+        def tag
+          Runtime::Env.elastic_version
         end
 
         def start
-          @docker.run(ELASTIC_IMAGE, Runtime::Env.elastic_version) do |command|
+          @docker.run(image, tag) do |command|
             command << "-d"
             command << "--name #{name}"
             command << "--net #{network}"
@@ -45,11 +23,6 @@ module Gitlab
             command.env("discovery.type", "single-node")
           end
         end
-
-        def teardown
-          @docker.stop(name)
-          @docker.remove(name)
-        end
       end
     end
   end

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

@@ -7,13 +7,12 @@ require 'openssl'
 module Gitlab
   module QA
     module Component
-      class Gitlab
+      class Gitlab < Base
         extend Forwardable
-        include Scenario::Actable
 
-        attr_reader :release, :docker
-        attr_accessor :volumes, :network, :environment, :tls, :disable_animations
-        attr_writer :name, :relative_path, :exec_commands, :skip_check
+        attr_reader :release
+        attr_accessor :tls, :disable_animations, :skip_availability_check
+        attr_writer :name, :relative_path
 
         def_delegators :release, :tag, :image, :edition
 
@@ -21,17 +20,14 @@ module Gitlab
         SSL_PATH = '/etc/gitlab/ssl'.freeze
 
         def initialize
-          @docker = Docker::Engine.new
-          @environment = {}
-          @volumes = {}
-          @network_aliases = []
+          super
+
           @disable_animations = true
-          @skip_check = false
+          @skip_availability_check = false
 
           @volumes[CERTIFICATES_PATH] = SSL_PATH
 
           self.release = 'CE'
-          self.exec_commands = []
         end
 
         def omnibus_config=(config)
@@ -48,10 +44,6 @@ module Gitlab
           @environment['ELASTIC_URL'] = url
         end
 
-        def add_network_alias(name)
-          @network_aliases.push(name)
-        end
-
         def release=(release)
           @release = QA::Release.new(release)
         end
@@ -72,10 +64,6 @@ module Gitlab
           tls ? '443' : '80'
         end
 
-        def hostname
-          "#{name}.#{network}"
-        end
-
         def relative_path
           @relative_path ||= ''
         end
@@ -84,24 +72,16 @@ module Gitlab
           Runtime::Env.accept_insecure_certs = 'true'
         end
 
-        def instance
-          prepare
-          start
-          reconfigure
-          wait unless @skip_check
-          process_exec_commands
+        def prepare
+          prepare_gitlab_omnibus_config
 
-          yield self if block_given?
-        ensure
-          teardown
+          super
         end
 
-        alias_method :launch_and_teardown_instance, :instance
+        def pull
+          docker.login(**release.login_params) if release.login_params
 
-        def prepare
-          prepare_gitlab_omnibus_config
-          prepare_docker_image
-          prepare_network
+          super
         end
 
         def prepare_gitlab_omnibus_config
@@ -109,18 +89,6 @@ module Gitlab
           set_formless_login_token
         end
 
-        def prepare_docker_image
-          return if Runtime::Env.skip_pull?
-
-          @docker.pull(image, tag)
-        end
-
-        def prepare_network
-          return if @docker.network_exists?(network)
-
-          @docker.network_create(network)
-        end
-
         def setup_disable_animations
           @environment['GITLAB_OMNIBUS_CONFIG'] = "gitlab_rails['gitlab_disable_animations'] = true; #{@environment['GITLAB_OMNIBUS_CONFIG'] || ''}"
         end
@@ -128,17 +96,6 @@ module Gitlab
         def start # rubocop:disable Metrics/AbcSize
           ensure_configured!
 
-          if release.dev_gitlab_org?
-            Docker::Command.execute(
-              [
-                'login',
-                '--username gitlab-qa-bot',
-                %(--password "#{Runtime::Env.dev_access_token_variable}"),
-                Release::DEV_REGISTRY
-              ]
-            )
-          end
-
           docker.run(image, tag) do |command|
             command << "-d -p #{port}"
             command << "--name #{name}"
@@ -170,18 +127,9 @@ module Gitlab
           end
         end
 
-        def restart
-          @docker.restart(name)
-        end
-
-        def teardown
-          raise 'Invalid instance name!' unless name
-
-          @docker.stop(name)
-          @docker.remove(name)
-        end
-
         def wait
+          return if skip_availability_check
+
           if Availability.new(name, relative_path: relative_path, scheme: scheme, protocol_port: port.to_i).check(180)
             sleep 12 # TODO, handle that better
             puts ' -> GitLab is available.'
@@ -190,10 +138,6 @@ module Gitlab
           end
         end
 
-        def pull
-          @docker.pull(@release.image, @release.tag)
-        end
-
         def sha_version
           json = @docker.read_file(
             @release.image, @release.tag,
@@ -204,14 +148,8 @@ module Gitlab
           manifest['software']['gitlab-rails']['locked_version']
         end
 
-        def process_exec_commands
-          exec_commands.each { |command| @docker.exec(name, command) }
-        end
-
         private
 
-        attr_reader :exec_commands
-
         def ensure_configured!
           raise 'Please configure an instance first!' unless [name, release, network].all?
         end