takelage 0.13.2 → 0.13.3

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

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 # takelage docker container module
 module DockerContainerModule
-
   # Backend method for docker container run.
   def docker_container_command(command)
-    log.debug "Running command in container"
+    log.debug 'Running command in container'
 
     return false unless docker_check_running
 
@@ -11,9 +12,10 @@ module DockerContainerModule
 
     _create_network @hostname unless docker_container_check_network @hostname
 
-    container_created = true
-    container_created = _create_container @hostname unless docker_container_check_existing @hostname
-    return false unless container_created
+    unless docker_container_check_existing @hostname
+      return false unless _docker_container_create_container @hostname
+    end
+
     _run_command_in_container @hostname, command
   end
 
@@ -25,9 +27,11 @@ module DockerContainerModule
 
     _create_network @hostname unless docker_container_check_network @hostname
 
-    container_created = true
-    container_created = _create_container @hostname unless docker_container_check_existing @hostname
-    return false unless container_created
+    unless docker_container_check_existing @hostname
+      return false unless _docker_container_create_container @hostname
+    end
+
+    true
   end
 
   # Backend method for docker container login.
@@ -36,24 +40,17 @@ module DockerContainerModule
 
     return false unless docker_check_running
 
-    unless @docker_tag == 'latest'
-      outdated = docker_image_check_outdated @docker_tag
-      if outdated
-        tag_latest_remote = docker_image_tag_latest_remote
-        log.warn "#{@docker_user}/#{@docker_repo}:#{@docker_tag} is outdated"
-        log.warn "#{@docker_user}/#{@docker_repo}:#{tag_latest_remote} is available"
-      end
-    end
-
+    _docker_container_login_check_outdated
     docker_socket_start
-
     _create_network @hostname unless docker_container_check_network @hostname
 
-    container_created = true
-    container_created = _create_container @hostname unless docker_container_check_existing @hostname
-    return false unless container_created
+    unless docker_container_check_existing @hostname
+      return false unless _docker_container_create_container @hostname
+    end
+
+    cmd_enter_container = _docker_container_enter_container @hostname
 
-    _enter_container @hostname
+    run_and_exit cmd_enter_container
   end
 
   # Backend method for docker container nuke.
@@ -62,20 +59,9 @@ module DockerContainerModule
 
     return false unless docker_check_running
 
-    hostname = ENV['HOSTNAME'] || ''
-    if 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"
-      return false
-    end
-
-    networks = []
+    return false if _docker_container_harakiri?
 
-    _get_containers.each do |container|
-      name = _get_container_name_by_id container
-      _stop_container container
-      networks << name unless networks.include? name
-    end
+    networks = _docker_container_kill_existing_containers
 
     networks.each do |network|
       _remove_network network if docker_container_check_network network
@@ -88,39 +74,38 @@ module DockerContainerModule
 
     return false unless docker_check_running
 
-    networks = []
-
-    _get_containers.each do |container|
-      if docker_container_check_orphaned container
-        name = _get_container_name_by_id container
-        _stop_container container
-        networks << name unless networks.include? name
-      end
-    end
+    networks = _docker_container_kill_orphaned_containers
 
     networks.each do |network|
       _remove_network network if docker_container_check_network network
     end
   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
+
   # Create docker container.
-  def _create_container(container)
+  # rubocop:disable Metrics/MethodLength
+  def _docker_container_create_container(container)
     log.debug "Creating container \"#{container}\""
 
     image = "#{@docker_user}/#{@docker_repo}:#{@docker_tag}"
 
-    unless docker_image_tag_list_local.include? @docker_tag
-      log.error "No local image \"#{image}\" available"
-      return false
-    end
+    return false unless _docker_container_image_available? image
 
     log.debug "Using docker image \"#{image}\""
 
-    unless docker_image_tag_check_local @docker_tag
-      log.error "Image \"#{image}\" does not exist"
-      return false
-    end
-
     unless @socket_host == '127.0.0.1'
       addhost = "--add-host host.docker.internal:#{@socket_host}"
     end
@@ -128,74 +113,93 @@ module DockerContainerModule
     entrypoint = '/entrypoint.py '
     volume_dev = ''
     if options[:development]
