minicron 0.1.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60fca4e316aa04aa9af9e988a25aac6f52bee585
-  data.tar.gz: 77a60882f414259f240a49d9b780c7b82a162ac0
+  metadata.gz: aa2c40fa9887bb6c06b46153ba397a13806ed4f9
+  data.tar.gz: e1fc6d9b267c3e0a21727328f25922ecffeae9e4
 SHA512:
-  metadata.gz: 3af6cc620890e0883e5c8541f19a39694d964f0bfddddd384a9c3ec123548e4f3b815390212079efd68b6ccca692b7ca636682ae3b0f9fe8bf2dc006b031c4a6
-  data.tar.gz: 8732f37eba792dee23ac23f12543301dd231ab3d67f912c51679fd1f77a6b9ef98af0a80d9530fd93c03b3cf7e683e2f51dc16c30112dc8a90767b3ffac7d458
+  metadata.gz: 3f8fa7cdcd2a80623bbf1a0c3f266e575f9c3da024325579e96b65a523158212ac879ced4cffa834a11f150c14c3bfce48d921b90004ec380a5629779af89e14
+  data.tar.gz: 3e48387f403abbf3b34d1efd85bb4f3d33aec113a20abfce5336c6e801794d9a49a6f0e00e7844af12e4aa87a298de04632a6a2bffaf13b8686519ae790e34b7

data/README.md

@@ -1,12 +1,20 @@
 minicron
 =======
 
