gitlab-qa 5.14.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80b5afa85b80b6c367a00f9e0077782d761bf5ad69d851aa95e5ea4f7ec4af78
-  data.tar.gz: b6940307fb5981a4f7c4468be522916ae4a01f2e65ddb0a5847037ce7099556f
+  metadata.gz: 87249baf75070cf8c5362c34b9995f6163370e9b6e353a393104beefe62d4bd8
+  data.tar.gz: 6e00eee6993c9f5c6aeb4cb187c708941bfd27cb9b59340165b23b02c30f583a
 SHA512:
-  metadata.gz: 95347f6df44ef53110ac29177e3373fecba8d0ea2535f5a642233519c87d4c97edef9120d6a48e22b05739a00e4b01eccd090743894f1f0db52ba6a1ee4e0995
-  data.tar.gz: a688557eb3fb7738f7288dfbd18bf804fbfdbf668ffd1e17f155f1df3fce5b38b5618af10460355f516e26091e93f290651f364ac5f09531827c6a06b4b0fee5
+  metadata.gz: 6d621d51ca18fa402e397b13c86dda6d52039a11ca259c6a46f3e9caffeab0faa68b6b9ff58ec4f727b2dae82c386442655122571936a47c366647b3ad895a50
+  data.tar.gz: 73bbcc44b560368e64d8bd335b3fac6d52128e8c05f6ddf582ea6139032f570d80563b6fbc9c96f41598fee2c2c345ec9155f5990f3ea4df1bde2167bede9a27

data/.gitlab-ci.yml

@@ -94,7 +94,7 @@ release:
     - exe/gitlab-qa ${QA_SCENARIO:=Test::Instance::Image} ${RELEASE:=$DEFAULT_RELEASE} -- $QA_TESTS $QA_RSPEC_TAGS $RSPEC_REPORT_OPTS || test_run_exit_code=$?
     - exe/gitlab-qa-report --update-screenshot-path "gitlab-qa-run-*/**/rspec-*.xml"
     - export GITLAB_QA_ACCESS_TOKEN="$GITLAB_QA_PRODUCTION_ACCESS_TOKEN"
-    - if [ "$TOP_UPSTREAM_SOURCE_REF" == "master" ]; then exe/gitlab-qa-report --report-in-issues "gitlab-qa-run-*/**/rspec-*.xml" --project "$QA_TESTCASES_REPORTING_PROJECT"; fi
+    - if [ "$TOP_UPSTREAM_SOURCE_REF" == "master" ]; then exe/gitlab-qa-report --report-in-issues "gitlab-qa-run-*/**/rspec-*.xml" --project "$QA_TESTCASES_REPORTING_PROJECT" || true; fi
     - exit $test_run_exit_code
 
 .ce-qa:
@@ -832,6 +832,44 @@ ee:praefect-quarantine:
     QA_CAN_TEST_PRAEFECT: "true"
     QA_RSPEC_TAGS: "--tag quarantine --tag ~orchestrated"
 
+ce:gitaly-cluster:
+  extends:
+    - .test
+    - .high-capacity
+    - .ce-qa
+    - .rspec-report-opts
+  variables:
+    QA_SCENARIO: "Test::Integration::GitalyCluster"
+
+ce:gitaly-cluster-quarantine:
+  extends:
+    - .test
+    - .high-capacity
+    - .ce-qa
+    - .quarantine
+    - .rspec-report-opts
+  variables:
+    QA_SCENARIO: "Test::Integration::GitalyCluster"
+
+ee:gitaly-cluster:
+  extends:
+    - .test
+    - .high-capacity
+    - .ee-qa
+    - .rspec-report-opts
+  variables:
+    QA_SCENARIO: "Test::Integration::GitalyCluster"
+
+ee:gitaly-cluster-quarantine:
+  extends:
+    - .test
+    - .high-capacity
+    - .ee-qa
+    - .quarantine
+    - .rspec-report-opts
+  variables:
+    QA_SCENARIO: "Test::Integration::GitalyCluster"
+
 ce:smtp:
   extends:
     - .test
