Class: Gitlab::QA::Component::Base

Inherits:
Object
  • Object
show all
Includes:
Scenario::Actable
Defined in:
lib/gitlab/qa/component/base.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Scenario::Actable

#act, included

Constructor Details

#initialize ⇒ Base

Returns a new instance of Base.



13
14
15
16
17
18
19
20
 
# File 'lib/gitlab/qa/component/base.rb', line 13

def initialize
  @docker = Docker::Engine.new
  @environment = {}
  @volumes = {}
  @ports = []
  @network_aliases = []
  @exec_commands = []
end

Instance Attribute Details

#docker ⇒ Object (readonly)

Returns the value of attribute docker.



9
10
11
 
# File 'lib/gitlab/qa/component/base.rb', line 9

def docker
  @docker
end

#environment ⇒ Object

Returns the value of attribute environment.



10
11
12
 
# File 'lib/gitlab/qa/component/base.rb', line 10

def environment
  @environment
end

#exec_commands=(value) ⇒ Object

Sets the attribute exec_commands

Parameters:

  • value —

    the value to set the attribute exec_commands to.



11
12
13
 
# File 'lib/gitlab/qa/component/base.rb', line 11

def exec_commands=(value)
  @exec_commands = value
end

#name ⇒ Object

Raises:

  • (NotImplementedError) 


26
27
28
 
# File 'lib/gitlab/qa/component/base.rb', line 26

def name
  raise NotImplementedError, "#{self.class.name} must specify a default name"
end

#network ⇒ Object

Returns the value of attribute network.



10
11
12
 
# File 'lib/gitlab/qa/component/base.rb', line 10

def network
  @network
end

#ports ⇒ Object

Returns the value of attribute ports.



10
11
12
 
# File 'lib/gitlab/qa/component/base.rb', line 10

def ports
  @ports
end

#runner_network ⇒ Object

Returns the value of attribute runner_network.



10
11
12
 
# File 'lib/gitlab/qa/component/base.rb', line 10

def runner_network
  @runner_network
end

#volumes ⇒ Object

Returns the value of attribute volumes.



10
11
12
 
# File 'lib/gitlab/qa/component/base.rb', line 10

def volumes
  @volumes
end

Instance Method Details

#add_network_alias(name) ⇒ Object 



22
23
24
 
# File 'lib/gitlab/qa/component/base.rb', line 22

def add_network_alias(name)
  @network_aliases.push(name)
end

#hostname ⇒ Object 



30
31
32
 
# File 'lib/gitlab/qa/component/base.rb', line 30

def hostname
  "#{name}.#{network}"
end

#image ⇒ Object

Raises:

  • (NotImplementedError) 


34
35
36
37
38
 
# File 'lib/gitlab/qa/component/base.rb', line 34

def image
  return self.class.const_get('DOCKER_IMAGE') if self.class.const_defined?('DOCKER_IMAGE')

  raise NotImplementedError, "#{self.class.name} must specify a docker image as DOCKER_IMAGE"
end

#instance(skip_teardown: false) ⇒ Object Also known as: launch_and_teardown_instance 



46
47
48
49
50
51
52
 
# File 'lib/gitlab/qa/component/base.rb', line 46

def instance(skip_teardown: false)
  instance_no_teardown do
    yield self if block_given?
  end
ensure
  teardown unless skip_teardown
end

#prepare ⇒ Object 



56
57
58
59
60
 
# File 'lib/gitlab/qa/component/base.rb', line 56

def prepare
  prepare_docker_image
  prepare_docker_container
  prepare_network
end

#prepare_docker_container ⇒ Object 



76
77
78
79
80
 
# File 'lib/gitlab/qa/component/base.rb', line 76

def prepare_docker_container
  return unless docker.container_exists?(name)

  docker.remove(name)
end

#prepare_docker_image ⇒ Object 



62
63
64
 
# File 'lib/gitlab/qa/component/base.rb', line 62

def prepare_docker_image
  pull
end

#prepare_network ⇒ Object 



66
67
68
69
70
71
72
73
74
 
# File 'lib/gitlab/qa/component/base.rb', line 66

def prepare_network
  if runner_network && !docker.network_exists?(runner_network) # rubocop:disable Style/IfUnlessModifier
    docker.network_create("--driver=bridge --internal #{runner_network}")
  end

  return if docker.network_exists?(network)

  docker.network_create(network)
end

#process_exec_commands ⇒ Object 



140
141
142
 
# File 'lib/gitlab/qa/component/base.rb', line 140

def process_exec_commands
  exec_commands.each { |command| docker.exec(name, command) }
end

#pull ⇒ Object 



134
135
136
137
138
 
# File 'lib/gitlab/qa/component/base.rb', line 134

def pull
  return if Runtime::Env.skip_pull?

  docker.pull(image: image, tag: tag)
end

#restart ⇒ Object 



109
110
111
112
113
 
# File 'lib/gitlab/qa/component/base.rb', line 109

def restart
  assert_name!

  docker.restart(name)
end

#start ⇒ Object

rubocop:disable Metrics/AbcSize



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/gitlab/qa/component/base.rb', line 82

def start # rubocop:disable Metrics/AbcSize
  docker.run(image: image, tag: tag) do |command|
    command << "-d"
    command << "--name #{name}"
    command << "--net #{network}"
    command << "--hostname #{hostname}"

    @ports.each do |mapping|
      command.port(mapping)
    end

    @volumes.to_h.each do |to, from|
      command.volume(to, from, 'Z')
    end

    command.volume(File.join(Runtime::Env.host_artifacts_dir, name, 'logs'), '/var/log/gitlab', 'Z')

    @environment.to_h.each do |key, value|
      command.env(key, value)
    end

    @network_aliases.to_a.each do |network_alias|
      command << "--network-alias #{network_alias}"
    end
  end
end

#tag ⇒ Object

Raises:

  • (NotImplementedError) 


40
41
42
43
44
 
# File 'lib/gitlab/qa/component/base.rb', line 40

def tag
  return self.class.const_get('DOCKER_IMAGE_TAG') if self.class.const_defined?('DOCKER_IMAGE_TAG')

  raise NotImplementedError, "#{self.class.name} must specify a docker image tag as DOCKER_IMAGE_TAG"
end

#teardown ⇒ Object 



115
116
117
118
119
120
121
122
123
124
 
# File 'lib/gitlab/qa/component/base.rb', line 115

def teardown
  unless teardown?
    Runtime::Logger.info("The orchestrated docker containers have not been removed.")
    docker.ps

    return
  end

  teardown!
end

#teardown! ⇒ Object 



126
127
128
129
130
131
132
 
# File 'lib/gitlab/qa/component/base.rb', line 126

def teardown!
  assert_name!

  return unless docker.running?(name)

  docker.remove(name)
end