takeltau 0.43.23 → 0.44.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 179f0b7a1f0a55cb3a19d640fae0e44172943941112cf79ffa3b676e08424bee
-  data.tar.gz: d33e64ed86c368e1c60a82e026f24d8214f1aa426eaa88db0764c4e02ab7b517
+  metadata.gz: 0265577b0c7fe802841470d93b7df218162928a825b3c360e0c7fa5c16d10810
+  data.tar.gz: 39143047fc8490a50a8bef1c967ddf7ee61396e5f8a1f198f7aac0ab803c9ffe
 SHA512:
-  metadata.gz: 7ecfd4990c4bbb84cd1715218d78bef5aac178b487c9abe8cf0c0d802097fd3fa400cd887210878ed392e2f17afad6060c9b2b671124641cb7687cb5a42f067b
-  data.tar.gz: 0401d8bd721ae94f4e15abcd861934c8423b1b513f5ad409938df7def79db972a6ad0197bd6ad71a86071f4ea31fc82986910b41d2ca01e721fd778b92841ea8
+  metadata.gz: d28bb37c89010cbba5c0a0061b6d349bfe3e1c1235c5fc1e3ecab38db85518583c86059f0d457362ef1f0c4fb25fdb6d24593b98579e15df914876f4e04a9b89
+  data.tar.gz: 06c7e2e98e681c7a28cc03ddbfef9cff9c21481db11446c8067ef5e9962c56ee1c55506d436a728dd1949323c51aeb1127ec7cdf32c7c4d561826739d6daa0df

data/README.md

@@ -115,6 +115,32 @@ tau [self config default](features/cucumber/features/self/self.config.default.fe
 tau [self config home](features/cucumber/features/self/self.config.home.feature) | Print takelage home config file configuration
 tau [self config project](features/cucumber/features/self/self.config.project.feature) | Print takelage project config file configuration
 tau [self version](features/cucumber/features/self/self.version.feature) | Print tau semantic version number
+tau [ship completion bash](features/cucumber/features/ship/completion/completion.bash.feature) | Print bash completion code for ship subcommand
+tau [ship container check existing](features/cucumber/features/ship/container/ship.container.check.existing.feature) | Check if a takelship is existing
+tau [ship container clean](features/cucumber/features/ship/container/ship.container.clean.feature) | Stop all takelships
+tau [ship container command](features/cucumber/features/ship/container/ship.container.command.feature) [COMMAND] | Run a [COMMAND] in a takelship container
+tau [ship container list](features/cucumber/features/ship/container/ship.container.list.feature) | List takelships
+tau [ship container login](features/cucumber/features/ship/container/ship.container.login.feature) | Log in to a takelship
+tau [ship container podman](features/cucumber/features/ship/container/ship.container.podman.feature) [COMMAND] | Run a podman [COMMAND] in a takelship
+tau [ship container stop](features/cucumber/features/ship/container/ship.container.stop.feature) | Stop a takelship
+tau [ship container sudo](features/cucumber/features/ship/container/ship.container.sudo.feature) [COMMAND] | Run a sudo [COMMAND] in a takelship
+tau [ship container update](features/cucumber/features/ship/container/ship.container.update.feature) | Update takelship image
+tau [ship info takelconfig](features/cucumber/features/ship/info/ship.info.takelconfig.feature) | Print takelage config
+tau [ship info takelship](features/cucumber/features/ship/info/ship.info.takelship.feature) | Print takelship info
+tau [ship project list](features/cucumber/features/ship/project/ship.project.list.feature) | List takelship projects
+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 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 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 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)
 tau config | Alias for tau [self config active](features/cucumber/features/self/self.config.active.feature)
