minicron 0.2 → 0.3

data/lib/minicron/cli/commands.rb

@@ -0,0 +1,194 @@
+require 'insidious'
+require 'minicron'
+require 'minicron/transport/client'
+
+module Minicron
+  module CLI
+    class Commands
+      # Add the `minicron db` command
+      def self.add_db_cli_command(cli)
+        cli.command :db do |c|
+          c.syntax = 'minicron db [setup]'
+          c.description = 'Sets up the minicron database schema.'
+
+          c.action do |args, opts|
+            # Check that exactly one argument has been passed
+            if args.length != 1
+              fail ArgumentError, 'A valid command to run is required! See `minicron help db`'
+            end
+
+            # Parse the file and cli config options
+            Minicron::CLI.parse_config(opts)
+
+            # These are inlined as we only need them in this use case
+            require 'rake'
+            require 'minicron/hub/app'
+            require 'sinatra/activerecord/rake'
+
+            # Setup the db
+            Minicron::Hub::App.setup_db
+
+            # Tell activerecord where the db folder is, it assumes it is in db/
+            Sinatra::ActiveRecordTasks.db_dir = Minicron::HUB_PATH + '/db'
+
+            # Adjust the task name
+            task = args.first == 'setup' ? 'load' : args.first
+
+            # Run the task
+            Rake.application['db:schema:' + task].invoke
+          end
+        end
+      end
+
+      # Add the `minicron server` command
+      def self.add_server_cli_command(cli)
+        cli.command :server do |c|
+          c.syntax = 'minicron server [start|stop|status]'
+          c.description = 'Controls the minicron server.'
+          c.option '--host STRING', String, "The host for the server to listen on. Default: #{Minicron.config['server']['host']}"
+          c.option '--port STRING', Integer, "How port for the server to listed on. Default: #{Minicron.config['server']['port']}"
+          c.option '--path STRING', String, "The path on the host. Default: #{Minicron.config['server']['path']}"
+          c.option '--debug', "Enable debug mode. Default: #{Minicron.config['server']['debug']}"
+
+          c.action do |args, opts|
+            # Parse the file and cli config options
+            Minicron::CLI.parse_config(opts)
+
+            # If we get no arguments then default the action to start
+            action = args.first.nil? ? 'start' : args.first
+
+            # Get an instance of insidious and set the pid file
+            insidious = Insidious.new(
+              :pid_file => '/tmp/minicron.pid',
+              :daemonize => Minicron.config['server']['debug'] == false
+            )
+
+            case action
+            when 'start'
+              insidious.start! do
+              # Run the execution monitor (this runs in a separate thread)
+              monitor = Minicron::Monitor.new
+              monitor.start!
+
+              # Start the server!
+              Minicron::Transport::Server.start!(
+                Minicron.config['server']['host'],
+                Minicron.config['server']['port'],
+                Minicron.config['server']['path']
+              )
+              end
+            when 'stop'
+              insidious.stop!
+            when 'status'
+              if insidious.running?
+                puts 'minicron is running'
+              else
+                puts 'minicron is not running'
+              end
+            else
+              fail ArgumentError, 'Invalid action, expected [start|stop|status]. See `minicron help server`'
+            end
+          end
+        end
+      end
+
+      # Add the `minicron run [command]` command
+      # @yieldparam output [String] output from the cli
+      def self.add_run_cli_command(cli)
+        # Add the run command to the cli
+        cli.command :run do |c|
+          c.syntax = "minicron run 'command -option value'"
+          c.description = 'Runs the command passed as an argument.'
+          c.option '--mode STRING', String, "How to capture the command output, each 'line' or each 'char'? Default: #{Minicron.config['cli']['mode']}"
+          c.option '--dry-run', "Run the command without sending the output to the server.  Default: #{Minicron.config['cli']['dry_run']}"
+
+          c.action do |args, opts|
+            # Check that exactly one argument has been passed
+            if args.length != 1
+              fail ArgumentError, 'A valid command to run is required! See `minicron help run`'
+            end
+
+            # Parse the file and cli config options
+            Minicron::CLI.parse_config(opts)
+
+            begin
+              # Set up the job and get the job and execution ids
+              unless Minicron.config['cli']['dry_run']
+                # Get a faye instance so we can send data about the job
+                faye = Minicron::Transport::Client.new(
+                  Minicron.config['client']['scheme'],
+                  Minicron.config['client']['host'],
+                  Minicron.config['client']['port'],
+                  Minicron.config['client']['path']
+                )
+
+                # Set up the job and get the jexecution and job ids back from the server
+                ids = setup_job(args.first, faye)
+              end
+
+              # Execute the command and yield the output
+              Minicron::CLI.run_command(args.first, :mode => Minicron.config['cli']['mode'], :verbose => Minicron.config['verbose']) do |output|
+                # We need to handle the yielded output differently based on it's type
+                case output[:type]
+                when :status
+                  unless Minicron.config['cli']['dry_run']
+                    faye.send(:job_id => ids[:job_id], :execution_id => ids[:execution_id], :type => :status, :message => output[:output])
+                  end
+                when :command
+                  unless Minicron.config['cli']['dry_run']
+                    faye.send(:job_id => ids[:job_id], :execution_id => ids[:execution_id], :type => :output, :message => output[:output])
+                  end
+                end
+
+                yield output[:output] unless output[:type] == :status
+              end
+            rescue Exception => e
+              # Send the exception message to the server and yield it
+              unless Minicron.config['cli']['dry_run']
+                faye.send(:job_id => ids[:job_id], :execution_id => ids[:execution_id], :type => :output, :message => e.message)
+              end
+
+              raise Exception, e
+            ensure
+              # Ensure that all messages are delivered and that we
+              unless Minicron.config['cli']['dry_run']
+                faye.ensure_delivery
+                faye.tidy_up
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+      # Setup a job by sending the SETUP command to the server
+      #
+      # @param command [String] the job command
+      # @param faye a faye client instance
+      # @return [Hash] the job_id and execution_id
+      def self.setup_job(command, faye)
+        # Get the fully qualified domain name of the currnet host
+        fqdn = Minicron.get_fqdn
+
+        # Get the short hostname of the current host
+        hostname = Minicron.get_hostname
+
+        # Get the md5 hash for the job
+        job_hash = Minicron::Transport.get_job_hash(command, fqdn)
+
+        # Fire up eventmachine
+        faye.ensure_em_running
+
+        # Setup the job on the server
+        ids = faye.setup(job_hash, command, fqdn, hostname)
+
+        # Wait until we get the execution id
+        faye.ensure_delivery
+
+        # Return the ids
+        ids
+      end
+    end
+  end
+end

