gitlab-qa 5.13.6 → 5.16.0

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

@@ -3,18 +3,14 @@ require 'tempfile'
 module Gitlab
   module QA
     module Component
-      class InternetTunnel
-        include Scenario::Actable
-
+      class InternetTunnel < Base
         DOCKER_IMAGE = 'gitlab/ssh-tunnel'.freeze
         DOCKER_IMAGE_TAG = '1.0.0'.freeze
 
-        attr_writer :gitlab_hostname, :name
-        attr_accessor :network
+        attr_writer :gitlab_hostname
 
         def initialize
-          @docker = Docker::Engine.new
-          @volumes = {}
+          super
 
           key_dir = ENV['CI_PROJECT_DIR'] || Dir.tmpdir
           @ssh_key = Tempfile.new('tunnel-ssh-private-key', key_dir)
@@ -27,14 +23,9 @@ module Gitlab
         end
 
         def instance
-          raise ArgumentError, 'Please provide a block!' unless block_given?
-
-          prepare
-          start
+          raise 'Please provide a block!' unless block_given?
 
-          yield self
-        ensure
-          teardown
+          super
         end
 
         def url
@@ -47,14 +38,6 @@ module Gitlab
           @name ||= "ssh-tunnel-#{SecureRandom.hex(4)}"
         end
 
-        def prepare
-          @docker.pull(DOCKER_IMAGE, DOCKER_IMAGE_TAG)
-
-          return if @docker.network_exists?(network)
-
-          @docker.network_create(network)
-        end
-
         def tunnel_server_hostname
           ENV.fetch("TUNNEL_SERVER_HOSTNAME")
         end
@@ -77,15 +60,9 @@ module Gitlab
           end
         end
 
-        def restart
-          @docker.restart(name)
-        end
-
         def teardown
-          raise 'Invalid instance name!' unless name
+          super
 
-          @docker.stop(name)
-          @docker.remove(name)
           @ssh_key.unlink
         end
       end

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

@@ -1,50 +1,22 @@
 module Gitlab
   module QA
     module Component
-      class Jira
-        include Scenario::Actable
-
-        JIRA_IMAGE = 'registry.gitlab.com/gitlab-org/gitlab-qa/jira-gitlab'.freeze
-        JIRA_IMAGE_TAG = '8.8-project-and-issue'.freeze
-
-        attr_reader :docker
-        attr_accessor :environment, :network
-        attr_writer :name
-
-        def initialize
-          @docker = Docker::Engine.new
-          @environment = {}
-        end
+      class Jira < Base
+        DOCKER_IMAGE = 'registry.gitlab.com/gitlab-org/gitlab-qa/jira-gitlab'.freeze
+        DOCKER_IMAGE_TAG = '8.8-project-and-issue'.freeze
 
         def name
           @name ||= "jira"
         end
 
-        def hostname
-          "#{name}.#{network}"
-        end
-
         def instance
           raise 'Please provide a block!' unless block_given?
 
-          prepare
-          start
-
-          yield self
-        ensure
-          teardown
-        end
-
-        def prepare
-          @docker.pull(JIRA_IMAGE, JIRA_IMAGE_TAG)
-
-          return if @docker.network_exists?(network)
-
-          @docker.network_create(network)
+          super
         end
 
         def start
-          docker.run(JIRA_IMAGE, JIRA_IMAGE_TAG) do |command|
+          docker.run(image, tag) do |command|
             command << '-d '
             command << "--name #{name}"
             command << "--net #{network}"
@@ -53,17 +25,6 @@ module Gitlab
           end
         end
 
-        def restart
-          @docker.restart(name)
-        end
-
-        def teardown
-          raise 'Invalid instance name!' unless name
-
-          @docker.stop(name)
-          @docker.remove(name)
-        end
-
         def set_jira_hostname
           ::Gitlab::QA::Runtime::Env.jira_hostname = hostname
         end

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

@@ -15,25 +15,16 @@ require 'securerandom'
 module Gitlab
   module QA
     module Component
-      class LDAP
-        include Scenario::Actable
-
-        LDAP_IMAGE = 'osixia/openldap'.freeze
-        LDAP_IMAGE_TAG = 'latest'.freeze
+      class LDAP < Base
+        DOCKER_IMAGE = 'osixia/openldap'.freeze
+        DOCKER_IMAGE_TAG = 'latest'.freeze
         LDAP_USER = 'tanuki'.freeze
         LDAP_PASSWORD = 'password'.freeze
         BOOTSTRAP_LDIF = '/container/service/slapd/assets/config/bootstrap/ldif/custom'.freeze
         FIXTURE_PATH = File.expand_path('../../../../fixtures/ldap'.freeze, __dir__)
 