@@ -133,21 +159,28 @@ tau version | Alias for tau [self version](features/cucumber/features/self/self.
 
 ### Configuration Files
 
-*takelage-cli* uses three different YAML configuration files
-which have different precedences.
+*takelage-cli* uses three different YAML configuration files and environment variables which have different precedences.
 They are merged to an active configuration during runtime
 which can be inspected with 
 *tau [self config active](features/cucumber/features/self/self.config.active.feature)*
 or *tau config*.
 
 | Filename | Precedence | Description |
-| -------- | ---------- | ----------- |
-| *default.yml* | lowest | Shipped with *takelage-cli*. Sets defaults where applicable. |
-| *~/.takelage.yml* | normal | User-wide configuration file in your home directory. This is your normal custom configuration file. |
-| *takelage.yml* | highest | Project-specific configuration file next to your main Rakefile. Some projects need special configuration. |
-
-Please remember that a project directory is identified by the main
-[Rakefile](Rakefile).
+|-|-|-|
+| *default.yml* | lowest | Shipped with *takelage-cli*. Sets defaults where applicable.                                                          |
+| *~/.takelage.yml* | normal | User-wide configuration file in your home directory. This is your normal custom configuration file.                   |
+| *takelage.yml* | highest | Project-specific configuration file next to your main Rakefile. Some projects need special configuration.             |
+| TAKELAGE_TAU_CONFIG_* | ultimate | Fileless configuration through TAKELAGE_TAU_CONFIG environment variables. |
+
+The tau command line tool is directory-aware so it is important that you can set the working directory of the tau command.
+The project directory is identified by the first match:
+
+| Method | Precedence | Description |
+|-|-|-|
+| `--workdir`/`-w` command line option | ultimate |
+| `TAKELAGE_WORKDIR` environment variable | highest |
+| Main [`Rakefile`](Rakefile) | normal |
+| Current working directory | lowest |
 
 ### Configuration Examples
 

data/bin/ship

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-system "TAKELAGE_TAU_SHIP=#{$PROGRAM_NAME} tau ship #{ARGV.join(' ')}"
+system "TAKELAGE_TAU_TAU=#{$PROGRAM_NAME} TAKELAGE_TAU_SHIP=true tau ship #{ARGV.join(' ')}"

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/docker/container/lib.rb

@@ -181,6 +181,10 @@ module DockerContainerLib
     run cmd_docker_stop
   end
 
+  def _docker_container_lib_homify_dir(dir)
+    dir.strip.sub Dir.home, '~'
+  end
+
   # Get the mounted takelage directory
   def _docker_container_lib_get_mounted_dir(name, destination, docker)
     log.debug 'Getting mounted directory from ' \
@@ -193,7 +197,7 @@ module DockerContainerLib
       dest_dir: "\"#{destination}\""
     )
 
-    (run cmd_get_mounted_dir).strip
+    _docker_container_lib_homify_dir run cmd_get_mounted_dir
   end
 end
 # rubocop:enable Style/IfUnlessModifier

data/lib/takeltau/init/packer/docker.rb

@@ -14,7 +14,7 @@ module InitPackerDocker
     exit_code = _init_packer_docker_create_project files
 
     # reinitialize config with newly created files
-    initialize_config
+    initialize_config ''
 
     return false unless _init_lib_hg_clone
 

data/lib/takeltau/init/takelage/rake.rb

@@ -14,7 +14,7 @@ module InitTakelageRake
     exit_code = _init_takelage_rake_create_project files
 
     # reinitialize config with newly created files
-    initialize_config
+    initialize_config ''
 
     return false unless _init_lib_hg_clone
 

data/lib/takeltau/lib/config.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # tau config module
+# rubocop:disable Metrics/ModuleLength
 module ConfigModule
   # tau config class.
   class TakeltauConfig
@@ -21,8 +22,8 @@ module ConfigModule
 
   # Initialize config
   # rubocop:disable Metrics/AbcSize
-  def initialize_config
-    project_root_dir = _get_project_root_dir
+  def initialize_config(workdir)
+    project_root_dir = _get_project_root_dir workdir
 
     log.debug "takelage version: #{Takeltau::VERSION}"
     log.debug "Current working directory: #{Dir.pwd}"
