gitlab-qa 12.2.1 → 12.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d415adc65e11bf7cb6e51536436a6569e8477bb37cb16ef6834148e1966b3a97
-  data.tar.gz: 18bb3333e27085779c061807124eef6921cb9e272d1bbca9f36f4c5b8fc1e703
+  metadata.gz: 06d3630b5975bd6c560b29280de76f5c6fdfeec2acf65775ca48646c2b413c06
+  data.tar.gz: 21d8d5abef70cf7fdcc47af4700d1c3392739efb2e923c0de71fe2614317e7e3
 SHA512:
-  metadata.gz: a3af2c133956e35c0fc594811d9027a0a61798407632c790dbefb7873605db3701ec56c0b7c7f2dc046ea4b0f711b15a40d8bb746b15c2f0d285b8bb942b7a1a
-  data.tar.gz: f188e6ea775ecc41d6e31de86a609a2ce479ab52055cb28f9e3c6c08feeea8d549494e578dd3c09daa46e659a654fed1ef464ab465a67033b0b7ecb6f211f9c4
+  metadata.gz: fad44c2bdf42d67c7b71686907cf62990ee96948e0b759615cb79745d57c0c8ec91ab75298992972712dab3139fa464b69c0eb078cc3d22ef4ae2db5e2efb807
+  data.tar.gz: 2117d2c4e221dc908ef562800302c1c821f55a2cb9040f3b82529989579613da4cceeddd280497a73de45860e44ce3e611934b2907b2ded4c8a7a65e6eaa9d30

data/.gitlab-ci.yml

@@ -34,7 +34,7 @@ workflow:
     # For merge requests, create a pipeline.
     - if: '$CI_MERGE_REQUEST_IID'
     # For the default branch, create a pipeline (this includes on schedules, pushes, merges, etc.).
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+    - if: '$CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH || $CI_COMMIT_REF_NAME =~ /^[\d-]+-stable$/'
     # 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.
@@ -47,6 +47,12 @@ variables:
   BUNDLE_SILENCE_ROOT_WARNING: "true"
   BUNDLE_SUPPRESS_INSTALL_USING_MESSAGES: "true"
 
+# Override rules to allow creating backport releases
+.release-base:
+  rules:
+    - if: '$CI_PIPELINE_SOURCE == "push" && ($CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH || $CI_COMMIT_REF_NAME =~ /^[\d-]+-stable$/)'
+      changes: ["lib/**/version.rb"]
+
 package-and-test-env:
   image: ${CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX}/alpine:latest
   stage: .pre
@@ -135,7 +141,6 @@ package-and-test:
     variables:
       - RUBY_VERSION
       - DEBIAN_VERSION
-  when: manual
   trigger:
     strategy: depend
     forward:
@@ -145,3 +150,8 @@ package-and-test:
       - project: gitlab-org/gitlab
         ref: master
         file: .gitlab/ci/package-and-test/main.gitlab-ci.yml
+  rules:
+    - if: '$CI_MERGE_REQUEST_IID'
+      when: manual
+      allow_failure: true
+    - when: always

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-qa (12.2.1)
+    gitlab-qa (12.4.0)
       activesupport (>= 6.1, < 7.1)
       gitlab (~> 4.19)
       http (~> 5.0)
@@ -24,6 +24,7 @@ GEM
     ast (2.4.2)
     backport (1.2.0)
     benchmark (0.2.0)
+    byebug (11.1.3)
     claide (1.1.0)
     claide-plugins (0.9.2)
       cork
@@ -149,6 +150,9 @@ GEM
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
     public_suffix (5.0.0)
     racc (1.6.0)
     rack (3.0.7)
@@ -263,6 +267,7 @@ DEPENDENCIES
   gitlab-styles (~> 10)
   lefthook (~> 1.2.6)
   pry (~> 0.11)
+  pry-byebug (~> 3.10.1)
   rake (~> 13.0)
   rspec (~> 3.7)
   simplecov (~> 0.22)

data/gitlab-qa.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'gitlab-styles', '~> 10'
   spec.add_development_dependency 'lefthook', '~> 1.2.6'
   spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'pry-byebug', '~> 3.10.1'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.7'
   spec.add_development_dependency 'simplecov', '~> 0.22'

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

