gitlab-qa 7.12.0 → 7.13.3

data/docs/running_against_remote_grid.md

@@ -8,20 +8,49 @@ I.e, if you have a Selenium server set up at http://localhost:4444 or if you hav
 
 | Variable                  | Description                                                    | Default  | Example(s)                     |
 |---------------------------|----------------------------------------------------------------|----------|--------------------------------|
-| QA_BROWSER                | Browser to run against                                         | "chrome" | "chrome" "firefox"             |
+| QA_BROWSER                | Browser to run against                                         | "chrome" | "chrome" "firefox" "safari"    |
 | QA_REMOTE_GRID_PROTOCOL   | Protocol to use                                                | "http"   | "http" "https"                 |
 | QA_REMOTE_GRID            | Remote grid to run tests against                               |          | "localhost:3000" "provider:80" |
-| QA_REMOTE_GRID_USERNAME   | Username to specify in the remote grid. "USERNAME@provider:80" |          |                                |
+| QA_REMOTE_GRID_USERNAME   | Username to specify in the remote grid. "USERNAME@provider:80" |          | "gitlab-sl"                    |
 | QA_REMOTE_GRID_ACCESS_KEY | Key/Token paired with `QA_REMOTE_GRID_USERNAME`                |          |                                |
+| QA_REMOTE_TUNNEL_ID       | Name of the remote tunnel to use                               | "gitlab-sl_tunnel_id" |                                |
+| QA_REMOTE_MOBILE_DEVICE_NAME | Name of mobile device to test against. `QA_BROWSER` must be set to `safari` for iOS devices and `chrome` for Android devices.                                                |          | "iPhone 12 Simulator"          |
 
-## Examples
+## Testing with Sauce Labs
 
-*Run QA Smoke Tests against firefox on SauceLabs*
+Running directly against an environment like staging is not recommended because test logs expose credentials. Therefore, it is best practice and the default to use a tunnel.
 
-```bash
-$ QA_BROWSER=firefox \
-  QA_REMOTE_GRID=ondemand.saucelabs.com:80 \
-  QA_REMOTE_GRID_USERNAME=user \
-  QA_REMOTE_GRID_ACCESS_KEY=privatetoken \
-  gitlab-qa Test::Instance::All --tags smoke
+To install a tunnel, follow these [instructions](https://docs.saucelabs.com/secure-connections/sauce-connect/installation). 
+
+To start the tunnel, copy the run command in **Sauce Labs > Tunnels** and run it in the terminal. You must be logged in to Sauce Labs. Use the credentials in 1Password to log in.
+
+It is highly recommended to use `GITLAB_QA_ACCESS_TOKEN` to speed up tests and reduce flakiness.
+
+
+### Run a test in a desktop browser
+
+While tunnel is running, to test against a local instance in a desktop browser, run:
+```shell
+$ QA_BROWSER="safari" \
+  QA_REMOTE_GRID="ondemand.saucelabs.com:80" \
+  QA_REMOTE_GRID_USERNAME="gitlab-sl" \
+  QA_REMOTE_GRID_ACCESS_KEY="<access key found in Sauce Lab account>" \
+  GITLAB_QA_ACCESS_TOKEN="<token>" \
+  gitlab-qa Test::Instance::Any <CE|EE> http://<local_ip>:3000 -- -- <relative_spec_path>
 ```
+
+### Run a test in a mobile device browser
+
+`QA_REMOTE_MOBILE_DEVICE_NAME` can be any device name in the [supported browser devices](https://saucelabs.com/platform/supported-browsers-devices) in the Emulators/simulators list, and the latest versions of Android or iOS. You must set `QA_BROWSER` to `safari` for iOS devices and `chrome` for Android devices.```
+
+```shell
+$ QA_BROWSER="safari" \
+  QA_REMOTE_MOBILE_DEVICE_NAME="iPhone 12 Simulator" \
+  QA_REMOTE_GRID="ondemand.saucelabs.com:80" \
+  QA_REMOTE_GRID_USERNAME="gitlab-sl" \
+  QA_REMOTE_GRID_ACCESS_KEY="<found in Sauce Lab account>" \
+  GITLAB_QA_ACCESS_TOKEN="<token>" \
+  gitlab-qa Test::Instance::Any <CE|EE> http://<local_ip>:3000 -- -- <relative_spec_path>
+```
+
+Results can be watched in real time in Sauce Labs under AUTOMATED > Test Results

data/docs/what_tests_can_be_run.md

@@ -1,5 +1,7 @@
 # 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
