takeltau 0.44.2 → 0.44.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91c0fd02dbdf001b8c5fa156dda3652f49e03478e9f8f1815242c309acaf29a4
-  data.tar.gz: 9e729bcd61aff9974a34e7a6f203ac628e99c359ef0eb1756329cd88bbadba17
+  metadata.gz: 6ddae907069e4203d6fd9ab233e4e39573a2c9db4a4921868fa53e3375172d18
+  data.tar.gz: 0bae02ff5ccaa0885c4c08c9ea2dd4e48dec96b8b6164532a86b5fd3add3fc8e
 SHA512:
-  metadata.gz: f258eec6024594a928f0da69b07836b1c0382b40b1c057976aacda403cfa77fa7d25b96bbe6597a92f41b3441902380d7a06f597598946c6673db5ee863fe341
-  data.tar.gz: f9db8ceaeaa94f105b07ecd766ac6b03022bbe04164d358b137e8b7816ff8b5591c3bdcaab14be4e5f98ea0bbb5bb2c84dd711db4177abf30c0b0146f6649d9b
+  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/default.yml

@@ -61,10 +61,10 @@ cmd_ship_container_docker: '%{ship_docker} exec --interactive %{tty} %{ship_host
 cmd_ship_container_login: 'bash'
 cmd_ship_docker: 'docker'
 cmd_ship_docker_check: 'docker --version'
+cmd_ship_project_follow_logs: 'pod --workdir /home/podman/takelship/compose/projects/%{project} podman-compose logs --follow'
 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_project_follow_logs: 'pod --workdir /home/podman/takelship/compose/projects/%{project} podman-compose logs --follow'
 docker_container_check_matrjoschka: 'true'
 docker_debug: 'ansible/roles/takel_takelage/files/takelscripts'
 docker_entrypoint_extra: ''
@@ -96,7 +96,6 @@ ship_env: '--env TAKELSHIP_UPDATE=true'
 ship_hostname: '%{ship_name}_%{unique}'
 ship_name: 'takelship'
 ship_podman_localhost: '127.0.0.1'
-ship_ports: ''
 ship_port_expose_podman_socket: 'false'
 ship_repo: 'takelship'
 ship_tag: 'latest'

data/lib/takeltau/lib/system.rb

@@ -49,6 +49,13 @@ module SystemModule
     @content
   end
 
+  # Write content to file
+  def write_file(file, content)
+    log.debug "Writing content to file \"#{file}\":"
+    log.debug "\"#{content}\""
+    File.write(file, content)
+  end
+
   # Remove directory tree.
   def rm_fr(directory)
     unless File.directory? directory

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
@@ -25,6 +26,9 @@ module Takeltau
     desc 'info [COMMAND]', 'Get info about takelship containers'
     subcommand 'info', ShipInfo
 
+    desc 'ports [COMMAND]', 'Manage takelship portss'
+    subcommand 'ports', ShipPorts
+
     desc 'project [COMMAND]', 'Manage takelship projects'
     subcommand 'project', ShipProject
 
@@ -32,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.
@@ -112,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.
@@ -122,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.
@@ -132,4 +166,5 @@ module Takeltau
       Takeltau::ShipContainer.new.update
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

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

@@ -20,14 +20,18 @@ module ShipContainerLib
   # rubocop:disable Metrics/MethodLength
   def _ship_container_lib_docker_privileged(ports, command)
     ship_data_dir = config.active['ship_data_dir']
-    ship_env = config.active['ship_env']
+    ship_env = [config.active['ship_env']]
+    ports.each do |key, port|
+      envvar = "TAKELSHIP_#{key}".upcase
+      envstr = "--env #{envvar}=#{port['localhost']}"
+      ship_env << envstr
+    end
     ports = _ship_container_lib_publish(ports)