-      entrypoint = '/debug/entrypoint.py --debug '
+      entrypoint += ' --debug '
       volume_dev = "--volume #{@workdir}/#{@docker_debug}:/debug "
     end
 
     cmd_docker_create =
-        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
-        }
+      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
+      )
 
     run cmd_docker_create
     true
   end
+  # rubocop:enable Metrics/MethodLength
+
+  # Check if docker image is available
+  def _docker_container_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
 
   # Create docker network.
   def _create_network(network)
     log.debug "Create network \"#{network}\""
 
     cmd_create_network =
-        config.active['cmd_docker_container_create_network'] % {
-            network: network
-        }
+      format(
+        config.active['cmd_docker_container_create_network'],
+        network: network
+      )
 
     run cmd_create_network
   end
 
   # Enter existing docker container.
-  def _enter_container(container)
+  def _docker_container_enter_container(container)
     log.debug "Entering container \"#{container}\""
 
-    loginpoint = '/loginpoint.py '
-    if options[:development]
-      loginpoint = '/loginpoint.py --debug '
-    end
+    loginpoint = '/loginpoint.py'
+    loginpoint += ' --debug ' if options[:development]
+
+    format(
+      config.active['cmd_docker_container_enter_container'],
+      container: container,
+      loginpoint: loginpoint,
+      username: @username
+    )
+  end
 
-    cmd_docker_enter =
-        config.active['cmd_docker_container_enter_container'] % {
-            container: container,
-            loginpoint: loginpoint,
-            username: @username
-        }
+  # Check if we are running tau nuke inside a takelage container
+  def _docker_container_harakiri?
+    hostname = ENV['HOSTNAME'] || ''
+    return false unless hostname.start_with? "#{@docker_repo}_"
 
-    run_and_exit cmd_docker_enter
+    log.error "Please run \"tau nuke\" outside of #{@docker_repo} containers"
+    log.info "Run \"tau purge\" to remove orphaned #{@docker_repo} containers"
+    true
   end
 
   # Get container name by id.
-  def _get_container_name_by_id container
+  def _docker_container_get_container_name_by_id(container)
     log.debug "Getting name of container \"#{container}\""
 
     cmd_get_container_name_by_id =
-        config.active['cmd_docker_container_get_container_name'] % {
-            container: container
-        }
+      format(
+        config.active['cmd_docker_container_get_container_name'],
+        container: container
+      )
 
     stdout_str = run cmd_get_container_name_by_id
 
@@ -208,13 +212,14 @@ module DockerContainerModule
 
   # Get all docker containers.
   # @return [Array] list of docker containers
-  def _get_containers
+  def _docker_container_get_containers
     log.debug "Getting all containers of image \"#{@docker_repo}\""
 
     cmd_docker_get =
-        config.active['cmd_docker_container_get_containers'] % {
-            docker_repo: @docker_repo
-        }
+      format(
+        config.active['cmd_docker_container_get_containers'],
+        docker_repo: @docker_repo
+      )
 
     stdout_str = run cmd_docker_get
 
@@ -222,14 +227,40 @@ module DockerContainerModule
     stdout_str.split(/\n+/)
   end
 
+  # Kill all docker containers and return list of networks
+  def _docker_container_kill_existing_containers
+    networks = []
+    _docker_container_get_containers.each do |container|
+      name = _docker_container_get_container_name_by_id container
+      _docker_container_stop_container container
+      networks << name unless networks.include? name
+    end
+    networks
+  end
+
+  # Kill orphaned docker containers and return list of networks
+  def _docker_container_kill_orphaned_containers
+    networks = []
+
+    _docker_container_get_containers.each do |container|
+      next unless docker_container_check_orphaned container
+
+      name = _docker_container_get_container_name_by_id container
+      _docker_container_stop_container container
+      networks << name unless networks.include? name
+    end
+    networks
+  end
+
   # Remove docker network.
-  def _remove_network network
+  def _remove_network(network)
     log.debug "Remove network \"#{network}\""
 
     cmd_remove_network =
-        config.active['cmd_docker_container_remove_network'] % {
-            network: network
-        }
+      format(
+        config.active['cmd_docker_container_remove_network'],
+        network: network
+      )
 
     run cmd_remove_network
   end