@@ -245,8 +247,8 @@ instance-level tests against it.
 To run tests against the GitLab containers, a GitLab QA (`gitlab/gitlab-qa`)
 container is spun up and tests are run from it by running the `Test::Instance`
 scenario (located under
-[`gitlab-org/gitlab-ce@qa/qa/scenario/test/instance.rb`][test-instance] in the
-GitLab CE project).
+[`gitlab-org/gitlab/qa/qa/scenario/test/instance.rb`][test-instance] in the
+GitLab project).
 
 Example:
 
@@ -370,8 +372,8 @@ that LDAP-related features work as expected.
 To run tests against the GitLab containers, a GitLab QA (`gitlab/gitlab-qa`)
 container is spun up and tests are run from it by running the
 `Test::Integration::LDAPNoTLS` scenario (located under
-[`gitlab-org/gitlab-ce@qa/qa/scenario/test/integration/ldap_no_tls.rb`][test-integration-ldap-no-tls]
-in the GitLab CE project).
+[`gitlab-org/gitlab/qa/qa/scenario/test/integration/ldap_no_tls.rb`][test-integration-ldap-no-tls]
+in the GitLab project).
 
 In EE, both the GitLab standard and LDAP credentials are needed:
 
@@ -393,7 +395,7 @@ $ export EE_LICENSE=$(cat /path/to/Geo.gitlab_license)
 $ gitlab-qa Test::Integration::LDAPNoTLS EE
 ```
 
-[test-integration-ldap-no-tls]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/qa/qa/scenario/test/integration/ldap_no_tls.rb
+[test-integration-ldap-no-tls]: https://gitlab.com/gitlab-org/gitlab/blob/master/qa/qa/scenario/test/integration/ldap_no_tls.rb
 
 ### `Test::Integration::LDAPTLS CE|EE|<full image address>`
 
@@ -411,8 +413,8 @@ that LDAP-related features work as expected.
 To run tests against the GitLab containers, a GitLab QA (`gitlab/gitlab-qa`)
 container is spun up and tests are run from it by running the
 `Test::Integration::LDAPTLS` scenario (located under
-[`gitlab-org/gitlab-ce@qa/qa/scenario/test/integration/ldap_tls.rb`][test-integration-ldap-tls]
-in the GitLab CE project).
+[`gitlab-org/gitlab/qa/qa/scenario/test/integration/ldap_tls.rb`][test-integration-ldap-tls]
+in the GitLab project).
 
 In EE, both the GitLab standard and LDAP credentials are needed:
 
@@ -434,8 +436,8 @@ $ export EE_LICENSE=$(cat /path/to/Geo.gitlab_license)
 $ gitlab-qa Test::Integration::LDAPTLS EE
 ```
 
-[test-integration-ldap-tls]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/qa/qa/scenario/test/integration/ldap_tls.rb
-[test-integration-ldap-tls-certs]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/tls_certificates/gitlab
+[test-integration-ldap-tls]: https://gitlab.com/gitlab-org/gitlab/blob/master/qa/qa/scenario/test/integration/ldap_tls.rb
+[test-integration-ldap-tls-certs]: https://gitlab.com/gitlab-org/gitlab/blob/master/tls_certificates/gitlab
 
 ### `Test::Integration::LDAPNoServer EE|<full image address>`
 
@@ -504,9 +506,9 @@ using SAML.
 
 To run tests against the GitLab containers, a GitLab QA (`gitlab/gitlab-qa`)
 container is spun up and tests are run from it by running the
-`Test::Integration::InstanceSAML` scenario (located under [`gitlab-org/gitlab-ce@qa/qa/scenario/test/integration/instance_saml.rb`][test-integration-instance-saml] in the GitLab CE project).
+`Test::Integration::InstanceSAML` scenario (located under [`gitlab-org/gitlab-ce@qa/qa/scenario/test/integration/instance_saml.rb`][test-integration-instance-saml] in the GitLab project).
 
-[test-integration-instance-saml]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/qa/qa/scenario/test/integration/instance_saml.rb
+[test-integration-instance-saml]: https://gitlab.com/gitlab-org/gitlab/blob/master/qa/qa/scenario/test/integration/instance_saml.rb
 
 **Required environment variables:**
 
@@ -531,8 +533,8 @@ Mattermost server (see `Test::Instance::Image` above).
 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::Integration::Mattermost` scenario (located under
-[`gitlab-org/gitlab-ce@qa/qa/scenario/test/integration/mattermost.rb`][test-integration-mattermost]
-in the GitLab CE project).
+[`gitlab-org/gitlab/qa/qa/scenario/test/integration/mattermost.rb`][test-integration-mattermost]
+in the GitLab project).
 
 **Required environment variables:**
 
@@ -549,7 +551,7 @@ $ export EE_LICENSE=$(cat /path/to/Geo.gitlab_license)
 $ gitlab-qa Test::Integration::Mattermost EE
 ```
 
