class Gitlab::QA::Docker::Engine

Constants

DOCKER_HOST
PRIVILEGED_COMMANDS

Public Instance Methods

attach(name, &block) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 75
def attach(name, &block)
  Docker::Command.execute("attach --sig-proxy=false #{name}", &block)
end
container_exists?(name) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 91
def container_exists?(name)
  Docker::Command.execute("container inspect #{name}")
rescue Docker::Shellout::StatusError
  false
else
  true
end
exec(name, command) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 64
def exec(name, command)
  cmd = ['exec']
  cmd << '--privileged' if privileged_command?(command)
  Docker::Command.execute(%(#{cmd.join(' ')} #{name} bash -c "#{command.gsub('"', '\\"')}"))
end
hostname() click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 10
def hostname
  URI(DOCKER_HOST).host
end
login(username:, password:, registry:) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 14
def login(username:, password:, registry:)
  Docker::Command.execute(%(login --username "#{username}" --password "#{password}" #{registry}), mask_secrets: password)
end
network_create(name) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 107
def network_create(name)
  Docker::Command.execute("network create #{name}")
end
network_exists?(name) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 99
def network_exists?(name)
  Docker::Command.execute("network inspect #{name}")
rescue Docker::Shellout::StatusError
  false
else
  true
end
port(name, port) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 111
def port(name, port)
  Docker::Command.execute("port #{name} #{port}/tcp")
end
privileged_command?(command) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 33
def privileged_command?(command)
  PRIVILEGED_COMMANDS.each do |privileged_regex|
    return true if command.match(privileged_regex)
  end

  false
end
ps(name = nil) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 119
def ps(name = nil)
  Docker::Command.execute(['ps', name].compact.join(' '))
end
pull(image:, tag: nil) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 18
def pull(image:, tag: nil)
  Docker::Command.execute("pull #{full_image_name(image, tag)}")
end
read_file(image, tag, path, &block) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 70
def read_file(image, tag, path, &block)
  cat_file = "run --rm --entrypoint /bin/cat #{full_image_name(image, tag)} #{path}"
  Docker::Command.execute(cat_file, &block)
end
remove(name) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 87
def remove(name)
  Docker::Command.execute("rm -f #{name}")
end
restart(name) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 79
def restart(name)
  Docker::Command.execute("restart #{name}")
end
run(image:, tag: nil, args: []) { |command| ... } click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 22
def run(image:, tag: nil, args: [])
  Docker::Command.new('run').tap do |command|
    yield command if block_given?

    command << full_image_name(image, tag)
    command << args if args.any?

    command.execute!
  end
end
running?(name) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 115
def running?(name)
  Docker::Command.execute("ps -f name=#{name}").include?(name)
end
stop(name) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 83
def stop(name)
  Docker::Command.execute("stop #{name}")
end
write_files(name) { |class do def write%(echo "#{contents}" > #{file};) end def append%(echo "#{contents}" >> #{file};) end end| ... } click to toggle source

Write to file(s) in the Docker container specified by @param name @param name The name of the Docker Container @example

engine.write_files('gitlab-abc123') do |files|
  files.append('/etc/hosts', '127.0.0.1 localhost')
  files.write('/opt/other', <<~TEXT
    This is content
    That goes within /opt/other
  TEXT)
# File lib/gitlab/qa/docker/engine.rb, line 50
def write_files(name)
  exec(name, yield(
    Class.new do
      def self.write(file, contents)
        %(echo "#{contents}" > #{file};)
      end

      def self.append(file, contents)
        %(echo "#{contents}" >> #{file};)
      end
    end
  ))
end

Private Instance Methods

full_image_name(image, tag) click to toggle source
# File lib/gitlab/qa/docker/engine.rb, line 125
def full_image_name(image, tag)
  [image, tag].compact.join(':')
end