-    ports = config.active['ports'] unless config.active['ship_ports'].empty?
     cmd_docker_run_command = format(
       config.active['cmd_ship_project_start_docker_run_privileged'],
       ship_docker: config.active['cmd_ship_docker'],
       ship_hostname: _ship_container_lib_ship_hostname,
-      ship_env: ship_env,
+      ship_env: ship_env.join(' '),
       ports: ports,
       ship_data_dir: ship_data_dir,
       image: _ship_container_lib_image,
@@ -77,7 +81,11 @@ module ShipContainerLib
   def _ship_container_lib_publish(ports)
     publish = []
     ports.each do |port|
-      publish << "--publish \"127.0.0.1:#{port}:#{port}\""
+      shipport = port[1]['takelship'].to_s
+      localport = port[1]['localhost'].to_s
+      next unless localport.to_i.between? 1, 65_535
+
+      publish << "--publish \"127.0.0.1:#{localport}:#{shipport}\""
     end
     publish.join(' ')
   end

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

@@ -5,6 +5,7 @@ module ShipContainerStop
   # Stop a takelship container
   def ship_container_stop
     _ship_container_stop_docker_stop
+    "Stopped takelship \"#{_ship_container_lib_ship_hostname}\""
   end
 
   private

data/lib/takeltau/ship/info/lib.rb

@@ -9,6 +9,7 @@ module ShipInfoLib
     log.debug 'Gathering takelship info'
     takelshipinfo = _ship_info_lib_get_info_from_file
     takelshipinfo = _ship_info_lib_get_info_from_docker if takelshipinfo.empty?
+
     return false if takelshipinfo.nil?
 
     takelshipinfo
@@ -44,6 +45,8 @@ module ShipInfoLib
   def _ship_info_lib_valid_project?(takelship, project)
     valid_project = false
     takelship_projects = takelship['projects']
+    return false if takelship_projects.nil? || takelship_projects.empty?
+
     takelship_projects.each do |takelship_project|
       valid_project = true if project == takelship_project['name']
     end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Takeltau
+  # tau ship info
+  class ShipPorts < SubCommandBase
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerCheckDaemon
+    include ShipContainerLib
+    include ShipInfoLib
+    include ShipPortsLib
+    include ShipPortsList
+
+    desc 'list [PROJECT]', 'Print takelship ports of a [PROJECT]'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print the ports that a takelship project exposes.
+    LONGDESC
+    # ship list: {Takeltau::ShipPorts#list}
+    def list(project = 'default')
+      say (ship_ports_list project).to_yaml
+    end
+  end
+end

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

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+# tau ship ports lib
+module ShipPortsLib
+  private
+
+  # get the ports of a takelship
+  # rubocop:disable Metrics/MethodLength
+  def _ship_ports_lib_get_ports(takelship, takelproject)
+    ports = _ship_ports_lib_get_ports_docker(takelship)
+    takelship['projects'].each do |project|
+      next unless project['name'] == takelproject
+
+      project['services'].each do |service|
+        next unless service.key? 'ports'
+
+        service['ports'].each do |port|
+          key = _ship_ports_lib_generate_key port, service
+          ports[key] = _ship_ports_lib_get_port key, port, service
+        end
+      end
+    end
+    ports
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  # write ports to project takelage.yml
+  def _ship_ports_lib_write_ports(ports, project)
+    config_project = _ship_ports_lib_get_project_config ports, project
+    project_dir = config.active['project_root_dir']
+    config_file = "#{project_dir}/takelage.yml"
+    write_file config_file, config_project.to_yaml
+  end
+
+  # get current project config
+  # the values are added/updated unconditionally
+  # the merge with the existing values has been done here:
+  # ConfigModule::TakeltauConfig::_config_merge_active
+  # and here: _ship_ports_lib_get_localhost_port
+  def _ship_ports_lib_get_project_config(ports, project)
+    config_project = config.project
+    ports.each do |key, port|
+      config_project[key] = port['localhost']
+    end
+    config_project['ship_default_project'] = project
+    config_project.sort.to_h
+  end
+
+  # map the podman socket port (aka "DOCKER_HOST")
+  # returns a hash unlike the get_port method
+  # rubocop:disable Metrics/MethodLength
+  def _ship_ports_lib_get_ports_docker(takelship)
+    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,
+        '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,
+      'description' => port['description']
+    }
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  # get new port on localhost for takelport
+  def _ship_ports_lib_get_localhost_port(key, port)
+    env_var = "TAKELAGE_TAU_CONFIG_#{key}".upcase
+    return ENV[env_var].to_i if ENV.key? env_var
+
+    return config.active[key] if config.active.key? key
+
+    _ship_ports_lib_get_free_port port
+  end
+
+  # derive a random free port from a port
+  def _ship_ports_lib_get_free_port(port)
+    localport = 0
+    loop do
+      offset = _ship_ports_lib_get_offset
+      localport = port.to_i + offset
+      break unless _ship_ports_lib_port_open? localport
+    end
+    localport
+  end
+
+  # generate dynamic takelconfig key
+  def _ship_ports_lib_generate_key(port, service)
+    key = "ship_ports_#{service['name']}_#{port['protocol']}_#{port['port']}"
+    key.gsub('-', '_')
+  end
+
+  # generate random offset
+  def _ship_ports_lib_get_offset
+    # this results in ports
+    # from 30000 + 15000 = 45000
+    # to 40000 + 25000 = 65000
+    # max port number: 65535
+    rand(15_000..25_000)
+  end
+
+  # check if a port on the host is open
+  def _ship_ports_lib_port_open?(port)
+    log.debug "Checking if port #{port} is open"
+    begin
+      Socket.tcp('127.0.0.1', port, connect_timeout: 5)
+      true
+    rescue Errno::ECONNREFUSED
+      false
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# tau ship ports list
+module ShipPortsList
+  # List takelship portss.
+  def ship_ports_list(project)
+    log.debug 'List takelship ports'
+
+    takelship = _ship_info_lib_get_takelshipinfo
+    project = _ship_info_lib_get_project(project, takelship)
+
+    return false unless _ship_info_lib_valid_project? takelship, project
+
+    _ship_ports_lib_get_ports takelship, project
+  end
+end

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