-        attr_reader :docker
-        attr_accessor :volumes, :network, :environment
-        attr_writer :name
-
         def initialize
-          @docker = Docker::Engine.new
-          @environment = {}
-          @volumes = {}
-          @network_aliases = []
+          super
 
           @volumes[FIXTURE_PATH] = BOOTSTRAP_LDIF
         end
@@ -58,41 +49,21 @@ module Gitlab
           LDAP_PASSWORD
         end
 
-        def add_network_alias(name)
-          @network_aliases.push(name)
-        end
-
         def name
           @name ||= "openldap-#{SecureRandom.hex(4)}"
         end
 
-        def hostname
-          "#{name}.#{network}"
-        end
-
         def instance
           raise 'Please provide a block!' unless block_given?
 
-          prepare
-          start
-
-          yield self
-        ensure
-          teardown
-        end
-
-        def prepare
-          @docker.pull(LDAP_IMAGE, LDAP_IMAGE_TAG)
-
-          return if @docker.network_exists?(network)
-
-          @docker.network_create(network)
+          super
         end
 
+        # rubocop:disable Metrics/AbcSize
         def start
           # copy-service needed for bootstraping LDAP user:
           # https://github.com/osixia/docker-openldap#seed-ldap-database-with-ldif
-          docker.run(LDAP_IMAGE, LDAP_IMAGE_TAG, '--copy-service') do |command|
+          docker.run(image, tag, '--copy-service') do |command|
             command << '-d '
             command << "--name #{name}"
             command << "--net #{network}"
@@ -111,21 +82,7 @@ module Gitlab
             end
           end
         end
-
-        def restart
-          @docker.restart(name)
-        end
-
-        def teardown
-          raise 'Invalid instance name!' unless name
-
-          @docker.stop(name)
-          @docker.remove(name)
-        end
-
-        def pull
-          @docker.pull(LDAP_IMAGE, LDAP_IMAGE_TAG)
-        end
+        # rubocop:enable Metrics/AbcSize
 
         def set_gitlab_credentials
           ::Gitlab::QA::Runtime::Env.ldap_username = username

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

@@ -4,50 +4,22 @@
 module Gitlab
   module QA
     module Component
-      class MailHog
-        include Scenario::Actable
-
-        MAILHOG_IMAGE = 'mailhog/mailhog'.freeze
-        MAILHOG_IMAGE_TAG = 'v1.0.0'.freeze
-
-        attr_reader :docker
-        attr_accessor :environment, :network
-        attr_writer :name
-
-        def initialize
-          @docker = Docker::Engine.new
-          @environment = {}
-        end
+      class MailHog < Base
+        DOCKER_IMAGE = 'mailhog/mailhog'.freeze
+        DOCKER_IMAGE_TAG = 'v1.0.0'.freeze
 
         def name
           @name ||= "mailhog"
         end
 
-        def hostname
-          "#{name}.#{network}"
-        end
-
         def instance
           raise 'Please provide a block!' unless block_given?
 
-          prepare
-          start
-
-          yield self
-        ensure
-          teardown
-        end
-
-        def prepare
-          @docker.pull(MAILHOG_IMAGE, MAILHOG_IMAGE_TAG)
-
-          return if @docker.network_exists?(network)
-
-          @docker.network_create(network)
+          super
         end
 
         def start
-          docker.run(MAILHOG_IMAGE, MAILHOG_IMAGE_TAG) do |command|
+          docker.run(image, tag) do |command|
             command << '-d '
             command << "--name #{name}"
             command << "--net #{network}"
@@ -57,17 +29,6 @@ module Gitlab
           end
         end
 
-        def restart
-          @docker.restart(name)
-        end
-
-        def teardown
-          raise 'Invalid instance name!' unless name
-
-          @docker.stop(name)
-          @docker.remove(name)
-        end
-
         def set_mailhog_hostname
           ::Gitlab::QA::Runtime::Env.mailhog_hostname = hostname
         end

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

@@ -6,23 +6,18 @@ require 'fileutils'
 module Gitlab
   module QA
     module Component
-      class Minio
-        include Scenario::Actable
-
-        MINIO_IMAGE = 'minio/minio'.freeze
-        MINIO_IMAGE_TAG = 'latest'.freeze
+      class Minio < Base
+        DOCKER_IMAGE = 'minio/minio'.freeze
+        DOCKER_IMAGE_TAG = 'latest'.freeze
         # These are secrets used in a local Minio container, they're not used for any online S3 server.
         AWS_ACCESS_KEY = 'AKIAIOSFODNN7EXAMPLE'.freeze
         AWS_SECRET_KEY = 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'.freeze
         DATA_DIR = '/data'.freeze
         DEFAULT_PORT = 9000
 
-        attr_reader :docker
-        attr_accessor :volumes, :network, :environment
-        attr_writer :name
-
         def initialize
-          @docker = Docker::Engine.new
+          super
+
           @environment = { MINIO_ACCESS_KEY: AWS_ACCESS_KEY, MINIO_SECRET_KEY: AWS_SECRET_KEY }
           @volumes = { host_data_dir => DATA_DIR }
           @buckets = []
@@ -31,12 +26,7 @@ module Gitlab
         def instance
           raise 'Please provide a block!' unless block_given?
 
-          prepare
-          start
-
-          yield self
-        ensure
-          teardown
+          super
         end
 
         def add_bucket(name)
@@ -70,16 +60,12 @@ module Gitlab
           @name ||= "minio-#{SecureRandom.hex(4)}"
         end
 
-        def hostname
-          "#{name}.#{network}"
-        end
-
         def port
           DEFAULT_PORT
         end
 
         def prepare
-          @docker.pull(MINIO_IMAGE, MINIO_IMAGE_TAG)
+          super
 
           FileUtils.mkdir_p(host_data_dir)
 
@@ -87,16 +73,12 @@ module Gitlab
             puts "Creating Minio bucket: #{bucket}"
             FileUtils.mkdir_p(File.join(host_data_dir, bucket))
           end
-
-          return if @docker.network_exists?(network)
-
-          @docker.network_create(network)
         end
 
-        def start
+        def start # rubocop:disable Metrics/AbcSize
           # --compat needed until https://gitlab.com/gitlab-org/gitlab-workhorse/issues/210
           # is resolved
-          docker.run(MINIO_IMAGE, MINIO_IMAGE_TAG, "server", "--compat", DATA_DIR) do |command|
+          docker.run(image, tag, "server", "--compat", DATA_DIR) do |command|
             command << '-d '
             command << "--name #{name}"
             command << "--net #{network}"
@@ -115,13 +97,6 @@ module Gitlab
             end
           end
         end
-
-        def teardown
-          raise 'Invalid instance name!' unless name
-
-          @docker.stop(name)
-          @docker.remove(name)
-        end
       end
     end
   end

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

@@ -1,43 +1,16 @@
 module Gitlab
   module QA
     module Component
-      class PostgreSQL
-        include Scenario::Actable
-
-        POSTGRES_IMAGE = 'postgres'.freeze
-        POSTGRES_IMAGE_TAG = '11'.freeze
-
-        attr_reader :docker
-        attr_accessor :environment, :network
-        attr_writer :name
-
-        def initialize
-          @docker = Docker::Engine.new
-          @environment = {}
-        end
+      class PostgreSQL < Base
+        DOCKER_IMAGE = 'postgres'.freeze
+        DOCKER_IMAGE_TAG = '11'.freeze
 
         def name
           @name ||= "postgres"
         end
 
-        def instance
-          prepare
-          start
-          wait_until_ready
-          yield self
-        ensure
-          teardown
-        end
-
-        def prepare
-          @docker.pull(POSTGRES_IMAGE, POSTGRES_IMAGE_TAG)
-          return if @docker.network_exists?(network)
-
-          @docker.network_create(network)
-        end
-
         def start
-          @docker.run(POSTGRES_IMAGE, POSTGRES_IMAGE_TAG) do |command|
+          @docker.run(image, tag) do |command|
             command << "-d"
             command << "--name #{name}"
             command << "--net #{network}"
@@ -46,11 +19,6 @@ module Gitlab
           end
         end
 
-        def teardown
-          @docker.stop(name)
-          @docker.remove(name)
-        end
-
         def run_psql(command)
           @docker.exec(name, %(psql -U postgres #{command}))
         end