takelage 0.28.24 → 0.29.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a283a1e76877049cf7645c703c6bf2b17dcc3c7c13c1a5cac363441202f91b1
-  data.tar.gz: a53eb5c037d97b88d99e8bc4b9e9d5db17a2eb30b15fa993ac6a70924d5f9a36
+  metadata.gz: 0b28f6c30df4d3f1e62b9f8ad4c282a828eb186521b168bda7f79dfb9a2a483b
+  data.tar.gz: 6adc87395967eac65059df51f82140ee3b879fa19d869082924aaf44d04826b4
 SHA512:
-  metadata.gz: '05921e675c4136d159cf1e3e4e3774ea0e39a23bd4add0d4a0ce955b6e34806577ab63ddc9d14797799439e4abdde303b86471ef94c6a98ad24e196194e65416'
-  data.tar.gz: f0eb22800596daaefc3e6a8b2ccd9ea8df1d17e3ec547165bd795c98eedf06f02f310339406d6afb0164390b4fed7c88bc4b8b804b8f13c0db68f9665e33f3aa
+  metadata.gz: 68bfc3ff719f4fdbd300e38cded2a0379b78bad467259fd7f1b79b773d7137567ca22451f581a7c684070feaff6296c58e6c73ad4c9cdacbe793daf9019b98a6
+  data.tar.gz: c21632713ec979285748664c5076f20499bb2ac58efeda6f957c904421d21ee078bfc4a1e424c9e69ed38bf2f31dc52bf629276df4704f633e19a009e414c70d

data/README.md

