takelage 0.27.1 → 0.28.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 689104aead67286437fded2a138c0a043f9eb9604a7a44375df45a5f9d66de68
-  data.tar.gz: 91fe52a44bfc3025b284ae155879a1c5d948a34baba5fc2a903c376c8996062e
+  metadata.gz: c9cbafaa5bcc3f8d74cf010208562a6a117e2051878031c723591ab3b11ec382
+  data.tar.gz: '087322623aab1f24da511744d2e5f28377077593bc48e10c433ac7f8406c413b'
 SHA512:
-  metadata.gz: 948586185c0cf2b448d3ad14d49c80742e73e5517d545cbd951908d062ceb2a1aec0e2404c86deec18e8b916c597dc246e2129b21e165986ed5cb55b367f1c89
-  data.tar.gz: 82c8e74a3e9673707f0ca2ce1cb865e73bff2282208ac0d76b8ba21eed04e6cefc07b84080faeaafa10bd34e324beafb2e5537ebd7a6a6e809e40dd0342bad43
+  metadata.gz: 5998e3c792f0173950380450329100d039802219b48d7b1d88f07985a3df6f3510f30943a7becbd78a966837a93a0927ae30cc8e32b940e785952b10094e7708
+  data.tar.gz: 8ec3aa7a7fb9737915ee4cbbeb541483aa2cb97871423f415df66213675fc86d7ba24c45bc53d4b666360397e5265f48a896bb9506aa127ab9470e4f98fb8af5

data/README.md

@@ -102,11 +102,15 @@ tau [info project active](features/cucumber/features/info/info.project.active.fe
 tau [info project dir](features/cucumber/features/info/info.project.dir.feature) | Print project root directory
 tau [info project main](features/cucumber/features/info/info.project.main.feature) | Print main project info
 tau [info project private](features/cucumber/features/info/info.project.private.feature) | Print private project info
-tau [info status git](features/cucumber/features/info/info.status.git.feature) | Check git status info
-tau [info status gopass](features/cucumber/features/info/info.status.gopass.feature) | Check gopass status info
-tau [info status gpg](features/cucumber/features/info/info.status.gpg.feature) | Check gpg status info
-tau [info status bar](features/cucumber/features/info/info.status.bar.feature) | Print status info bar
-tau [info status ssh](features/cucumber/features/info/info.status.ssh.feature) | Check ssh status info
+tau [info status bar](features/cucumber/features/info/info.status.bar.feature) | Print status bar
+tau [info status git](features/cucumber/features/info/info.status.git.feature) | Check git status
+tau [info status gopass](features/cucumber/features/info/info.status.gopass.feature) | Check gopass status
+tau [info status gpg](features/cucumber/features/info/info.status.gpg.feature) | Check gpg status
+tau [info status ssh](features/cucumber/features/info/info.status.ssh.feature) | Check ssh status
+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 list](features/cucumber/features/mutagen/mutagen.socket.list.feature) | List mutagen sockets
+tau [mutagen socket terminate](features/cucumber/features/mutagen/mutagen.socket.terminate.feature) | Terminate a mutagen socket
 tau [self config active](features/cucumber/features/self/self.config.active.feature) | Print active takelage configuration
 tau [self config default](features/cucumber/features/self/self.config.default.feature) | Print takelage default configuration
 tau [self config home](features/cucumber/features/self/self.config.home.feature) | Print takelage home config file configuration

data/lib/takelage.rb

@@ -59,6 +59,8 @@ require_relative 'takelage/docker/image/tag/check'
 require_relative 'takelage/docker/image/tag/cli'
 require_relative 'takelage/docker/image/update'
 require_relative 'takelage/docker/image/cli'
+require_relative 'takelage/mutagen/socket/create'
+require_relative 'takelage/mutagen/socket/terminate'
 require_relative 'takelage/docker/container/check/existing'
 require_relative 'takelage/docker/container/check/network'
 require_relative 'takelage/docker/container/check/orphaned'
