locd 0.1.3

data/lib/locd/cli/command/base.rb

@@ -0,0 +1,243 @@
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+require 'shellwords'
+
+# Deps
+# -----------------------------------------------------------------------
+require 'thor'
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+# Abstract base for CLI interface commands using the `thor` gem.
+# 
+# @abstract
+# 
+# @see http://whatisthor.com/
+# 
+class Locd::CLI::Command::Base < Thor
+  
+  # Helpers
+  # ============================================================================
+  # 
+  protected
+    
+    # Swap `$stdout` for a {StringIO}, call `block`, swap original `$stdout`
+    # back in and return the string contents.
+    # 
+    # 'Cause we got that damn threaded logging going on, we want to write
+    # output all as one string using `$stdout.write`, but some stuff like
+    # {Thor::Shell::Basic#print_table} just write to {#stdout} (which resolves
+    # to `$stdout`) and don't offer an option to returned a formatted string
+    # instead.
+    # 
+    # This seems like the simplest way to handle it, though it may still run
+    # into trouble with the threads, we shall see...
+    # 
+    # @param [Proc] &block
+    #   Block to run that writes to `$stdout`
+    # 
+    # @return [String]
+    # 
+    def capture_stdout &block
+      io = StringIO.new
+      stdout = $stdout
+      $stdout = io
+      block.call
+      $stdout = stdout
+      io.string
+    end
+    
+    
+    def agent_file agent
+      agent.path.to_s.sub( /\A#{ Regexp.escape( ENV['HOME'] ) }/, '~' )
+    end
+    
+    
+    def render_table table
+      string = capture_stdout do
+        print_table table.to_a
+      end
+      
+      width = string.lines.map( &:length ).max
+      
+      return (
+        string.lines[0] +
+        "-" * width + "\n" +
+        string.lines[1..-1].join +
+        "---\n" +
+        table.footer +
+        "\n\n"
+      )
+      
+      string.lines.each_with_index.map { |line, index|
+        if index == 0
+          '# ' + line
+        else
+          '  ' + line
+        end
+      }.join
+    end
+    
+    
+    def render_text object
+      # Does it look like an array/list?
+      if NRSER.array_like? object
+        # It does! Convert it to an actual array to make life easier
+        array = object.to_a
+        
+        return "(EMPTY)" if array.empty?
+        
+        # Is it a list of agents?
+        if array.all? { |entry| entry.is_a? Locd::Agent }
+          # Ok, we want to display them. What mode are we in accoring to the
+          # options?
+          if options[:long]
+            # We're in long-mode, render a table
+            render_table agent_table( array )
+          else
+            # We're in regular mode, render each agent on it's own line by
+            # recurring
+            array.map( &method( __method__ ) ).join( "\n" )
+          end
+        
+        # Is it a list of arrays?
+        elsif array.all? { |entry| entry.is_a? Array }
+          # It is, let's render that as a table
+          render_table message
+        else
+          # It's not, let's just render each entry on it's own line by
+          # recurring
+          message.map( &method( __method__ ) ).join( "\n" )
+        end
+      
+      else
+        # It's not array-ish. Special-case {Locd::Agent} instances and render
+        # the rest as `#to_s`
+        case object
+        when Locd::Agent::Site
+          # TODO  Want to add options for this, but for now just render agent
+          #       URLs 'cause they have the label in them and are
+          #       `cmd+click`-able in iTerm2 to open, which is most useful
+          object.url
+        when Locd::Agent
+          object.label
+        else
+          object.to_s
+        end
+      end
+    end # #render_text
+    
+    
+    def respond message, title: nil
+      formatted = if options[:json]
+        begin
+          JSON.pretty_generate message
+        rescue JSON::GeneratorError => error
+          logger.debug "Error generating 'pretty' JSON, falling back to dump",
+            error: error
+          
+          JSON.dump message
+        end
+        
+      elsif options[:yaml] || NRSER.hash_like?( message )
+        # TODO  This sucks, but it's the easiest way to get "nice" YAML :/
+        YAML.dump JSON.load( JSON.dump message )
+        
+      else
+        render_text message
+      end
+      
+      if title
+        formatted = (
+          "# #{ title }\n#{ '#' * 78}\n#\n" + formatted
+        )
+      end
+      
+      # Be puts-like
+      unless formatted[-1] == "\n"
+        formatted = formatted + "\n"
+      end
+      
+      $stdout.write formatted
+    end # #respond
+    
+    
+    # Hook called from {Thor::Command#run} when an error occurs. Errors are
+    # not recoverable from my understanding, so this method should provide
+    # necessary feedback to the user and exit with an error code for errors
+    # it expects and re-raise those that it doesn't.
+    # 
+    def on_run_error error, command, args
+      case error
+      when NRSER::CountError
+        if error.count == 0
+          logger.error "No results"
+        else
+          logger.error "Too many results:\n\n#{ render_text error.subject }\n"
+        end
+      
+        # If the command supports `--all`, let them know that they can use it
+        if command.options[:all]
+          logger.info "You can use `--all` to to operate on ALL matches."
+          logger.info "See `locd help #{ command.name }`\n"
+        end
+      
+        exit 1
+      else
+        raise error
+      end
+    end
+    
+    
+    # Find exactly one {Locd::Agent} for a `pattern`, using the any `:pattern`
+    # shared options provided, and raising if there are no matches or more
+    # than one.
+    # 
+    # @param pattern (see Locd::Agent.find_only!)
+    # 
+    # @return [Locd::Agent]
+    #   Matched agent.
+    # 
+    # @raise If more or less than one agent is matched.
+    # 
+    def find_only! pattern
+      Locd::Agent.find_only! pattern, **option_kwds( groups: :pattern )
+    end
+    
+    
+    def find_multi! pattern
+      # Behavior depend on the `:all` option...
+      if options[:all]
+        # `:all` is set, so we find all the agents for the pattern, raising
+        # if we don't find any
+        Locd::Agent.find_all!(
+          pattern,
+          **option_kwds( groups: :pattern )
+        ).values
+      else
+        # `:all` is not set, so we need to find exactly one or error
+        [find_only!( pattern )]
+      end
+    end
+    
+  # end protected
+  public
+  
+end # module Locd::CLI::Command::Base

data/lib/locd/cli/command/job.rb

@@ -0,0 +1,110 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+# TODO  Doc me pls
+# 
+class Locd::CLI::Command::Job < Locd::CLI::Command::Agent
+  
+  # Helpers
+  # ============================================================================
+  # 
+  
+  def self.agent_class
+    Locd::Agent::Job
+  end
+  
+  def self.parse_every_option value
+    case value
+    when /\A\d+\z/, /\A\d+s\z/
+      value.to_i
+    when /\A\d+m\z/
+      value[0...-1].to_i * 60
+    when /\A\d+h\z/
+      value[0...-1].to_i * 60 * 60
+    when /\A\d+d\z/
+      value[0...-1].to_i * 60 * 60 * 24
+    else
+      raise ArgumentError,
+        "Can't parse `every` option value: #{ value.inspect }"
+    end
+  end
+  
+  
+  protected
+  # ========================================================================
+    
+    def agent_table agents
+      Locd::CLI::Table.build do |t|
+        t.col "PID", &:pid
+        t.col "LEC", desc: "Last Exit Code", &:last_exit_code
+        t.col "File" do |agent| agent_file agent end
+        
+        t.rows agents
+      end
+    end
+    
+  # end protected
+  public
+  
+  
+  # Write Commands
+  # ----------------------------------------------------------------------------
+  
+  desc              "add CMD_TEMPLATE...",
+                    "Add job that runs in the current directory"
+  include_options   groups: [:write, :add, :respond_with_agents]
+  option            :every,
+                    desc: "How often to start the job",
+                    type: :string
+  option            :at,
+                    desc: "Day/time to start the job",
+                    type: :hash
+  def add           *cmd_template
+    logger.debug "#{ self.class.name }##{ __method__ }",
+      options: options,
+      cmd_template: cmd_template,
+      shared: self.class.shared_method_options
+    
+    if options[:every] && options[:at]
+      logger.error "Don't supply both `every` and `at` options",
+        options: options
+      exit 1
+    end
+    
+    start_interval = if options[:every]
+      self.class.parse_every_option options[:every]
+    elsif options[:at]
+      options[:at].map { |key, value|
+        [key.to_sym, value.to_i]
+      }.to_h
+    else
+      raise Thor::RequiredArgumentMissingError,
+        "Must provide `every` or `at` option"
+    end
+    
+    logger.debug "Parsed start interval", start_interval: start_interval
+    
+    job = agent_class.add \
+      cmd_template: cmd_template,
+      start_interval: start_interval,
+      **option_kwds( groups: :write )
+    
+    logger.info "`#{ job.label }` job added."
+    
+    job.load if options[:load]
+    
+    respond job
+  end
+  
+end # class Locd::CLI::Command::Job

data/lib/locd/cli/command/main.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+# Requirements
+# =======================================================================
+
+# Stdlib
+# -----------------------------------------------------------------------
+
+# Deps
+# -----------------------------------------------------------------------
+
+# Project / Package
+# -----------------------------------------------------------------------
+
+
+# Refinements
+# =======================================================================
+
+using NRSER
+using NRSER::Types
+
+
+# Definitions
+# =======================================================================
+
+# CLI interface using the `thor` gem.
+# 
+# @see http://whatisthor.com/
+# 
+class Locd::CLI::Command::Main < Locd::CLI::Command::Base
+  
+  # Constants
+  # ============================================================================
+  
+  # Just the symbol log levels from {SemnaticLogger::LEVELS} converted to
+  # frozen strings
+  # 
+  # @return [Array<String>]
+  # 
+  LOG_LEVEL_STRINGS = SemanticLogger::LEVELS.map { |sym| sym.to_s.freeze }
+  
+  
+  # Mixins
+  # ============================================================================
+  
+  # Dynamically add {.logger} and {#logger} methods.
+  # 
+  # Needs to be in `no_commands` or Thor gets upset.
+  # 
+  # no_commands { include SemanticLogger::Loggable }
+  
+  
+  # Global (Class-Level) Options
+  # ============================================================================
+  # 
+  # Applicable to all commands.
+  # 
+  
+  class_option :log_level,
+    desc: "Set log level",
+    type: :string,
+    enum: LOG_LEVEL_STRINGS.
+      zip( LOG_LEVEL_STRINGS.map { |level| level[0] } ).
+      flatten,
+    default: ENV['LOCD_LOG_LEVEL']
+  
+  
+  class_option :debug,
+    desc: "Set log level to debug",
+    type: :boolean
+    
+    
+  class_option :trace,
+    desc: "Set log level to trace",
+    type: :boolean
+  
+  
+  class_option :verbose,
+    desc: "Turn on DEBUG-level logging",
+    aliases: '-v',
+    type: :boolean
+  
+  
+  class_option :json,
+    desc: "Output in JSON format (to STDOUT)",
+    type: :boolean
+  
+  
+  class_option :yaml,
+    desc: "Output in YAML format (to STDOUT)",
+    type: :boolean
+  
+  
+  # Construction
+  # ============================================================================
+  
+  # Wrap {Thor#initialize} to call {#init_setup_logging} after letting `super`
+  # do it's thing so logging is setup before we do anything else.
+  # 
+  def initialize args = [], local_options = {}, config = {}
+    super args, local_options, config
+    
+    # If anything raises in here, the command seems to just silently exit..?
+    begin
+      init_setup_logging!
+    rescue Exception => e
+      $stderr.write \
+        "ERROR: #{ e.message } #{ e.class }\n#{ e.backtrace.join( "\n" ) }\n"
+    end
+    
+    logger.debug "initialized",
+      args: args,
+      local_options: local_options,
+      options: self.options
+    
+  end
+  
+  
+  # Helpers
+  # ============================================================================
+  # 
+  protected
+    
+    # Setup logging using {#options}.
+    # 
+    def init_setup_logging!
+      kwds = {}
+      
+      level = if options[:trace]
+        :trace
+      elsif options[:debug]
+        :debug
+      elsif options[:log_level]
+        LOG_LEVEL_STRINGS.find_only { |level|
+          level.start_with? options[:log_level]
+        }.to_sym
+      end
+      
+      Locd::Logging.level = level unless level.nil?
+      
+      if [:trace, :debug].include? Locd::Logging.level
+        logger.send Locd::Logging.level, "Hello! We about to start the show..."
+      end
+    end
+    
+  # end protected
+  public
+  
+  
+  # Commands
+  # ============================================================================
+  
+  # Querying
+  # ----------------------------------------------------------------------------
+  
+  desc              "version",
+                    "Print the version"
+  def version
+    respond Locd::VERSION
+  end
+  
+  
+  # System
+  # ----------------------------------------------------------------------------
+  
+  
+  desc              "config",
+                    "Dump config"
+  def config
+    respond Locd.config.to_h
+  end
+  
+  
+  # Sub-Commands
+  # ============================================================================
+  
+  desc              'site SUBCOMMAND...',
+                    'Deal with site agents.'
+  subcommand        'site',
+                    Locd::CLI::Command::Site
+  
+  
+  desc              'job SUBCOMMAND...',
+                    'Deal with job agents.'
+  subcommand        'job',
+                    Locd::CLI::Command::Job
+  
+  
+  desc              'proxy SUBCOMMAND...',
+                    'Deal with the HTTP proxy that routes requests to servers'
+  subcommand        'proxy',
+                    Locd::CLI::Command::Proxy
+                    
+                    
+  desc              'rotate-logs SUBCOMMAND...',
+                    'Deal with the log rotation job'
+  # map               :'rotate-logs' => :rotate_logs
+  subcommand        'rotate_logs',
+                    Locd::CLI::Command::RotateLogs
+  
+end # class Locd::CLI::Command::Main