@@ -137,10 +138,18 @@ module ConfigModule
   # Get project root directory.
   # @return [String] project root directory
   # rubocop:disable Metrics/MethodLength
-  def _get_project_root_dir
-    if ENV.key? 'TAKELAGE_TAU_DIR'
-      log.debug "TAKELTAU_TAU_DIR is set to \"#{ENV['TAKELAGE_TAU_DIR']}\""
-      return ENV['TAKELAGE_TAU_DIR']
+  # rubocop:disable Metrics/AbcSize
+  def _get_project_root_dir(workdir)
+    tau_workdir_root_dir = _get_workdir_root_dir workdir
+    unless tau_workdir_root_dir.empty?
+      log.debug "CLI option workdir is set to #{tau_workdir_root_dir}"
+      return tau_workdir_root_dir
+    end
+
+    if ENV.key? 'TAKELAGE_WORKDIR'
+      tau_envvar_root_dir = ENV['TAKELAGE_WORKDIR']
+      log.debug "TAKELAGE_WORKDIR is set to \"#{tau_envvar_root_dir}\""
+      return File.expand_path tau_envvar_root_dir
     end
 
     tau_takelage_root_dir = _get_takelage_root_dir
@@ -152,11 +161,20 @@ module ConfigModule
     log.debug "Setting root dir to current working dir \"#{Dir.pwd}\""
     Dir.pwd
   end
+  # rubocop:enable Metrics/AbcSize
   # rubocop:enable Metrics/MethodLength
 
+  # Return a command line workdir
+  def _get_workdir_root_dir(workdir)
+    return '' unless Dir.exist? File.expand_path workdir
+
+    workdir
+  end
+
   # Return a takelage root dir
   def _get_takelage_root_dir
     _rakefile, path_rakefile = Rake.application.find_rakefile_location
     path_rakefile
   end
 end
+# rubocop:enable Metrics/ModuleLength

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

@@ -25,6 +25,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,61 +35,101 @@ module Takeltau
     # Top-level ship commands
     #
 
-    desc 'list', 'Alias for tau ship container list'
+    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.
+    Alias for ship container command.
+    LONGDESC
+    # ship command: {Takeltau::ShipContainer#command}
+    def command(*args)
+      Takeltau::ShipContainer.new.command args
+    end
+
+    desc 'list', 'List takelships'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    List takelship containers.
+    Alias for ship container list.
+    LONGDESC
     # ship list: {Takeltau::ShipContainer#list}
     def list
       Takeltau::ShipContainer.new.list
     end
 
-    desc 'logs [PROJECT]', 'Alias for tau ship project logs'
+    desc 'logs [PROJECT]', 'Follow logs of takelship [PROJECT]'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Follow logs of project [PROJECT] in a takelship project.
+    Alias for ship project logs.
+    LONGDESC
     # ship logs: {Takeltau::ShipProject#logs}
     def logs(project = 'default')
       Takeltau::ShipProject.new.logs(project)
     end
 
-    desc 'ls', 'Alias for tau ship container list'
+    desc 'ls', 'List takelships'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    List takelship containers.
+    Alias for ship container list.
+    LONGDESC
     # ship list: {Takeltau::ShipContainer#list}
     def ls
       Takeltau::ShipContainer.new.list
     end
 
-    desc 'login', 'Alias for tau ship container login'
+    desc 'login', '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 login: {Takeltau::ShipContainer#login}
     def login
       Takeltau::ShipContainer.new.login
     end
 
-    desc 'podman [ARGS]', 'Alias for tau ship container podman'
+    desc 'podman [COMMAND]', 'Run a podman [COMMAND] in a takelship'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Run a podman command as user podman in a takelship container.
+    Alias for ship container podman.
+    LONGDESC
     # ship podman: {Takeltau::ShipContainer#podman}
     def podman(*args)
       Takeltau::ShipContainer.new.podman args
     end
 