@@ -80,6 +82,10 @@ require_relative 'takelage/info/status/bar'
 require_relative 'takelage/info/status/cli'
 require_relative 'takelage/info/project/cli'
 require_relative 'takelage/info/cli'
+require_relative 'takelage/mutagen/socket/check'
+require_relative 'takelage/mutagen/socket/list'
+require_relative 'takelage/mutagen/socket/cli'
+require_relative 'takelage/mutagen/cli'
 require_relative 'takelage/self/config/cli'
 require_relative 'takelage/self/list'
 require_relative 'takelage/self/cli'
@@ -143,6 +149,9 @@ module Takelage
     desc 'info [COMMAND] ', 'Get information'
     subcommand 'info', Info
 
+    desc 'mutagen [COMMAND] ', 'Manage mutagen'
+    subcommand 'mutagen', Mutagen
+
     desc 'self [COMMAND] ', 'Manage takelage tools'
     subcommand 'self', Self
 

data/lib/takelage/default.yml

@@ -66,6 +66,11 @@ 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_mutagen_forward_socket_create: 'mutagen forward create --name=%{socketname} --label=%{hostlabel} --label=%{takellabel} docker://%{username}@%{container}:unix:%{containersock} unix:%{hostsock}'
+cmd_mutagen_forward_socket_check: 'mutagen forward list %{socketname}'
+cmd_mutagen_forward_socket_terminate: 'mutagen forward terminate %{socketname}'
+cmd_mutagen_forward_socket_remove: 'rm -f ~/.mutagen/daemon/*'
+cmd_mutagen_forward_socket_list: 'mutagen forward list --label-selector="%{takellabel}"'
 docker_debug: 'ansible/roles/takel-takelage/files/takelscripts'
 docker_entrypoint_extra: '.config/gcloud'
 docker_entrypoint_options: ''

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

@@ -12,6 +12,7 @@ module DockerContainerClean
 
     networks = _docker_container_clean_kill_existing_containers
     _docker_container_lib_remove_networks networks
+    mutagen_socket_terminate @takellabel
   end
 
   private

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

@@ -24,9 +24,12 @@ module Takelage
     include DockerSocketHost
     include DockerSocketScheme
     include DockerSocketStart
+    include MutagenSocketCreate
+    include MutagenSocketTerminate
 
     # Initialize docker container
     # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     def initialize(args = [], local_options = {}, configuration = {})
       # initialize thor parent class
       super args, local_options, configuration
@@ -38,9 +41,12 @@ module Takelage
       @username = ENV['USER'] || 'noname'
       @workdir = Dir.getwd
       @hostname = _docker_container_lib_hostname
+      @hostlabel = "hostname=#{@hostname}"
+      @takellabel = 'type=takelage-socket'
       @socket_host = docker_socket_host
       @sockets = docker_socket_scheme
     end
+    # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/AbcSize
 
     desc 'check [COMMAND]', 'Check docker container'

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

@@ -11,6 +11,8 @@ module DockerContainerCommand
     docker_socket_start
     return false unless _docker_container_lib_create_net_and_ctr @hostname
 
+    mutagen_socket_create '~/.mutagen/daemon/daemon.sock', '~/.mutagen/daemon/daemon.sock'
+
     _docker_container_command_run_command @hostname, command
   end
 

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

@@ -8,6 +8,10 @@ module DockerContainerDaemon
 
     return false unless docker_check_daemon
 
-    _docker_container_lib_create_net_and_ctr @hostname
+    result = _docker_container_lib_create_net_and_ctr @hostname
+
+    mutagen_socket_create '~/.mutagen/daemon/daemon.sock', '~/.mutagen/daemon/daemon.sock'
+
+    result
   end
 end

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

@@ -16,7 +16,10 @@ module DockerContainerLib
 
   # Create docker container and network.
   def _docker_container_lib_create_net_and_ctr(name)
-    return false if _docker_container_lib_check_matrjoschka
+    if _docker_container_lib_check_matrjoschka
+      log.error 'You cannot log in to takelage from within takelage'
+      return false
+    end
 
     unless docker_container_check_network name
       _docker_container_lib_create_network name
@@ -108,6 +111,7 @@ module DockerContainerLib
 
     try cmd_docker_create
   end
+
   # rubocop:enable Metrics/AbcSize
   # rubocop:enable Metrics/MethodLength
 
@@ -117,7 +121,7 @@ module DockerContainerLib
 
     return false unless ENV.keys.include? 'TAKELAGE_PROJECT_BASE_DIR'
 
-    log.error 'You cannot log in to takelage from within takelage'
+    log.debug 'We are already inside a takelage container'
 
     # wait or the github workflow will fail
     sleep 1

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

@@ -9,8 +9,11 @@ module DockerContainerLogin
     return false unless docker_check_daemon
 
     docker_socket_start
+
     return false unless _docker_container_lib_create_net_and_ctr @hostname
 
+    mutagen_socket_create '~/.mutagen/daemon/daemon.sock', '~/.mutagen/daemon/daemon.sock'
+
     run_and_exit _docker_container_login_enter_container @hostname
   end
 

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

@@ -23,6 +23,7 @@ module DockerContainerPrune
 
       name = _docker_container_lib_get_container_name_by_id container
       _docker_container_lib_stop_container container
+      mutagen_socket_terminate "hostname=#{container}"
       networks << name unless networks.include? name
     end
     networks

data/lib/takelage/lib/system.rb

@@ -51,8 +51,9 @@ module SystemModule
   # @return [String] stdout of command
   def run(command)
     log.debug "Running command \"#{command}\""
-    stdout_str, = Open3.capture3 command
+    stdout_str, stderr_str = Open3.capture3 command
     log.debug "Command \"#{command}\" has stdout:\n\"\"\"\n#{stdout_str}\"\"\""
+    log.debug "Command \"#{command}\" has stderr:\n\"\"\"\n#{stderr_str}\"\"\""
     stdout_str
   end
 

data/lib/takelage/mutagen/cli.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage git
+  class Mutagen < SubCommandBase
+    desc 'socket [COMMAND]', 'Manage mutagen socket'
+    subcommand 'socket', MutagenSocket
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# takelage mutagen socket check
+module MutagenSocketCheck
+  # Backend method for mutagen socket check.
+  # @return [Boolean] Does a mutagen socket exist?
+  def mutagen_socket_check(socket)
+    log.debug "Check if the mutagen socket \"#{socket}\" exists"
+
+    socket_exists = _mutagen_socket_check_socket(socket)
+
+    unless socket_exists.exitstatus.zero?
+      log.debug "A mutagen socket \"#{socket}\" does not exist"
+      return false
+    end
+
+    log.debug "The mutagen socket \"#{socket}\" does exist"
+    true
+  end
+
+  private
+
+  # Get git branch.
+  def _mutagen_socket_check_socket(socketname)
+    cmd_check_socket = format(
+      config.active['cmd_mutagen_forward_socket_check'],
+      socketname: socketname
+    )
+    try cmd_check_socket
+  end
+end

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage mutagen socket
+  class MutagenSocket < SubCommandBase
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerCheckDaemon
+    include DockerCheckSocat
+    include DockerContainerCheckExisting
+    include DockerContainerCheckNetwork
+    include DockerContainerCommand
+    include DockerContainerLib
+    include DockerSocketLib
+    include DockerSocketScheme
+    include DockerSocketStart
+    include MutagenSocketCheck
+    include MutagenSocketCreate
+    include MutagenSocketList
+    include MutagenSocketTerminate
+
+    # Initialize mtagen socket
+    def initialize(args = [], local_options = {}, configuration = {})
+      # initialize thor parent class
+      super args, local_options, configuration
+
+      @docker_repo = config.active['docker_repo']
+      @username = ENV['USER'] || 'noname'
+      @workdir = Dir.getwd
+      inside = _docker_container_lib_check_matrjoschka
+      @hostname = inside ? ENV['HOSTNAME'] : _docker_container_lib_hostname
+      @hostlabel = "hostname=#{@hostname}"
+      @takellabel = 'type=takelage-socket'
+      @sockets = docker_socket_scheme
+    end
+
+    #
+    # mutagen socket check
+    #
+    desc 'check [SOCKET]', 'Check if mutagen [SOCKET] exists'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check if mutagen [SOCKET] exists
+    LONGDESC
+    # Check if mutagen [SOCKET] exists.
+    def check(socket)
+      exit mutagen_socket_check socket
+    end
+
+    #
+    # mutagen socket create
+    #
+    desc 'create [IN] [OUT]', 'Create a mutagen socket from [IN] to [OUT] of the container'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Create a mutagen socket 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
+    end
+
+    #
+    # mutagen socket list
+    #
+    desc 'list', 'List mutagen sockets'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    List mutagen sockets
+    LONGDESC
+    # List mutagen sockets.
+    def list
+      socket_list = mutagen_socket_list
+      exit false if socket_list == false
+      say socket_list
+      true
+    end
+
+    #
+    # mutagen socket terminate
+    #
+    desc 'terminate', 'Terminate a mutagen socket'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Terminate a mutagen socket
+    LONGDESC
+    # Terminate a mutagen socket.
+    def terminate(socket)
+      exit mutagen_socket_terminate socket
+    end
+  end
+end

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

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

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# takelage mutagen socket list
+module MutagenSocketList
+  # Backend method for mutagen socket list.
+  # @return [String] List of takelage sockets
+  def mutagen_socket_list
+    log.debug 'List the mutagen takelage sockets'
+
+    sockets = _mutagen_socket_list
+
+    if sockets.to_s.empty?
+      log.debug 'No mutagen takelage sockets found'
+      return false
+    end
+
+    log.debug "Found mutagen takelage sockets: \n\"\"\"\n#{sockets}\"\"\""
+    sockets.to_s
+  end
+
+  private
+
+  # Get git branch.
+  def _mutagen_socket_list
+    cmd_list_socket = format(
+      config.active['cmd_mutagen_forward_socket_list'],
+      takellabel: @takellabel
+    )
+    run cmd_list_socket
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# takelage mutagen socket terminate
+module MutagenSocketTerminate
+  # Backend method for mutagen socket terminate.
+  def mutagen_socket_terminate(socket)
+    log.debug "Terminate the mutagen socket \"#{socket}\""
+
+    socket_terminated = _mutagen_socket_terminate_socket socket
+
+    cmd_remove = config.active['cmd_mutagen_forward_socket_remove']
+    docker_container_command cmd_remove if cmd_remove && socket_terminated.exitstatus.zero?
+
+    unless socket_terminated.exitstatus.zero?
+      log.debug "Unable to terminated mutagen socket \"#{socket}\""
+      return false
+    end
+
+    log.debug "Terminated the mutagen socket \"#{socket}\""
+    true
+  end
+
+  private
+
+  # Get git branch.
+  def _mutagen_socket_terminate_socket(socketname)
+    cmd_terminate_socket = format(
+      config.active['cmd_mutagen_forward_socket_terminate'],
+      socketname: socketname
+    )
+    try cmd_terminate_socket
+  end
+end

data/lib/takelage/version

@@ -1 +1 @@
-0.27.1
+0.28.5

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: takelage
 version: !ruby/object:Gem::Version
-  version: 0.27.1
+  version: 0.28.5
 platform: ruby
 authors:
 - Geospin
@@ -271,6 +271,12 @@ files:
 - lib/takelage/lib/project.rb
 - lib/takelage/lib/subcmd.rb
 - lib/takelage/lib/system.rb
+- lib/takelage/mutagen/cli.rb
+- lib/takelage/mutagen/socket/check.rb
+- lib/takelage/mutagen/socket/cli.rb
+- lib/takelage/mutagen/socket/create.rb
+- lib/takelage/mutagen/socket/list.rb
+- lib/takelage/mutagen/socket/terminate.rb
 - lib/takelage/self/cli.rb
 - lib/takelage/self/config/cli.rb
 - lib/takelage/self/list.rb