1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
|
#!/usr/bin/env python
#
# Copyright (C) 2013 Martin Owens
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 3.0 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library.
#
"""
Test crontab interaction.
"""
import re
import os
import unittest
from crontab import CronTab, CronSlices, CronSlice, PY3
from .utils import LoggingMixin
try:
from test import test_support
except ImportError:
from test import support as test_support
TEST_DIR = os.path.dirname(__file__)
if PY3:
unicode = str #pylint: disable=redefined-builtin
COMMANDS = [
'firstcommand',
'range',
'byweek',
'disabled',
'spaced',
'python /example_app/testing.py',
'rebooted',
'echo % escaped',
'cat %%',
]
RESULT_TAB = """# First Comment
# Edit this line to test for mistaken checks
# m h dom mon dow user command
*/30 * * * * firstcommand
* 10-20/3 * * * range
# Middle Comment
* * * 10 * byweek # Comment One
# * * * * * disabled
0 5 * * * spaced # Comment Two
# monitorCron\\n*/59 * * * * python /example_app/testing.py
@reboot rebooted # re-id
# Last Comment @has this # extra
# percent_one\\n* * * * * echo \% escaped
# percent_two\\n* * * * * cat \%\% % stdin%with%lines
"""
class InteractionTestCase(LoggingMixin, unittest.TestCase):
"""Test basic functionality of crontab."""
log_name = 'crontab'
def setUp(self):
super(InteractionTestCase, self).setUp()
self.crontab = CronTab(tabfile=os.path.join(TEST_DIR, 'data', 'test.tab'))
def test_01_presevation(self):
"""All Entries Re-Rendered Correctly"""
results = RESULT_TAB.split('\n')
for line_no, line in enumerate(self.crontab.lines):
self.assertEqual(str(line), results[line_no].replace('\\n', '\n'))
def test_02_access(self):
"""All Entries Are Accessable"""
for line_no, job in enumerate(self.crontab):
self.assertEqual(str(job.command), COMMANDS[line_no])
else: # pylint: disable=useless-else-on-loop
self.assertEqual(line_no + 1, 9)
def test_03_blank(self):
"""Render Blank"""
job = self.crontab.new(command='blank')
self.assertEqual(repr(job), '<CronItem \'* * * * * blank\'>')
self.assertEqual(job.render(), '* * * * * blank')
def test_04_number(self):
"""Render Number"""
job = self.crontab.new(command='number')
job.minute.on(4)
self.assertEqual(job.render(), '4 * * * * number')
def test_05_fields(self):
"""Render Hours Days and Weeks"""
job = self.crontab.new(command='fields')
job.hour.on(4)
self.assertEqual(job.render(), '* 4 * * * fields')
job.dom.on(5)
self.assertEqual(job.render(), '* 4 5 * * fields')
job.month.on(6)
self.assertEqual(job.render(), '* 4 5 6 * fields')
job.dow.on(7)
self.assertEqual(job.render(), '* 4 5 6 0 fields')
def test_05_multiple_fields(self):
"""Test mutliple named fields"""
job = self.crontab.new(command='fields')
job.hour.on(4, 6, 7)
self.assertEqual(job.render(), '* 4,6,7 * * * fields')
job.dow.on('SUN', 'FRI')
self.assertEqual(job.render(), '* 4,6,7 * * SUN,FRI fields')
def test_06_clear(self):
"""Render Hours Days and Weeks"""
job = self.crontab.new(command='clear')
job.minute.on(3)
job.hour.on(4)
job.dom.on(5)
job.month.on(6)
job.dow.on(7)
self.assertEqual(job.render(), '3 4 5 6 0 clear')
job.clear()
self.assertEqual(job.render(), '* * * * * clear')
def test_07_range(self):
"""Render Time Ranges"""
job = self.crontab.new(command='range')
job.minute.during(4, 10)
self.assertEqual(job.render(), '4-10 * * * * range')
job.minute.during(15, 19)
self.assertEqual(job.render(), '15-19 * * * * range')
job.minute.clear()
self.assertEqual(job.render(), '* * * * * range')
job.minute.during(15, 19)
self.assertEqual(job.render(), '15-19 * * * * range')
job.minute.also.during(4, 10)
self.assertEqual(job.render(), '4-10,15-19 * * * * range')
def test_08_sequence(self):
"""Render Time Sequences"""
job = self.crontab.new(command='seq')
job.hour.every(4)
self.assertEqual(job.render(), '* */4 * * * seq')
job.hour.during(2, 10)
self.assertEqual(job.render(), '* 2-10 * * * seq')
job.hour.clear()
self.assertEqual(job.render(), '* * * * * seq')
job.hour.during(2, 10).every(4)
self.assertEqual(job.render(), '* 2-10/4 * * * seq')
job.hour.also.during(1, 4)
self.assertEqual(job.render(), '* 1-4,2-10/4 * * * seq')
job.hour.also.every(4)
self.assertEqual(job.render(), '* */4,1-4,2-10/4 * * * seq')
def test_10_comment(self):
"""Render cron Comments"""
job = self.crontab.new(command='com', comment='I love this')
self.assertEqual(unicode(job), '* * * * * com # I love this')
def test_11_disabled(self):
"""Disabled Job"""
jobs = list(self.crontab.find_command('firstcommand'))
self.assertTrue(jobs[0].enabled)
jobs = list(self.crontab.find_command('disabled'))
self.assertFalse(jobs[0].enabled)
def test_12_disable(self):
"""Disable and Enable Job"""
job = self.crontab.new(command='dis')
job.enable(False)
self.assertEqual(unicode(job), '# * * * * * dis')
job.enable()
self.assertEqual(unicode(job), '* * * * * dis')
def test_13_plural(self):
"""Plural API"""
job = self.crontab.new(command='plural')
job.minutes.every(4)
job.hours.on(5, 6)
job.day.on(4)
job.months.on(2)
self.assertEqual(unicode(job), '*/4 5,6 4 2 * plural')
def test_14_valid(self):
"""Valid and Invalid"""
job = self.crontab.new(command='valid')
job.minute.every(2)
job.valid = False
with self.assertRaises(ValueError):
unicode(job)
# Disabled jobs still work
job.enabled = False
unicode(job)
job.enabled = True
with self.assertRaises(ValueError):
self.crontab.render(errors=True)
self.crontab.render(errors=False)
self.assertFalse(job.enabled)
def test_15_slices(self):
"""Invalid Slices"""
mon = CronSlices('* * * * *')
with self.assertRaises(ValueError):
CronSlices('* * * */15 *')
with self.assertRaises(AssertionError):
mon.setall(mon)
def test_16_slice(self):
"""Single Slice"""
dow = CronSlice({'name': 'M', 'max': 7, 'min': 0, 'enum': ['a']}, '*/6')
self.assertEqual(repr(dow), '<CronSlice \'*/6\'>')
self.assertEqual(repr(dow.parse_value('a')), 'a')
with self.assertRaises(ValueError):
dow.parse_value('b')
self.assertEqual(dow.get_range()[0].render(), '*')
with self.assertRaises(ValueError):
dow.get_range('%')
def test_17_slice_id(self):
"""Single slice by Id"""
self.assertEqual(CronSlice(1).max, 23)
def test_18_range_cmp(self):
"""Compare ranges"""
dow = CronSlice({'max': 5, 'min': 0})
three = dow.get_range(2, 4)[0]
self.assertGreater(three, 2)
self.assertLess(three, 4)
self.assertEqual(str(three), '2-4')
def test_18_find(self):
"""Find a command and comments by name"""
cmds = list(self.crontab.find_command('byweek'))
self.assertEqual(len(cmds), 1)
self.assertEqual(cmds[0].comment, 'Comment One')
cmds = list(self.crontab.find_command(re.compile(r'stc\w')))
self.assertEqual(len(cmds), 1)
self.assertEqual(cmds[0].command, 'firstcommand')
cmds = list(self.crontab.find_command('Comment One'))
self.assertEqual(len(cmds), 0)
cmds = list(self.crontab.find_comment('Comment One'))
self.assertEqual(len(cmds), 1)
self.assertEqual(cmds[0].command, 'byweek')
cmds = list(self.crontab.find_comment(re.compile(r'om+en\w O')))
self.assertEqual(len(cmds), 1)
self.assertEqual(cmds[0].comment, 'Comment One')
cmds = list(self.crontab.find_comment(re.compile(r'stc\w')))
self.assertEqual(len(cmds), 0)
def test_20_write(self):
"""Write CronTab to file"""
self.crontab.write('output.tab')
self.assertTrue(os.path.exists('output.tab'))
os.unlink('output.tab')
def test_21_multiuse(self):
"""Multiple Renderings"""
cron = '# start of tab\n'
for i in range(10):
crontab = CronTab(tab=cron)
p = list(crontab.new(command='multi%d' % i))
cron = unicode(crontab)
crontab = CronTab(tab=cron)
list(crontab.find_command('multi%d' % i))[0].delete()
cron = unicode(crontab)
self.assertEqual(unicode(crontab), '# start of tab\n')
def test_22_min(self):
"""Minimum Field Values"""
job = self.crontab.new(command='min')
job.minute.on('<')
job.hour.on('<')
job.dom.on('<')
job.month.on('<')
self.assertEqual(unicode(job), '@yearly min')
def test_23_max(self):
"""Maximum Field Values"""
job = self.crontab.new(command='max')
job.minute.on('>')
job.hour.on('>')
job.dom.on('>')
job.month.on('>')
self.assertEqual(unicode(job), '59 23 31 12 * max')
def test_24_special_r(self):
"""Special formats are read and written"""
tab = CronTab(tabfile=os.path.join(TEST_DIR, 'data', 'specials_enc.tab'))
self.assertEqual(tab.render(), """@hourly hourly\n@daily daily\n@midnight midnight\n@weekly weekly\n@reboot reboot\n""")
self.assertEqual(len(list(tab)), 5)
def test_24_special_d(self):
"""Removal All Specials"""
tab = CronTab(tabfile=os.path.join(TEST_DIR, 'data', 'specials.tab'))
tab.remove_all()
self.assertEqual(len(list(tab)), 0)
def test_24_special_w(self):
"""Write Specials"""
tab = CronTab(tabfile=os.path.join(TEST_DIR, 'data', 'specials.tab'))
self.assertEqual(tab.render(), """@hourly hourly\n@daily daily\n@weekly weekly\n""")
self.assertEqual(len(list(tab)), 3)
def test_25_setall(self):
"""Set all values at once"""
job = self.crontab.new(command='all')
job.setall(1, '*/2', '2-4', '>', 'SUN')
self.assertEqual(unicode(job), '1 */2 2-4 12 SUN all')
job.setall('*/2')
self.assertEqual(unicode(job), '*/2 * * * * all')
job.setall('1 */2 2-4 12 SUN')
self.assertEqual(unicode(job), '1 */2 2-4 12 SUN all')
job.setall(['*'])
self.assertEqual(unicode(job), '* * * * * all')
def test_26_setall_obj(self):
"""Copy all values"""
job = self.crontab.new(command='all')
job2 = self.crontab.new(command='ignore')
job2.setall("1 */2 2-4 12 SUN")
job.setall(job2)
self.assertEqual(unicode(job), '1 */2 2-4 12 SUN all')
job2.setall("2 */3 4-8 10 MON")
job.setall(job2.slices)
self.assertEqual(unicode(job), '2 */3 4-8 10 MON all')
def test_27_commands(self):
"""Get all commands"""
self.assertEqual(list(self.crontab.commands),
[u'firstcommand', u'range', u'byweek', u'disabled',
u'spaced', u'python /example_app/testing.py',
u'rebooted',
u'echo % escaped',
u'cat %%'
])
def test_28_comments(self):
"""Get all comments"""
self.assertEqual(list(self.crontab.comments),
['Comment One', 'Comment Two', 'monitorCron',
're-id', 'percent_one', 'percent_two'])
def test_29_set_lines(self):
"""Set crontab lines directly"""
cron = CronTab(tab='')
cron.lines = [
str(self.crontab.lines[5]),
]
self.assertEqual(str(cron), '\n*/30 * * * * firstcommand\n')
with self.assertRaises(AttributeError):
cron.crons = ['A']
if __name__ == '__main__':
test_support.run_unittest(InteractionTestCase)
|
