takelage 0.13.2 → 0.13.3

data/lib/takelage/docker/image/tag/latest/module.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 # takelage docker image tag latest module
 module DockerImageTagLatestModule
-
   # Backend method for docker image tag latest local.
   # @return [String] latest local docker image tag
   def docker_image_tag_latest_local
-    log.debug "Getting latest local docker image tag"
+    log.debug 'Getting latest local docker image tag'
 
     return false unless docker_check_running
 
@@ -20,14 +21,14 @@ module DockerImageTagLatestModule
   # Backend method for docker image tag latest remote.
   # @return [String] latest remote docker image tag
   def docker_image_tag_latest_remote
-    log.debug "Getting latest remote docker image tag"
+    log.debug 'Getting latest remote docker image tag'
 
     return false unless docker_check_running
 
     tags = docker_image_tag_list_remote
 
-    if tags == false or tags.nil?
-      log.warn "No latest docker remote tag"
+    if tags == false || tags.nil?
+      log.warn 'No latest docker remote tag'
       return ''
     end
 

data/lib/takelage/docker/image/tag/list/cli.rb

@@ -1,8 +1,8 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage docker image tag list
   class DockerImageTagList < SubCommandBase
-
     include LoggingModule
     include SystemModule
     include ConfigModule
@@ -11,7 +11,6 @@ module Takelage
 
     # Initialize takelage docker image tag list
     def initialize(args = [], local_options = {}, configuration = {})
-
       # initialize thor parent class
       super args, local_options, configuration
 

data/lib/takelage/docker/image/tag/list/module.rb

@@ -1,20 +1,18 @@
+# frozen_string_literal: true
+
 # takelage docker image tag list module
 module DockerImageTagListModule
-
   # Backend method for docker image tag list local.
   # @return [Array] local docker image tags
   def docker_image_tag_list_local
-    tags = []
-
     cmd_docker_tags =
-        config.active['cmd_docker_image_tag_list_local_docker_images'] % {
-            docker_user: @docker_user,
-            docker_repo: @docker_repo
-        }
-
-    stdout_str = run cmd_docker_tags
+      format(
+        config.active['cmd_docker_image_tag_list_local_docker_images'],
+        docker_user: @docker_user,
+        docker_repo: @docker_repo
+      )
 
-    tags = stdout_str.split("\n")
+    tags = (run cmd_docker_tags).split("\n")
 
     VersionSorter.sort(tags)
   end
@@ -22,19 +20,24 @@ module DockerImageTagListModule
   # Backend method for docker image tag list remote.
   # @return [Array] remote docker image tags
   def docker_image_tag_list_remote
-    log.debug "Getting docker remote tags " +
-                  "of \"#{@docker_user}/#{@docker_repo}\" " +
-                  "from \"#{@docker_registry}\""
+    log.debug 'Getting docker remote tags ' \
+      "of \"#{@docker_user}/#{@docker_repo}\" " \
+      "from \"#{@docker_registry}\""
+    _docker_image_tag_list_remote_tags
+  end
+
+  private
 
+  # Get docker remote tags.
+  def _docker_image_tag_list_remote_tags
     user = File.basename @docker_user
     begin
       registry = DockerRegistry2.connect(@docker_registry)
       tags = registry.tags("#{user}/#{@docker_repo}")
+      VersionSorter.sort(tags['tags'])
     rescue RestClient::Exceptions::OpenTimeout
       log.error "Timeout while connecting to \"#{@docker_registry}\""
-      return false
+      false
     end
-
-    VersionSorter.sort(tags['tags'])
   end
 end

data/lib/takelage/docker/socket/cli.rb

@@ -1,8 +1,8 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage docker socket
   class DockerSocket < SubCommandBase
-
     include LoggingModule
     include SystemModule
     include ConfigModule
@@ -11,7 +11,6 @@ module Takelage
 
     # Initialize docker socket
     def initialize(args = [], local_options = {}, configuration = {})
-
       # initialize thor parent class
       super args, local_options, configuration
 

data/lib/takelage/docker/socket/module.rb

@@ -1,42 +1,19 @@
+# frozen_string_literal: true
+
 # takelage docker socket module
 module DockerSocketModule
-
   # Backend method for docker socket scheme.
   def docker_socket_scheme
     log.debug 'Getting docker socket scheme'
 
