takelage 0.13.3 → 0.14.0

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,149 @@
+# frozen_string_literal: true
+
+# takelage docker container lib
+module DockerContainerLib
+  private
+
+  # Create docker container and network.
+  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
+
+  # Remove docker networks.
+  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
+
+  # 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
+  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
+
+    entrypoint = '/entrypoint.py '
+    volume_dev = ''
+    if options[:development]
+      entrypoint += ' --debug '
+      volume_dev = "--volume #{@workdir}/#{@docker_debug}:/debug "
+    end
+
+    cmd_docker_create = format(
+      config.active['cmd_docker_container_create'],
+      workdir: @workdir,
+      timezone: @timezone,
+      container: container,
+      dockersock: @dockersock,
+      homedir: @homedir,
+      volume_dev: volume_dev,
+      image: image,
+      addhost: addhost,
+      dockerrun_options: @dockerrun_options,
+      entrypoint: entrypoint,
+      gid: @gid,
+      uid: @uid,
+      username: @username,
+      gpg_agent_port: @gpg_agent_port,
+      gpg_ssh_agent_port: @gpg_ssh_agent_port,
+      extra: @entrypoint_extra,
+      entrypoint_options: @entrypoint_options
+    )
+
+    try cmd_docker_create
+  end
+
+  # 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

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# takelage docker container login
+module DockerContainerLogin
+  # Backend method for docker container login.
+  def docker_container_login
+    log.debug 'Logging in to docker container'
+
+    return false unless docker_check_running
+
+    _docker_container_login_check_outdated
+    docker_socket_start
+    return false unless _docker_container_lib_create_net_and_ctr @hostname
+
+    run_and_exit _docker_container_login_enter_container @hostname
+  end
+
+  private
+
+  # Check if newer docker container is available.
+  def _docker_container_login_check_outdated
+    return if @docker_tag == 'latest'
+
+    outdated = docker_image_check_outdated @docker_tag
+    return unless outdated
+
+    tag_latest = docker_image_tag_latest_remote
+    log.warn "#{@docker_user}/#{@docker_repo}:#{@docker_tag} is outdated"
+    log.warn "#{@docker_user}/#{@docker_repo}:#{tag_latest} is available"
+  end
+
+  # Prepare enter existing container command.
+  def _docker_container_login_enter_container(container)
+    log.debug "Entering container \"#{container}\""
+
+    loginpoint = '/loginpoint.py'
+    loginpoint += ' --debug ' if options[:development]
+
+    format(
+      config.active['cmd_docker_container_enter_container'],
+      container: container,
+      loginpoint: loginpoint,
+      username: @username
+    )
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# takelage docker container nuke
+module DockerContainerNuke
+  # Backend method for docker container nuke.
+  def docker_container_nuke
+    log.debug 'Removing all docker containers'
+
+    return false unless docker_check_running
+
+    return false if _docker_container_nuke_harakiri?
+
+    networks = _docker_container_nuke_kill_existing_containers
+    _docker_container_lib_remove_networks networks
+  end
+
+  private
+
+  # Check if we are running tau nuke inside a takelage container
+  def _docker_container_nuke_harakiri?
+    hostname = ENV['HOSTNAME'] || ''
+    return false unless hostname.start_with? "#{@docker_repo}_"
+
+    log.error "Please run \"tau nuke\" outside of #{@docker_repo} containers"
+    log.info "Run \"tau purge\" to remove orphaned #{@docker_repo} containers"
+    true
+  end
+
+  # Kill all docker containers and return list of networks
+  def _docker_container_nuke_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/purge.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# takelage docker container purge
+module DockerContainerPurge
+  # Backend method for docker container purge.
+  def docker_container_purge
+    log.debug 'Removing orphaned docker containers'
+
+    return false unless docker_check_running
+
+    networks = _docker_container_purge_kill_orphaned_containers
+    _docker_container_lib_remove_networks networks
+  end
+
+  private
+
+  # Kill orphaned docker containers and return list of networks
+  def _docker_container_purge_kill_orphaned_containers
+    networks = []
+
+    _docker_container_lib_get_containers.each do |container|
+      next unless docker_container_check_orphaned 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/image/check/cli.rb

