crontabinator 0.0.0 → 0.0.1

data/lib/crontabinator/built-in.rb

@@ -1,2 +1,6 @@
 set :crontab_log_level,             "info"
+set :crontab_logs_path,             -> { shared_path.join('log') }
 set :crontab_templates_path,        "templates/crontab"
+set :crontab_lockfile_path,         -> { "#{fetch(:crontab_templates_path)}/crontab.lock" }
+set :crontab_scripts_path,          -> { "#{fetch(:crontab_templates_path)}/scripts.d" }
+set :crontab_server_scripts_path,   -> { current_path.join('script') }

data/lib/crontabinator/check.rb

@@ -1,8 +1,37 @@
 namespace :crontab do
   namespace :check do
 
+    task :scripts do
+      run_locally do
+        files = Dir.glob("#{fetch(:crontab_scripts_path)}/*\.erb")
+        set :crontab_script_files, files.collect { |f| File.expand_path(f) }
+        fetch(:crontab_script_files).each do |file|
+          hash = eval(File.read(file).lines.to_a.shift)
+          if hash.nil? or hash[:user].nil? or hash[:schedule].nil?
+            fatal "Error reading the first line of #{file}"
+            fatal "Ensure the first line is a Ruby hash in the form: " +
+              "\"{ :user => \"www-data\", :schedule => \"* * * * *\" }\""
+            fatal "Your shebang line directly next"
+            exit
+          end
+        end
+      end
+    end
+
+    task :erb_validity do
+      run_locally do
+        fetch(:crontab_script_files).each do |file|
+          unless test "erb", "-x", "-T", "'-'", file, "|", "ruby", "-c"
+            fatal "There's a syntax error with #{file}"
+            fatal "Test it manually with `erb -x -T '-' #{file} | ruby -c`"
+            exit
+          end
+        end
+      end
+    end
+
     desc 'Ensure all crontabinator specific settings are set, and warn and exit if not.'