-    desc 'command [ARGS]', 'Alias for tau ship container command'
-    # ship command: {Takeltau::ShipContainer#command}
-    def command(*args)
-      Takeltau::ShipContainer.new.command args
-    end
-
-    desc 'sudo [ARGS]', 'Alias for tau ship container sudo'
+    desc 'sudo [COMMAND]', 'Run a sudo [COMMAND] in a takelship'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Run a command as root in a takelship container.
+    Alias for ship container sudo.
+    LONGDESC
     # ship sudo: {Takeltau::ShipContainer#sudo}
     def sudo(*args)
       Takeltau::ShipContainer.new.sudo args
     end
 
-    desc 'start [PROJECT]', 'Alias for tau ship project start'
+    desc 'start [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 start: {Takeltau::ShipProject#start}
     def start(project = 'default')
       Takeltau::ShipProject.new.start project
     end
 
-    desc 'stop', 'Alias for tau ship project stop'
+    desc 'stop', 'Stop a takelship'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Stop a takelship container.
+    Alias for ship container stop.
+    LONGDESC
     # ship stop: {Takeltau::ShipProject#stop}
     def stop
       Takeltau::ShipProject.new.stop
     end
 
-    desc 'update', 'Alias for tau ship container update'
+    desc 'update', 'Update takelship image'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Update the takelship docker image.
+    Alias for ship container update.
+    LONGDESC
     # tau update: {Takeltau::ShipContainer#update}
     def update
       Takeltau::ShipContainer.new.update

data/lib/takeltau/ship/completion/bash.rb

@@ -14,19 +14,13 @@ module ShipCompletionBash
   private
 
   # Remove bash completion lines
-  # rubocop:disable Style/BlockDelimiters
   def _ship_completion_bash_remove_lines(tau_completion)
     completion =
       tau_completion
       .strip.split("\n")
-      .reject { |line|
-        line.include? 'options+=("--help")' or
-          line.include? 'options+=("-h")'
-      }
     completion.pop
     completion.join("\n")
   end
-  # rubocop:enable Style/BlockDelimiters
 
   # Remove bash completion functions
   def _ship_completion_bash_remove_functions(completion)

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

@@ -9,12 +9,11 @@ module Takeltau
     desc 'bash', 'Print bash completion code'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
     Print bash completion code
-    This command will print bash code which can be parsed to enable auto-completion for the takelage cli.
+    This command will print bash code which can be parsed to enable auto-completion for the takelship cli.
     Add this to your bash startup files:
 
-    source <(tau completion bash)
+    source <(ship completion bash)
     LONGDESC
-    # Print bash completion code.
     def bash
       completion_bash = ship_completion_bash
       exit false if completion_bash == false

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

@@ -13,13 +13,12 @@ module Takeltau
     #
     # ship container check existing
     #
-    desc 'existing', 'Check if takelship is existing'
+    desc 'existing', 'Check if a takelship is existing'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
     Check if a takelship container is existing
     This check looks for a container with a given name.
     If such a container is existing the result is true else false.
     LONGDESC
-    # Check if takelship container is existing.
     def existing
       exit ship_container_check_existing
     end

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

@@ -19,17 +19,16 @@ module Takeltau
     include ShipContainerStop
     include ShipContainerUpdate
 
-    desc 'check [COMMAND]', 'Check takelship container'
+    desc 'check [COMMAND]', 'Check takelship containers'
     subcommand 'check', ShipContainerCheck
 
     #
     # ship container clean
     #
-    desc 'clean', 'Stop all takelship containers'
+    desc 'clean', 'Stop all takelships'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Stop all takelship containers
+    Stop all takelship containers.
     LONGDESC
-    # Stop all takelship containers.
     def clean
       ship_container_clean
     end
@@ -37,11 +36,10 @@ module Takeltau
     #
     # ship container command
     #
