takeltau 0.44.19 → 0.44.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5d0871bd24f476f6349d62f2cb177c18fb6e1b66df92c6f26130c7474dfba43
-  data.tar.gz: f4b9a65df03c97a890e696571c377c350f5b961367d2657a1efb895335397fa2
+  metadata.gz: deb82fda940a4ff5a0a2bf71cc84bf813589c07eda38a3d2040f825738b1d443
+  data.tar.gz: d41134f25c52879dcba44f08a6fdd4b910a884a410f02728d5f2413ae70c5338
 SHA512:
-  metadata.gz: 45344bf0fa90a346ac8bc403b990c387682381cf00c6562567ae67b1c184130df7c030fcab0691371fe8f47b3a990bf14b2a649a98b016902722faf1829a3cc2
-  data.tar.gz: 39c3c22e12e95bd0b6f4729ebe19fe79879900bf8f67a92ebb15ac92726d7a3d2f0cfa2b0a806c68ece2e17fa702512c31f60793bc167a10426231c3381c589b
+  metadata.gz: 2245845fa2cfe9ab835d416dc7502487cbedcc652a8e6191ddeb69267f9dc48d0e81a96d9f04ed985972e645da8da8fe861ac4695fff6f0a94f65ec8dcb85b80
+  data.tar.gz: 73b097fe9c5426567c53a2d7b1d95e92b7d0ca25817d6731f0cc32b9765efbf2016a96a7cd5d3d4d482e864d1d9844dae537cb58beb2f6c32ed463c0b5f999ab

data/README.md

@@ -1,13 +1,13 @@
 # takelage-cli
 
-*takelage-cli* is a command line interface 
+*takelage-cli* is a command line interface
 to facilitate the takelage devops workflow.
 The takelage devops workflow helps devops engineers
 build, test and deploy os images.
 