@@ -90,10 +90,6 @@ tau [docker image tag check](features/cucumber/features/docker/docker.image.tag.
 tau [docker image tag latest](features/cucumber/features/docker/docker.image.tag.latest.feature) | Print latest local docker image tag
 tau [docker image tag list](features/cucumber/features/docker/docker.image.tag.list.feature) | Print local docker image tags
 tau [docker image update](features/cucumber/features/docker/docker.image.update.feature) | Get latest remote docker container
-tau [docker socket host](features/cucumber/features/docker/docker.socket.host.feature) | Print docker socket host ip address
-tau [docker socket scheme](features/cucumber/features/docker/docker.socket.scheme.feature) | Print docker socket scheme
-tau [docker socket start](features/cucumber/features/docker/docker.socket.start.feature) | Start sockets for docker container
-tau [docker socket stop](features/cucumber/features/docker/docker.socket.stop.feature) | Stop sockets for docker container
 tau [git check clean](features/cucumber/features/git/git.check.clean.feature) | Check if the git workspace is clean
 tau [git check main](features/cucumber/features/git/git.check.main.feature) | Check if we are on the git main branch
 tau [git check workspace](features/cucumber/features/git/git.check.workspace.feature) | Check if a git workspace exists
@@ -109,7 +105,7 @@ tau [info status mutagen](features/cucumber/features/info/info.status.mutagen.fe
 tau [info status ssh](features/cucumber/features/info/info.status.ssh.feature) | Check ssh status
 tau [mutagen check daemon](features/cucumber/features/mutagen/mutagen.check.daemon.feature)) | Check if mutagen host conenction is available
 tau [mutagen socket check](features/cucumber/features/mutagen/mutagen.socket.check.feature) [SOCKET] | Check if mutagen [SOCKET] exists
-tau [mutagen socket create](features/cucumber/features/mutagen/mutagen.socket.create.feature) [IN] [OUT] | Create a mutagen socket from [IN] to [OUT] of the container
+tau [mutagen socket create](features/cucumber/features/mutagen/mutagen.socket.create.feature) [NAME] [IN] [OUT] | Create a mutagen socket [NAME] from [IN] to [OUT] of the container
 tau [mutagen socket list](features/cucumber/features/mutagen/mutagen.socket.list.feature) | List mutagen sockets
 tau [mutagen socket tidy](features/cucumber/features/mutagen/mutagen.socket.tidy.feature) | Remove mutagen daemon files
 tau [mutagen socket terminate](features/cucumber/features/mutagen/mutagen.socket.terminate.feature) | Terminate a mutagen socket

data/lib/takelage.rb

@@ -45,17 +45,12 @@ require_relative 'takelage/bit/require/cli'
 require_relative 'takelage/bit/cli'
 require_relative 'takelage/completion/cli'
 require_relative 'takelage/mutagen/check/daemon'
+require_relative 'takelage/mutagen/socket/check'
 require_relative 'takelage/mutagen/socket/create'
 require_relative 'takelage/mutagen/socket/terminate'
 require_relative 'takelage/mutagen/socket/tidy'
 require_relative 'takelage/docker/check/daemon'
 require_relative 'takelage/docker/check/cli'
-require_relative 'takelage/docker/socket/lib'
-require_relative 'takelage/docker/socket/host'
-require_relative 'takelage/docker/socket/scheme'
-require_relative 'takelage/docker/socket/start'
-require_relative 'takelage/docker/socket/stop'
-require_relative 'takelage/docker/socket/cli'
 require_relative 'takelage/docker/image/tag/list'
 require_relative 'takelage/docker/image/tag/latest'
 require_relative 'takelage/docker/image/tag/check'
@@ -75,7 +70,6 @@ require_relative 'takelage/docker/container/prune'
 require_relative 'takelage/docker/container/cli'
 require_relative 'takelage/docker/cli'
 require_relative 'takelage/mutagen/check/cli'
-require_relative 'takelage/mutagen/socket/check'
 require_relative 'takelage/mutagen/socket/list'
 require_relative 'takelage/mutagen/socket/cli'
 require_relative 'takelage/mutagen/cli'
@@ -126,7 +120,9 @@ module Takelage
 
       # Set defaults
       @docker_daemon_running = false
-      @socat_command_available = false
+      @command_available_docker = false
+      @mutagen_daemon_available = false
+      @command_available_mutagen = false
 
       # fylla bash completion code
       @bash_fylla = Fylla.bash_completion self

data/lib/takelage/default.yml

@@ -33,7 +33,7 @@ cmd_docker_check_daemon_docker_info: 'docker info'
 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'
-cmd_docker_container_create: 'docker run --detach --env TAKELAGE_PROJECT_BASE_DIR=%{workdir} --env TZ=%{timezone} --hostname %{container} --name %{container} --network %{container} --rm --shm-size %{shmsize} --tty --volume %{dockersock}:/var/run/docker.sock --volume %{homedir}:/hostdir --volume %{workdir}:/project %{volume_dev} --workdir /project %{addhost} %{docker_run_options} %{image} %{entrypoint} --gid %{gid} --home %{homedir} --uid %{uid} --username %{username} --gpg_agent_port %{gpg_agent_port} --gpg_ssh_agent_port %{gpg_ssh_agent_port} --extra=%{extra} %{entrypoint_options}'
+cmd_docker_container_create: 'docker run --detach --env TAKELAGE_PROJECT_BASE_DIR=%{workdir} --env TZ=%{timezone} --hostname %{container} --name %{container} --network %{container} --rm --shm-size %{shmsize} --tty --volume %{dockersock}:/var/run/docker.sock --volume %{homedir}:/hostdir --volume %{workdir}:/project %{volume_dev} --workdir /project %{docker_run_options} %{image} %{entrypoint} --gid %{gid} --home %{homedir} --uid %{uid} --username %{username} --extra=%{extra} %{entrypoint_options}'
 cmd_docker_container_create_network: 'docker network create %{network}'
 cmd_docker_container_enter_container: 'docker exec --interactive --tty %{container} %{loginpoint} --username %{username}'
 cmd_docker_container_get_container_name: 'docker ps --filter id=%{container} --format "{{.Names}}"'
@@ -45,12 +45,6 @@ cmd_docker_image_tag_check_docker_images: 'docker images --quiet %{image}'
 cmd_docker_image_tag_list_docker_images: 'docker images %{docker_user}\/%{docker_repo} --format "{{.Tag}}"'
 cmd_docker_image_update_docker_pull_latest: 'docker pull %{docker_user}/%{docker_repo}:latest'
 cmd_docker_image_update_docker_remove_dangling: 'docker image prune --force'
-cmd_docker_socket_config_agent_socket_path: 'gpgconf --list-dirs agent-socket'
-cmd_docker_socket_config_agent_ssh_socket_path: 'gpgconf --list-dirs agent-ssh-socket'
-cmd_docker_socket_get_start: 'sudo socat TCP-LISTEN:%{port},bind=%{host},reuseaddr,fork UNIX-CLIENT:%{path}'
-cmd_docker_socket_start_sudo_true: 'sudo true'
-cmd_docker_socket_stop_docker_socket_ps: 'sudo ps a -o pid,command'
-cmd_docker_socket_stop_docker_socket_kill: 'sudo kill -SIGTERM %{pid}'
 cmd_git_check_clean_git_unstaged: 'git diff --exit-code'
 cmd_git_check_clean_git_uncommitted: 'git diff --cached --exit-code'
 cmd_git_check_clean_git_status: 'git status --porcelain'
@@ -65,6 +59,7 @@ cmd_info_status_gopass_root_store: 'gopass config | grep "path" | cut -d " " -f
 cmd_info_status_gpg_agent: 'gpg-connect-agent /bye'
 cmd_info_status_gpg_keys: 'gpg --list-keys'
 cmd_info_status_ssh_keys: 'ssh-add -l'
+cmd_info_status_ssh_socket: 'gpgconf --list-dirs agent-ssh-socket'
 cmd_mutagen_check_daemon_host_connection: 'mutagen forward list --label-selector="%{hostlabel}"'
 cmd_mutagen_check_daemon_version: 'mutagen version'
 cmd_mutagen_forward_socket_create: 'mutagen forward create --name=%{socketname} --label=%{hostlabel} --label=%{takellabel} docker://%{username}@%{container}:unix:%{containersock} unix:%{hostsock}'
@@ -79,12 +74,13 @@ docker_registry: 'https://registry.hub.docker.com'
 docker_repo: 'takelage'
 docker_run_options: '--env GOOGLE_APPLICATION_CREDENTIALS=/hostdir/.google/default.json'
 docker_shm_size: '512M'
-docker_socket_gpg_agent_port: 17874
-docker_socket_gpg_ssh_agent_port: 17875
 docker_tag: 'latest'
 docker_user: 'takelage'
 git_main_branch: 'main'
 info_project_main: 'project.yml'
 info_project_private: 'private/project.yml'
-mutagen_socket_path: '~/.mutagen/daemon/daemon.sock'
+login_wait_for_sockets: '0'
+mutagen_socket_path_mutagen: '~/.mutagen/daemon/daemon.sock'
+mutagen_socket_path_gpg: '~/.gnupg/S.gpg-agent'
+mutagen_socket_path_ssh: '~/.gnupg/S.gpg-agent.ssh'
 mutagen_socket_takelage_label: 'type=takelage-socket'

data/lib/takelage/docker/cli.rb

@@ -11,8 +11,5 @@ module Takelage
 
     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/cli.rb

@@ -19,11 +19,8 @@ module Takelage
     include DockerImageTagLatest
     include DockerImageTagList
     include DockerImageTagCheck
-    include DockerSocketLib
-    include DockerSocketHost
-    include DockerSocketScheme
-    include DockerSocketStart
     include MutagenCheckDaemon
+    include MutagenSocketCheck
     include MutagenSocketCreate
     include MutagenSocketTerminate
 
@@ -43,9 +40,9 @@ module Takelage
       @hostname = _docker_container_lib_hostname
       @hostlabel = "hostname=#{@hostname}"
       @takellabel = config.active['mutagen_socket_takelage_label']
-      @socket_host = docker_socket_host
-      @sockets = docker_socket_scheme
-      @mutagensock = config.active['mutagen_socket_path']
+      @mutagensock = config.active['mutagen_socket_path_mutagen']
+      @gpgsock = config.active['mutagen_socket_path_gpg']
+      @sshsock = config.active['mutagen_socket_path_ssh']
     end
     # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/AbcSize

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

@@ -8,10 +8,13 @@ module DockerContainerCommand
 
     return false unless docker_check_daemon
 
-    docker_socket_start
-    return false unless _docker_container_lib_create_net_and_ctr @hostname
+    # no matrjoschka test here
 
-    mutagen_socket_create @mutagensock, @mutagensock if mutagen_check_daemon
+    unless docker_container_check_existing @hostname
+      return false unless _docker_container_lib_create_net_and_ctr @hostname
+
+      _docker_container_lib_start_sockets
+    end
 
     _docker_container_command_run_command @hostname, command
   end

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

@@ -10,7 +10,7 @@ module DockerContainerDaemon
 
     result = _docker_container_lib_create_net_and_ctr @hostname
 
-    mutagen_socket_create @mutagensock, @mutagensock if mutagen_check_daemon
+    _docker_container_lib_start_sockets
 
     result
   end

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

@@ -6,6 +6,15 @@
 module DockerContainerLib
   private
 
+  # Create mutagen sockets
+  def _docker_container_lib_start_sockets
+    return false unless mutagen_check_daemon
+
+    mutagen_socket_create 'mutagen', @mutagensock, @mutagensock
+    mutagen_socket_create 'gpg', @gpgsock, @gpgsock
+    mutagen_socket_create 'ssh', @sshsock, @sshsock
+  end
+
   # Create unique docker hostname
   def _docker_container_lib_hostname
     relative_name = "#{@docker_repo}_#{File.basename(@workdir)}"
@@ -16,17 +25,12 @@ module DockerContainerLib
 
   # Create docker container and network.
   def _docker_container_lib_create_net_and_ctr(name)
-    if _docker_container_lib_check_matrjoschka
-      log.error 'You cannot log in to takelage from within takelage'
-      return false
-    end
+    return true if docker_container_check_existing 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
 
@@ -75,10 +79,6 @@ module DockerContainerLib
 
     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 = ''
@@ -89,7 +89,6 @@ module DockerContainerLib
 
     cmd_docker_create = format(
       config.active['cmd_docker_container_create'],
-      addhost: addhost,
       container: container,
       docker_run_options: config.active['docker_run_options'],
       dockersock: '/var/run/docker.sock',
@@ -97,8 +96,6 @@ module DockerContainerLib
       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'],
@@ -119,12 +116,12 @@ module DockerContainerLib
   def _docker_container_lib_check_matrjoschka
     log.debug 'Checking if we are already inside a takelage container'
 
-    return false unless ENV.keys.include? 'TAKELAGE_PROJECT_BASE_DIR'
-
-    log.debug 'We are already inside a takelage container'
+    unless ENV.keys.include? 'TAKELAGE_PROJECT_BASE_DIR'
+      log.debug 'We are not inside a takelage container'
+      return false
+    end
 
-    # wait or the github workflow will fail
-    sleep 1
+    log.debug 'We are inside a takelage container'
 
     true
   end

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

@@ -8,17 +8,30 @@ module DockerContainerLogin
 
     return false unless docker_check_daemon
 
-    docker_socket_start
+    if _docker_container_lib_check_matrjoschka
+      log.error 'You cannot log in to takelage from within takelage'
+      return false
+    end
 
-    return false unless _docker_container_lib_create_net_and_ctr @hostname
-
-    mutagen_socket_create @mutagensock, @mutagensock if mutagen_check_daemon
+    # rubocop:disable Style/IfUnlessModifier
+    unless docker_container_check_existing @hostname
+      _docker_container_login_create_container @hostname
+    end
+    # rubocop:enable Style/IfUnlessModifier
 
     run_and_exit _docker_container_login_enter_container @hostname
   end
 
   private
 
+  # Create container, network and forward sockets
+  def _docker_container_login_create_container(container)
+    return false unless _docker_container_lib_create_net_and_ctr container
+
+    _docker_container_lib_start_sockets
+    _docker_container_wait_for_sockets
+  end
+
   # Prepare enter existing container command.
   def _docker_container_login_enter_container(container)
     log.debug "Entering container \"#{container}\""
@@ -33,4 +46,13 @@ module DockerContainerLogin
       username: @username
     )
   end
+
+  # Wait for the sockets to come up
+  def _docker_container_wait_for_sockets
+    wait_for_sockets = config.active['login_wait_for_sockets'].to_i
+    return if wait_for_sockets.zero?
+
+    log.debug "Waiting for #{wait_for_sockets} #{pluralize(wait_for_sockets, 'second', 'seconds')}"
+    sleep wait_for_sockets
+  end
 end

data/lib/takelage/info/status/bar.rb

@@ -15,6 +15,7 @@ module InfoStatusBar
     _info_status_bar_git
     _info_status_bar_gopass
     _info_status_bar_gpg
+    _info_status_bar_mutagen
     _info_status_bar_ssh
 
     bar = @bar_list.join(' | ')
@@ -61,6 +62,11 @@ module InfoStatusBar
     @bar_list << ("gpg: #{info_status_gpg ? 'ok'.green : 'no'.red}")
   end
 
+  # Add mutagen status info to bar
+  def _info_status_bar_mutagen
+    @bar_list << ("mutagen: #{mutagen_check_daemon ? 'ok'.green : 'no'.red}")
+  end
+
   # Add ssh status info to bar
   def _info_status_bar_ssh
     @bar_list << ("ssh: #{info_status_ssh ? 'ok'.green : 'no'.red}")

data/lib/takelage/info/status/cli.rb

@@ -11,9 +11,6 @@ module Takelage
     include DockerContainerCheckNetwork
     include DockerContainerCommand
     include DockerContainerLib
-    include DockerSocketLib
-    include DockerSocketScheme
-    include DockerSocketStart
     include GitCheckWorkspace
     include InfoStatusLib
     include InfoStatusGit

data/lib/takelage/info/status/ssh.rb

@@ -9,7 +9,7 @@ module InfoStatusSSH
     log.debug 'Check ssh status'
 
     ssh_auth_sock = ENV['SSH_AUTH_SOCK']
-    gpg_ssh_socket = _socket_get_agent_ssh_socket_path
+    gpg_ssh_socket = _info_status_ssh_socket_path.chomp
 
     unless ssh_auth_sock == gpg_ssh_socket
       log.error 'ssh does not use gpg ssh socket'
@@ -33,6 +33,11 @@ module InfoStatusSSH
 
   private
 
+  # Get ssh socket path
+  def _info_status_ssh_socket_path
+    run config.active['cmd_info_status_ssh_socket']
+  end
+
   # Check ssh keys
   def _info_status_ssh_keys
     status_keys = try config.active['cmd_info_status_ssh_keys']

data/lib/takelage/lib/system.rb

@@ -77,6 +77,19 @@ module SystemModule
     stdout_str
   end
 
+  # Run a command and return the standard output
+  # the standard error and the exit status
+  # @return [[String, String, Integer]] array of
+  # stdout, stderr, exitstatus of command
+  def run_and_capture(command)
+    log.debug "Running amd capturing command \"#{command}\""
+    stdout_str, stderr_str, status = Open3.capture3 command
+    log.debug "Command \"#{command}\" has stdout:\n\"\"\"\n#{stdout_str}\"\"\""
+    log.debug "Command \"#{command}\" has stderr:\n\"\"\"\n#{stderr_str}\"\"\""
+    log.debug "Command \"#{command}\" has exit status: \"#{status.exitstatus}\""
+    [stdout_str, stderr_str, status.exitstatus]
+  end
+
   # Use Kernel#exec to replace the ruby process with a command.
   def run_and_exit(command)
     log.debug "Running command \"#{command}\" and exiting afterwards"
@@ -149,5 +162,12 @@ module SystemModule
     end
     true
   end
+
+  # Pluralize a verb in relation to a number
+  def pluralize(number, singular, plural)
+    return singular if number == 1
+
+    plural
+  end
 end
 # rubocop:enable Metrics/ModuleLength

data/lib/takelage/mutagen/check/cli.rb

@@ -11,9 +11,6 @@ module Takelage
     include DockerContainerCheckNetwork
     include DockerContainerCommand
     include DockerContainerLib
-    include DockerSocketLib
-    include DockerSocketScheme
-    include DockerSocketStart
     include MutagenCheckDaemon
 
     # Initialize mutagen check

data/lib/takelage/mutagen/check/daemon.rb

@@ -7,10 +7,12 @@ module MutagenCheckDaemon
   # rubocop:disable Metrics/MethodLength
   # rubocop:disable Metrics/AbcSize
   def mutagen_check_daemon
-    log.debug 'Check mutagen status'
+    return true if @mutagen_daemon_available
 
     return false unless command_available? 'mutagen'
 
+    log.debug 'Check mutagen status'
+
     # are we outside of a takelage container?
     unless _docker_container_lib_check_matrjoschka
       unless _mutagen_check_daemon_version
@@ -19,10 +21,11 @@ module MutagenCheckDaemon
       end
 
       log.debug 'The mutagen daemon is available'
+      @mutagen_daemon_available = true
       return true
     end
 
-    unless _file_exists? config.active['mutagen_socket_path']
+    unless _file_exists? config.active['mutagen_socket_path_mutagen']
       log.error 'The mutagen socket is not available'
       return false
     end
@@ -33,6 +36,7 @@ module MutagenCheckDaemon
     end
 
     log.debug 'The mutagen daemon is available'
+    @mutagen_daemon_available = true
     true
   end
   # rubocop:enable Metrics/AbcSize
@@ -41,14 +45,28 @@ module MutagenCheckDaemon
   private
 
   # Check mutagen host connection
+  # rubocop:disable Metrics/MethodLength
   def _mutagen_check_daemon_host_connection
     check_host_connection = format(
       config.active['cmd_mutagen_check_daemon_host_connection'],
       hostlabel: @hostlabel
     )
-    host_connection = try check_host_connection
-    host_connection.exitstatus.zero?
+    stdout, _, exitstatus = run_and_capture check_host_connection
+
+    unless exitstatus.zero?
+      log.debug 'There is no mutagen forward connection to the host'
+      return false
+    end
+
+    unless stdout.include? 'Status: Forwarding connections'
+      log.debug 'The mutagen forward connection to the host ' \
+        'is not forwarding connections'
+      return false
+    end
+
+    true
   end
+  # rubocop:enable Metrics/MethodLength
 
   # Check mutagen version
   def _mutagen_check_daemon_version

data/lib/takelage/mutagen/socket/cli.rb

@@ -11,9 +11,6 @@ module Takelage
     include DockerContainerCheckNetwork
     include DockerContainerCommand
     include DockerContainerLib
-    include DockerSocketLib
-    include DockerSocketScheme
-    include DockerSocketStart
     include DockerImageTagLatest
     include DockerImageTagList
     include DockerImageTagCheck
@@ -35,13 +32,9 @@ module Takelage
 
       inside = _docker_container_lib_check_matrjoschka
       @hostname = inside ? ENV['HOSTNAME'] : _docker_container_lib_hostname
-      # See DockerContainerLib::_docker_container_lib_hostname
-      @socketname = @hostname[-11..-1]
 
       @hostlabel = "hostname=#{@hostname}"
       @takellabel = config.active['mutagen_socket_takelage_label']
-
-      @sockets = docker_socket_scheme
     end
 
     #
@@ -59,13 +52,13 @@ module Takelage
     #
     # mutagen socket create
     #
-    desc 'create [IN] [OUT]', 'Create a mutagen socket from [IN] to [OUT] of the container'
+    desc 'create [NAME] [IN] [OUT]', 'Create a mutagen socket [NAME] from [IN] to [OUT] of the container'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Create a mutagen socket from [IN] to [OUT] of the container
+    Create a mutagen socket [NAME] from [IN] to [OUT] of the container
     LONGDESC
-    # Create a mutagen socket from [IN] to [OUT] of the container.
-    def create(containersock, hostsock)
-      exit mutagen_socket_create containersock, hostsock
+    # Create a mutagen socket [NAME] from [IN] to [OUT] of the container.
+    def create(name, containersock, hostsock)
+      exit mutagen_socket_create name, containersock, hostsock
     end
 
     #

data/lib/takelage/mutagen/socket/create.rb

@@ -3,31 +3,37 @@
 # takelage mutagen socket create
 module MutagenSocketCreate
   # Backend method for mutagen socket create.
-  def mutagen_socket_create(containersock, hostsock)
-    log.debug "Create the mutagen socket \"#{@socketname}\" in the container" \
+  # rubocop:disable Metrics/MethodLength
+  def mutagen_socket_create(name, containersock, hostsock)
+    # See DockerContainerLib::_docker_container_lib_hostname
+    socketname = "#{@hostname[-11..-1]}-#{name}"
+    log.debug "Create the mutagen socket \"#{socketname}\" in the container " \
       "at \"#{containersock}\" pointing to the host at \"#{hostsock}\""
 
     return false unless mutagen_check_daemon
 
-    socket_created = _mutagen_socket_create_socket(containersock, hostsock)
+    return false if mutagen_socket_check socketname
+
+    socket_created = _mutagen_socket_create_socket(socketname, containersock, hostsock)
 
     unless socket_created.include? 'Created session'
-      log.debug "Unable to create mutagen socket \"#{@socketname}\""
+      log.debug "Unable to create mutagen socket \"#{socketname}\""
       return false
     end
 
-    log.debug "Created the mutagen socket \"#{@socketname}\""
+    log.debug "Created the mutagen socket \"#{socketname}\""
     true
   end
+  # rubocop:enable Metrics/MethodLength
 
   private
 
   # Get git branch.
   # rubocop:disable Metrics/MethodLength
-  def _mutagen_socket_create_socket(containersock, hostsock)
+  def _mutagen_socket_create_socket(socketname, containersock, hostsock)
     cmd_create_socket = format(
       config.active['cmd_mutagen_forward_socket_create'],
-      socketname: @socketname,
+      socketname: socketname,
       containersock: containersock,
       hostsock: hostsock,
       username: @username,

data/lib/takelage/version

@@ -1 +1 @@
-0.28.24
+0.29.10

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: takelage
 version: !ruby/object:Gem::Version
-  version: 0.28.24
+  version: 0.29.10
 platform: ruby
 authors:
 - Geospin
@@ -245,12 +245,6 @@ files:
 - lib/takelage/docker/image/tag/latest.rb
 - lib/takelage/docker/image/tag/list.rb
 - lib/takelage/docker/image/update.rb
-- lib/takelage/docker/socket/cli.rb
-- lib/takelage/docker/socket/host.rb
-- lib/takelage/docker/socket/lib.rb
-- lib/takelage/docker/socket/scheme.rb
-- lib/takelage/docker/socket/start.rb
-- lib/takelage/docker/socket/stop.rb
 - lib/takelage/git/check/clean.rb
 - lib/takelage/git/check/cli.rb
 - lib/takelage/git/check/main.rb

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

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-module Takelage
-  # takelage docker socket
-  class DockerSocket < SubCommandBase
-    include LoggingModule
-    include SystemModule
-    include ConfigModule
-    include DockerCheckDaemon
-    include DockerSocketLib
-    include DockerSocketHost
-    include DockerSocketScheme
-    include DockerSocketStart
-    include DockerSocketStop
-
-    # Initialize docker socket
-    def initialize(args = [], local_options = {}, configuration = {})
-      # initialize thor parent class
-      super args, local_options, configuration
-
-      @socket_host = docker_socket_host
-      @sockets = docker_socket_scheme
-    end
-
-    #
-    # docker socket host
-    #
-    desc 'host', 'Print docker socket host ip address'
-    long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Print docker socket host ip address
-    LONGDESC
-    # Print docker socket host ip address.
-    def host
-      say @socket_host
-      true
-    end
-
-    #
-    # docker socket scheme
-    #
-    desc 'scheme', 'Print docker socket scheme'
-    long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Print docker socket scheme
-    LONGDESC
-    # Print docker socket scheme.
-    def scheme
-      say hash_to_yaml(@sockets)
-      true
-    end
-
-    #
-    # docker socket start
-    #
-    desc 'start', 'Start sockets for docker container'
-    long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Start sockets for docker container
-    LONGDESC
-    # Start sockets for docker container.
-    def start
-      exit docker_socket_start
-    end
-
-    #
-    # docker socket stop
-    #
-    desc 'stop', 'Stop sockets for docker container'
-    long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Stop sockets for docker container
-    LONGDESC
-    # Stop sockets for docker container.
-    def stop
-      exit docker_socket_stop
-    end
-  end
-end

data/lib/takelage/docker/socket/host.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-# takelage docker socket host
-module DockerSocketHost
-  # Backend method for docker socket host.
-  def docker_socket_host
-    log.debug 'Getting docker socket host ip address'
-
-    socket_host = _docker_socket_host_get_socket_host
-
-    log.debug "Docker socket host ip address is \"#{socket_host}\""
-
-    socket_host
-  end
-
-  private
-
-  # Get the socket host, i.e. the ip of the docker host.
-  def _docker_socket_host_get_socket_host
-    socket_host = '127.0.0.1'
-
-    addr_infos = Socket.getifaddrs
-
-    # if interface docker0 exists (== linux host)
-    # then return the ip address
-    addr_infos.each do |addr_info|
-      next unless (addr_info.name == 'docker0') && addr_info.addr.ipv4?
-
-      socket_host = addr_info.addr.ip_address
-    end
-
-    socket_host
-  end
-end

data/lib/takelage/docker/socket/lib.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-# takelage docker socket lib
-module DockerSocketLib
-  private
-
-  # Get socket start commands.
-  # sockets_up is a boolean which defines if the sockets need to be up
-  # to be included in the resulting array of socket start commands
-  def _docker_socket_lib_get_socket_start_commands(mode)
-    cmds_start_socket = []
-
-    # loop over sockets
-    @sockets.each do |socket, socket_config|
-      host = socket_config['host']
-      port = socket_config['port']
-      path = socket_config['path']
-
-      cmd = _docker_socket_lib_get_start_cmd(mode, socket, host, port, path)
-      cmds_start_socket.push cmd if cmd
-    end
-
-    cmds_start_socket
-  end
-
-  # Get socket start command.
-  def _docker_socket_lib_get_start_cmd(mode, socket, host, port, path)
-    if mode == 'start'
-      unless _docker_socket_lib_socket_up? socket, host, port, path
-        return _docker_socket_lib_start_cmd(host, port, path)
-      end
-    elsif _docker_socket_lib_socket_up? socket, host, port, path
-      return _docker_socket_lib_start_cmd(host, port, path)
-    end
-    nil
-  end
-
-  # Get socket start command.
-  def _docker_socket_lib_start_cmd(host, port, path)
-    format(
-      config.active['cmd_docker_socket_get_start'],
-      host: host,
-      port: port,
-      path: path
-    )
-  end
-
-  # Check if a socket is available by trying to connect to it via TCP.
-  def _docker_socket_lib_socket_up?(socket, host, port, path)
-    error_message = _docker_socket_lib_error_msg socket, host, port, path
-    begin
-      Timeout.timeout(1) do
-        _docker_socket_lib_socket_reachable? socket, host, port, error_message
-      end
-    rescue Timeout::Error
-      log.debug "Timeout: #{error_message}"
-      false
-    end
-  end
-
-  # Create error message.
-  def _docker_socket_lib_error_msg(socket, host, port, path)
-    'failed to connect to ' \
-        "socket \"#{socket}\" " \
-        "using host \"#{host}\", " \
-        "port \"#{port}\", " \
-        "path \"#{path}\""
-  end
-
-  # Test socket.
-  # rubocop:disable Metrics/MethodLength
-  def _docker_socket_lib_socket_reachable?(socket, host, port, error_message)
-    begin
-      s = TCPSocket.new host, port
-      s.close
-      log.debug "Socket \"#{socket}\" up"
-      return true
-    rescue Errno::ECONNREFUSED
-      log.debug "Connection refused: #{error_message}"
-    rescue Errno::EHOSTUNREACH
-      log.debug "Host unreachable: #{error_message}"
-    rescue SocketError
-      log.debug "Socket error: #{error_message}"
-    end
-    false
-  end
-  # rubocop:enable Metrics/MethodLength
-end

data/lib/takelage/docker/socket/scheme.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-# takelage docker socket scheme
-module DockerSocketScheme
-  # Backend method for docker socket scheme.
-  def docker_socket_scheme
-    log.debug 'Getting docker socket scheme'
-
-    gpg_path = _socket_get_agent_socket_path
-    gpg_port = config.active['docker_socket_gpg_agent_port']
-    ssh_path = _socket_get_agent_ssh_socket_path
-    ssh_port = config.active['docker_socket_gpg_ssh_agent_port']
-
-    socket_scheme = _socket_get_scheme gpg_path, gpg_port, ssh_path, ssh_port
-    log.debug 'Docker socket scheme is ' \
-      "\n\"\"\"\n#{hash_to_yaml socket_scheme}\"\"\""
-
-    socket_scheme
-  end
-
-  private
-
-  # Get gpg agent socket path.
-  def _socket_get_agent_socket_path
-    cmd_agent_socket_path =
-      config.active['cmd_docker_socket_config_agent_socket_path']
-    (run cmd_agent_socket_path).chomp
-  end
-
-  # Get gpg ssh agent socket path.
-  def _socket_get_agent_ssh_socket_path
-    cmd_agent_ssh_socket_path =
-      config.active['cmd_docker_socket_config_agent_ssh_socket_path']
-    (run cmd_agent_ssh_socket_path).chomp
-  end
-
-  # Create socket scheme.
-  def _socket_get_scheme(gpg_path, gpg_port, ssh_path, ssh_port)
-    { 'agent-socket' => { 'path' => gpg_path,
-                          'host' => @socket_host,
-                          'port' => gpg_port },
-      'agent-ssh-socket' => { 'path' => ssh_path,
-                              'host' => @socket_host,
-                              'port' => ssh_port } }
-  end
-end

data/lib/takelage/docker/socket/start.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-# takelage docker socket start
-module DockerSocketStart
-  # Backend method for docker socket start.
-  def docker_socket_start
-    log.debug 'Starting sockets for docker container'
-
-    return false unless docker_check_daemon
-
-    return false unless command_available? 'socat'
-
-    cmds_start_socket = _docker_socket_lib_get_socket_start_commands 'start'
-
-    return true if cmds_start_socket.empty?
-
-    _docker_socket_start_get_sudo
-
-    cmds_start_socket.each do |cmd_start_socket|
-      run_and_fork cmd_start_socket
-    end
-
-    true
-  end
-
-  private
-
-  # Get sudo.
-  def _docker_socket_start_get_sudo
-    log.debug 'Request sudo so that ' \
-      'subsequent background tasks run without delay'
-    cmd_sudo_true =
-      config.active['cmd_docker_socket_start_sudo_true']
-    run cmd_sudo_true
-  end
-end

data/lib/takelage/docker/socket/stop.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-# takelage docker socket stop
-module DockerSocketStop
-  # Backend method for docker socket stop.
-  def docker_socket_stop
-    log.debug 'Stopping sockets for docker container'
-
-    return false unless docker_check_daemon
-
-    return false unless command_available? 'socat'
-
-    # get process list
-    # assuming format: "pid command"
-    cmd_ps = config.active['cmd_docker_socket_stop_docker_socket_ps']
-
-    stdout_str = run cmd_ps
-
-    cmds_start_socket = _docker_socket_lib_get_socket_start_commands 'stop'
-
-    # loop over process list
-    stdout_str.split(/\n+/).each do |process|
-      _docker_socket_stop_kill_process process, cmds_start_socket
-    end
-
-    true
-  end
-
-  private
-
-  # Stop process.
-  def _docker_socket_stop_kill_process(process, cmds_start_socket)
-    # split processes in process id and process command
-    pid_command = process.chomp.split(/ /, 2)
-    pid = pid_command[0]
-    command = pid_command[1]
-
-    # loop over socket start commands
-    cmds_start_socket.each do |cmd_start_socket|
-      next unless command == cmd_start_socket
-
-      _docker_socket_stop_kill_pid pid
-    end
-  end
-
-  # Kill process.
-  def _docker_socket_stop_kill_pid(pid)
-    log.debug "Killing PID #{pid}"
-    cmd_kill =
-      format(
-        config.active['cmd_docker_socket_stop_docker_socket_kill'],
-        pid: pid
-      )
-    run cmd_kill
-  end
-end