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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
|
# Copyright (C) 2017 Lars Wirzenius
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
import shutil
import tempfile
import unittest
import ick2
class ControllerAPITests(unittest.TestCase):
def setUp(self):
self.tempdir = tempfile.mkdtemp()
self.statedir = os.path.join(self.tempdir, 'state/dir')
def tearDown(self):
shutil.rmtree(self.tempdir)
def create_api(self):
api = ick2.ControllerAPI()
api.set_state_directory(self.statedir)
return api
def test_has_no_state_directory_initially(self):
api = ick2.ControllerAPI()
statedir = api.get_state_directory()
self.assertTrue(statedir is None)
def test_sets_and_creates_state_directory(self):
api = self.create_api()
statedir = api.get_state_directory()
self.assertEqual(statedir, self.statedir)
self.assertTrue(os.path.exists(statedir))
class VersionAPITests(unittest.TestCase):
def create_api(self):
api = ick2.VersionAPI(None)
return api
def test_returns_version_correcly(self):
api = ick2.VersionAPI(None)
response = api.get_version()
self.assertEqual(
response,
{
'version': ick2.__version__,
}
)
class ProjectAPITests(unittest.TestCase):
def setUp(self):
self.tempdir = tempfile.mkdtemp()
self.statedir = os.path.join(self.tempdir, 'state/dir')
self.state = ick2.ControllerState()
self.state.set_state_directory(self.statedir)
def tearDown(self):
shutil.rmtree(self.tempdir)
def create_api(self):
return ick2.ProjectAPI(self.state)
def test_has_not_projects_initially(self):
api = self.create_api()
self.assertEqual(api.list(), {'projects': []})
def test_creates_project(self):
project = {
'project': 'foo',
'pipelines': [
{
'name': 'build',
'actions': [
{
'shell': 'step-1',
},
],
},
],
}
api = self.create_api()
self.assertEqual(api.create(project), project)
self.assertEqual(api.list(), {'projects': [project]})
self.assertEqual(api.get_pipeline('foo', 'build'), {'status': 'idle'})
self.assertEqual(
api.get_builds('foo'),
{'project': 'foo', 'builds': []}
)
def test_raises_error_when_getting_missing_pipeline(self):
project = {
'project': 'foo',
'pipelines': [
{
'name': 'build',
'actions': [
{
'shell': 'step-1',
},
],
},
],
}
api = self.create_api()
api.create(project)
with self.assertRaises(ick2.NotFound):
api.get_pipeline('foo', 'does-not-exist')
def test_loads_projects_from_state_directory(self):
project = {
'project': 'foo',
'shell_steps': ['build'],
}
api = self.create_api()
api.create(project)
api2 = self.create_api()
self.assertEqual(api2.list(), {'projects': [project]})
def test_gets_named_project(self):
project = {
'project': 'foo',
'shell_steps': ['build'],
}
api = self.create_api()
api.create(project)
self.assertEqual(api.show('foo'), project)
def test_updates_named_project(self):
project_v1 = {
'project': 'foo',
'shell_steps': ['build'],
}
project_v2 = dict(project_v1)
project_v2['shell_steps'] = ['build it using magic']
api = self.create_api()
api.create(project_v1)
updated = api.update(project_v2, 'foo')
self.assertEqual(updated, project_v2)
self.assertEqual(api.show('foo'), project_v2)
def test_deletes_named_project(self):
project = {
'project': 'foo',
'shell_steps': ['build'],
}
api = self.create_api()
api.create(project)
api.delete('foo')
self.assertEqual(api.list(), {'projects': []})
with self.assertRaises(ick2.NotFound):
api.show('foo')
def test_raises_error_deleting_missing_project(self):
api = self.create_api()
with self.assertRaises(ick2.NotFound):
api.delete('foo')
def test_updates_pipeline_status(self):
project = {
'project': 'foo',
'pipelines': [
{
'name': 'build',
'actions': [
{
'shell': 'step-1',
},
],
},
],
}
api = self.create_api()
api.create(project)
self.assertEqual(api.get_pipeline('foo', 'build'), {'status': 'idle'})
with self.assertRaises(ick2.WrongPipelineStatus):
api.set_pipeline('building', 'foo', 'build')
api.set_pipeline('triggered', 'foo', 'build')
self.assertEqual(
api.get_pipeline('foo', 'build'),
{'status': 'triggered'}
)
with self.assertRaises(ick2.WrongPipelineStatus):
api.set_pipeline('idle', 'foo', 'build')
api.set_pipeline('building', 'foo', 'build')
self.assertEqual(
api.get_pipeline('foo', 'build'),
{'status': 'building'}
)
with self.assertRaises(ick2.WrongPipelineStatus):
api.set_pipeline('triggered', 'foo', 'build')
api.set_pipeline('idle', 'foo', 'build')
self.assertEqual(
api.get_pipeline('foo', 'build'),
{'status': 'idle'}
)
def test_raises_error_updating_status_of_missing_pipeline(self):
project = {
'project': 'foo',
'pipelines': [],
}
api = self.create_api()
api.create(project)
with self.assertRaises(ick2.NotFound):
api.set_pipeline('idle', 'foo', 'build')
class WorkAPITests(unittest.TestCase):
def setUp(self):
self.tempdir = tempfile.mkdtemp()
self.statedir = os.path.join(self.tempdir, 'state/dir')
self.state = ick2.ControllerState()
self.state.set_state_directory(self.statedir)
def tearDown(self):
shutil.rmtree(self.tempdir)
def create_project_api(self):
project = {
'project': 'foo',
'pipelines': [
{
'name': 'build',
'actions': [
{
'shell': 'step-1',
},
{
'shell': 'step-2',
},
],
},
],
}
api = ick2.ProjectAPI(self.state)
api.create(project)
return api
def create_worker_api(self):
worker = {
'worker': 'asterix',
}
api = ick2.WorkerAPI(self.state)
api.create(worker)
return api
def create_work_api(self):
return ick2.WorkAPI(self.state)
def test_worker_gets_no_work_when_no_pipeline_is_triggered(self):
self.create_project_api()
self.create_worker_api()
work = self.create_work_api()
self.assertEqual(work.get_work('asterix'), {})
def test_worker_gets_work_when_a_pipeline_is_triggered(self):
projects = self.create_project_api()
projects.set_pipeline('triggered', 'foo', 'build')
self.create_worker_api()
work = self.create_work_api()
expected = {
'build_id': 1,
'worker': 'asterix',
'project': 'foo',
'pipeline': 'build',
'step': {
'shell': 'step-1',
},
'step_index': 0,
'log': '/logs/1',
}
self.assertEqual(work.get_work('asterix'), expected)
# Check we get the same thing twice.
self.assertEqual(work.get_work('asterix'), expected)
def test_worker_manager_posts_work_updates(self):
projects = self.create_project_api()
projects.set_pipeline('triggered', 'foo', 'build')
self.create_worker_api()
work = self.create_work_api()
# Ask for some work.
expected = {
'build_id': 1,
'worker': 'asterix',
'project': 'foo',
'pipeline': 'build',
'step': {
'shell': 'step-1',
},
'step_index': 0,
'log': '/logs/1',
}
self.assertEqual(work.get_work('asterix'), expected)
# Post a partial update.
done = {
'build_id': 1,
'worker': 'asterix',
'project': 'foo',
'pipeline': 'build',
'exit_code': None,
'stdout': 'out',
'stderr': 'err',
'timestamp': '2000-01-01T00:00:00',
}
work.update_work(done)
# Ask for work again. We didn't finish the previous step, so
# should get same thing.
self.assertEqual(work.get_work('asterix'), expected)
# Finish the step.
done['exit_code'] = 0
work.update_work(done)
# We should get the next step now.
expected['step'] = {'shell': 'step-2'}
expected['step_index'] = 1
self.assertEqual(work.get_work('asterix'), expected)
# Finish the step.
done['exit_code'] = 0
work.update_work(done)
# We now get nothing further to do.
self.assertEqual(work.get_work('asterix'), {})
# An pipeline status has changed.
self.assertEqual(
projects.get_pipeline('foo', 'build'),
{'status': 'idle'})
def test_worker_manager_posts_failure(self):
projects = self.create_project_api()
projects.set_pipeline('triggered', 'foo', 'build')
self.create_worker_api()
work = self.create_work_api()
# Ask for some work.
expected = {
'build_id': 1,
'worker': 'asterix',
'project': 'foo',
'pipeline': 'build',
'step': {
'shell': 'step-1',
},
'step_index': 0,
'log': '/logs/1',
}
self.assertEqual(work.get_work('asterix'), expected)
# Post a partial update.
done = {
'build_id': 1,
'worker': 'asterix',
'project': 'foo',
'pipeline': 'build',
'exit_code': 1,
'stdout': 'out',
'stderr': 'err',
'timestamp': '2000-01-01T00:00:00',
}
work.update_work(done)
# Ask for work again.
self.assertEqual(work.get_work('asterix'), {})
# An pipeline status has changed.
self.assertEqual(
projects.get_pipeline('foo', 'build'),
{'status': 'idle'})
|
