gitlab-qa 5.14.1 → 5.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80b5afa85b80b6c367a00f9e0077782d761bf5ad69d851aa95e5ea4f7ec4af78
-  data.tar.gz: b6940307fb5981a4f7c4468be522916ae4a01f2e65ddb0a5847037ce7099556f
+  metadata.gz: 32ae85f17e98b415ac5fddd505d5cf9d37462bbcc5b0eabee7584c3a26803542
+  data.tar.gz: 62ea7475a8d3eddb193a975c440fc19b2177ea612ecf8a02d9bbf9a8c926f177
 SHA512:
-  metadata.gz: 95347f6df44ef53110ac29177e3373fecba8d0ea2535f5a642233519c87d4c97edef9120d6a48e22b05739a00e4b01eccd090743894f1f0db52ba6a1ee4e0995
-  data.tar.gz: a688557eb3fb7738f7288dfbd18bf804fbfdbf668ffd1e17f155f1df3fce5b38b5618af10460355f516e26091e93f290651f364ac5f09531827c6a06b4b0fee5
+  metadata.gz: 35e187728145ac187fda0dbe3b41b24d44adc52a3cb8718083736ccf0e36f06a089c74e97db983b4b40f2eb432fa847c440208e083df24d8f9a5df76a495b0d7
+  data.tar.gz: a7e08091352126ada545f61b6d7a940e0eb87f4ec9d9753fa0521244c2f35b209a0474eb158b7e82486ee7fe5ae59047d3748fd6aadd36922d96b9520081b177

data/README.md