-    desc 'command', 'Run a command in a takelship container'
+    desc 'command [COMMAND]', 'Run a [COMMAND] in a takelship container'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Run a command in a takelship container
+    Run a command in a takelship container as user podman.
     LONGDESC
-    # Run a command in a takelship container.
     def command(*args)
       say ship_container_command args
     end
@@ -49,11 +47,10 @@ module Takeltau
     #
     # ship container list
     #
-    desc 'list', 'List takelship containers'
+    desc 'list', 'List takelships'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-    List takelage containers
+    List takelship containers.
     LONGDESC
-    # List takelage containers.
     def list
       say ship_container_list
     end
@@ -63,9 +60,8 @@ module Takeltau
     #
     desc 'login', 'Log in to a takelship'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Log in to a takelship
+    Log in to a takelship as root.
     LONGDESC
-    # Log in to a takelship.
     def login
       ship_container_login
     end
@@ -73,11 +69,10 @@ module Takeltau
     #
     # ship container podman
     #
-    desc 'podman', 'Run podman command'
+    desc 'podman [COMMAND]', 'Run a podman [COMMAND] in a takelship'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Run podman command
+    Run a podman command as user podman in a takelship container.
     LONGDESC
-    # Run podman command.
     def podman(*args)
       say ship_container_podman args
     end
@@ -85,11 +80,10 @@ module Takeltau
     #
     # ship container sudo
     #
-    desc 'sudo', 'Run a sudo command in a takelship container'
+    desc 'sudo [COMMAND]', 'Run a sudo [COMMAND] in a takelship'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Run a sudo command in a takelship container
+    Run a command as root in a takelship container.
     LONGDESC
-    # Run a sudo command in a takelship container.
     def sudo(*args)
       say ship_container_sudo args
     end
@@ -97,11 +91,10 @@ module Takeltau
     #
     # ship container stop
     #
-    desc 'stop', 'Stop takelship container'
+    desc 'stop', 'Stop a takelship'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Stop takelship container
+    Stop a takelship container.
     LONGDESC
-    # Stop takelship container.
     def stop
       ship_container_stop
     end
@@ -111,9 +104,8 @@ module Takeltau
     #
     desc 'update', 'Update takelship image'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Update takelship image
+    Update the takelship docker image.
     LONGDESC
-    # Update takelship image.
     def update
       ship_container_update
     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_CONFIG_#{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/cli.rb

@@ -10,27 +10,30 @@ module Takeltau
     include ShipContainerLib
     include ShipInfoLib
 
-    #
-    # ship info json
-    #
-    desc 'json', 'Print json takelship info'
+    desc 'takelconfig', 'Print takelage config'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-      Print json takelship info
+    Print takelage config.
+    The configuration values can be overwritten by a
+    1. ~/.takelage.yml in your home directory
+    2. takelage.yml next to a takelship directory
+    3. environment variables like TAKELAGE_TAU_CONFIG_SHIP_NAME
+    Alias for tau self config.
     LONGDESC
-    # Print json takelship info.
-    def json
-      say _ship_info_lib_get_takelshipinfo.to_json
+    # ship takelconfig: {Takeltau::SelfConfig#active}
+    def takelconfig
+      Takeltau::SelfConfig.new.active
     end
 
     #
-    # ship info yaml
+    # ship info takelship
     #
-    desc 'yaml', 'Print yaml takelship info'
+    desc 'takelship', 'Print takelship info'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-      Print yaml takelship info
+    Print takelship info.
+    This info is read from a takelship.yml file in a takelship directory.
+    If no such file exists the info is gathered from a takelship.
     LONGDESC
