takelage 0.25.10 → 0.26.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e946f65c7d82b399bff9b24ad38f5f35692b1984fb3b24a746b9a79d949ff68
-  data.tar.gz: 22ca88e0d4c57564caafe1fbabd6fb2ec18fe85da30b78edec4286d0f807555f
+  metadata.gz: 98366dc05dd33f98b17be99056fcac490af4d5d94b7f6ff6e4b26b76aeb641b7
+  data.tar.gz: 236580e61eeb4820c76aa1c685ffa4e0b84d1dd438d5decbb80af3957ac195da
 SHA512:
-  metadata.gz: 321defb1e6c775e1fdf69d85fba71f2265602be4db53705b204b4e10096d73c517762e71e910af09cf717bb112f736c1705802ccdfc44a1289ab9e5183f2fbe2
-  data.tar.gz: 58ab87995c99d0ff2059b9d7def178b3489276e18787c8744c66d43c2bc4d82f80ba959f19e31b3a3084e14c04d99515324ba69ec5b743fc267eb6bb091a8a65
+  metadata.gz: d30c5477ca06ff1dad259ff2b6c03bb5f62b63227307981efafac6f74a6ee6f0e298d1191efe87ac9b0e777c3b2758e1fd537734f77dd5c9b825e695d8a94ab9
+  data.tar.gz: febee8477c3168f2e23e588077fecfe43df4a8557d7927067eb572065e65e5591fccba41227582f75a20853de24127137bbfdb97dd1645a04ab62bcf35668946

data/lib/takelage.rb

@@ -71,6 +71,13 @@ 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/status/lib'
+require_relative 'takelage/info/status/git'
+require_relative 'takelage/info/status/gopass'
+require_relative 'takelage/info/status/gpg'
+require_relative 'takelage/info/status/ssh'
+require_relative 'takelage/info/status/header'
+require_relative 'takelage/info/status/cli'
 require_relative 'takelage/info/project/cli'
 require_relative 'takelage/info/cli'
 require_relative 'takelage/self/config/cli'
@@ -203,6 +210,12 @@ module Takelage
       Takelage::BitClipboard.new.push
     end
 
+    desc 'status', 'Alias for tau info status header'
+    # takelage status: {takelage::InfoStatus#header}
+    def status
+      Takelage::InfoStatus.new.header
+    end
+
     desc 'update', 'Alias for tau docker image update'
     # takelage update: {takelage::DockerImage#update}
     def update

data/lib/takelage/default.yml

@@ -58,6 +58,14 @@ cmd_git_check_clean_git_status: 'git status --porcelain'
 cmd_git_check_main_git_branch: 'git symbolic-ref HEAD'
 cmd_git_check_workspace_git_repo: 'git -C . rev-parse'
 cmd_git_check_workspace_pwd: 'pwd'
+cmd_info_status_lib_git_name: 'git -C %{root} config user.name'
+cmd_info_status_lib_git_email: 'git -C %{root} config user.email'
+cmd_info_status_lib_git_signingkey: 'git -C %{root} config user.signingKey'
+cmd_info_status_lib_git_key_available: 'gpg --list-key %{key}'
+cmd_info_status_gopass_root_store: 'gopass config | grep "path" | cut -d " " -f 2'
+cmd_info_status_gpg_agent: 'gpg-connect-agent /bye'
+cmd_info_status_gpg_keys: 'gpg --list-keys'
+cmd_info_status_ssh_keys: 'ssh-add -l'
 docker_debug: 'ansible/roles/takel-takelage/files/takelscripts'
 docker_entrypoint_extra: '.config/gcloud'
 docker_entrypoint_options: ''

data/lib/takelage/git/check/workspace.rb

@@ -19,8 +19,7 @@ module GitCheckWorkspace
 
   # Get git repository status.
   def _git_check_workspace_get_status_repo
-    cmd_git_repo =
-      config.active['cmd_git_check_workspace_git_repo']
+    cmd_git_repo = config.active['cmd_git_check_workspace_git_repo']
     try cmd_git_repo
   end
 

data/lib/takelage/info/cli.rb

@@ -5,5 +5,8 @@ module Takelage
   class Info < SubCommandBase
     desc 'project [COMMAND]', 'Get project info'
     subcommand 'project', InfoProject
+
+    desc 'status [COMMAND]', 'Get status info'
+    subcommand 'status', InfoStatus
   end
 end

