takeltau 0.34.9

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Takeltau
+  # takeltau mutagen check
+  class MutagenCheck < SubCommandBase
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerCheckDaemon
+    include DockerContainerCheckExisting
+    include DockerContainerCheckNetwork
+    include DockerContainerCommand
+    include DockerContainerLib
+    include MutagenCheckDaemon
+
+    # Initialize mutagen check
+    def initialize(args = [], local_options = {}, configuration = {})
+      # initialize thor parent class
+      super args, local_options, configuration
+
+      @workdir = Dir.getwd
+
+      inside = _docker_container_lib_check_matrjoschka
+      @hostname = inside ? ENV['HOSTNAME'] : _docker_container_lib_hostname
+      @hostlabel = "hostname=#{@hostname}"
+    end
+
+    #
+    # mutagen check daemon
+    #
+    desc 'daemon', 'Check if mutagen host conenction is available'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check if mutagen host conenction is available
+    LONGDESC
+    # Check if mutagen host conenction is available.
+    def daemon
+      exit mutagen_check_daemon
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+# takeltau info status mutagen
+module MutagenCheckDaemon
+  # Backend method for mutagen check daemon.
+  # @return [Boolean] is mutagen available?
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
+  def mutagen_check_daemon
+    return true if @mutagen_daemon_available
+
+    return false unless command_available_else_warn? config.active['cmd_mutagen']
+
+    log.debug 'Check mutagen status'
+
+    # are we outside of a takelage container?
+    unless _docker_container_lib_check_matrjoschka
+      unless _mutagen_check_daemon_version
+        log.error 'The mutagen daemon is not available'
+        return false
+      end
+
+      log.debug 'The mutagen daemon is available'
+      @mutagen_daemon_available = true
+      return true
+    end
+
+    unless _file_exists? config.active['mutagen_socket_path_mutagen']
+      log.error 'The mutagen socket is not available'
+      return false
+    end
+
+    unless _mutagen_check_daemon_host_connection
+      log.error 'A mutagen host connection is not available'
+      return false
+    end
+
+    log.debug 'The mutagen daemon is available'
+    @mutagen_daemon_available = true
+    true
+  end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
+
+  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
+    )
+    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
+    version = try config.active['cmd_mutagen_check_daemon_version']
+    version.exitstatus.zero?
+  end
+end

data/lib/takeltau/mutagen/cli.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Takeltau
+  # takeltau git
+  class Mutagen < SubCommandBase
+    desc 'check [COMMAND]', 'Check mutagen'
+    subcommand 'check', MutagenCheck
+
+    desc 'socket [COMMAND]', 'Manage mutagen socket'
+    subcommand 'socket', MutagenSocket
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# takeltau 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"
+
+    return false unless mutagen_check_daemon
+
+    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/takeltau/mutagen/socket/cli.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Takeltau
+  # takeltau mutagen socket
+  class MutagenSocket < SubCommandBase
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerCheckDaemon
+    include DockerContainerCheckExisting
+    include DockerContainerCheckNetwork
+    include DockerContainerCommand
+    include DockerContainerLib
+    include DockerImageTagLatest
+    include DockerImageTagList
+    include DockerImageTagCheck
+    include MutagenCheckDaemon
+    include MutagenSocketCheck
+    include MutagenSocketCreate
+    include MutagenSocketList
+    include MutagenSocketTidy
+    include MutagenSocketTerminate
+
+    # Initialize mutagen 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 = config.active['mutagen_socket_takelage_label']
+    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 [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 [NAME] from [IN] to [OUT] of the container
+    LONGDESC
+    # 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
+
+    #
+    # 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 [SOCKET]', '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
+
+    #
+    # mutagen socket tidy
+    #
+    desc 'tidy', 'Remove mutagen daemon files'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Remove mutagen daemon files
+    LONGDESC
+    # Remove mutagen daemon files.
+    def tidy
+      exit mutagen_socket_tidy
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# takeltau mutagen socket create
+module MutagenSocketCreate
+  # Backend method for mutagen socket create.
+  # 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
+
+    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}\""
+      return false
+    end
+
+    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(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/takeltau/mutagen/socket/list.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# takeltau 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'
+
+    return false unless mutagen_check_daemon
+
+    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/takeltau/mutagen/socket/terminate.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# takeltau mutagen socket terminate
+module MutagenSocketTerminate
+  # Backend method for mutagen socket terminate.
+  def mutagen_socket_terminate(socket)
+    log.debug "Terminate the mutagen socket \"#{socket}\""
+
+    return false unless mutagen_check_daemon
+
+    socket_terminated = _mutagen_socket_terminate_socket socket
+
+    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/takeltau/mutagen/socket/tidy.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# takeltau mutagen socket tidy
+module MutagenSocketTidy
+  # Backend method for mutagen socket tidy.
+  def mutagen_socket_tidy
+    log.debug "Remove the mutagen daemon files in container \"#{@hostname}\""
+
+    container_existing = docker_container_check_existing @hostname
+    cmd_remove = config.active['cmd_mutagen_forward_socket_remove']
+    return false unless container_existing && cmd_remove.empty?
+
+    unless docker_container_command cmd_remove
+      log.error "Unable to remove the mutagen daemon files in container \"#{@hostname}\""
+      return false
+    end
+
+    log.debug "Removed the mutagen daemon files in container \"#{@hostname}\""
+    true
+  end
+end

data/lib/takeltau/self/cli.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Takeltau
+  # semantic version number
+  VERSION = (File.read "#{File.dirname(__FILE__)}/../version").chomp
+
+  # takeltau self
+  class Self < SubCommandBase
+    include LoggingModule
+    include SelfList
+
+    desc 'config [COMMAND]', 'Manage takeltau configuration'
+    subcommand 'config', SelfConfig
+
+    #
+    # self list
+    #
+    desc 'list', 'List all commands'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    List all commands
+    LONGDESC
+    # List all commands.
+    def list
+      list = self_list
+      exit false if list == false
+      say list
+      true
+    end
+
+    #
+    # self version
+    #
+    desc 'version', 'Print takeltau semantic version number'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print takeltau semantic version number
+    LONGDESC
+    # Print takeltau semantic version number.
+    def version
+      say VERSION
+      true
+    end
+  end
+end