-    cmd_agent_socket_path =
-        config.active['cmd_docker_socket_config_agent_socket_path']
-
-    agent_socket_path = run cmd_agent_socket_path
-    agent_socket_path.chomp!
-
-    agent_socket_port =
-        config.active['docker_socket_gpg_agent_port']
-
-    cmd_agent_ssh_socket_path =
-        config.active['cmd_docker_socket_config_agent_ssh_socket_path']
-
-    agent_ssh_socket_path = run cmd_agent_ssh_socket_path
-    agent_ssh_socket_path.chomp!
-
-    agent_ssh_socket_port =
-        config.active['docker_socket_gpg_ssh_agent_port']
+    gpg_path = _socket_get_agent_socket_path
+    gpg_port = config.active['docker_socket_gpg_agent_port']
+    ssh_path = _socket_get_agent_ssh_socket_path
+    ssh_port = config.active['docker_socket_gpg_ssh_agent_port']
 
-    socket_scheme = {
-        'agent-socket' => {
-            'path' => agent_socket_path,
-            'host' => @socket_host,
-            'port' => agent_socket_port
-        },
-        'agent-ssh-socket' => {
-            'path' => agent_ssh_socket_path,
-            'host' => @socket_host,
-            'port' => agent_ssh_socket_port
-        }
-    }
-
-    log.debug "Docker socket scheme is \n\"\"\"\n#{hash_to_yaml socket_scheme}\"\"\""
+    socket_scheme = _socket_get_scheme gpg_path, gpg_port, ssh_path, ssh_port
+    log.debug 'Docker socket scheme is ' \
+      "\n\"\"\"\n#{hash_to_yaml socket_scheme}\"\"\""
 
     socket_scheme
   end
@@ -68,16 +45,11 @@ module DockerSocketModule
 
     return false unless docker_check_running
 
-    cmds_start_socket = _get_socket_start_commands sockets_up = false
-
-    unless cmds_start_socket.empty?
-      log.debug 'Request sudo so that subsequent background tasks run without delay'
+    cmds_start_socket = _get_socket_start_commands 'start'
 
-      cmd_sudo_true =
-          config.active['cmd_docker_socket_start_sudo_true']
+    return true if cmds_start_socket.empty?
 
-      run cmd_sudo_true
-    end
+    _socket_get_sudo
 
     cmds_start_socket.each do |cmd_start_socket|
       run_and_fork cmd_start_socket
@@ -95,103 +67,161 @@ module DockerSocketModule
     # get process list
     # assuming format: "pid command"
     cmd_ps =
-        config.active['cmd_docker_socket_stop_docker_socket_ps']
+      config.active['cmd_docker_socket_stop_docker_socket_ps']
 
     stdout_str = run cmd_ps
 
-    cmds_start_socket = _get_socket_start_commands sockets_up = true
+    cmds_start_socket = _get_socket_start_commands 'stop'
 
     # loop over process list
     stdout_str.split(/\n+/).each do |process|
+      _socket_stop_process process, cmds_start_socket
+    end
 
-      # split processes in process id and process command
-      pid_command = process.strip.split(/ /, 2)
-      pid = pid_command[0]
-      command = pid_command[1]
-
-      # loop over socket start commands
-      cmds_start_socket.each do |cmd_start_socket|
+    true
+  end
 
-        if command == cmd_start_socket
-          log.debug "Killing PID #{pid}"
+  private
 
-          cmd_kill =
-              config.active['cmd_docker_socket_stop_docker_socket_kill'] % {
-                  pid: pid
-              }
+  # Get gpg agent socket path.
+  def _socket_get_agent_socket_path
+    cmd_agent_socket_path =
+      config.active['cmd_docker_socket_config_agent_socket_path']
+    (run cmd_agent_socket_path).chomp
+  end
 
-          run cmd_kill
-        end
-      end
-    end
+  # Get gpg ssh agent socket path.
+  def _socket_get_agent_ssh_socket_path
+    cmd_agent_ssh_socket_path =
+      config.active['cmd_docker_socket_config_agent_ssh_socket_path']
+    (run cmd_agent_ssh_socket_path).chomp
+  end
 
-    true
+  # Create socket scheme.
+  def _socket_get_scheme(gpg_path, gpg_port, ssh_path, ssh_port)
+    { 'agent-socket' => { 'path' => gpg_path,
+                          'host' => @socket_host,
+                          'port' => gpg_port },
+      'agent-ssh-socket' => { 'path' => ssh_path,
+                              'host' => @socket_host,
+                              'port' => ssh_port } }
   end
 
-  # get socket start commands
+  # Get socket start commands.
   # sockets_up is a boolean which defines if the sockets need to be up
   # to be included in the resulting array of socket start commands
-  def _get_socket_start_commands sockets_up
+  def _get_socket_start_commands(mode)
     cmds_start_socket = []
 
     # loop over sockets
     @sockets.each do |socket, socket_config|