data/lib/takelage/info/status/cli.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Takelage
+  # takelage info status
+  class InfoStatus < SubCommandBase
+    include LoggingModule
+    include SystemModule
+    include ConfigModule
+    include DockerSocketScheme
+    include InfoStatusLib
+    include InfoStatusGit
+    include InfoStatusGopass
+    include InfoStatusGPG
+    include InfoStatusSSH
+    include InfoStatusHeader
+
+    #
+    # info status git
+    #
+    desc 'git', 'Check git status info'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check git status info
+    LONGDESC
+    # Check git status info.
+    def git
+      exit info_status_git
+    end
+
+    #
+    # info status gopass
+    #
+    desc 'gopass', 'Check gopass status info'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check gopass status info
+    LONGDESC
+    # Check gopass status info.
+    def gopass
+      exit info_status_gopass
+    end
+
+    #
+    # info status gpg
+    #
+    desc 'gpg', 'Check gpg status info'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check gpg status info
+    LONGDESC
+    # Check gpg status info.
+    def gpg
+      exit info_status_gpg
+    end
+
+    #
+    # info status header
+    #
+    desc 'header', 'Print status info header'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Print status info header
+    LONGDESC
+    # Print status info header.
+    def header
+      say info_status_header
+    end
+
+    #
+    # info status ssh
+    #
+    desc 'ssh', 'Check ssh status info'
+    long_desc <<-LONGDESC.gsub("\n", "\x5")
+    Check ssh status info
+    LONGDESC
+    # Check ssh status info.
+    def ssh
+      exit info_status_ssh
+    end
+  end
+end

data/lib/takelage/info/status/git.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# takelage info status git
+module InfoStatusGit
+  # Backend method for info status git.
+  # @return [Boolean] is the git gpg signing key available?
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/AbcSize
+  def info_status_git
+    log.debug 'Check git status'
+
+    root = config.active['project_root_dir']
+
+    if root.strip.empty?
+      log.error 'Cannot determine project root directory'
+      log.info 'Is there a Rakefile in the project root directory?'
+      return false
+    end
+
+    if _info_status_lib_git_name(root).strip.empty?
+      log.error 'git config user.name is not available'
+      return false
+    end
+
+    if _info_status_lib_git_email(root).strip.empty?
+      log.error 'git config user.email is not available'
+      return false
+    end
+
+    key = _info_status_lib_git_signingkey(root)
+
+    unless _info_status_lib_git_key_available(key).exitstatus.zero?
+      log.error 'git config user.signingkey is not available'
+      return false
+    end
+
+    log.debug 'git config is available'
+    true
+  end
+  # rubocop:enable Metrics/AbcSize
+  # rubocop:enable Metrics/MethodLength
+end

data/lib/takelage/info/status/gopass.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# takelage info status gopass
+module InfoStatusGopass
+  # Backend method for info status gopass.
+  # @return [Boolean] is gopass available?
+  # rubocop:disable Metrics/MethodLength
+  def info_status_gopass
+    log.debug 'Check gopass status'
+
+    root = _info_status_gopass_root_store.chomp
+
+    if root.strip.empty?
+      log.error 'gopass root store not found'
+      return false
+    end
+
+    key = _info_status_lib_git_signingkey(root)
+
+    unless _info_status_lib_git_key_available(key).exitstatus.zero?
+      log.error 'gopass root store gpg key is not available'
+      return false
+    end
+
+    log.debug 'gopass is available'
+    true
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  private
+
+  # Get gopass root store
+  def _info_status_gopass_root_store
+    cmd_gopass_root_store = config.active['cmd_info_status_gopass_root_store']
+    run cmd_gopass_root_store
+  end
+end

data/lib/takelage/info/status/gpg.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# takelage info status gpg
+module InfoStatusGPG
+  # Backend method for info status gpg.
+  # @return [Boolean] is GPG available?
+  # rubocop:disable Metrics/MethodLength
+  def info_status_gpg
+    log.debug 'Check gpg status'
+
+    unless _info_status_gpg_keys
+      log.error 'gpg keys are not available'
+      return false
+    end
+
+    unless _info_status_gpg_agent
+      log.error 'gpg agent is not available'
+      return false
+    end
+
+    log.debug 'gpg is available'
+    true
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  private
+
+  # Check gpg keys
+  def _info_status_gpg_keys
+    status_keys = try config.active['cmd_info_status_gpg_keys']
+    status_keys.exitstatus.zero?
+  end
+
+  # Check gpg agent
+  def _info_status_gpg_agent
+    status_agent = try config.active['cmd_info_status_gpg_agent']
+    status_agent.exitstatus.zero?
+  end
+end

