gitlab-qa 9.1.2 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58f719bee0e55a8a1fc5b3f32a63d060c53f6fbffe9455c716f379910688d7f2
-  data.tar.gz: c6a6dd6e340a90fe4cbf1681b47c3458c05f6120c7bc02f7fac7d124200da233
+  metadata.gz: 14c426ca85861845164d12c2bfe65ba51aeb3791d383920ce872b9066f7d50ca
+  data.tar.gz: 33e80bd2dd23bc1949018fe46f70bb892fecf0a9789f0365e0ccef6c01334267
 SHA512:
-  metadata.gz: aee127d159eed0e7ace711cbe1a96fe64c9cdd2a2cf63464973cca072ae31fb471143fb13fe07c2b585bb6404b17b890568a33a87bc372aa4019e9fc63fc0861
-  data.tar.gz: 3dd64f65b35ae21b26a7f6cab90b7fe3d12cd6d063b76a982fa1ffc44e08fbbb38ef4086c4c5d33e4ab5182ea39b4ad39ee2f7cfac15126f4b5e54d8e0922f7a
+  metadata.gz: 560b02f9b0a4321cb1b7be3c1e482f73a306b4c171bcc0bff4c6527fdd9fdabd68fb33ee042a4033cd047f3a23e8e5d84ae8017936ed6885cfd1de0c0c3eb646
+  data.tar.gz: 149bfc867c9913c3af4865964e12ba21d96509eaf0d4c1feb2bcf8c19c3d7da1933a68fa790bb41724ae824f4090f818d4240d5562a532e1fd2461a50138d21c

data/.gitlab-ci.yml

@@ -1,188 +1,145 @@
+.cache: &cache
+  key:
+    prefix: $RUBY_VERSION
+    files:
+      - Gemfile.lock
+      - gitlab-qa.gemspec
+  paths:
+    - vendor/ruby
+
+include:
+  - project: 'gitlab-org/quality/pipeline-common'
+    file:
+      - '/ci/gem-release.yml'
+      - '/ci/danger-review.yml'
+
 stages:
   - check
-  - generate
-  - triggers
+  - test
+  - qa
   - deploy
 
 default:
-  image: registry.gitlab.com/gitlab-org/gitlab-build-images/debian-bullseye-ruby-${RUBY_VERSION}:bundler-2.3
+  image: ${CI_REGISTRY}/gitlab-org/gitlab-build-images/debian-bullseye-ruby-${RUBY_VERSION}:bundler-2.3
   tags:
     - gitlab-org
   cache:
-    key:
-      files:
-        - Gemfile.lock
-        - gitlab-qa.gemspec
-      prefix: $RUBY_VERSION
-    paths:
-      - vendor/ruby
+    <<: *cache
+    policy: pull
   before_script:
-    - bundle version
-    - bundle config path vendor
-    - bundle install --jobs=$(nproc) --retry=3 --quiet && bundle check
-    - export LANG=C.UTF-8
+    - bundle install
 
 workflow:
   rules:
     # For merge requests, create a pipeline.
     - if: '$CI_MERGE_REQUEST_IID'
-      variables:
-        ALLURE_JOB_NAME: gitlab-qa
     # For the default branch, create a pipeline (this includes on schedules, pushes, merges, etc.).
-    - if: '$CI_COMMIT_BRANCH == "master"'
-      variables:
-        ALLURE_JOB_NAME: gitlab-qa
-    # For triggers from GitLab MR pipelines (and pipelines from other projects), create a pipeline
-    - if: '$CI_PIPELINE_SOURCE == "pipeline"'
-      variables:
-        ALLURE_JOB_NAME: package-and-qa
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
     # For tags, create a pipeline.
     - if: '$CI_COMMIT_TAG'
     # When using Run pipeline button in the GitLab UI, from the project’s CI/CD > Pipelines section, create a pipeline.
     - if: '$CI_PIPELINE_SOURCE == "web"'
 
 variables:
-  RUBY_VERSION: "2.7"
+  RUBY_VERSION: "3.0"
+  BUNDLE_PATH: vendor
+  BUNDLE_SILENCE_ROOT_WARNING: "true"
+  BUNDLE_SUPPRESS_INSTALL_USING_MESSAGES: "true"
+
+package-and-test-env:
+  image: ${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/alpine:latest
+  stage: .pre
+  variables:
+    BUILD_ENV: build.env
+  cache: []
+  before_script: []
+  script:
+    - scripts/build-package-and-test-env
+  artifacts:
+    reports:
+      dotenv: $BUILD_ENV
+  rules:
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+      changes:
+        - Gemfile.lock
+      variables:
+        UPDATE_QA_CACHE: "true"
+    - if: '$CI_MERGE_REQUEST_IID'
+      changes:
+        - Gemfile.lock
+      variables:
+        UPDATE_QA_CACHE: "true"
+    - when: always
+      variables:
+        UPDATE_QA_CACHE: "false"
+
+cache-gems:
+  stage: .pre
+  script:
+    - echo "Cached gems!"
+  cache:
+    <<: *cache
+    policy: pull-push
+    when: on_success
+  rules:
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+      changes:
+        - Gemfile.lock
+    - if: '$CI_MERGE_REQUEST_IID'
+      changes:
+        - Gemfile.lock
 
-.check-base:
+danger-review:
+  image: ${CI_REGISTRY}/gitlab-org/gitlab-build-images/debian-bullseye-ruby-${RUBY_VERSION}:bundler-2.4
   stage: check
-  parallel:
-    matrix:
-      - RUBY_VERSION: ["2.7", "3.0"]
+  needs:
+    - job: cache-gems
+      optional: true
 
 rubocop:
-  extends: .check-base
+  stage: check
+  needs:
+    - job: cache-gems
+      optional: true
   script:
     - bundle exec rubocop --color
 
 rspec:
-  extends: .check-base
+  stage: test
+  needs:
+    - job: cache-gems
+      optional: true
+  coverage: /LOC \((\d{1,3}\.\d{1,2})\%\)/
   script:
     - bundle exec rspec --force-color
-
-prepare:
-  stage: generate
-  extends: .rules:never-on-version-change-or-tag
-  script:
-    - |
-      if [[ $TOP_UPSTREAM_SOURCE_PROJECT == "gitlab-org/gitlab" && -n $TOP_UPSTREAM_SOURCE_SHA ]]; then
-        export QA_IMAGE_TAG=${TOP_UPSTREAM_SOURCE_SHA}
-      else
-        export QA_IMAGE_TAG=master
-      fi
-    - 'echo "QA_IMAGE_TAG=$QA_IMAGE_TAG" >> prep_vars.env'
-    - 'echo $QA_IMAGE_TAG'
   artifacts:
     reports:
-      dotenv: prep_vars.env
-    paths:
-      - prep_vars.env
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage/coverage.xml
 
-generate-jobs:
-  stage: generate
-  extends: .rules:never-on-version-change-or-tag
-  image:
-    name: $CI_REGISTRY/gitlab-org/gitlab/gitlab-ee-qa:$QA_IMAGE_TAG
-    entrypoint: [ "" ]
-  variables:
-    QA_EXPORT_TEST_METRICS: "false"
+package-and-test:
+  stage: qa
   needs:
-    - prepare
-  before_script:
-    - cd /home/gitlab/qa
-  script:
-    # Generate count example files
-    - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS
-    - bundle exec bin/qa Test::Integration::Mattermost http://dummy.test --mattermost-address http://mattermost.test --count-examples-only -- $QA_TESTS
-    - bundle exec bin/qa Test::Integration::ServicePingDisabled http://dummy.test --count-examples-only -- $QA_TESTS
-    - bundle exec bin/qa QA::EE::Scenario::Test::Geo --count-examples-only --primary-address http://dummy1.test --primary-name gitlab-primary --secondary-address http://dummy2.test --secondary-name gitlab-secondary --without-setup
-    - bundle exec bin/qa Test::Integration::LDAPNoTLS http://dummy.test --count-examples-only -- $QA_TESTS
-    - bundle exec bin/qa Test::Integration::LDAPTLS http://dummy.test --count-examples-only -- $QA_TESTS
-    - bundle exec bin/qa Test::Integration::LDAPNoServer http://dummy.test --count-examples-only -- $QA_TESTS
-    - bundle exec bin/qa Test::Integration::InstanceSAML http://dummy.test --count-examples-only -- $QA_TESTS
-    - bundle exec bin/qa QA::EE::Scenario::Test::Integration::GroupSAML http://dummy.test --count-examples-only -- $QA_TESTS
-    - bundle exec bin/qa Test::Integration::RegistryTLS http://dummy.test --count-examples-only -- $QA_TESTS
-    - bundle exec bin/qa Test::Integration::Registry http://dummy.test --count-examples-only -- $QA_TESTS
-    - bundle exec bin/qa QA::EE::Scenario::Test::Integration::Elasticsearch http://dummy.test --count-examples-only -- $QA_TESTS
-    - bundle exec bin/qa Test::Integration::SMTP http://dummy.test --count-examples-only -- $QA_TESTS
-    - bundle exec bin/qa Test::Integration::RegistryWithCDN http://dummy.test --count-examples-only -- $QA_TESTS
-    - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag repository_storage
-    - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag packages
-    - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag integrations
-    - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag gitlab_pages
-    - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag mtls
-    - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag jira
-    - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag can_use_large_setup
-    - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag cloud_activation
-    - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag object_storage
-    - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag metrics
-    - cp -r no_of_examples $CI_PROJECT_DIR
-
-    # TOP_UPSTREAM_DEFAULT_BRANCH is the default branch name of the original project that triggered a pipeline in this project.
-    - 'export TOP_UPSTREAM_DEFAULT_BRANCH=${TOP_UPSTREAM_DEFAULT_BRANCH:=master} && echo "TOP_UPSTREAM_DEFAULT_BRANCH=$TOP_UPSTREAM_DEFAULT_BRANCH" >> variables.env'
-    - 'echo "RELEASE=$RELEASE" >> variables.env'
-    - 'echo "GITLAB_QA_OPTIONS=$GITLAB_QA_OPTIONS" >> variables.env'
-    - 'echo "QA_TESTS=$QA_TESTS" >> variables.env'
-    - 'echo "KNAPSACK_GENERATE_REPORT=$KNAPSACK_GENERATE_REPORT" >> variables.env'
-    - 'echo "TOP_UPSTREAM_SOURCE_JOB=$TOP_UPSTREAM_SOURCE_JOB" >> variables.env'
-    - 'echo "TOP_UPSTREAM_SOURCE_REF=$TOP_UPSTREAM_SOURCE_REF" >> variables.env'
-    - 'echo "DISABLE_RELATING_FAILURE_ISSUES=$DISABLE_RELATING_FAILURE_ISSUES" >> variables.env'
-    - 'echo "TOP_UPSTREAM_SOURCE_PROJECT=$TOP_UPSTREAM_SOURCE_PROJECT" >> variables.env'
-    - 'echo "TOP_UPSTREAM_SOURCE_SHA=$TOP_UPSTREAM_SOURCE_SHA" >> variables.env'
-    - 'echo "NOTIFY_CHANNEL=$NOTIFY_CHANNEL" >> variables.env'
-    - 'echo "QA_IMAGE=$QA_IMAGE" >> variables.env'
-    - 'echo "EE_LICENSE=$EE_LICENSE" >> variables.env'
-    - 'echo "TOP_UPSTREAM_MERGE_REQUEST_IID=$TOP_UPSTREAM_MERGE_REQUEST_IID" >> variables.env'
-    - 'echo "ALLURE_JOB_NAME=$ALLURE_JOB_NAME" >> variables.env'
-    - mv variables.env $CI_PROJECT_DIR
-
-    - cd $CI_PROJECT_DIR
-    - ./scripts/generate-qa-jobs.rb
-    - cat generated-qa-jobs.yml
-  artifacts:
-    reports:
-      dotenv: variables.env
-    paths:
-      - generated-qa-jobs.yml
-      - variables.env
-      - no_of_examples
-    expire_in: 2 days
-
-trigger-generated-jobs:
-  stage: triggers
-  extends: .rules:never-on-version-change-or-tag
-  needs: [ generate-jobs ]
+    - package-and-test-env
   variables:
-    # Variables used in rules also need to be passed down using the `variables` section in addition to dotenv file
-    # due to this bug: https://gitlab.com/gitlab-org/gitlab/-/issues/352828. For other variables, duplicate declaration here is needed
-    # as well due to not using `needs` and `artifacts: true` in child pipelines.
-    RELEASE: $RELEASE
-    GITLAB_QA_OPTIONS: $GITLAB_QA_OPTIONS
-    QA_TESTS: $QA_TESTS
-    KNAPSACK_GENERATE_REPORT: $KNAPSACK_GENERATE_REPORT
-    TOP_UPSTREAM_SOURCE_JOB: $TOP_UPSTREAM_SOURCE_JOB
-    TOP_UPSTREAM_SOURCE_REF: $TOP_UPSTREAM_SOURCE_REF
-    TOP_UPSTREAM_DEFAULT_BRANCH: $TOP_UPSTREAM_DEFAULT_BRANCH
-    DISABLE_RELATING_FAILURE_ISSUES: $DISABLE_RELATING_FAILURE_ISSUES
-    TOP_UPSTREAM_SOURCE_PROJECT: $TOP_UPSTREAM_SOURCE_PROJECT
-    TOP_UPSTREAM_SOURCE_SHA: $TOP_UPSTREAM_SOURCE_SHA
-    NOTIFY_CHANNEL: $NOTIFY_CHANNEL
-    QA_IMAGE: $QA_IMAGE
-    EE_LICENSE: $EE_LICENSE
-    TOP_UPSTREAM_MERGE_REQUEST_IID: $TOP_UPSTREAM_MERGE_REQUEST_IID
-    ALLURE_JOB_NAME: $ALLURE_JOB_NAME
+    RELEASE: EE
+    RUN_WITH_BUNDLE: "true"
+    SKIP_OMNIBUS_TRIGGER: "true"
+    SKIP_REPORT_IN_ISSUES: "true"
+    ALLURE_JOB_NAME: gitlab-qa
+    UPDATE_QA_CACHE: $UPDATE_QA_CACHE
+    GITLAB_QA_CACHE_KEY: $GITLAB_QA_CACHE_KEY
+  inherit:
+    variables:
+      - RUBY_VERSION
+  when: manual
   trigger:
     strategy: depend
+    forward:
+      yaml_variables: true
+      pipeline_variables: true
     include:
-      - artifact: generated-qa-jobs.yml
-        job: generate-jobs
-
-include:
-  - local: .gitlab/ci/rules.gitlab-ci.yml
-  - project: 'gitlab-org/quality/pipeline-common'
-    file:
-      - '/ci/gem-release.yml'
-      - '/ci/danger-review.yml'
-
-danger-review:
-  stage: check
+      - project: gitlab-org/gitlab
+        ref: master
+        file: .gitlab/ci/package-and-test/main.gitlab-ci.yml

data/.simplecov

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "simplecov-cobertura"
+
+SimpleCov.configure do
+  formatter SimpleCov::Formatter::CoberturaFormatter
+  enable_coverage :branch
+  add_filter ["/spec/", "/vendor/"]
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-qa (9.1.2)
+    gitlab-qa (10.0.0)
       activesupport (~> 6.1)
       gitlab (~> 4.18.0)
       http (~> 5.0)
@@ -55,6 +55,7 @@ GEM
       danger
       gitlab (~> 4.2, >= 4.2.0)
     diff-lcs (1.5.0)
+    docile (1.4.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     e2mmap (0.1.0)
@@ -199,6 +200,15 @@ GEM
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (2.1.0)
+      rexml
+      simplecov (~> 0.19)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     solargraph (0.47.2)
       backport (~> 1.2)
       benchmark
@@ -219,6 +229,7 @@ GEM
       unicode-display_width (>= 1.1.1, < 3)
     thor (1.2.1)
     tilt (2.0.11)
+    timecop (0.9.6)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unf (0.1.4)
@@ -246,7 +257,10 @@ DEPENDENCIES
   pry (~> 0.11)
   rake (~> 13.0)
   rspec (~> 3.7)
+  simplecov (~> 0.22)
+  simplecov-cobertura (~> 2.1)
   solargraph (~> 0.41)
+  timecop (~> 0.9.5)
   webmock (= 3.7.0)
 
 BUNDLED WITH

data/README.md

@@ -1,5 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/gitlab-qa.svg)](https://rubygems.org/gems/gitlab-qa)
 [![build status](https://gitlab.com/gitlab-org/gitlab-qa/badges/master/pipeline.svg)](https://gitlab.com/gitlab-org/gitlab-qa/pipelines)
+[![coverage report](https://gitlab.com/gitlab-org/gitlab-qa/badges/master/coverage.svg)](https://gitlab.com/gitlab-org/gitlab-qa/-/commits/master)
 
 # GitLab QA orchestrator
 
@@ -7,11 +8,11 @@
 
 - **GitLab QA framework**: A framework that allows developers to write end-to-end
   tests simply and efficiently.
-  Located at [`gitlab-org/gitlab-ce@qa/qa/`][qa-framework].
+  Located at [`gitlab-org/gitlab-foss@qa/qa/`][qa-framework].
 - **GitLab QA instance-level scenarios**: RSpec scenarios that use the
   GitLab QA framework and Capybara to setup and perform individual end-to-end
   tests against a live GitLab instance.
-  Located at [`gitlab-org/gitlab-ce@qa/qa/specs/features/`][instance-level-scenarios].
+  Located at [`gitlab-org/gitlab-foss@qa/qa/specs/features/`][instance-level-scenarios].
 - **GitLab QA orchestrator** (this project): An orchestration tool that enables
   running various QA test suites in a simple manner.
 - **GitLab QA orchestrated scenarios**: Scenarios where containers are started,
@@ -19,8 +20,8 @@
   instance.
   Located at [`gitlab-org/gitlab-qa@lib/gitlab/qa/scenario/test/`][orchestrated-scenarios].
 
-[qa-framework]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/qa/qa/
-[instance-level-scenarios]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/qa/qa/specs/features/
+[qa-framework]: https://gitlab.com/gitlab-org/gitlab-foss/blob/master/qa/qa/
+[instance-level-scenarios]: https://gitlab.com/gitlab-org/gitlab-foss/blob/master/qa/qa/specs/features/
 [orchestrated-scenarios]: https://gitlab.com/gitlab-org/gitlab-qa/blob/master/lib/gitlab/qa/scenario/test/
 
 ## Goals and objectives

data/docs/what_tests_can_be_run.md

@@ -85,8 +85,8 @@ All environment variables used by GitLab QA should be defined in [`lib/gitlab/qa
 | `QA_RUN_TYPE` |- | QA run type like `staging-full`, `canary`, `production` etc. Used in test metrics reporting | No|
 | `QA_VALIDATE_RESOURCE_REUSE` | `false` | Set to `true` to [validate resource reuse](https://docs.gitlab.com/ee/development/testing_guide/end_to_end/resources.html#reusable-resources) after a test suite | No |
 | `QA_USE_PUBLIC_IP_API` | `false` | When performing Instance tests against a remote/pre-existing instance, use an API to detect the public API for requests coming from gitlab-qa.  Used by tests that exercise IP-address restrictions and similar
-| `GITHUB_USERNAME` |-  | Username for authenticating with GitHub. | No|
-| `GITHUB_PASSWORD` |-  | Password for authenticating with GitHub. | No|
+| `QA_GITHUB_USERNAME` |-  | Username for authenticating with GitHub. | No|
+| `QA_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|
@@ -101,7 +101,13 @@ All environment variables used by GitLab QA should be defined in [`lib/gitlab/qa
 | `COLORIZED_LOGS` | `false` | Colors GitLab QA and test logs to improve readability | No|
 | `QA_DOCKER_ADD_HOSTS` |- | Comma separated list of hosts to add to /etc/hosts in docker container | No|
 | `FIPS` |- | Set to `1` or `true` to indicate that the test is running under FIPS mode | No|
-| `JH_ENV` | `false` | Set to `true` to indicate tests or scenarios are running under JH env | No|
+| `JH_ENV` | `false` | Set to `true` to indicate tests or scenarios are running under JH env | No |
+| `QA_GITHUB_OAUTH_APP_ID` | - | Client ID for GitHub OAuth app. See https://docs.gitlab.com/ce/integration/github.html for steps to generate this token. | No |
+| `QA_GITHUB_OAUTH_APP_SECRET` | - | Client Secret for GitHub OAuth app. See https://docs.gitlab.com/ce/integration/github.html for steps to generate this token. | No |
+| `QA_1P_EMAIL` | - | Email address for authenticating into 1Password. | No |
+| `QA_1P_PASSWORD` | - | Password for authenticating into 1Password. | No |
+| `QA_1P_SECRET` | - | Secret for authenticating into 1Password. | No |
+| `QA_1P_GITHUB_UUID` | - | UUID for GitHub item in GitLab-QA 1Password vault. | No |
 
 ## [Supported Remote Grid environment variables](./running_against_remote_grid.md)
 
@@ -285,29 +291,6 @@ Example:
 $ gitlab-qa Test::Omnibus::Image CE
 ```
 
-### `Test::Omnibus::Update CE|EE|<full image address>`
-
-This tests that:
-
-- the GitLab Docker `latest` container works as expected by running
-  instance-level tests against it (see `Test::Instance::Image` above)
-- it can be updated to a new (`nightly` or `<full image address>`) container
-- the new GitLab container still works as expected by running
-  `Test::Instance::Image` against it
-
-Example:
-
-```shell
-# Update from gitlab/gitlab-ce:latest to gitlab/gitlab-ce:nightly
-$ gitlab-qa Test::Omnibus::Update CE
-
-# Update from gitlab/gitlab-ee:latest to gitlab/gitlab-ee:nightly
-$ gitlab-qa Test::Omnibus::Update EE
-
-# Update from gitlab/gitlab-ce:latest to gitlab/gitlab-ce:my-custom-tag
-$ gitlab-qa Test::Omnibus::Update gitlab/gitlab-ce:my-custom-tag
-```
-
 ### `Test::Omnibus::Upgrade CE|<full image address>`
 
 This tests that:
@@ -576,6 +559,48 @@ $ export EE_LICENSE=$(cat /path/to/Geo.gitlab_license)
 $ gitlab-qa Test::Integration::InstanceSAML EE
 ```
 
+### `Test::Integration::OAuth CE|EE|<full image address>`
+
+This tests that users can sign in to a GitLab instance using external OAuth services.
+
+The tests currently integrate with the following OAuth service providers:
+* GitHub
+
+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::OAuth` scenario
+
+**Required environment variables:**
+
+- [For EE only] `EE_LICENSE`: A valid EE license.
+- `QA_GITHUB_OAUTH_APP_ID`: Client ID for GitHub OAuth app. This can be found in the shared 1Password vault.
+- `QA_GITHUB_OAUTH_APP_SECRET`: Client Secret for GitHub OAuth app. This can be found in the shared 1Password vault.
+- `QA_GITHUB_USERNAME`: Username for authenticating with GitHub. This can be found in the shared 1Password vault.
+- `QA_GITHUB_PASSWORD`: Password for authenticating with GitHub. This can be found in the shared 1Password vault.
+- `QA_1P_EMAIL`: Email address for authenticating into 1Password for GitLab-QA vault. This can be found in the shared 1Password vault.
+- `QA_1P_PASSWORD`: Password for authenticating into 1Password for GitLab-QA vault. This can be found in the shared 1Password vault.
+- `QA_1P_SECRET`: Secret for authenticating into 1Password. This can be found in the GitLab-QA 1Password vault.
+- `QA_1P_GITHUB_UUID`: UUID for GitHub item in GitLab-QA 1Password vault. This can be found in the GitLab-QA 1Password vault.
+
+Example:
+
+```
+$ export QA_GITHUB_OAUTH_APP_ID=your_github_oauth_client_id
+$ export QA_GITHUB_OAUTH_APP_SECRET=your_github_oauth_client_secret
+$ export QA_GITHUB_USERNAME=your_github_username
+$ export QA_GITHUB_PASSWORD=your_github_password
+$ export QA_1P_EMAIL=1password_email
+$ export QA_1P_PASSWORD=1password_password
+$ export QA_1P_SECRET=1password_secret
+$ export QA_1P_GITHUB_UUID=1password_github_uuid
+
+$ gitlab-qa Test::Integration::OAuth CE
+
+# For EE
+$ export EE_LICENSE=$(cat /path/to/gitlab_license)
+
+$ gitlab-qa Test::Integration::OAuth EE
+```
+
 ### `Test::Integration::Mattermost CE|EE|<full image address>`
 
 This tests that a GitLab instance works as expected when enabling the embedded
@@ -1100,17 +1125,10 @@ Sample Test:
 
 Example:
 
-```ruby
+```shell
 $ gitlab-qa Test::Instance::Chaos
 ```
 
-----
-
-[Back to README.md](../README.md)
-
-[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
-
 ### `Test::Integration::Import`
 
 This scenario will run specs tagged with `:import` tags.
@@ -1118,4 +1136,24 @@ This scenario will run specs tagged with `:import` tags.
 These tests are designed to validate import functionality by importing projects from `GitHub` or another `GitLab` instance.
 This scenario type spins up 2 gitlab instances and additionally an instance with simple http mock server.
 
-If environment variable `QA_MOCK_GITHUB` is set to `true`, all calls to `github.com` are rerouted to mock server.
+Example:
+
+```shell
+$ gitlab-qa Test::Integration::Import
+```
+
+#### GitHub
+
+Setup uses [smocker](https://smocker.dev/) mock server for mocking all interactions with `GitHub`. By default environment variable `QA_MOCK_GITHUB` is
+set to `true` which adds host entry to `import-target` docker container to redirect all requests for `api.github.com` dns name to mock container.
+
+All mock definitions are defined in [github.yml](https://gitlab.com/gitlab-org/gitlab/-/blob/master/qa/qa/fixtures/mocks/import/github.yml) file. When mock definitions
+need to be updated, it can be useful to proxy all requests to real `GitHub` instance and recording all requests and responses.
+
+#### GitLab
+
+Testing import [by direct transfer](https://docs.gitlab.com/ee/user/group/import/#migrate-groups-by-direct-transfer-recommended) is done by spinning up 2 omnibus installations - `import-target` and `import-source`. In order for tests to work, application setting `allow_local_requests_from_web_hooks_and_services` must be enabled in target instance. This is automatically done by test process if environment variable `QA_ALLOW_LOCAL_REQUESTS` is set to `true`.
+
+----
+
+[Back to README.md](../README.md)

data/gitlab-qa.gemspec

@@ -27,7 +27,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry', '~> 0.11'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'simplecov', '~> 0.22'
+  spec.add_development_dependency 'simplecov-cobertura', '~> 2.1'
   spec.add_development_dependency 'solargraph', '~> 0.41'
+  spec.add_development_dependency 'timecop', '~> 0.9.5'
   spec.add_development_dependency 'webmock', '3.7.0'
 
   spec.add_runtime_dependency 'activesupport', '~> 6.1'

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

@@ -122,7 +122,7 @@ module Gitlab
               command.volume(to, from, 'Z')
             end
 
-            command.volume(File.join(Runtime::Env.host_artifacts_dir, name, 'logs'), '/var/log/gitlab', 'Z')
+            command.volume(*log_volume.values) unless log_volume.empty?
 
             @environment.to_h.each do |key, value|
               command.env(key, value)
@@ -177,6 +177,13 @@ module Gitlab
 
         attr_reader :exec_commands, :wait_until_ready, :reconfigure
 
+        def log_volume
+          @log_volume ||= {
+            src: File.join(Runtime::Env.host_artifacts_dir, name, 'logs'),
+            dest: '/var/log/gitlab'
+          }
+        end
+
         def assert_name!
           raise 'Invalid instance name!' unless name
         end

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

@@ -49,7 +49,7 @@ module Gitlab
         end
 
         def process_exec_commands
-          exec_commands << Support::ConfigScripts.add_git_server_hooks(docker, name)
+          Support::ConfigScripts.add_git_server_hooks(docker, name)
 
           commands = exec_commands.flatten.uniq
           return if commands.empty?

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

@@ -208,12 +208,12 @@ module Gitlab
         end
 
         def process_exec_commands
-          @docker.copy(name, DATA_SEED_PATH, DATA_PATH) if seed_admin_token || seed_db
+          Support::ConfigScripts.add_git_server_hooks(docker, name) unless skip_server_hooks
 
+          @docker.copy(name, DATA_SEED_PATH, DATA_PATH) if seed_admin_token || seed_db
           exec_commands << seed_admin_token_command if seed_admin_token
           exec_commands << seed_test_data_command if seed_db
           exec_commands << Runtime::Scenario.omnibus_exec_commands
-          exec_commands << Support::ConfigScripts.add_git_server_hooks(docker, name) unless skip_server_hooks
 
           commands = exec_commands.flatten.uniq
           return if commands.empty?

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

@@ -18,6 +18,7 @@ module Gitlab
           @tls_path = "/etc/smocker/tls"
           @ports = [80, 8081]
           @environment = { "SMOCKER_MOCK_SERVER_LISTEN_PORT" => 80 }
+          @log_volume = {}
         end
 
         attr_reader :name
@@ -29,10 +30,22 @@ module Gitlab
           setup_tls if tls
         end
 
+        # Print smocker log output by using docker logs command because smocker only logs to stdout
+        #
+        # @return [void]
+        def teardown!
+          Docker::Command.execute("logs #{name}")
+
+          super
+        end
+
         private
 
         attr_reader :tls_path, :tls
 
+        # Set up tls certs
+        #
+        # @return [void]
         def setup_tls
           @volumes = { "smocker-ssl" => tls_path }
           @ports = [443, 8081]

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

@@ -79,7 +79,7 @@ module Gitlab
 
         def find_issue_notes(iid:)
           handle_gitlab_client_exceptions do
-            Gitlab.issue_notes(project, iid, order_by: 'created_at', sort: 'asc').auto_paginate
+            Gitlab.issue_notes(project, iid, order_by: 'created_at', sort: 'asc')&.auto_paginate
           end
         end