takeltau 0.44.8 → 0.44.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0265577b0c7fe802841470d93b7df218162928a825b3c360e0c7fa5c16d10810
-  data.tar.gz: 39143047fc8490a50a8bef1c967ddf7ee61396e5f8a1f198f7aac0ab803c9ffe
+  metadata.gz: 6ddae907069e4203d6fd9ab233e4e39573a2c9db4a4921868fa53e3375172d18
+  data.tar.gz: 0bae02ff5ccaa0885c4c08c9ea2dd4e48dec96b8b6164532a86b5fd3add3fc8e
 SHA512:
-  metadata.gz: d28bb37c89010cbba5c0a0061b6d349bfe3e1c1235c5fc1e3ecab38db85518583c86059f0d457362ef1f0c4fb25fdb6d24593b98579e15df914876f4e04a9b89
-  data.tar.gz: 06c7e2e98e681c7a28cc03ddbfef9cff9c21481db11446c8067ef5e9962c56ee1c55506d436a728dd1949323c51aeb1127ec7cdf32c7c4d561826739d6daa0df
+  metadata.gz: 3a263b2321750b5547d6234c35a85a75a06fbe8b9e357f5aa18af74f0aa1300c28fab6b830d662fb239f03a6188e730a39659c1fc8e8db2b89b6ff4ef6349b0a
+  data.tar.gz: b0024cf566206e62ffd3e5d1f407d04217ca66b0738d77ee8c2c31e5f897af951ad312cf7c799761ee3ea3abd1f2afba6fbfc9aaf2dd86442fcc3d54115fccc7

data/README.md

