gitlab-qa 12.3.0 → 12.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e4cc0696035cf54be7b10e0153ffb42d59a5da480b4f87b8e313fc19ac50d96
-  data.tar.gz: d773ed2ef468d85328eee38811f03738c97cb8b6679a1e65d6c22d3a91a76936
+  metadata.gz: 367b59ae508a9c2c33e9703ef5838f654326938179b0fff4e9854394dec28566
+  data.tar.gz: 72498fa54bd13f7ea378bc74307b9d08a8078f75ac185893e36a6ed2717f5f72
 SHA512:
-  metadata.gz: eef1ff7b5b65693659df80f4bfb78891238b07a0bdba06d1348d068c780bf52cd6f2b65faf753a700511f0fb28a4bfe2cc6dead51cc8873933bc5fa420445fe3
-  data.tar.gz: bb30bec072843a3939966e1beda00b2468f85f4bf201cd32c4f8d80c42824440d24884f86447b885d687fd627b75f7cf93d74cf20c778ada16986a5c51282d92
+  metadata.gz: 920ac1c0445f1ba5cecb1864e759df9c5cf5c48fbb89ba24ff04fc1960b8a21c771d7d6f981205125ac7cea882d15ab533ec906a90478da3336ddc345a795a2c
+  data.tar.gz: e48d7d55d2ccb5dfcf280a4626f1e2c798af68afaeea345c248b14947951942229d3a23add3e408dcd2faa68e0a5f0b7230333d7e6d5b6eefb6fc74d37193c8c

data/Gemfile.lock

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

data/docs/what_tests_can_be_run.md

@@ -112,6 +112,14 @@ All environment variables used by GitLab QA should be defined in [`lib/gitlab/qa
 | `RELEASE_REGISTRY_URL` | - | The registry url to fetch the release image for an orchestrated GitLab. | No |
 | `RELEASE_REGISTRY_USERNAME` | - | The username to log in to the registry for pulling the release image for orchestrated GitLab. | No |
 | `RELEASE_REGISTRY_PASSWORD` | - | The password to log in to the registry for pulling the release image for orchestrated GitLab. | No |
+| `WORKSPACES_OAUTH_APP_ID` | - | Client ID for Gitlab-workspaces-proxy OAuth app used for the authentication and authorization of the workspaces running in the cluster. See https://gitlab.com/gitlab-org/remote-development/gitlab-workspaces-proxy for instructions. | No |
+| `WORKSPACES_OAUTH_APP_SECRET` | - | Client Secret for Gitlab-workspaces-proxy OAuth app used for the authentication and authorization of the workspaces running in the cluster. See https://gitlab.com/gitlab-org/remote-development/gitlab-workspaces-proxy for instructions. | No |
+| `WORKSPACES_OAUTH_SIGNING_KEY` | - | Client Signing key for Gitlab-workspaces-proxy OAuth app used for the authentication and authorization of the workspaces running in the cluster. | No |
+| `WORKSPACES_PROXY_DOMAIN` | - | The domain on which gitlab-workspaces-proxy will listen on and it is used to create workspaces url. | No |
+| `WORKSPACES_DOMAIN_CERT` | - | The fullchain.pem SSL Certificates for the `WORKSPACES_PROXY_DOMAIN`. See https://gitlab.com/gitlab-org/remote-development/gitlab-workspaces-proxy for instructions. | No |
+| `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 |
 
 ## [Supported Remote Grid environment variables](./running_against_remote_grid.md)
 

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

@@ -10,7 +10,7 @@ module Gitlab
       # and has to be performed before main component containers are started
       #
       class Alpine < Base
-        DOCKER_IMAGE = "alpine"
+        DOCKER_IMAGE = "alpine/curl"
         DOCKER_IMAGE_TAG = "latest"
 
         def name
@@ -21,6 +21,7 @@ module Gitlab
           docker.run(image: image, tag: tag, args: ["tail", "-f", "/dev/null"]) do |command|
             command << "-d"
             command << "--name #{name}"
+            command << "--network #{network}" if network
 
             volumes.each { |to, from| command.volume(to, from, 'Z') }
             environment.each { |key, value| command.env(key, value) }

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

@@ -8,7 +8,7 @@ module Gitlab
 
         CERTIFICATES_PATH = File.expand_path('../../../../tls_certificates', __dir__)
 
-        attr_reader :docker
+        attr_reader :docker, :logger
         attr_writer :name, :exec_commands
         attr_accessor :volumes,
           :ports,
@@ -21,6 +21,7 @@ module Gitlab
 
         def initialize
           @docker = Docker::Engine.new
+          @logger = Runtime::Logger.logger
           @environment = {}
           @volumes = {}
           @ports = []

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

@@ -18,23 +18,24 @@ module Gitlab
           @tls_path = "/etc/smocker/tls"
           @ports = [80, 8081]
           @environment = { "SMOCKER_MOCK_SERVER_LISTEN_PORT" => 80 }
-          @log_volume = {}
+          @tls_volume = { "smocker-ssl" => @tls_path }
         end
 
-        attr_reader :name
+        attr_reader :name, :tls_volume
         attr_writer :tls
 
         def prepare
           super
 
+          alpine_service_container.start_instance
           setup_tls if tls
         end
 
-        # Print smocker log output by using docker logs command because smocker only logs to stdout
-        #
-        # @return [void]
         def teardown!
+          # Print smocker log output by using docker logs command because smocker only logs to stdout
           Docker::Command.execute("logs #{name}")
+          # Remove alpine service container
+          alpine_service_container.teardown!
 
           super
         end
@@ -43,26 +44,64 @@ module Gitlab
 
         attr_reader :tls_path, :tls
 
+        # Run healthcheck validate startup of mock server
+        #
+        # @return [void]
+        def wait_until_ready
+          logger.info("Waiting for mock server to start!")
+          poll_mock_healthcheck(3)
+          logger.info("Mock server container is healthy!")
+        end
+
+        # Poll healthcheck endpoint
+        #
+        # @param [Integer] max_tries
+        # @return [void]
+        def poll_mock_healthcheck(max_tries)
+          url = "#{tls ? 'https' : 'http'}://#{hostname}:8081/version"
+          curl_cmd = "curl --cacert #{tls_path}/smocker.crt -s -f -o /dev/null -w '%{http_code}' #{url}"
+          tries = 0
+
+          loop do
+            # Poll healthcheck endpoint and remove service container if it passes
+            if docker.exec(alpine_service_container.name, curl_cmd, shell: "sh")
+              alpine_service_container.teardown!
+              break
+            end
+          rescue Support::ShellCommand::StatusError => e
+            # re-raise StatusError so that built in startup retry is used in case of failure
+            raise e if tries >= max_tries
+
+            tries += 1
+            sleep 1
+          end
+        end
+
         # Set up tls certs
         #
         # @return [void]
         def setup_tls
-          @volumes = { "smocker-ssl" => tls_path }
+          @volumes = tls_volume
           @ports = [443, 8081]
           @environment = {
             "SMOCKER_MOCK_SERVER_LISTEN_PORT" => 443,
             "SMOCKER_TLS_ENABLE" => "true",
-            "SMOCKER_TLS_CERT_FILE" => "#{@tls_path}/smocker.crt",
-            "SMOCKER_TLS_PRIVATE_KEY_FILE" => "#{@tls_path}/smocker.key"
+            "SMOCKER_TLS_CERT_FILE" => "#{tls_path}/smocker.crt",
+            "SMOCKER_TLS_PRIVATE_KEY_FILE" => "#{tls_path}/smocker.key"
           }
 
-          Alpine.perform do |alpine|
-            alpine.volumes = volumes
+          docker.copy(alpine_service_container.name, "#{CERTIFICATES_PATH}/smocker/.", tls_path)
+        end
 
-            alpine.start_instance
-            docker.copy(alpine.name, "#{CERTIFICATES_PATH}/smocker/.", tls_path)
-          ensure
-            alpine.teardown! # always remove container, even when global `--no-tests` flag was provided
+        # Helper container to run tls cert copy and curl healthcheck command
+        # Separate container is required because tls certs have to be copied before smocker startup and smocker
+        # container itself doesn't ship with curl to perform healthcheck requests
+        #
+        # @return [Component::Alpine]
+        def alpine_service_container
+          @alpine_service_container ||= Alpine.new.tap do |alpine|
+            alpine.volumes = tls_volume
+            alpine.network = network
           end
         end
       end

data/lib/gitlab/qa/docker/engine.rb

@@ -81,10 +81,10 @@ module Gitlab
           ), mask_secrets: mask_secrets)
         end
 
