-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Implement support for actions runners #1446
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| // Copyright 2020 The go-github AUTHORS. All rights reserved. | ||
| // | ||
| // Use of this source code is governed by a BSD-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package github | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| ) | ||
|
|
||
| // RunnerApplicationDownload represents a binary for the self-hosted runner application that can be downloaded. | ||
| type RunnerApplicationDownload struct { | ||
| OS *string `json:"os,omitempty"` | ||
| Architecture *string `json:"architecture,omitempty"` | ||
| DownloadURL *string `json:"download_url,omitempty"` | ||
| Filename *string `json:"filename,omitempty"` | ||
| } | ||
|
|
||
| // ListRunnerApplicationDownloads lists self-hosted runner application binaries that can be downloaded and run. | ||
| // | ||
| // GitHub API docs: https://developer.github.com/v3/actions/self_hosted_runners/#list-downloads-for-the-self-hosted-runner-application | ||
| func (s *ActionsService) ListRunnerApplicationDownloads(ctx context.Context, owner, repo string) ([]*RunnerApplicationDownload, *Response, error) { | ||
| u := fmt.Sprintf("repos/%v/%v/actions/runners/downloads", owner, repo) | ||
| req, err := s.client.NewRequest("GET", u, nil) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| var rads []*RunnerApplicationDownload | ||
| resp, err := s.client.Do(ctx, req, &rads) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
|
|
||
| return rads, resp, nil | ||
| } | ||
|
|
||
| // RegistrationToken represents a token that can be used to add a self-hosted runner to a repository. | ||
| type RegistrationToken struct { | ||
| Token *string `json:"token,omitempty"` | ||
| ExpiresAt *Timestamp `json:"expires_at,omitempty"` | ||
| } | ||
|
|
||
| // CreateRegistrationToken creates a token that can be used to add a self-hosted runner. | ||
| // | ||
| // GitHub API docs: https://developer.github.com/v3/actions/self_hosted_runners/#create-a-registration-token | ||
| func (s *ActionsService) CreateRegistrationToken(ctx context.Context, owner, repo string) (*RegistrationToken, *Response, error) { | ||
| u := fmt.Sprintf("repos/%v/%v/actions/runners/registration-token", owner, repo) | ||
|
|
||
| req, err := s.client.NewRequest("POST", u, nil) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| registrationToken := new(RegistrationToken) | ||
| resp, err := s.client.Do(ctx, req, registrationToken) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
|
|
||
| return registrationToken, resp, nil | ||
| } | ||
|
|
||
| // Runner represents a self-hosted runner registered with a repository. | ||
| type Runner struct { | ||
| ID *int64 `json:"id,omitempty"` | ||
| Name *string `json:"name,omitempty"` | ||
| OS *string `json:"os,omitempty"` | ||
| Status *string `json:"status,omitempty"` | ||
| } | ||
|
|
||
| // ListRunners lists all the self-hosted runners for a repository. | ||
| // | ||
| // GitHub API docs: https://developer.github.com/v3/actions/self_hosted_runners/#list-self-hosted-runners-for-a-repository | ||
| func (s *ActionsService) ListRunners(ctx context.Context, owner, repo string, opts *ListOptions) ([]*Runner, *Response, error) { | ||
| u := fmt.Sprintf("repos/%v/%v/actions/runners", owner, repo) | ||
| u, err := addOptions(u, opts) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| req, err := s.client.NewRequest("GET", u, nil) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| var runners []*Runner | ||
| resp, err := s.client.Do(ctx, req, &runners) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
|
|
||
| return runners, resp, nil | ||
| } | ||
|
|
||
| // GetRunner gets a specific self-hosted runner for a repository using its runner ID. | ||
| // | ||
| // GitHub API docs: https://developer.github.com/v3/actions/self_hosted_runners/#get-a-self-hosted-runner | ||
| func (s *ActionsService) GetRunner(ctx context.Context, owner, repo string, runnerID int64) (*Runner, *Response, error) { | ||
| u := fmt.Sprintf("repos/%v/%v/actions/runners/%v", owner, repo, runnerID) | ||
| req, err := s.client.NewRequest("GET", u, nil) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| runner := new(Runner) | ||
| resp, err := s.client.Do(ctx, req, runner) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
|
|
||
| return runner, resp, nil | ||
| } | ||
|
|
||
| // RemoveToken represents a token that can be used to remove a self-hosted runner from a repository. | ||
| type RemoveToken struct { | ||
| Token *string `json:"token,omitempty"` | ||
| ExpiresAt *Timestamp `json:"expires_at,omitempty"` | ||
| } | ||
|
|
||
| // CreateRemoveToken creates a token that can be used to remove a self-hosted runner from a repository. | ||
| // | ||
| // GitHub API docs: https://developer.github.com/v3/actions/self_hosted_runners/#create-a-remove-token | ||
| func (s *ActionsService) CreateRemoveToken(ctx context.Context, owner, repo string) (*RemoveToken, *Response, error) { | ||
| u := fmt.Sprintf("repos/%v/%v/actions/runners/remove-token", owner, repo) | ||
|
|
||
| req, err := s.client.NewRequest("POST", u, nil) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| removeToken := new(RemoveToken) | ||
| resp, err := s.client.Do(ctx, req, removeToken) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
|
|
||
| return removeToken, resp, nil | ||
| } | ||
|
|
||
| // RemoveRunner forces the removal of a self-hosted runner in a repository using the runner id. | ||
| // | ||
| // GitHub API docs: https://developer.github.com/v3/actions/self_hosted_runners/#remove-a-self-hosted-runner | ||
| func (s *ActionsService) RemoveRunner(ctx context.Context, owner, repo string, runnerID int64) (*Response, error) { | ||
| u := fmt.Sprintf("repos/%v/%v/actions/runners/%v", owner, repo, runnerID) | ||
|
|
||
| req, err := s.client.NewRequest("DELETE", u, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return s.client.Do(ctx, req, nil) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| // Copyright 2020 The go-github AUTHORS. All rights reserved. | ||
| // | ||
| // Use of this source code is governed by a BSD-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package github | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "net/http" | ||
| "reflect" | ||
| "testing" | ||
| "time" | ||
| ) | ||
|
|
||
| func TestActionsService_ListRunnerApplicationDownloads(t *testing.T) { | ||
| client, mux, _, teardown := setup() | ||
| defer teardown() | ||
|
|
||
| mux.HandleFunc("/repos/o/r/actions/runners/downloads", func(w http.ResponseWriter, r *http.Request) { | ||
| testMethod(t, r, "GET") | ||
| fmt.Fprint(w, `[{"os":"osx","architecture":"x64","download_url":"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz","filename":"actions-runner-osx-x64-2.164.0.tar.gz"},{"os":"linux","architecture":"x64","download_url":"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz","filename":"actions-runner-linux-x64-2.164.0.tar.gz"},{"os": "linux","architecture":"arm","download_url":"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz","filename":"actions-runner-linux-arm-2.164.0.tar.gz"},{"os":"win","architecture":"x64","download_url":"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip","filename":"actions-runner-win-x64-2.164.0.zip"},{"os":"linux","architecture":"arm64","download_url":"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz","filename":"actions-runner-linux-arm64-2.164.0.tar.gz"}]`) | ||
| }) | ||
|
|
||
| downloads, _, err := client.Actions.ListRunnerApplicationDownloads(context.Background(), "o", "r") | ||
| if err != nil { | ||
| t.Errorf("Actions.ListRunnerApplicationDownloads returned error: %v", err) | ||
| } | ||
|
|
||
| want := []*RunnerApplicationDownload{ | ||
| {OS: String("osx"), Architecture: String("x64"), DownloadURL: String("https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz"), Filename: String("actions-runner-osx-x64-2.164.0.tar.gz")}, | ||
| {OS: String("linux"), Architecture: String("x64"), DownloadURL: String("https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz"), Filename: String("actions-runner-linux-x64-2.164.0.tar.gz")}, | ||
| {OS: String("linux"), Architecture: String("arm"), DownloadURL: String("https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz"), Filename: String("actions-runner-linux-arm-2.164.0.tar.gz")}, | ||
| {OS: String("win"), Architecture: String("x64"), DownloadURL: String("https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip"), Filename: String("actions-runner-win-x64-2.164.0.zip")}, | ||
| {OS: String("linux"), Architecture: String("arm64"), DownloadURL: String("https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz"), Filename: String("actions-runner-linux-arm64-2.164.0.tar.gz")}, | ||
| } | ||
| if !reflect.DeepEqual(downloads, want) { | ||
| t.Errorf("Actions.ListRunnerApplicationDownloads returned %+v, want %+v", downloads, want) | ||
| } | ||
| } | ||
|
|
||
| func TestActionsService_CreateRegistrationToken(t *testing.T) { | ||
| client, mux, _, teardown := setup() | ||
| defer teardown() | ||
|
|
||
| mux.HandleFunc("/repos/o/r/actions/runners/registration-token", func(w http.ResponseWriter, r *http.Request) { | ||
| testMethod(t, r, "POST") | ||
| fmt.Fprint(w, `{"token":"LLBF3JGZDX3P5PMEXLND6TS6FCWO6","expires_at":"2020-01-22T12:13:35.123Z"}`) | ||
| }) | ||
|
|
||
| token, _, err := client.Actions.CreateRegistrationToken(context.Background(), "o", "r") | ||
| if err != nil { | ||
| t.Errorf("Actions.CreateRegistrationToken returned error: %v", err) | ||
| } | ||
|
|
||
| want := &RegistrationToken{Token: String("LLBF3JGZDX3P5PMEXLND6TS6FCWO6"), | ||
| ExpiresAt: &Timestamp{time.Date(2020, time.January, 22, 12, 13, 35, | ||
| 123000000, time.UTC)}} | ||
| if !reflect.DeepEqual(token, want) { | ||
| t.Errorf("Actions.CreateRegistrationToken returned %+v, want %+v", token, want) | ||
| } | ||
| } | ||
|
|
||
| func TestActionsService_ListRunners(t *testing.T) { | ||
| client, mux, _, teardown := setup() | ||
| defer teardown() | ||
|
|
||
| mux.HandleFunc("/repos/o/r/actions/runners", func(w http.ResponseWriter, r *http.Request) { | ||
| testMethod(t, r, "GET") | ||
| testFormValues(t, r, values{"per_page": "2", "page": "2"}) | ||
| fmt.Fprint(w, `[{"id":23,"name":"MBP","os":"macos","status":"online"},{"id":24,"name":"iMac","os":"macos","status":"offline"}]`) | ||
| }) | ||
|
|
||
| opts := &ListOptions{Page: 2, PerPage: 2} | ||
| runners, _, err := client.Actions.ListRunners(context.Background(), "o", "r", opts) | ||
| if err != nil { | ||
| t.Errorf("Actions.ListRunners returned error: %v", err) | ||
| } | ||
|
|
||
| want := []*Runner{ | ||
| {ID: Int64(23), Name: String("MBP"), OS: String("macos"), Status: String("online")}, | ||
| {ID: Int64(24), Name: String("iMac"), OS: String("macos"), Status: String("offline")}, | ||
| } | ||
| if !reflect.DeepEqual(runners, want) { | ||
| t.Errorf("Actions.ListRunners returned %+v, want %+v", runners, want) | ||
| } | ||
| } | ||
|
|
||
| func TestActionsService_GetRunner(t *testing.T) { | ||
| client, mux, _, teardown := setup() | ||
| defer teardown() | ||
|
|
||
| mux.HandleFunc("/repos/o/r/actions/runners/23", func(w http.ResponseWriter, r *http.Request) { | ||
| testMethod(t, r, "GET") | ||
| fmt.Fprint(w, `{"id":23,"name":"MBP","os":"macos","status":"online"}`) | ||
| }) | ||
|
|
||
| runner, _, err := client.Actions.GetRunner(context.Background(), "o", "r", 23) | ||
| if err != nil { | ||
| t.Errorf("Actions.GetRunner returned error: %v", err) | ||
| } | ||
|
|
||
| want := &Runner{ | ||
| ID: Int64(23), | ||
| Name: String("MBP"), | ||
| OS: String("macos"), | ||
| Status: String("online"), | ||
| } | ||
| if !reflect.DeepEqual(runner, want) { | ||
| t.Errorf("Actions.GetRunner returned %+v, want %+v", runner, want) | ||
| } | ||
| } | ||
|
|
||
| func TestActionsService_CreateRemoveToken(t *testing.T) { | ||
| client, mux, _, teardown := setup() | ||
| defer teardown() | ||
|
|
||
| mux.HandleFunc("/repos/o/r/actions/runners/remove-token", func(w http.ResponseWriter, r *http.Request) { | ||
| testMethod(t, r, "POST") | ||
| fmt.Fprint(w, `{"token":"AABF3JGZDX3P5PMEXLND6TS6FCWO6","expires_at":"2020-01-29T12:13:35.123Z"}`) | ||
| }) | ||
|
|
||
| token, _, err := client.Actions.CreateRemoveToken(context.Background(), "o", "r") | ||
| if err != nil { | ||
| t.Errorf("Actions.CreateRemoveToken returned error: %v", err) | ||
| } | ||
|
|
||
| want := &RemoveToken{Token: String("AABF3JGZDX3P5PMEXLND6TS6FCWO6"), ExpiresAt: &Timestamp{time.Date(2020, time.January, 29, 12, 13, 35, 123000000, time.UTC)}} | ||
| if !reflect.DeepEqual(token, want) { | ||
| t.Errorf("Actions.CreateRemoveToken returned %+v, want %+v", token, want) | ||
| } | ||
| } | ||
|
|
||
| func TestActionsService_RemoveRunner(t *testing.T) { | ||
| client, mux, _, teardown := setup() | ||
| defer teardown() | ||
|
|
||
| mux.HandleFunc("/repos/o/r/actions/runners/21", func(w http.ResponseWriter, r *http.Request) { | ||
| testMethod(t, r, "DELETE") | ||
| }) | ||
|
|
||
| _, err := client.Actions.RemoveRunner(context.Background(), "o", "r", 21) | ||
| if err != nil { | ||
| t.Errorf("Actions.RemoveRunner returned error: %v", err) | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please contact [email protected] and ask them why their example shows a list-of-lists here:
https://developer.github.com/v3/actions/self_hosted_runners/#list-self-hosted-runners-for-a-repository
(and ask them to please fix it if it truly is a single list, which I think it should be)? Thank you!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That’s the bit in the description where I mentioned contacting support about the array nested two levels deep (the real endpoint response doesn’t match their example). I'm not sure if they'll respond until the week starts.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whups, I have a bad habit of looking at the code before I look at the PR description.
Sorry about that, and thank you!
😁