Refactor api package to an interface

agent/agent_worker.go

@@ -19,12 +19,6 @@ type AgentWorkerConfig struct {
 	// Whether to set debug in the job
 	Debug bool
 
-	// The endpoint that should be used when communicating with the API
-	Endpoint string
-
-	// Whether to disable http for the API
-	DisableHTTP2 bool
-
 	// The configuration of the agent from the CLI
 	AgentConfiguration AgentConfiguration
 }
@@ -37,7 +31,7 @@ type AgentWorker struct {
 	lastPing, lastHeartbeat int64
 
 	// The API Client used when this agent is communicating with the API
-	apiClient *api.Client
+	apiClient APIClient
 
 	// The logger instance to use
 	logger logger.Logger
@@ -68,26 +62,12 @@ type AgentWorker struct {
 }
 
 // Creates the agent worker and initializes it's API Client
-func NewAgentWorker(l logger.Logger, a *api.AgentRegisterResponse, m *metrics.Collector, c AgentWorkerConfig) *AgentWorker {
-	var endpoint string
-	if a.Endpoint != "" {
-		endpoint = a.Endpoint
-	} else {
-		endpoint = c.Endpoint
-	}
-
-	// Create an APIClient with the agent's access token
-	apiClient := NewAPIClient(l, APIClientConfig{
-		Endpoint:     endpoint,
-		Token:        a.AccessToken,
-		DisableHTTP2: c.DisableHTTP2,
-	})
-
+func NewAgentWorker(l logger.Logger, a *api.AgentRegisterResponse, m *metrics.Collector, apiClient APIClient, c AgentWorkerConfig) *AgentWorker {
 	return &AgentWorker{
 		logger:             l,
 		agent:              a,
 		metricsCollector:   m,
-		apiClient:          apiClient,
+		apiClient:          apiClient.FromAgentRegisterResponse(a),
 		debug:              c.Debug,
 		agentConfiguration: c.AgentConfiguration,
 		stop:               make(chan struct{}),
@@ -257,7 +237,7 @@ func (a *AgentWorker) Connect() error {
 	a.UpdateProcTitle("connecting")
 
 	return retry.Do(func(s *retry.Stats) error {
-		_, err := a.apiClient.Agents.Connect()
+		_, err := a.apiClient.Connect()
 		if err != nil {
 			a.logger.Warn("%s (%s)", err, s)
 		}
@@ -273,7 +253,7 @@ func (a *AgentWorker) Heartbeat() error {
 
 	// Retry the heartbeat a few times
 	err = retry.Do(func(s *retry.Stats) error {
-		beat, _, err = a.apiClient.Heartbeats.Beat()
+		beat, _, err = a.apiClient.Heartbeat()
 		if err != nil {
 			a.logger.Warn("%s (%s)", err, s)
 		}
@@ -297,7 +277,7 @@ func (a *AgentWorker) Ping() (*api.Job, error) {
 	// Update the proc title
 	a.UpdateProcTitle("pinging")
 
-	ping, _, err := a.apiClient.Pings.Get()
+	ping, _, err := a.apiClient.Ping()
 	if err != nil {
 		// Get the last ping time to the nearest microsecond
 		lastPing := time.Unix(atomic.LoadInt64(&a.lastPing), 0)
@@ -312,15 +292,11 @@ func (a *AgentWorker) Ping() (*api.Job, error) {
 
 	// Should we switch endpoints?
 	if ping.Endpoint != "" && ping.Endpoint != a.agent.Endpoint {
+		newAPIClient := a.apiClient.FromPing(ping)
+
 		// Before switching to the new one, do a ping test to make sure it's
 		// valid. If it is, switch and carry on, otherwise ignore the switch
-		// for now.
-		newAPIClient := NewAPIClient(a.logger, APIClientConfig{
-			Endpoint: ping.Endpoint,
-			Token:    a.agent.AccessToken,
-		})
-
-		newPing, _, err := newAPIClient.Pings.Get()
+		newPing, _, err := newAPIClient.Ping()
 		if err != nil {
 			a.logger.Warn("Failed to ping the new endpoint %s - ignoring switch for now (%s)", ping.Endpoint, err)
 		} else {
@@ -364,7 +340,7 @@ func (a *AgentWorker) AcceptAndRun(job *api.Job) error {
 	var accepted *api.Job
 	err := retry.Do(func(s *retry.Stats) error {
 		var err error
-		accepted, _, err = a.apiClient.Jobs.Accept(job)
+		accepted, _, err = a.apiClient.AcceptJob(job)
 		if err != nil {
 			if api.IsRetryableError(err) {
 				a.logger.Warn("%s (%s)", err, s)
@@ -395,9 +371,8 @@ func (a *AgentWorker) AcceptAndRun(job *api.Job) error {
 	}()
 
 	// Now that the job has been accepted, we can start it.
-	a.jobRunner, err = NewJobRunner(a.logger, jobMetricsScope, a.agent, accepted, JobRunnerConfig{
+	a.jobRunner, err = NewJobRunner(a.logger, jobMetricsScope, a.agent, accepted, a.apiClient, JobRunnerConfig{
 		Debug:              a.debug,
-		Endpoint:           accepted.Endpoint,
 		AgentConfiguration: a.agentConfiguration,
 	})
 
@@ -422,7 +397,7 @@ func (a *AgentWorker) Disconnect() error {
 	// Update the proc title
 	a.UpdateProcTitle("disconnecting")
 
-	_, err := a.apiClient.Agents.Disconnect()
+	_, err := a.apiClient.Disconnect()
 	if err != nil {
 		a.logger.Warn("There was an error sending the disconnect API call to Buildkite. If this agent still appears online, you may have to manually stop it (%s)", err)
 	}

agent/api.go

@@ -0,0 +1,34 @@
+// Created by interfacer; DO NOT EDIT
+
+package agent
+
+import (
+	"github.com/buildkite/agent/api"
+)
+
+// APIClient is an interface generated for "github.com/buildkite/agent/api.Client".
+type APIClient interface {
+	AcceptJob(*api.Job) (*api.Job, *api.Response, error)
+	Annotate(string, *api.Annotation) (*api.Response, error)
+	Config() api.Config
+	Connect() (*api.Response, error)
+	CreateArtifacts(string, *api.ArtifactBatch) (*api.ArtifactBatchCreateResponse, *api.Response, error)
+	Disconnect() (*api.Response, error)
+	ExistsMetaData(string, string) (*api.MetaDataExists, *api.Response, error)
+	FinishJob(*api.Job) (*api.Response, error)
+	FromAgentRegisterResponse(*api.AgentRegisterResponse) *api.Client
+	FromPing(*api.Ping) *api.Client
+	GetJobState(string) (*api.JobState, *api.Response, error)
+	GetMetaData(string, string) (*api.MetaData, *api.Response, error)
+	Heartbeat() (*api.Heartbeat, *api.Response, error)
+	Ping() (*api.Ping, *api.Response, error)
+	Register(*api.AgentRegisterRequest) (*api.AgentRegisterResponse, *api.Response, error)
+	SaveHeaderTimes(string, *api.HeaderTimes) (*api.Response, error)
+	SearchArtifacts(string, *api.ArtifactSearchOptions) ([]*api.Artifact, *api.Response, error)
+	SetMetaData(string, *api.MetaData) (*api.Response, error)
+	StartJob(*api.Job) (*api.Response, error)
+	StepUpdate(string, *api.StepUpdate) (*api.Response, error)
+	UpdateArtifacts(string, map[string]string) (*api.Response, error)
+	UploadChunk(string, *api.Chunk) (*api.Response, error)
+	UploadPipeline(string, *api.Pipeline) (*api.Response, error)
+}

agent/artifact_batch_creator.go

@@ -27,10 +27,10 @@ type ArtifactBatchCreator struct {
 	logger logger.Logger
 
 	// The APIClient that will be used when uploading jobs
-	apiClient *api.Client
+	apiClient APIClient
 }
 
-func NewArtifactBatchCreator(l logger.Logger, ac *api.Client, c ArtifactBatchCreatorConfig) *ArtifactBatchCreator {
+func NewArtifactBatchCreator(l logger.Logger, ac APIClient, c ArtifactBatchCreatorConfig) *ArtifactBatchCreator {
 	return &ArtifactBatchCreator{
 		logger:    l,
 		conf:      c,
@@ -67,7 +67,7 @@ func (a *ArtifactBatchCreator) Create() ([]*api.Artifact, error) {
 
 		// Retry the batch upload a couple of times
 		err = retry.Do(func(s *retry.Stats) error {
-			creation, resp, err = a.apiClient.Artifacts.Create(a.conf.JobID, batch)
+			creation, resp, err = a.apiClient.CreateArtifacts(a.conf.JobID, batch)
 			if resp != nil && (resp.StatusCode == 401 || resp.StatusCode == 404 || resp.StatusCode == 500) {
 				s.Break()
 			}

agent/artifact_downloader.go

@@ -8,7 +8,6 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/buildkite/agent/api"
 	"github.com/buildkite/agent/logger"
 	"github.com/buildkite/agent/pool"
 )
@@ -25,6 +24,9 @@ type ArtifactDownloaderConfig struct {
 
 	// Where we'll be downloading artifacts to
 	Destination string
+
+	// Whether to show HTTP debugging
+	DebugHTTP bool
 }
 
 type ArtifactDownloader struct {
@@ -34,11 +36,11 @@ type ArtifactDownloader struct {
 	// The logger instance to use
 	logger logger.Logger
 
-	// The *api.Client that will be used when uploading jobs
-	apiClient *api.Client
+	// The APIClient that will be used when uploading jobs
+	apiClient APIClient
 }
 
-func NewArtifactDownloader(l logger.Logger, ac *api.Client, c ArtifactDownloaderConfig) ArtifactDownloader {
+func NewArtifactDownloader(l logger.Logger, ac APIClient, c ArtifactDownloaderConfig) ArtifactDownloader {
 	return ArtifactDownloader{
 		logger:    l,
 		apiClient: ac,
@@ -90,31 +92,31 @@ func (a *ArtifactDownloader) Download() error {
 						Bucket:      artifact.UploadDestination,
 						Destination: downloadDestination,
 						Retries:     5,
-						DebugHTTP:   a.apiClient.DebugHTTP,
+						DebugHTTP:   a.conf.DebugHTTP,
 					}).Start()
 				} else if strings.HasPrefix(artifact.UploadDestination, "gs://") {
 					err = NewGSDownloader(a.logger, GSDownloaderConfig{
 						Path:        artifact.Path,
 						Bucket:      artifact.UploadDestination,
 						Destination: downloadDestination,
 						Retries:     5,
-						DebugHTTP:   a.apiClient.DebugHTTP,
+						DebugHTTP:   a.conf.DebugHTTP,
 					}).Start()
 				} else if strings.HasPrefix(artifact.UploadDestination, "rt://") {
 					err = NewArtifactoryDownloader(a.logger, ArtifactoryDownloaderConfig{
 						Path:        artifact.Path,
 						Repository:  artifact.UploadDestination,
 						Destination: downloadDestination,
 						Retries:     5,
-						DebugHTTP:   a.apiClient.DebugHTTP,
+						DebugHTTP:   a.conf.DebugHTTP,
 					}).Start()
 				} else {
 					err = NewDownload(a.logger, http.DefaultClient, DownloadConfig{
 						URL:         artifact.URL,
 						Path:        artifact.Path,
 						Destination: downloadDestination,
 						Retries:     5,
-						DebugHTTP:   a.apiClient.DebugHTTP,
+						DebugHTTP:   a.conf.DebugHTTP,
 					}).Start()
 				}
 

agent/artifact_downloader_test.go

@@ -2,10 +2,12 @@ package agent
 
 import (
 	"fmt"
-	"github.com/buildkite/agent/logger"
 	"net/http"
 	"net/http/httptest"
 	"testing"
+
+	"github.com/buildkite/agent/api"
+	"github.com/buildkite/agent/logger"
 )
 
 func TestArtifactDownloaderConnectsToEndpoint(t *testing.T) {
@@ -27,7 +29,7 @@ func TestArtifactDownloaderConnectsToEndpoint(t *testing.T) {
 	}))
 	defer server.Close()
 
-	ac := NewAPIClient(logger.Discard, APIClientConfig{
+	ac := api.NewClient(logger.Discard, api.Config{
 		Endpoint: server.URL,
 		Token:    `llamasforever`,
 	})

agent/artifact_searcher.go

@@ -10,13 +10,13 @@ type ArtifactSearcher struct {
 	logger logger.Logger
 
 	// The APIClient that will be used when uploading jobs
-	apiClient *api.Client
+	apiClient APIClient
 
 	// The ID of the Build that these artifacts belong to
 	buildID string
 }
 
-func NewArtifactSearcher(l logger.Logger, ac *api.Client, buildID string) *ArtifactSearcher {
+func NewArtifactSearcher(l logger.Logger, ac APIClient, buildID string) *ArtifactSearcher {
 	return &ArtifactSearcher{
 		logger:    l,
 		apiClient: ac,
@@ -31,7 +31,7 @@ func (a *ArtifactSearcher) Search(query string, scope string) ([]*api.Artifact,
 		a.logger.Info("Searching for artifacts: \"%s\" within step: \"%s\"", query, scope)
 	}
 
-	artifacts, _, err := a.apiClient.Artifacts.Search(a.buildID, &api.ArtifactSearchOptions{
+	artifacts, _, err := a.apiClient.SearchArtifacts(a.buildID, &api.ArtifactSearchOptions{
 		Query: query,
 		Scope: scope,
 	})