data/lib/minicron/constants.rb

@@ -1,6 +1,6 @@
 # The minicron module
 module Minicron
-  VERSION = '0.2'
+  VERSION = '0.3'
   DEFAULT_CONFIG_FILE = '/etc/minicron.toml'
   BASE_PATH = File.expand_path('../../../', __FILE__)
   LIB_PATH = File.expand_path('../../', __FILE__)

data/lib/minicron/cron.rb

@@ -1,4 +1,5 @@
 require 'shellwords'
+require 'escape'
 
 module Minicron
   # Used to interact with the crontab on hosts over an ssh connection
@@ -13,24 +14,17 @@ module Minicron
       @ssh = ssh
     end
 
-    # Escape the quotes in a command
-    #
-    # @param command [String]
-    # @return [String]
-    def escape_command(command)
-      command.gsub(/\\|'/) { |c| "\\#{c}" }
-    end
-
     # Build the minicron command to be used in the crontab
     #
     # @param command [String]
     # @param schedule [String]
     # @return [String]
     def build_minicron_command(command, schedule)
-      # Escape any quotes in the command
-      command = escape_command(command)
+      # Escape the command so it will work in bourne shells
+      command = Escape.shell_command(['minicron', 'run', command])
+      cron_command =Escape.shell_command(['/bin/bash', '-l', '-c', command])
 
-      "#{schedule} root minicron run '#{command}'"
+      "#{schedule} root #{cron_command}"
     end
 
     # Used to find a string and replace it with another in the crontab by
@@ -63,7 +57,7 @@ module Minicron
       # If it's a delete
       if replace == ''
         # Check the original line is no longer there
-        grep = conn.exec!("grep -F \"#{find}\" /etc/crontab.tmp").to_s.strip
+        grep = conn.exec!("grep -F #{find.shellescape} /etc/crontab.tmp").to_s.strip
 
         # Throw an exception if we can't see our new line at the end of the file
         if grep != replace
@@ -71,7 +65,7 @@ module Minicron
         end
       else
         # Check the updated line is there
-        grep = conn.exec!("grep -F \"#{replace}\" /etc/crontab.tmp").to_s.strip
+        grep = conn.exec!("grep -F #{replace.shellescape} /etc/crontab.tmp").to_s.strip
 
         # Throw an exception if we can't see our new line at the end of the file
         if grep != replace
@@ -98,14 +92,15 @@ module Minicron
 
       # Prepare the line we are going to write to the crontab
       line = build_minicron_command(job.command, schedule)
-      echo_line = "echo \"#{line}\" >> /etc/crontab && echo 'y' || echo 'n'"
+      escaped_line = line.shellescape
+      echo_line = "echo #{escaped_line} >> /etc/crontab && echo 'y' || echo 'n'"
 
       # Append it to the end of the crontab
       write = conn.exec!(echo_line).strip
 
       # Throw an exception if it failed
       if write != 'y'
-        fail Exception, "Unable to write '#{line}' to the crontab"
+        fail Exception, "Unable to echo #{escaped_line} to the crontab"
       end
 
       # Check the line is there

data/lib/minicron/hub/app.rb

@@ -104,7 +104,7 @@ module Minicron::Hub
     end
 
     def handle_exception(env, e, status)
-      if Minicron.config['global']['trace']
+      if Minicron.config['trace']
         env['rack.errors'].puts(e)
         env['rack.errors'].puts(e.backtrace.join("\n"))
         env['rack.errors'].flush
@@ -114,7 +114,7 @@ module Minicron::Hub
       hash = { :error => e.to_s }
 
       # Display the full trace if tracing is enabled
-      hash[:trace] = e.backtrace if Minicron.config['global']['trace']
+      hash[:trace] = e.backtrace if Minicron.config['trace']
 
       [status, { 'Content-Type' => 'application/json' }, [hash.to_json]]
     end

data/lib/minicron/hub/controllers/api/hosts.rb

@@ -1,4 +1,3 @@
-require 'minicron'
 require 'minicron/transport/ssh'
 
 class Minicron::Hub::App
@@ -109,8 +108,8 @@ class Minicron::Hub::App
         ssh.close
 
         # Delete the pub/priv key pair
-        private_key_path = Minicron.sanitize_filename(File.expand_path("~/.ssh/minicron_host_#{host.id}_rsa"))
-        public_key_path = Minicron.sanitize_filename(File.expand_path("~/.ssh/minicron_host_#{host.id}_rsa.pub"))
+        private_key_path = File.expand_path("~/.ssh/minicron_host_#{host.id}_rsa")
+        public_key_path = File.expand_path("~/.ssh/minicron_host_#{host.id}_rsa.pub")
         File.delete(private_key_path)
         File.delete(public_key_path)
 

data/lib/minicron/hub/db/schema.rb

@@ -12,92 +12,87 @@
 
 ActiveRecord::Schema.define(version: 0) do
 
-  create_table 'alerts', force: true do |t|
-    t.integer  'schedule_id'
-    t.integer  'execution_id'
-    t.string   'kind',         limit: 4, default: '', null: false
-    t.datetime 'expected_at'
-    t.string   'medium',       limit: 9, default: '', null: false
-    t.datetime 'sent_at',                             null: false
+  create_table "alerts", force: true do |t|
+    t.integer  "schedule_id"
+    t.integer  "execution_id"
+    t.string   "kind",         limit: 4, default: "", null: false
+    t.datetime "expected_at"
+    t.string   "medium",       limit: 9, default: "", null: false
+    t.datetime "sent_at",                             null: false
   end
 
-  add_index 'alerts', ['execution_id'], name: 'execution_id', using: :btree
-  add_index 'alerts', ['expected_at'], name: 'expected_at', using: :btree
-  add_index 'alerts', ['kind'], name: 'kind', using: :btree
-  add_index 'alerts', ['medium'], name: 'medium', using: :btree
-  add_index 'alerts', ['schedule_id'], name: 'schedule_id', using: :btree
+  add_index "alerts", ["execution_id"], name: "execution_id", using: :btree
+  add_index "alerts", ["expected_at"], name: "expected_at", using: :btree
+  add_index "alerts", ["kind"], name: "kind", using: :btree
+  add_index "alerts", ["medium"], name: "medium", using: :btree
+  add_index "alerts", ["schedule_id"], name: "schedule_id", using: :btree
 
-  create_table 'executions', force: true do |t|
-    t.integer  'job_id',      null: false
-    t.datetime 'created_at',  null: false
-    t.datetime 'started_at'
-    t.datetime 'finished_at'
-    t.integer  'exit_status'
+  create_table "executions", force: true do |t|
+    t.integer  "job_id",      null: false
+    t.datetime "created_at",  null: false
+    t.datetime "started_at"
+    t.datetime "finished_at"
+    t.integer  "exit_status"
   end
 
-  add_index 'executions', ['created_at'], name: 'created_at', using: :btree
-  add_index 'executions', ['finished_at'], name: 'finished_at', using: :btree
-  add_index 'executions', ['job_id'], name: 'job_id', using: :btree
-  add_index 'executions', ['started_at'], name: 'started_at', using: :btree
+  add_index "executions", ["created_at"], name: "created_at", using: :btree
+  add_index "executions", ["finished_at"], name: "finished_at", using: :btree
+  add_index "executions", ["job_id"], name: "job_id", using: :btree
+  add_index "executions", ["started_at"], name: "started_at", using: :btree
 
-  create_table 'hosts', force: true do |t|
-    t.string   'name'
-    t.string   'fqdn',       default: '', null: false
-    t.string   'host',       default: '', null: false
-    t.integer  'port',                    null: false
-    t.text     'public_key'
-    t.datetime 'created_at',              null: false
-    t.datetime 'updated_at',              null: false
+  create_table "hosts", force: true do |t|
+    t.string   "name"
+    t.string   "fqdn",       default: "", null: false
+    t.string   "host",       default: "", null: false
+    t.integer  "port",                    null: false
+    t.text     "public_key"
+    t.datetime "created_at",              null: false
+    t.datetime "updated_at",              null: false
   end
 
-  add_index 'hosts', ['fqdn'], name: 'hostname', using: :btree
+  add_index "hosts", ["fqdn"], name: "hostname", using: :btree
 
-  create_table 'job_execution_outputs', force: true do |t|
-    t.integer  'execution_id', null: false
-    t.integer  'seq',          null: false
-    t.text     'output',       null: false
-    t.datetime 'timestamp',    null: false
+  create_table "job_execution_outputs", force: true do |t|
+    t.integer  "execution_id", null: false
+    t.integer  "seq",          null: false
+    t.text     "output",       null: false
+    t.datetime "timestamp",    null: false
   end
 
-  add_index 'job_execution_outputs', ['execution_id'], name: 'execution_id', using: :btree
-  add_index 'job_execution_outputs', ['seq'], name: 'seq', using: :btree
+  add_index "job_execution_outputs", ["execution_id"], name: "execution_id", using: :btree
+  add_index "job_execution_outputs", ["seq"], name: "seq", using: :btree
 
-  create_table 'jobs', force: true do |t|
-    t.string   'job_hash',   limit: 32, default: '', null: false
-    t.string   'name'
-    t.text     'command',                            null: false
-    t.integer  'host_id',                            null: false
-    t.datetime 'created_at',                         null: false
-    t.datetime 'updated_at',                         null: false
+  create_table "jobs", force: true do |t|
+    t.string   "job_hash",   limit: 32, default: "", null: false
+    t.string   "name"
+    t.text     "command",                            null: false
+    t.integer  "host_id",                            null: false
+    t.datetime "created_at",                         null: false
+    t.datetime "updated_at",                         null: false
   end
 
-  add_index 'jobs', ['created_at'], name: 'created_at', using: :btree
-  add_index 'jobs', ['host_id'], name: 'host_id', using: :btree
-  add_index 'jobs', ['job_hash'], name: 'job_hash', unique: true, using: :btree
+  add_index "jobs", ["created_at"], name: "created_at", using: :btree
+  add_index "jobs", ["host_id"], name: "host_id", using: :btree
+  add_index "jobs", ["job_hash"], name: "job_hash", unique: true, using: :btree
 
-  create_table 'schedules', force: true do |t|
-    t.integer  'job_id',                       null: false
-    t.string   'minute',           limit: 179
-    t.string   'hour',             limit: 71
-    t.string   'day_of_the_month', limit: 92
-    t.string   'month',            limit: 25
-    t.string   'day_of_the_week',  limit: 20
-    t.string   'special',          limit: 9
-    t.datetime 'created_at',                   null: false
-    t.datetime 'updated_at',                   null: false
+  create_table "schedules", force: true do |t|
+    t.integer  "job_id",                       null: false
+    t.string   "minute",           limit: 179
+    t.string   "hour",             limit: 71
+    t.string   "day_of_the_month", limit: 92
+    t.string   "month",            limit: 25
+    t.string   "day_of_the_week",  limit: 20
+    t.string   "special",          limit: 9
+    t.datetime "created_at",                   null: false
+    t.datetime "updated_at",                   null: false
   end
 
-  add_index 'schedules', ['day_of_the_month'], name: 'day_of_the_month', using: :btree
-  add_index 'schedules', ['day_of_the_week'], name: 'day_of_the_week', using: :btree
-  add_index 'schedules', ['hour'], name: 'hour', using: :btree
-  add_index 'schedules', ['job_id'], name: 'job_id', using: :btree
-  add_index 'schedules', ['minute'], name: 'minute', using: :btree
-  add_index 'schedules', ['month'], name: 'month', using: :btree
-  add_index 'schedules', ['special'], name: 'special', using: :btree
-
-  create_table 'users', force: true do |t|
-    t.integer 'email',    null: false
-    t.integer 'password', null: false
-  end
+  add_index "schedules", ["day_of_the_month"], name: "day_of_the_month", using: :btree
+  add_index "schedules", ["day_of_the_week"], name: "day_of_the_week", using: :btree
+  add_index "schedules", ["hour"], name: "hour", using: :btree
+  add_index "schedules", ["job_id"], name: "job_id", using: :btree
+  add_index "schedules", ["minute"], name: "minute", using: :btree
+  add_index "schedules", ["month"], name: "month", using: :btree
+  add_index "schedules", ["special"], name: "special", using: :btree
 
 end