@@ -239,23 +270,25 @@ module DockerContainerModule
     log.debug "Running command \"#{command}\" in container \"#{container}\""
 
     cmd_docker_run_command =
-        config.active['cmd_docker_container_docker_exec'] % {
-            container: container,
-            username: @username,
-            command: command
-        }
+      format(
+        config.active['cmd_docker_container_docker_exec'],
+        container: container,
+        username: @username,
+        command: command
+      )
 
     run_and_exit cmd_docker_run_command
   end
 
   # Stop container.
-  def _stop_container(container)
+  def _docker_container_stop_container(container)
     log.debug "Stopping container \"#{container}\""
 
     cmd_docker_stop =
-        config.active['cmd_docker_container_stop_container'] % {
-            container: container
-        }
+      format(
+        config.active['cmd_docker_container_stop_container'],
+        container: container
+      )
 
     run cmd_docker_stop
   end

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

@@ -1,8 +1,8 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage docker image check
   class DockerImageCheck < SubCommandBase
-
     include LoggingModule
     include SystemModule
     include ConfigModule
@@ -13,7 +13,6 @@ module Takelage
 
     # Initialize takelage docker image check
     def initialize(args = [], local_options = {}, configuration = {})
-
       # initialize thor parent class
       super args, local_options, configuration
 

data/lib/takelage/docker/image/check/module.rb

@@ -1,27 +1,41 @@
+# frozen_string_literal: true
+
 # takelage docker image check module
 module DockerImageCheckModule
-
   # Backend method for docker image check outdated.
-  # @return [Boolean] is docker image tag older than latest remote docker image tag?
+  # @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"
 
     return false unless docker_check_running
 
-    if tag == 'latest'
-      log.debug "Docker image version \"latest\" is by definition never outdated"
-      return false
-    end
+    return false if _docker_outdated_tag_latest? tag
 
     tag_latest_remote = docker_image_tag_latest_remote
-    tags = [tag, tag_latest_remote]
-    outdated = tag != VersionSorter.sort(tags).last
+    tags = [tag, docker_image_tag_latest_remote]
+    outdated = (tag != VersionSorter.sort(tags).last)
 
-    if outdated
-      "Docker image version \"#{tag}\" is outdated"
-      "Docker image version \"#{tag_latest_remote}\" is available"
-    end
+    _docker_outdated_log_info tag, tag_latest_remote if outdated
 
     outdated
   end
+
+  # rubocop:enable Style/RedundantSort
+
+  private
+
+  # Check if the tag is "latest".
+  def _docker_outdated_tag_latest?(tag)
+    return false unless tag == 'latest'
+
+    log.debug 'Docker image version "latest" is by definition never outdated'
+    true
+  end
+
+  # Log info if docker image is outdated.
+  def _docker_outdated_log_info(tag, tag_latest_remote)
+    log.debug "Docker image version is outdated: #{tag}"
+    log.debug "Docker image version is available: #{tag_latest_remote}"
+  end
 end

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

@@ -1,8 +1,8 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage docker image
   class DockerImage < SubCommandBase
-
     include LoggingModule
     include SystemModule
     include ConfigModule
@@ -12,8 +12,7 @@ module Takelage
     include DockerImageModule
 
     # Initialize takelage docker image
-    def initialize(args=[], local_options={}, configuration={})
-
+    def initialize(args = [], local_options = {}, configuration = {})
       # initialize thor parent class
       super args, local_options, configuration
 

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

@@ -1,28 +1,33 @@
+# frozen_string_literal: true
+
 # takelage docker image module
 module DockerImageModule
-
   # Backend method for docker image update.
   def docker_image_update
     return false unless docker_check_running
 
     tags_remote = docker_image_tag_list_remote
 
-    if tags_remote.include? 'latest'
-      tag = 'latest'
-    else
-      tag = docker_image_tag_latest_remote
-    end
+    tag = 'latest'
+    tag = docker_image_tag_latest_remote unless tags_remote.include?('latest')
 
