summaryrefslogtreecommitdiff
path: root/ick2/workapi_tests.py
blob: c368b4bd3db4c785fcd75121eb9e55cdb8946084 (plain)
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
# Copyright (C) 2017-2018  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 copy
import os
import shutil
import tempfile
import unittest


import ick2


class WorkAPITests(unittest.TestCase):

    def setUp(self):
        self.tempdir = tempfile.mkdtemp()
        self.statedir = os.path.join(self.tempdir, 'state/dir')
        self.state = ick2.FilePersistentState()
        self.state.set_directory(self.statedir)
        self.claims = None

    def tearDown(self):
        shutil.rmtree(self.tempdir)

    def create_project_api(self):
        pipeline = {
            'pipeline': 'build',
            'actions': [
                {'shell': 'step-1', 'where': 'host'},
                {'shell': 'step-2', 'where': 'host'},
            ],
        }

        pipeapi = ick2.PipelineAPI(self.state)
        pipeapi.create(pipeline)

        project = {
            'project': 'foo',
            'parameters': {
                'foo': 'bar',
            },
            'pipelines': ['build'],
        }
        api = ick2.ProjectAPI(self.state)
        api.create(project)
        return api

    def create_worker_api(self):
        worker = {
            'doing': {},
        }
        self.claims = {
            'aud': 'asterix',
        }
        api = ick2.WorkerAPI(self.state)
        api.create(worker, claims=self.claims)
        return api

    def create_work_api(self):
        return ick2.WorkAPI(self.state)

    def test_worker_gets_no_work_when_no_builds_have_been_triggered(self):
        self.create_project_api()
        self.create_worker_api()
        work = self.create_work_api()
        self.assertEqual(work.get_work(claims=self.claims), {})

    def test_worker_gets_work_when_a_build_has_been_triggered(self):
        projects = self.create_project_api()
        projects.trigger_project('foo')
        self.create_worker_api()
        work = self.create_work_api()
        expected = {
            'build_id': 'foo/1',
            'build_number': 1,
            'worker': 'asterix',
            'project': 'foo',
            'parameters': {
                'foo': 'bar',
            },
            'action_id': '1',
            'step': {
                'action': 'create_workspace',
                'where': 'host',
            },
            'log': '/logs/foo/1',
        }
        self.assertEqual(work.get_work(claims=self.claims), expected)

        # Check we get the same thing twice.
        self.assertEqual(work.get_work(claims=self.claims), expected)

    def test_worker_manager_posts_work_updates(self):
        # Define the actions we expect to get from the controller.
        # They're mostly identical so we copy and change what needs to
        # be changed.

        action_1 = {
            'build_id': 'foo/1',
            'build_number': 1,
            'worker': 'asterix',
            'project': 'foo',
            'parameters': {
                'foo': 'bar',
            },
            'action_id': '1',
            'step': {
                'action': 'create_workspace',
                'where': 'host',
            },
            'log': '/logs/foo/1',
        }

        action_2 = copy.deepcopy(action_1)
        action_2.update({
            'action_id': '2',
            'step': {
                'shell': 'step-1',
                'where': 'host',
            },
        })

        action_3 = copy.deepcopy(action_1)
        action_3.update({
            'action_id': '3',
            'step': {
                'shell': 'step-2',
                'where': 'host',
            },
        })

        action_4 = copy.deepcopy(action_1)
        action_4.update({
            'action_id': '4',
            'step': {
                'action': 'notify',
            },
        })

        # Define the work updates we will be sending to indicate
        # progress on executing the actions above. Again, they're
        # mostly identical.

        done_1_partial = {
            'build_id': 'foo/1',
            'action_id': '1',
            'worker': 'asterix',
            'project': 'foo',
            'exit_code': None,
            'stdout': 'out',
            'stderr': 'err',
            'timestamp': '2000-01-01T00:00:00',
        }
        done_1 = copy.deepcopy(done_1_partial)
        done_1.update({
            'exit_code': 0,
        })
        done_2 = copy.deepcopy(done_1)
        done_2.update({
            'action_id': '2',
        })
        done_3 = copy.deepcopy(done_1)
        done_3.update({
            'action_id': '3',
        })
        done_4 = copy.deepcopy(done_1)
        done_4.update({
            'action_id': '4',
        })

        # Set up the various API objects.
        projects = self.create_project_api()
        self.create_worker_api()
        work = self.create_work_api()

        # No builds have been triggered, nothing to do.
        self.assertEqual(work.get_work(claims=self.claims), {})

        # Trigger a build.
        projects.trigger_project('foo')

        # Get the first action.
        self.assertEqual(work.get_work(claims=self.claims), action_1)

        # Post a partial update.
        work.update_work(done_1_partial)

        # Ask for work again. We didn't finish the previous step, so
        # should get same thing.
        self.assertEqual(work.get_work(claims=self.claims), action_1)

        # Finish the step.
        work.update_work(done_1)

        # We should get the next step now.
        self.assertEqual(work.get_work(claims=self.claims), action_2)

        # Finish the step.
        work.update_work(done_2)

        # We should get the final actual step now.
        self.assertEqual(work.get_work(claims=self.claims), action_3)

        # Finish the step.
        work.update_work(done_3)

        # We should get the notification step now.
        self.assertEqual(work.get_work(claims=self.claims), action_4)

        # Finish the step.
        work.update_work(done_4)

        # We now get nothing further to do.
        self.assertEqual(work.get_work(claims=self.claims), {})

    def test_worker_manager_posts_failure(self):
        projects = self.create_project_api()
        projects.trigger_project('foo')
        self.create_worker_api()
        work = self.create_work_api()

        # Ask for some work.
        expected = {
            'build_id': 'foo/1',
            'build_number': 1,
            'worker': 'asterix',
            'project': 'foo',
            'parameters': {
                'foo': 'bar',
            },
            'action_id': '1',
            'step': {
                'action': 'create_workspace',
                'where': 'host',
            },
            'log': '/logs/foo/1',
        }
        self.assertEqual(work.get_work(claims=self.claims), expected)

        # Post an update.
        done = {
            'build_id': 'foo/1',
            'action_id': '1',
            'worker': 'asterix',
            'project': 'foo',
            'exit_code': 1,
            'stdout': 'out',
            'stderr': 'err',
            'timestamp': '2000-01-01T00:00:00',
        }
        work.update_work(done)

        # Ask for some work.
        expected = {
            'build_id': 'foo/1',
            'build_number': 1,
            'worker': 'asterix',
            'project': 'foo',
            'parameters': {
                'foo': 'bar',
            },
            'action_id': '4',
            'step': {
                'action': 'notify',
            },
            'log': '/logs/foo/1',
        }
        self.assertEqual(work.get_work(claims=self.claims), expected)

        # Post an update.
        done = {
            'build_id': 'foo/1',
            'action_id': '4',
            'worker': 'asterix',
            'project': 'foo',
            'exit_code': 0,
            'stdout': 'out',
            'stderr': 'err',
            'timestamp': '2000-01-01T00:00:00',
        }
        work.update_work(done)

        # Ask for work again.
        self.assertEqual(work.get_work(claims=self.claims), {})