-The *takelage-cli* executable `tau` is a 
-[ruby](https://www.ruby-lang.org/) 
-command line script using the 
+The *takelage-cli* executable `tau` is a
+[ruby](https://www.ruby-lang.org/)
+command line script using the
 [thor](http://whatisthor.com/) toolkit.
 
 *takelage-cli* is also the remote control for the
@@ -50,9 +50,9 @@ The *takelage-cli* executable `ship` is a wrapper for `tau ship`.
 
 ## Installation
 
-*tau* is part of *takelage-dev*'s docker image 
+*tau* is part of *takelage-dev*'s docker image
 but you typically want to install it on the host system as well.
-Install the takelage gem and its dependencies 
+Install the takelage gem and its dependencies
 through the [gem](https://github.com/rubygems/rubygems)
 command line tool:
 
@@ -123,13 +123,16 @@ or *tau commands*:
 | 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 command](features/cucumber/features/ship/container/ship.container.command.feature) [CMD] | Run a bash command in a takelship container |
 | tau [ship container list](features/cucumber/features/ship/container/ship.container.list.feature) | List takelships |
+| tau [ship container hostname](features/cucumber/features/ship/container/ship.container.hostname.feature) | Print takelship hostname |
 | tau [ship container login](features/cucumber/features/ship/container/ship.container.login.feature) | Log in to a takelship |
 | tau [ship container logs](features/cucumber/features/ship/container/ship.container.logs.feature) | Print the takelship logs |
-| tau [ship container podman](features/cucumber/features/ship/container/ship.container.podman.feature) [COMMAND] | Run a podman [COMMAND] in a takelship |
+| tau [ship container name](features/cucumber/features/ship/container/ship.container.name.feature) | Print the takelship name |
+| tau [ship container podman](features/cucumber/features/ship/container/ship.container.podman.feature) [CMD] | Run a podman command in a takelship |
+| tau [ship container shipdir](features/cucumber/features/ship/container/ship.container.shipdir.feature) | Print takelship shipdir |
 | 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 sudo](features/cucumber/features/ship/container/ship.container.sudo.feature) [CMD] | 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 |
@@ -140,17 +143,20 @@ or *tau commands*:
 | tau [ship project stop](features/cucumber/features/ship/project/ship.project.stop.feature) | Stop a takelship project |
 | tau [ship project update](features/cucumber/features/ship/project/ship.project.create.feature) [PROJECT] | Update 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 clean | Alias for tau [ship container clean](features/cucumber/features/ship/container/ship.container.clean.feature) |
+| tau ship command [CMD] | Alias for tau [ship container command](features/cucumber/features/ship/container/ship.container.command.feature) |
+| tau ship docker [CMD] | Alias for tau [ship container podman](features/cucumber/features/ship/container/ship.container.podman.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 | Alias for tau [ship container logs](features/cucumber/features/ship/container/ship.container.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 name | Alias for tau [ship container list](features/cucumber/features/ship/container/ship.container.name.feature) |
+| tau ship podman [CMD] | 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 restart [PROJECT] | Alias for tau [ship project restart](features/cucumber/features/ship/project/ship.project.restart.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 sudo [CMD] | 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) |
@@ -173,7 +179,7 @@ or *tau commands*:
 
 *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 
+which can be inspected with
 *tau [self config active](features/cucumber/features/self/self.config.active.feature)*
 or *tau config*.
 
@@ -197,7 +203,7 @@ The project directory is identified by the first match:
 ### Configuration Examples
 
 - You should add the following configuration items in your *~/.takelage.yml*
-if you want to use the *takelbeta* docker image channel:
+  if you want to use the *takelbeta* docker image channel:
 
 ```yaml
 ---
@@ -205,7 +211,7 @@ docker_repo: takelbeta
 ```
 
 - If you want to pin a specific docker tag for one of your projects
-then create an *takelage.yml* file with:
+  then create an *takelage.yml* file with:
 
 ```yaml
 ---
@@ -213,18 +219,18 @@ docker_tag: '1.2.3'
 ```
 
 - The cucumber tests make use of an *~/.takelage.yml*
-to overwrite defaults like:
+  to overwrite defaults like:
 
 ```yaml
 ---
 docker_repo: takelage-mock
 ```
 
-- You may prefer to interact with 
-[mercurial](https://github.com/takelwerk/takelage-doc/blob/main/doc/tau/hg.md)
-through `tau hg`
-in a different branch than `main` in one project so you may add
-to your *takelage.yml*:
+- You may prefer to interact with
+  [mercurial](https://github.com/takelwerk/takelage-doc/blob/main/doc/tau/hg.md)
+  through `tau hg`
+  in a different branch than `main` in one project so you may add
+  to your *takelage.yml*:
 
 
 ```yaml
@@ -232,7 +238,7 @@ to your *takelage.yml*:
 git_hg_repo: my_git_hg_branch
 ```
 
-Furthermore, 
+Furthermore,
 [every external command](https://github.com/takelwerk/takelage-cli/blob/main/lib/takeltau/default.yml)
 can be reconfigured.
 
@@ -241,7 +247,7 @@ can be reconfigured.
 *tau* reads two different YAML project files
 which have different precedences.
 They are merged to an active configuration during runtime
-which can be inspected with 
+which can be inspected with
 *tau [info project active](features/cucumber/features/info/info.project.active.feature)*
 or *tau project*.
 
@@ -263,24 +269,24 @@ source <(tau completion bash)
 *takelage-cli* uses
 [minitest](https://github.com/seattlerb/minitest) unit tests.
 
-*takelage-cli* ships with 
+*takelage-cli* ships with
 [cucumber](https://github.com/cucumber/cucumber) ruby system tests.
-It uses cucumber's 
+It uses cucumber's
 [aruba](https://github.com/cucumber/aruba) extension and especially its
 [filesystem](https://relishapp.com/cucumber/aruba/v/0-11-0/docs/filesystem)
 library.
 
 *takelage-cli* [deploys](https://docs.docker.com/registry/deploying/)
-a private docker 
+a private docker
 [registry](https://hub.docker.com/_/registry)
 to conduct end-to-end tests of *tau docker* commands.
-The registry exposes port 5005. 
-You need to whitelist it in your host's docker engine configuration: 
+The registry exposes port 5005.
+You need to whitelist it in your host's docker engine configuration:
 
 ```json
 {
-"insecure-registries": [
-"host.docker.internal:5005"
-]
+  "insecure-registries": [
+    "host.docker.internal:5005"
+  ]
 }
 ```

data/lib/takeltau/lib/logging.rb

@@ -14,8 +14,9 @@ module LoggingModule
   end
 
   # Initialize logger with loglevel.
-  def initialize_logging(loglevel)
+  def initialize_logging(loglevel, debug)
     TakeltauLogger.instance.logger.formatter = _logging_get_log_format
+    loglevel = 'DEBUG' if debug
     log_level_in_use = _logging_get_log_level loglevel
     TakeltauLogger.instance.logger.level = log_level_in_use
     TakeltauLogger.instance.logger.debug "Using loglevel #{log_level_in_use}"

data/lib/takeltau/self/commands.rb

@@ -4,7 +4,7 @@
 module SelfCommands
   # Backend method for config self commands.
   def self_commands
-    _manipulate_output_(_get_thor_list_)
+    _manipulate_output_ _get_thor_list_
   end
 
   private

data/lib/takeltau/ship/cli.rb

@@ -2,7 +2,6 @@
 
 module Takeltau
   # tau ship
-  # rubocop:disable Metrics/ClassLength
   class Ship < SubCommandBase
     include LoggingModule
     include SystemModule
@@ -26,7 +25,7 @@ module Takeltau
     desc 'info [COMMAND]', 'Get info about takelship containers'
     subcommand 'info', ShipInfo
 
-    desc 'ports [COMMAND]', 'Manage takelship portss'
+    desc 'ports [COMMAND]', 'Manage takelship ports'
     subcommand 'ports', ShipPorts
 
     desc 'project [COMMAND]', 'Manage takelship projects'
@@ -46,7 +45,17 @@ module Takeltau
       Takeltau::ShipContainer.new.login
     end
 
-    desc 'command [COMMAND]', 'Run a [COMMAND] in a takelship'
+    desc 'clean', 'Stop all takelships'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Stop all takelship containers.
+    Alias for ship container clean.
+    LONGDESC
+    # ship clean: {Takeltau::ShipProject#clean}
+    def clean
+      Takeltau::ShipProject.new.clean
+    end
+
+    desc 'command [CMD]', 'Run a bash 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.
@@ -56,6 +65,16 @@ module Takeltau
       Takeltau::ShipContainer.new.command(*args)
     end
 
+    desc 'docker [CMD]', '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 docker: {Takeltau::ShipContainer#podman}
+    def docker(*args)
+      Takeltau::ShipContainer.new.podman(*args)
+    end
+
     desc 'list', 'List takelships'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
     List takelship containers.
@@ -96,7 +115,7 @@ module Takeltau
       Takeltau::ShipContainer.new.list
     end
 
-    desc 'podman [COMMAND]', 'Run a podman [COMMAND] in a takelship'
+    desc 'podman [CMD]', '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.
@@ -117,7 +136,7 @@ module Takeltau
       Takeltau::ShipProject.new.restart project
     end
 
-    desc 'sudo [COMMAND]', 'Run a sudo [COMMAND] in a takelship'
+    desc 'sudo [CMD]', '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.
@@ -177,5 +196,4 @@ module Takeltau
       Takeltau::ShipContainer.new.update
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

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

@@ -37,7 +37,7 @@ module Takeltau
     #
     # ship container command
     #
-    desc 'command [COMMAND]', 'Run a [COMMAND] in a takelship container'
+    desc 'command [CMD]', 'Run a bash command in a takelship container'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
     Run a command in a takelship container as user podman.
     LONGDESC
@@ -45,6 +45,19 @@ module Takeltau
       say ship_container_command args
     end
 
+    #
+    # ship container hostname
+    #
+    desc 'hostname', 'Print the takelship hostname'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print the hostname of the takelship container.
+    LONGDESC
+    def hostname
+      say _ship_container_lib_ship_hostname
+      exit false unless ship_container_check_existing
+      true
+    end
+
     #
     # ship container list
     #
@@ -83,7 +96,7 @@ module Takeltau
     #
     # ship container podman
     #
-    desc 'podman [COMMAND]', 'Run a podman [COMMAND] in a takelship'
+    desc 'podman [CMD]', 'Run a podman command in a takelship'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
     Run a podman command as user podman in a takelship container.
     LONGDESC
@@ -91,10 +104,23 @@ module Takeltau
       say ship_container_podman args
     end
 
+    #
+    # ship container shipdir
+    #
+    desc 'shipdir', 'Print the takelship project root dir'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print the project root directory of the takelship container.
+    LONGDESC
+    def shipdir
+      say config.active['project_root_dir']
+      exit false unless ship_container_check_existing
+      true
+    end
+
     #
     # ship container sudo
     #
-    desc 'sudo [COMMAND]', 'Run a sudo [COMMAND] in a takelship'
+    desc 'sudo [CMD]', 'Run a sudo command in a takelship'
     long_desc <<-LONGDESC.gsub("\n", "\x5")
     Run a command as root in a takelship container.
     LONGDESC

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

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

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

@@ -63,8 +63,7 @@ module Takeltau
     Start a takelship and run project [PROJECT] in it.
     LONGDESC
     def start(project = 'default')
-      project_start = ship_project_start project
-      say project_start if project_start
+      exit ship_project_start project
     end
 
     #

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

@@ -11,15 +11,16 @@ module ShipProjectStart
     return false unless _ship_project_start_valid_project? takelship, project
 
     ports = _ship_ports_lib_get_ports(takelship, project)
-    return false unless _ship_project_start_sailing? project, ports
+    return false if _ship_project_start_already_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
-    say "Started project \"#{project}\" on takelship \"#{_ship_container_lib_ship_hostname}\".\n\n"
+    _ship_project_start_print_banner project
     _ship_project_start_print_ports ports
+    true
   end
 
   private
@@ -33,12 +34,12 @@ module ShipProjectStart
   end
 
   # check if the takelship is already existng
-  def _ship_project_start_sailing?(project, ports)
-    return true unless ship_container_check_existing
+  def _ship_project_start_already_sailing?(project, ports)
+    return false 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
+    _ship_project_start_print_banner project
+    _ship_project_start_print_ports ports
+    true
   end
 
   # check if the project is a valid takelship project
@@ -46,10 +47,20 @@ module ShipProjectStart
     return true if _ship_info_lib_valid_project? takelship, project
 
     say 'No valid project found!'
-    say 'Hint: ship project list'
+    say 'Try: ship project list'
     false
   end
 
+  # print banner with status information
+  def _ship_project_start_print_banner(project)
+    ship_hostname = _ship_container_lib_ship_hostname
+    ship_dir = _docker_container_lib_homify_dir config.active['project_root_dir']
+    say "The takelship #{ship_hostname}"
+    say "departed from #{ship_dir}"
+    say "ships project #{project}"
+    say
+  end
+
   # print ports after starting a takelship
   def _ship_project_start_print_ports(ports)
     output = []
@@ -63,7 +74,7 @@ module ShipProjectStart
       description = " (#{description})" if port.key? 'description'
       output << "#{url.ljust(max_length['url'])} #{service.ljust(max_length['service'])}#{description}"
     end
-    output.join("\n")
+    say output.join("\n")
   end
 
   # get max length of left column

data/lib/takeltau/version

@@ -1 +1 @@
-0.44.19
+0.44.24

data/lib/takeltau.rb

@@ -127,6 +127,11 @@ module Takeltau
     # @return [String] bash completion code
     attr_reader :bash_fylla
 
+    option :debug,
+           aliases: 'd',
+           type: :boolean,
+           default: false,
+           desc: 'Alias for --loglevel=debug'
     option :loglevel,
            aliases: 'l',
            default: 'INFO',
@@ -141,7 +146,7 @@ module Takeltau
       super
 
       # Initialize global singleton log
-      initialize_logging options[:loglevel].to_s.upcase
+      initialize_logging options[:loglevel].to_s.upcase, options[:debug]
 
       # Initialize global singleton config
       initialize_config options[:workdir]

metadata

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