Skip to content

Commit c3fc57b

Browse files
uvulposuvulpos
committed
Merge branch 'feat/add-oauth-management-to-api-for-iac-tooling' of github.com:uvulpos/gitea into feat/add-oauth-management-to-api-for-iac-tooling
2 parents 62dc4c2 + 91247d6 commit c3fc57b

File tree

20 files changed

+1648
-29
lines changed

20 files changed

+1648
-29
lines changed

‎models/actions/runner.go‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import (
1414
"code.gitea.io/gitea/models/shared/types"
1515
user_model "code.gitea.io/gitea/models/user"
1616
"code.gitea.io/gitea/modules/optional"
17+
"code.gitea.io/gitea/modules/setting"
1718
"code.gitea.io/gitea/modules/timeutil"
1819
"code.gitea.io/gitea/modules/translation"
1920
"code.gitea.io/gitea/modules/util"
@@ -123,8 +124,15 @@ func (r *ActionRunner) IsOnline() bool {
123124
return false
124125
}
125126

126-
// Editable checks if the runner is editable by the user
127-
func (r *ActionRunner) Editable(ownerID, repoID int64) bool {
127+
// EditableInContext checks if the runner is editable by the "context" owner/repo
128+
// ownerID == 0 and repoID == 0 means "admin" context, any runner including global runners could be edited
129+
// ownerID == 0 and repoID != 0 means "repo" context, any runner belonging to the given repo could be edited
130+
// ownerID != 0 and repoID == 0 means "owner(org/user)" context, any runner belonging to the given user/org could be edited
131+
// ownerID != 0 and repoID != 0 means "owner" OR "repo" context, legacy behavior, but we should forbid using it
132+
func (r *ActionRunner) EditableInContext(ownerID, repoID int64) bool {
133+
if ownerID != 0 && repoID != 0 {
134+
setting.PanicInDevOrTesting("ownerID and repoID should not be both set")
135+
}
128136
if ownerID == 0 && repoID == 0 {
129137
return true
130138
}
@@ -168,6 +176,12 @@ func init() {
168176
db.RegisterModel(&ActionRunner{})
169177
}
170178

179+
// FindRunnerOptions
180+
// ownerID == 0 and repoID == 0 means any runner including global runners
181+
// repoID != 0 and WithAvailable == false means any runner for the given repo
182+
// repoID != 0 and WithAvailable == true means any runner for the given repo, parent user/org, and global runners
183+
// ownerID != 0 and repoID == 0 and WithAvailable == false means any runner for the given user/org
184+
// ownerID != 0 and repoID == 0 and WithAvailable == true means any runner for the given user/org and global runners
171185
type FindRunnerOptions struct {
172186
db.ListOptions
173187
IDs []int64

‎models/fixtures/action_runner.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
-
2+
id: 34346
3+
name: runner_to_be_deleted-user
4+
uuid: 3EF231BD-FBB7-4E4B-9602-E6F28363EF18
5+
token_hash: 3EF231BD-FBB7-4E4B-9602-E6F28363EF18
6+
version: "1.0.0"
7+
owner_id: 1
8+
repo_id: 0
9+
description: "This runner is going to be deleted"
10+
agent_labels: '["runner_to_be_deleted","linux"]'
11+
-
12+
id: 34347
13+
name: runner_to_be_deleted-org
14+
uuid: 3EF231BD-FBB7-4E4B-9602-E6F28363EF19
15+
token_hash: 3EF231BD-FBB7-4E4B-9602-E6F28363EF19
16+
version: "1.0.0"
17+
owner_id: 3
18+
repo_id: 0
19+
description: "This runner is going to be deleted"
20+
agent_labels: '["runner_to_be_deleted","linux"]'
21+
-
22+
id: 34348
23+
name: runner_to_be_deleted-repo1
24+
uuid: 3EF231BD-FBB7-4E4B-9602-E6F28363EF20
25+
token_hash: 3EF231BD-FBB7-4E4B-9602-E6F28363EF20
26+
version: "1.0.0"
27+
owner_id: 0
28+
repo_id: 1
29+
description: "This runner is going to be deleted"
30+
agent_labels: '["runner_to_be_deleted","linux"]'
31+
-
32+
id: 34349
33+
name: runner_to_be_deleted
34+
uuid: 3EF231BD-FBB7-4E4B-9602-E6F28363EF17
35+
token_hash: 3EF231BD-FBB7-4E4B-9602-E6F28363EF17
36+
version: "1.0.0"
37+
owner_id: 0
38+
repo_id: 0
39+
description: "This runner is going to be deleted"
40+
agent_labels: '["runner_to_be_deleted","linux"]'

‎models/packages/package_version.go‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -279,9 +279,7 @@ func (opts *PackageSearchOptions) configureOrderBy(e db.Engine) {
279279
default:
280280
e.Desc("package_version.created_unix")
281281
}
282-
283-
// Sort by id for stable order with duplicates in the other field
284-
e.Asc("package_version.id")
282+
e.Desc("package_version.id") // Sort by id for stable order with duplicates in the other field
285283
}
286284

287285
// SearchVersions gets all versions of packages matching the search options

‎modules/structs/repo_actions.go‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,3 +133,26 @@ type ActionWorkflowJob struct {
133133
// swagger:strfmt date-time
134134
CompletedAt time.Time `json:"completed_at,omitempty"`
135135
}
136+
137+
// ActionRunnerLabel represents a Runner Label
138+
type ActionRunnerLabel struct {
139+
ID int64 `json:"id"`
140+
Name string `json:"name"`
141+
Type string `json:"type"`
142+
}
143+
144+
// ActionRunner represents a Runner
145+
type ActionRunner struct {
146+
ID int64 `json:"id"`
147+
Name string `json:"name"`
148+
Status string `json:"status"`
149+
Busy bool `json:"busy"`
150+
Ephemeral bool `json:"ephemeral"`
151+
Labels []*ActionRunnerLabel `json:"labels"`
152+
}
153+
154+
// ActionRunnersResponse returns Runners
155+
type ActionRunnersResponse struct {
156+
Entries []*ActionRunner `json:"runners"`
157+
TotalCount int64 `json:"total_count"`
158+
}

‎routers/api/packages/swift/swift.go‎

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,24 @@ func DownloadManifest(ctx *context.Context) {
290290
})
291291
}
292292

293-
// https://github.com/swiftlang/swift-package-manager/blob/main/Documentation/PackageRegistry/Registry.md#endpoint-6
293+
// formFileOptionalReadCloser returns (nil, nil) if the formKey is not present.
294+
func formFileOptionalReadCloser(ctx *context.Context, formKey string) (io.ReadCloser, error) {
295+
multipartFile, _, err := ctx.Req.FormFile(formKey)
296+
if err != nil && !errors.Is(err, http.ErrMissingFile) {
297+
return nil, err
298+
}
299+
if multipartFile != nil {
300+
return multipartFile, nil
301+
}
302+
303+
content := ctx.Req.FormValue(formKey)
304+
if content == "" {
305+
return nil, nil
306+
}
307+
return io.NopCloser(strings.NewReader(content)), nil
308+
}
309+
310+
// UploadPackageFile refers to https://github.com/swiftlang/swift-package-manager/blob/main/Documentation/PackageRegistry/Registry.md#endpoint-6
294311
func UploadPackageFile(ctx *context.Context) {
295312
packageScope := ctx.PathParam("scope")
296313
packageName := ctx.PathParam("name")
@@ -304,9 +321,9 @@ func UploadPackageFile(ctx *context.Context) {
304321

305322
packageVersion := v.Core().String()
306323

307-
file, _, err := ctx.Req.FormFile("source-archive")
308-
if err != nil {
309-
apiError(ctx, http.StatusBadRequest, err)
324+
file, err := formFileOptionalReadCloser(ctx, "source-archive")
325+
if file == nil || err != nil {
326+
apiError(ctx, http.StatusBadRequest, "unable to read source-archive file")
310327
return
311328
}
312329
defer file.Close()
@@ -318,10 +335,13 @@ func UploadPackageFile(ctx *context.Context) {
318335
}
319336
defer buf.Close()
320337

321-
var mr io.Reader
322-
metadata := ctx.Req.FormValue("metadata")
323-
if metadata != "" {
324-
mr = strings.NewReader(metadata)
338+
mr, err := formFileOptionalReadCloser(ctx, "metadata")
339+
if err != nil {
340+
apiError(ctx, http.StatusBadRequest, "unable to read metadata file")
341+
return
342+
}
343+
if mr != nil {
344+
defer mr.Close()
325345
}
326346

327347
pck, err := swift_module.ParsePackage(buf, buf.Size(), mr)

‎routers/api/v1/admin/runners.go‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,81 @@ func GetRegistrationToken(ctx *context.APIContext) {
2424

2525
shared.GetRegistrationToken(ctx, 0, 0)
2626
}
27+
28+
// CreateRegistrationToken returns the token to register global runners
29+
func CreateRegistrationToken(ctx *context.APIContext) {
30+
// swagger:operation POST /admin/actions/runners/registration-token admin adminCreateRunnerRegistrationToken
31+
// ---
32+
// summary: Get an global actions runner registration token
33+
// produces:
34+
// - application/json
35+
// parameters:
36+
// responses:
37+
// "200":
38+
// "$ref": "#/responses/RegistrationToken"
39+
40+
shared.GetRegistrationToken(ctx, 0, 0)
41+
}
42+
43+
// ListRunners get all runners
44+
func ListRunners(ctx *context.APIContext) {
45+
// swagger:operation GET /admin/actions/runners admin getAdminRunners
46+
// ---
47+
// summary: Get all runners
48+
// produces:
49+
// - application/json
50+
// responses:
51+
// "200":
52+
// "$ref": "#/definitions/ActionRunnersResponse"
53+
// "400":
54+
// "$ref": "#/responses/error"
55+
// "404":
56+
// "$ref": "#/responses/notFound"
57+
shared.ListRunners(ctx, 0, 0)
58+
}
59+
60+
// GetRunner get an global runner
61+
func GetRunner(ctx *context.APIContext) {
62+
// swagger:operation GET /admin/actions/runners/{runner_id} admin getAdminRunner
63+
// ---
64+
// summary: Get an global runner
65+
// produces:
66+
// - application/json
67+
// parameters:
68+
// - name: runner_id
69+
// in: path
70+
// description: id of the runner
71+
// type: string
72+
// required: true
73+
// responses:
74+
// "200":
75+
// "$ref": "#/definitions/ActionRunner"
76+
// "400":
77+
// "$ref": "#/responses/error"
78+
// "404":
79+
// "$ref": "#/responses/notFound"
80+
shared.GetRunner(ctx, 0, 0, ctx.PathParamInt64("runner_id"))
81+
}
82+
83+
// DeleteRunner delete an global runner
84+
func DeleteRunner(ctx *context.APIContext) {
85+
// swagger:operation DELETE /admin/actions/runners/{runner_id} admin deleteAdminRunner
86+
// ---
87+
// summary: Delete an global runner
88+
// produces:
89+
// - application/json
90+
// parameters:
91+
// - name: runner_id
92+
// in: path
93+
// description: id of the runner
94+
// type: string
95+
// required: true
96+
// responses:
97+
// "204":
98+
// description: runner has been deleted
99+
// "400":
100+
// "$ref": "#/responses/error"
101+
// "404":
102+
// "$ref": "#/responses/notFound"
103+
shared.DeleteRunner(ctx, 0, 0, ctx.PathParamInt64("runner_id"))
104+
}

‎routers/api/v1/api.go‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -912,7 +912,11 @@ func Routes() *web.Router {
912912
})
913913

914914
m.Group("/runners", func() {
915+
m.Get("", reqToken(), reqChecker, act.ListRunners)
915916
m.Get("/registration-token", reqToken(), reqChecker, act.GetRegistrationToken)
917+
m.Post("/registration-token", reqToken(), reqChecker, act.CreateRegistrationToken)
918+
m.Get("/{runner_id}", reqToken(), reqChecker, act.GetRunner)
919+
m.Delete("/{runner_id}", reqToken(), reqChecker, act.DeleteRunner)
916920
})
917921
})
918922
}
@@ -1043,7 +1047,11 @@ func Routes() *web.Router {
10431047
})
10441048

10451049
m.Group("/runners", func() {
1050+
m.Get("", reqToken(), user.ListRunners)
10461051
m.Get("/registration-token", reqToken(), user.GetRegistrationToken)
1052+
m.Post("/registration-token", reqToken(), user.CreateRegistrationToken)
1053+
m.Get("/{runner_id}", reqToken(), user.GetRunner)
1054+
m.Delete("/{runner_id}", reqToken(), user.DeleteRunner)
10471055
})
10481056
})
10491057

@@ -1697,6 +1705,12 @@ func Routes() *web.Router {
16971705
Patch(bind(api.EditHookOption{}), admin.EditHook).
16981706
Delete(admin.DeleteHook)
16991707
})
1708+
m.Group("/actions/runners", func() {
1709+
m.Get("", admin.ListRunners)
1710+
m.Post("/registration-token", admin.CreateRegistrationToken)
1711+
m.Get("/{runner_id}", admin.GetRunner)
1712+
m.Delete("/{runner_id}", admin.DeleteRunner)
1713+
})
17001714
m.Group("/runners", func() {
17011715
m.Get("/registration-token", admin.GetRegistrationToken)
17021716
})

0 commit comments

Comments
 (0)