-        def exec(name, command, mask_secrets: nil)
+        def exec(name, command, mask_secrets: nil, shell: "bash")
           cmd = ['exec']
           cmd << '--privileged' if privileged_command?(command)
-          Docker::Command.execute(%(#{cmd.join(' ')} #{name} bash -c "#{command.gsub('"', '\\"')}"),
+          Docker::Command.execute(%(#{cmd.join(' ')} #{name} #{shell} -c "#{command.gsub('"', '\\"')}"),
             mask_secrets: mask_secrets)
         end
 

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

@@ -156,7 +156,15 @@ module Gitlab
           'RELEASE_REGISTRY_PASSWORD' => :release_registry_password,
           'SELENOID_DIRECTORY' => :selenoid_directory,
           'USE_SELENOID' => :use_selenoid,
-          'SCHEDULE_TYPE' => :schedule_type
+          'SCHEDULE_TYPE' => :schedule_type,
+          'WORKSPACES_OAUTH_APP_ID' => :workspaces_oauth_app_id,
+          'WORKSPACES_OAUTH_APP_SECRET' => :workspaces_oauth_app_secret,
+          'WORKSPACES_OAUTH_SIGNING_KEY' => :workspaces_oauth_signing_key,
+          'WORKSPACES_PROXY_DOMAIN' => :workspaces_proxy_domain,
+          'WORKSPACES_DOMAIN_CERT' => :workspaces_domain_cert,
+          'WORKSPACES_DOMAIN_KEY' => :workspaces_domain_key,
+          'WORKSPACES_WILDCARD_CERT' => :workspaces_wildcard_cert,
+          'WORKSPACES_WILDCARD_KEY' => :workspaces_wildcard_key
         }.freeze
 
         ENV_VARIABLES.each do |env_name, method_name|

data/lib/gitlab/qa/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module QA
-    VERSION = '12.3.0'
+    VERSION = '12.4.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 12.3.0
+  version: 12.4.1
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-18 00:00:00.000000000 Z
+date: 2023-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control