@@ -12,6 +12,7 @@ module Takeltau
     include ShipContainerLib
     include ShipContainerStop
     include ShipInfoLib
+    include ShipPortsLib
     include ShipProjectList
     include ShipProjectLogs
     include ShipProjectStart
@@ -46,7 +47,8 @@ module Takeltau
     Start a takelship and run project [PROJECT] in it.
     LONGDESC
     def start(project = 'default')
-      ship_project_start project
+      project_start = ship_project_start project
+      say project_start if project_start
     end
 
     #

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

@@ -3,45 +3,96 @@
 # tau ship project start
 module ShipProjectStart
   # Start a takelship
+  # rubocop:disable Metrics/MethodLength
   def ship_project_start(project)
-    return false if _docker_container_lib_check_matrjoschka
-
-    return false if ship_container_check_existing
+    return false unless _ship_project_start_matrjoschka?
 
     takelship = _ship_info_lib_get_takelshipinfo
-    project = _ship_info_lib_get_project(project, takelship)
+    project = _ship_info_lib_get_project project, takelship
+
+    return false unless _ship_project_start_valid_project? takelship, project
 
-    return false unless _ship_info_lib_valid_project? takelship, project
+    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}\""
-    ports = _ship_project_start_ports takelship, project
-    say _ship_container_lib_docker_privileged ports, project
+    _ship_container_lib_docker_privileged ports, project
+    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
 
-  # Get takelship ports
+  # check if we are inside a takelage container
+  def _ship_project_start_matrjoschka?
+    return true unless _docker_container_lib_check_matrjoschka
+
+    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
+
+    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
+  def _ship_project_start_valid_project?(takelship, project)
+    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
   # rubocop:disable Metrics/MethodLength
   # rubocop:disable Metrics/AbcSize
-  def _ship_project_start_ports(takelship, project)
-    ports = []
-    takelship['projects'].each do |takelship_project|
-      next unless project == takelship_project['name']
-
-      takelship_project['services'].each do |service|
-        next unless service.key?('ports')
-
-        service['ports'].each do |port|
-          ports << port['port']
-        end
-      end
+  def _ship_project_start_print_ports(ports)
+    output = []
+    max_length = _ship_project_start_get_maxlength ports
+    ports.each_value do |port|
+      next unless port['localhost'].to_i.between? 1, 65_535
+
+      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
-    if config.active['ship_port_expose_podman_socket'] == 'true'
-      log.debug "Add DOCKER_HOST port #{config.active['ship_docker_host']}"
-      ports << config.active['ship_docker_host']
+    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 = {}
+    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
+
+      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
-    ports
+    max_length
   end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
 end
-# rubocop:enable Metrics/AbcSize
-# rubocop:enable Metrics/MethodLength

data/lib/takeltau/version

@@ -1 +1 @@
-0.44.2
+0.44.11

data/lib/takeltau.rb

@@ -98,6 +98,9 @@ require_relative 'takeltau/ship/container/stop'
 require_relative 'takeltau/ship/container/update'
 require_relative 'takeltau/ship/container/cli'
 require_relative 'takeltau/ship/info/cli'
+require_relative 'takeltau/ship/ports/lib'
+require_relative 'takeltau/ship/ports/list'
+require_relative 'takeltau/ship/ports/cli'
 require_relative 'takeltau/ship/project/list'
 require_relative 'takeltau/ship/project/logs'
 require_relative 'takeltau/ship/project/start'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: takeltau
 version: !ruby/object:Gem::Version
-  version: 0.44.2
+  version: 0.44.11
 platform: ruby
 authors:
 - Takelwerk
@@ -300,6 +300,9 @@ files:
 - lib/takeltau/ship/container/update.rb
 - lib/takeltau/ship/info/cli.rb
 - lib/takeltau/ship/info/lib.rb
+- lib/takeltau/ship/ports/cli.rb
+- lib/takeltau/ship/ports/lib.rb
+- lib/takeltau/ship/ports/list.rb
 - lib/takeltau/ship/project/cli.rb
 - lib/takeltau/ship/project/list.rb
 - lib/takeltau/ship/project/logs.rb