Merge pull request #196 from jamesrwhite/develop

v0.9.1

Author: jamesrwhite

Makefile

@@ -2,6 +2,7 @@ start-gem-server:
 	(cd ../minicron-build/gem-server && rm -rf data && rackup)
 
 build:
+	rm -rf pkg
 	rm -f *.gem
 	rm -f Gemfile.lock
 	bundle

README.md

@@ -105,11 +105,10 @@ instead.
 
 1. First check you meet the [requirements](#requirements)
 
-2. Either [grab the latest](https://github.com/jamesrwhite/minicron/releases/tag/v0.9.0) zip/tarball for your OS, use
-   the handy [install script](install.sh) (where `OS` is one of:
-   osx, linux-x86, linux-x86_64)
+2. Use the handy [install script](install.sh) or [grab the latest](https://github.com/jamesrwhite/minicron/releases/tag/v0.9.1) zip/tarball
+   for your OS and install manually.
    ```
-   OS=linux-x86_64 bash -c "$(curl -sSL https://raw.githubusercontent.com/jamesrwhite/minicron/master/install.sh)"
+   bash -c "$(curl -sSL https://raw.githubusercontent.com/jamesrwhite/minicron/master/install.sh)"
    ```
    ..or [build it yourself](README.md)
    if you're feeling adventurous!
@@ -118,27 +117,24 @@ instead.
    [minicron.toml](config/minicron.toml) as a guide on what options
    are configurable
 
-4. Make sure you have created an empty database with the name you set in ````/etc/minicron.toml````
-
   > **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 ..
   > ````
 
-6. You can then ````minicron db setup```` to create the database schema, alternatively you can use
-   the [schema dump provided](lib/minicron/hub/db/schema.sql) (MySQL)
+4. You can then ````minicron db setup```` to create the database schema and run any pending migrations.
 
-7. Done! See the usage section below for more details on how to use minicron now you have it installed
+5. Done! See the usage section below for more details on how to use minicron now you have it installed
 
 #### Docker
 
 You can also run minicron in a docker container, see below for instructions how:
 
 ````bash
-docker pull jamesrwhite/minicron:0.9.0
-minicron_container_id=$(docker run -d -p 127.0.0.1:9292:9292 -i -t jamesrwhite/minicron:0.9.0)
+docker pull jamesrwhite/minicron:0.9.1
+minicron_container_id=$(docker run -d -p 127.0.0.1:9292:9292 -i -t jamesrwhite/minicron:0.9.1)
 docker exec $minicron_container_id minicron db setup
 docker exec $minicron_container_id minicron server start
 ````
@@ -197,14 +193,7 @@ how to run minicron behind a reverse proxy.
 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 have permission to edit ````/etc/crontab```` and write and
-execute permissions on the ````/etc```` directory so it can move files there (the crontab). This will most
-likely mean allowing minicron to connect to the host as the root user although you could alter your permissions
-to allow for this not to be the case.
-
-As an example, to setup minicron SSH for the root user on a host 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.
+You will then to add the public key into the remote hosts authorized_keys file.
 
 #### Version
 

Rakefile

@@ -1,29 +1,17 @@
-require 'minicron/hub/app'
-require 'sinatra/activerecord/rake'
+require 'minicron'
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
 
-namespace :db do
-  task :load_config do
-    # Tell active record where the db dir is
-    Sinatra::ActiveRecordTasks.db_dir = Minicron::HUB_PATH + '/db'
+# Task for local dev to dump schema
+task :dump_schema do
+  # Parse our local config file
+  Minicron.parse_file_config('./my.config.toml')
 
-    # Parse the file config in /etc/minicron.toml
-    Minicron.parse_file_config(nil)
+  # Connect to the db
+  Minicron.establish_db_connection(
+    Minicron.config['server']['database'],
+    Minicron.config['verbose']
+  )
 
-    # Connect to the DB
-    Minicron::Hub::App.setup_db
-  end
-end
-
-# rspec tests
-desc 'Run specs'
-RSpec::Core::RakeTask.new do |t|
-  t.verbose = true
-  t.rspec_opts = '--color --order random'
-end
-
-# Show a list of tasks by default
-task :default do
-  puts `rake --tasks`
+  # Dump the schema file
+  ActiveRecord::SchemaDumper.dump
 end

Vagrantfile

@@ -5,9 +5,9 @@ VAGRANTFILE_API_VERSION = "2"
 $script = <<SCRIPT
 apt-get update
 apt-get install -y libsqlite3-dev wget unzip
-wget https://github.com/jamesrwhite/minicron/releases/download/v0.9.0/minicron-0.9.0-linux-x86_64.zip > minicron.zip
-unzip -o minicron-0.9.0-linux-x86_64.zip
-export PATH=~/minicron-0.9.0-linux-x86_64:$PATH
+wget https://github.com/jamesrwhite/minicron/releases/download/v0.9.1/minicron-0.9.1-linux-x86_64.zip > minicron.zip
+unzip -o minicron-0.9.1-linux-x86_64.zip
+export PATH=~/minicron-0.9.1-linux-x86_64:$PATH
 ufw allow 2222
 ufw allow 9292
 ufw enable

…te/20160103130649_enable_disable_jobs.rb …ns/20160103130649_enable_disable_jobs.rbdb/migrate/20160103130649_enable_disable_jobs.rb renamed to db/migrations/20160103130649_enable_disable_jobs.rb db/migrate/20160103130649_enable_disable_jobs.rb renamed to db/migrations/20160103130649_enable_disable_jobs.rb

@@ -12,10 +12,10 @@
 
 ActiveRecord::Schema.define(version: 0) do
 
-  create_table "alerts", force: true do |t|
-    t.integer  "job_id",                              null: false
-    t.integer  "execution_id"
-    t.integer  "schedule_id"
+  create_table "alerts", force: :cascade do |t|
+    t.integer  "job_id",       limit: 4,              null: false
+    t.integer  "execution_id", limit: 4
+    t.integer  "schedule_id",  limit: 4
     t.string   "kind",         limit: 4, default: "", null: false
     t.datetime "expected_at"
     t.string   "medium",       limit: 9, default: "", null: false
@@ -29,13 +29,13 @@
   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.integer  "number",      null: false
-    t.datetime "created_at",  null: false
+  create_table "executions", force: :cascade do |t|
+    t.integer  "job_id",      limit: 4, null: false
+    t.integer  "number",      limit: 4, null: false
+    t.datetime "created_at",            null: false
     t.datetime "started_at"
     t.datetime "finished_at"
-    t.integer  "exit_status"
+    t.integer  "exit_status", limit: 4
   end
 
   add_index "executions", ["created_at"], name: "executions_created_at", using: :btree
@@ -44,45 +44,45 @@
   add_index "executions", ["job_id"], name: "executions_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   "user",       limit: 32, 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: :cascade do |t|
+    t.string   "name",       limit: 255
+    t.string   "fqdn",       limit: 255,   default: "", null: false
+    t.string   "user",       limit: 32,    default: "", null: false
+    t.string   "host",       limit: 255,   default: "", null: false
+    t.integer  "port",       limit: 4,                  null: false
+    t.text     "public_key", limit: 65535
+    t.datetime "created_at",                            null: false
+    t.datetime "updated_at",                            null: false
   end
 
   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: :cascade do |t|
+    t.integer  "execution_id", limit: 4,     null: false
+    t.integer  "seq",          limit: 4,     null: false
+    t.text     "output",       limit: 65535, null: false
+    t.datetime "timestamp",                  null: false
   end
 
   add_index "job_execution_outputs", ["execution_id"], name: "job_execution_outputs_execution_id", using: :btree
   add_index "job_execution_outputs", ["seq"], name: "seq", using: :btree
 
-  create_table "jobs", force: true do |t|
-    t.integer  "host_id",                            null: false
-    t.string   "job_hash",   limit: 32, default: "", null: false
-    t.string   "name"
-    t.string   "user",       limit: 32,              null: false
-    t.text     "command",                            null: false
-    t.datetime "created_at",                         null: false
-    t.datetime "updated_at",                         null: false
+  create_table "jobs", force: :cascade do |t|
+    t.integer  "host_id",    limit: 4,                    null: false
+    t.string   "job_hash",   limit: 32,    default: "",   null: false
+    t.string   "name",       limit: 255
+    t.string   "user",       limit: 32,                   null: false
+    t.text     "command",    limit: 65535,                null: false
+    t.datetime "created_at",                              null: false
+    t.datetime "updated_at",                              null: false
   end
 
   add_index "jobs", ["created_at"], name: "jobs_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
+  create_table "schedules", force: :cascade do |t|
+    t.integer  "job_id",           limit: 4,   null: false
     t.string   "minute",           limit: 169
     t.string   "hour",             limit: 61
     t.string   "day_of_the_month", limit: 83

lib/minicron/hub/db/schema.rb db/schema.rblib/minicron/hub/db/schema.rb renamed to db/schema.rb

@@ -1,7 +1,7 @@
 #!/bin/bash
 set -e
 
-VERSION="0.9.0"
+VERSION="0.9.1"
 
 echo "Installing mincron v$VERSION"
 

install.sh

@@ -1,4 +1,5 @@
 require 'minicron/constants'
+require 'active_record'
 require 'toml'
 require 'sshkey'
 require 'stringio'
@@ -224,4 +225,48 @@ def self.get_db_adapter(type)
       raise Minicron::DatabaseError, "The database #{type} is not supported"
     end
   end
+
+  # Get the activerecord config hash for the databaes
+  #
+  # @param type [Hash] database config
+  # @return type [String] activerecord database config
+  def self.get_activerecord_db_config(config)
+    case config['type']
+    when /mysql|postgresql/
+      return {
+        :adapter => Minicron.get_db_adapter(config['type']),
+        :host => config['host'],
+        :database => config['database'],
+        :username => config['username'],
+        :password => config['password']
+      }
+    when 'sqlite'
+      # Calculate the realtive path to the db because sqlite or activerecord is
+      # weird and doesn't seem to handle abs paths correctly
+      root = Pathname.new(Dir.pwd)
+      db = Pathname.new(Minicron::BASE_PATH + '/db')
+      db_rel_path = db.relative_path_from(root)
+
+      return {
+        :adapter => Minicron.get_db_adapter(config['type']),
+        :database => "#{db_rel_path}/minicron.sqlite3" # TODO: Allow configuring this but default to this value
+      }
+    else
+      raise Minicron::DatabaseError, "The database #{config['type']} is not supported"
+    end
+  end
+
+  # Get the activerecord config hash for the databaes
+  #
+  # @param type [Hash] database config
+  def self.establish_db_connection(config, verbose = false)
+    # Get the activerecord formatted config
+    ar_config = self.get_activerecord_db_config(config)
+
+    # Connect to the database
+    ActiveRecord::Base.establish_connection(ar_config)
+
+    # Enable ActiveRecord logging if in verbose mode
+    ActiveRecord::Base.logger = verbose ? Logger.new(STDOUT) : nil
+  end
 end

lib/minicron.rb

@@ -2,8 +2,7 @@
 require 'insidious'
 require 'rake'
 require 'minicron/hub/app'
-require 'sinatra/activerecord'
-require 'sinatra/activerecord/rake'
+require 'active_record'
 require 'minicron/transport'
 require 'minicron/transport/client'
 require 'minicron/transport/server'
@@ -14,7 +13,7 @@ class Commands
       # Add the `minicron db` command
       def self.add_db_cli_command(cli)
         cli.command :db do |c|
-          c.syntax = 'minicron db [create|setup|migrate]'
+          c.syntax = 'minicron db [setup|migrate|version]'
           c.description = 'Sets up the minicron database schema.'
 
           c.action do |args, opts|
@@ -26,22 +25,63 @@ def self.add_db_cli_command(cli)
             # Parse the file and cli config options
             Minicron::CLI.parse_config(opts)
 
-            # 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'
+            # Display all the infos please
+            ActiveRecord::Migration.verbose = true
 
             # Adjust the task name for some more friendly tasks
             case args.first
             when 'setup'
-              task = 'schema:load'
+              # Remove the database name from the config in case it doesn't exist yet
+              Minicron.establish_db_connection(
+                Minicron.config['server']['database'].merge('database' => nil),
+                Minicron.config['verbose']
+              )
+
+              # Create the database
+              ActiveRecord::Base.connection.create_database(
+                Minicron.config['server']['database']['database'],
+                {
+                  :charset => 'utf8',
+                  :collation => 'utf8_unicode_ci'
+                }
+              )
+
+              # Then create the initial schema based on schema.rb
+              ActiveRecord::Tasks::DatabaseTasks.load_schema_for(
+                Minicron.get_activerecord_db_config(Minicron.config['server']['database']),
+                ActiveRecord::Base.schema_format,
+                "#{Minicron::DB_PATH}/schema.rb"
+              )
+
+              # Open a new connection to our shiny new database now we know it's there for sure
+              Minicron.establish_db_connection(
+                Minicron.config['server']['database'],
+                Minicron.config['verbose']
+              )
+
+              # Then run any migrations
+              ActiveRecord::Migrator.migrate(Minicron::MIGRATIONS_PATH)
+            when 'migrate'
+              # Connect to the database
+              Minicron.establish_db_connection(
+                Minicron.config['server']['database'],
+                Minicron.config['verbose']
+              )
+
+              # Run any pending migrations
+              ActiveRecord::Migrator.migrate(Minicron::MIGRATIONS_PATH)
+            when 'version'
+              # Connect to the database
+              Minicron.establish_db_connection(
+                Minicron.config['server']['database'],
+                Minicron.config['verbose']
+              )
+
+              # Print our the schema version
+              puts ActiveRecord::Migrator.current_version
             else
-              task = args.first
+              raise Minicron::ArgumentError, "Unknown argument #{args.first}. See `minicron help db`"
             end
-
-            # Run the task
-            Rake.application['db:' + task].invoke
           end
         end
       end