whenever-test 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e58e9d99279233e6a8275a597c0027ad970833c
+  data.tar.gz: 3e1c0a686c3c37d8ce9624fbed598330c6848840
+SHA512:
+  metadata.gz: ab551e5513e11c13624fe18334f5f26ef31b06546fcba4e39e4cfdffbf1ee41a27322af8c80bdd8f72fe5672134753d32d8c3eddc15d38dcb8921af707aedf53
+  data.tar.gz: 8e6b25ec2930806c7073e8c4df9ddec90162d963ef2c98c853ccab87a5f95798f2b6927d7a8331b5370507ad68ce3d948b27d6a6f00766c94b3df64a6775ea18

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem "bundler"
+  gem "rake"
+  gem "pry-byebug"
+end
+
+group :test do
+  gem "minitest"
+  gem "mocha", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    whenever-test (1.0.0)
+      whenever
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (4.0.5)
+      columnize (= 0.9.0)
+    chronic (0.10.2)
+    coderay (1.1.0)
+    columnize (0.9.0)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    minitest (5.7.0)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.1.0)
+      byebug (~> 4.0)
+      pry (~> 0.10)
+    rake (10.4.2)
+    slop (3.6.0)
+    whenever (0.9.4)
+      chronic (>= 0.6.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  minitest
+  mocha
+  pry-byebug
+  rake
+  whenever-test!
+
+BUNDLED WITH
+   1.10.4

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Heart Bits
+
+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,107 @@
+### Whenever::Test
+
+[![Gem Downloads](http://img.shields.io/gem/dt/whenever-test.svg)](https://rubygems.org/gems/whenever-test)
+[![Build Status](https://snap-ci.com/heartbits/whenever-test/branch/master/build_image)](https://snap-ci.com/heartbits/whenever-test/branch/master)
+[![Code Climate](https://codeclimate.com/github/heartbits/whenever-test/badges/gpa.svg)](https://codeclimate.com/github/heartbits/whenever-test)
+[![GitHub Issues](https://img.shields.io/github/issues/heartbits/whenever-test.svg)](https://github.com/heartbits/whenever-test/issues)
+[![GitHub License](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/heartbits/whenever-test)
+
+A gem that adds test support to [Whenever](https://github.com/javan/whenever) gem.
+
+### Background
+
+I've been part of many projects that used whenever gem, but testing the `schedule.rb` file was always neglected.
+
+Turns out your jobs defined in Whenever schedule might reference rake tasks that don't exist in runtime and not even have correct ruby syntax (in case or runner-type jobs).
+
+This gem adds a support class so you can write specs that asserts against definitions in the `schedule.rb` file. To make sure ruby statements referenced in runner-type jobs actually work, you can `instance_eval` them and write expectations on what should happen, and then you'll be sure cron jobs won't have runtime issues that are detected only in staging or production environments.
+
+NOTE: *This gem is test-framework agnostic, so you can use with RSpec, MiniTest, ...*
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'whenever-test'
+end
+```
+
+Available in RubyGems: https://rubygems.org/gems/whenever-test
+
+### Usage
+
+Suppose you have a schedule such as:
+
+```ruby
+# config/schedule.rb
+job_type :curl, 'curl :task'
+
+every :hour { runner 'TimeoutOffers.perform_async' }
+every :minute { curl 'http://myapp.com/cron-alive' }
+
+if @environment == 'staging'
+  every :day { rake 'db_sync:import' }
+end
+```
+
+You can write a spec such as (Minitest was used in this example):
+
+```ruby
+# spec/whenever_spec.rb
+require 'spec_helper'
+
+describe 'Whenever Schedule' do
+  before do
+    load 'Rakefile' # Makes sure rake tasks are loaded so you can assert in rake jobs
+  end
+
+  it 'makes sure `runner` statements exist' do
+    schedule = Whenever::Test::Schedule.new(file: 'config/schedule.rb')
+
+    assert_equal 2, schedule.jobs[:runner].count
+
+    # Executes the actual ruby statement to make sure all constants and methods exist:
+    schedule.jobs[:runner].each { |job| instance_eval job[:task] }
+  end
+
+  it 'makes sure `rake` statements exist' do
+    # config/schedule.rb file is used by default in constructor:
+    schedule = Whenever::Test::Schedule.new(vars: { environment: 'staging' })
+
+    # Makes sure the rake task is defined:
+    assert Rake::Task.task_defined?(schedule.jobs[:rake].first[:task])
+  end
+
+  it 'makes sure cron alive monitor is registered in minute basis' do
+    schedule = Whenever::Test::Schedule.new(file: fixture)
+
+    assert_equal 'http://myapp.com/cron-alive', schedule.jobs[:curl].first[:task]
+    assert_equal 'curl :task', schedule.jobs[:ping].first[:command]
+    assert_equal [:minute], schedule.jobs[:ping].first[:every]
+  end
+end
+```
+
+**Now the important part:** these specs guarantee that:
+
+1. If `TimeoutOffers` constant is not defined or `TimeoutOffers.perform_async` methods doesn't exist, an error will raise
+2. If Rake task `db_sync:import` doesn't exist, an error will raise
+3. You should have a custom task named `curl` to make sure that job will work
+
+### How it works
+
+This gem implements a class that has the same DSL interface as Whenever gem. It basically runs the `schedule.rb` file against the `Whenever::Test::DSLInterpreter` and stores all statements and parameters found so you can easily query them in your tests.
+
+### Contributors
+
+* Rafael Sales [@rafaelsales](https://github.com/rafaelsales)
+
+### Contributing
+
+1. Fork it ( https://github.com/heartbits/whenever-test/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/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs += ["spec", "lib"]
+  t.test_files = FileList['spec/**/*_spec.rb']
+end

data/lib/whenever/test.rb

@@ -0,0 +1,3 @@
+require 'whenever'
+
+Dir.glob(File.join(File.dirname(__FILE__), "/test/**/*.rb")).sort.each { |f| require f }

data/lib/whenever/test/dsl.rb

@@ -0,0 +1,30 @@
+module Whenever::Test
+  class DSLInterpreter
+    def initialize(schedule_world, vars)
+      @_world = schedule_world
+      vars.each do |name, value|
+        instance_variable_set("@#{name}", value)
+      end
+    end
+
+    def job_type(job, command)
+      @_world.jobs[job] = []
+      define_singleton_method(job) do |task, *args|
+        @_world.jobs[job] << StrictHash[task: task, every: @_current_every, command: command]
+      end
+    end
+
+    def every(*args, &block)
+      @_current_every = args
+      yield
+    end
+
+    def set(name, value)
+      @_world.sets[name] = value
+    end
+
+    def env(name, value)
+      @_world.envs[name] = value
+    end
+  end
+end

data/lib/whenever/test/schedule.rb

@@ -0,0 +1,26 @@
+module Whenever::Test
+  class Schedule
+    attr_accessor :jobs, :envs, :sets
+
+    def initialize(file: 'config/schedule.rb', vars: {})
+      self.jobs = {}
+      self.envs = {}
+      self.sets = {}
+
+      dsl = DSLInterpreter.new(self, vars)
+      setup_whenever(dsl)
+      parse(dsl, file)
+    end
+
+    private
+
+    def setup_whenever(dsl)
+      whenever_setup_file = File.join(Gem.loaded_specs['whenever'].full_gem_path, 'lib', 'whenever', 'setup.rb').to_s
+      dsl.instance_eval File.read(whenever_setup_file)
+    end
+
+    def parse(dsl, file)
+      dsl.instance_eval File.read(file)
+    end
+  end
+end

data/lib/whenever/test/strict_hash.rb

@@ -0,0 +1,5 @@
+module Whenever::Test
+  class StrictHash < Hash
+    alias [] fetch
+  end
+end

data/spec/fixtures/db_sync.rake

@@ -0,0 +1,4 @@
+namespace :db_sync do
+  task :import do
+  end
+end

data/spec/fixtures/schedule.rb

@@ -0,0 +1,22 @@
+set :output, '/var/log/whenever.log'
+set :runner_command, 'bundle exec rails runner'
+job_type :ping, 'ping :task'
+env :PATH, ENV['PATH']
+
+every :day do
+  runner 'UpdateAnalyticsMetricsWorker.perform_async'
+end
+
+every :hour do
+  runner 'TimeoutCampaings.perform_async'
+end
+
+every :minute do
+  ping 'http://myapp.com/cron-alive'
+end
+
+if @environment == 'staging'
+  every :day do
+    rake 'db_sync:import'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'pry'
+require 'whenever/test'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'mocha/setup'

data/spec/whenever/test/schedule_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Whenever::Test::Schedule do
+  let(:fixture) { 'spec/fixtures/schedule.rb' }
+  before { load 'spec/fixtures/db_sync.rake' }
+
+  describe '#jobs' do
+    it 'makes sure `runner` statements are captured' do
+      schedule = Whenever::Test::Schedule.new(file: fixture)
+
+      assert_equal 2, schedule.jobs[:runner].count
+
+      # Executes the actual ruby statement to make sure the constant and method exists:
+      schedule.jobs[:runner].each { |job| instance_eval job[:task] }
+    end
+
+    it 'makes sure `rake` statements are captured' do
+      schedule = Whenever::Test::Schedule.new(file: fixture, vars: { environment: 'staging' })
+
+      # Makes sure the rake task is defined:
+      assert Rake::Task.task_defined?(schedule.jobs[:rake].first[:task])
+    end
+
+    it 'makes sure custom job_type tasks are registered' do
+      schedule = Whenever::Test::Schedule.new(file: fixture)
+
+      assert_equal 'http://myapp.com/cron-alive', schedule.jobs[:ping].first[:task]
+      assert_equal 'ping :task', schedule.jobs[:ping].first[:command]
+      assert_equal [:minute], schedule.jobs[:ping].first[:every]
+    end
+  end
+
+  it 'makes sure `set` statements are captured ' do
+    schedule = Whenever::Test::Schedule.new(file: fixture)
+
+    assert_equal 'bundle exec rails runner', schedule.sets[:runner_command]
+  end
+
+  it 'makes sure `env` statements are captured ' do
+    schedule = Whenever::Test::Schedule.new(file: fixture)
+
+    assert_equal ENV['PATH'], schedule.envs[:PATH]
+  end
+
+  class TimeoutCampaings
+    def self.perform_async; end
+  end
+
+  class UpdateAnalyticsMetricsWorker
+    def self.perform_async; end
+  end
+end

data/whenever-test.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'whenever-test'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Rafael Sales']
+  spec.email         = ['rafaelcds@gmail.com']
+  spec.summary       = %q{Test Whenever scheduled jobs}
+  spec.description   = %q{Whenever gem doesn't provide test support, so whenever-test makes that possible}
+  spec.homepage      = 'https://github.com/heartbits/whenever-test'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'whenever'
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: whenever-test
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rafael Sales
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: whenever
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Whenever gem doesn't provide test support, so whenever-test makes that
+  possible
+email:
+- rafaelcds@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/whenever/test.rb
+- lib/whenever/test/dsl.rb
+- lib/whenever/test/schedule.rb
+- lib/whenever/test/strict_hash.rb
+- spec/fixtures/db_sync.rake
+- spec/fixtures/schedule.rb
+- spec/spec_helper.rb
+- spec/whenever/test/schedule_spec.rb
+- whenever-test.gemspec
+homepage: https://github.com/heartbits/whenever-test
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Test Whenever scheduled jobs
+test_files:
+- spec/fixtures/db_sync.rake
+- spec/fixtures/schedule.rb
+- spec/spec_helper.rb
+- spec/whenever/test/schedule_spec.rb