summaryrefslogtreecommitdiff
path: root/yarns/100-projects.yarn
blob: 2fddded9c7376211784db80647ad882ad9c4c2ee (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
<!--

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

-->

# Controller project management

The Ick2 controller manages information about projects. Projects are
things the controller builds. A project is described by a resource
like this:

    EXAMPLE project resource
    {
        "project": "ick2-website",
        "pipelines": [
            "setup-workspace",
            "build-website",
            "publish-website"
        ]
    }

In other words, there are several things that define a project:

* The `name`. This is used for referreing to the project in the API.
* A list of pipelines. Each pipeline has a name, and sequence of
  actions that need to be taken. At the moment, each action is a shell
  command to be run.

## Managing projects

First we test the controller API for managing projects, without
building them. We start by starting an instance of the controller.

    SCENARIO managing projects
    GIVEN an RSA key pair for token signing
    AND an access token for user with scopes
    ... uapi_pipelines_post
    ... uapi_projects_get
    ... uapi_projects_post
    ... uapi_projects_id_get
    ... uapi_projects_id_put
    ... uapi_projects_id_delete
    AND controller config uses statedir at the state directory
    AND controller config uses https://blobs.example.com as artifact store
    AND controller config uses https://auth.example.com as authentication
    AND controller config uses https://notify.example.com as notify
    AND a running ick controller

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

    WHEN user makes request POST /pipelines with a valid token and body
    ... {
    ...     "pipeline": "build",
    ...     "actions": [
    ...         { "shell": "git clone git://repo src" },
    ...         { "shell": "mkdir html" },
    ...         { "shell": "ikiwiki src html" }
    ...     ]
    ... }
    WHEN user makes request POST /projects with a valid token and body
    ... {
    ...     "project": "website",
    ...     "pipelines": ["build"]
    ... }
    THEN result has status code 201
    AND body matches
    ... {
    ...     "project": "website",
    ...     "pipelines": ["build"],
    ...     "next_build_id": null
    ... }
    AND controller state directory contains project website

Creating a new project with the same name is forbidden.

    WHEN user makes request POST /projects with a valid token and body
    ... {
    ...     "project": "website",
    ...     "pipelines": []
    ... }
    THEN result has status code 409

    WHEN user makes request GET /projects
    THEN result has status code 200
    AND body matches
    ... {
    ...     "projects": [
    ...         {
    ...             "project": "website",
    ...             "pipelines": ["build"],
    ...             "next_build_id": null
    ...         }
    ...     ]
    ... }

    WHEN user stops ick controller
    GIVEN a running ick controller
    WHEN user makes request GET /projects/website
    THEN result has status code 200
    AND body matches
    ... {
    ...     "project": "website",
    ...     "pipelines": ["build"],
    ...     "next_build_id": null
    ... }

    WHEN user makes request PUT /projects/website with a valid token
    ... and body
    ... {
    ...     "project": "website",
    ...     "parameters": {"foo": "bar"},
    ...     "pipelines": ["build"]
    ... }
    THEN result has status code 200
    AND body matches
    ... {
    ...     "project": "website",
    ...     "parameters": {"foo": "bar"},
    ...     "pipelines": ["build"],
    ...     "next_build_id": null
    ... }
    AND controller state directory contains project website

    WHEN user makes request GET /projects/website
    THEN result has status code 200
    AND body matches
    ... {
    ...     "project": "website",
    ...     "parameters": {"foo": "bar"},
    ...     "pipelines": ["build"],
    ...     "next_build_id": null
    ... }

    WHEN user makes request DELETE /projects/website
    THEN result has status code 200
    WHEN user makes request GET /projects/website
    THEN result has status code 404

    WHEN user makes request PUT /projects/nosuchproject with a valid token and body
    ... {
    ...     "project": "nosuchproject",
    ...     "pipelines": []
    ... }
    THEN result has status code 404

    FINALLY stop ick controller