summaryrefslogtreecommitdiff
path: root/yarns/400-build.yarn
blob: 30e47c64cafbc97b936bebb7d39db1ffd572b7dc (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
<!--

Copyright 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/>.

-->

# Build a project

This scenario tests the controller API to simulate a build.

    SCENARIO build a project

Set up the controller.

    GIVEN an RSA key pair for token signing
    AND controller config uses statedir at the state directory
    AND an access token for user with scopes
    ... uapi_projects_post
    ... uapi_projects_id_pipeline_id_put
    ... uapi_projects_id_pipeline_id_get
    ... uapi_projects_id_builds_get
    ... uapi_workers_id_get
    AND a running ick controller

Add up a project.

    WHEN user makes request POST /projects
    ... {
    ...     "project": "rome",
    ...     "pipelines": [
    ...         {
    ...             "name": "construct",
    ...             "actions": [
    ...                 { "shell": "day 1" },
    ...                 { "shell": "day 2" }
    ...             ]
    ...         }
    ...     ]
    ... }
    THEN result has status code 201

There are no builds for the project yet, and is idle.

    WHEN user makes request GET /projects/rome/pipelines/construct
    THEN result has status code 200
    AND body matches { "status": "idle" }

    WHEN user makes request GET /projects/rome/builds
    THEN result has status code 200
    AND body matches { "project": "rome", "builds": []}

Register a worker.

    GIVEN an access token for worker-manager with scopes
    ... uapi_workers_post
    ... uapi_work_post
    WHEN worker-manager makes request POST /workers
    ... {
    ...     "worker": "obelix"
    ... }
    THEN result has status code 201

Trigger build. First with an invalid status, then a real one.

    WHEN user makes request PUT /projects/rome/pipelines/construct
    ... { "status": "VANDALS!" }
    THEN result has status code 400

    WHEN user makes request PUT /projects/rome/pipelines/construct
    ... { "status": "triggered" }
    THEN result has status code 200

Worker wants work and gets the first step to run. If the worker asks
again, it gets the same answer. **FIXME: should the name of the worker
be in the path or can we get it in the access token?**

    WHEN worker-manager makes request GET /work/obelix
    THEN result has status code 200
    AND body matches
    ... {
    ...     "worker": "obelix",
    ...     "project": "rome",
    ...     "pipeline": "construct",
    ...     "step": {
    ...         "shell": "day 1"
    ...     },
    ...     "step_index": 0
    ... }

    WHEN worker-manager makes request GET /work/obelix
    THEN result has status code 200
    AND body matches
    ... {
    ...     "worker": "obelix",
    ...     "project": "rome",
    ...     "pipeline": "construct",
    ...     "step": {
    ...         "shell": "day 1"
    ...     },
    ...     "step_index": 0
    ... }

User can now see pipeline is running and which worker is building it.

    WHEN user makes request GET /projects/rome/pipelines/construct
    THEN result has status code 200
    AND body matches 
    ... {
    ...     "status": "building"
    ... }

    WHEN user makes request GET /workers/obelix
    THEN result has status code 200
    AND body matches 
    ... {
    ...     "worker": "obelix",
    ...     "doing": {
    ...         "worker": "obelix",
    ...         "project": "rome",
    ...         "pipeline": "construct",
    ...         "step_index": 0,
    ...         "step": {
    ...             "shell": "day 1"
    ...         }
    ...     }
    ... }


Worker reports some build output. Note the null exit code.

    WHEN worker-manager makes request POST /work
    ... {
    ...     "worker": "obelix",
    ...     "project": "rome",
    ...     "pipeline": "construct",
    ...     "exít_code": null,
    ...     "stdout": "hey ho hey ho",
    ...     "stderr": "",
    ...     "timestamp": "2017-10-27T17:08:49"
    ... }
    THEN result has status code 201
    AND body matches { "result": "waiting for more" }

Still the same job, since the first build step didnt't finish.

    WHEN worker-manager makes request GET /work/obelix
    THEN result has status code 200
    AND body matches
    ... {
    ...     "project": "rome",
    ...     "pipeline": "construct",
    ...     "step": {
    ...         "shell": "day 1"
    ...     }
    ... }

Report the step is done, and successfully.

    WHEN worker-manager makes request POST /work
    ... {
    ...     "worker": "obelix",
    ...     "project": "rome",
    ...     "pipeline": "construct",
    ...     "exít_code": 0,
    ...     "stdout": "hey ho, hey ho\n",
    ...     "stderr": "",
    ...     "timestamp": "2017-10-27T17:08:49"
    ... }
    THEN result has status code 200
    AND body matches { "result": "next step awaits you" }

Now there's another step to do.

    WHEN worker-manager makes request GET /work/obelix
    THEN result has status code 200
    AND body matches
    ... {
    ...     "project": "rome",
    ...     "pipeline": "construct",
    ...     "step": {
    ...         "shell": "day 2"
    ...     }
    ... }

User sees changed status.

    WHEN user makes request GET /projects/rome/pipelines/construct
    THEN result has status code 200
    AND body matches 
    ... {
    ...     "status": "running",
    ...     "worker": "obelix",
    ...     "step_number": 2,
    ...     "step": {
    ...         "shell": "day 2"
    ...     }
    ... }

Report it done.

    WHEN worker-manager makes request POST /work
    ... {
    ...     "worker": "obelix",
    ...     "project": "rome",
    ...     "pipeline": "construct",
    ...     "exít_code": 0,
    ...     "stdout": "to the gold mine we go!\n",
    ...     "stderr": "",
    ...     "timestamp": "2017-10-27T17:08:49"
    ... }
    THEN result has status code 200
    AND body matches { "result": "no more steps" }

Now there's no more work to do.

    WHEN worker-manager makes request GET /work/obelix
    THEN result has status code 200
    AND body matches {}

The pipeline status indicates success.

    WHEN user makes request GET /projects/rome/pipelines/construct
    THEN result has status code 200
    AND body matches { "status": "idle" }

Also, there's a build with a log.

    WHEN user makes request GET /projects/rome/builds
    THEN result has status code 200
    AND body matches
    ... {
    ...     "project": "rome",
    ...     "builds": [
    ...         {
    ...             "pipeline": "construct",
    ...             "build_number": 1,
    ...             "status": "success",
    ...             "log": "/projects/rome/logs/1"
    ...         }
    ...     ]
    ... }

    WHEN user makes request GET /projects/rome/logs/1
    THEN result has status code 200
    AND result has header Content-Type: text/plain
    AND body matches "hey ho, hey ho\nto the gold mine we go!\n"

    FINALLY stop ick controller