@@ -121,11 +121,58 @@ All the scenarios you can run are described in the
 
 Note: The GitLab QA tool requires that [Docker](https://docs.docker.com/install/) is installed.
 
-### How to add new scenarios
-
-Scenarios (test cases) and scripts to run them are located in the
-[CE](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/qa) and
-[EE](https://gitlab.com/gitlab-org/gitlab-ee/tree/master/qa)
+### Command-line options
+
+In addition to the [arguments you can use to specify the scenario and
+tests to run](/docs/what_tests_can_be_run.md), you can use the
+following options to control the tool's behavior.
+
+**Note:** These are `gitlab-qa` options so if you specify RSpec
+options as well, including test file paths, be sure to add these
+options before the `--` that indicates that subsequent arguments are
+intended for RSpec.
+
+| Option | Description |
+| ------ | ----------- |
+| `--no-teardown` | Skip teardown of containers after the scenario completes |
+| `--no-tests` | Orchestrates the docker containers but does not run the tests. Implies `--no-teardown` |
+
+For example, the following command would start an EE GitLab Docker
+container and would leave the instance running, but would not run the
+tests:
+
+```plaintext
+$ gitlab-qa Test::Instance::Image EE --no-tests
+```
+
+GitLab QA will have automatically run the `docker ps` command to show
+the port that container is running on, for example:
+
+```plaintext
+...
+Skipping tests.
+The orchestrated docker containers have not been removed.
+Docker shell command: `docker ps`
+CONTAINER ID  IMAGE                     ... PORTS
+fdeffd791b69  gitlab/gitlab-ee:nightly      22/tcp, 443/tcp, 0.0.0.0:32768->80/tcp
+```
+
+You could then run tests against that instance in a similar way to
+[running tests against GDK](/docs/run_qa_against_gdk.md). This can be
+useful if you want to run and debug a specific test, for example:
+
+```plaintext
+# From /path/to/gdk/gitlab/qa
+$ bundle exec bin/qa Test::Instance::All http://localhost:32768 -- qa/specs/features/browser_ui/3_create/merge_request/create_merge_request_spec.rb
+```
+
+### How to add new tests
+
+Please see the [Beginner's guide to writing end-to-end tests](https://docs.gitlab.com/ee/development/testing_guide/end_to_end/beginners_guide.html).
+
+Test cases and scripts to run them are located in the
+[GitLab FOSS](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/qa) and
+[GitLab](https://gitlab.com/gitlab-org/gitlab/tree/master/qa)
 repositories under the `qa/` directory, so please also check the documentation
 there.
 

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

@@ -61,8 +61,6 @@ module Gitlab
         end
 
         def prepare_docker_image
-          return if Runtime::Env.skip_pull?
-
           pull
         end
 
@@ -106,6 +104,17 @@ module Gitlab
         end
 
         def teardown
+          unless teardown?
+            puts "The orchestrated docker containers have not been removed."
+            docker.ps
+
+            return
+          end
+
+          teardown!
+        end
+
+        def teardown!
           assert_name!
 
           return unless docker.running?(name)
@@ -115,6 +124,8 @@ module Gitlab
         end
 
         def pull
+          return if Runtime::Env.skip_pull?
+
           docker.pull(image, tag)
         end
 
@@ -129,6 +140,10 @@ module Gitlab
         def assert_name!
           raise 'Invalid instance name!' unless name
         end
+
+        def teardown?
+          !Runtime::Scenario.attributes.include?(:teardown) || Runtime::Scenario.teardown
+        end
       end
     end
   end

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

@@ -17,6 +17,8 @@ module Gitlab
         end
 
         def perform # rubocop:disable Metrics/AbcSize
+          return puts "Skipping tests." if skip_tests?
+
           raise ArgumentError unless [suite, release].all?
 
           @docker.login(**release.login_params) if release.login_params
@@ -42,6 +44,12 @@ module Gitlab
             command.name(name)
           end
         end
+
+        private
+
+        def skip_tests?
+          Runtime::Scenario.attributes.include?(:run_tests) && !Runtime::Scenario.run_tests
+        end
       end
     end
   end

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

@@ -82,6 +82,10 @@ module Gitlab
         def running?(name)
           Docker::Command.execute("ps -f name=#{name}").include?(name)
         end
+
+        def ps(name = nil)
+          Docker::Command.execute(['ps', name].compact.join(' '))
+        end
       end
     end
   end

data/lib/gitlab/qa/release.rb

@@ -136,6 +136,8 @@ module Gitlab
       end
 
       def login_params
+        return if Runtime::Env.skip_pull?
+
         if dev_gitlab_org?
           Runtime::Env.require_qa_dev_access_token!
 
@@ -173,6 +175,10 @@ module Gitlab
         canonical? || release.match?(CUSTOM_GITLAB_IMAGE_REGEX)
       end
 
+      def api_project_name
+        project_name.gsub('ce', 'foss').gsub('-ee', '')
+      end
+
       private
 
       def canonical?

data/lib/gitlab/qa/runner.rb

@@ -4,22 +4,20 @@ module Gitlab
   module QA
     # rubocop:disable Metrics/AbcSize
     class Runner
-      # These options are implemented in the QA framework (i.e., in the CE/EE codebase)
-      # They're included here so that gitlab-qa treats them as valid options
-      PASS_THROUGH_OPTS = [
-        ['--address URL', 'Address of the instance to test'],
-        ['--enable-feature FEATURE_FLAG', 'Enable a feature before running tests'],
-        ['--mattermost-address URL', 'Address of the Mattermost server'],
-        ['--parallel', 'Execute tests in parallel'],
-        ['--loop', 'Execute tests in a loop']
-      ].freeze
-
       def self.run(args)
-        options = OptionParser.new do |opts|
+        Runtime::Scenario.define(:teardown, true)
+        Runtime::Scenario.define(:run_tests, true)
+
+        @options = OptionParser.new do |opts|
           opts.banner = 'Usage: gitlab-qa [options] Scenario URL [[--] path] [rspec_options]'
 
-          PASS_THROUGH_OPTS.each do |opt|
-            opts.on(*opt)
+          opts.on('--no-teardown', 'Skip teardown of containers after the scenario completes.') do
+            Runtime::Scenario.define(:teardown, false)
+          end
+
+          opts.on('--no-tests', 'Orchestrates the docker containers but does not run the tests. Implies --no-teardown') do
+            Runtime::Scenario.define(:run_tests, false)
+            Runtime::Scenario.define(:teardown, false)
           end
 
           opts.on_tail('-v', '--version', 'Show the version') do
@@ -33,19 +31,29 @@ module Gitlab
             exit
           end
 
-          opts.parse(args)
+          begin
+            opts.parse(args)
+          rescue OptionParser::InvalidOption
+            # Ignore invalid options and options that are passed through to the tests
+          end
         end
 
+        args.reject! { |arg| gitlab_qa_options.include?(arg) }
+
         if args.size >= 1
           Scenario
             .const_get(args.shift)
             .perform(*args)
         else
-          puts options
+          puts @options
           exit 1
         end
       end
       # rubocop:enable Metrics/AbcSize
+
+      def self.gitlab_qa_options
+        @gitlab_qa_options ||= @options.top.list.map(&:long).flatten
+      end
     end
   end
 end

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

@@ -13,7 +13,11 @@ module Gitlab
                   gitlab.name = 'gitlab'
                   gitlab.network = 'test'
                   gitlab.volumes = volumes
-                  gitlab.exec_commands = ['gitlab-psql -d template1 -c "CREATE DATABASE praefect_production OWNER gitlab"']
+                  gitlab.exec_commands = [
+                    'gitlab-psql -d template1 -c "CREATE DATABASE praefect_production OWNER gitlab"',
+                    'mkdir -p /var/opt/gitlab/git-data/repositories/praefect',
+                    'chown -R git:root /var/opt/gitlab/git-data/repositories'
+                  ]
 
                   gitlab.act do
                     prepare
@@ -21,7 +25,7 @@ module Gitlab
                     reconfigure
                     process_exec_commands
                     wait
-                    teardown
+                    teardown!
                   end
                 end
 
@@ -61,21 +65,25 @@ module Gitlab
             def omnibus_config_with_praefect
               <<~OMNIBUS
                 gitaly['enable'] = true;
-                gitaly['auth_token'] = 'praefect-gitaly-token';
+                gitaly['auth_token'] = 'secret-token';
                 gitaly['storage'] = [
                   {
                     'name' => 'praefect-gitaly-0',
-                    'path' => '/var/opt/gitlab/git-data/repositories'
+                    'path' => '/var/opt/gitlab/git-data/repositories/praefect'
+                  },
+                  {
+                    'name' => 'gitaly',
+                    'path' => '/var/opt/gitlab/git-data/repositories/gitaly'
                   }
                 ];
                 praefect['enable'] = true;
                 praefect['listen_addr'] = '0.0.0.0:2305';
-                praefect['auth_token'] = 'praefect-token';
+                praefect['auth_token'] = 'secret-token';
                 praefect['virtual_storages'] = {
                   'default' => {
                     'praefect-gitaly-0' => {
                       'address' => 'unix:/var/opt/gitlab/gitaly/gitaly.socket',
-                      'token'   => 'praefect-gitaly-token',
+                      'token'   => 'secret-token',
                       'primary' => true
                     }
                   }
@@ -84,10 +92,13 @@ module Gitlab
                 praefect['database_user'] = 'gitlab';
                 praefect['database_dbname'] = 'praefect_production';
                 praefect['postgres_queue_enabled'] = true;
-                gitlab_rails['gitaly_token'] = 'praefect-token';
+                gitlab_rails['gitaly_token'] = 'secret-token';
                 git_data_dirs({
                   'default' => {
                     'gitaly_address' => 'tcp://localhost:2305'
+                  },
+                  'gitaly' => {
+                    'path' => '/var/opt/gitlab/git-data/repositories/gitaly'
                   }
                 });
               OMNIBUS

data/lib/gitlab/qa/scenario/test/sanity/version.rb

@@ -24,7 +24,7 @@ module Gitlab
                 end
               end
 
-              project = "gitlab-org/#{QA::Release.new(release).project_name}"
+              project = "gitlab-org/#{QA::Release.new(release).api_project_name}"
               commit = recent_commits(project).find { |c| c['id'] == version }
 
               if commit

data/lib/gitlab/qa/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module QA
-    VERSION = '5.14.1'.freeze
+    VERSION = '5.15.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 5.14.1
+  version: 5.15.0
 platform: ruby
 authors:
 - Grzegorz Bizon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-15 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control