peezy-tech/jojo
2
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2026-05-12 22:10:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: add visible flag to HTTP API endpoints that return runners (#11670)

Browse source 
Add a `visible=true|false` flag to the HTTP API endpoints that return runners (`/user/actions/runners` and friends). Previously, all endpoints (except the one for admins) only returned the runners owned by the respective repository, user, or organization. The endpoint for admins returned all runners.

With this change, all endpoints only return the runners directly owned by the repository, user, organization, or instance by default (`visible=false`). With `visible=true`, the API returns the same runners as the UI. That means, for example, that `/repos/{owner}/{repo}/actions/runners?visible=true` returns all runners owned by the repository, its owner, and the instance.

Additionally, the behaviour of the endpoint for getting a single runner was altered. With this change, it permits accessing all _visible_ runners, thereby matching the UI. Previously, only runners directly owned by the repository, user, or organization could be obtained, whereas the admin could obtain all. Furthermore, existence probing is no longer possible.

## Checklist

The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org).

### Tests for Go changes

(can be removed for JavaScript changes)

- I added test coverage for Go changes...
  - [ ] in their respective `*_test.go` for unit tests.
  - [x] in the `tests/integration` directory if it involves interactions with a live Forgejo server.
- I ran...
  - [x] `make pr-go` before pushing

### Tests for JavaScript changes

(can be removed for Go changes)

- I added test coverage for JavaScript changes...
  - [ ] in `web_src/js/*.test.js` if it can be unit tested.
  - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)).

### Documentation