@@ -85,6 +85,7 @@ module Gitlab
           'KNAPSACK_REPORT_PATH' => :knapsack_report_path,
           'KNAPSACK_TEST_FILE_PATTERN' => :knapsack_test_file_pattern,
           'KNAPSACK_TEST_DIR' => :knapsack_test_dir,
+          'NO_KNAPSACK' => :no_knapsack,
           'QA_KNAPSACK_REPORT_GCS_CREDENTIALS' => :qa_knapsack_report_gcs_credentials,
           'QA_KNAPSACK_REPORT_PATH' => :qa_knapsack_report_path,
           'QA_RSPEC_REPORT_PATH' => :qa_rspec_report_path,

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

@@ -53,28 +53,134 @@ module Gitlab
             #   NOT gitlab_rails['packages_enabled']=true
 
             v.nil? ? k.strip : "#{k.strip} = #{v.strip.tr('"', "'")}".strip
-          end.uniq
+          end
 
-          errors = []
+          sanitized = split_items(sanitized).uniq
+
+          sanitized = merge_arrays(sanitized)
 
           # check for duplicates
           duplicate_keys = []
           duplicates = sanitized.reject do |n|
             key = n.split('=').first
+
             duplicate_keys << key unless duplicate_keys.include?(key)
           end
 
+          errors = []
           duplicates.each { |duplicate| errors << "Duplicate entry found: `#{duplicate}`" }
 
           raise "Errors exist within the Omnibus Configuration!\n#{errors.join(',')}" if errors.any?
 
           @config = sanitized
         end
+
         # rubocop:enable Metrics/AbcSize
 
         def <<(config)
           @config << config.strip unless config.strip.empty?
         end
+
+        private
+
+        # Merge Omnibus configuration values if the value is an array
+        # @example
+        #  array = ['a["setting"] = [1]', 'a["setting"] = [2]']
+        #  merge_arrays(array) #=> ['a["setting"] = [1, 2]']
+        #
+        # @param [Array] arr
+        #
+        # @return [Array]
+        def merge_arrays(arr)
+          entries_with_array = {}
+
+          arr.reject! do |item|
+            key, value = item.split("=", 2)
+
+            array_content_match = value&.match(/^\s?\[([\s\S]+)\][\s;]?$/)
+
+            if array_content_match
+              if entries_with_array[key]
+                entries_with_array[key] << array_content_match[1]
+              else
+                entries_with_array[key] = [array_content_match[1]]
+              end
+            end
+          end
+
+          entries_with_array.each do |k, v|
+            arr << "#{k}= [#{v.map(&:chomp).join(', ')}]".strip
+          end
+
+          arr
+        end
+
+        # Split each Omnibus setting into an array item
+        # @example
+        #  input = ["a['setting_1'] = true",
+        #  "a['setting_2'] = [
+        #    {
+        #      name: 'setting_2a_name'
+        #    }
+        #  ]
+        #  a['setting_3'] = false"]
+        #
+        # split_items(input) #=>
+        # ["a['setting_1'] = true",
+        #  "a['setting_2'] = [
+        #     {
+        #       name: 'setting_2a_name'
+        #     }
+        #   ]",
+        # "a['setting_3'] = false"]
+        #
+        # @param [Array] input
+        #
+        # @return [Array]
+        #
+        # rubocop:disable Metrics/AbcSize
+        def split_items(input)
+          items = []
+
+          input.each do |item|
+            if count_occurrences(item, ' = ') > 1
+              multi_line_item = []
+              item.split("\n").each do |line|
+                if /( = |external_url)/.match?(line)
+
+                  if multi_line_item.count > 1
+                    items.pop
+                    items << multi_line_item.join("\n")
+                  end
+
+                  items << line
+                  multi_line_item = [line]
+                else
+                  multi_line_item << line
+                end
+              end
+
+              if multi_line_item.count > 1
+                items.pop
+                items << multi_line_item.join("\n")
+              end
+            else
+              items << item
+            end
+          end
+
+          items
+        end
+        # rubocop:enable Metrics/AbcSize
+
+        # Count occurrences of a substring in a string
+        # @param [String] str
+        # @param [String] substr
+        #
+        # @return [Array]
+        def count_occurrences(str, substr)
+          str.scan(/(?=#{substr})/).count
+        end
       end
     end
   end

data/lib/gitlab/qa/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module QA
-    VERSION = '12.2.1'
+    VERSION = '12.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 12.2.1
+  version: 12.4.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-26 00:00:00.000000000 Z
+date: 2023-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement