gitlab-qa 12.5.0 → 13.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 886c387d7119bbeaff903a9396e315d79563805e6582a9d479cb0d827cc3526d
-  data.tar.gz: e0a58c2a59421fbb55ba7d64613dc8240368af30e544a6d573f0ef64baf81f0b
+  metadata.gz: c1b0faca28f971a96c2dbbb66253bb39575c8113f5106ee5845bd7d18a49ad14
+  data.tar.gz: 8d3d7ec33d579c662b765beb542c60912997a7a71711eb6b38c4fdbc8fa3580f
 SHA512:
-  metadata.gz: 0b61da0814b8ce32f7fadc0f7dac3aaeb1beb280d64bbd051cae5027d3c94942977b3dae19833f4e516b9aff7e084eb3d2acb239783f33eecb64b2eed11d7ab7
-  data.tar.gz: 0ee1817892437a9157cd90ea1139040b171df703c8d4c4733287eb09c6b0c86aa8fa10cb412bd387f2e34606319399b1e09190259d2eddef0e9078b9fd5bddf3
+  metadata.gz: 420a71805ccb95a567440373e42592588437b479bcb60d1ad0158e71620d95e679b7f01339a505c626e44c1b262096bfbd0b2b4a9c3eb2011175589de265b1af
+  data.tar.gz: 566711df162bd8506cabc16ffcfc66764d692c86058c5a482343412fd90a75dee821fa086df4459dd0d07abb3f03e6150d9f536afc96c15710a7b7b157b94289

data/.gitlab/merge_request_templates/Release.md

@@ -12,8 +12,8 @@ https://gitlab.com/gitlab-org/gitlab-qa/-/compare/v<PREVIOUS_VERSION>...<COMMIT_
 
 ## Post-merge checklist
 