-      cmd_start_socket =
-          config.active['cmd_docker_socket_get_start'] % {
-              port: socket_config['port'],
-              host: socket_config['host'],
-              path: socket_config['path'],
-          }
-
-      if sockets_up
-        if _socket_up? socket, socket_config
-          cmds_start_socket << cmd_start_socket
-        end
-      else
-        unless _socket_up? socket, socket_config
-          cmds_start_socket << cmd_start_socket
-        end
-      end
+      host = socket_config['host']
+      port = socket_config['port']
+      path = socket_config['path']
+
+      cmd = _get_socket_start_command mode, socket, host, port, path
+      cmds_start_socket.push cmd if cmd
     end
 
     cmds_start_socket
   end
 
-  # check if a socket is available
-  # but trying to connect to it via TCP
-  def _socket_up? socket, socket_config
-    host = socket_config['host']
-    port = socket_config['port']
-    path = socket_config['path']
+  # Get socket start command
+  def _get_socket_start_command(mode, socket, host, port, path)
+    if mode == 'start'
+      unless _socket_up? socket, host, port, path
+        return _socket_get_cmd_start_socket(host, port, path)
+      end
+    elsif _socket_up? socket, host, port, path
+      return _socket_get_cmd_start_socket(host, port, path)
+    end
+    nil
+  end
 
-    error_message = "failed to connect to " +
-        "socket \"#{socket}\" " +
-        "using host \"#{host}\", " +
-        "port \"#{port}\", " +
-        "path \"#{path}\""
+  # Get socket start command.
+  def _socket_get_cmd_start_socket(host, port, path)
+    format(
+      config.active['cmd_docker_socket_get_start'],
+      host: host,
+      port: port,
+      path: path
+    )
+  end
 
-    # check if socket is available
+  # Check if a socket is available by trying to connect to it via TCP
+  def _socket_up?(socket, host, port, path)
+    error_message = _socket_get_error_message socket, host, port, path
     begin
-      Timeout::timeout(1) do
-        begin
-          s = TCPSocket.new host, port
-          s.close
-          log.debug "Socket \"#{socket}\" available"
-          return true
-        rescue Errno::ECONNREFUSED
-          log.debug "Connection refused: #{error_message}"
-          return false
-        rescue Errno::EHOSTUNREACH
-          log.debug "Host unreachable: #{error_message}"
-          return false
-        rescue SocketError
-          log.debug "Socket error: #{error_message}"
-          return false
-        end
+      Timeout.timeout(1) do
+        _socket_reachable? socket, host, port, error_message
       end
     rescue Timeout::Error
       log.debug "Timeout: #{error_message}"
-      return false
+      false
+    end
+  end
+
+  # Create error message.
+  def _socket_get_error_message(socket, host, port, path)
+    'failed to connect to ' \
+        "socket \"#{socket}\" " \
+        "using host \"#{host}\", " \
+        "port \"#{port}\", " \
+        "path \"#{path}\""
+  end
+
+  # Test socket.
+  # rubocop:disable Metrics/MethodLength
+  def _socket_reachable?(socket, host, port, error_message)
+    begin
+      s = TCPSocket.new host, port
+      s.close
+      log.debug "Socket \"#{socket}\" up"
+      return true
+    rescue Errno::ECONNREFUSED
+      log.debug "Connection refused: #{error_message}"
+    rescue Errno::EHOSTUNREACH
+      log.debug "Host unreachable: #{error_message}"
+    rescue SocketError
+      log.debug "Socket error: #{error_message}"
+    end
+    false
+  end
+
+  # rubocop:enable Metrics/MethodLength
+
+  # Kill process.
+  def _socket_kill_pid(pid)
+    log.debug "Killing PID #{pid}"
+    cmd_kill =
+      format(
+        config.active['cmd_docker_socket_stop_docker_socket_kill'],
+        pid: pid
+      )
+    run cmd_kill
+  end
+
+  # Get sudo.
+  def _socket_get_sudo
+    log.debug 'Request sudo so that ' \
+      'subsequent background tasks run without delay'
+    cmd_sudo_true =
+      config.active['cmd_docker_socket_start_sudo_true']
+    run cmd_sudo_true
+  end
+
+  # Stop process.
+  def _socket_stop_process(process, cmds_start_socket)
+    # split processes in process id and process command
+    pid_command = process.strip.split(/ /, 2)
+    pid = pid_command[0]
+    command = pid_command[1]
+
+    # loop over socket start commands
+    cmds_start_socket.each do |cmd_start_socket|
+      next unless command == cmd_start_socket
+
+      _socket_kill_pid pid
     end
   end
 end

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

@@ -1,8 +1,8 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage git check
   class GitCheck < SubCommandBase
