Merge remote-tracking branch 'origin/master' into variable-sets

Author: leg100

internal/agent/agent.go

@@ -13,7 +13,6 @@ import (
 
 	"github.com/go-logr/logr"
 	"github.com/leg100/otf/internal"
-	"github.com/leg100/otf/internal/client"
 	"golang.org/x/sync/errgroup"
 )
 
@@ -33,9 +32,9 @@ var (
 // agent processes runs.
 type agent struct {
 	Config
-	client.Client
 	logr.Logger
 
+	client
 	spooler              // spools new run events
 	*terminator          // terminates runs
 	Downloader           // terraform cli downloader
@@ -45,7 +44,7 @@ type agent struct {
 }
 
 // NewAgent is the constructor for an agent
-func NewAgent(logger logr.Logger, app client.Client, cfg Config) (*agent, error) {
+func NewAgent(logger logr.Logger, app client, cfg Config) (*agent, error) {
 	if cfg.Concurrency == 0 {
 		cfg.Concurrency = DefaultConcurrency
 	}
@@ -65,7 +64,7 @@ func NewAgent(logger logr.Logger, app client.Client, cfg Config) (*agent, error)
 	pathFinder := newTerraformPathFinder(cfg.TerraformBinDir)
 
 	agent := &agent{
-		Client:              app,
+		client:              app,
 		Config:              cfg,
 		Logger:              logger,
 		envs:                DefaultEnvs,
@@ -90,7 +89,7 @@ func NewAgent(logger logr.Logger, app client.Client, cfg Config) (*agent, error)
 // via http
 func NewExternalAgent(ctx context.Context, logger logr.Logger, cfg ExternalConfig) (*agent, error) {
 	// Sends unauthenticated ping to server
-	app, err := client.New(cfg.HTTPConfig)
+	app, err := newClient(cfg.HTTPConfig)
 	if err != nil {
 		return nil, err
 	}

internal/agent/client.go

@@ -0,0 +1,101 @@
+package agent
+
+import (
+	"context"
+
+	"github.com/leg100/otf/internal"
+	"github.com/leg100/otf/internal/configversion"
+	"github.com/leg100/otf/internal/http"
+	"github.com/leg100/otf/internal/logs"
+	"github.com/leg100/otf/internal/pubsub"
+	"github.com/leg100/otf/internal/resource"
+	"github.com/leg100/otf/internal/run"
+	"github.com/leg100/otf/internal/state"
+	"github.com/leg100/otf/internal/tokens"
+	"github.com/leg100/otf/internal/variable"
+	"github.com/leg100/otf/internal/workspace"
+)
+
+var (
+	_ client = (*LocalClient)(nil)
+	_ client = (*remoteClient)(nil)
+)
+
+type (
+	// client allows the agent to communicate with the server endpoints.
+	client interface {
+		GetWorkspace(ctx context.Context, workspaceID string) (*workspace.Workspace, error)
+		ListVariables(ctx context.Context, workspaceID string) ([]*variable.Variable, error)
+		GetPlanFile(ctx context.Context, id string, format run.PlanFormat) ([]byte, error)
+		UploadPlanFile(ctx context.Context, id string, plan []byte, format run.PlanFormat) error
+		GetLockFile(ctx context.Context, id string) ([]byte, error)
+		UploadLockFile(ctx context.Context, id string, lockFile []byte) error
+		ListRuns(ctx context.Context, opts run.ListOptions) (*resource.Page[*run.Run], error)
+		StartPhase(ctx context.Context, id string, phase internal.PhaseType, opts run.PhaseStartOptions) (*run.Run, error)
+		FinishPhase(ctx context.Context, id string, phase internal.PhaseType, opts run.PhaseFinishOptions) (*run.Run, error)
+		DownloadConfig(ctx context.Context, id string) ([]byte, error)
+		Watch(context.Context, run.WatchOptions) (<-chan pubsub.Event, error)
+		CreateStateVersion(ctx context.Context, opts state.CreateStateVersionOptions) (*state.Version, error)
+		DownloadCurrentState(ctx context.Context, workspaceID string) ([]byte, error)
+		DeleteStateVersion(ctx context.Context, svID string) error
+		DownloadState(ctx context.Context, svID string) ([]byte, error)
+		Hostname() string
+
+		tokens.RunTokenService
+		internal.PutChunkService
+	}
+
+	// LocalClient is the client for an internal agent.
+	LocalClient struct {
+		tokens.TokensService
+		variable.VariableService
+		state.StateService
+		workspace.WorkspaceService
+		internal.HostnameService
+		configversion.ConfigurationVersionService
+		run.RunService
+		logs.LogsService
+	}
+
+	// remoteClient is the client for an external agent.
+	remoteClient struct {
+		*http.Client
+		http.Config
+
+		*stateClient
+		*configClient
+		*variableClient
+		*tokensClient
+		*workspaceClient
+		*runClient
+		*logsClient
+	}
+
+	stateClient     = state.Client
+	configClient    = configversion.Client
+	variableClient  = variable.Client
+	tokensClient    = tokens.Client
+	workspaceClient = workspace.Client
+	runClient       = run.Client
+	logsClient      = logs.Client
+)
+
+// New constructs a client that uses http to remotely invoke OTF
+// services.
+func newClient(config http.Config) (*remoteClient, error) {
+	httpClient, err := http.NewClient(config)
+	if err != nil {
+		return nil, err
+	}
+
+	return &remoteClient{
+		Client:          httpClient,
+		stateClient:     &stateClient{JSONAPIClient: httpClient},
+		configClient:    &configClient{JSONAPIClient: httpClient},
+		variableClient:  &variableClient{JSONAPIClient: httpClient},
+		tokensClient:    &tokensClient{JSONAPIClient: httpClient},
+		workspaceClient: &workspaceClient{JSONAPIClient: httpClient},
+		runClient:       &runClient{JSONAPIClient: httpClient, Config: config},
+		logsClient:      &logsClient{JSONAPIClient: httpClient},
+	}, nil
+}

internal/agent/environment.go

@@ -9,7 +9,6 @@ import (
 	"github.com/go-logr/logr"
 	"github.com/hashicorp/go-multierror"
 	"github.com/leg100/otf/internal"
-	"github.com/leg100/otf/internal/client"
 	"github.com/leg100/otf/internal/logs"
 	"github.com/leg100/otf/internal/run"
 	"github.com/leg100/otf/internal/tokens"
@@ -23,7 +22,7 @@ import (
 // TODO: this is a pointless abstraction; refactor it out into worker's
 // handle() func.
 type environment struct {
-	client.Client
+	client
 	logr.Logger
 	Downloader // Downloader for workers to download terraform cli on demand
 
@@ -88,7 +87,7 @@ func newEnvironment(
 
 	env := &environment{
 		Logger:     logger,
-		Client:     agent,
+		client:     agent,
 		Downloader: agent,
 		out:        writer,
 		workdir:    wd,

internal/agent/spooler.go

@@ -7,7 +7,6 @@ import (
 
 	"github.com/go-logr/logr"
 	"github.com/leg100/otf/internal"
-	"github.com/leg100/otf/internal/client"
 	"github.com/leg100/otf/internal/pubsub"
 	"github.com/leg100/otf/internal/resource"
 	"github.com/leg100/otf/internal/run"
@@ -34,9 +33,9 @@ type (
 	// spoolerDaemon implements Spooler, receiving runs with either a queued plan or
 	// apply, and converting them into spooled jobs.
 	spoolerDaemon struct {
-		queue         chan *run.Run    // Queue of queued jobs
-		cancelations  chan cancelation // Queue of cancelation requests
-		client.Client                  // Application for retrieving queued runs
+		queue        chan *run.Run    // Queue of queued jobs
+		cancelations chan cancelation // Queue of cancelation requests
+		client                        // Application for retrieving queued runs
 		logr.Logger
 		Config
 	}
@@ -48,11 +47,11 @@ type (
 )
 
 // newSpooler populates a Spooler with queued runs
-func newSpooler(app client.Client, logger logr.Logger, cfg Config) *spoolerDaemon {
+func newSpooler(app client, logger logr.Logger, cfg Config) *spoolerDaemon {
 	return &spoolerDaemon{
 		queue:        make(chan *run.Run, spoolerCapacity),
 		cancelations: make(chan cancelation, spoolerCapacity),
-		Client:       app,
+		client:       app,
 		Logger:       logger,
 		Config:       cfg,
 	}

internal/agent/spooler_test_helper.go

@@ -3,7 +3,6 @@ package agent
 import (
 	"context"
 
-	"github.com/leg100/otf/internal/client"
 	"github.com/leg100/otf/internal/pubsub"
 	"github.com/leg100/otf/internal/resource"
 	"github.com/leg100/otf/internal/run"
@@ -13,7 +12,7 @@ type fakeSpoolerApp struct {
 	runs   []*run.Run
 	events chan pubsub.Event
 
-	client.Client
+	client
 }
 
 func (a *fakeSpoolerApp) ListRuns(ctx context.Context, opts run.ListOptions) (*resource.Page[*run.Run], error) {

internal/client/client.go

@@ -13,7 +13,6 @@ import (
 	"github.com/leg100/otf/internal/agent"
 	"github.com/leg100/otf/internal/auth"
 	"github.com/leg100/otf/internal/authenticator"
-	"github.com/leg100/otf/internal/client"
 	"github.com/leg100/otf/internal/cloud"
 	"github.com/leg100/otf/internal/configversion"
 	"github.com/leg100/otf/internal/disco"
@@ -240,11 +239,9 @@ func New(ctx context.Context, logger logr.Logger, cfg Config) (*Daemon, error) {
 
 	agent, err := agent.NewAgent(
 		logger.WithValues("component", "agent"),
-		client.LocalClient{
-			AuthService:                 authService,
+		agent.LocalClient{
 			TokensService:               tokensService,
 			WorkspaceService:            workspaceService,
-			OrganizationService:         orgService,
 			VariableService:             variableService,
 			StateService:                stateService,
 			HostnameService:             hostnameService,