gitlab-qa 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32ba2e013021db66a5aa650661b9b84853494bb4
-  data.tar.gz: e46916c8c07a846e132713918c7cb27aaf0688dc
+  metadata.gz: 1c2b6de72f64ffc8c5b1400cb9a96ddf6734ca74
+  data.tar.gz: da79c5ba4b2e2c6b2113213fce6ea51810979508
 SHA512:
-  metadata.gz: c5c3a6a1b4eeffd67ef375c288217e2501371ae8c36f5bba98902f16e02893b5befc1b94fea238b34e2aeefd94411198c10481202df78c2cb7fd3f4a66365e8e
-  data.tar.gz: 69d51e22a352ed08f05ca2bd99adcc3ec59ccc3b32fde0c5cddd22f9b29ab19cf6ebe88d8eaea69bed34a02a420efbc5c98bc79c6b04fe7b2449b6eb557f3419
+  metadata.gz: 8aa3ad66f489c2c4996e4dba9f937b6fef4fceced5ae2b4b2f2f9d25c5ff2b8d48d3ecf71ead553ded3e1efe8e7a632cbbf28063f5338b830e08e117d61c1572
+  data.tar.gz: 463dbd089d21e6b49627b40b7cbbe04ecbd6f961e6605f90ef2ab0cc2066eb79118f4efee447ac627de3187f3e772a8f07fe4f23713f1cf09f4fb09f4e57bfc8

data/.gitlab-ci.yml

@@ -11,6 +11,7 @@ variables:
   DOCKER_DRIVER: overlay
   DOCKER_HOST: tcp://docker:2375
   QA_SCREENSHOTS_DIR: $CI_PROJECT_DIR/screenshots
+  QA_LOGS_DIR: $CI_PROJECT_DIR/logs
 
 before_script:
   - bundle install
@@ -61,43 +62,47 @@ ee:version:
     expire_in: 30d
     paths:
       - screenshots/*.png
+      - logs/*.log
 
 ce:instance:
-  script: bin/qa Test::Instance::Image CE
+  script: bin/qa Test::Instance::Image ${RELEASE:=CE}
   <<: *test
 
 ee:instance:
-  script: bin/qa Test::Instance::Image EE
+  script: bin/qa Test::Instance::Image ${RELEASE:=EE}
   <<: *test
 
 ce:image:
-  script: bin/qa Test::Omnibus::Image CE
+  script: bin/qa Test::Omnibus::Image ${RELEASE:=CE}
   <<: *test
 
 ee:image:
-  script: bin/qa Test::Omnibus::Image EE
+  script: bin/qa Test::Omnibus::Image ${RELEASE:=EE}
   <<: *test
 
-ce:upgrade:
-  script: bin/qa Test::Omnibus::Upgrade CE
+ce:update:
+  script: bin/qa Test::Omnibus::Update ${RELEASE:=CE}
   <<: *test
 
-ee:upgrade:
-  script: bin/qa Test::Omnibus::Upgrade EE
+ee:update:
+  script: bin/qa Test::Omnibus::Update ${RELEASE:=EE}
+  <<: *test
+
+ce:upgrade:
+  script: bin/qa Test::Omnibus::Upgrade
   <<: *test
 
 ce:mattermost:
-  script: bin/qa Test::Integration::Mattermost CE
+  script: bin/qa Test::Integration::Mattermost ${RELEASE:=CE}
   <<: *test
 
 ee:mattermost:
-  script: bin/qa Test::Integration::Mattermost EE
+  script: bin/qa Test::Integration::Mattermost ${RELEASE:=EE}
   <<: *test
 
 ee:geo:
-  script: bin/qa Test::Integration::Geo EE
+  script: bin/qa Test::Integration::Geo ${RELEASE:=EE}
   <<: *test
-  allow_failure: true
   tags:
     - docker
     - 7gb

data/README.md

@@ -33,9 +33,13 @@ command in your system.
 
     `gitlab-qa Test::Integration::Mattermost CE|EE|<full image address>`
 
-1. Test upgrade process:
+1. Test update process between two CE or EE subsequent versions:
 
-    `gitlab-qa Test::Omnibus::Upgrade CE|EE|<full image address>`
+    `gitlab-qa Test::Omnibus::Update CE|EE|<full image address>`
+
+1. Test upgrade process from CE to EE:
+
+    `gitlab-qa Test::Omnibus::Upgrade CE|<full CE image address>`
 
 1. Run tests against any existing instance:
 
@@ -93,7 +97,9 @@ tests against it (see `Test::Instance::Image` above).
 * `GITLAB_PASSWORD` - password to use when signing in to GitLab
 * `EE_LICENSE` - Enterprise Edition license
 * `QA_SCREENSHOTS_DIR` - Path to a directory where screenshots for failing tests
-  will be saved (default: `/tmp/gitlab-qa-screenshots`)
+  will be saved (default: `/tmp/gitlab-qa/screenshots`)
+* `QA_LOGS_DIR` - Path to a directory where logs will be saved (default:
+  `/tmp/gitlab-qa/logs`)
 * `DOCKER_HOST` - Docker host to run tests against (default: `http://localhost`)
 
 ## Contributing

data/docs/README.md

@@ -0,0 +1,4 @@
+# GitLab QA Documentation
+
+- [Architecture](architecture.md)
+- [Trainings](trainings.md)

data/docs/trainings.md

@@ -0,0 +1,8 @@
+# GitLab QA trainings
+
+## Build team training on GitLab QA
+
+A great introduction to the GitLab QA project, its internal structure, how it's
+used, and how to start contributing to it. Check out the
+[video](https://youtu.be/Ym159ATYN_g) and
+[slides](https://docs.google.com/presentation/d/1-3YlYTIBzd2kSjGVYGPq1xqz4O7qtfABhoZRi_PcGRg/edit?usp=sharing).

data/lib/gitlab/qa.rb

@@ -20,6 +20,7 @@ module Gitlab
 
         module Omnibus
           autoload :Image, 'qa/scenario/test/omnibus/image'
+          autoload :Update, 'qa/scenario/test/omnibus/update'
           autoload :Upgrade, 'qa/scenario/test/omnibus/upgrade'
         end
 
@@ -43,6 +44,7 @@ module Gitlab
       autoload :Engine, 'qa/docker/engine'
       autoload :Command, 'qa/docker/command'
       autoload :Shellout, 'qa/docker/shellout'
+      autoload :Volumes, 'qa/docker/volumes'
     end
   end
 end

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

@@ -6,8 +6,6 @@ module Gitlab
       # the `qa/` directory located in GitLab CE / EE repositories.
       #
       class Specs < Scenario::Template
-        IMAGE = 'gitlab/gitlab-qa'.freeze
-
         attr_accessor :suite, :release, :network, :args
 
         def initialize
@@ -19,7 +17,7 @@ module Gitlab
 
           puts "Running test suite `#{suite}` for #{release.project_name}"
 
-          @docker.run(IMAGE, release.edition_tag, suite, *args) do |command|
+          @docker.run(release.qa_image, release.tag, suite, *args) do |command|
             command << "-t --rm --net=#{network || 'bridge'}"
 
             Runtime::Env.delegated.each do |env|
@@ -27,6 +25,7 @@ module Gitlab
             end
 
             command.volume('/var/run/docker.sock', '/var/run/docker.sock')
+            command.volume(Runtime::Env.logs_dir, '/var/log/gitlab')
             command.volume(Runtime::Env.screenshots_dir, '/home/qa/tmp')
             command.name("gitlab-specs-#{Time.now.to_i}")
           end

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

@@ -0,0 +1,26 @@
+require 'tmpdir'
+
+module Gitlab
+  module QA
+    module Docker
+      class Volumes
+        VOLUMES = { 'config' => '/etc/gitlab',
+                    'logs' => '/var/log/gitlab',
+                    'data' => '/var/opt/gitlab' }.freeze
+
+        def initialize(volumes = VOLUMES)
+          @volumes = volumes
+        end
+
+        def with_temporary_volumes
+          # macOS's tmpdir is a symlink /var/folders -> /private/var/folders
+          # but Docker on macOS exposes /private and disallow exposing /var/
+          # so we need to get the real tmpdir path
+          Dir.mktmpdir('gitlab-qa-', File.realpath(Dir.tmpdir)).tap do |dir|
+            yield Hash[@volumes.map { |k, v| ["#{dir}/#{k}", v] }]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/release.rb

@@ -3,7 +3,8 @@ module Gitlab
     class Release
       CANONICAL_REGEX = /\A(?<edition>ce|ee):?(?<tag>.+)?/i
       CUSTOM_GITLAB_IMAGE_REGEX = %r{/gitlab-(?<edition>[ce]e):(?<tag>.+)\z}
-      DEFAULT_TAG = 'nightly'.freeze
+      DEFAULT_TAG = 'latest'.freeze
+      DEFAULT_CANONICAL_TAG = 'nightly'.freeze
 
       attr_reader :release
       attr_writer :tag
@@ -31,6 +32,16 @@ module Gitlab
           end
       end
 
+      def ee?
+        edition == :ee
+      end
+
+      def to_ee
+        return self if ee?
+
+        self.class.new(to_s.sub('ce:', 'ee:'))
+      end
+
       def image
         @image ||=
           if canonical?
@@ -40,6 +51,10 @@ module Gitlab
           end
       end
 
+      def qa_image
+        "#{image}-qa"
+      end
+
       def project_name
         @project_name ||= image.sub(%r{^gitlab\/}, '')
       end
@@ -47,9 +62,9 @@ module Gitlab
       def tag
         @tag ||=
           if canonical?
-            release.match(CANONICAL_REGEX)[:tag] || DEFAULT_TAG
+            release.match(CANONICAL_REGEX)[:tag] || DEFAULT_CANONICAL_TAG
           else
-            release.match(CUSTOM_GITLAB_IMAGE_REGEX)[:tag]
+            release.match(CUSTOM_GITLAB_IMAGE_REGEX)&.[](:tag) || DEFAULT_TAG
           end
       end
 

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

@@ -10,7 +10,11 @@ module Gitlab
                        EE_LICENSE].freeze
 
         def screenshots_dir
-          ENV['QA_SCREENSHOTS_DIR'] || '/tmp/gitlab-qa-screenshots'
+          ENV['QA_SCREENSHOTS_DIR'] || '/tmp/gitlab-qa/screenshots'
+        end
+
+        def logs_dir
+          ENV['QA_LOGS_DIR'] || '/tmp/gitlab-qa/logs'
         end
 
         def delegated

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

@@ -11,9 +11,7 @@ module Gitlab
             def perform(release)
               release = Release.new(release)
 
-              unless release.edition == :ee
-                raise ArgumentError, 'Geo is EE only!'
-              end
+              raise ArgumentError, 'Geo is EE only!' unless release.ee?
 
               Component::Gitlab.perform do |primary|
                 primary.release = release

data/lib/gitlab/qa/scenario/test/omnibus/update.rb

@@ -0,0 +1,30 @@
+require 'tmpdir'
+require 'fileutils'
+
+module Gitlab
+  module QA
+    module Scenario
+      module Test
+        module Omnibus
+          class Update < Scenario::Template
+            def perform(next_release)
+              next_release = Release.new(next_release)
+
+              Docker::Volumes.new.with_temporary_volumes do |volumes|
+                Scenario::Test::Instance::Image
+                  .perform(next_release.previous_stable) do |scenario|
+                  scenario.volumes = volumes
+                end
+
+                Scenario::Test::Instance::Image
+                  .perform(next_release) do |scenario|
+                  scenario.volumes = volumes
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/scenario/test/omnibus/upgrade.rb

@@ -7,31 +7,25 @@ module Gitlab
       module Test
         module Omnibus
           class Upgrade < Scenario::Template
-            VOLUMES = { 'config' => '/etc/gitlab',
-                        'logs' => '/var/log/gitlab',
-                        'data' => '/var/opt/gitlab' }.freeze
+            def perform(image = 'CE')
+              ce_release = Release.new(image)
 
-            def perform(next_release)
-              next_release = Release.new(next_release)
+              if ce_release.ee?
+                raise ArgumentError, 'Only CE can be upgraded to EE!'
+              end
 
-              with_temporary_volumes do |volumes|
+              Docker::Volumes.new.with_temporary_volumes do |volumes|
                 Scenario::Test::Instance::Image
-                  .perform(next_release.previous_stable) do |scenario|
+                  .perform(ce_release) do |scenario|
                   scenario.volumes = volumes
                 end
 
                 Scenario::Test::Instance::Image
-                  .perform(next_release) do |scenario|
+                  .perform(ce_release.to_ee) do |scenario|
                   scenario.volumes = volumes
                 end
               end
             end
-
-            def with_temporary_volumes
-              Dir.mktmpdir('gitlab-qa-').tap do |dir|
-                yield Hash[VOLUMES.map { |k, v| ["#{dir}/#{k}", v] }]
-              end
-            end
           end
         end
       end

data/lib/gitlab/qa/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module QA
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Grzegorz Bizon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-22 00:00:00.000000000 Z
+date: 2017-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,7 +102,9 @@ files:
 - bin/console
 - bin/qa
 - bin/setup
+- docs/README.md
 - docs/architecture.md
+- docs/trainings.md
 - exe/gitlab-qa
 - gitlab-qa.gemspec
 - lib/gitlab/qa.rb
@@ -111,6 +113,7 @@ files:
 - lib/gitlab/qa/docker/command.rb
 - lib/gitlab/qa/docker/engine.rb
 - lib/gitlab/qa/docker/shellout.rb
+- lib/gitlab/qa/docker/volumes.rb
 - lib/gitlab/qa/release.rb
 - lib/gitlab/qa/runtime/env.rb
 - lib/gitlab/qa/scenario/actable.rb
@@ -120,6 +123,7 @@ files:
 - lib/gitlab/qa/scenario/test/integration/geo.rb
 - lib/gitlab/qa/scenario/test/integration/mattermost.rb
 - lib/gitlab/qa/scenario/test/omnibus/image.rb
+- lib/gitlab/qa/scenario/test/omnibus/update.rb
 - lib/gitlab/qa/scenario/test/omnibus/upgrade.rb
 - lib/gitlab/qa/scenario/test/sanity/version.rb
 - lib/gitlab/qa/version.rb