-    before 'crontab:setup', :settings do
+    task :settings => [:scripts, :erb_validity] do
       {
         (File.dirname(__FILE__) + "/examples/config/deploy.rb") => 'config/deploy.rb',
         (File.dirname(__FILE__) + "/examples/config/deploy/staging.rb") => "config/deploy/#{fetch(:stage)}.rb"

data/lib/crontabinator/config.rb

@@ -18,12 +18,13 @@ namespace :crontabinator do
   desc "Write example config files (with '_example' appended to their names)."
   task :write_example_configs do
     run_locally do
-      execute "mkdir", "-p", "config/deploy", fetch(:crontab_templates_path)
+      execute "mkdir", "-p", "config/deploy", fetch(:crontab_templates_path), fetch(:crontab_scripts_path)
       {
         "examples/Capfile"                    => "Capfile#{fetch(:example)}",
         "examples/config/deploy.rb"           => "config/deploy#{fetch(:example)}.rb",
         "examples/config/deploy/staging.rb"   => "config/deploy/staging#{fetch(:example)}.rb",
         "examples/crontab.erb"                => "#{fetch(:crontab_templates_path)}/crontab#{fetch(:example)}.erb",
+        "examples/myscript.sh.erb"            => "#{fetch(:crontab_scripts_path)}/myscript#{fetch(:example)}.sh.erb"
       }.each do |source, destination|
         config = File.read(File.dirname(__FILE__) + "/#{source}")
         File.open("./#{destination}", 'w') { |f| f.write(config) }

data/lib/crontabinator/crontab.rb

@@ -1,31 +1,108 @@
 namespace :crontab do
 
+  # sets :user_crontab_hash in the form:
+  # { :"user" => ["#!/bin/bash", "/bin/echo 'asdf' >> /tmp/test.log"] }
+  task :read_all_settings => ['crontab:check:scripts'] do
+    run_locally do
+      user_crontab_hash = {}
+
+      # Auto entries
+      auto_entries = []
+      fetch(:crontab_script_files).each do |file|
+        hash = eval(File.read(file).lines.to_a.shift)
+        path = "#{fetch(:crontab_server_scripts_path)}/#{File.basename(file, '.erb')}"
+        auto_entries += [{ :user => hash[:user], :schedule => hash[:schedule], :path => path }]
+      end
+      auto_entries.each do |entry|
+        name = File.basename(entry[:path], '.erb')
+        user_crontab_hash[entry[:user]] ||= []
+        user_crontab_hash[entry[:user]] << [
+          "# #{name}",
+          "#{entry[:schedule]} #{entry[:path]} >> #{fetch(:crontab_logs_path)}/#{name} 2>&1",
+          ""
+        ]
+      end
+
+      # User entries
+      fetch(:user_crontab_entries, {}).each do |user, lines|
+        user_crontab_hash[user] ||= []
+        user_crontab_hash[user] << [lines]
+      end
+
+      # All entries
+      user_crontab_hash.each { |user, lines| user_crontab_hash[user] = lines.flatten }
+
+      set :user_crontab_hash, user_crontab_hash
+
+      # Newly removed crontabs
+      crontabs_to_remove = []
+      if File.exists?(fetch(:crontab_lockfile_path))
+        old_users = eval(File.read(fetch(:crontab_lockfile_path))).sort
+        new_users = user_crontab_hash.collect { |user, _| user }.sort
+        crontabs_to_remove = old_users - new_users
+      end
+      set :crontabs_to_remove, crontabs_to_remove
+    end
+  end
+
+  task :upload_scripts => [:read_all_settings] do
+    on roles(:cron) do |host|
+      fetch(:crontab_script_files).each do |path|
+        lines = File.read(path).lines.to_a
+        lines.shift
+        file = ERB.new(lines.join, nil, '-').result(binding)
+        as :root do execute("rm", "/tmp/script", "-f") end
+        upload! StringIO.new(file), "/tmp/script"
+        final_path = "#{fetch(:crontab_server_scripts_path)}/#{File.basename(path, '.erb')}"
+        as :root do
+          execute("mv", "/tmp/script", final_path)
+          execute("chmod", "750", final_path)
+        end
+      end
+    end
+  end
+
   desc "Idempotently setup Crontabs."
-  task :setup do
+  task :setup => ['crontab:check:settings', :read_all_settings, :upload_scripts] do
     log_level = SSHKit.config.output_verbosity
     log_level = "info" if log_level.nil?
     SSHKit.config.output_verbosity = fetch(:crontab_log_level)
 
     on roles(:cron) do |host|
-      fetch(:user_crontab_entries).each do |user, entries|
+      # New
+      fetch(:user_crontab_hash).each do |user, lines|
         unless unix_user_exists?(user)
-          error "User #{user} does not exist even though you defined crontab settings for it - Skipping!"
+          error "You defined crontab settings for '#{user}', but no such user exists - Skipping!"
         else
-          set :crontab_entries, entries
-          template_path = File.expand_path("./#{fetch(:crontab_templates_path)}/crontab.erb")
-          generated_config_file = ERB.new(File.new(template_path).read, nil, '-').result(binding)
-          upload! StringIO.new(generated_config_file), "/tmp/crontab"
-          as :root do
-            execute("chown", "#{user}:#{user}", "/tmp/crontab")
-          end
-          as user do
-            execute "crontab", "/tmp/crontab"
-          end
+          set :crontab_entries, lines
+          path = File.expand_path("./#{fetch(:crontab_templates_path)}/crontab.erb")
+          file = ERB.new(File.read(path), nil, '-').result(binding)
+          as :root do execute("rm", "/tmp/crontab", "-f") end
+          upload! StringIO.new(file), "/tmp/crontab"
+          as :root do execute("chown", "#{user}:#{user}", "/tmp/crontab") end
+          as user do execute "crontab", "/tmp/crontab" end
           as :root do
             execute "rm", "/tmp/crontab"
           end
         end
       end
+
+      # Old
+      fetch(:crontabs_to_remove).each do |user|
+        as :root do
+          execute "crontab", "-u", user, "-r"
+        end
+      end
+      content = [
+        "# Add this file to version control, - it tracks and removes crontab",
+        "#   entries on the server which you have removed from the config",
+        fetch(:user_crontab_hash).collect { |u, _| u }.sort.to_s
+      ].join("\n") + "\n"
+      unless File.exists?(fetch(:crontab_lockfile_path)) &&
+          File.read(fetch(:crontab_lockfile_path)) == content
+        File.open(fetch(:crontab_lockfile_path), 'w') { |f| f.write(content) }
+        warn "Updated '#{fetch(:crontab_lockfile_path)}', add it to version control"
+      end
     end
     SSHKit.config.output_verbosity = log_level
   end
@@ -35,13 +112,13 @@ namespace :crontab do
   end
 
   desc "Check the status of the Crontabs."
-  task :status do
+  task :status => [:read_all_settings] do
     log_level = SSHKit.config.output_verbosity
     log_level = "info" if log_level.nil?
     SSHKit.config.output_verbosity = fetch(:crontab_log_level)
 
     on roles(:cron) do
-      fetch(:user_crontab_entries).each do |user, _|
+      fetch(:user_crontab_hash).each do |user, _|
         as :root do
           unless unix_user_exists?(user)
             error "User #{user} does not exist even though you defined crontab settings for it - Skipping!"

data/lib/crontabinator/examples/config/deploy/staging.rb

@@ -4,7 +4,7 @@ set :domain,                        "my-app.example.com"
 server fetch(:domain),
   :user                             => fetch(:deployment_username),
   :roles                            => ["cron"]
-set :user_crontab_entries,          {
+set :user_crontab_entries,          { # this must be set, even if an empty Hash
   "www-data"                          => [
     "SHELL=/bin/bash",
     "MAILTO=myemail@example.com",

data/lib/crontabinator/examples/myscript.sh.erb

@@ -0,0 +1,4 @@
+{ :user => "root", :schedule => '* * * * *' }
+#!/bin/bash
+
+/bin/echo "example scripts.d script" >> <%= current_path.join('log', 'example.log') %> 2>&1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crontabinator
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-27 00:00:00.000000000 Z
+date: 2015-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -90,6 +90,7 @@ files:
 - lib/crontabinator/examples/config/deploy.rb
 - lib/crontabinator/examples/config/deploy/staging.rb
 - lib/crontabinator/examples/crontab.erb
+- lib/crontabinator/examples/myscript.sh.erb
 homepage: https://github.com/snarlysodboxer/crontabinator
 licenses:
 - GNU
@@ -117,3 +118,4 @@ signing_key:
 specification_version: 3
 summary: Deploy Crontabs
 test_files: []
+has_rdoc: