takelage 0.18.1

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/loginpoint.py --debug ' if options[:debug]
+
+    format(
+      config.active['cmd_docker_container_enter_container'],
+      container: container,
+      loginpoint: loginpoint,
+      username: @username
+    )
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# takelage docker container prune
+module DockerContainerPrune
+  # Backend method for docker container prune.
+  def docker_container_prune
+    log.debug 'Removing orphaned docker containers'
+
+    return false unless docker_check_running
+
+    networks = _docker_container_prune_kill_orphaned_containers
+    _docker_container_lib_remove_networks networks
+  end
+
+  private
+
+  # Kill orphaned docker containers and return list of networks
+  def _docker_container_prune_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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage docker image check
+  class DockerImageCheck < SubCommandBase
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerCheckRunning
+    include DockerImageTagListRemote
+    include DockerImageTagLatestRemote
+    include DockerImageCheckOutdated
+
+    # Initialize takelage docker image check
+    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_registry = config.active['docker_registry']
+      @docker_tag = config.active['docker_tag']
+    end
+
+    #
+    # docker image check outdated
+    #
+    desc 'outdated', 'Check if a docker image is outdated'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check if a docker image is outdated
+    LONGDESC
+    # Check if a docker image is outdated.
+    def outdated
+      outdated = docker_image_check_outdated @docker_tag
+      say "Your takelage version \"#{@docker_tag}\" is outdated" if outdated
+      exit outdated
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# 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?
+  def docker_image_check_outdated(tag)
+    log.debug "Check if docker image version \"#{tag}\" is outdated"
+
+    return false unless docker_check_running
+
+    return false if _docker_outdated_tag_latest? tag
+
+    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
+
+  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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage docker image
+  class DockerImage < SubCommandBase
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerCheckRunning
+    include DockerImageTagListRemote
+    include DockerImageTagLatestRemote
+    include DockerImageUpdate
+
+    # Initialize takelage docker image
+    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_registry = config.active['docker_registry']
+    end
+
+    desc 'check [COMMAND]', 'Check docker image'
+    subcommand 'check', DockerImageCheck
+
+    desc 'tag [COMMAND]', 'Handle docker image tags'
+    subcommand 'tag', DockerImageTag
+
+    #
+    # docker image update
+    #
+    desc 'update', 'Get latest remote docker container'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Get latest remote docker container
+    This command will download the latest remote version of the takelage docker container.
+    When you start the environment the latest locally available container will be used.
+    LONGDESC
+    # Get latest remote docker container.
+    def update
+      exit docker_image_update
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage docker image tag check
+  class DockerImageTagCheck < SubCommandBase
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerCheckRunning
+    include DockerImageTagListRemote
+    include DockerImageTagCheckLocal
+    include DockerImageTagCheckRemote
+
+    # Initialize takelage docker image tag check
+    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_registry = config.active['docker_registry']
+    end
+
+    #
+    # docker image tag check local
+    #
+    desc 'local [TAG]', 'Check if local docker image [TAG] exists'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check if local docker image tag exists
+    LONGDESC
+    # Check if local docker image tag exists.
+    def local(tag)
+      exit docker_image_tag_check_local tag
+    end
+
+    #
+    # docker image tag check remote
+    #
+    desc 'remote [TAG]', 'Check if remote docker image [TAG] exists'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check if remote docker image tag exists
+    LONGDESC
+    # Check if remote docker image tag exists.
+    def remote(tag)
+      exit docker_image_tag_check_remote tag
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# 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)
+    log.debug "Check if local docker image tag \"#{tag}\" exists"
+
+    return false unless docker_check_running
+
+    if tag.to_s.strip.empty?
+      log.warn 'No local docker image tag specified'
+      return false
+    end
+
+    image = "#{@docker_user}/#{@docker_repo}:#{tag}"
+
+    return false unless _docker_image_check_local_image? image
+
+    log.debug "Found local 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
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# takelage docker image tag check remote
+module DockerImageTagCheckRemote
+  # 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 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

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

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

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage docker image tag latest
+  class DockerImageTagLatest < SubCommandBase
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerCheckRunning
+    include DockerImageTagListLocal
+    include DockerImageTagListRemote
+    include DockerImageTagLatestLocal
+    include DockerImageTagLatestRemote
+
+    # Initialize takelage docker image tag latest
+    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_registry = config.active['docker_registry']
+    end
+
+    #
+    # docker image tag latest local
+    #
+    desc 'local', 'Print latest local docker image tag'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print latest local docker image tag
+    Print the tag of the local docker image with the highest tag.
+    LONGDESC
+    # Print latest local docker image tag.
+    def local
+      tag_latest_local = docker_image_tag_latest_local
+      exit false if tag_latest_local == false
+      say tag_latest_local
+      true
+    end
+
+    #
+    # docker image tag latest remote
+    #
+    desc 'remote', 'Print latest remote docker image tag'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print latest remote docker image tag
+    Print the tag of the remote docker image with the highest tag.
+    LONGDESC
+    # Print latest remote docker image tag.
+    def remote
+      tag_latest_remote = docker_image_tag_latest_remote
+      exit false if tag_latest_remote == false
+      say tag_latest_remote
+      true
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# takelage docker image tag latest local
+module DockerImageTagLatestLocal
+  # Backend method for docker image tag latest local.
+  # @return [String] latest local docker image tag
+  def docker_image_tag_latest_local
+    log.debug 'Getting latest local docker image tag'
+
+    return false unless docker_check_running
+
+    tags = docker_image_tag_list_local
+
+    tag_latest_local = tags[-1]
+
+    log.debug "Latest docker local tag: #{tag_latest_local}"
+
+    tag_latest_local
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# takelage docker image tag latest remote
+module DockerImageTagLatestRemote
+  # Backend method for docker image tag latest remote.
+  # @return [String] latest remote docker image tag
+  def docker_image_tag_latest_remote
+    log.debug 'Getting latest remote docker image tag'
+
+    return false unless docker_check_running
+
+    tags = docker_image_tag_list_remote
+
+    if tags == false || tags.nil?
+      log.warn 'No latest docker remote tag'
+      return ''
+    end
+
+    tag_latest_remote = tags[-1]
+
+    log.debug "Latest docker remote tag: #{tag_latest_remote}"
+
+    tag_latest_remote
+  end
+end