-[test-integration-mattermost]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/qa/qa/scenario/test/integration/mattermost.rb
+[test-integration-mattermost]: https://gitlab.com/gitlab-org/gitlab/blob/master/qa/qa/scenario/test/integration/mattermost.rb
 
 ### `Test::Integration::Packages CE|EE|<full image address>`
 
@@ -668,8 +670,8 @@ against it.
 To run tests against the GitLab instance, a GitLab QA (`gitlab/gitlab-qa`)
 container is spun up and tests are run from it by running the
 `Test::Instance` scenario (located under
-[`gitlab-org/gitlab-ce@qa/qa/scenario/test/instance.rb`][test-instance] in the
-in the GitLab CE project).
+[`gitlab-org/gitlab/qa/qa/scenario/test/instance.rb`][test-instance] in the
+in the GitLab project).
 
 Example:
 
@@ -695,8 +697,8 @@ works as expected by running tests against it.
 To run tests against the GitLab instance, a GitLab QA (`gitlab/gitlab-qa`)
 container is spun up and tests are run from it by running the
 `Test::Instance` scenario (located under
-[`gitlab-org/gitlab-ce@qa/qa/scenario/test/instance.rb`][test-instance] in the
-in the GitLab CE project).
+[`gitlab-org/gitlab/qa/qa/scenario/test/instance.rb`][test-instance] in the
+in the GitLab project).
 
 **Required environment variables:**
 
@@ -723,6 +725,42 @@ $ export GITLAB_PASSWORD="$GITLAB_QA_PASSWORD"
 $ gitlab-qa Test::Instance::Staging
 ```
 
+### `Test::Instance::StagingRef`
+
+This scenario tests that the [`Staging Ref`](https://staging-ref.gitlab.com)
+works as expected by running tests against it.
+
+To run tests against the GitLab instance, a GitLab QA (`gitlab/gitlab-qa`)
+container is spun up and tests are run from it by running the
+`Test::Instance` scenario (located under
+[`gitlab-org/gitlab/qa/qa/scenario/test/instance.rb`][test-instance] in the
+in the GitLab project).
+
+**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.
+  Staging Ref QA users credentials can be found in the shared GitLab QA 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 GitLab QA 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::StagingRef
+```
+
 ### `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.
@@ -789,8 +827,8 @@ Smoke tests are quick tests that ensure that some basic functionality of GitLab
 To run tests against the GitLab instance, a GitLab QA (`gitlab/gitlab-qa`)
 container is spun up and tests are run from it by running the
 `Test::Instance::Smoke` scenario (located under
-[`gitlab-org/gitlab-ce@qa/qa/scenario/test/smoke.rb`][smoke-instance] in the
-in the GitLab CE project).
+[`gitlab-org/gitlab/qa/qa/scenario/test/smoke.rb`][smoke-instance] in the
+in the GitLab project).
 
 Example:
 
@@ -863,5 +901,5 @@ $ gitlab-qa Test::Instance::Geo EE https://primary.gitlab.com https://secondary.
 
 [Back to README.md](../README.md)
 
-[test-instance]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/qa/qa/scenario/test/instance/all.rb
-[smoke-instance]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/qa/qa/scenario/test/instance/smoke.rb
+[test-instance]: https://gitlab.com/gitlab-org/gitlab/blob/master/qa/qa/scenario/test/instance/all.rb
+[smoke-instance]: https://gitlab.com/gitlab-org/gitlab/blob/master/qa/qa/scenario/test/instance/smoke.rb

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

@@ -1,7 +1,3 @@
-require 'net/http'
-require 'json'
-require 'uri'
-
 module Gitlab
   module QA
     module Component

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

@@ -1,7 +1,3 @@
-require 'net/http'
-require 'json'
-require 'uri'
-
 module Gitlab
   module QA
     module Component

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

@@ -1,7 +1,3 @@
-require 'net/http'
-require 'json'
-require 'uri'
-
 module Gitlab
   module QA
     module Component

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

@@ -0,0 +1,9 @@
+module Gitlab
+  module QA
+    module Component
+      class StagingRef < Staging
+        ADDRESS = 'https://staging-ref.gitlab.com'.freeze
+      end
+    end
+  end
+end

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

@@ -113,7 +113,7 @@ module Gitlab
             "found:#{pipeline}.gitlab.com"
           when 'preprod'
             'found:pre.gitlab.com'