data/lib/takelage/info/status/header.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# takelage info status header
+module InfoStatusHeader
+  # Backend method for info status header.
+  # @return [String] status info header
+  # rubocop:disable Metrics/MethodLength
+  def info_status_header
+    log.debug 'Get status info header'
+
+    @header_list = []
+
+    _info_status_header_takelage
+    _info_status_header_tau
+    _info_status_header_git
+    _info_status_header_gopass
+    _info_status_header_gpg
+    _info_status_header_ssh
+
+    header = @header_list.join(' | ')
+    log.debug "status info header: #{header}"
+    header
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  private
+
+  # Add takelage version info to header
+  def _info_status_header_takelage
+    takelage_version_file = '/etc/takelage_version'
+    return unless _file_exists? takelage_version_file
+
+    _file_read takelage_version_file
+    @header_list << "takelage: #{@content_file.chomp.green}"
+  end
+
+  # Add tau version info to header
+  def _info_status_header_tau
+    @header_list << "tau: #{Takelage::VERSION.green}"
+  end
+
+  # Add git status info to header
+  def _info_status_header_git
+    @status_git = info_status_git
+    @header_list << ("git: #{@status_git ? 'ok'.green : 'no'.red}")
+  end
+
+  # Add gopass status info to header
+  def _info_status_header_gopass
+    @status_gopass = info_status_gopass
+    @header_list << ("gopass: #{@status_gopass ? 'ok'.green : 'no'.red}")
+  end
+
+  # Add gpg status info to header
+  def _info_status_header_gpg
+    if @status_git || @status_gopass
+      @header_list << "gpg: #{'ok'.green}"
+      return
+    end
+
+    @header_list << ("gpg: #{info_status_gpg ? 'ok'.green : 'no'.red}")
+  end
+
+  # Add ssh status info to header
+  def _info_status_header_ssh
+    @header_list << ("ssh: #{info_status_ssh ? 'ok'.green : 'no'.red}")
+  end
+end
+
+# Amend String class with colorization
+class String
+  # Colorize strings
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  # String color red
+  def red
+    colorize(31)
+  end
+
+  # String color green
+  def green
+    colorize(32)
+  end
+
+  # String color yellow
+  def yellow
+    colorize(33)
+  end
+
+  # String color blue
+  def blue
+    colorize(34)
+  end
+
+  # String color pink
+  def pink
+    colorize(35)
+  end
+
+  # String color light_blue
+  def light_blue
+    colorize(36)
+  end
+end

data/lib/takelage/info/status/lib.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# takelage info status lib
+module InfoStatusLib
+  private
+
+  # Get git config user name
+  def _info_status_lib_git_name(root)
+    cmd_git_name =
+      format(
+        config.active['cmd_info_status_lib_git_name'],
+        root: root
+      )
+    run cmd_git_name
+  end
+
+  # Get git config user email
+  def _info_status_lib_git_email(root)
+    cmd_git_email =
+      format(
+        config.active['cmd_info_status_lib_git_email'],
+        root: root
+      )
+    run cmd_git_email
+  end
+
+  # Get git config user signingkey
+  def _info_status_lib_git_signingkey(root)
+    cmd_git_signingkey =
+      format(
+        config.active['cmd_info_status_lib_git_signingkey'],
+        root: root
+      )
+    run cmd_git_signingkey
+  end
+
+  # Check if git key is available
+  def _info_status_lib_git_key_available(key)
+    cmd_git_key_available =
+      format(
+        config.active['cmd_info_status_lib_git_key_available'],
+        key: key
+      )
+    try cmd_git_key_available
+  end
+end

data/lib/takelage/info/status/ssh.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# takelage info status ssh
+module InfoStatusSSH
+  # Backend method for info status ssh.
+  # @return [Boolean] is ssh available?
+  # rubocop:disable Metrics/MethodLength
+  def info_status_ssh
+    log.debug 'Check ssh status'
+
+    ssh_socket_path = _socket_get_agent_ssh_socket_path
+
+    unless ENV['SSH_AUTH_SOCK'] == ssh_socket_path
+      log.error 'gpg ssh socket is misconfigured'
+      return false
+    end
+
+    unless _file_exists? ssh_socket_path
+      log.error 'gpg ssh socket is not available'
+      return false
+    end
+
+    unless _info_status_ssh_keys
+      log.error 'ssh keys are not available'
+      return false
+    end
+
+    log.debug 'ssh is available'
+    true
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  private
+
+  # Check ssh keys
+  def _info_status_ssh_keys
+    status_keys = try config.active['cmd_info_status_ssh_keys']
+    status_keys.exitstatus.zero?
+  end
+end

data/lib/takelage/version

@@ -1 +1 @@
-0.25.10
+0.26.2

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: takelage
 version: !ruby/object:Gem::Version
-  version: 0.25.10
+  version: 0.26.2
 platform: ruby
 authors:
 - Geospin
@@ -259,6 +259,13 @@ files:
 - lib/takelage/git/cli.rb
 - lib/takelage/info/cli.rb
 - lib/takelage/info/project/cli.rb
+- lib/takelage/info/status/cli.rb
+- lib/takelage/info/status/git.rb
+- lib/takelage/info/status/gopass.rb
+- lib/takelage/info/status/gpg.rb
+- lib/takelage/info/status/header.rb
+- lib/takelage/info/status/lib.rb
+- lib/takelage/info/status/ssh.rb
 - lib/takelage/lib/config.rb
 - lib/takelage/lib/logging.rb
 - lib/takelage/lib/project.rb