-
     include LoggingModule
     include SystemModule
     include ConfigModule

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

@@ -1,30 +1,22 @@
+# frozen_string_literal: true
+
 # takelage git check module
 module GitCheckModule
-
   # Backend method for git check clean.
   # @return [Boolean] is git workspace clean?
   def git_check_clean
-    log.debug "Checking if git workspace is clean"
+    log.debug 'Checking if git workspace is clean'
 
     return false unless git_check_workspace
 
-    cmd_git_unstaged =
-        config.active['cmd_git_check_clean_git_unstaged']
-
-    cmd_git_uncommitted =
-        config.active['cmd_git_check_clean_git_uncommitted']
-
-    cmd_git_status =
-        config.active['cmd_git_check_clean_git_status']
-
-    status_unstaged = try cmd_git_unstaged
-    status_uncommitted = try cmd_git_uncommitted
-    stdout_str_status = run cmd_git_status
+    status_unstaged = _git_get_status_unstaged
+    status_uncommitted = _git_get_status_uncommitted
+    stdout_str_status = _git_get_str_status
 
     # only return true if neither unstaged nor uncommitted nor empty files
     sum = status_unstaged.exitstatus +
-        status_uncommitted.exitstatus +
-        stdout_str_status.length
+          status_uncommitted.exitstatus +
+          stdout_str_status.length
 
     sum.zero?
   end
@@ -36,13 +28,7 @@ module GitCheckModule
 
     return false unless git_check_workspace
 
-    cmd_get_branch =
-        config.active['cmd_git_check_master_git_branch']
-
-    stdout_str = run cmd_get_branch
-
-    branch = stdout_str.strip.split('/')[-1]
-
+    branch = _git_get_branch
     log.debug "We are on git branch \"#{branch}\""
 
     branch == 'master'
@@ -52,24 +38,56 @@ module GitCheckModule
   # @return [Boolean] is this a git workspace?
   def git_check_workspace
     log.debug 'Check if this is a git workspace'
+    status_repo = _git_get_status_repo
+    dir = _git_get_dir
+    unless status_repo.exitstatus.zero?
+      log.debug "No git workspace found in \"#{dir}\""
+      return false
+    end
+    true
+  end
 
-    cmd_git_repo =
-        config.active['cmd_git_check_workspace_git_repo']
+  private
 
-    status_repo = try cmd_git_repo
+  # Get git status of unstaged changes.
+  def _git_get_status_unstaged
+    cmd_git_unstaged =
+      config.active['cmd_git_check_clean_git_unstaged']
+    try cmd_git_unstaged
+  end
 
-    cmd_pwd =
-        config.active['cmd_git_check_workspace_pwd']
+  # Get git status of uncommitted changes.
+  def _git_get_status_uncommitted
+    cmd_git_uncommitted =
+      config.active['cmd_git_check_clean_git_uncommitted']
+    try cmd_git_uncommitted
+  end
 
-    stdout_str_dir = run cmd_pwd
+  # Get git status result.
+  def _git_get_str_status
+    cmd_git_status =
+      config.active['cmd_git_check_clean_git_status']
+    run cmd_git_status
+  end
 
-    dir = stdout_str_dir.strip
+  # Get git branch.
+  def _git_get_branch
+    cmd_get_branch =
+      config.active['cmd_git_check_master_git_branch']
+    (run cmd_get_branch).strip.split('/')[-1]
+  end
 
-    unless status_repo.exitstatus.zero?
-      log.debug "No git workspace found in \"#{dir}\""
-      return false
-    end
+  # Get git repository status.
+  def _git_get_status_repo
+    cmd_git_repo =
+      config.active['cmd_git_check_workspace_git_repo']
+    try cmd_git_repo
+  end
 
-    true
+  # Get current working directory.
+  def _git_get_dir
+    cmd_pwd =
+      config.active['cmd_git_check_workspace_pwd']
+    (run cmd_pwd).strip
   end
 end

data/lib/takelage/git/cli.rb

@@ -1,10 +1,9 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage git
   class Git < SubCommandBase
-
     desc 'check [COMMAND]', 'Check git state'
     subcommand 'check', GitCheck
-
   end
 end

data/lib/takelage/info/cli.rb

@@ -1,10 +1,9 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage info
   class Info < SubCommandBase
-
     desc 'project [COMMAND]', 'Get project info'
     subcommand 'project', InfoProject
-
   end
 end

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

@@ -1,8 +1,8 @@
-module Takelage
+# frozen_string_literal: true
 
+module Takelage
   # takelage info project
   class InfoProject < SubCommandBase
-
     include LoggingModule
     include SystemModule
     include ConfigModule