-    cmd_docker_pull_latest =
-        config.active['cmd_docker_image_update_docker_pull_latest'] % {
-            docker_user: @docker_user,
-            docker_repo: @docker_repo,
-            tag_latest_remote: tag
-        }
+    cmd_docker_pull_latest = _docker_image_update_cmd_docker_pull_latest tag
 
     cmd_docker_remove_dangling =
-        config.active['cmd_docker_image_update_docker_remove_dangling']
+      config.active['cmd_docker_image_update_docker_remove_dangling']
 
     run_and_exit "#{cmd_docker_pull_latest} && #{cmd_docker_remove_dangling}"
   end
-end
+
+  private
+
+  # Prepare dpcker pull latest command.
+  def _docker_image_update_cmd_docker_pull_latest(tag)
+    format(
+      config.active['cmd_docker_image_update_docker_pull_latest'],
+      docker_user: @docker_user,
+      docker_repo: @docker_repo,
+      tag_latest_remote: tag
+    )
+  end
+end

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

@@ -1,8 +1,8 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage docker image tag check
   class DockerImageTagCheck < SubCommandBase
-
     include LoggingModule
     include SystemModule
     include ConfigModule
@@ -12,7 +12,6 @@ module Takelage
 
     # Initialize takelage docker image tag check
     def initialize(args = [], local_options = {}, configuration = {})
-
       # initialize thor parent class
       super args, local_options, configuration
 

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

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 # takelage docker image tag check module
 module DockerImageTagCheckModule
-
   # Backend method for docker image check tag local.
   # @return [Boolean] does local docker image tag exist?
   def docker_image_tag_check_local(tag)
@@ -9,23 +10,13 @@ module DockerImageTagCheckModule
     return false unless docker_check_running
 
     if tag.to_s.strip.empty?
-      log.warn "No local docker image tag specified"
+      log.warn 'No local docker image tag specified'
       return false
     end
 
     image = "#{@docker_user}/#{@docker_repo}:#{tag}"
 
-    cmd_docker_images =
-        config.active['cmd_docker_image_tag_check_local_docker_images'] % {
-            image: image
-        }
-
-    stdout_str = run cmd_docker_images
-
-    if stdout_str.to_s.strip.empty?
-      log.debug "No local docker image \"#{image}\" found"
-      return false
-    end
+    return false unless _docker_image_check_local_image? image
 
     log.debug "Found local docker image \"#{image}\""
     true
@@ -38,21 +29,46 @@ module DockerImageTagCheckModule
 
     return false unless docker_check_running
 
-    if tag .to_s.strip.empty?
-      log.warn "No remote docker image tag specified"
+    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.
+  def _docker_image_check_local_image?(image)
+    cmd_docker_images =
+      format(
+        config.active['cmd_docker_image_tag_check_local_docker_images'],
+        image: image
+      )
+
+    if (run cmd_docker_images).to_s.strip.empty?
+      log.debug "No local docker image \"#{image}\" found"
+      return false
+    end
+
+    true
+  end
+
+  # Check if remote image exists.
+  def _docker_iamge_check_remote_image?(image, tag)
     tags = docker_image_tag_list_remote
 
-    unless tags != false and tags.include? tag
+    unless tags != false && tags.include?(tag)
       log.debug "No remote docker image \"#{image}\" found"
       return false
     end
 
-    log.debug "Found remote docker image \"#{image}\""
     true
   end
 end

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

@@ -1,8 +1,8 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage docker image tag
   class DockerImageTag < SubCommandBase
-
     desc 'check [COMMAND]', 'Check docker image tag'
     subcommand 'check', DockerImageTagCheck
 
@@ -11,6 +11,5 @@ module Takelage
 
     desc 'list [COMMAND]', 'Print local or remote docker image tags'
     subcommand 'list', DockerImageTagList
-
   end
 end

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

@@ -1,8 +1,8 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage docker image tag latest
   class DockerImageTagLatest < SubCommandBase
-
     include LoggingModule
     include SystemModule
     include ConfigModule
@@ -12,7 +12,6 @@ module Takelage
 
     # Initialize takelage docker image tag latest
     def initialize(args = [], local_options = {}, configuration = {})
-
       # initialize thor parent class
       super args, local_options, configuration