gitlab-qa 7.13.0 → 7.14.0

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

@@ -727,7 +727,7 @@ $ gitlab-qa Test::Instance::Staging
 
 ### `Test::Instance::StagingRef`
 
-This scenario tests that the [`Staging Ref`](https://staging-ref.testbed.gitlab.net)
+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`)

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

@@ -2,7 +2,7 @@ module Gitlab
   module QA
     module Component
       class StagingRef < Staging
-        ADDRESS = 'https://staging-ref.testbed.gitlab.net'.freeze
+        ADDRESS = 'https://staging-ref.gitlab.com'.freeze
       end
     end
   end

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

@@ -107,7 +107,14 @@ module Gitlab
           retry
         rescue StandardError => e
           pipeline = QA::Runtime::Env.pipeline_from_project_name
-          channel = pipeline == "canary" ? "qa-production" : "qa-#{pipeline}"
+          channel = case pipeline
+                    when "canary"
+                      "qa-production"
+                    when "staging-canary"
+                      "qa-staging"
+                    else
+                      "qa-#{pipeline}"
+                    end
           error_msg = warn_exception(e)
 
           return unless QA::Runtime::Env.ci_commit_ref_name == QA::Runtime::Env.default_branch

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

@@ -111,9 +111,11 @@ module Gitlab
             'found:gitlab.com'
           when 'canary', 'staging'
             "found:#{pipeline}.gitlab.com"
+          when 'staging-canary'
+            "found:canary.staging.gitlab.com"
           when 'preprod'
             'found:pre.gitlab.com'
-          when 'staging-orchestrated', 'nightly', QA::Runtime::Env.default_branch, 'staging-ref'
+          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/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module QA
-    VERSION = '7.13.0'.freeze
+    VERSION = '7.14.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 7.13.0
+  version: 7.14.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-27 00:00:00.000000000 Z
+date: 2021-11-07 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"