- [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change.
- [x] I did not document these changes and I do not expect someone else to do it.

### Release notes

- [x] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change.
- [ ] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change.

*The decision if the pull request will be shown in the release notes is up to the mergers / release team.*

The content of the `release-notes/<pull request number>.md` file will serve as the basis for the release notes. If the file does not exist, the title of the pull request will be used instead.

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/11670
Reviewed-by: Mathieu Fenniak <mfenniak@noreply.codeberg.org>
Co-authored-by: Andreas Ahlenstorf <andreas@ahlenstorf.ch>
Co-committed-by: Andreas Ahlenstorf <andreas@ahlenstorf.ch>
This commit is contained in:
Andreas Ahlenstorf 2026-03-14 04:22:01 +01:00 • committed by Mathieu Fenniak
parent e9969afa6b
commit ce73827b7e
10 changed files with 382 additions and 262 deletions
Download patch file Download diff file Expand all files Collapse all files

151
tests/integration/api_admin_actions_test.go
View file

@ -183,6 +183,63 @@ func TestAPIAdminActionsRunnerOperations(t *testing.T) {
readToken := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadAdmin)
writeToken := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteAdmin)
runnerOne := &api.ActionRunner{
ID: 130791,
UUID: "8b0f6b98-fef8-430e-bfdc-dcbeeb58f3c8",
Name: "runner-1-global",
Version: "dev",
OwnerID: 0,
RepoID: 0,
Description: "A superb runner",
Labels: []string{"debian", "gpu"},
Status: "offline",
}
runnerTwo := &api.ActionRunner{
ID: 130792,
UUID: "61c48447-6e7d-42da-9dbe-d659ade77a56",
Name: "runner-2-user",
Version: "11.3.1",
OwnerID: 1,
RepoID: 0,
Description: "A splendid runner",
Labels: []string{"docker"},
Status: "offline",
}
runnerThree := &api.ActionRunner{
ID: 130793,
UUID: "9b92be13-b002-4fc0-b182-5e7cdbef0b8d",
Name: "runner-3-global",
Version: "11.3.1",
OwnerID: 0,
RepoID: 0,
Description: "Another fine runner",
Labels: []string{"fedora"},
Status: "offline",
}
runnerFour := &api.ActionRunner{
ID: 130794,
UUID: "44d595e9-b47d-42ef-b1b9-5869f8b8d501",
Name: "runner-4-repository",
Version: "12.2.0",
OwnerID: 0,
RepoID: 62,
Description: "",
Labels: []string{"nixos"},
Status: "offline",
}
runnerFive := &api.ActionRunner{
ID: 130795,
UUID: "16ca1a5c-8024-41f1-be31-e55830263cc6",
Name: "runner-5-ephemeral",
Version: "1.0.0",
OwnerID: 0,
RepoID: 0,
Description: "An ephemeral runner",
Labels: []string{"ephemeral-label"},
Status: "offline",
Ephemeral: true,
}
t.Run("Get runners", func(t *testing.T) {
request := NewRequest(t, "GET", "/api/v1/admin/actions/runners")
request.AddTokenAuth(readToken)
@ -193,57 +250,12 @@ func TestAPIAdminActionsRunnerOperations(t *testing.T) {
var runners []*api.ActionRunner
DecodeJSON(t, response, &runners)
runnerOne := &api.ActionRunner{
ID: 130791,
UUID: "8b0f6b98-fef8-430e-bfdc-dcbeeb58f3c8",
Name: "runner-1-global",
Version: "dev",
OwnerID: 0,
RepoID: 0,
Description: "A superb runner",
Labels: []string{"debian", "gpu"},
Status: "offline",
}
runnerTwo := &api.ActionRunner{
ID: 130792,
UUID: "61c48447-6e7d-42da-9dbe-d659ade77a56",
Name: "runner-2-user",
Version: "11.3.1",
OwnerID: 1,
RepoID: 0,
Description: "A splendid runner",
Labels: []string{"docker"},
Status: "offline",
}
runnerThree := &api.ActionRunner{
ID: 130793,
UUID: "9b92be13-b002-4fc0-b182-5e7cdbef0b8d",
Name: "runner-3-global",
Version: "11.3.1",
OwnerID: 0,
RepoID: 0,
Description: "Another fine runner",
Labels: []string{"fedora"},
Status: "offline",
}
runnerFive := &api.ActionRunner{
ID: 130795,
UUID: "16ca1a5c-8024-41f1-be31-e55830263cc6",
Name: "runner-5-ephemeral",
Version: "1.0.0",
OwnerID: 0,
RepoID: 0,
Description: "An ephemeral runner",
Labels: []string{"ephemeral-label"},
Status: "offline",
Ephemeral: true,
}
// There are more runners in the result that originate from the global fixtures. The test ignores them to limit
// the impact of unrelated changes.
assert.Contains(t, runners, runnerOne)
assert.Contains(t, runners, runnerTwo)
assert.NotContains(t, runners, runnerTwo)
assert.Contains(t, runners, runnerThree)
assert.NotContains(t, runners, runnerFour)
assert.Contains(t, runners, runnerFive)
})
@ -260,6 +272,25 @@ func TestAPIAdminActionsRunnerOperations(t *testing.T) {
assert.Len(t, runners, 5)
})
t.Run("Get visible runners", func(t *testing.T) {
request := NewRequest(t, "GET", "/api/v1/admin/actions/runners?visible=true")
request.AddTokenAuth(readToken)
response := MakeRequest(t, request, http.StatusOK)
assert.NotEmpty(t, response.Header().Get("X-Total-Count"))
var runners []*api.ActionRunner
DecodeJSON(t, response, &runners)
// There are more runners in the result that originate from the global fixtures. The test ignores them to limit
// the impact of unrelated changes.
assert.Contains(t, runners, runnerOne)
assert.Contains(t, runners, runnerTwo)
assert.Contains(t, runners, runnerThree)
assert.Contains(t, runners, runnerFour)
assert.Contains(t, runners, runnerFive)
})
t.Run("Get global runner", func(t *testing.T) {
request := NewRequest(t, "GET", "/api/v1/admin/actions/runners/130793")
request.AddTokenAuth(readToken)
@ -268,19 +299,7 @@ func TestAPIAdminActionsRunnerOperations(t *testing.T) {
var runner *api.ActionRunner
DecodeJSON(t, response, &runner)
runnerOne := &api.ActionRunner{
ID: 130793,
UUID: "9b92be13-b002-4fc0-b182-5e7cdbef0b8d",
Name: "runner-3-global",
Version: "11.3.1",
OwnerID: 0,
RepoID: 0,
Description: "Another fine runner",
Labels: []string{"fedora"},
Status: "offline",
}
assert.Equal(t, runnerOne, runner)
assert.Equal(t, runnerThree, runner)
})
t.Run("Get repository-scoped runner", func(t *testing.T) {
@ -291,18 +310,6 @@ func TestAPIAdminActionsRunnerOperations(t *testing.T) {
var runner *api.ActionRunner
DecodeJSON(t, response, &runner)
runnerFour := &api.ActionRunner{
ID: 130794,
UUID: "44d595e9-b47d-42ef-b1b9-5869f8b8d501",
Name: "runner-4-repository",
Version: "12.2.0",
OwnerID: 0,
RepoID: 62,
Description: "",
Labels: []string{"nixos"},
Status: "offline",
}
assert.Equal(t, runnerFour, runner)
})

152
tests/integration/api_org_actions_test.go
View file

@ -112,6 +112,63 @@ func TestAPIOrgActionsRunnerOperations(t *testing.T) {
readToken := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadOrganization)
writeToken := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteOrganization)
runnerOne := &api.ActionRunner{
ID: 655691,
UUID: "a3297f3a-ba5c-4a0f-878e-6cc8b8ac79ec",
Name: "runner-1-organization",
Version: "dev",
OwnerID: 3,
RepoID: 0,
Description: "A superb runner",
Labels: []string{"debian", "gpu"},
Status: "offline",
}
runnerTwo := &api.ActionRunner{
ID: 655692,
UUID: "6d2d13ef-b19f-47a8-85ad-e82e51f606c5",
Name: "runner-2-user",
Version: "11.3.1",
OwnerID: 1,
RepoID: 0,
Description: "A splendid runner",
Labels: []string{"docker"},
Status: "offline",
}
runnerThree := &api.ActionRunner{
ID: 655693,
UUID: "0a7e5e05-2da4-44d5-a72a-615da120cef6",
Name: "runner-3-organization",
Version: "11.3.1",
OwnerID: 3,
RepoID: 0,
Description: "Another fine runner",
Labels: []string{"fedora"},
Status: "offline",
}
runnerFour := &api.ActionRunner{
ID: 655694,
UUID: "166c596c-5016-488d-bd55-b84e5a0460ea",
Name: "runner-4-global",
Version: "11.3.1",
OwnerID: 0,
RepoID: 0,
Description: "",
Labels: []string{},
Status: "offline",
}
runnerFive := &api.ActionRunner{
ID: 655695,
UUID: "0851ed0a-f0af-4a01-9b98-fc9bf9c1d332",
Name: "runner-5-ephemeral",
Version: "1.0.0",
OwnerID: 3,
RepoID: 0,
Description: "An ephemeral runner",
Labels: []string{"ephemeral-label"},
Status: "offline",
Ephemeral: true,
}
t.Run("Get runners", func(t *testing.T) {
request := NewRequest(t, "GET", "/api/v1/orgs/org3/actions/runners")
request.AddTokenAuth(readToken)
@ -122,41 +179,6 @@ func TestAPIOrgActionsRunnerOperations(t *testing.T) {
var runners []*api.ActionRunner
DecodeJSON(t, response, &runners)
runnerOne := &api.ActionRunner{
ID: 655691,
UUID: "a3297f3a-ba5c-4a0f-878e-6cc8b8ac79ec",
Name: "runner-1-organization",
Version: "dev",
OwnerID: 3,
RepoID: 0,
Description: "A superb runner",
Labels: []string{"debian", "gpu"},
Status: "offline",
}
runnerThree := &api.ActionRunner{
ID: 655693,
UUID: "0a7e5e05-2da4-44d5-a72a-615da120cef6",
Name: "runner-3-organization",
Version: "11.3.1",
OwnerID: 3,
RepoID: 0,
Description: "Another fine runner",
Labels: []string{"fedora"},
Status: "offline",
}
runnerFive := &api.ActionRunner{
ID: 655695,
UUID: "0851ed0a-f0af-4a01-9b98-fc9bf9c1d332",
Name: "runner-5-ephemeral",
Version: "1.0.0",
OwnerID: 3,
RepoID: 0,
Description: "An ephemeral runner",
Labels: []string{"ephemeral-label"},
Status: "offline",
Ephemeral: true,
}
assert.ElementsMatch(t, []*api.ActionRunner{runnerOne, runnerThree, runnerFive}, runners)
})
@ -173,6 +195,25 @@ func TestAPIOrgActionsRunnerOperations(t *testing.T) {
assert.Len(t, runners, 1)
})
t.Run("Get visible runners", func(t *testing.T) {
request := NewRequest(t, "GET", "/api/v1/orgs/org3/actions/runners?visible=true")
request.AddTokenAuth(readToken)
response := MakeRequest(t, request, http.StatusOK)
assert.NotEmpty(t, response.Header().Get("X-Total-Count"))
var runners []*api.ActionRunner
DecodeJSON(t, response, &runners)
// There are more runners in the result that originate from the global fixtures. The test ignores them to limit
// the impact of unrelated changes.
assert.Contains(t, runners, runnerOne)
assert.NotContains(t, runners, runnerTwo)
assert.Contains(t, runners, runnerThree)
assert.Contains(t, runners, runnerFour)
assert.Contains(t, runners, runnerFive)
})
t.Run("Get runner", func(t *testing.T) {
request := NewRequest(t, "GET", "/api/v1/orgs/org3/actions/runners/655691")
request.AddTokenAuth(readToken)
@ -181,19 +222,21 @@ func TestAPIOrgActionsRunnerOperations(t *testing.T) {
var runner *api.ActionRunner
DecodeJSON(t, response, &runner)
runnerOne := &api.ActionRunner{
ID: 655691,
UUID: "a3297f3a-ba5c-4a0f-878e-6cc8b8ac79ec",
Name: "runner-1-organization",
Version: "dev",
OwnerID: 3,
RepoID: 0,
Description: "A superb runner",
Labels: []string{"debian", "gpu"},
Status: "offline",
}
assert.Equal(t, runnerOne, runner)
// Instance runner is visible to any organization.
request = NewRequest(t, "GET", "/api/v1/orgs/org3/actions/runners/655694")
request.AddTokenAuth(readToken)
response = MakeRequest(t, request, http.StatusOK)
DecodeJSON(t, response, &runner)
assert.Equal(t, runnerFour, runner)
// Runner owned by a user is invisible.
request = NewRequest(t, "GET", "/api/v1/orgs/org3/actions/runners/655692")
request.AddTokenAuth(readToken)
MakeRequest(t, request, http.StatusNotFound)
})
t.Run("Get ephemeral runner", func(t *testing.T) {
@ -204,20 +247,7 @@ func TestAPIOrgActionsRunnerOperations(t *testing.T) {
var runner *api.ActionRunner
DecodeJSON(t, response, &runner)
expectedRunner := &api.ActionRunner{
ID: 655695,
UUID: "0851ed0a-f0af-4a01-9b98-fc9bf9c1d332",
Name: "runner-5-ephemeral",
Version: "1.0.0",
OwnerID: 3,
RepoID: 0,
Description: "An ephemeral runner",
Labels: []string{"ephemeral-label"},
Status: "offline",
Ephemeral: true,
}
assert.Equal(t, expectedRunner, runner)
assert.Equal(t, runnerFive, runner)
})
t.Run("Delete runner", func(t *testing.T) {

152
tests/integration/api_repo_actions_test.go
View file

@ -393,6 +393,63 @@ func TestAPIRepoActionsRunnerOperations(t *testing.T) {
readToken := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadRepository)
writeToken := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
runnerOne := &api.ActionRunner{
ID: 899251,
UUID: "a3297f3a-ba5c-4a0f-878e-6cc8b8ac79ec",
Name: "runner-1-repository",
Version: "dev",
OwnerID: 0,
RepoID: 62,
Description: "A superb runner",
Labels: []string{"debian", "gpu"},
Status: "offline",
}
runnerTwo := &api.ActionRunner{
ID: 899252,
UUID: "6d2d13ef-b19f-47a8-85ad-e82e51f606c5",
Name: "runner-2-user",
Version: "11.3.1",
OwnerID: 1,
RepoID: 0,
Description: "A splendid runner",
Labels: []string{"docker"},
Status: "offline",
}
runnerThree := &api.ActionRunner{
ID: 899253,
UUID: "0a7e5e05-2da4-44d5-a72a-615da120cef6",
Name: "runner-3-repository",
Version: "11.3.1",
OwnerID: 0,
RepoID: 62,
Description: "Another fine runner",
Labels: []string{"fedora"},
Status: "offline",
}
runnerFour := &api.ActionRunner{
ID: 899254,
UUID: "6456ac1f-70ec-4e8f-9ab7-bf117ee23d47",
Name: "runner-4-global",
Version: "11.3.1",
OwnerID: 0,
RepoID: 0,
Description: "",
Labels: []string{},
Status: "offline",
}
runnerFive := &api.ActionRunner{
ID: 899255,
UUID: "96639646-67b2-4bcb-9142-fde1ab8498cf",
Name: "runner-5-repository-ephemeral",
Version: "1.0.0",
OwnerID: 0,
RepoID: 62,
Description: "An ephemeral runner",
Labels: []string{"ephemeral-label"},
Status: "offline",
Ephemeral: true,
}
t.Run("Get runners", func(t *testing.T) {
request := NewRequest(t, "GET", "/api/v1/repos/user2/test_workflows/actions/runners")
request.AddTokenAuth(readToken)
@ -403,41 +460,6 @@ func TestAPIRepoActionsRunnerOperations(t *testing.T) {
var runners []*api.ActionRunner
DecodeJSON(t, response, &runners)
runnerOne := &api.ActionRunner{
ID: 899251,
UUID: "a3297f3a-ba5c-4a0f-878e-6cc8b8ac79ec",
Name: "runner-1-repository",
Version: "dev",
OwnerID: 0,
RepoID: 62,
Description: "A superb runner",
Labels: []string{"debian", "gpu"},
Status: "offline",
}
runnerThree := &api.ActionRunner{
ID: 899253,
UUID: "0a7e5e05-2da4-44d5-a72a-615da120cef6",
Name: "runner-3-repository",
Version: "11.3.1",
OwnerID: 0,
RepoID: 62,
Description: "Another fine runner",
Labels: []string{"fedora"},
Status: "offline",
}
runnerFive := &api.ActionRunner{
ID: 899255,
UUID: "96639646-67b2-4bcb-9142-fde1ab8498cf",
Name: "runner-5-repository-ephemeral",
Version: "1.0.0",
OwnerID: 0,
RepoID: 62,
Description: "An ephemeral runner",
Labels: []string{"ephemeral-label"},
Status: "offline",
Ephemeral: true,
}
assert.ElementsMatch(t, []*api.ActionRunner{runnerOne, runnerThree, runnerFive}, runners)
})
@ -454,6 +476,25 @@ func TestAPIRepoActionsRunnerOperations(t *testing.T) {
assert.Len(t, runners, 1)
})
t.Run("Get visible runners", func(t *testing.T) {
request := NewRequest(t, "GET", "/api/v1/repos/user2/test_workflows/actions/runners?visible=true")
request.AddTokenAuth(readToken)
response := MakeRequest(t, request, http.StatusOK)
assert.NotEmpty(t, response.Header().Get("X-Total-Count"))
var runners []*api.ActionRunner
DecodeJSON(t, response, &runners)
// There are more runners in the result that originate from the global fixtures. The test ignores them to limit
// the impact of unrelated changes.
assert.Contains(t, runners, runnerOne)
assert.NotContains(t, runners, runnerTwo)
assert.Contains(t, runners, runnerThree)
assert.Contains(t, runners, runnerFour)
assert.Contains(t, runners, runnerFive)
})
t.Run("Get runner", func(t *testing.T) {
request := NewRequest(t, "GET", "/api/v1/repos/user2/test_workflows/actions/runners/899251")
request.AddTokenAuth(readToken)
@ -462,19 +503,21 @@ func TestAPIRepoActionsRunnerOperations(t *testing.T) {
var runner *api.ActionRunner
DecodeJSON(t, response, &runner)
runnerOne := &api.ActionRunner{
ID: 899251,
UUID: "a3297f3a-ba5c-4a0f-878e-6cc8b8ac79ec",
Name: "runner-1-repository",
Version: "dev",
OwnerID: 0,
RepoID: 62,
Description: "A superb runner",
Labels: []string{"debian", "gpu"},
Status: "offline",
}
assert.Equal(t, runnerOne, runner)
// Runner of instance is visible
request = NewRequest(t, "GET", "/api/v1/repos/user2/test_workflows/actions/runners/899254")
request.AddTokenAuth(readToken)
response = MakeRequest(t, request, http.StatusOK)
DecodeJSON(t, response, &runner)
assert.Equal(t, runnerFour, runner)
// Runner of user that does not own the repository is invisible
request = NewRequest(t, "GET", "/api/v1/repos/user2/test_workflows/actions/runners/899252")
request.AddTokenAuth(readToken)
MakeRequest(t, request, http.StatusNotFound)
})
t.Run("Get ephemeral runner", func(t *testing.T) {
@ -485,20 +528,7 @@ func TestAPIRepoActionsRunnerOperations(t *testing.T) {
var runner *api.ActionRunner
DecodeJSON(t, response, &runner)
expectedRunner := &api.ActionRunner{
ID: 899255,
UUID: "96639646-67b2-4bcb-9142-fde1ab8498cf",
Name: "runner-5-repository-ephemeral",
Version: "1.0.0",
OwnerID: 0,
RepoID: 62,
Description: "An ephemeral runner",
Labels: []string{"ephemeral-label"},
Status: "offline",
Ephemeral: true,
}
assert.Equal(t, expectedRunner, runner)
assert.Equal(t, runnerFive, runner)
})
t.Run("Delete runner", func(t *testing.T) {

139
tests/integration/api_user_actions_test.go
View file

@ -110,6 +110,53 @@ func TestAPIUserActionsRunnerOperations(t *testing.T) {
readToken := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadUser)
writeToken := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteUser)
runnerOne := &api.ActionRunner{
ID: 71301,
UUID: "99fc4a58-a25e-4dbe-b6ea-3d55dddcd216",
Name: "runner-1-user",
Version: "dev",
OwnerID: 2,
RepoID: 0,
Description: "A superb runner",
Labels: []string{"debian", "gpu"},
Status: "offline",
}
runnerThree := &api.ActionRunner{
ID: 71303,
UUID: "70bc0da3-35b2-4129-bbc9-4679dfdda4d0",
Name: "runner-3-user",
Version: "11.3.1",
OwnerID: 2,
RepoID: 0,
Description: "Another fine runner",
Labels: []string{"fedora"},
Status: "offline",
}
runnerFour := &api.ActionRunner{
ID: 71304,
UUID: "3873c473-47b8-4559-9fa5-843277419780",
Name: "runner-4-global",
Version: "11.3.1",
OwnerID: 0,
RepoID: 0,
Description: "",
Labels: []string{},
Status: "offline",
Ephemeral: false,
}
runnerFive := &api.ActionRunner{
ID: 71305,
UUID: "3ca04a95-3e75-4e48-8b7a-63427ebcf3b8",
Name: "runner-5-user-ephemeral",
Version: "1.0.0",
OwnerID: 2,
RepoID: 0,
Description: "An ephemeral runner",
Labels: []string{"ephemeral-label"},
Status: "offline",
Ephemeral: true,
}
t.Run("Get runners", func(t *testing.T) {
request := NewRequest(t, "GET", "/api/v1/user/actions/runners")
request.AddTokenAuth(readToken)
@ -120,41 +167,6 @@ func TestAPIUserActionsRunnerOperations(t *testing.T) {
var runners []*api.ActionRunner
DecodeJSON(t, response, &runners)
runnerOne := &api.ActionRunner{
ID: 71301,
UUID: "99fc4a58-a25e-4dbe-b6ea-3d55dddcd216",
Name: "runner-1-user",
Version: "dev",
OwnerID: 2,
RepoID: 0,
Description: "A superb runner",
Labels: []string{"debian", "gpu"},
Status: "offline",
}
runnerThree := &api.ActionRunner{
ID: 71303,
UUID: "70bc0da3-35b2-4129-bbc9-4679dfdda4d0",
Name: "runner-3-user",
Version: "11.3.1",
OwnerID: 2,
RepoID: 0,
Description: "Another fine runner",
Labels: []string{"fedora"},
Status: "offline",
}
runnerFive := &api.ActionRunner{
ID: 71305,
UUID: "3ca04a95-3e75-4e48-8b7a-63427ebcf3b8",
Name: "runner-5-user-ephemeral",
Version: "1.0.0",
OwnerID: 2,
RepoID: 0,
Description: "An ephemeral runner",
Labels: []string{"ephemeral-label"},
Status: "offline",
Ephemeral: true,
}
assert.ElementsMatch(t, []*api.ActionRunner{runnerOne, runnerThree, runnerFive}, runners)
})
@ -171,6 +183,22 @@ func TestAPIUserActionsRunnerOperations(t *testing.T) {
assert.Len(t, runners, 1)
})
t.Run("Get visible runners", func(t *testing.T) {
request := NewRequest(t, "GET", "/api/v1/user/actions/runners?visible=true")
request.AddTokenAuth(readToken)
response := MakeRequest(t, request, http.StatusOK)
var runners []*api.ActionRunner
DecodeJSON(t, response, &runners)
// There are more runners in the result that originate from the global fixtures. The test ignores them to limit
// the impact of unrelated changes.
assert.Contains(t, runners, runnerOne)
assert.Contains(t, runners, runnerThree)
assert.Contains(t, runners, runnerFour)
assert.Contains(t, runners, runnerFive)
})
t.Run("Get runner", func(t *testing.T) {
request := NewRequest(t, "GET", "/api/v1/user/actions/runners/71303")
request.AddTokenAuth(readToken)
@ -179,19 +207,21 @@ func TestAPIUserActionsRunnerOperations(t *testing.T) {
var runner *api.ActionRunner
DecodeJSON(t, response, &runner)
runnerThree := &api.ActionRunner{
ID: 71303,
UUID: "70bc0da3-35b2-4129-bbc9-4679dfdda4d0",
Name: "runner-3-user",
Version: "11.3.1",
OwnerID: 2,
RepoID: 0,
Description: "Another fine runner",
Labels: []string{"fedora"},
Status: "offline",
}
assert.Equal(t, runnerThree, runner)
// Runner owned by instance is visible to user.
request = NewRequest(t, "GET", "/api/v1/user/actions/runners/71304")
request.AddTokenAuth(readToken)
response = MakeRequest(t, request, http.StatusOK)
DecodeJSON(t, response, &runner)
assert.Equal(t, runnerFour, runner)
// Runner owned by different user is invisible.
request = NewRequest(t, "GET", "/api/v1/user/actions/runners/71302")
request.AddTokenAuth(readToken)
MakeRequest(t, request, http.StatusNotFound)
})
t.Run("Get ephemeral runner", func(t *testing.T) {
@ -202,20 +232,7 @@ func TestAPIUserActionsRunnerOperations(t *testing.T) {
var runner *api.ActionRunner
DecodeJSON(t, response, &runner)
expectedRunner := &api.ActionRunner{
ID: 71305,
UUID: "3ca04a95-3e75-4e48-8b7a-63427ebcf3b8",
Name: "runner-5-user-ephemeral",
Version: "1.0.0",
OwnerID: 2,
RepoID: 0,
Description: "An ephemeral runner",
Labels: []string{"ephemeral-label"},
Status: "offline",
Ephemeral: true,
}
assert.Equal(t, expectedRunner, runner)
assert.Equal(t, runnerFive, runner)
})
t.Run("Delete runner", func(t *testing.T) {