takeltau 0.43.10 → 0.43.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e3cfcc5190c832bb598a7995d870a9ad8ffbd2d80cc27d40716a2c8f48234e9
-  data.tar.gz: 2329865f99624b7107046aeb8662ba7116e6ab2a5b92045f11a39bde8d38999a
+  metadata.gz: bffbfd83d32f80c65710d44484f6efc3ca2cd1aedecfd045c48acc7d7662476f
+  data.tar.gz: 49032edfaa569d46693240c6776aad04ce234ff8ffdc63fc2609d2f97b556c4b
 SHA512:
-  metadata.gz: c85f8b70f10c8982e88bb08bab002c22e5efdaa4dc8e4652ba87733ab9c0b8e34dd38923e402a8564de1a827fe487877b56733a19d7574f99f26a5d08f6419c4
-  data.tar.gz: b64fe24cc6176b74ebe52f7d6010103bf1b060cd411dacb59c207999839971379a38409e0d65b0947dbd30136af01c7f8841c329e74294203ef774770ef4bd32
+  metadata.gz: a3809662ed4e64854cf7324862816dd26c172da554e084d0d8504eff6a4a87d8bb177a082ce28ccb04c1e24350e13441a798dce667cf0472c4f73e1184190504
+  data.tar.gz: 73a636ac6b86704d68747ce8f278680df734289b5a429d38a37f4eb8ad8320df29866cbb0db13078f972e15f8d9264c8918962c9632e63bad92fe0efccf6240e

data/lib/takeltau/default.yml

@@ -1,6 +1,6 @@
 ---
 cmd_docker: 'docker'
-cmd_docker_check_daemon_docker_info: '%{docker} info'
+cmd_docker_check_daemon_docker_version: '%{docker} --version'
 cmd_docker_container_check_existing_docker_ps: '%{docker} ps --filter name=^%{container}$ --quiet'
 cmd_docker_container_check_network_docker_network: '%{docker} network ls --quiet --filter name=^%{network}$'
 cmd_docker_container_check_orphaned_docker_exec: '%{docker} exec --interactive %{container} ps a'
@@ -87,9 +87,11 @@ ship_takelship_yml: '%{pwd}/%{ship_data_dir}/compose/projects/takelship.yml'
 ship_podman_localhost: '127.0.0.1'
 ship_docker_host: '32375'
 ship_default_docker_host: '32375'
-cmd_ship_project_start_docker_run_nonprivileged: '%{docker} run --rm --interactive %{image} %{command}'
-cmd_ship_project_start_docker_run_privileged: '%{docker} run --privileged --rm --detach --name %{ship_hostname} --hostname %{ship_hostname} %{ship_env} %{ports} --volume ./%{ship_data_dir}:/home/podman/takelship %{image} %{command}'
-cmd_ship_project_start_docker_stop: '%{docker} stop %{ship_hostname}'
-cmd_ship_container_check_existing_docker_ps: '%{docker} ps --filter name=^%{ship_name}$ --quiet'
-cmd_ship_container_docker: '%{docker} exec --interactive %{tty} %{ship_hostname} %{command}'
+cmd_ship_docker: 'docker'
+cmd_ship_project_start_docker_run_nonprivileged: '%{ship_docker} run --rm --interactive %{image} %{command}'
+cmd_ship_project_start_docker_run_privileged: '%{ship_docker} run --privileged --rm --detach --name %{ship_hostname} --hostname %{ship_hostname} %{ship_env} %{ports} --volume ./%{ship_data_dir}:/home/podman/takelship %{image} %{command}'
+cmd_ship_project_start_docker_stop: '%{ship_docker} stop %{ship_hostname}'
+cmd_ship_container_check_existing_docker_ps: '%{ship_docker} ps --filter name=^%{ship_name}$ --quiet'
+cmd_ship_container_docker: '%{ship_docker} exec --interactive %{tty} %{ship_hostname} %{command}'
 cmd_ship_container_login: 'bash'
+cmd_docker_container_get_mounted_dir: '%{ship_docker} container inspect %{ship_hostname} --format "{{ (index .Mounts 0).Source }}"'

data/lib/takeltau/docker/check/daemon.rb

@@ -6,7 +6,7 @@ module DockerCheckDaemon
   # @return [Boolean] is the docker daemon running?
   # rubocop:disable Metrics/MethodLength
   # rubocop:disable Metrics/AbcSize
-  def docker_check_daemon
+  def docker_check_daemon(docker = 'cmd_docker')
     return true if @docker_daemon_running
 
     return false unless command_available_else_error? config.active['cmd_docker']
@@ -14,8 +14,8 @@ module DockerCheckDaemon
     log.debug 'Check if the docker daemon is running'
 
     cmd_docker_info = format(
-      config.active['cmd_docker_check_daemon_docker_info'],
-      docker: config.active['cmd_docker']
+      config.active['cmd_docker_check_daemon_docker_version'],
+      docker: config.active[docker]
     )
     status = try cmd_docker_info
 

data/lib/takeltau/docker/container/list.rb

@@ -2,7 +2,7 @@
 
 # tau docker container list
 module DockerContainerList
-  # Backend method for docker container prune.
+  # List docker containers.
   def docker_container_list
     log.debug 'List docker containers'
 

data/lib/takeltau/ship/cli.rb

@@ -25,6 +25,12 @@ module Takeltau
       Takeltau::SelfConfig.new.active
     end
 
+    desc 'list', 'Alias for tau ship container list'
+    # ship list: {Takeltau::ShipContainer#list}
+    def list
+      Takeltau::ShipContainer.new.list
+    end
+
     desc 'login', 'Alias for tau ship container login'
     # ship login: {Takeltau::ShipContainer#login}
     def login

data/lib/takeltau/ship/container/check/existing.rb

@@ -8,7 +8,7 @@ module ShipContainerCheckExisting
     ship_hostname = _ship_container_lib_ship_hostname
     log.debug "Checking if takelship \"#{ship_hostname}\" is existing"
 
-    return false unless docker_check_daemon
+    return false unless docker_check_daemon 'cmd_ship_docker'
 
     stdout_str = run _ship_container_cmd_check_existing ship_hostname
 
@@ -27,7 +27,7 @@ module ShipContainerCheckExisting
   def _ship_container_cmd_check_existing(ship_hostname)
     format(
       config.active['cmd_ship_container_check_existing_docker_ps'],
-      docker: config.active['cmd_docker'],
+      ship_docker: config.active['cmd_ship_docker'],
       ship_name: ship_hostname
     )
   end

data/lib/takeltau/ship/container/cli.rb

@@ -7,9 +7,11 @@ module Takeltau
     include SystemModule
     include ConfigModule
     include DockerCheckDaemon
+    include DockerContainerLib
     include ShipInfoLib
     include ShipContainerCheckExisting
     include ShipContainerLib
+    include ShipContainerList
     include ShipContainerLogin
     include ShipContainerPodman
     include ShipContainerUpdate
@@ -17,14 +19,26 @@ module Takeltau
     desc 'check [COMMAND]', 'Check takelship container'
     subcommand 'check', ShipContainerCheck
 
+    #
+    # ship container list
+    #
+    desc 'list', 'list command'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+      Run list command
+    LONGDESC
+    # Run list command.
+    def list
+      say ship_container_list
+    end
+
     #
     # ship container login
     #
-    desc 'login', 'Run login command'
+    desc 'login', 'Log in to a takelship'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-      Run login command
+      Log in to a takelship
     LONGDESC
-    # Run login command.
+    # Log in to a takelship.
     def login
       ship_container_login
     end

data/lib/takeltau/ship/container/lib.rb

@@ -6,11 +6,11 @@ module ShipContainerLib
 
   # Run nonprivileged docker command
   def _ship_container_lib_docker_nonprivileged(command)
-    return false unless docker_check_daemon
+    return false unless docker_check_daemon 'cmd_ship_docker'
 
     cmd_docker_run_command = format(
       config.active['cmd_ship_project_start_docker_run_nonprivileged'],
-      docker: config.active['cmd_docker'],
+      ship_docker: config.active['cmd_ship_docker'],
       image: _ship_container_lib_image,
       command: command
     )
@@ -21,7 +21,7 @@ module ShipContainerLib
   # rubocop:disable Metrics/AbcSize
   # rubocop:disable Metrics/MethodLength
   def _ship_container_lib_docker_privileged(ports, command)
-    return false unless docker_check_daemon
+    return false unless docker_check_daemon 'cmd_ship_docker'
 
     ship_data_dir = config.active['ship_data_dir']
     ship_env = config.active['ship_env']
@@ -29,7 +29,7 @@ module ShipContainerLib
     ports = config.active['ports'] unless config.active['ship_ports'].empty?
     cmd_docker_run_command = format(
       config.active['cmd_ship_project_start_docker_run_privileged'],
-      docker: config.active['cmd_docker'],
+      ship_docker: config.active['cmd_ship_docker'],
       ship_hostname: _ship_container_lib_ship_hostname,
       ship_env: ship_env,
       ports: ports,
@@ -39,16 +39,17 @@ module ShipContainerLib
     )
     run cmd_docker_run_command
   end
+
   # rubocop:enable Metrics/MethodLength
   # rubocop:enable Metrics/AbcSize
 
   # Run a docker command in a takelship container
   def _ship_container_lib_docker(command, tty = '--tty')
-    return false unless docker_check_daemon
+    return false unless docker_check_daemon 'cmd_ship_docker'
 
     cmd_docker_run_command = format(
       config.active['cmd_ship_container_docker'],
-      docker: config.active['cmd_docker'],
+      ship_docker: config.active['cmd_ship_docker'],
       ship_hostname: _ship_container_lib_ship_hostname,
       tty: tty,
       command: command
@@ -58,13 +59,13 @@ module ShipContainerLib
 
   # Run takelship docker stop command
   def _ship_container_lib_docker_stop
-    return false unless docker_check_daemon
+    return false unless docker_check_daemon 'cmd_ship_docker'
 
     return false unless ship_container_check_existing
 
     cmd_docker_stop_command = format(
       config.active['cmd_ship_project_start_docker_stop'],
-      docker: config.active['cmd_docker'],
+      ship_docker: config.active['cmd_ship_docker'],
       ship_hostname: _ship_container_lib_ship_hostname
     )
     run cmd_docker_stop_command
@@ -100,4 +101,36 @@ module ShipContainerLib
     end
     publish.join(' ')
   end
+
+  # Get all takelship containers.
+  # @return [Array] list of takelship containers
+  def _ship_container_lib_get_containers
+    ship_name = config.active['ship_name']
+    log.debug "Getting all #{ship_name} containers"
+
+    cmd_docker_get = format(
+      config.active['cmd_docker_container_get_containers'],
+      docker: config.active['cmd_docker'],
+      docker_repo: ship_name
+    )
+
+    # convert stdout lines to array and return array
+    (run cmd_docker_get).split(/\n+/)
+  end
+
+  # Get the mounted takelship directory
+  def _ship_container_lib_get_mounted_dir
+    ship_hostname = _ship_container_lib_ship_hostname
+    log.debug 'Getting mounted directory from ' \
+                "takelship container \"#{ship_hostname}\""
+
+    cmd_get_mounted_dir = format(
+      config.active['cmd_docker_container_get_mounted_dir'],
+      ship_docker: config.active['cmd_ship_docker'],
+      docker: config.active['cmd_ship_docker'],
+      ship_hostname: ship_hostname
+    )
+
+    run cmd_get_mounted_dir
+  end
 end

data/lib/takeltau/ship/container/list.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# tau ship container list
+module ShipContainerList
+  # List takelship containers.
+  def ship_container_list
+    log.debug 'List takelship containers'
+
+    return false unless docker_check_daemon 'cmd_ship_docker'
+
+    _ship_container_list_get_inventory.to_yaml
+  end
+
+  private
+
+  # Get the current inventory
+  def _ship_container_list_get_inventory
+    ship_name = config.active['ship_name']
+    inventory = _ship_container_list_new_inventory ship_name
+    _ship_container_lib_get_containers.each do |container|
+      name = _docker_container_lib_get_container_name_by_id container
+      dir = _ship_container_lib_get_mounted_dir.strip
+      inventory[ship_name]['hosts'] << { name => dir }
+    end
+    inventory
+  end
+
+  # Create a new inventory
+  def _ship_container_list_new_inventory(ship_name)
+    {
+      ship_name => {
+        'hosts' => []
+      }
+    }
+  end
+end

data/lib/takeltau/ship/container/login.rb

@@ -4,7 +4,7 @@
 module ShipContainerLogin
   # Run a login command in a takelship
   def ship_container_login
-    return false unless docker_check_daemon
+    return false unless docker_check_daemon 'cmd_ship_docker'
 
     return false unless ship_container_check_existing
 

data/lib/takeltau/ship/container/podman.rb

@@ -4,7 +4,7 @@
 module ShipContainerPodman
   # Run a podman command in a takelship
   def ship_container_podman(args)
-    return false unless docker_check_daemon
+    return false unless docker_check_daemon 'cmd_ship_docker'
 
     return false unless ship_container_check_existing
 

data/lib/takeltau/ship/container/update.rb

@@ -4,7 +4,7 @@
 module ShipContainerUpdate
   # Update takelship image.
   def ship_container_update
-    return false unless docker_check_daemon
+    return false unless docker_check_daemon 'cmd_ship_docker'
 
     cmd_docker_pull = _ship_container_update_cmd_docker_pull
 

data/lib/takeltau/ship/project/start.rb

@@ -4,7 +4,7 @@
 module ShipProjectStart
   # Start a takelship
   def ship_project_start(project)
-    return false unless docker_check_daemon
+    return false unless docker_check_daemon 'cmd_ship_docker'
 
     return false if _docker_container_lib_check_matrjoschka
 

data/lib/takeltau/version

@@ -1 +1 @@
-0.43.10
+0.43.15

data/lib/takeltau.rb

@@ -88,6 +88,7 @@ require_relative 'takeltau/ship/container/lib'
 require_relative 'takeltau/ship/container/check/existing'
 require_relative 'takeltau/ship/container/check/cli'
 require_relative 'takeltau/ship/info/lib'
+require_relative 'takeltau/ship/container/list'
 require_relative 'takeltau/ship/container/login'
 require_relative 'takeltau/ship/container/podman'
 require_relative 'takeltau/ship/container/update'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: takeltau
 version: !ruby/object:Gem::Version
-  version: 0.43.10
+  version: 0.43.15
 platform: ruby
 authors:
 - Takelwerk
@@ -290,6 +290,7 @@ files:
 - lib/takeltau/ship/container/check/existing.rb
 - lib/takeltau/ship/container/cli.rb
 - lib/takeltau/ship/container/lib.rb
+- lib/takeltau/ship/container/list.rb
 - lib/takeltau/ship/container/login.rb
 - lib/takeltau/ship/container/podman.rb
 - lib/takeltau/ship/container/update.rb