@@ -6,10 +6,10 @@ module Takelage
     include LoggingModule
     include SystemModule
     include ConfigModule
-    include DockerCheckModule
-    include DockerImageTagListModule
-    include DockerImageTagLatestModule
-    include DockerImageCheckModule
+    include DockerCheckRunning
+    include DockerImageTagListRemote
+    include DockerImageTagLatestRemote
+    include DockerImageCheckOutdated
 
     # Initialize takelage docker image check
     def initialize(args = [], local_options = {}, configuration = {})

data/lib/takelage/docker/image/check/{module.rb → outdated.rb}

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
-# takelage docker image check module
-module DockerImageCheckModule
+# takelage docker image check outdated
+module DockerImageCheckOutdated
   # Backend method for docker image check outdated.
   # @return [Boolean] is docker image tag older than latest remote image tag?
-  # rubocop:disable Style/RedundantSort
   def docker_image_check_outdated(tag)
     log.debug "Check if docker image version \"#{tag}\" is outdated"
 
@@ -14,15 +13,15 @@ module DockerImageCheckModule
 
     tag_latest_remote = docker_image_tag_latest_remote
     tags = [tag, docker_image_tag_latest_remote]
+    # rubocop:disable Style/RedundantSort
     outdated = (tag != VersionSorter.sort(tags).last)
+    # rubocop:enable Style/RedundantSort
 
     _docker_outdated_log_info tag, tag_latest_remote if outdated
 
     outdated
   end
 
-  # rubocop:enable Style/RedundantSort
-
   private
 
   # Check if the tag is "latest".

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

@@ -6,10 +6,10 @@ module Takelage
     include LoggingModule
     include SystemModule
     include ConfigModule
-    include DockerCheckModule
-    include DockerImageTagListModule
-    include DockerImageTagLatestModule
-    include DockerImageModule
+    include DockerCheckRunning
+    include DockerImageTagListRemote
+    include DockerImageTagLatestRemote
+    include DockerImageUpdate
 
     # Initialize takelage docker image
     def initialize(args = [], local_options = {}, configuration = {})

data/lib/takelage/docker/image/tag/check/cli.rb

@@ -6,9 +6,10 @@ module Takelage
     include LoggingModule
     include SystemModule
     include ConfigModule
-    include DockerCheckModule
-    include DockerImageTagListModule
-    include DockerImageTagCheckModule
+    include DockerCheckRunning
+    include DockerImageTagListRemote
+    include DockerImageTagCheckLocal
+    include DockerImageTagCheckRemote
 
     # Initialize takelage docker image tag check
     def initialize(args = [], local_options = {}, configuration = {})

data/lib/takelage/docker/image/tag/check/{module.rb → local.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-# takelage docker image tag check module
-module DockerImageTagCheckModule
+# takelage docker image tag check local
+module DockerImageTagCheckLocal
   # Backend method for docker image check tag local.
   # @return [Boolean] does local docker image tag exist?
   def docker_image_tag_check_local(tag)
@@ -22,26 +22,6 @@ module DockerImageTagCheckModule
     true
   end
 
-  # Backend method for docker image check tag remote.
-  # @return [Boolean] does remote docker image tag exist?
-  def docker_image_tag_check_remote(tag)
-    log.debug "Check if remote image tag \"#{tag}\" exists"
-
-    return false unless docker_check_running
-
-    if tag.to_s.strip.empty?
-      log.warn 'No remote docker image tag specified'
-      return false
-    end
-
-    image = "#{@docker_user}/#{@docker_repo}:#{tag}"
-
-    return false unless _docker_iamge_check_remote_image? image, tag
-
-    log.debug "Found remote docker image \"#{image}\""
-    true
-  end
-
   private
 
   # Check if local image exists.
@@ -59,16 +39,4 @@ module DockerImageTagCheckModule
 
     true
   end
-
-  # Check if remote image exists.
-  def _docker_iamge_check_remote_image?(image, tag)
-    tags = docker_image_tag_list_remote
-
-    unless tags != false && tags.include?(tag)
-      log.debug "No remote docker image \"#{image}\" found"
-      return false
-    end
-
-    true
-  end
 end