-
Notifications
You must be signed in to change notification settings - Fork 301
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Integrate Job API into the bootstrap under the job-api experiment
- Loading branch information
Showing
6 changed files
with
230 additions
and
6 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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,52 @@ | ||
| package bootstrap | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/buildkite/agent/v3/experiments" | ||
| "github.com/buildkite/agent/v3/jobapi" | ||
| ) | ||
|
|
||
| // startJobAPI starts the job API server, iff the job API experiment is enabled, and the OS of the box supports it | ||
| // otherwise it returns a noop cleanup function | ||
| // It also sets the BUILDKITE_AGENT_JOB_API_SOCKET and BUILDKITE_AGENT_JOB_API_TOKEN environment variables | ||
| func (b *Bootstrap) startJobAPI() (cleanup func(), err error) { | ||
| cleanup = func() {} | ||
|
|
||
| if !experiments.IsEnabled("job-api") { | ||
| return cleanup, nil | ||
| } | ||
|
|
||
| if !jobapi.Available() { | ||
| b.shell.Warningf("The Job API isn't available on this machine, as it's running an unsupported version of Windows") | ||
| b.shell.Warningf("The Job API is available on Unix agents, and agents running Windows versions after build 17063") | ||
| b.shell.Warningf("We'll continue to run your job, but you won't be able to use the Job API") | ||
| return cleanup, nil | ||
| } | ||
|
|
||
| socketPath, err := jobapi.NewSocketPath() | ||
| if err != nil { | ||
| return cleanup, fmt.Errorf("creating job API socket path: %v", err) | ||
| } | ||
|
|
||
| srv, token, err := jobapi.NewServer(socketPath, b.shell.Env) | ||
| if err != nil { | ||
| return cleanup, fmt.Errorf("creating job API server: %v", err) | ||
| } | ||
|
|
||
| b.shell.Env.Set("BUILDKITE_AGENT_JOB_API_SOCKET", socketPath) | ||
| b.shell.Env.Set("BUILDKITE_AGENT_JOB_API_TOKEN", token) | ||
|
|
||
| if err := srv.Start(); err != nil { | ||
| return cleanup, fmt.Errorf("starting Job API server: %v", err) | ||
| } | ||
|
|
||
| return func() { | ||
| err = srv.Stop() | ||
| if err != nil { | ||
| b.shell.Errorf("Error stopping Job API server: %v", err) | ||
| } else { | ||
| b.shell.Commentf("Stopped Job API server") | ||
| } | ||
| }, nil | ||
| } |
This file contains 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
This file contains 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
This file contains 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,146 @@ | ||
| package integration | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
| "io" | ||
| "net" | ||
| "net/http" | ||
| "testing" | ||
|
|
||
| "github.com/buildkite/agent/v3/jobapi" | ||
| "github.com/buildkite/bintest/v3" | ||
| ) | ||
|
|
||
| func TestBootstrapRunsJobAPI(t *testing.T) { | ||
| defer experimentWithUndo("job-api")() | ||
|
|
||
| tester, err := NewBootstrapTester() | ||
| if err != nil { | ||
| t.Fatalf("NewBootstrapTester() error = %v", err) | ||
| } | ||
| defer tester.Close() | ||
|
|
||
| tester.ExpectGlobalHook("command").Once().AndCallFunc(func(c *bintest.Call) { | ||
| socketPath := c.GetEnv("BUILDKITE_AGENT_JOB_API_SOCKET") | ||
| if socketPath == "" { | ||
| t.Errorf("Expected BUILDKITE_AGENT_JOB_API_SOCKET to be set") | ||
| c.Exit(1) | ||
| return | ||
| } | ||
|
|
||
| socketToken := c.GetEnv("BUILDKITE_AGENT_JOB_API_TOKEN") | ||
| if socketToken == "" { | ||
| t.Errorf("Expected BUILDKITE_AGENT_JOB_API_TOKEN to be set") | ||
| c.Exit(1) | ||
| return | ||
| } | ||
|
|
||
| client := &http.Client{ | ||
| Transport: &http.Transport{ | ||
| DialContext: func(context.Context, string, string) (net.Conn, error) { | ||
| return net.Dial("unix", socketPath) | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| req, err := http.NewRequest(http.MethodGet, "http://bootstrap/api/current-job/v0/env", nil) | ||
| if err != nil { | ||
| t.Errorf("creating request: %v", err) | ||
| c.Exit(1) | ||
| return | ||
| } | ||
|
|
||
| req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", socketToken)) | ||
|
|
||
| resp, err := client.Do(req) | ||
| if err != nil { | ||
| t.Errorf("sending request: %v", err) | ||
| c.Exit(1) | ||
| return | ||
| } | ||
|
|
||
| if resp.StatusCode != http.StatusOK { | ||
| body, _ := io.ReadAll(resp.Body) | ||
| t.Errorf("expected status 200, got %d, body: %s", resp.StatusCode, body) | ||
| c.Exit(1) | ||
| return | ||
| } | ||
|
|
||
| var envResp jobapi.EnvGetResponse | ||
| err = json.NewDecoder(resp.Body).Decode(&envResp) | ||
| if err != nil { | ||
| t.Errorf("decoding env get response: %v", err) | ||
| c.Exit(1) | ||
| return | ||
| } | ||
|
|
||
| for name, val := range envResp.Env { | ||
| if val != c.GetEnv(name) { | ||
| t.Errorf("expected c.GetEnv(%q) = %s, got %s", name, c.GetEnv(name), val) | ||
| c.Exit(1) | ||
| return | ||
| } | ||
| } | ||
|
|
||
| mtn := "chimborazo" | ||
| b, err := json.Marshal(jobapi.EnvUpdateRequest{Env: map[string]*string{"MOUNTAIN": &mtn}}) | ||
| if err != nil { | ||
| t.Errorf("marshaling env update request: %v", err) | ||
| c.Exit(1) | ||
| return | ||
| } | ||
|
|
||
| req, err = http.NewRequest(http.MethodPatch, "http://bootstrap/api/current-job/v0/env", bytes.NewBuffer(b)) | ||
| if err != nil { | ||
| t.Errorf("creating patch request: %v", err) | ||
| c.Exit(1) | ||
| return | ||
| } | ||
|
|
||
| req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", socketToken)) | ||
|
|
||
| resp, err = client.Do(req) | ||
| if err != nil { | ||
| t.Errorf("sending patch request: %v", err) | ||
| c.Exit(1) | ||
| return | ||
| } | ||
|
|
||
| if resp.StatusCode != http.StatusOK { | ||
| body, _ := io.ReadAll(resp.Body) | ||
| t.Errorf("expected status 200, got %d, body: %s", resp.StatusCode, body) | ||
| c.Exit(1) | ||
| return | ||
| } | ||
|
|
||
| var patchResp jobapi.EnvUpdateResponse | ||
| err = json.NewDecoder(resp.Body).Decode(&patchResp) | ||
| if err != nil { | ||
| t.Errorf("decoding env get response: %v", err) | ||
| c.Exit(1) | ||
| return | ||
| } | ||
|
|
||
| if patchResp.Added[0] != "MOUNTAIN" { | ||
| t.Errorf("expected patchResp.Added[0] = %q, got %s", mtn, patchResp.Added[0]) | ||
| c.Exit(1) | ||
| return | ||
| } | ||
|
|
||
| c.Exit(0) | ||
| }) | ||
|
|
||
| tester.ExpectGlobalHook("post-command").Once().AndExitWith(0).AndCallFunc(func(c *bintest.Call) { | ||
| if got, want := c.GetEnv("MOUNTAIN"), "chimborazo"; got != want { | ||
| fmt.Fprintf(c.Stderr, "MOUNTAIN = %q, want %q\n", got, want) | ||
| c.Exit(1) | ||
| } else { | ||
| c.Exit(0) | ||
| } | ||
| }) | ||
|
|
||
| tester.RunAndCheck(t) | ||
| } |
This file contains 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