Run preflights in manager UI / API

.github/workflows/ci.yaml

@@ -2,6 +2,7 @@ name: CI
 
 on:
   pull_request: {}
+
   push:
     branches:
       - main

api/Makefile

@@ -8,3 +8,7 @@ swagger: swag
 .PHONY: swag
 swag:
 	which swag || (go install github.com/swaggo/swag/v2/cmd/swag@latest)
+
+.PHONY: unit-tests
+unit-tests:
+	go test -v ./...

api/README.md

@@ -10,7 +10,10 @@ The root directory contains the main API setup files and request handlers.
 ### Subpackages
 
 #### `/controllers`
-Contains the business logic for different API endpoints. Each controller package focuses on a specific domain of functionality (e.g., authentication, console, installation) and implements the core business logic for that domain.
+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/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.
 
 #### `/types`
 Defines the core data structures and types used throughout the API. This includes:
@@ -36,12 +39,12 @@ Provides a client library for interacting with the API. The client package imple
 
 1. **New API Endpoints**:
    - Add route definitions in the root API setup
-   - Create corresponding controller in `/controllers`
+   - Create or update corresponding controller in `/controllers`
    - Define request/response types in `/types`
 
 2. **New Business Logic**:
-   - Place in appropriate controller under `/controllers`
-   - Share common logic in `/pkg` if used across multiple controllers
+   - Place in appropriate controller under `/controllers` if the logic represents a distinct domain or workflow
+   - Place in appropriate manager under `/internal/managers` if the logic represents a distinct subdomain
 
 3. **New Types/Models**:
    - Add to `/types` directory

api/api.go

@@ -11,7 +11,12 @@ import (
 	"github.com/replicatedhq/embedded-cluster/api/controllers/console"
 	"github.com/replicatedhq/embedded-cluster/api/controllers/install"
 	"github.com/replicatedhq/embedded-cluster/api/docs"
+	"github.com/replicatedhq/embedded-cluster/api/pkg/logger"
 	"github.com/replicatedhq/embedded-cluster/api/types"
+	"github.com/replicatedhq/embedded-cluster/pkg-new/hostutils"
+	"github.com/replicatedhq/embedded-cluster/pkg/metrics"
+	"github.com/replicatedhq/embedded-cluster/pkg/release"
+	"github.com/replicatedhq/embedded-cluster/pkg/runtimeconfig"
 	"github.com/sirupsen/logrus"
 	httpSwagger "github.com/swaggo/http-swagger/v2"
 )
@@ -38,8 +43,14 @@ type API struct {
 	authController    auth.Controller
 	consoleController console.Controller
 	installController install.Controller
+	rc                runtimeconfig.RuntimeConfig
+	releaseData       *release.ReleaseData
+	licenseFile       string
+	airgapBundle      string
 	configChan        chan<- *types.InstallationConfig
 	logger            logrus.FieldLogger
+	hostUtils         hostutils.HostUtilsInterface
+	metricsReporter   metrics.ReporterInterface
 }
 
 type APIOption func(*API)
@@ -62,24 +73,79 @@ func WithInstallController(installController install.Controller) APIOption {
 	}
 }
 
+func WithRuntimeConfig(rc runtimeconfig.RuntimeConfig) APIOption {
+	return func(a *API) {
+		a.rc = rc
+	}
+}
+
 func WithLogger(logger logrus.FieldLogger) APIOption {
 	return func(a *API) {
 		a.logger = logger
 	}
 }
 
+func WithHostUtils(hostUtils hostutils.HostUtilsInterface) APIOption {
+	return func(a *API) {
+		a.hostUtils = hostUtils
+	}
+}
+
+func WithMetricsReporter(metricsReporter metrics.ReporterInterface) APIOption {
+	return func(a *API) {
+		a.metricsReporter = metricsReporter
+	}
+}
+
+func WithReleaseData(releaseData *release.ReleaseData) APIOption {
+	return func(a *API) {
+		a.releaseData = releaseData
+	}
+}
+
 func WithConfigChan(configChan chan<- *types.InstallationConfig) APIOption {
 	return func(a *API) {
 		a.configChan = configChan
 	}
 }
 
