capistrano-crontab 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b55fea9c50337accbc5ea2d5ad5de57a589be0f
+  data.tar.gz: 9575801ba52762a84c644005792c96385e6554a4
+SHA512:
+  metadata.gz: f79ef57a256bfe97ae9c11e12b15fc5ae1ac1d0afbdd3543ed6c94ec1a703f592c10a405b6cd39a83ed8f0a77fdd75595699ddb8ff004003985b1bd36d737bc4
+  data.tar.gz: 7ca9478f13d7a459864909635427709d563c99509eba9d6f03ab717257bdfe7bd8e117a48e84f3ea5c3c77a4d966cfd811b915e32097bef5f824c493305bb5a7

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing
+
+1. Fork it ([https://github.com/KumukanGmbH/capistrano-crontab/fork](https://github.com/KumukanGmbH/capistrano-crontab/fork))
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in *.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016, Kumukan GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# Capistrano::Crontab
+
+This capistrano plugin is inspired by [fab_deploy.crontab](https://bitbucket.org/kmike/django-fab-deploy/src/9c07813e136bf3e059684b4205e0577973c157b4/fab_deploy/crontab.py?at=default&fileviewer=file-view-default)
+and allows you to add, remove and update cronjobs in your crontab.
+
+## Requirements
+
+* capistrano >= 3.0
+* sshkit >= 1.2
+
+## Installation
+
+Add this to your `Gemfile`:
+
+```ruby
+group :development do
+  gem "capistrano"
+  gem "capistrano-crontab"
+end
+```
+
+And then:
+
+```
+$ bundle install
+```
+
+## Setup
+
+Add this line to `Capfile`:
+
+```ruby
+require "capistrano/crontab"
+```
+
+## DSL usage
+
+```ruby
+on roles(:all) do
+  # output the content of your crontab using `puts`
+  crontab_puts_content
+
+  #
+  # Crontab:
+  #   30 7 * * * start -q anacron || :
+  #
+
+  # get the content of your crontab
+  crontab = crontab_get_content
+
+  #
+  # Crontab:
+  #   30 7 * * * start -q anacron || :
+  #
+
+  # add a new cronjob to your crontab and mark it with "date"
+  crontab_add_line("*/5 * * * * date >> /tmp/date", "date")
+
+  #
+  # Crontab:
+  #   30 7 * * * start -q anacron || :
+  #   */5 * * * * data >> /tmp/date # MARKER:date
+  #
+
+  # update an existing cronjob in your crontab, which is marked with "date"
+  crontab_update_line("*/2 * * * * date >> /tmp/date", "date")
+
+  #
+  # Crontab:
+  #   30 7 * * * start -q anacron || :
+  #   */2 * * * * date >> /tmp/date # MARKER:date
+  #
+
+  # ensure that a cronjob exists in your crontab, and mark it with "snapshot"
+  crontab_update_line("0 * * * * create_snapshot", "snapshot")
+
+  #
+  # Crontab
+  #   30 7 * * * start -q anacron || :
+  #   */2 * * * * date >> /tmp/date # MARKER:date
+  #   0 * * * * create_snapshot # MARKER:snapshot
+  #
+
+  # remove the cronjob, which is marked with "date"
+  crontab_remove_line("date")
+
+  #
+  # Crontab:
+  #   30 7 * * * start -q anacron || :
+  #   0 * * * * create_snapshot # MARKER:snapshot
+  #
+
+  # overwrite the whole crontab
+  crontab_set_content("* * 1 * * send_invoices_to_customers")
+
+  #
+  # Crontab:
+  #   * * 1 * * send_invoices_to_customers
+  #
+end
+```
+
+## TODOs
+
+* Update DSL to look more like `fab_deploy.crontab` (e.g. `crontab.add_line`)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-crontab.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib)
+require "capistrano/crontab/version"
+
+Gem::Specification.new do |gem|
+  gem.name = "capistrano-crontab"
+  gem.version = Capistrano::Crontab::VERSION
+  gem.authors = [ "Jan Pieper" ]
+  gem.email = [ "tech@kumukan.com" ]
+  gem.description = "Crontab DSL for Capistrano."
+  gem.summary = "Capistrano plugin for crontab DSL extension, to add/update/remove cronjobs."
+  gem.homepage = "https://github.com/KumukanGmbH/capistrano-crontab"
+
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(%r{bin/}).map { |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{spec/})
+  gem.require_paths = [ "lib" ]
+
+  gem.add_dependency "capistrano", ">= 3.0"
+  gem.add_dependency "sshkit", ">= 1.2"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", ">= 3.0"
+end

data/lib/capistrano/crontab.rb

@@ -0,0 +1 @@
+require "capistrano/dsl/crontab"

data/lib/capistrano/crontab/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Crontab
+    VERSION = "0.2.0"
+  end
+end

data/lib/capistrano/dsl/crontab.rb

@@ -0,0 +1,49 @@
+module Capistrano
+  module DSL
+    def crontab_get_content
+      capture(:crontab, "-l")
+    end
+
+    def crontab_set_content(content)
+      tempfile = Tempfile.new
+      tempfile.write("#{content}\n")
+      tempfile.close
+
+      begin
+        upload!(tempfile.path, tempfile.path)
+        execute(:crontab, tempfile.path)
+      ensure
+        execute(:rm, "-f", tempfile.path)
+        tempfile.unlink
+      end
+    end
+
+    def crontab_puts_content
+      puts crontab_get_content
+    end
+
+    def crontab_add_line(content, marker = nil)
+      old_crontab = crontab_get_content
+      marker = crontab_marker(marker)
+      crontab_set_content("#{old_crontab.rstrip}\n#{content}#{marker}")
+    end
+
+    def crontab_remove_line(marker)
+      marker = crontab_marker(marker)
+
+      lines = crontab_get_content.split("\n")
+        .reject { |line| line.end_with?(marker) }
+
+      crontab_set_content(lines.join("\n"))
+    end
+
+    def crontab_update_line(content, marker)
+      crontab_remove_line(marker)
+      crontab_add_line(content, marker)
+    end
+
+    def crontab_marker(marker = nil)
+      marker.nil? ? "" : " # MARKER:%s" % [marker]
+    end
+  end
+end

data/spec/lib/capistrano/dsl/crontab_spec.rb

@@ -0,0 +1,191 @@
+require "spec_helper"
+
+RSpec.describe Capistrano::DSL do
+  let(:dsl) { Class.new { extend Capistrano::DSL } }
+  let(:tempfile) { StringIO.new }
+
+  before(:each) do
+    allow(Tempfile).to receive(:new).and_wrap_original { tempfile.reopen }
+    allow(tempfile).to receive(:path).and_return("/tmp/capistrano-crontab")
+    allow(tempfile).to receive(:unlink)
+
+    allow(dsl).to receive(:capture).with(:crontab, "-l").and_wrap_original { tempfile.string }
+    allow(dsl).to receive(:upload!)
+    allow(dsl).to receive(:execute)
+  end
+
+  describe ".crontab_get_content" do
+    it "should call .capture with :crontab and '-l' as arguments" do
+      expect(dsl).to receive(:capture).once.with(:crontab, "-l")
+      dsl.crontab_get_content
+    end
+
+    it "should return the return value of the call to .capture" do
+      allow(dsl).to receive(:capture).and_return("crontab content\n")
+      expect(dsl.crontab_get_content).to eql("crontab content\n")
+    end
+  end
+
+  describe ".crontab_set_content" do
+    context "if upload of tempfile fails" do
+      before(:each) do
+        expect(dsl).to receive(:upload!)
+          .once.with(tempfile.path, tempfile.path)
+          .and_raise("Upload failed")
+      end
+
+      after(:each) do
+        expect { dsl.crontab_set_content("irrelevant") }.to raise_error("Upload failed")
+      end
+
+      it "should not update crontab on the server" do
+        expect(dsl).not_to receive(:execute).with(:crontab, tempfile.path)
+      end
+
+      it "should delete tempfile on the server" do
+        expect(dsl).to receive(:execute).once.with(:rm, "-f", tempfile.path)
+      end
+
+      it "should delete tempfile locally" do
+        expect(tempfile).to receive(:unlink).once
+      end
+    end
+
+    context "if update of crontab fails" do
+      before(:each) do
+        expect(dsl).to receive(:execute)
+          .once.with(:crontab, tempfile.path)
+          .and_raise("Crontab update failed")
+      end
+
+      after(:each) do
+        expect { dsl.crontab_set_content("Irrelevant") }.to raise_error("Crontab update failed")
+      end
+
+      it "should upload tempfile to the server" do
+        expect(dsl).to receive(:upload!).once.with(tempfile.path, tempfile.path)
+      end
+
+      it "should delete tempfile on the server" do
+        expect(dsl).to receive(:execute).once.with(:rm, "-f", tempfile.path)
+      end
+
+      it "should delete tempfile locally" do
+        expect(tempfile).to receive(:unlink).once
+      end
+    end
+
+    context "if update of crontab is successful" do
+      after(:each) do
+        dsl.crontab_set_content("Irrelevant")
+      end
+
+      it "should upload tempfile to the server" do
+        expect(dsl).to receive(:upload!).once.with(tempfile.path, tempfile.path)
+      end
+
+      it "should update crontab on the server" do
+        expect(dsl).to receive(:execute).once.with(:crontab, tempfile.path)
+      end
+
+      it "should delete tempfile on the server" do
+        expect(dsl).to receive(:execute).once.with(:rm, "-f", tempfile.path)
+      end
+
+      it "should delete tempfile locally" do
+        expect(tempfile).to receive(:unlink)
+      end
+    end
+  end
+
+  describe ".crontab_puts_content" do
+    it "should call .crontab_get_content without any args" do
+      expect(dsl).to receive(:crontab_get_content).once.with(no_args)
+      expect { dsl.crontab_puts_content }.to output.to_stdout
+    end
+
+    it "should write the return value of .crontab_get_content to stdout" do
+      allow(dsl).to receive(:crontab_get_content).and_return("crontab content\n")
+      expect { dsl.crontab_puts_content }.to output("crontab content\n").to_stdout
+    end
+  end
+
+  describe ".crontab_add_line" do
+    before(:each) do
+      dsl.crontab_set_content("* * * * * create_snapshot")
+    end
+
+    it "should call .crontab_set_content with previous crontab content and new line marked with 'backup'" do
+      expect(dsl).to receive(:crontab_set_content).once.with(
+        "* * * * * create_snapshot\n" \
+        "* * * * * rotate_logs # MARKER:backup"
+      )
+
+      dsl.crontab_add_line("* * * * * rotate_logs", "backup")
+    end
+  end
+
+  describe ".crontab_remove_line" do
+    before(:each) do
+      dsl.crontab_set_content(
+        "* * * * * create_snapshot\n" \
+        "* * * * * rotate_logs # MARKER:rotate\n" \
+        "* * * * * clear_cache # MARKER:clear"
+      )
+    end
+
+    it "should call .crontab_set_content with previous crontab content except the line marked with 'rotate'" do
+      expect(dsl).to receive(:crontab_set_content).once.with(
+        "* * * * * create_snapshot\n" \
+        "* * * * * clear_cache # MARKER:clear"
+      )
+
+      dsl.crontab_remove_line("rotate")
+    end
+  end
+
+  describe ".crontab_update_line" do
+    before(:each) do
+      dsl.crontab_set_content(
+        "* * * * * create_snapshot\n" \
+        "* * * * * rotate_logs # MARKER:rotate\n" \
+        "* * * * * clear_cache # MARKER:clear"
+      )
+    end
+
+    after(:each) do
+      dsl.crontab_update_line("0 0 * * * rotate_logs", "rotate")
+    end
+
+    it "should call .crontab_set_content with previous crontab content except the line to be updated" do
+      expect(dsl).to receive(:crontab_set_content).once.with(
+        "* * * * * create_snapshot\n" \
+        "* * * * * clear_cache # MARKER:clear" \
+      ).and_call_original
+
+      allow(dsl).to receive(:crontab_set_content)
+        .once.with(anything).and_call_original
+    end
+
+    it "should call .crontab_set_content with previous crontab content and updated line marked with 'rotate'" do
+      allow(dsl).to receive(:crontab_set_content)
+        .once.with(anything).and_call_original
+
+      expect(dsl).to receive(:crontab_set_content).with(
+        "* * * * * create_snapshot\n" \
+        "* * * * * clear_cache # MARKER:clear\n" \
+        "0 0 * * * rotate_logs # MARKER:rotate"
+      ).and_call_original
+    end
+  end
+
+  describe ".crontab_marker" do
+    it "should return empty marker string if no marker name is given" do
+      expect(dsl.crontab_marker).to eql("")
+    end
+
+    it "should return ' # MARKER:backup' if marker name is 'backup'" do
+      expect(dsl.crontab_marker("backup")).to eql(" # MARKER:backup")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+
+require "capistrano/all"
+require "capistrano/crontab"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    #mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  #config.filter_run :focus
+  #config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  #config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-crontab
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Jan Pieper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Crontab DSL for Capistrano.
+email:
+- tech@kumukan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-crontab.gemspec
+- lib/capistrano-crontab.rb
+- lib/capistrano/crontab.rb
+- lib/capistrano/crontab/version.rb
+- lib/capistrano/dsl/crontab.rb
+- spec/lib/capistrano/dsl/crontab_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/KumukanGmbH/capistrano-crontab
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Capistrano plugin for crontab DSL extension, to add/update/remove cronjobs.
+test_files:
+- spec/lib/capistrano/dsl/crontab_spec.rb
+- spec/spec_helper.rb