takelage 0.18.1

data/lib/takelage/docker/cli.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage docker
+  class Docker < SubCommandBase
+    desc 'check [COMMAND]', 'Check docker'
+    subcommand 'check', DockerCheck
+
+    desc 'container [COMMAND]', 'Handle docker container'
+    subcommand 'container', DockerContainer
+
+    desc 'image [COMMAND]', 'Handle docker images'
+    subcommand 'image', DockerImage
+
+    desc 'socket [COMMAND]', 'Handle sockets for docker containers'
+    subcommand 'socket', DockerSocket
+  end
+end

data/lib/takelage/docker/container/check/cli.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage docker container check
+  class DockerContainerCheck < SubCommandBase
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerCheckRunning
+    include DockerContainerCheckExisting
+    include DockerContainerCheckNetwork
+    include DockerContainerCheckOrphaned
+
+    #
+    # docker container check existing
+    #
+    desc 'existing [CONTAINER]', 'Check if docker [CONTAINER] is existing'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check if docker container is existing
+    This check looks for a container with a given name.
+    If such a container is existing the result is true else false.
+    LONGDESC
+    # Check if docker container is existing.
+    def existing(container)
+      exit docker_container_check_existing container
+    end
+
+    #
+    # docker container check network
+    #
+    desc 'network [NETWORK]', 'Check if docker [NETWORK] is existing'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check if docker network is existing
+    This check looks for a network with a given name.
+    If such a network is existing the result is true else false.
+    LONGDESC
+    # Check if docker network is existing.
+    def network(network)
+      exit docker_container_check_network network
+    end
+
+    #
+    # docker container check orphaned
+    #
+    desc 'orphaned [CONTAINER]', 'Check if docker [CONTAINER] is orphaned'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check if docker container is orphaned
+    This check looks for a process which is started
+    when you log in to an takelage docker container.
+    If such a process is found the result is true else false.
+    LONGDESC
+    # Check if docker container is orphaned.
+    def orphaned(container)
+      exit docker_container_check_orphaned container
+    end
+  end
+end

data/lib/takelage/docker/container/check/existing.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# takelage docker container check existing
+module DockerContainerCheckExisting
+  # Backend method for docker container check existing.
+  # @return [Boolean] is container existing?
+  def docker_container_check_existing(container)
+    log.debug "Checking if container \"#{container}\" is existing"
+
+    return false unless docker_check_running
+
+    stdout_str = run _docker_container_cmd_check_existing container
+
+    if stdout_str.to_s.strip.empty?
+      log.debug "Container \"#{container}\" is not existing"
+      return false
+    end
+
+    log.debug "Container \"#{container}\" is existing"
+    true
+  end
+
+  private
+
+  def _docker_container_cmd_check_existing(container)
+    format(
+      config.active['cmd_docker_container_check_existing_docker_ps'],
+      container: container
+    )
+  end
+end

data/lib/takelage/docker/container/check/network.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# takelage docker container check network
+module DockerContainerCheckNetwork
+  # Backend method for docker container check network.
+  # @return [Boolean] is network existing?
+  def docker_container_check_network(network)
+    log.debug "Checking if network \"#{network}\" is existing"
+
+    return false unless docker_check_running
+
+    stdout_str = run _docker_container_cmd_check_network network
+
+    if stdout_str.to_s.strip.empty?
+      log.debug "Network \"#{network}\" is not existing"
+      return false
+    end
+
+    log.debug "Network \"#{network}\" is existing"
+    true
+  end
+
+  private
+
+  def _docker_container_cmd_check_network(network)
+    format(
+      config.active['cmd_docker_container_check_network_docker_network'],
+      network: network
+    )
+  end
+end

data/lib/takelage/docker/container/check/orphaned.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# takelage docker container check orphaned
+module DockerContainerCheckOrphaned
+  # Backend method for docker container check orphaned.
+  # @return [Boolean] is container orphaned?
+  def docker_container_check_orphaned(container)
+    log.debug "Check if container \"#{container}\" is orphaned"
+
+    return false unless docker_check_running
+
+    stdout_str = run _docker_container_cmd_check_orphaned container
+
+    if stdout_str.include? '/loginpoint.py'
+      log.debug "Container \"#{container}\" isn't orphaned"
+      return false
+    end
+
+    log.debug "Container \"#{container}\" is orphaned"
+    true
+  end
+
+  private
+
+  def _docker_container_cmd_check_orphaned(container)
+    format(
+      config.active['cmd_docker_container_check_orphaned_docker_exec'],
+      container: container
+    )
+  end
+end

data/lib/takelage/docker/container/clean.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# takelage docker container clean
+module DockerContainerClean
+  # Backend method for docker container clean.
+  def docker_container_clean
+    log.debug 'Removing all docker containers'
+
+    return false unless docker_check_running
+
+    return false if _docker_container_clean_harakiri?
+
+    networks = _docker_container_clean_kill_existing_containers
+    _docker_container_lib_remove_networks networks
+  end
+
+  private
+
+  # Check if we are running tau clean inside a takelage container
+  def _docker_container_clean_harakiri?
+    hostname = ENV['HOSTNAME'] || ''
+    return false unless hostname.start_with? "#{@docker_repo}_"
+
+    log.error "Please run \"tau clean\" outside of #{@docker_repo} containers"
+    log.info "Run \"tau prune\" to remove orphaned #{@docker_repo} containers"
+    true
+  end
+
+  # Kill all docker containers and return list of networks
+  def _docker_container_clean_kill_existing_containers
+    networks = []
+    _docker_container_lib_get_containers.each do |container|
+      name = _docker_container_lib_get_container_name_by_id container
+      _docker_container_lib_stop_container container
+      networks << name unless networks.include? name
+    end
+    networks
+  end
+end

data/lib/takelage/docker/container/cli.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage docker container
+  class DockerContainer < SubCommandBase
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerCheckRunning
+    include DockerContainerCheckExisting
+    include DockerContainerCheckNetwork
+    include DockerContainerCheckOrphaned
+    include DockerContainerLib
+    include DockerContainerCommand
+    include DockerContainerDaemon
+    include DockerContainerLogin
+    include DockerContainerClean
+    include DockerContainerPrune
+    include DockerImageTagLatestLocal
+    include DockerImageTagListLocal
+    include DockerImageTagCheckLocal
+    include DockerImageCheckOutdated
+    include DockerSocketLib
+    include DockerSocketHost
+    include DockerSocketScheme
+    include DockerSocketStart
+
+    # Initialize docker container
+    # rubocop:disable Metrics/AbcSize
+    def initialize(args = [], local_options = {}, configuration = {})
+      # initialize thor parent class
+      super args, local_options, configuration
+
+      @docker_user = config.active['docker_user']
+      @docker_repo = config.active['docker_repo']
+      @docker_tag = config.active['docker_tag']
+      @docker_registry = config.active['docker_registry']
+      @username = ENV['USER'] || 'noname'
+      @workdir = Dir.getwd
+      @hostname = "#{@docker_repo}_#{File.basename(@workdir)}"
+      @socket_host = docker_socket_host
+      @sockets = docker_socket_scheme
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    desc 'check [COMMAND]', 'Check docker container'
+    subcommand 'check', DockerContainerCheck
+
+    #
+    # docker container clean
+    #
+    desc 'clean', 'Remove all docker containers'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Remove all docker containers
+    LONGDESC
+    # Remove all docker containers.
+    def clean
+      docker_container_clean
+    end
+
+    #
+    # docker container command
+    #
+    desc 'command [CMD]', 'Run [CMD] in a docker container'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Run command in docker container
+    LONGDESC
+    # Run command in docker container.
+    def command(command)
+      docker_container_command(command)
+    end
+
+    #
+    # docker container daemon
+    #
+    desc 'daemon', 'Run docker container in daemon mode'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Run docker container in daemon mode
+    LONGDESC
+    # Run docker container in daemon mode.
+    def daemon
+      docker_container_daemon
+    end
+
+    #
+    # docker container login
+    #
+    option :debug,
+           aliases: 'd',
+           type: :boolean,
+           default: false,
+           desc: 'Log in to docker container in debug mode'
+    desc 'login', 'Log in to latest local docker container'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Log in to latest local docker container
+    LONGDESC
+    # Log in to latest local docker container.
+    def login
+      docker_container_login
+    end
+
+    #
+    # docker container prune
+    #
+    desc 'prune', 'Remove orphaned docker containers'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Remove orphaned docker containers
+    LONGDESC
+    # Remove orphaned docker containers.
+    def prune
+      docker_container_prune
+    end
+  end
+end

data/lib/takelage/docker/container/command.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# takelage docker container command
+module DockerContainerCommand
+  # Backend method for docker container command.
+  def docker_container_command(command)
+    log.debug 'Running command in container'
+
+    return false unless docker_check_running
+
+    docker_socket_start
+    return false unless _docker_container_lib_create_net_and_ctr @hostname
+
+    _docker_container_command_run_command @hostname, command
+  end
+
+  private
+
+  # Prepare run command in container command.
+  def _docker_container_command_run_command(container, command)
+    log.debug "Running command \"#{command}\" in container \"#{container}\""
+
+    cmd_docker_run_command =
+      format(
+        config.active['cmd_docker_container_docker_exec'],
+        container: container,
+        username: @username,
+        command: command
+      )
+
+    run_and_exit cmd_docker_run_command
+  end
+end

data/lib/takelage/docker/container/daemon.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# takelage docker container daemon
+module DockerContainerDaemon
+  # Backend method for docker container daemon.
+  def docker_container_daemon
+    log.debug 'Starting docker container as daemon'
+
+    return false unless docker_check_running
+
+    _docker_container_lib_create_net_and_ctr @hostname
+  end
+end

data/lib/takelage/docker/container/lib.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+# takelage docker container lib
+# rubocop:disable Metrics/ModuleLength
+module DockerContainerLib
+  private
+
+  # Create docker container and network.
+  # rubocop:disable Style/IfUnlessModifier
+  def _docker_container_lib_create_net_and_ctr(name)
+    unless docker_container_check_network name
+      _docker_container_lib_create_network name
+    end
+
+    return true if docker_container_check_existing name
+
+    _docker_container_lib_create_container name
+  end
+  # rubocop:enable Style/IfUnlessModifier
+
+  # Remove docker networks.
+  # rubocop:disable Style/IfUnlessModifier
+  def _docker_container_lib_remove_networks(networks)
+    networks.each do |network|
+      if docker_container_check_network network
+        _docker_container_lib_remove_network network
+      end
+    end
+  end
+  # rubocop:enable Style/IfUnlessModifier
+
+  # Create docker network.
+  def _docker_container_lib_create_network(network)
+    log.debug "Create network \"#{network}\""
+
+    cmd_create_network = format(
+      config.active['cmd_docker_container_create_network'],
+      network: network
+    )
+
+    run cmd_create_network
+  end
+
+  # Remove docker network.
+  def _docker_container_lib_remove_network(network)
+    log.debug "Remove network \"#{network}\""
+
+    cmd_remove_network = format(
+      config.active['cmd_docker_container_remove_network'],
+      network: network
+    )
+
+    run cmd_remove_network
+  end
+
+  # Create docker container.
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
+  # rubocop:disable Style/IfUnlessModifier
+  def _docker_container_lib_create_container(container)
+    log.debug "Creating container \"#{container}\""
+
+    image = "#{@docker_user}/#{@docker_repo}:#{@docker_tag}"
+
+    return false unless _docker_container_lib_image_available? image
+
+    log.debug "Using docker image \"#{image}\""
+
+    unless @socket_host == '127.0.0.1'
+      addhost = "--add-host host.docker.internal:#{@socket_host}"
+    end
+
+    docker_debug = config.active['docker_debug']
+    entrypoint = '/entrypoint.py '
+    volume_dev = ''
+    if options[:debug]
+      entrypoint = '/debug/entrypoint.py --debug '
+      volume_dev = "--volume #{@workdir}/#{docker_debug}:/debug "
+    end
+
+    cmd_docker_create = format(
+      config.active['cmd_docker_container_create'],
+      addhost: addhost,
+      container: container,
+      docker_run_options: config.active['docker_run_options'],
+      docker_daemon_port: config.active['docker_socket_docker_daemon_port'],
+      entrypoint: entrypoint,
+      entrypoint_options: config.active['docker_entrypoint_options'],
+      extra: config.active['docker_entrypoint_extra'],
+      gid: Etc.getpwnam(@username).gid,
+      gpg_agent_port: config.active['docker_socket_gpg_agent_port'],
+      gpg_ssh_agent_port: config.active['docker_socket_gpg_ssh_agent_port'],
+      homedir: ENV['HOME'] || '/tmp',
+      image: image,
+      shmsize: config.active['docker_shm_size'],
+      timezone: 'Europe/Berlin',
+      uid: Etc.getpwnam(@username).uid,
+      username: @username,
+      volume_dev: volume_dev,
+      workdir: @workdir
+    )
+
+    try cmd_docker_create
+  end
+  # rubocop:enable Style/IfUnlessModifier
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
+
+  # Check if docker image is available
+  def _docker_container_lib_image_available?(image)
+    return true if docker_image_tag_list_local.include? @docker_tag
+
+    log.error "No local image \"#{image}\" available"
+    log.info "Try: docker pull #{image}"
+    false
+  end
+
+  # Get container name by id.
+  def _docker_container_lib_get_container_name_by_id(container)
+    log.debug "Getting name of container \"#{container}\""
+
+    cmd_get_container_name_by_id = format(
+      config.active['cmd_docker_container_get_container_name'],
+      container: container
+    )
+
+    name = (run cmd_get_container_name_by_id).chomp
+
+    log.debug "Container #{container} has name \"#{name}\""
+
+    name
+  end
+
+  # Get all docker containers.
+  # @return [Array] list of docker containers
+  def _docker_container_lib_get_containers
+    log.debug "Getting all containers of image \"#{@docker_repo}\""
+
+    cmd_docker_get = format(
+      config.active['cmd_docker_container_get_containers'],
+      docker_repo: @docker_repo
+    )
+
+    # convert stdout lines to array and return array
+    (run cmd_docker_get).split(/\n+/)
+  end
+
+  # Stop container.
+  def _docker_container_lib_stop_container(container)
+    log.debug "Stopping container \"#{container}\""
+
+    cmd_docker_stop = format(
+      config.active['cmd_docker_container_stop_container'],
+      container: container
+    )
+
+    run cmd_docker_stop
+  end
+end
+# rubocop:enable Metrics/ModuleLength