-          when 'staging-orchestrated', 'nightly', QA::Runtime::Env.default_branch
+          when 'staging-orchestrated', 'nightly', QA::Runtime::Env.default_branch, 'staging-ref', 'release'
             "found:#{pipeline}"
           else
             raise "No `found:*` label for the `#{pipeline}` pipeline!"

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

@@ -15,6 +15,8 @@ module Gitlab
           'QA_REMOTE_GRID_USERNAME' => :remote_grid_username,
           'QA_REMOTE_GRID_ACCESS_KEY' => :remote_grid_access_key,
           'QA_REMOTE_GRID_PROTOCOL' => :remote_grid_protocol,
+          'QA_REMOTE_MOBILE_DEVICE_NAME' => :remote_mobile_device_name,
+          'QA_REMOTE_TUNNEL_ID' => :remote_tunnel_id,
           'QA_BROWSER' => :browser,
           'QA_ADDITIONAL_REPOSITORY_STORAGE' => :qa_additional_repository_storage,
           'QA_PRAEFECT_REPOSITORY_STORAGE' => :qa_praefect_repository_storage,

data/lib/gitlab/qa/runtime/omnibus_configurations/license_mode.rb

@@ -7,7 +7,7 @@ module Gitlab
         class LicenseMode < Default
           def configuration
             <<~OMNIBUS
-              gitlab_rails['env'] = { 'GITLAB_LICENSE_MODE' => 'test', 'CUSTOMER_PORTAL_URL' => 'https://customers.stg.gitlab.com' }
+              gitlab_rails['env'] = { 'GITLAB_LICENSE_MODE' => 'test', 'CUSTOMER_PORTAL_URL' => 'https://customers.staging.gitlab.com' }
             OMNIBUS
           end
         end

data/lib/gitlab/qa/scenario/test/instance/staging_ref.rb

@@ -0,0 +1,18 @@
+module Gitlab
+  module QA
+    module Scenario
+      module Test
+        module Instance
+          ##
+          # Run test suite against Staging Ref environment
+          #
+          class StagingRef < DeploymentBase
+            def deployment_component
+              Component::StagingRef
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module QA
-    VERSION = '7.12.0'.freeze
+    VERSION = '7.13.3'.freeze
   end
 end

data/lib/gitlab/qa.rb

@@ -34,6 +34,7 @@ module Gitlab
           autoload :RelativeUrl, 'gitlab/qa/scenario/test/instance/relative_url'
           autoload :RepositoryStorage, 'gitlab/qa/scenario/test/instance/repository_storage'
           autoload :Staging, 'gitlab/qa/scenario/test/instance/staging'
+          autoload :StagingRef, 'gitlab/qa/scenario/test/instance/staging_ref'
           autoload :Production, 'gitlab/qa/scenario/test/instance/production'
           autoload :Smoke, 'gitlab/qa/scenario/test/instance/smoke'
           autoload :Preprod, 'gitlab/qa/scenario/test/instance/preprod'
@@ -87,6 +88,7 @@ module Gitlab
       autoload :SAML, 'gitlab/qa/component/saml'
       autoload :Specs, 'gitlab/qa/component/specs'
       autoload :Staging, 'gitlab/qa/component/staging'
+      autoload :StagingRef, 'gitlab/qa/component/staging_ref'
       autoload :Production, 'gitlab/qa/component/production'
       autoload :Minio, 'gitlab/qa/component/minio'
       autoload :Preprod, 'gitlab/qa/component/preprod'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 7.12.0
+  version: 7.13.3
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -190,6 +190,7 @@ files:
 - ".dockerignore"
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".gitlab/ci/rules.gitlab-ci.yml"
 - ".gitlab/merge_request_templates/Release.md"
 - ".rspec"
 - ".rubocop.yml"
@@ -240,6 +241,7 @@ files:
 - lib/gitlab/qa/component/saml.rb
 - lib/gitlab/qa/component/specs.rb
 - lib/gitlab/qa/component/staging.rb
+- lib/gitlab/qa/component/staging_ref.rb
 - lib/gitlab/qa/docker/command.rb
 - lib/gitlab/qa/docker/engine.rb
 - lib/gitlab/qa/docker/shellout.rb
@@ -287,6 +289,7 @@ files:
 - lib/gitlab/qa/scenario/test/instance/smoke.rb
 - lib/gitlab/qa/scenario/test/instance/staging.rb
 - lib/gitlab/qa/scenario/test/instance/staging_geo.rb
+- lib/gitlab/qa/scenario/test/instance/staging_ref.rb
 - lib/gitlab/qa/scenario/test/integration/actioncable.rb
 - lib/gitlab/qa/scenario/test/integration/client_ssl.rb
 - lib/gitlab/qa/scenario/test/integration/elasticsearch.rb