-[![Gem Version](http://img.shields.io/gem/v/minicron.svg)](https://rubygems.org/gems/minicron) [![Build Status](http://img.shields.io/travis/jamesrwhite/minicron.svg)](http://travis-ci.org/jamesrwhite/minicron) [![Coverage Status](http://img.shields.io/coveralls/jamesrwhite/minicron.svg)](https://coveralls.io/r/jamesrwhite/minicron?branch=master) [![Code Climate](http://img.shields.io/codeclimate/github/jamesrwhite/minicron.svg)](https://codeclimate.com/github/jamesrwhite/minicron) [![Dependency Status](http://img.shields.io/gemnasium/jamesrwhite/minicron.svg)](https://gemnasium.com/jamesrwhite/minicron) [![Inline docs](http://inch-pages.github.io/github/jamesrwhite/minicron.png)](http://inch-pages.github.io/github/jamesrwhite/minicron)
-
-minicron aims to complement ````cron```` by making it easier to manage and monitor cron jobs, it can largely be thought of as two components that interact together, the CLI and the Hub. The CLI is what is installed on your server(s) and executes your cron command and reports the status back to the Hub. The Hub is the central point where data from one or many instances of the CLI are is recieved and stored in a database. The Hub also provides a web interface to the data and makes it easy to manage your cron jobs.
+[![Gem Version](http://img.shields.io/gem/v/minicron.svg)](https://rubygems.org/gems/minicron)
+[![Build Status](http://img.shields.io/travis/jamesrwhite/minicron.svg)](http://travis-ci.org/jamesrwhite/minicron)
+[![Coverage Status](http://img.shields.io/coveralls/jamesrwhite/minicron.svg)](https://coveralls.io/r/jamesrwhite/minicron?branch=master)
+[![Code Climate](http://img.shields.io/codeclimate/github/jamesrwhite/minicron.svg)](https://codeclimate.com/github/jamesrwhite/minicron)
+[![Dependency Status](http://img.shields.io/gemnasium/jamesrwhite/minicron.svg)](https://gemnasium.com/jamesrwhite/minicron)
+[![Inline docs](http://inch-pages.github.io/github/jamesrwhite/minicron.png)](http://inch-pages.github.io/github/jamesrwhite/minicron)
+
+minicron aims to complement ````cron```` by making it easier to manage and monitor cron jobs, it can largely be
+thought of as two components that interact together, the CLI and the Hub. The CLI is what is installed on your
+server(s) and executes your cron command and reports the status back to the Hub. The Hub is the central point
+where data from one or many instances of the CLI are is recieved and stored in a database. The Hub also provides
+a web interface to the data and makes it easy to manage your cron jobs.
 
 - [Background](https://github.com/jamesrwhite/minicron/blob/master/README.md#background)
-- [Goals](https://github.com/jamesrwhite/minicron/blob/master/README.md#features)
 - [Features](https://github.com/jamesrwhite/minicron/blob/master/README.md#goals)
 - [Requirements](https://github.com/jamesrwhite/minicron/blob/master/README.md#requirements)
 - [Installation](https://github.com/jamesrwhite/minicron/blob/master/README.md#installation)
@@ -20,17 +28,9 @@ minicron aims to complement ````cron```` by making it easier to manage and monit
 Background
 -----------
 
-I'm developing minicron as part of my dissertation at university which is due in May but I plan to continue development after that. My inspiration for developing minicron comes from time spent working at [Miniclip](http://www.miniclip.com) where the management and monitoring of cron jobs at times proved to be tricky!
-
-Goals
-------
-
-Some rough goals that minicron is trying to achieve.
-
-- Remove the need to understand cron syntax
-- Increase visiblity into cron failures and missed executions
-- Have minimal external dependencies
-- Fault tolerance
+I'm developing minicron as part of my dissertation at university which is due in May but I plan to continue
+development after that. My inspiration for developing minicron comes from time spent working at
+[Miniclip](http://www.miniclip.com) where the management and monitoring of cron jobs at times proved to be tricky!
 
 Features
 ---------
@@ -51,10 +51,9 @@ Requirements
 -------------
 
 #### Ruby
-- MRI
-  - 1.9.3 and above (tested on 1.9.3, 2.0.0, 2.1.0)
-- <del>Rubinius</del>
-  - <del>Travis builds are run on the latest release</del> [*awaiting bug fix*](https://github.com/rubinius/rubinius/issues/2944)
+- **MRI**: 1.9.3 and above (tested on 1.9.3, 2.0.0, 2.1.0)
+- <del>**Rubinius**: Travis builds are run on the latest release</del> [*awaiting bug fix*](https://github.com/rubinius/rubinius/issues/2944)
+- **JRuby:** currently untested but most likely needs some workn
 
 #### Database
 
@@ -63,11 +62,13 @@ Requirements
 
 #### Web Server / Reverse Proxy
 
-If you want to run minicron behind a web server or proxy it needs to support the web socket protocol. nginx for example supports web sockets from version 1.3.13 and up.
+If you want to run minicron behind a web server or proxy it needs to support the web socket protocol.
+nginx for example supports web sockets from version 1.3.13 and up. I've included an [example config](https://github.com/jamesrwhite/minicron/blob/master/sample.nginx.conf) for nginx.
 
 #### Browser
 
-I have been testing the web interface in the latest versions of Chrome, Firefox and Safari. I'm currently unsure of how it functions in the various of Internet Explorer but in theory it should support IE9+
+I have been testing the web interface in the latest versions of Chrome, Firefox and Safari.
+I'm currently unsure of how it functions in the various of Internet Explorer but in theory it should support IE9+
 
 #### OS
 
@@ -76,61 +77,111 @@ Should run on any linux/bsd based OS that the above ruby versions run on.
 Installation
 -------------
 
-minicron is currently under heavy development and as such I would not recommend that you use this in production yet but I encourage you to give it a try in a non critical environment and help me improve it.
+minicron is currently under heavy development and as such I would not recommend that you use this in production yet
+but I encourage you to give it a try in a non critical environment and help me to improve it.
+
+1. First check you meet the [requirements](https://github.com/jamesrwhite/minicron/blob/master/README.md#requirements)
+
+2. On some distributions you may need to install the ````ruby-dev```` and ````build-essential```` packages
 
-To install the latest release (currently 0.1.1) you can ````gem install minicron````.
+3. To install the latest release (currently 0.2) you can ````gem install minicron````, depending on your ruby setup
+   you may need to run this with ````sudo````
 
-#### Database Setup
+4. Set your database configuration options in ````/etc/minicron.toml````, you can use the [default.config.toml](https://github.com/jamesrwhite/minicron/blob/master/default.config.toml) as a guide on what options are configurable
 
-Set your database configuration options in ````/etc/minicron.toml````, you can use the [default.config.toml](https://github.com/jamesrwhite/minicron/blob/master/default.config.toml) as a guide on what options are configurable. You can then ````minicron db setup````
+5. Make sure you have created an empty database with the name you set in ````/etc/minicron.toml````
 
-> **WARNING** this will drop any existing tables of the same name in the configured database and create new ones
+  > **WARNING**
+  >
+  > the step below will drop any existing tables in the configured database and create new ones i.e:
+  > ````sql
+  > DROP TABLE IF EXISTS jobs; CREATE TABLE jobs ..
+  > ````
 
-or set it up manually using the [schema dump provided](https://github.com/jamesrwhite/minicron/blob/master/lib/minicron/hub/db/schema.sql).
+6. You can then ````minicron db setup```` to create the database schema, alternatively you can use
+   the [schema dump provided](https://github.com/jamesrwhite/minicron/blob/master/lib/minicron/hub/db/schema.sql)
+
+7. Done! See the usage section below for more details on how to use minicron now you have it installed
 
 Usage
 -----
 
-minicron is packaged as a gem and can be interacted with from the command line once you have installed it. The current commands are as follows:
-
 #### Run a command
 
-````
-minicron run 'command --options'
+````bash
+minicron run 'mysqldump db > backup.sql'
 ````
 
-You can alter the way in which the command alters it's output by passing the --mode option to the run argument with the value of either 'line' or 'char'. Most of the time you'll want to use the default value of line but for some commands e.g a script that outputs a progress bar minicron printing the output each character at a time can be useful.
+The global ````--verbose```` option can also be passed to the ````run```` argument like so
 
+````bash
+minicron run --verbose ls
 ````
-minicron run 'mysqldump db > backup.sql'
+
+You can also run a command in 'dry run' mode to test if it works without sending the output to the server.
+
+````bash
+minicron run --dry-run 'zip -r backup.zip website'
 ````
 
-The global ````--verbose```` option can also be passed to the ````run```` argument like so ````minicron run --verbose ls````, for further information see ````minicron help run````.
+for further information see ````minicron help run````.
 
 #### Get help
 
-Running ````minicron```` with no arguments is an alias to running ````minicron help````, ````minicron -h```` or ````minicron --help````. You can also use the help argument to get information on any command as shown above in the run a command section or alternatively you can pass the ````-h```` or ````--help```` options like so ````minicron run -h````.
+Running ````minicron```` with no arguments is an alias to running ````minicron help````, ````minicron -h```` or ````minicron --help````.
+You can also use the help argument to get information on any command as shown above in the run a command section
+or alternatively you can pass the ````-h```` or ````--help```` options like so ````minicron run -h````.
 
 #### Server
 
-To launch the server (aka the Hub) run ````minicron server```` - by default it will bind to port 9292 on the host 127.0.0.1 but this can be configured by the command line arguments ````--host```` ````--port```` and ````--path```` or in the config file.
+To launch the server (aka the Hub) run
+
+````bash
+minicron server start
+````
+
+by default it will bind to port 9292 on the host 127.0.0.1 but this can be configured by the command line
+arguments ````--host```` ````--port```` and ````--path```` or in the config file.
 
-See [sample.nginx.conf](https://github.com/jamesrwhite/minicron/blob/master/sample.nginx.conf) for an example of how to run minicron behind a reverse proxy. It should be possible to run minicron behind any web server/reverse proxy as long as it supports WebSockets.
+By default the server will run as a daemon with its process id stored in ````/tmp/minicron.pid````
+you can also use the ````stop```` ````restart```` and ````status```` commands to control the server.
+
+To run the server in debug mode, i.e not as a daemon so you can see its output you can pass the ````--debug````
+option.
+
+See [sample.nginx.conf](https://github.com/jamesrwhite/minicron/blob/master/sample.nginx.conf) for an example of
+how to run minicron behind a reverse proxy.
+
+#### Connecting to a host via SSH
+
+To be able to perform CRUD operations on the crontab minicron needs to connect via SSH to the host.
+When you set up a host minicron automatically creates a public/private key pair for you and stores it
+in ````~/.ssh```` on the host the minicron server is being run on using the naming schema ````minicron_host_*HOST_ID*_rsa(.pub)````.
+To be able edit the crontab on a host minicron *needs* to connect to the host as the root user so you will
+need to to copy the public key to the hosts authorized_keys file e.g ````/root/.ssh/authorized_keys```` on
+most linux distributions or ````/var/root/.ssh/authorized_keys```` on OSX.
 
 #### Version
 
-Like many command line programs minicron will show it's version number when the global options ````-v```` or ````--version```` are passed to the CLI.
+Like many command line programs minicron will show it's version number when the global options ````-v````
+or ````--version```` are passed to the CLI.
 
 #### Configuration
 
-Some configuration options can be passed in manually but the recommend way to configure minicron is through the use of a config file. You can specify the path to the file using the ````--config```` global option. The file is expected to be in the [toml](https://github.com/mojombo/toml "toml") format. The default options are specified in the [default.config.toml](https://github.com/jamesrwhite/minicron/blob/master/default.config.toml "default.config.toml") file and minicron will parse a config located in ````/etc/minicron.toml```` if it exists. Options specified via the command line will take precedence over those taken from a config file.
+Some configuration options can be passed in manually but the recommend way to configure minicron is through the use
+of a config file. You can specify the path to the file using the ````--config```` global option. The file is expected
+to be in the [toml](https://github.com/mojombo/toml "toml") format. The default options are specified in the
+[default.config.toml](https://github.com/jamesrwhite/minicron/blob/master/default.config.toml "default.config.toml")
+file and minicron will parse a config located in ````/etc/minicron.toml```` if it exists. Options specified via
+the command line will take precedence over those taken from a config file.
 
 Documentation
 -------------
 
-minicron uses [Yard](http://yardoc.org/ "Yard") for it's code documentation, you can either generate it and view it locally using the following commands:
+minicron uses [Yard](http://yardoc.org/ "Yard") for it's code documentation, you can either generate it and view
+it locally using the following commands:
 
-````
+````bash
 yard doc
 yard server
 ````
@@ -163,8 +214,10 @@ Areas that I would love some help with:
 - General testing of the system, let me know what you think and create issues for any bugs you find!
 - Tests!!
 - Validation and error handling improvements
-- Documentation improvements. Find something confusing or unexpected, let me know and I'll add or improve documentation for it!
-- Look for '[TODO:](https://github.com/jamesrwhite/minicron/search?q=TODO%3A)' notices littered around the code, I'm trying to convert them all to issues but there are a lot..
+- Documentation improvements. Find something confusing or unexpected, let me know and I'll add or improve
+  documentation for it!
+- Look for '[TODO:](https://github.com/jamesrwhite/minicron/search?q=TODO%3A)' notices littered around the code,
+  I'm trying to convert them all to issues but there are a lot..
 - Code refactoring, I had a reasonably tight deadline to have the main concept done by so some parts are a bit rushed
 - UI improvements
 

data/Rakefile

@@ -1,7 +1,7 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'sinatra/activerecord/rake'
-require 'minicron'
+require 'minicron/constants'
 require 'minicron/hub/app'
 
 # rspec tests
@@ -15,3 +15,11 @@ end
 task :default do
   puts `rake --tasks`
 end
+
+namespace :db do
+  # Tell active record where the db dir is
+  Sinatra::ActiveRecordTasks.db_dir = Minicron::HUB_PATH + '/db'
+
+  # Connect to the DB
+  Minicron::Hub::App.setup_db
+end

data/lib/minicron.rb

@@ -23,7 +23,8 @@ module Minicron
     'server' => {
       'host' => '127.0.0.1',
       'port' => 9292,
-      'path' => '/'
+      'path' => '/',
+      'debug' => false
     },
     'database' => {
       'type' => 'mysql',
@@ -41,7 +42,12 @@ module Minicron
         'enabled' => false,
         'smtp' => {
           'address' => 'localhost',
-          'port' => 25
+          'port' => 25,
+          'domain' => 'localhost.localdomain',
+          'user_name' => nil,
+          'password' => nil,
+          'authentication' => nil,
+          'enable_starttls_auto' => true
         }
       },
       'sms' => {
@@ -68,7 +74,7 @@ module Minicron
     rescue Errno::ENOENT
       # Fail if the file doesn't exist unless it's the default config file
       if file_path != DEFAULT_CONFIG_FILE
-        fail Exception, "Unable to the load the file '#{file_path}', are you sure it exists?"
+        raise Exception, "Unable to the load the file '#{file_path}', are you sure it exists?"
       end
     rescue Errno::EACCES
       fail Exception, "Unable to the readthe file '#{file_path}', check it has the right permissions."
@@ -152,7 +158,6 @@ module Minicron
     filename
   end
 
-
   # Used to generate SSH keys for hosts but is completely generic
   #
   # @param type [String] the thing that is using the key, this is just here

data/lib/minicron/alert.rb

@@ -5,6 +5,7 @@ require 'minicron/hub/models/alert'
 require 'minicron/hub/models/job'
 
 module Minicron
+  # Allows the sending of alerts via multiple mediums
   class Alert
     # Send an alert using all enabled mediums
     #
@@ -50,7 +51,7 @@ module Minicron
       when 'pagerduty'
         send_pagerduty(options)
       else
-        raise Exception, "The medium '#{options[:medium]}' is not supported!"
+        fail Exception, "The medium '#{options[:medium]}' is not supported!"
       end
 
       # Store that we sent the alert

data/lib/minicron/alert/email.rb

@@ -1,6 +1,7 @@
 require 'mail'
 
 module Minicron
+  # Allows the sending of email alerts
   class Email
     # Configure the mail client
     def initialize
@@ -8,7 +9,11 @@ module Minicron
         delivery_method(
           :smtp,
           :address => Minicron.config['alerts']['email']['smtp']['address'],
-          :port => Minicron.config['alerts']['email']['smtp']['port']
+          :port => Minicron.config['alerts']['email']['smtp']['port'],
+          :domain => Minicron.config['alerts']['email']['smtp']['domain'],
+          :user_name => Minicron.config['alerts']['email']['smtp']['user_name'],
+          :password => Minicron.config['alerts']['email']['smtp']['password'],
+          :enable_starttls_auto => Minicron.config['alerts']['email']['smtp']['enable_starttls_auto']
         )
       end
     end
@@ -28,7 +33,7 @@ module Minicron
       when 'fail'
         "Execution ##{options[:execution_id]} of Job ##{options[:job_id]} '#{options[:job].name}' failed."
       else
-        raise Exception, "The kind '#{options[:kind]} is not supported!"
+        fail Exception, "The kind '#{options[:kind]} is not supported!"
       end
     end
 

data/lib/minicron/alert/pagerduty.rb

@@ -1,6 +1,7 @@
 require 'pagerduty'
 
 module Minicron
+  # Allows the sending of pagerduty alerts
   class PagerDuty
     # Used to set up on the pagerduty client
     def initialize
@@ -24,7 +25,7 @@ module Minicron
       when 'fail'
         "Execution ##{options[:execution_id]} of Job ##{options[:job_id]} failed"
       else
-        raise Exception, "The kind '#{options[:kind]} is not supported!"
+        fail Exception, "The kind '#{options[:kind]} is not supported!"
       end
     end
 
@@ -33,7 +34,7 @@ module Minicron
     # @param title [String]
     # @param message [String]
     def send(title, message)
-      @client.trigger(title, { :message => message })
+      @client.trigger(title,  :message => message)
     end
   end
 end

data/lib/minicron/alert/sms.rb

@@ -1,6 +1,7 @@
 require 'twilio-ruby'
 
 module Minicron
+  # Allows the sending of SMS alerts via Twilio
   class SMS
     # Used to set up on the twilio client
     def initialize
@@ -27,7 +28,7 @@ module Minicron
       when 'fail'
         "minicron alert - job failed!\nExecution ##{options[:execution_id]} of Job ##{options[:job_id]} failed"
       else
-        raise Exception, "The kind '#{options[:kind]} is not supported!"
+        fail Exception, "The kind '#{options[:kind]} is not supported!"
       end
     end
 

data/lib/minicron/cli.rb

@@ -2,6 +2,7 @@ require 'pty'
 require 'English'
 require 'rainbow/ext/string'
 require 'commander'
+require 'insidious'
 require 'minicron/constants'
 require 'minicron/transport'
 require 'minicron/transport/client'
@@ -11,6 +12,8 @@ require 'minicron/monitor'
 include Commander::UI
 
 module Minicron
+  # Handles the main CLI interaction of minicron
+  # TODO: this class is probably too complicated and should be refactored a bit
   class CLI
     # Function to the parse the config of the options passed to commands
     #
@@ -32,7 +35,8 @@ module Minicron
         'server' => {
           'host' => opts.host,
           'port' => opts.port,
-          'path' => opts.path
+          'path' => opts.path,
+          'debug' => opts.debug
         }
       )
     end
@@ -128,9 +132,7 @@ module Minicron
           end
         end
       rescue Errno::ENOENT
-        exit_status = 1
-
-        fail Exception, "Running the command `#{command}` failed, are you sure it exists?"
+        raise Exception, "Running the command `#{command}` failed, are you sure it exists?"
       ensure
         # Record the time the command finished
         finish = Time.now.utc - subtract_total
@@ -142,7 +144,7 @@ module Minicron
 
         # Output some debug info
         if options[:verbose]
-          yield structured :verbose, "\n" + "[minicron]".colour(:magenta)
+          yield structured :verbose, "\n" + '[minicron]'.colour(:magenta)
           yield structured :verbose, ' finished running '.colour(:blue) + "`#{command}`".colour(:yellow) + " at #{start}\n".colour(:blue)
           yield structured :verbose, '[minicron]'.colour(:magenta)
           yield structured :verbose, ' running '.colour(:blue) + "`#{command}`".colour(:yellow) + " took #{finish - start}s\n".colour(:blue)
@@ -233,11 +235,26 @@ module Minicron
       ids
     end
 
+    # Start the server and monitor
+    def start_server
+      # Run the execution monitor (this runs in a separate thread)
+      monitor = Minicron::Monitor.new
+      monitor.start!
+
+      # Start the server!
+      server = Minicron::Transport::Server.new
+      server.start!(
+        Minicron.config['server']['host'],
+        Minicron.config['server']['port'],
+        Minicron.config['server']['path']
+      )
+    end
+
     # Add the `minicron db` command
     def add_db_cli_command
       @cli.command :db do |c|
-        c.syntax = 'minicron db [setup|dump]'
-        c.description = 'Loads or dumps the minicron database schema.'
+        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
@@ -271,27 +288,40 @@ module Minicron
     # Add the `minicron server` command
     def add_server_cli_command
       @cli.command :server do |c|
-        c.syntax = 'minicron server'
-        c.description = 'Starts the minicron server.'
+        c.syntax = 'minicron server [start|stop|restart|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
           parse_config(opts)
 
-          # Run the execution monitor (this runs in a separate thread)
-          monitor = Minicron::Monitor.new
-          monitor.start!
+          # If we get no arguments then default the action to start
+          action = args.first.nil? ? 'start' : args.first
 
-          # Start the server!
-          server = Minicron::Transport::Server.new
-          server.start!(
-            Minicron.config['server']['host'],
-            Minicron.config['server']['port'],
-            Minicron.config['server']['path']
+          # 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! { start_server }
+          when 'stop'
+            insidious.stop!
+          when 'restart'
+            insidious.restart! { start_server }
+          when 'status'
+            if insidious.running?
+              puts 'minicron is running'
+            else
+              puts 'minicron is not running'
+            end
+          end
         end
       end
     end
@@ -352,7 +382,7 @@ module Minicron
               faye.send(:job_id => ids[:job_id], :execution_id => ids[:execution_id], :type => :output, :message => e.message)
             end
 
-            fail e
+            raise e
           ensure
             # Ensure that all messages are delivered and that we
             unless Minicron.config['cli']['dry_run']