-    # Print yaml takelship info.
-    def yaml
+    def takelship
       say _ship_info_lib_get_takelshipinfo.to_yaml
     end
   end

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,124 @@
+# 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_key => {
+        'service' => 'dind',
+        'protocol' => 'docker',
+        'takelship' => takel_docker.to_i,
+        'localhost' => local_docker
+      }
+    }
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  # map a takelship port
+  def _ship_ports_lib_get_port(key, port, service)
+    localhost = _ship_ports_lib_get_localhost_port key, port['port']
+    {
+      'service' => service['name'],
+      'protocol' => port['protocol'],
+      'takelship' => port['port'],
+      'localhost' => localhost
+    }
+  end
+
+  # 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
@@ -19,11 +20,10 @@ module Takeltau
     #
     # ship container list
     #
-    desc 'list', 'List projects'
+    desc 'list', 'List takelship projects'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-    List projects
+    List all available takelship projects.
     LONGDESC
-    # List projects.
     def list
       ship_project_list
     end
@@ -31,11 +31,10 @@ module Takeltau
     #
     # ship container logs
     #
-    desc 'logs [PROJECT]', 'Follow logs of project [PROJECT]'
+    desc 'logs [PROJECT]', 'Follow logs of [PROJECT]'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Follow logs of project [PROJECT]
+    Follow logs of project [PROJECT] in a takelship project.
     LONGDESC
-    # logs projects.
     def logs(project = 'default')
       ship_project_logs project
     end
@@ -43,23 +42,22 @@ module Takeltau
     #
     # ship container start
     #
-    desc 'start [PROJECT]', 'Start project [PROJECT] in a takelship container'
+    desc 'start [PROJECT]', 'Start takelship [PROJECT]'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Start project [PROJECT] in a takelship container
+    Start a takelship and run project [PROJECT] in it.
     LONGDESC
-    # Run command in docker container.
     def start(project = 'default')
-      ship_project_start project
+      project_start = ship_project_start project
+      say project_start if project_start
     end
 
     #
     # ship project stop
     #
-    desc 'stop', 'Stop a takelship container'
+    desc 'stop', 'Stop a takelship project'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
-    Stop a takelship container
+    Stop a takelship container running a project.
     LONGDESC
-    # Stop a takelship container.
     def stop
       say ship_container_stop
     end

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

@@ -4,44 +4,75 @@
 module ShipProjectStart
   # Start a takelship
   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_prerequisites_fulfilled?
 
     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
+
+    ports = _ship_ports_lib_get_ports(takelship, project)
 
-    return false unless _ship_info_lib_valid_project? takelship, project
+    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
+
+    _ship_project_start_print_ports project, ports
   end
 
   private
 
-  # Get takelship ports
-  # 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
+  # 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
+
+    if ship_container_check_existing
+      say "Container \"#{_ship_container_lib_ship_hostname}\" is already started!"
+      return false
+    end
+
+    true
+  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!'
+    false
+  end
+
+  # print ports after starting a takelship
+  def _ship_project_start_print_ports(project, 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}"
     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
+
+  # get max length of left column
+  def _ship_project_start_get_maxlength(ports)
+    max_length = 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
     end
-    ports
+    max_length
   end
 end
-# rubocop:enable Metrics/AbcSize
-# rubocop:enable Metrics/MethodLength

data/lib/takeltau/version

@@ -1 +1 @@
-0.43.23
+0.44.8

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'
@@ -127,6 +130,10 @@ module Takeltau
            aliases: 'l',
            default: 'INFO',
            desc: 'One of: FATAL, ERROR, WARN, INFO, DEBUG'
+    option :workdir,
+           aliases: 'w',
+           default: '',
+           desc: 'Working directory'
     # Initialize takelage cli.
     def initialize(args = [], local_options = {}, configuration = {})
       # Initialize thor parent class
@@ -136,7 +143,7 @@ module Takeltau
       initialize_logging options[:loglevel].to_s.upcase
 
       # Initialize global singleton config
-      initialize_config
+      initialize_config options[:workdir]
 
       # Initialize global singleton project
       initialize_project

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: takeltau
 version: !ruby/object:Gem::Version
-  version: 0.43.23
+  version: 0.44.8
 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