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
|
#!/usr/bin/env python
#
# Copyright (C) 2017 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 the creation, reading and writing on environment variables.
"""
import os
import sys
sys.path.insert(0, '../')
from .test_usage import TEST_DIR
import unittest
from collections import OrderedDict
from crontab import CronTab
try:
from test import test_support
except ImportError:
from test import support as test_support
INITIAL_TAB = """PERSONAL_VAR=bar
CRON_VAR=fork
34 12 * * * eat_soup
CRON_VAR=spoon
35 12 * * * eat_salad
CRON_VAR=knife
36 12 * * * eat_icecream
SECONDARY=fork
38 12 * * * eat_steak
"""
class EnvTestCase(unittest.TestCase):
"""Test vixie cron user addition."""
def setUp(self):
self.crontab = CronTab(tab=INITIAL_TAB)
def test_01_consistancy(self):
"""Read in crontab and write out the same"""
self.assertEqual(INITIAL_TAB, str(self.crontab))
def test_02_top_vars(self):
"""Whole file env variables"""
crontab = CronTab(tab="SHELL=dash\n")
self.assertEqual(str(crontab), "SHELL=dash\n")
self.assertEqual(crontab.env['SHELL'], 'dash')
crontab.env['SHELL'] = 'bash'
self.assertEqual(str(crontab), "SHELL=bash\n")
self.assertEqual(crontab.env['SHELL'], 'bash')
def test_03_get_job_var(self):
"""Test each of the job env structures"""
for job, expected in zip(self.crontab, [
{'PERSONAL_VAR': 'bar', 'CRON_VAR': 'fork'},
{'PERSONAL_VAR': 'bar', 'CRON_VAR': 'spoon'},
{'PERSONAL_VAR': 'bar', 'CRON_VAR': 'knife'},
{'PERSONAL_VAR': 'bar', 'CRON_VAR': 'knife', 'SECONDARY': 'fork'},
]):
self.assertEqual(OrderedDict(job.env.all()), expected)
def test_04_set_job_var(self):
"""Test that variables set are applied correctly"""
self.crontab[1].env['CRON_VAR'] = 'javlin'
self.assertEqual(self.crontab[1].env.all(),
{'PERSONAL_VAR': 'bar', 'CRON_VAR': 'javlin'})
self.crontab[2].env['CRON_VAR'] = 'javlin'
self.assertEqual(self.crontab[2].env.all(),
{'PERSONAL_VAR': 'bar', 'CRON_VAR': 'javlin'})
self.assertEqual(self.crontab[3].env['PERSONAL_VAR'], 'bar')
self.assertEqual(self.crontab[3].env.all(),
{'PERSONAL_VAR': 'bar', 'CRON_VAR': 'javlin', 'SECONDARY': 'fork'})
self.crontab.env['PERSONAL_VAR'] = 'foo'
self.assertEqual(self.crontab[2].env.all(),
{'PERSONAL_VAR': 'foo', 'CRON_VAR': 'javlin'})
self.crontab.env['CRON_VAR'] = 'fork'
self.assertEqual(self.crontab[0].env.all(),
{'PERSONAL_VAR': 'foo', 'CRON_VAR': 'fork'})
self.assertEqual(str(self.crontab), """PERSONAL_VAR=foo
CRON_VAR=fork
34 12 * * * eat_soup
CRON_VAR=javlin
35 12 * * * eat_salad
36 12 * * * eat_icecream
SECONDARY=fork
38 12 * * * eat_steak
""")
def test_05_no_env(self):
"""Test that we get an error asking for no var"""
with self.assertRaises(KeyError):
self.crontab.env['BLUE_BOTTLE']
with self.assertRaises(KeyError):
self.crontab[0].env['RED_BOTTLE']
def test_06_env_access(self):
cron = CronTab(tab="""
MYNAME='Random'
* * * * * echo "first: $MYNAME"
* * * * * echo "second: $MYNAME"
* * * * * echo "third: $MYNAME"
""")
for job in cron:
self.assertEqual(job.env['MYNAME'], "Random")
def test_07_mutated_dict(self):
"""Test when the ordered dict is changed during loop"""
cron = CronTab(tab="""
ALL='all'
ABCD='first'
* * * * * echo "first"
""")
def test_08_space_quotes(self):
"""Test that spaces and quotes are handled correctly"""
cron = CronTab(tab="""
A= 123
B=" 123 "
C=' 123 '
D= " 123 "
E= 1 2 3
""")
self.assertEqual(cron.env['A'], '123')
self.assertEqual(cron.env['B'], ' 123 ')
self.assertEqual(cron.env['C'], ' 123 ')
self.assertEqual(cron.env['D'], ' 123 ')
self.assertEqual(cron.env['E'], '1 2 3')
self.assertEqual(str(cron), """A=123
B=" 123 "
C=" 123 "
D=" 123 "
E="1 2 3"
""")
def test_09_delete_middle(self):
"""Test that a delete doesn't remove vars"""
self.crontab.remove_all(command='eat_icecream')
self.crontab.remove_all(command='eat_soup')
self.assertEqual(str(self.crontab), """PERSONAL_VAR=bar
CRON_VAR=spoon
35 12 * * * eat_salad
CRON_VAR=knife
SECONDARY=fork
38 12 * * * eat_steak
""")
def test_10_empty_env(self):
"""Test when an env is an empty string it should have quotes"""
tab='MAILTO=""\n'
self.assertEqual(str(CronTab(tab=tab)), tab)
def test_11_empty_flow(self):
"""Test what happends when an env is involved in flow"""
tab = """
# A
# B
MAILTO=""
# C
*/10 * * * * /home/pi/job.py # any job
"""
cron = CronTab(tab=tab)
job = cron.new('update.py', 'update')
job.setall('1 12 * * 3')
self.assertTrue(job.is_valid())
self.assertEqual(str(cron), """MAILTO=""
# A
# B
# C
*/10 * * * * /home/pi/job.py # any job
1 12 * * 3 update.py # update
""")
cron.remove_all(comment='update')
cron.write_to_user("bob")
filename = os.path.join(TEST_DIR, 'data', 'spool', 'bob')
with open(filename, 'r') as fhl:
self.assertEqual(fhl.read(), """MAILTO=""
# A
# B
# C
*/10 * * * * /home/pi/job.py # any job
""")
os.unlink(filename)
if __name__ == '__main__':
test_support.run_unittest(EnvTestCase)
|
