chore: install state machine with final states (#2334)

* chore: install state machine with final states

Author: emosbaugh

api/README.md

@@ -12,9 +12,15 @@ The root directory contains the main API setup files and request handlers.
 #### `/controllers`
 Contains the business logic for different API endpoints. Each controller package focuses on a specific domain of functionality or workflow (e.g., authentication, console, install, upgrade, join, etc.) and implements the core business logic for that domain or workflow. Controllers can utilize multiple managers with each manager handling a specific subdomain of functionality.
 
+#### `/internal`
+Contains shared utilities and helper packages that provide common functionality used across different parts of the API. This includes both general-purpose utilities and domain-specific helpers.
+
 #### `/internal/managers`
 Each manager is responsible for a specific subdomain of functionality and provides a clean, thread-safe interface for controllers to interact with. For example, the Preflight Manager manages system requirement checks and validation.
 
+#### `/internal/statemachine`
+The statemachine is used by controllers to capture workflow state and enforce valid transitions.
+
 #### `/types`
 Defines the core data structures and types used throughout the API. This includes:
 - Request and response types
@@ -30,7 +36,7 @@ Contains Swagger-generated API documentation. This includes:
 - API operation descriptions
 
 #### `/pkg`
-Contains shared utilities and helper packages that provide common functionality used across different parts of the API. This includes both general-purpose utilities and domain-specific helpers.
+Contains helper packages that can be used by packages external to the API.
 
 #### `/client`
 Provides a client library for interacting with the API. The client package implements a clean interface for making API calls and handling responses, making it easy to integrate with the API from other parts of the system.

api/api.go

@@ -48,7 +48,7 @@ type API struct {
 	rc                runtimeconfig.RuntimeConfig
 	releaseData       *release.ReleaseData
 	tlsConfig         types.TLSConfig
-	licenseFile       string
+	license           []byte
 	airgapBundle      string
 	configValues      string
 	endUserConfig     *ecv1beta1.Config
@@ -113,9 +113,9 @@ func WithTLSConfig(tlsConfig types.TLSConfig) APIOption {
 	}
 }
 
-func WithLicenseFile(licenseFile string) APIOption {
+func WithLicense(license []byte) APIOption {
 	return func(a *API) {
-		a.licenseFile = licenseFile
+		a.license = license
 	}
 }
 
@@ -188,7 +188,7 @@ func New(password string, opts ...APIOption) (*API, error) {
 			install.WithReleaseData(api.releaseData),
 			install.WithPassword(password),
 			install.WithTLSConfig(api.tlsConfig),
-			install.WithLicenseFile(api.licenseFile),
+			install.WithLicense(api.license),
 			install.WithAirgapBundle(api.airgapBundle),
 			install.WithConfigValues(api.configValues),
 			install.WithEndUserConfig(api.endUserConfig),

api/controllers/install/controller.go

@@ -7,6 +7,7 @@ import (
 	"github.com/replicatedhq/embedded-cluster/api/internal/managers/infra"
 	"github.com/replicatedhq/embedded-cluster/api/internal/managers/installation"
 	"github.com/replicatedhq/embedded-cluster/api/internal/managers/preflight"
+	"github.com/replicatedhq/embedded-cluster/api/internal/statemachine"
 	"github.com/replicatedhq/embedded-cluster/api/internal/store"
 	"github.com/replicatedhq/embedded-cluster/api/pkg/logger"
 	"github.com/replicatedhq/embedded-cluster/api/pkg/utils"
@@ -40,24 +41,26 @@ type RunHostPreflightsOptions struct {
 var _ Controller = (*InstallController)(nil)
 
 type InstallController struct {
-	install              types.Install
-	store                store.Store
 	installationManager  installation.InstallationManager
 	hostPreflightManager preflight.HostPreflightManager
 	infraManager         infra.InfraManager
-	rc                   runtimeconfig.RuntimeConfig
-	logger               logrus.FieldLogger
 	hostUtils            hostutils.HostUtilsInterface
 	netUtils             utils.NetUtils
 	metricsReporter      metrics.ReporterInterface
 	releaseData          *release.ReleaseData
 	password             string
 	tlsConfig            types.TLSConfig
-	licenseFile          string
+	license              []byte
 	airgapBundle         string
 	configValues         string
 	endUserConfig        *ecv1beta1.Config
-	mu                   sync.RWMutex
+
+	install      types.Install
+	store        store.Store
+	rc           runtimeconfig.RuntimeConfig
+	stateMachine statemachine.Interface
+	logger       logrus.FieldLogger
+	mu           sync.RWMutex
 }
 
 type InstallControllerOption func(*InstallController)
@@ -110,9 +113,9 @@ func WithTLSConfig(tlsConfig types.TLSConfig) InstallControllerOption {
 	}
 }
 
-func WithLicenseFile(licenseFile string) InstallControllerOption {
+func WithLicense(license []byte) InstallControllerOption {
 	return func(c *InstallController) {
-		c.licenseFile = licenseFile
+		c.license = license
 	}
 }
 
@@ -152,19 +155,22 @@ func WithInfraManager(infraManager infra.InfraManager) InstallControllerOption {
 	}
 }
 
-func NewInstallController(opts ...InstallControllerOption) (*InstallController, error) {
-	controller := &InstallController{}
-
-	for _, opt := range opts {
-		opt(controller)
+func WithStateMachine(stateMachine statemachine.Interface) InstallControllerOption {
+	return func(c *InstallController) {
+		c.stateMachine = stateMachine
 	}
+}
 
-	if controller.rc == nil {
-		controller.rc = runtimeconfig.New(nil)
+func NewInstallController(opts ...InstallControllerOption) (*InstallController, error) {
+	controller := &InstallController{
+		store:        store.NewMemoryStore(),
+		rc:           runtimeconfig.New(nil),
+		logger:       logger.NewDiscardLogger(),
+		stateMachine: NewStateMachine(),
 	}
 
-	if controller.logger == nil {
-		controller.logger = logger.NewDiscardLogger()
+	for _, opt := range opts {
+		opt(controller)
 	}
 
 	if controller.hostUtils == nil {
@@ -177,15 +183,11 @@ func NewInstallController(opts ...InstallControllerOption) (*InstallController,
 		controller.netUtils = utils.NewNetUtils()
 	}
 
-	if controller.store == nil {
-		controller.store = store.NewMemoryStore()
-	}
-
 	if controller.installationManager == nil {
 		controller.installationManager = installation.NewInstallationManager(
 			installation.WithLogger(controller.logger),
 			installation.WithInstallationStore(controller.store.InstallationStore()),
-			installation.WithLicenseFile(controller.licenseFile),
+			installation.WithLicense(controller.license),
 			installation.WithAirgapBundle(controller.airgapBundle),
 			installation.WithHostUtils(controller.hostUtils),
 			installation.WithNetUtils(controller.netUtils),
@@ -207,7 +209,7 @@ func NewInstallController(opts ...InstallControllerOption) (*InstallController,
 			infra.WithInfraStore(controller.store.InfraStore()),
 			infra.WithPassword(controller.password),
 			infra.WithTLSConfig(controller.tlsConfig),
-			infra.WithLicenseFile(controller.licenseFile),
+			infra.WithLicense(controller.license),
 			infra.WithAirgapBundle(controller.airgapBundle),
 			infra.WithConfigValues(controller.configValues),
 			infra.WithReleaseData(controller.releaseData),