-- [ ] In the `pipeline-common` project, [update the GITLAB_QA_VERSION](https://gitlab.com/gitlab-org/quality/pipeline-common/-/blob/master/ci/base.gitlab-ci.yml) and [create a release](https://gitlab.com/gitlab-org/quality/pipeline-common#release-process).
-- [ ] In the GitLab project, update the ref for `pipeline-common` in [`.gitlab/ci/qa-common/main.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/ci/qa-common/main.gitlab-ci.yml).
+- [ ] In the `pipeline-common` project, [update the GITLAB_QA_VERSION](https://gitlab.com/gitlab-org/quality/pipeline-common/-/blob/master/ci/base.gitlab-ci.yml) (make sure to add a `Changelog:` trailer to the commit) and [create a release](https://gitlab.com/gitlab-org/quality/pipeline-common#release-process).
+- [ ] Unless already done by [`renovate-gitlab-bot`](https://gitlab.com/dashboard/merge_requests?scope=all&state=opened&author_username=gitlab-dependency-update-bot&label_name[]=Engineering%20Productivity), in the GitLab project, update the ref for `pipeline-common` in [`.gitlab/ci/qa-common/main.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/ci/qa-common/main.gitlab-ci.yml).
 - [ ] Unless already done by [`renovate-gitlab-bot`](https://gitlab.com/dashboard/merge_requests?scope=all&state=opened&author_username=gitlab-dependency-update-bot&label_name[]=Quality), or if you need it sooner, in the GitLab project, update the `gitlab-qa` gem version in [`qa/Gemfile`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/qa/Gemfile) and [`qa/Gemfile.lock`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/qa/Gemfile.lock) (for an example, see: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117054).
 
 /label ~Quality ~"type::maintenance" ~"maintenance::dependency" ~Quality

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-qa (12.5.0)
+    gitlab-qa (13.0.0)
       activesupport (>= 6.1, < 7.1)
       gitlab (~> 4.19)
       http (~> 5.0)

data/docs/what_tests_can_be_run.md

@@ -120,6 +120,8 @@ All environment variables used by GitLab QA should be defined in [`lib/gitlab/qa
 | `WORKSPACES_DOMAIN_KEY` | - | The privkey.pem SSL Certificates for the `WORKSPACES_PROXY_DOMAIN`. See https://gitlab.com/gitlab-org/remote-development/gitlab-workspaces-proxy for instructions. | No |
 | `WORKSPACES_WILDCARD_CERT` | - | The fullchain.pem SSL Certificates for the Wildcard `WORKSPACES_PROXY_DOMAIN`. See https://gitlab.com/gitlab-org/remote-development/gitlab-workspaces-proxy for instructions.| No |
 | `WORKSPACES_WILDCARD_KEY` | - | The privkey.pem SSL Certificates for the Wildcard `WORKSPACES_PROXY_DOMAIN`. See https://gitlab.com/gitlab-org/remote-development/gitlab-workspaces-proxy for instructions. | No |
+| `QA_GITLAB_HOSTNAME` | `"gitlab-#{edition}-#{SecureRandom.hex(4)}"` | A host name for the GitLab instance setup with Test::Instance::Image. | No |
+| `QA_GITLAB_USE_TLS` | false | Specify if GitLab instance setup with Test::Instance::Image should use TLS | No |
 
 ## [Supported Remote Grid environment variables](./running_against_remote_grid.md)
 
@@ -571,7 +573,7 @@ $ export EE_LICENSE=$(cat /path/to/Geo.gitlab_license)
 $ gitlab-qa Test::Integration::InstanceSAML EE
 ```
 
-### `Test::Integration::OAuth CE|EE|<full image address>`
+### `Test::Instance::Image CE|EE|<full image address> --omnibus-config oauth`
 
 This tests that users can sign in to a GitLab instance using external OAuth services.
 
@@ -579,7 +581,7 @@ 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
+container is spun up and tests are run from it by running the `Test::Instance::All` scenario
 
 **Required environment variables:**
 
@@ -592,6 +594,8 @@ container is spun up and tests are run from it by running the `Test::Integration
 - `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.
+- `QA_GITLAB_HOSTNAME`: Hostname set for GitLab instance. This must be set to `gitlab` as the external OAuth applications have been setup to use this.
+- `QA_GITLAB_USE_TLS`: Use TLS for setting up GitLab instance. This must be set to `true` as since some external OAuth applications require the client to use TLS.
 
 Example:
 

data/lib/gitlab/qa/runner.rb

@@ -156,7 +156,7 @@ module Gitlab
             Runtime::Scenario.omnibus_exec_commands << configurator.exec_commands
 
             # Load the configuration
-            configurator.configuration.split("\n").each { |c| Runtime::Scenario.omnibus_configuration << c }
+            Runtime::Scenario.omnibus_configuration << configurator.configuration
           end
         rescue NameError
           raise <<~ERROR

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

@@ -81,6 +81,8 @@ module Gitlab
           'QA_GITHUB_PASSWORD' => :qa_github_password,
           'QA_FACEBOOK_USERNAME' => :qa_facebook_username,
           'QA_FACEBOOK_PASSWORD' => :qa_facebook_password,
+          'QA_GITLAB_HOSTNAME' => :qa_gitlab_hostname,
+          'QA_GITLAB_USE_TLS' => :qa_gitlab_use_tls,
           'KNAPSACK_GENERATE_REPORT' => :knapsack_generate_report,
           'KNAPSACK_REPORT_PATH' => :knapsack_report_path,
           'KNAPSACK_TEST_FILE_PATTERN' => :knapsack_test_file_pattern,
@@ -345,6 +347,10 @@ module Gitlab
           enabled?(env_var_value_if_defined('QA_SKIP_PULL'), default: false)
         end
 
+        def qa_gitlab_use_tls?
+          enabled?(env_var_value_if_defined('QA_GITLAB_USE_TLS'), default: false)
+        end
+
         def geo_failover?
           enabled?(env_var_value_if_defined('GEO_FAILOVER'), default: false)
         end

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

@@ -6,12 +6,12 @@ module Gitlab
       module OmnibusConfigurations
         class FacebookOauth < Default
           def configuration
-            Runtime::Env.require_github_oauth_environment!
+            Runtime::Env.require_facebook_environment!
 
             <<~OMNIBUS
-              gitlab_rails['omniauth_enabled'] = true;
-              gitlab_rails['omniauth_allow_single_sign_on'] = [facebook'];
-              gitlab_rails['omniauth_block_auto_created_users'] = false;
+              gitlab_rails['omniauth_enabled'] = true
+              gitlab_rails['omniauth_allow_single_sign_on'] = ['facebook']
+              gitlab_rails['omniauth_block_auto_created_users'] = false
               gitlab_rails['omniauth_providers'] = [
                 {
                   name: 'facebook',
@@ -20,8 +20,8 @@ module Gitlab
                   verify_ssl: false
                 }
               ];
-              letsencrypt['enable'] = false;
-              external_url '<%= gitlab.address %>';
+              letsencrypt['enable'] = false
+              external_url '<%= gitlab.address %>'
             OMNIBUS
           end
         end

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

@@ -18,7 +18,9 @@ module Gitlab
                 gitlab.release = release
                 gitlab.volumes = @volumes
                 gitlab.network = 'test'
+                gitlab.name = Runtime::Env.qa_gitlab_hostname
                 gitlab.seed_admin_token = @seed_admin_token
+                gitlab.tls = Runtime::Env.qa_gitlab_use_tls?
 
                 gitlab.instance do
                   Component::Specs.perform do |specs|

data/lib/gitlab/qa/support/http_request.rb

@@ -8,7 +8,7 @@ module Gitlab
     module Support
       class HttpRequest
         # rubocop:disable Metrics/AbcSize
-        def self.make_http_request(method: 'get', url: nil, params: {}, headers: {}, show_response: false, fail_on_error: true)
+        def self.make_http_request(method: 'get', url: nil, params: nil, headers: {}, show_response: false, fail_on_error: true)
           raise "URL not defined for making request. Exiting..." unless url
 
           res = HTTP.follow.method(method).call(url, json: params, headers: headers)

data/lib/gitlab/qa/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module QA
-    VERSION = '12.5.0'
+    VERSION = '13.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 12.5.0
+  version: 13.0.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-25 00:00:00.000000000 Z
+date: 2023-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -462,7 +462,6 @@ files:
 - lib/gitlab/qa/scenario/test/integration/mattermost.rb
 - lib/gitlab/qa/scenario/test/integration/metrics.rb
 - lib/gitlab/qa/scenario/test/integration/mtls.rb
-- lib/gitlab/qa/scenario/test/integration/oauth.rb
 - lib/gitlab/qa/scenario/test/integration/opensearch.rb
 - lib/gitlab/qa/scenario/test/integration/praefect.rb
 - lib/gitlab/qa/scenario/test/integration/registry.rb

data/lib/gitlab/qa/scenario/test/integration/oauth.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml'
-
-module Gitlab
-  module QA
-    module Scenario
-      module Test
-        module Integration
-          class OAuth < Scenario::Template
-            attr_reader :gitlab_name
-
-            def initialize
-              @gitlab_name = 'gitlab'
-            end
-
-            def perform(release, *rspec_args)
-              Runtime::Env.require_oauth_environment!
-
-              release = Release.new(release)
-
-              Component::Gitlab.perform do |gitlab|
-                gitlab.release = release
-                gitlab.network = 'test'
-                gitlab.name = gitlab_name
-                gitlab.tls = true
-
-                gitlab.omnibus_configuration << gitlab_omnibus_configuration(gitlab.address)
-
-                gitlab.instance do
-                  Runtime::Logger.info('Running OAuth specs!')
-
-                  Component::Specs.perform do |specs|
-                    rspec_args << '--' unless rspec_args.include?('--')
-                    rspec_args << %w[--tag oauth]
-                    specs.suite = 'Test::Instance::All'
-                    specs.release = release
-                    specs.network = gitlab.network
-                    specs.args = [gitlab.address, *rspec_args]
-                  end
-                end
-              end
-            end
-
-            private
-
-            def gitlab_omnibus_configuration(gitlab_address)
-              <<~OMNIBUS
-                gitlab_rails['omniauth_enabled'] = true;
-                gitlab_rails['omniauth_allow_single_sign_on'] = ['github', 'facebook'];
-                gitlab_rails['omniauth_block_auto_created_users'] = false;
-                gitlab_rails['omniauth_providers'] = [
-                  {
-                    name: 'github',
-                    app_id: '$QA_GITHUB_OAUTH_APP_ID',
-                    app_secret: '$QA_GITHUB_OAUTH_APP_SECRET',
-                    url: 'https://github.com/',
-                    verify_ssl: false,
-                    args: { scope: 'user:email' }
-                  },
-                  {
-                    name: 'facebook',
-                    app_id: '$QA_FACEBOOK_OAUTH_APP_ID',
-                    app_secret: '$QA_FACEBOOK_OAUTH_APP_SECRET',
-                    verify_ssl: false
-                  }
-                ];
-                letsencrypt['enable'] = false;
-                external_url '#{gitlab_address}';
-              OMNIBUS
-            end
-          end
-        end
-      end
-    end
-  end
-end