takelage 0.18.1

data/README.md

@@ -0,0 +1,213 @@
+# takelage-cli
+
+*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 
+[thor](http://whatisthor.com/) toolkit.
+
+## Framework
+
+The takelage devops framework consists of these projects:
+
+| App | Description |
+| --- | ----------- |
+| *[takelage-doc](https://github.com/geospin-takelage/takelage-doc)* | takelage documentation |
+| *[takelage-dev](https://github.com/geospin-takelage/takelage-dev)* | takelage development environment |
+| *[takelage-var](https://github.com/geospin-takelage/takelage-var)* | takelage test plugin |
+| *[takelage-cli](https://github.com/geospin-takelage/takelage-cli)* | takelage command line interface |
+| *[takelage-bit](https://github.com/geospin-takelage/takelage-bit)* | takelage bit server | 
+
+## Installation
+
+*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 
+through the [gem](https://github.com/rubygems/rubygems)
+command line tool:
+
+```bash
+gem install takelage
+```
+
+## Commands
+
+*takelage-cli* uses [cucumber](https://github.com/cucumber/cucumber)
+to system test its features.
+You are encouraged to read the cucumber feature files
+for the *tau* commands
+to get an idea of how the commands work.
+You can list the *tau* commands by running
+*tau [self list](features/takelage/self/self.list.feature)*
+or *tau list*:
+
+Command	| Description
+------- | -----------
+tau [bit check workspace](features/takelage/bit/bit.check.workspace.feature) | Check if a bit workspace exists
+tau [bit clipboard copy](features/takelage/bit/bit.clipboard.copy.feature) [DIR] [SCOPE] | Copy new [DIR] to [SCOPE]
+tau [bit clipboard paste](features/takelage/bit/bit.clipboard.paste.feature) [COMPONENT] [DIR] | Paste bit [COMPONENT] into [DIR]
+tau [bit clipboard pull](features/takelage/bit/bit.clipboard.pull.feature) | Pull all updates for bit components from bit remote scopes
+tau [bit clipboard push](features/takelage/bit/bit.clipboard.push.feature) | Push all updates of bit components to bit remote scopes
+tau [bit scope add](features/takelage/bit/bit.scope.add.feature) [SCOPE] | Add a bit [SCOPE]
+tau [bit scope inbit](features/takelage/bit/bit.scope.inbit.feature) | Log in to bit remote server
+tau [bit scope list](features/takelage/bit/bit.scope.list.feature) | List bit remote scopes
+tau [bit scope new](features/takelage/bit/bit.scope.new.feature) [SCOPE] | Init a new bit [SCOPE]
+tau [completion bash](features/takelage/completion/completion.bash.feature) | Print bash completion code
+tau [docker check running](features/takelage/docker/docker.check.running.feature) | Check if docker daemon is running
+tau [docker container check existing](features/takelage/docker/docker.container.check.existing.feature) [CONTAINER] | Check if docker [CONTAINER] is existing
+tau [docker container check network](features/takelage/docker/docker.container.check.network.feature) [NETWORK] | Check if docker [NETWORK] is existing
+tau [docker container check orphaned](features/takelage/docker/docker.container.check.orphaned.feature) [CONTAINER] | Check if docker [CONTAINER] is orphaned
+tau [docker container command](features/takelage/docker/docker.container.command.feature) [CMD] | Run [CMD] in a docker container
+tau [docker container daemon](features/takelage/docker/docker.container.daemon.feature) | Run docker container in daemon mode
+tau [docker container login](features/takelage/docker/docker.container.login.feature) | Log in to latest local docker container
+tau [docker container clean](features/takelage/docker/docker.container.clean.feature) | Remove all docker containers
+tau [docker container prune](features/takelage/docker/docker.container.prune.feature) | Remove orphaned docker containers
+tau [docker image check outdated](features/takelage/docker/docker.image.check.outdated.feature) | Check if a docker image is outdated
+tau [docker image tag check local](features/takelage/docker/docker.image.tag.check.local.feature) [TAG] | Check if local docker image [TAG] exists
+tau [docker image tag check remote](features/takelage/docker/docker.image.tag.check.remote.feature) [TAG] | Check if remote docker image [TAG] exists
+tau [docker image tag latest local](features/takelage/docker/docker.image.tag.latest.local.feature) | Print latest local docker image tag
+tau [docker image tag latest remote](features/takelage/docker/docker.image.tag.latest.remote.feature) | Print latest remote docker image tag
+tau [docker image tag list local](features/takelage/docker/docker.image.tag.list.local.feature) | Print local docker image tags
+tau [docker image tag list remote](features/takelage/docker/docker.image.tag.list.remote.feature) | Print remote docker image tags
+tau [docker image update](features/takelage/docker/docker.image.update.feature) | Get latest remote docker container
+tau [docker socket host](features/takelage/docker/docker.socket.host.feature) | Print docker socket host ip address
+tau [docker socket scheme](features/takelage/docker/docker.socket.scheme.feature) | Print docker socket scheme
+tau [docker socket start](features/takelage/docker/docker.socket.start.feature) | Start sockets for docker container
+tau [docker socket stop](features/takelage/docker/docker.socket.stop.feature) | Stop sockets for docker container
+tau [git check clean](features/takelage/git/git.check.clean.feature) | Check if the git workspace is clean
+tau [git check master](features/takelage/git/git.check.master.feature) | Check if we are on the git master branch
+tau [git check workspace](features/takelage/git/git.check.workspace.feature) | Check if a git workspace exists
+tau [info project active](features/takelage/info/info.project.active.feature) | Print active project info
+tau [info project main](features/takelage/info/info.project.main.feature) | Print main project info
+tau [info project private](features/takelage/info/info.project.private.feature) | Print private project info
+tau [self config active](features/takelage/self/self.config.active.feature) | Print active takelage configuration
+tau [self config default](features/takelage/self/self.config.default.feature) | Print takelage default configuration
+tau [self config home](features/takelage/self/self.config.home.feature) | Print takelage home config file configuration
+tau [self config project](features/takelage/self/self.config.project.feature) | Print takelage project config file configuration
+tau [self list](features/takelage/self/self.list.feature) | List all commands
+tau [self version](features/takelage/self/self.version.feature) | Print tau semantic version number
+tau config | Alias for tau [self config active](features/takelage/self/self.config.active.feature)
+tau copy [DIR] [SCOPE] | Alias for tau [bit clipboard copy](features/takelage/bit/bit.clipboard.copy.feature)
+tau list | Alias for tau [self list](features/takelage/self/self.list.feature)
+tau login | Alias for tau [docker container login](features/takelage/docker/docker.container.login.feature)
+tau clean | Alias for tau [docker container clean](features/takelage/docker/docker.container.clean.feature)
+tau paste [COMPONENT] [DIR] | Alias for tau [bit clipboard paste](features/takelage/bit/bit.clipboard.paste.feature)
+tau project | Alias for tau [info project active](features/takelage/info/info.project.active.feature)
+tau pull | Alias for tau [bit clipboard pull](features/takelage/bit/bit.clipboard.pull.feature)
+tau prune | Alias for tau [docker container prune](features/takelage/docker/docker.container.prune.feature)
+tau push | Alias for tau [bit clipboard push](features/takelage/bit/bit.clipboard.push.feature)
+tau update | Alias for tau [docker image update](features/takelage/docker/docker.image.update.feature)
+tau version | Alias for tau [self version](features/takelage/self/self.version.feature)
+
+**Warning: *tau update* will call *docker image prune* and remove all dangling images!**
+
+## Configuration
+
+### Configuration Files
+
+*takelage-cli* uses three different YAML configuration files
+which have different precedences.
+They are merged to an active configuration during runtime
+which can be inspected with 
+*tau [self config active](features/takelage/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. |
+
+### Configuration Examples
+
+- You should add the following configuration items in your *~/.takelage.yml*
+if you want to use a private bit remote server:
+
+```yaml
+---
+bit_remote: 'ssh://bit@bit.example.com:222:/bit'
+bit_ssh: 'ssh -p 222 bit@bit.example.com'
+```
+
+- By default, takelage uses bright prompt colors which are best viewed on a
+dark background. If you prefer a light background (or want less bright colors)
+you can add an option to your *~/.takelage.yml*:
+
+```yaml
+---
+docker_daynight: 'day'
+```
+
+- If you want to pin a specific docker tag for one of your projects
+then create an *takelage.yml* file with:
+
+```yaml
+---
+docker_tag: '1.2.3'
+```
+
+- The cucumber tests make use of an *~/.takelage.yml*
+to overwrite defaults like:
+
+```yaml
+---
+docker_repo: takelage-mock
+```
+
+Furthermore, every external command can be reconfigured.
+
+### Project Files
+
+*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 
+*tau [info project active](features/takelage/info/info.project.active.feature)*
+or *tau project*.
+
+| Default filename | Config key | Precedence | Description |
+| -------- | ---------- | ---------- | ----------- |
+| *project.yml* | info_project_main | normal | Main project file.  |
+| *private/project.yml* | info_project_private | highest | Private project file. Should be in *.gitignore*. |
+
+### Bash Completion
+
+Add this to your [bash startup files](https://www.gnu.org/software/bash/manual/html_node/Bash-Startup-Files.html):
+
+```bash
+source <(tau completion bash)
+```
+
+### Software Tests
+
+*takelage-cli* ships with 
+[cucumber](https://github.com/cucumber/cucumber) ruby tests.
+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 
+[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: 
+
+```json
+{
+  "insecure-registries": [
+    "host.docker.internal:5005"
+  ]
+}
+```
+
+*takelage-cli* deploys a 
+*[bitboard](https://hub.docker.com/r/takelage/bitboard)*
+server created with 
+*[takelage-bit](https://github.com/geospin-takelage/takelage-bit)*
+to end-to-end test the *tau bit* commands.

data/bin/tau

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'takelage'
+Fylla.load('tau')
+Takelage::CLI.start

data/lib/Thorfile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'takelage'

data/lib/takelage.rb

@@ -0,0 +1,230 @@
+# frozen_string_literal: true
+
+require 'docker_registry2'
+require 'etc'
+require 'fileutils'
+require 'fylla'
+require 'json'
+require 'logger'
+require 'rake'
+require 'singleton'
+require 'socket'
+require 'thor'
+require 'timeout'
+require 'version_sorter'
+require 'yaml'
+
+require_relative 'takelage/lib/logging'
+require_relative 'takelage/lib/subcmd'
+require_relative 'takelage/lib/system'
+require_relative 'takelage/lib/config'
+require_relative 'takelage/lib/project'
+
+require_relative 'takelage/git/check/clean'
+require_relative 'takelage/git/check/master'
+require_relative 'takelage/git/check/workspace'
+require_relative 'takelage/git/check/cli'
+require_relative 'takelage/git/cli'
+require_relative 'takelage/bit/check/workspace'
+require_relative 'takelage/bit/check/cli'
+require_relative 'takelage/bit/scope/add'
+require_relative 'takelage/bit/scope/inbit'
+require_relative 'takelage/bit/scope/list'
+require_relative 'takelage/bit/scope/new'
+require_relative 'takelage/bit/scope/cli'
+require_relative 'takelage/bit/clipboard/lib'
+require_relative 'takelage/bit/clipboard/copy'
+require_relative 'takelage/bit/clipboard/paste'
+require_relative 'takelage/bit/clipboard/pull'
+require_relative 'takelage/bit/clipboard/push'
+require_relative 'takelage/bit/clipboard/cli'
+require_relative 'takelage/bit/cli'
+require_relative 'takelage/completion/cli'
+require_relative 'takelage/docker/check/running'
+require_relative 'takelage/docker/check/cli'
+require_relative 'takelage/docker/socket/lib'
+require_relative 'takelage/docker/socket/host'
+require_relative 'takelage/docker/socket/scheme'
+require_relative 'takelage/docker/socket/start'
+require_relative 'takelage/docker/socket/stop'
+require_relative 'takelage/docker/socket/cli'
+require_relative 'takelage/docker/image/tag/list/local'
+require_relative 'takelage/docker/image/tag/list/remote'
+require_relative 'takelage/docker/image/tag/list/cli'
+require_relative 'takelage/docker/image/tag/latest/local'
+require_relative 'takelage/docker/image/tag/latest/remote'
+require_relative 'takelage/docker/image/tag/latest/cli'
+require_relative 'takelage/docker/image/tag/check/local'
+require_relative 'takelage/docker/image/tag/check/remote'
+require_relative 'takelage/docker/image/tag/check/cli'
+require_relative 'takelage/docker/image/tag/cli'
+require_relative 'takelage/docker/image/check/outdated'
+require_relative 'takelage/docker/image/check/cli'
+require_relative 'takelage/docker/image/update'
+require_relative 'takelage/docker/image/cli'
+require_relative 'takelage/docker/container/check/existing'
+require_relative 'takelage/docker/container/check/network'
+require_relative 'takelage/docker/container/check/orphaned'
+require_relative 'takelage/docker/container/check/cli'
+require_relative 'takelage/docker/container/lib'
+require_relative 'takelage/docker/container/command'
+require_relative 'takelage/docker/container/daemon'
+require_relative 'takelage/docker/container/login'
+require_relative 'takelage/docker/container/clean'
+require_relative 'takelage/docker/container/prune'
+require_relative 'takelage/docker/container/cli'
+require_relative 'takelage/docker/cli'
+require_relative 'takelage/info/project/cli'
+require_relative 'takelage/info/cli'
+require_relative 'takelage/self/config/cli'
+require_relative 'takelage/self/list'
+require_relative 'takelage/self/cli'
+
+# Facilitate the takelage devops workflow.
+module Takelage
+  # takelage
+  class CLI < Thor
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include ProjectModule
+
+    check_unknown_options!
+
+    # @return [String] bash completion code
+    attr_reader :bash_fylla
+
+    option :loglevel,
+           aliases: 'l',
+           default: 'INFO',
+           desc: 'One of: FATAL, ERROR, WARN, INFO, DEBUG'
+    # Initialize takelage cli.
+    def initialize(args = [], local_options = {}, configuration = {})
+      # Initialize thor parent class
+      super args, local_options, configuration
+
+      # Initialize global singleton log
+      initialize_logging options[:loglevel].to_s.upcase
+
+      # Initialize global singleton config
+      initialize_config
+
+      # Initialize global singleton project
+      initialize_project
+
+      # prepare for the worst
+      @docker_daemon_running = false
+
+      # fylla bash completion code
+      @bash_fylla = Fylla.bash_completion self
+    end
+
+    #
+    # Subcommands
+    #
+
+    desc 'bit [COMMAND] ', 'Manage bit'
+    subcommand 'bit', Bit
+
+    desc 'completion [COMMAND] ', 'Print shell completion code'
+    subcommand 'completion', Completion
+
+    desc 'docker [COMMAND] ', 'Manage docker containers'
+    subcommand 'docker', Docker
+
+    desc 'git [COMMAND] ', 'Manage git'
+    subcommand 'git', Git
+
+    desc 'info [COMMAND] ', 'Get information'
+    subcommand 'info', Info
+
+    desc 'self [COMMAND] ', 'Manage takelage tools'
+    subcommand 'self', Self
+
+    #
+    # Top-level commands
+    #
+
+    desc 'config', 'Alias for tau self config active'
+    # takelage config: {takelage::SelfConfig#active}
+    def config
+      Takelage::SelfConfig.new.active
+    end
+
+    desc 'copy [DIR] [SCOPE]', 'Alias for tau bit clipboard copy'
+    # takelage copy: {takelage::BitClipboard#copy}
+    def copy(dir_or_file, scope)
+      Takelage::BitClipboard.new.copy dir_or_file, scope
+    end
+
+    desc 'project', 'Alias for tau info project active'
+    # takelage project: {takelage::InfoProject#active}
+    def project
+      Takelage::InfoProject.new.active
+    end
+
+    desc 'login', 'Alias for tau docker container login'
+    # takelage login: {takelage::DockerContainer#login}
+    def login
+      Takelage::DockerContainer.new.login
+    end
+
+    desc 'list', 'Alias for tau self list'
+    # takelage version: {takelage::Self#list}
+    def list
+      Takelage::Self.new.list
+    end
+
+    desc 'clean', 'Alias for tau docker container clean'
+    # takelage clean: {takelage::DockerContainer#clean}
+    def clean
+      Takelage::DockerContainer.new.clean
+    end
+
+    desc 'paste [COMPONENT] [DIR]', 'Alias for tau bit clipboard paste'
+    # takelage paste: {takelage::BitClipboard#paste}
+    def paste(cid, dir)
+      Takelage::BitClipboard.new.paste cid, dir
+    end
+
+    desc 'pull', 'Alias for tau bit clipboard pull'
+    # takelage pull: {takelage::BitClipboard#pull}
+    def pull
+      Takelage::BitClipboard.new.pull
+    end
+
+    desc 'prune', 'Alias for tau docker container prune'
+    # takelage prune: {takelage::DockerContainer#prune}
+    def prune
+      Takelage::DockerContainer.new.prune
+    end
+
+    desc 'push', 'Alias for tau bit clipboard push'
+    # takelage push: {takelage::BitClipboard#push}
+    def push
+      Takelage::BitClipboard.new.push
+    end
+
+    desc 'update', 'Alias for tau docker image update'
+    # takelage update: {takelage::DockerImage#update}
+    def update
+      Takelage::DockerImage.new.update
+    end
+
+    desc 'version', 'Alias for tau self version'
+    # takelage version: {takelage::Self#version}
+    def version
+      Takelage::Self.new.version
+    end
+
+    #
+    # Administrative functions
+    #
+
+    # Behave as expected by correctly reporting failure in exit status.
+    # See https://github.com/erikhuda/thor/wiki/Making-An-Executable
+    def self.exit_on_failure?
+      true
+    end
+  end
+end