adg-whenever 0.2.2
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG.rdoc +40 -0
- data/Manifest +23 -0
- data/README.rdoc +135 -0
- data/Rakefile +13 -0
- data/bin/whenever +29 -0
- data/bin/wheneverize +69 -0
- data/lib/base.rb +39 -0
- data/lib/command_line.rb +108 -0
- data/lib/job_list.rb +144 -0
- data/lib/job_types/default.rb +27 -0
- data/lib/job_types/rake_task.rb +12 -0
- data/lib/job_types/runner.rb +12 -0
- data/lib/outputs/cron.rb +117 -0
- data/lib/version.rb +9 -0
- data/lib/whenever.rb +27 -0
- data/test/command_line_test.rb +107 -0
- data/test/cron_test.rb +226 -0
- data/test/job_list_test.rb +63 -0
- data/test/output_command_test.rb +70 -0
- data/test/output_env_test.rb +23 -0
- data/test/output_rake_test.rb +74 -0
- data/test/output_runner_test.rb +125 -0
- data/test/test_helper.rb +33 -0
- data/whenever.gemspec +39 -0
- metadata +122 -0
data/test/cron_test.rb
ADDED
@@ -0,0 +1,226 @@
|
|
1
|
+
require File.expand_path(File.dirname(__FILE__) + "/test_helper")
|
2
|
+
|
3
|
+
class CronTest < Test::Unit::TestCase
|
4
|
+
|
5
|
+
context "When parsing time in minutes" do
|
6
|
+
should "raise if less than 1 minute" do
|
7
|
+
assert_raises ArgumentError do
|
8
|
+
parse_time(59.seconds)
|
9
|
+
end
|
10
|
+
|
11
|
+
assert_raises ArgumentError do
|
12
|
+
parse_time(0.minutes)
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
# For santity, do some tests on straight String
|
17
|
+
should "parse correctly" do
|
18
|
+
assert_equal '* * * * *', parse_time(1.minute)
|
19
|
+
assert_equal '0,5,10,15,20,25,30,35,40,45,50,55 * * * *', parse_time(5.minutes)
|
20
|
+
assert_equal '7,14,21,28,35,42,49,56 * * * *', parse_time(7.minutes)
|
21
|
+
assert_equal '0,30 * * * *', parse_time(30.minutes)
|
22
|
+
assert_equal '32 * * * *', parse_time(32.minutes)
|
23
|
+
assert_not_equal '60 * * * *', parse_time(60.minutes) # 60 minutes bumps up into the hour range
|
24
|
+
end
|
25
|
+
|
26
|
+
# Test all minutes
|
27
|
+
(2..59).each do |num|
|
28
|
+
should "parse correctly for #{num} minutes" do
|
29
|
+
start = 0
|
30
|
+
start += num unless 60.modulo(num).zero?
|
31
|
+
minutes = (start..59).step(num).to_a
|
32
|
+
|
33
|
+
assert_equal "#{minutes.join(',')} * * * *", parse_time(num.minutes)
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
38
|
+
context "When parsing time in hours" do
|
39
|
+
should "parse correctly" do
|
40
|
+
assert_equal '0 * * * *', parse_time(1.hour)
|
41
|
+
assert_equal '0 0,2,4,6,8,10,12,14,16,18,20,22 * * *', parse_time(2.hours)
|
42
|
+
assert_equal '0 0,3,6,9,12,15,18,21 * * *', parse_time(3.hours)
|
43
|
+
assert_equal '0 5,10,15,20 * * *', parse_time(5.hours)
|
44
|
+
assert_equal '0 17 * * *', parse_time(17.hours)
|
45
|
+
assert_not_equal '0 24 * * *', parse_time(24.hours) # 24 hours bumps up into the day range
|
46
|
+
end
|
47
|
+
|
48
|
+
(2..23).each do |num|
|
49
|
+
should "parse correctly for #{num} hours" do
|
50
|
+
start = 0
|
51
|
+
start += num unless 24.modulo(num).zero?
|
52
|
+
hours = (start..23).step(num).to_a
|
53
|
+
|
54
|
+
assert_equal "0 #{hours.join(',')} * * *", parse_time(num.hours)
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
should "parse correctly when given an 'at' with minutes as an Integer" do
|
59
|
+
assert_minutes_equals "1", 1
|
60
|
+
assert_minutes_equals "14", 14
|
61
|
+
assert_minutes_equals "27", 27
|
62
|
+
assert_minutes_equals "55", 55
|
63
|
+
end
|
64
|
+
|
65
|
+
should "parse correctly when given an 'at' with minutes as a Time" do
|
66
|
+
# Basically just testing that Chronic parses some times and we get the minutes out of it
|
67
|
+
assert_minutes_equals "1", '3:01am'
|
68
|
+
assert_minutes_equals "1", 'January 21 2:01 PM'
|
69
|
+
assert_minutes_equals "0", 'midnight'
|
70
|
+
assert_minutes_equals "59", '13:59'
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
context "When parsing time in days (of month)" do
|
75
|
+
should "parse correctly" do
|
76
|
+
assert_equal '0 0 * * *', parse_time(1.days)
|
77
|
+
assert_equal '0 0 1,3,5,7,9,11,13,15,17,19,21,23,25,27,29,31 * *', parse_time(2.days)
|
78
|
+
assert_equal '0 0 1,5,9,13,17,21,25,29 * *', parse_time(4.days)
|
79
|
+
assert_equal '0 0 1,8,15,22 * *', parse_time(7.days)
|
80
|
+
assert_equal '0 0 1,17 * *', parse_time(16.days)
|
81
|
+
assert_equal '0 0 17 * *', parse_time(17.days)
|
82
|
+
assert_equal '0 0 29 * *', parse_time(29.days)
|
83
|
+
assert_not_equal '0 0 30 * *', parse_time(30.days) # 30 days bumps into the month range
|
84
|
+
end
|
85
|
+
|
86
|
+
should "parse correctly when given an 'at' with hours, minutes as a Time" do
|
87
|
+
# first param is an array with [hours, minutes]
|
88
|
+
assert_hours_and_minutes_equals %w(3 45), '3:45am'
|
89
|
+
assert_hours_and_minutes_equals %w(20 1), '8:01pm'
|
90
|
+
assert_hours_and_minutes_equals %w(0 0), 'midnight'
|
91
|
+
assert_hours_and_minutes_equals %w(1 23), '1:23 AM'
|
92
|
+
assert_hours_and_minutes_equals %w(23 59), 'March 21 11:59 pM'
|
93
|
+
end
|
94
|
+
|
95
|
+
should "parse correctly when given an 'at' with hours as an Integer" do
|
96
|
+
# first param is an array with [hours, minutes]
|
97
|
+
assert_hours_and_minutes_equals %w(1 0), 1
|
98
|
+
assert_hours_and_minutes_equals %w(3 0), 3
|
99
|
+
assert_hours_and_minutes_equals %w(15 0), 15
|
100
|
+
assert_hours_and_minutes_equals %w(19 0), 19
|
101
|
+
assert_hours_and_minutes_equals %w(23 0), 23
|
102
|
+
end
|
103
|
+
end
|
104
|
+
|
105
|
+
context "When parsing time in months" do
|
106
|
+
should "parse correctly" do
|
107
|
+
assert_equal '0 0 1 * *', parse_time(1.month)
|
108
|
+
assert_equal '0 0 1 1,3,5,7,9,11 *', parse_time(2.months)
|
109
|
+
assert_equal '0 0 1 1,4,7,10 *', parse_time(3.months)
|
110
|
+
assert_equal '0 0 1 1,5,9 *', parse_time(4.months)
|
111
|
+
assert_equal '0 0 1 1,6 *', parse_time(5.months)
|
112
|
+
assert_equal '0 0 1 7 *', parse_time(7.months)
|
113
|
+
assert_equal '0 0 1 8 *', parse_time(8.months)
|
114
|
+
assert_equal '0 0 1 9 *', parse_time(9.months)
|
115
|
+
assert_equal '0 0 1 10 *', parse_time(10.months)
|
116
|
+
assert_equal '0 0 1 11 *', parse_time(11.months)
|
117
|
+
assert_equal '0 0 1 12 *', parse_time(12.months)
|
118
|
+
end
|
119
|
+
|
120
|
+
should "parse correctly when given an 'at' with days, hours, minutes as a Time" do
|
121
|
+
# first param is an array with [days, hours, minutes]
|
122
|
+
assert_days_and_hours_and_minutes_equals %w(1 3 45), 'January 1st 3:45am'
|
123
|
+
assert_days_and_hours_and_minutes_equals %w(11 23 0), 'Feb 11 11PM'
|
124
|
+
assert_days_and_hours_and_minutes_equals %w(22 1 1), 'march 22nd at 1:01 am'
|
125
|
+
assert_days_and_hours_and_minutes_equals %w(23 0 0), 'march 22nd at midnight' # looks like midnight means the next day
|
126
|
+
end
|
127
|
+
|
128
|
+
should "parse correctly when given an 'at' with days as an Integer" do
|
129
|
+
# first param is an array with [days, hours, minutes]
|
130
|
+
assert_days_and_hours_and_minutes_equals %w(1 0 0), 1
|
131
|
+
assert_days_and_hours_and_minutes_equals %w(15 0 0), 15
|
132
|
+
assert_days_and_hours_and_minutes_equals %w(29 0 0), 29
|
133
|
+
end
|
134
|
+
end
|
135
|
+
|
136
|
+
context "When parsing time in days (of week)" do
|
137
|
+
should "parse days of the week correctly" do
|
138
|
+
{
|
139
|
+
'sun' => %w(sun Sunday SUNDAY SUN),
|
140
|
+
'mon' => %w(mon Monday MONDAY MON),
|
141
|
+
'tue' => %w(tue tues Tuesday TUESDAY TUE),
|
142
|
+
'wed' => %w(wed Wednesday WEDNESDAY WED),
|
143
|
+
'thu' => %w(thu thurs thur Thursday THURSDAY THU),
|
144
|
+
'fri' => %w(fri Friday FRIDAY FRI),
|
145
|
+
'sat' => %w(sat Saturday SATURDAY SAT)
|
146
|
+
}.each do |day, day_tests|
|
147
|
+
day_tests.each do |day_test|
|
148
|
+
assert_equal "0 0 * * #{day}", parse_time(day_test)
|
149
|
+
end
|
150
|
+
end
|
151
|
+
end
|
152
|
+
|
153
|
+
should "allow additional directives" do
|
154
|
+
assert_equal '30 13 * * fri', parse_time('friday', nil, "1:30 pm")
|
155
|
+
assert_equal '22 2 * * mon', parse_time('Monday', nil, "2:22am")
|
156
|
+
assert_equal '55 17 * * thu', parse_time('THU', nil, "5:55PM")
|
157
|
+
end
|
158
|
+
|
159
|
+
should "parse weekday correctly" do
|
160
|
+
assert_equal '0 0 * * mon-fri', parse_time('weekday')
|
161
|
+
assert_equal '0 0 * * mon-fri', parse_time('Weekdays')
|
162
|
+
assert_equal '0 1 * * mon-fri', parse_time('Weekdays', nil, "1:00 am")
|
163
|
+
assert_equal '59 5 * * mon-fri', parse_time('Weekdays', nil, "5:59 am")
|
164
|
+
end
|
165
|
+
|
166
|
+
should "parse weekend correctly" do
|
167
|
+
assert_equal '0 0 * * sat,sun', parse_time('weekend')
|
168
|
+
assert_equal '0 0 * * sat,sun', parse_time('Weekends')
|
169
|
+
assert_equal '0 7 * * sat,sun', parse_time('Weekends', nil, "7am")
|
170
|
+
assert_equal '2 18 * * sat,sun', parse_time('Weekends', nil, "6:02PM")
|
171
|
+
end
|
172
|
+
end
|
173
|
+
|
174
|
+
context "When parsing time using the cron shortcuts" do
|
175
|
+
should "parse a :symbol into the correct shortcut" do
|
176
|
+
assert_equal '@reboot', parse_time(:reboot)
|
177
|
+
assert_equal '@annually', parse_time(:year)
|
178
|
+
assert_equal '@annually', parse_time(:yearly)
|
179
|
+
assert_equal '@daily', parse_time(:day)
|
180
|
+
assert_equal '@daily', parse_time(:daily)
|
181
|
+
assert_equal '@midnight', parse_time(:midnight)
|
182
|
+
assert_equal '@monthly', parse_time(:month)
|
183
|
+
assert_equal '@monthly', parse_time(:monthly)
|
184
|
+
assert_equal '@hourly', parse_time(:hour)
|
185
|
+
assert_equal '@hourly', parse_time(:hourly)
|
186
|
+
end
|
187
|
+
|
188
|
+
should "raise an exception if a valid shortcut is given but also an :at" do
|
189
|
+
assert_raises ArgumentError do
|
190
|
+
parse_time(:hour, nil, "1:00 am")
|
191
|
+
end
|
192
|
+
|
193
|
+
assert_raises ArgumentError do
|
194
|
+
parse_time(:reboot, nil, 5)
|
195
|
+
end
|
196
|
+
|
197
|
+
assert_raises ArgumentError do
|
198
|
+
parse_time(:day, nil, '4:20pm')
|
199
|
+
end
|
200
|
+
end
|
201
|
+
end
|
202
|
+
|
203
|
+
private
|
204
|
+
|
205
|
+
def assert_days_and_hours_and_minutes_equals(expected, time)
|
206
|
+
cron = parse_time(2.months, 'some task', time)
|
207
|
+
minutes, hours, days, *garbage = cron.split(' ')
|
208
|
+
assert_equal expected, [days, hours, minutes]
|
209
|
+
end
|
210
|
+
|
211
|
+
def assert_hours_and_minutes_equals(expected, time)
|
212
|
+
cron = parse_time(2.days, 'some task', time)
|
213
|
+
minutes, hours, *garbage = cron.split(' ')
|
214
|
+
assert_equal expected, [hours, minutes]
|
215
|
+
end
|
216
|
+
|
217
|
+
def assert_minutes_equals(expected, time)
|
218
|
+
cron = parse_time(2.hours, 'some task', time)
|
219
|
+
assert_equal expected, cron.split(' ')[0]
|
220
|
+
end
|
221
|
+
|
222
|
+
def parse_time(time = nil, task = nil, at = nil)
|
223
|
+
Whenever::Output::Cron.new(time, task, at).time_in_cron_syntax
|
224
|
+
end
|
225
|
+
|
226
|
+
end
|
@@ -0,0 +1,63 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'ruby-debug'
|
3
|
+
|
4
|
+
require File.expand_path(File.dirname(__FILE__) + "/test_helper")
|
5
|
+
|
6
|
+
class JobListTest < Test::Unit::TestCase
|
7
|
+
|
8
|
+
context "A JobList for days-based jobs" do
|
9
|
+
setup do
|
10
|
+
@jobs = <<-JOBS
|
11
|
+
every 1.day do
|
12
|
+
runner 'foo'
|
13
|
+
end
|
14
|
+
|
15
|
+
every 2.days, :at => '4:30am' do
|
16
|
+
runner 'bar'
|
17
|
+
end
|
18
|
+
JOBS
|
19
|
+
|
20
|
+
@job_list = Whenever::JobList.new(:string => @jobs)
|
21
|
+
end
|
22
|
+
|
23
|
+
should "have scheduled jobs" do
|
24
|
+
assert_equal 2, @job_list.scheduled_jobs.size
|
25
|
+
end
|
26
|
+
|
27
|
+
should "have schedule for task" do
|
28
|
+
assert_no_match /not found/, @job_list.schedule_for_task('foo')
|
29
|
+
assert_no_match /not found/, @job_list.schedule_for_task('bar')
|
30
|
+
end
|
31
|
+
|
32
|
+
should "not have schedule for non-existent task" do
|
33
|
+
assert_match /not found/, @job_list.schedule_for_task('baz')
|
34
|
+
end
|
35
|
+
|
36
|
+
context "with updated schedule" do
|
37
|
+
setup do
|
38
|
+
@filename = 'test/fixtures/schedule.rb'
|
39
|
+
File.open(@filename, 'w') { |f| f.write(@jobs) }
|
40
|
+
@task = 'bar'
|
41
|
+
@schedule = {"interval"=>"days", "frequency"=>"4", "at"=>"10:00pm"}
|
42
|
+
Whenever::JobList.new(:file => File.expand_path(@filename)).update_schedule_for_task(@task, @schedule)
|
43
|
+
@job_list = Whenever::JobList.new(:file => File.expand_path(@filename))
|
44
|
+
end
|
45
|
+
|
46
|
+
should "provide updated scheduled job" do
|
47
|
+
assert_equal 4, @job_list.schedule_data_for_task(@task)[:frequency]
|
48
|
+
assert_equal '10:00pm', @job_list.schedule_data_for_task(@task)[:at]
|
49
|
+
end
|
50
|
+
|
51
|
+
should "update schedule file" do
|
52
|
+
lines = File.readlines(@filename)
|
53
|
+
lines.each_with_index do |line, i|
|
54
|
+
if line.include?(@task)
|
55
|
+
j = i - 1
|
56
|
+
assert lines[j].include?('4.days')
|
57
|
+
assert lines[j].include?('10:00pm')
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
@@ -0,0 +1,70 @@
|
|
1
|
+
require File.expand_path(File.dirname(__FILE__) + "/test_helper")
|
2
|
+
|
3
|
+
class OutputCommandTest < Test::Unit::TestCase
|
4
|
+
|
5
|
+
context "A plain command" do
|
6
|
+
setup do
|
7
|
+
@output = Whenever.cron \
|
8
|
+
<<-file
|
9
|
+
every 2.hours do
|
10
|
+
command "blahblah"
|
11
|
+
end
|
12
|
+
file
|
13
|
+
end
|
14
|
+
|
15
|
+
should "output the command" do
|
16
|
+
assert_match /^.+ .+ .+ .+ blahblah$/, @output
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
context "A command when the cron_log is set" do
|
21
|
+
setup do
|
22
|
+
@output = Whenever.cron \
|
23
|
+
<<-file
|
24
|
+
set :cron_log, 'logfile.log'
|
25
|
+
every 2.hours do
|
26
|
+
command "blahblah"
|
27
|
+
end
|
28
|
+
file
|
29
|
+
end
|
30
|
+
|
31
|
+
should "output the command with the log syntax appended" do
|
32
|
+
assert_match /^.+ .+ .+ .+ blahblah >> logfile.log 2>&1$/, @output
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
context "A command when the cron_log is set and the comand overrides it" do
|
37
|
+
setup do
|
38
|
+
@output = Whenever.cron \
|
39
|
+
<<-file
|
40
|
+
set :cron_log, 'logfile.log'
|
41
|
+
every 2.hours do
|
42
|
+
command "blahblah", :cron_log => 'otherlog.log'
|
43
|
+
end
|
44
|
+
file
|
45
|
+
end
|
46
|
+
|
47
|
+
should "output the command with the log syntax appended" do
|
48
|
+
assert_no_match /.+ .+ .+ .+ blahblah >> logfile.log 2>&1/, @output
|
49
|
+
assert_match /^.+ .+ .+ .+ blahblah >> otherlog.log 2>&1$/, @output
|
50
|
+
end
|
51
|
+
end
|
52
|
+
|
53
|
+
context "A command when the cron_log is set and the comand rejects it" do
|
54
|
+
setup do
|
55
|
+
@output = Whenever.cron \
|
56
|
+
<<-file
|
57
|
+
set :cron_log, 'logfile.log'
|
58
|
+
every 2.hours do
|
59
|
+
command "blahblah", :cron_log => false
|
60
|
+
end
|
61
|
+
file
|
62
|
+
end
|
63
|
+
|
64
|
+
should "output the command without the log syntax appended" do
|
65
|
+
assert_no_match /.+ .+ .+ .+ blahblah >> logfile.log 2>&1/, @output
|
66
|
+
assert_match /^.+ .+ .+ .+ blahblah$/, @output
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
require File.expand_path(File.dirname(__FILE__) + "/test_helper")
|
2
|
+
|
3
|
+
class OutputEnvTest < Test::Unit::TestCase
|
4
|
+
|
5
|
+
context "The output from Whenever with environment variables set" do
|
6
|
+
setup do
|
7
|
+
@output = Whenever.cron \
|
8
|
+
<<-file
|
9
|
+
env :MYVAR, 'blah'
|
10
|
+
env 'MAILTO', "someone@example.com"
|
11
|
+
file
|
12
|
+
end
|
13
|
+
|
14
|
+
should "output MYVAR environment variable" do
|
15
|
+
assert_match "MYVAR=blah", @output
|
16
|
+
end
|
17
|
+
|
18
|
+
should "output MAILTO environment variable" do
|
19
|
+
assert_match "MAILTO=someone@example.com", @output
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
end
|
@@ -0,0 +1,74 @@
|
|
1
|
+
require File.expand_path(File.dirname(__FILE__) + "/test_helper")
|
2
|
+
|
3
|
+
class OutputRakeTest < Test::Unit::TestCase
|
4
|
+
|
5
|
+
# Rake are generated in an almost identical way to runners so we
|
6
|
+
# only need some basic tests to ensure they are output correctly
|
7
|
+
|
8
|
+
context "A rake command with path set" do
|
9
|
+
setup do
|
10
|
+
@output = Whenever.cron \
|
11
|
+
<<-file
|
12
|
+
set :path, '/my/path'
|
13
|
+
every 2.hours do
|
14
|
+
rake "blahblah"
|
15
|
+
end
|
16
|
+
file
|
17
|
+
end
|
18
|
+
|
19
|
+
should "output the rake command using that path" do
|
20
|
+
assert_match two_hours + ' cd /my/path && RAILS_ENV=production /usr/bin/env rake blahblah', @output
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
context "A rake command that overrides the path set" do
|
25
|
+
setup do
|
26
|
+
@output = Whenever.cron \
|
27
|
+
<<-file
|
28
|
+
set :path, '/my/path'
|
29
|
+
every 2.hours do
|
30
|
+
rake "blahblah", :path => '/some/other/path'
|
31
|
+
end
|
32
|
+
file
|
33
|
+
end
|
34
|
+
|
35
|
+
should "output the rake command using that path" do
|
36
|
+
assert_match two_hours + ' cd /some/other/path && RAILS_ENV=production /usr/bin/env rake blahblah', @output
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
context "A rake command with environment set" do
|
41
|
+
setup do
|
42
|
+
@output = Whenever.cron \
|
43
|
+
<<-file
|
44
|
+
set :environment, :silly
|
45
|
+
set :path, '/my/path'
|
46
|
+
every 2.hours do
|
47
|
+
rake "blahblah"
|
48
|
+
end
|
49
|
+
file
|
50
|
+
end
|
51
|
+
|
52
|
+
should "output the rake command using that environment" do
|
53
|
+
assert_match two_hours + ' cd /my/path && RAILS_ENV=silly /usr/bin/env rake blahblah', @output
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
context "A rake command that overrides the environment set" do
|
58
|
+
setup do
|
59
|
+
@output = Whenever.cron \
|
60
|
+
<<-file
|
61
|
+
set :environment, :silly
|
62
|
+
set :path, '/my/path'
|
63
|
+
every 2.hours do
|
64
|
+
rake "blahblah", :environment => :serious
|
65
|
+
end
|
66
|
+
file
|
67
|
+
end
|
68
|
+
|
69
|
+
should "output the rake command using that environment" do
|
70
|
+
assert_match two_hours + ' cd /my/path && RAILS_ENV=serious /usr/bin/env rake blahblah', @output
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
end
|