@@ -131,15 +131,18 @@ tau [ship project list](features/cucumber/features/ship/project/ship.project.lis
 tau [ship project logs](features/cucumber/features/ship/project/ship.project.logs.feature) [PROJECT] | Follow logs of a takelship [PROJECT]
 tau [ship project start](features/cucumber/features/ship/project/ship.project.start.feature) [PROJECT] | Start a takelship [PROJECT]
 tau [ship project stop](features/cucumber/features/ship/project/ship.project.stop.feature) | Stop a takelship project
+tau ship board | Alias for tau [ship container login](features/cucumber/features/ship/container/ship.container.login.feature)
 tau ship command [COMMAND] | Alias for tau [ship container command](features/cucumber/features/ship/container/ship.container.command.feature)
 tau ship list | Alias for tau [ship container list](features/cucumber/features/ship/container/ship.container.list.feature)
 tau ship login | Alias for tau [ship container login](features/cucumber/features/ship/container/ship.container.login.feature)
 tau ship logs [PROJECT] | Alias for tau [ship project logs](features/cucumber/features/ship/project/ship.project.logs.feature)
 tau ship ls | Alias for tau [ship container list](features/cucumber/features/ship/container/ship.container.list.feature)
 tau ship podman [COMMAND] | Alias for tau [ship container podman](features/cucumber/features/ship/container/ship.container.podman.feature)
+tau ship sail [PROJECT] | Alias for tau [ship project start](features/cucumber/features/ship/project/ship.project.start.feature)
 tau ship start [PROJECT] | Alias for tau [ship project start](features/cucumber/features/ship/project/ship.project.start.feature)
 tau ship stop | Alias for tau [ship project stop](features/cucumber/features/ship/project/ship.project.stop.feature)
 tau ship sudo [COMMAND] | Alias for tau [ship container sudo](features/cucumber/features/ship/container/ship.container.sudo.feature)
+tau ship wreck | Alias for tau [ship project stop](features/cucumber/features/ship/project/ship.project.stop.feature)
 tau ship update | Alias for tau [ship container update](features/cucumber/features/ship/container/ship.container.update.feature)
 tau clean | Alias for tau [docker container clean](features/cucumber/features/docker/docker.container.clean.feature)
 tau commands | Alias for tau [self commands](features/cucumber/features/self/self.commands.feature)

data/lib/takeltau/ship/cli.rb

@@ -2,6 +2,7 @@
 
 module Takeltau
   # tau ship
+  # rubocop:disable Metrics/ClassLength
   class Ship < SubCommandBase
     include LoggingModule
     include SystemModule
@@ -35,6 +36,16 @@ module Takeltau
     # Top-level ship commands
     #
 
+    desc 'board', 'Log in to a takelship'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Log in to a takelship as root.
+    Alias for ship container login.
+    LONGDESC
+    # ship board: {Takeltau::ShipContainer#login}
+    def board
+      Takeltau::ShipContainer.new.login
+    end
+
     desc 'command [COMMAND]', 'Run a [COMMAND] in a takelship'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
     Run a command in a takelship container as user podman.
@@ -115,6 +126,16 @@ module Takeltau
       Takeltau::ShipProject.new.start project
     end
 
+    desc 'sail [PROJECT]', 'Start takelship [PROJECT]'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Start a takelship and run project [PROJECT] in it.
+    Alias for ship project start.
+    LONGDESC
+    # ship sail: {Takeltau::ShipProject#start}
+    def sail(project = 'default')
+      Takeltau::ShipProject.new.start project
+    end
+
     desc 'stop', 'Stop a takelship'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
     Stop a takelship container.
@@ -125,6 +146,16 @@ module Takeltau
       Takeltau::ShipProject.new.stop
     end
 
+    desc 'wreck', 'Stop a takelship'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Stop a takelship container.
+    Alias for ship container stop.
+    LONGDESC
+    # ship wreck: {Takeltau::ShipProject#stop}
+    def wreck
+      Takeltau::ShipProject.new.stop
+    end
+
     desc 'update', 'Update takelship image'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
     Update the takelship docker image.
@@ -135,4 +166,5 @@ module Takeltau
       Takeltau::ShipContainer.new.update
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

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

@@ -22,7 +22,7 @@ module ShipContainerLib
     ship_data_dir = config.active['ship_data_dir']
     ship_env = [config.active['ship_env']]
     ports.each do |key, port|
-      envvar = "TAKELSHIP_CONFIG_#{key}".upcase
+      envvar = "TAKELSHIP_#{key}".upcase
       envstr = "--env #{envvar}=#{port['localhost']}"
       ship_env << envstr
     end

data/lib/takeltau/ship/ports/lib.rb

@@ -53,27 +53,41 @@ module ShipPortsLib
     takel_docker = takelship['docker_host']
     docker_key = "ship_ports_dind_docker_#{takel_docker}"
     local_docker = _ship_ports_lib_get_localhost_port docker_key, takel_docker
+    docker_host = "DOCKER_HOST=tcp://localhost:#{local_docker}"
     {
       docker_key => {
         'service' => 'dind',
         'protocol' => 'docker',
         'takelship' => takel_docker.to_i,
-        'localhost' => local_docker
+        'localhost' => local_docker,
+        'description' => docker_host
       }
     }
   end
   # rubocop:enable Metrics/MethodLength
 
   # map a takelship port
+  # rubocop:disable Metrics/MethodLength
   def _ship_ports_lib_get_port(key, port, service)
     localhost = _ship_ports_lib_get_localhost_port key, port['port']
+    unless port.key?('description')
+      return {
+        'service' => service['name'],
+        'protocol' => port['protocol'],
+        'takelship' => port['port'],
+        'localhost' => localhost
+      }
+    end
+
     {
       'service' => service['name'],
       'protocol' => port['protocol'],
       'takelship' => port['port'],
-      'localhost' => localhost
+      'localhost' => localhost,
+      'description' => port['description']
     }
   end
+  # rubocop:enable Metrics/MethodLength
 
   # get new port on localhost for takelport
   def _ship_ports_lib_get_localhost_port(key, port)

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

@@ -3,8 +3,9 @@
 # tau ship project start
 module ShipProjectStart
   # Start a takelship
+  # rubocop:disable Metrics/MethodLength
   def ship_project_start(project)
-    return false unless _ship_project_start_prerequisites_fulfilled?
+    return false unless _ship_project_start_matrjoschka?
 
     takelship = _ship_info_lib_get_takelshipinfo
     project = _ship_info_lib_get_project project, takelship
@@ -13,30 +14,35 @@ module ShipProjectStart
 
     ports = _ship_ports_lib_get_ports(takelship, project)
 
+    return false unless _ship_project_start_sailing? project, ports
+
     log.debug 'Writing port configuration to takelage.yml'
     _ship_ports_lib_write_ports(ports, project)
 
     log.debug "Starting takelship project \"#{project}\""
     _ship_container_lib_docker_privileged ports, project
-
-    _ship_project_start_print_ports project, ports
+    say "Started project \"#{project}\" on takelship \"#{_ship_container_lib_ship_hostname}\".\n\n"
+    _ship_project_start_print_ports ports
   end
+  # rubocop:enable Metrics/MethodLength
 
   private
 
-  # check prerequisistes
-  def _ship_project_start_prerequisites_fulfilled?
-    if _docker_container_lib_check_matrjoschka
-      say 'Cannot start a takelship from within a takelage container!'
-      return false
-    end
+  # check if we are inside a takelage container
+  def _ship_project_start_matrjoschka?
+    return true unless _docker_container_lib_check_matrjoschka
 
-    if ship_container_check_existing
-      say "Container \"#{_ship_container_lib_ship_hostname}\" is already started!"
-      return false
-    end
+    say 'Cannot start a takelship from within a takelage container!'
+    false
+  end
+
+  # check if the takelship is already existng
+  def _ship_project_start_sailing?(project, ports)
+    return true unless ship_container_check_existing
 
-    true
+    say "The takelship \"#{_ship_container_lib_ship_hostname}\" is sailing with project \"#{project}\".\n\n"
+    say _ship_project_start_print_ports ports
+    false
   end
 
   # check if the project is a valid takelship project
@@ -44,35 +50,49 @@ module ShipProjectStart
     return true if _ship_info_lib_valid_project? takelship, project
 
     say 'No valid project found!'
+    say 'Hint: ship project list'
     false
   end
 
   # print ports after starting a takelship
-  def _ship_project_start_print_ports(project, ports)
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
+  def _ship_project_start_print_ports(ports)
     output = []
-    output << "Started takelship project \"#{project}\"\n"
     max_length = _ship_project_start_get_maxlength ports
-
     ports.each_value do |port|
       next unless port['localhost'].to_i.between? 1, 65_535
 
-      left = "localhost:#{port['localhost']}"
-      right = "(#{port['service']} #{port['protocol']})"
-      output << "#{left.ljust(max_length)} #{right}"
+      url = "localhost:#{port['localhost']}"
+      service = "[#{port['service']} #{port['protocol']}]"
+      description = port['description']
+      description = " (#{description})" if port.key? 'description'
+      output << "#{url.ljust(max_length['url'])} #{service.ljust(max_length['service'])}#{description}"
     end
     output.join("\n")
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 
   # get max length of left column
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
   def _ship_project_start_get_maxlength(ports)
-    max_length = 0
+    max_length = {}
+    max_length['url'] = 0
+    max_length['service'] = 0
     ports.each_value do |port|
       localport = port['localhost']
       next unless localport.to_i.between? 1, 65_535
 
-      left_string = "localhost:#{localport}"
-      max_length = left_string.length if max_length < left_string.length
+      url = "localhost:#{localport}"
+      max_length['url'] = url.length if max_length['url'] < url.length
+
+      service = "[#{port['service']} #{port['protocol']}]"
+      max_length['service'] = service.length if max_length['service'] < service.length
     end
     max_length
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 end

data/lib/takeltau/version

@@ -1 +1 @@
-0.44.8
+0.44.11

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: takeltau
 version: !ruby/object:Gem::Version
-  version: 0.44.8
+  version: 0.44.11
 platform: ruby
 authors:
 - Takelwerk