+func WithLicenseFile(licenseFile string) APIOption {
+	return func(a *API) {
+		a.licenseFile = licenseFile
+	}
+}
+
+func WithAirgapBundle(airgapBundle string) APIOption {
+	return func(a *API) {
+		a.airgapBundle = airgapBundle
+	}
+}
+
 func New(password string, opts ...APIOption) (*API, error) {
 	api := &API{}
+
 	for _, opt := range opts {
 		opt(api)
 	}
 
+	if api.rc == nil {
+		api.rc = runtimeconfig.New(nil)
+	}
+
+	if api.logger == nil {
+		l, err := logger.NewLogger()
+		if err != nil {
+			return nil, fmt.Errorf("create logger: %w", err)
+		}
+		api.logger = l
+	}
+
+	if api.hostUtils == nil {
+		api.hostUtils = hostutils.New(
+			hostutils.WithLogger(api.logger),
+		)
+	}
+
 	if api.authController == nil {
 		authController, err := auth.NewAuthController(password)
 		if err != nil {
@@ -97,17 +163,21 @@ func New(password string, opts ...APIOption) (*API, error) {
 	}
 
 	if api.installController == nil {
-		installController, err := install.NewInstallController()
+		installController, err := install.NewInstallController(
+			install.WithRuntimeConfig(api.rc),
+			install.WithLogger(api.logger),
+			install.WithHostUtils(api.hostUtils),
+			install.WithMetricsReporter(api.metricsReporter),
+			install.WithReleaseData(api.releaseData),
+			install.WithLicenseFile(api.licenseFile),
+			install.WithAirgapBundle(api.airgapBundle),
+		)
 		if err != nil {
 			return nil, fmt.Errorf("new install controller: %w", err)
 		}
 		api.installController = installController
 	}
 
-	if api.logger == nil {
-		api.logger = NewDiscardLogger()
-	}
-
 	return api, nil
 }
 
@@ -129,10 +199,19 @@ func (a *API) RegisterRoutes(router *mux.Router) {
 	authenticatedRouter.Use(a.authMiddleware)
 
 	installRouter := authenticatedRouter.PathPrefix("/install").Subrouter()
-	installRouter.HandleFunc("", a.getInstall).Methods("GET")
-	installRouter.HandleFunc("/config", a.setInstallConfig).Methods("POST")
-	installRouter.HandleFunc("/status", a.setInstallStatus).Methods("POST")
+	installRouter.HandleFunc("/installation/config", a.getInstallInstallationConfig).Methods("GET")
+	installRouter.HandleFunc("/installation/status", a.getInstallInstallationStatus).Methods("GET")
+	installRouter.HandleFunc("/installation/configure", a.postInstallConfigureInstallation).Methods("POST")
+
+	installRouter.HandleFunc("/host-preflights/status", a.getInstallHostPreflightsStatus).Methods("GET")
+	installRouter.HandleFunc("/host-preflights/run", a.postInstallRunHostPreflights).Methods("POST")
+
+	installRouter.HandleFunc("/node/setup", a.postInstallSetupNode).Methods("POST")
+
+	// TODO (@salah): remove this once the cli isn't responsible for setting the install status
+	// and the ui isn't polling for it to know if the entire install is complete
 	installRouter.HandleFunc("/status", a.getInstallStatus).Methods("GET")
+	installRouter.HandleFunc("/status", a.setInstallStatus).Methods("POST")
 
 	consoleRouter := authenticatedRouter.PathPrefix("/console").Subrouter()
 	consoleRouter.HandleFunc("/available-network-interfaces", a.getListAvailableNetworkInterfaces).Methods("GET")

api/api_test.go

@@ -6,6 +6,7 @@ import (
 	"net/http/httptest"
 	"testing"
 
+	"github.com/replicatedhq/embedded-cluster/api/pkg/logger"
 	"github.com/replicatedhq/embedded-cluster/api/types"
 	"github.com/stretchr/testify/assert"
 )
@@ -84,7 +85,7 @@ func TestAPI_jsonError(t *testing.T) {
 
 			// Call the JSON method
 			api := &API{
-				logger: NewDiscardLogger(),
+				logger: logger.NewDiscardLogger(),
 			}
 			api.jsonError(rec, httptest.NewRequest("GET", "/api/test", nil), tt.apiErr)
 

api/client/client.go

@@ -11,9 +11,10 @@ import (
 
 type Client interface {
 	Authenticate(password string) error
-	GetInstall() (*types.Install, error)
-	SetInstallConfig(config types.InstallationConfig) (*types.Install, error)
-	SetInstallStatus(status types.InstallationStatus) (*types.Install, error)
+	GetInstallationConfig() (*types.InstallationConfig, error)
+	GetInstallationStatus() (*types.Status, error)
+	ConfigureInstallation(config *types.InstallationConfig) (*types.Status, error)
+	SetInstallStatus(status *types.Status) (*types.Status, error)
 }
 
 type client struct {

api/client/client_test.go

@@ -99,33 +99,31 @@ func TestLogin(t *testing.T) {
 	assert.Equal(t, "Invalid password", apiErr.Message)
 }
 
-func TestGetInstall(t *testing.T) {
+func TestGetInstallationConfig(t *testing.T) {
 	// Create a test server
 	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		assert.Equal(t, "GET", r.Method)
-		assert.Equal(t, "/api/install", r.URL.Path)
+		assert.Equal(t, "/api/install/installation/config", r.URL.Path)
 
 		assert.Equal(t, "application/json", r.Header.Get("Content-Type"))
 		assert.Equal(t, "Bearer test-token", r.Header.Get("Authorization"))
 
 		// Return successful response
 		w.WriteHeader(http.StatusOK)
-		json.NewEncoder(w).Encode(types.Install{
-			Config: types.InstallationConfig{
-				GlobalCIDR:       "10.0.0.0/24",
-				AdminConsolePort: 8080,
-			},
+		json.NewEncoder(w).Encode(types.InstallationConfig{
+			GlobalCIDR:       "10.0.0.0/24",
+			AdminConsolePort: 8080,
 		})
 	}))
 	defer server.Close()
 
 	// Test successful get
 	c := New(server.URL, WithToken("test-token"))
-	install, err := c.GetInstall()
+	config, err := c.GetInstallationConfig()
 	assert.NoError(t, err)
-	assert.NotNil(t, install)
-	assert.Equal(t, "10.0.0.0/24", install.Config.GlobalCIDR)
-	assert.Equal(t, 8080, install.Config.AdminConsolePort)
+	assert.NotNil(t, config)
+	assert.Equal(t, "10.0.0.0/24", config.GlobalCIDR)
+	assert.Equal(t, 8080, config.AdminConsolePort)
 
 	// Test error response
 	errorServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
@@ -138,22 +136,22 @@ func TestGetInstall(t *testing.T) {
 	defer errorServer.Close()
 
 	c = New(errorServer.URL, WithToken("test-token"))
-	install, err = c.GetInstall()
+	config, err = c.GetInstallationConfig()
 	assert.Error(t, err)
-	assert.Nil(t, install)
+	assert.Nil(t, config)
 
 	apiErr, ok := err.(*types.APIError)
 	require.True(t, ok, "Expected err to be of type *types.APIError")
 	assert.Equal(t, http.StatusInternalServerError, apiErr.StatusCode)
 	assert.Equal(t, "Internal Server Error", apiErr.Message)
 }
 
-func TestSetInstallConfig(t *testing.T) {
+func TestConfigureInstallation(t *testing.T) {
 	// Create a test server
 	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		// Check request method and path
 		assert.Equal(t, "POST", r.Method) // Corrected from PUT to POST based on implementation
-		assert.Equal(t, "/api/install/config", r.URL.Path)
+		assert.Equal(t, "/api/install/installation/configure", r.URL.Path)
 
 		// Check headers
 		assert.Equal(t, "application/json", r.Header.Get("Content-Type"))
@@ -166,22 +164,24 @@ func TestSetInstallConfig(t *testing.T) {
 
 		// Return successful response
 		w.WriteHeader(http.StatusOK)
-		json.NewEncoder(w).Encode(types.Install{
-			Config: config,
+		json.NewEncoder(w).Encode(types.Status{
+			State:       types.StateRunning,
+			Description: "Configuring installation",
 		})
 	}))
 	defer server.Close()
 
-	// Test successful set
+	// Test successful configure
 	c := New(server.URL, WithToken("test-token"))
 	config := types.InstallationConfig{
 		GlobalCIDR:              "20.0.0.0/24",
 		LocalArtifactMirrorPort: 9081,
 	}
-	install, err := c.SetInstallConfig(config)
+	status, err := c.ConfigureInstallation(&config)
 	assert.NoError(t, err)
-	assert.NotNil(t, install)
-	assert.Equal(t, config, install.Config)
+	assert.NotNil(t, status)
+	assert.Equal(t, types.StateRunning, status.State)
+	assert.Equal(t, "Configuring installation", status.Description)
 
 	// Test error response
 	errorServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
@@ -194,9 +194,9 @@ func TestSetInstallConfig(t *testing.T) {
 	defer errorServer.Close()
 
 	c = New(errorServer.URL, WithToken("test-token"))
-	install, err = c.SetInstallConfig(config)
+	status, err = c.ConfigureInstallation(&config)
 	assert.Error(t, err)
-	assert.Nil(t, install)
+	assert.Nil(t, status)
 
 	apiErr, ok := err.(*types.APIError)
 	require.True(t, ok, "Expected err to be of type *types.APIError")
@@ -214,28 +214,26 @@ func TestSetInstallStatus(t *testing.T) {
 		assert.Equal(t, "Bearer test-token", r.Header.Get("Authorization"))
 
 		// Decode request body
-		var status types.InstallationStatus
+		var status types.Status
 		err := json.NewDecoder(r.Body).Decode(&status)
 		require.NoError(t, err, "Failed to decode request body")
 
 		// Return successful response
 		w.WriteHeader(http.StatusOK)
-		json.NewEncoder(w).Encode(types.Install{
-			Status: status,
-		})
+		json.NewEncoder(w).Encode(status)
 	}))
 	defer server.Close()
 
 	// Test successful set
 	c := New(server.URL, WithToken("test-token"))
-	status := types.InstallationStatus{
-		State:       types.InstallationStateSucceeded,
+	status := &types.Status{
+		State:       types.StateSucceeded,
 		Description: "Installation successful",
 	}
-	install, err := c.SetInstallStatus(status)
+	newStatus, err := c.SetInstallStatus(status)
 	assert.NoError(t, err)
-	assert.NotNil(t, install)
-	assert.Equal(t, status, install.Status)
+	assert.NotNil(t, newStatus)
+	assert.Equal(t, status, newStatus)
 
 	// Test error response
 	errorServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
@@ -248,9 +246,9 @@ func TestSetInstallStatus(t *testing.T) {
 	defer errorServer.Close()
 
 	c = New(errorServer.URL, WithToken("test-token"))
-	install, err = c.SetInstallStatus(status)
+	newStatus, err = c.SetInstallStatus(status)
 	assert.Error(t, err)
-	assert.Nil(t, install)
+	assert.Nil(t, newStatus)
 
 	apiErr, ok := err.(*types.APIError)
 	require.True(t, ok, "Expected err to be of type *types.APIError")