@@ -893,7 +931,8 @@ ee:jira-quarantine:
 staging:
   script:
     - unset EE_LICENSE
-    - exe/gitlab-qa Test::Instance::Staging
+    - 'echo "Running: exe/gitlab-qa Test::Instance::Staging ${RELEASE:=$DEFAULT_RELEASE} -- $QA_TESTS $QA_RSPEC_TAGS"'
+    - exe/gitlab-qa Test::Instance::Staging ${RELEASE:=$DEFAULT_RELEASE} -- $QA_TESTS $QA_RSPEC_TAGS
   extends:
     - .test
     - .high-capacity

data/README.md

@@ -121,11 +121,58 @@ All the scenarios you can run are described in the
 
 Note: The GitLab QA tool requires that [Docker](https://docs.docker.com/install/) is installed.
 
-### How to add new scenarios
-
-Scenarios (test cases) and scripts to run them are located in the
-[CE](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/qa) and
-[EE](https://gitlab.com/gitlab-org/gitlab-ee/tree/master/qa)
+### Command-line options
+
+In addition to the [arguments you can use to specify the scenario and
+tests to run](/docs/what_tests_can_be_run.md), you can use the
+following options to control the tool's behavior.
+
+**Note:** These are `gitlab-qa` options so if you specify RSpec
+options as well, including test file paths, be sure to add these
+options before the `--` that indicates that subsequent arguments are
+intended for RSpec.
+
+| Option | Description |
+| ------ | ----------- |
+| `--no-teardown` | Skip teardown of containers after the scenario completes |
+| `--no-tests` | Orchestrates the docker containers but does not run the tests. Implies `--no-teardown` |
+
+For example, the following command would start an EE GitLab Docker
+container and would leave the instance running, but would not run the
+tests:
+
+```plaintext
+$ gitlab-qa Test::Instance::Image EE --no-tests
+```
+
+GitLab QA will have automatically run the `docker ps` command to show
+the port that container is running on, for example:
+
+```plaintext
+...
+Skipping tests.
+The orchestrated docker containers have not been removed.
+Docker shell command: `docker ps`
+CONTAINER ID  IMAGE                     ... PORTS
+fdeffd791b69  gitlab/gitlab-ee:nightly      22/tcp, 443/tcp, 0.0.0.0:32768->80/tcp
+```
+
+You could then run tests against that instance in a similar way to
+[running tests against GDK](/docs/run_qa_against_gdk.md). This can be
+useful if you want to run and debug a specific test, for example:
+
+```plaintext
+# From /path/to/gdk/gitlab/qa
+$ bundle exec bin/qa Test::Instance::All http://localhost:32768 -- qa/specs/features/browser_ui/3_create/merge_request/create_merge_request_spec.rb
+```
+
+### How to add new tests
+
+Please see the [Beginner's guide to writing end-to-end tests](https://docs.gitlab.com/ee/development/testing_guide/end_to_end/beginners_guide.html).
+
+Test cases and scripts to run them are located in the
+[GitLab FOSS](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/qa) and
+[GitLab](https://gitlab.com/gitlab-org/gitlab/tree/master/qa)
 repositories under the `qa/` directory, so please also check the documentation
 there.
 

data/docs/what_tests_can_be_run.md

@@ -1,5 +1,6 @@
-# What tests can be run?
 
+# What tests can be run?
+[[_TOC_]]
 ## The two types of QA tests
 
 First of all, the first thing to choose is whether you want to run orchestrated
@@ -28,6 +29,8 @@ For more details on the internals, please read the
 
 ## Supported GitLab environment variables
 
+All environment variables used by GitLab QA should be defined in [`lib/gitlab/qa/runtime/env.rb`](https://gitlab.com/gitlab-org/gitlab-qa/-/blob/master/lib/gitlab/qa/runtime/env.rb).
+
 |        Variable       | Default   | Description           | Required |
 |-----------------------|-----------|-----------------------|----------|
 | `GITLAB_USERNAME`       | `root`  | Username to use when signing into GitLab. | Yes|
@@ -53,7 +56,8 @@ For more details on the internals, please read the
 | `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|
+| `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_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|
@@ -83,8 +87,27 @@ For more details on the internals, please read the
 
 ## Running tests with a feature flag enabled
 
-It is possible to enable a feature flag before running tests. See the [QA
-framework documentation](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/qa/README.md#running-tests-with-a-feature-flag-enabled) for details.
+It is possible to enable or disable a feature flag before running tests.
+To test a Gitlab image with a feature flag enabled, run this command:
+```
+$ gitlab-qa Test::Instance::Image gitlab/gitlab-ee:12.4.0-ee.0 --enable-feature feature_flag_name
+```
+
+To run a test with feature flag disabled, run this command:
+```
+$ gitlab-qa Test::Instance::Image gitlab/gitlab-ee:12.4.0-ee.0 --disable-feature feature_flag_name
+```
+
+You an also test a GitLab image multiple times with different feature flag settings:
+```
+$ gitlab-qa Test::Instance::Image gitlab/gitlab-ee:12.4.0-ee.0 --disable-feature feature_flag_name --enable-feature feature_flag_name
+```
+This will first disable `feature_flag_name` flag and run the tests and then enable it and run the tests again.
+
+You can pass any number of feature flag settings. The tests will run once for each setting.
+
+See the [QA framework documentation](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/qa/README.md#running-tests-with-a-feature-flag-enabled)
+for information on running the tests with different feature flag settings from the QA framework.
 
 ## Specifying the GitLab version
 
@@ -217,6 +240,25 @@ $ gitlab-qa Test::Integration::Geo EE
 
 [test-geo]: https://gitlab.com/gitlab-org/gitlab-ee/blob/master/qa/qa/ee/scenario/test/geo.rb
 
+### `Test::Integration::GitalyCluster CE|EE|<full image address>`
+
+This tests [Gitaly Cluster](https://docs.gitlab.com/ee/administration/gitaly/praefect.html),
+a clustered configuration of the Gitaly repository storage service.
+
+The scenario configures and starts several docker containers to
+represent the [recommended minimum configuration](https://docs.gitlab.com/ee/administration/gitaly/praefect.html#requirements-for-configuring-a-gitaly-cluster)
+of a Gitaly Cluster.
+
+To run tests against the GitLab container, a GitLab QA (`gitlab/gitlab-qa`)
+container is spun up and tests are run from it by running the
+`Test::Instance::All` scenario with the `:gitaly_cluster` tag.
+
+Example:
+
+```
+$ gitlab-qa Test::Integration::GitalyCluster EE
+```
+
 ### `Test::Integration::LDAPNoTLS CE|EE|<full image address>`
 
 This tests that a GitLab instance works as expected with an external
@@ -545,7 +587,7 @@ in the GitLab CE project).
 
 - `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 from the Omnibus GitLab `dev` Container Registry.
+  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.
 
@@ -560,6 +602,41 @@ $ export GITLAB_PASSWORD="$GITLAB_QA_PASSWORD"
 $ gitlab-qa Test::Instance::Staging
 ```
 
+### `Test::Instance::StagingGeo`
+
+This scenario tests that the Geo staging deployment (with [`staging.gitlab.com`](https://staging.gitlab.com) as the primary site and [`geo.staging.gitlab.com`](https://geo.staging.gitlab.com) as the secondary site) works as expected by running tests tagged `:geo` against it. This is done by spinning up a GitLab QA (`gitlab/gitlab-qa`) container and running the `QA::EE::Scenario::Test::Geo` scenario. Note that the Geo setup steps in the `QA::EE::Scenario::Test::Geo` scenario are skipped when testing a live Geo deployment.
+
+**Required user properties:**
+
+- The user must provide OAuth authorization on the secondary site before running Geo tests. This can be done via the authorization modal that appears after logging into the secondary node for the first time.
+
+- Some Geo tests require the user to have Admin access level (for example, the Geo Nodes API tests)
+
+**Required environment variables:**
+
+- `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.
+
+**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.
+
+Example:
+
+```
+$ export GITLAB_QA_ACCESS_TOKEN=your_api_access_token
+$ export GITLAB_QA_DEV_ACCESS_TOKEN=your_dev_registry_access_token
+$ export GITLAB_USERNAME="gitlab-qa"
+$ export GITLAB_PASSWORD="$GITLAB_QA_PASSWORD"
+
+$ gitlab-qa Test::Instance::StagingGeo
+```
+
 ### `Test::Instance::Production`
 
 This scenario functions the same as `Test::Instance::Staging`
@@ -633,6 +710,25 @@ $ export EE_LICENSE=$(cat /path/to/gitlab_license)
 $ gitlab-qa Test::Instance::Airgapped EE -- --tag smoke
 ```
 
+### `Test::Instance::Geo EE|<full image address>:nightly|latest|any_tag http://geo-primary.gitlab http://geo-secondary.gitlab`
+
+This scenario will run tests tagged `:geo` against a live Geo deployment, by spinning up a GitLab QA (`gitlab/gitlab-qa`)
+container and running the `QA::EE::Scenario::Test::Geo` scenario. Note that the Geo setup steps in the `QA::EE::Scenario::Test::Geo` scenario are skipped when testing a live Geo deployment. The URLs for the primary site and secondary site of the live Geo deployment must be provided as command line arguments.
+
+**Required user properties:**
+
+- The user must provide OAuth authorization on the secondary site before running Geo tests. This can be done via the authorization modal that appears after signing into the secondary node for the first time.
+
+- Some Geo tests require the user to have Admin access level (for example, the Geo Nodes API tests)
+
+Example:
+
+```
+$ export GITLAB_USERNAME="gitlab-qa"
+$ export GITLAB_PASSWORD="$GITLAB_QA_PASSWORD"
+
+$ gitlab-qa Test::Instance::Geo EE https://primary.gitlab.com https://secondary.gitlab.com
+```
 ----
 
 [Back to README.md](../README.md)

data/lib/gitlab/qa.rb

@@ -54,7 +54,7 @@ module Gitlab
           autoload :Praefect, 'gitlab/qa/scenario/test/integration/praefect'
           autoload :Elasticsearch, 'gitlab/qa/scenario/test/integration/elasticsearch'
           autoload :SMTP, 'gitlab/qa/scenario/test/integration/smtp'
-          autoload :GitalyHA, 'gitlab/qa/scenario/test/integration/gitaly_ha'
+          autoload :GitalyCluster, 'gitlab/qa/scenario/test/integration/gitaly_cluster'
           autoload :Jira, 'gitlab/qa/scenario/test/integration/jira'
         end
 
@@ -97,9 +97,12 @@ module Gitlab
     end
 
     module Report
+      autoload :JsonTestResults, 'gitlab/qa/report/json_test_results'
+      autoload :JUnitTestResults, 'gitlab/qa/report/junit_test_results'
       autoload :PrepareStageReports, 'gitlab/qa/report/prepare_stage_reports'
       autoload :ResultsInIssues, 'gitlab/qa/report/results_in_issues'
       autoload :SummaryTable, 'gitlab/qa/report/summary_table'
+      autoload :TestResult, 'gitlab/qa/report/test_result'
       autoload :UpdateScreenshotPath, 'gitlab/qa/report/update_screenshot_path'
     end
 

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

@@ -41,16 +41,12 @@ module Gitlab
           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?
+        def instance(skip_teardown: false)
+          instance_no_teardown do
+            yield self if block_given?
+          end
         ensure
-          teardown
+          teardown unless skip_teardown
         end
 
         alias_method :launch_and_teardown_instance, :instance
@@ -61,8 +57,6 @@ module Gitlab
         end
 
         def prepare_docker_image
-          return if Runtime::Env.skip_pull?
-
           pull
         end
 
@@ -106,6 +100,17 @@ module Gitlab
         end
 
         def teardown
+          unless teardown?
+            puts "The orchestrated docker containers have not been removed."
+            docker.ps
+
+            return
+          end
+
+          teardown!
+        end
+
+        def teardown!
           assert_name!
 
           return unless docker.running?(name)
@@ -115,6 +120,8 @@ module Gitlab
         end
 
         def pull
+          return if Runtime::Env.skip_pull?
+
           docker.pull(image, tag)
         end
 
@@ -129,6 +136,20 @@ module Gitlab
         def assert_name!
           raise 'Invalid instance name!' unless name
         end
+
+        def instance_no_teardown
+          prepare
+          start
+          reconfigure
+          wait_until_ready
+          process_exec_commands
+
+          yield self if block_given?
+        end
+
+        def teardown?
+          !Runtime::Scenario.attributes.include?(:teardown) || Runtime::Scenario.teardown
+        end
       end
     end
   end

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

@@ -17,6 +17,8 @@ module Gitlab
         end
 
         def perform # rubocop:disable Metrics/AbcSize
+          return puts "Skipping tests." if skip_tests?
+
           raise ArgumentError unless [suite, release].all?
 
           @docker.login(**release.login_params) if release.login_params
@@ -25,23 +27,53 @@ module Gitlab
 
           name = "#{release.project_name}-qa-#{SecureRandom.hex(4)}"
 
-          @docker.run(release.qa_image, release.qa_tag, suite, *args) do |command|
-            command << "-t --rm --net=#{network || 'bridge'}"
+          feature_flag_sets = []
 
-            env.merge(Runtime::Env.variables).each do |key, value|
-              command.env(key, value)
-            end
+          # When `args` includes `[..., "--disable-feature", "a", "--enable-feature", "b", ...]`
+          # `feature_flag_sets` will be set to `[["--disable-feature", "a"], ["--enable-feature", "b"]]`
+          # This will result in tests running twice, once with each feature.
+          while (index = args&.index { |x| x =~ /--.*-feature/ })
+            feature_flag_sets << args.slice!(index, 2)
+          end
 
-            command.volume('/var/run/docker.sock', '/var/run/docker.sock')
-            command.volume(File.join(Runtime::Env.host_artifacts_dir, name), File.join(Docker::Volumes::QA_CONTAINER_WORKDIR, 'tmp'))
+          # When `args` do not have either "--disable-feature" or "--enable-feature", we
+          # add [] so that test is run exactly once.
+          feature_flag_sets << [] unless feature_flag_sets.any?
 
-            @volumes.to_h.each do |to, from|
-              command.volume(to, from)
-            end
+          feature_flag_sets.each do |feature_flag_set|
+            @docker.run(release.qa_image, release.qa_tag, suite, *args_with_flags(args, feature_flag_set)) do |command|
+              command << "-t --rm --net=#{network || 'bridge'}"
 
-            command.name(name)
+              env.merge(Runtime::Env.variables).each do |key, value|
+                command.env(key, value)
+              end
+
+              command.volume('/var/run/docker.sock', '/var/run/docker.sock')
+              command.volume(File.join(Runtime::Env.host_artifacts_dir, name), File.join(Docker::Volumes::QA_CONTAINER_WORKDIR, 'tmp'))
+
+              @volumes.to_h.each do |to, from|
+                command.volume(to, from)
+              end
+
+              command.name(name)
+            end
           end
         end
+
+        private
+
+        def args_with_flags(args, feature_flag_set)
+          return args if feature_flag_set.empty?
+
+          puts "Running with feature flag: #{feature_flag_set.join(' ')}"
+
+          args_with_f = args.dup
+          args_with_f.insert(1, *feature_flag_set)
+        end
+
+        def skip_tests?
+          Runtime::Scenario.attributes.include?(:run_tests) && !Runtime::Scenario.run_tests
+        end
       end
     end
   end