feat: allow users to bypass host preflights in install wizard (#2335)

* add ignorehostpreflight to api installation config

* continue adding ignorehostpreflights flag to API

* add integration tests

* add modal to confirm skipping of preflights when ignorehostpreflights flag is passed

* revert files updated by buildtools

* update swagger docs

* fix unit tests

* restructure unit test

* debug issue with unit test

* debug issue with unit test

* remove test

* Update web/src/components/wizard/ValidationStep.tsx

Co-authored-by: Alex Parker <7272359+ajp-io@users.noreply.github.com>

* store ignorehostpreflight flag value in preflight response instead of installation config

* adding preflight validation to be used during infra setup

* continue adding preflight validation to infra setup

* update web to send request to ignore preflights when we start the installation

* add additional validationstep tests

* update swagger docs

* cleanup unused code

* add design doc

* simply preflight validatio and move to setupinfra on install controller

* consistently use allowignorehostpreflights in api

* simplify response for setupinfra

* update design doc

* revert buildtools files

* cleanup

* address feedback

* address feedback

* fix integration test

* fix failing test

* improve error handling

* returning bool for setupinfra no longer necessary

* improve setupinfra tests

* remove NewHostPreflights function that's not being used

* use mock manager with real controller for integration tests

* conditional render modal only when needed

* remove uneeded comment

* Update api/integration/infra_test.go

Co-authored-by: João Antunes <joao@replicated.com>

* remove modal test

* remove unneeded validation step test

* consolidate tests

* change api error handling to use returned handler from the API

* update tests to assert expected error from API

* update tests

* f

* fix tests

* fix lint

* make property name consistent

* revert uneeded changes

---------

Co-authored-by: Alex Parker <7272359+ajp-io@users.noreply.github.com>
Co-authored-by: João Antunes <joao@replicated.com>

Author: 3 people

api/api.go

@@ -42,19 +42,20 @@ import (
 // @externalDocs.description	OpenAPI
 // @externalDocs.url			https://swagger.io/resources/open-api/
 type API struct {
-	authController    auth.Controller
-	consoleController console.Controller
-	installController install.Controller
-	rc                runtimeconfig.RuntimeConfig
-	releaseData       *release.ReleaseData
-	tlsConfig         types.TLSConfig
-	license           []byte
-	airgapBundle      string
-	configValues      string
-	endUserConfig     *ecv1beta1.Config
-	logger            logrus.FieldLogger
-	hostUtils         hostutils.HostUtilsInterface
-	metricsReporter   metrics.ReporterInterface
+	authController            auth.Controller
+	consoleController         console.Controller
+	installController         install.Controller
+	rc                        runtimeconfig.RuntimeConfig
+	releaseData               *release.ReleaseData
+	tlsConfig                 types.TLSConfig
+	license                   []byte
+	airgapBundle              string
+	configValues              string
+	endUserConfig             *ecv1beta1.Config
+	allowIgnoreHostPreflights bool
+	logger                    logrus.FieldLogger
+	hostUtils                 hostutils.HostUtilsInterface
+	metricsReporter           metrics.ReporterInterface
 }
 
 type APIOption func(*API)
@@ -137,6 +138,12 @@ func WithEndUserConfig(endUserConfig *ecv1beta1.Config) APIOption {
 	}
 }
 
+func WithAllowIgnoreHostPreflights(allowIgnoreHostPreflights bool) APIOption {
+	return func(a *API) {
+		a.allowIgnoreHostPreflights = allowIgnoreHostPreflights
+	}
+}
+
 func New(password string, opts ...APIOption) (*API, error) {
 	api := &API{}
 
@@ -192,6 +199,7 @@ func New(password string, opts ...APIOption) (*API, error) {
 			install.WithAirgapBundle(api.airgapBundle),
 			install.WithConfigValues(api.configValues),
 			install.WithEndUserConfig(api.endUserConfig),
+			install.WithAllowIgnoreHostPreflights(api.allowIgnoreHostPreflights),
 		)
 		if err != nil {
 			return nil, fmt.Errorf("new install controller: %w", err)

api/controllers/install/controller.go

@@ -28,7 +28,7 @@ type Controller interface {
 	GetHostPreflightStatus(ctx context.Context) (types.Status, error)
 	GetHostPreflightOutput(ctx context.Context) (*types.HostPreflightsOutput, error)
 	GetHostPreflightTitles(ctx context.Context) ([]string, error)
-	SetupInfra(ctx context.Context) error
+	SetupInfra(ctx context.Context, ignoreHostPreflights bool) error
 	GetInfra(ctx context.Context) (types.Infra, error)
 	SetStatus(ctx context.Context, status types.Status) error
 	GetStatus(ctx context.Context) (types.Status, error)
@@ -55,12 +55,13 @@ type InstallController struct {
 	configValues         string
 	endUserConfig        *ecv1beta1.Config
 
-	install      types.Install
-	store        store.Store
-	rc           runtimeconfig.RuntimeConfig
-	stateMachine statemachine.Interface
-	logger       logrus.FieldLogger
-	mu           sync.RWMutex
+	install                   types.Install
+	store                     store.Store
+	rc                        runtimeconfig.RuntimeConfig
+	stateMachine              statemachine.Interface
+	logger                    logrus.FieldLogger
+	mu                        sync.RWMutex
+	allowIgnoreHostPreflights bool
 }
 
 type InstallControllerOption func(*InstallController)
@@ -137,6 +138,12 @@ func WithEndUserConfig(endUserConfig *ecv1beta1.Config) InstallControllerOption
 	}
 }
 
+func WithAllowIgnoreHostPreflights(allowIgnoreHostPreflights bool) InstallControllerOption {
+	return func(c *InstallController) {
+		c.allowIgnoreHostPreflights = allowIgnoreHostPreflights
+	}
+}
+
 func WithInstallationManager(installationManager installation.InstallationManager) InstallControllerOption {
 	return func(c *InstallController) {
 		c.installationManager = installationManager

api/controllers/install/controller_test.go

@@ -641,27 +641,33 @@ func TestGetInstallationStatus(t *testing.T) {
 
 func TestSetupInfra(t *testing.T) {
 	tests := []struct {
-		name          string
-		currentState  statemachine.State
-		expectedState statemachine.State
-		setupMocks    func(runtimeconfig.RuntimeConfig, *preflight.MockHostPreflightManager, *installation.MockInstallationManager, *infra.MockInfraManager, *metrics.MockReporter)
-		expectedErr   bool
+		name                            string
+		clientIgnoreHostPreflights      bool // From HTTP request
+		serverAllowIgnoreHostPreflights bool // From CLI flag
+		currentState                    statemachine.State
+		expectedState                   statemachine.State
+		setupMocks                      func(runtimeconfig.RuntimeConfig, *preflight.MockHostPreflightManager, *installation.MockInstallationManager, *infra.MockInfraManager, *metrics.MockReporter)
+		expectedErr                     error
 	}{
 		{
-			name:          "successful setup with passed preflights",
-			currentState:  StatePreflightsSucceeded,
-			expectedState: StateSucceeded,
+			name:                            "successful setup with passed preflights",
+			clientIgnoreHostPreflights:      false,
+			serverAllowIgnoreHostPreflights: true,
+			currentState:                    StatePreflightsSucceeded,
+			expectedState:                   StateSucceeded,
 			setupMocks: func(rc runtimeconfig.RuntimeConfig, pm *preflight.MockHostPreflightManager, im *installation.MockInstallationManager, fm *infra.MockInfraManager, r *metrics.MockReporter) {
 				mock.InOrder(
 					fm.On("Install", mock.Anything, rc).Return(nil),
 				)
 			},
-			expectedErr: false,
+			expectedErr: nil,
 		},
 		{
-			name:          "successful setup with failed preflights",
-			currentState:  StatePreflightsFailed,
-			expectedState: StateSucceeded,
+			name:                            "successful setup with failed preflights - ignored with CLI flag",
+			clientIgnoreHostPreflights:      true,
+			serverAllowIgnoreHostPreflights: true,
+			currentState:                    StatePreflightsFailed,
+			expectedState:                   StateSucceeded,
 			setupMocks: func(rc runtimeconfig.RuntimeConfig, pm *preflight.MockHostPreflightManager, im *installation.MockInstallationManager, fm *infra.MockInfraManager, r *metrics.MockReporter) {
 				preflightOutput := &types.HostPreflightsOutput{
 					Fail: []types.HostPreflightsRecord{
@@ -677,37 +683,73 @@ func TestSetupInfra(t *testing.T) {
 					fm.On("Install", mock.Anything, rc).Return(nil),
 				)
 			},
-			expectedErr: false,
+			expectedErr: nil,
 		},
 		{
-			name:          "preflight output error",
-			currentState:  StatePreflightsFailed,
-			expectedState: StatePreflightsFailed,
+			name:                            "failed setup with failed preflights - not ignored",
+			clientIgnoreHostPreflights:      false,
+			serverAllowIgnoreHostPreflights: true,
+			currentState:                    StatePreflightsFailed,
+			expectedState:                   StatePreflightsFailed,
+			setupMocks: func(rc runtimeconfig.RuntimeConfig, pm *preflight.MockHostPreflightManager, im *installation.MockInstallationManager, fm *infra.MockInfraManager, r *metrics.MockReporter) {
+			},
+			expectedErr: types.NewBadRequestError(ErrPreflightChecksFailed),
+		},
+		{
+			name:                            "preflight output error",
+			clientIgnoreHostPreflights:      true,
+			serverAllowIgnoreHostPreflights: true,
+			currentState:                    StatePreflightsFailed,
+			expectedState:                   StatePreflightsFailed,
 			setupMocks: func(rc runtimeconfig.RuntimeConfig, pm *preflight.MockHostPreflightManager, im *installation.MockInstallationManager, fm *infra.MockInfraManager, r *metrics.MockReporter) {
 				mock.InOrder(
 					pm.On("GetHostPreflightOutput", t.Context()).Return(nil, errors.New("get output error")),
 				)
 			},
-			expectedErr: true,
+			expectedErr: errors.New("any error"), // Just check that an error occurs, don't care about exact message
 		},
 		{
-			name:          "install infra error",
-			currentState:  StatePreflightsSucceeded,
-			expectedState: StateFailed,
+			name:                            "install infra error",
+			clientIgnoreHostPreflights:      false,
+			serverAllowIgnoreHostPreflights: true,
+			currentState:                    StatePreflightsSucceeded,
+			expectedState:                   StateFailed,
 			setupMocks: func(rc runtimeconfig.RuntimeConfig, pm *preflight.MockHostPreflightManager, im *installation.MockInstallationManager, fm *infra.MockInfraManager, r *metrics.MockReporter) {
 				mock.InOrder(
 					fm.On("Install", mock.Anything, rc).Return(errors.New("install error")),
 				)
 			},
-			expectedErr: false,
+			expectedErr: nil,
 		},
 		{
-			name:          "invalid state transition",
-			currentState:  StateInstallationConfigured,
-			expectedState: StateInstallationConfigured,
+			name:                            "invalid state transition",
+			clientIgnoreHostPreflights:      false,
+			serverAllowIgnoreHostPreflights: true,
+			currentState:                    StateInstallationConfigured,
+			expectedState:                   StateInstallationConfigured,
 			setupMocks: func(rc runtimeconfig.RuntimeConfig, pm *preflight.MockHostPreflightManager, im *installation.MockInstallationManager, fm *infra.MockInfraManager, r *metrics.MockReporter) {
 			},
-			expectedErr: true,
+			expectedErr: errors.New("invalid transition"), // Just check that an error occurs, don't care about exact message
+		},
+		{
+			name:                            "failed preflights with ignore flag but CLI flag disabled",
+			clientIgnoreHostPreflights:      true,
+			serverAllowIgnoreHostPreflights: false,
+			currentState:                    StatePreflightsFailed,
+			expectedState:                   StatePreflightsFailed,
+			setupMocks: func(rc runtimeconfig.RuntimeConfig, pm *preflight.MockHostPreflightManager, im *installation.MockInstallationManager, fm *infra.MockInfraManager, r *metrics.MockReporter) {
+			},
+			expectedErr: types.NewBadRequestError(ErrPreflightChecksFailed),
+		},
+		{
+			name:                            "failed preflights without ignore flag and CLI flag disabled",
+			clientIgnoreHostPreflights:      false,
+			serverAllowIgnoreHostPreflights: false,
+			currentState:                    StatePreflightsFailed,
+			expectedState:                   StatePreflightsFailed,
+			setupMocks: func(rc runtimeconfig.RuntimeConfig, pm *preflight.MockHostPreflightManager, im *installation.MockInstallationManager, fm *infra.MockInfraManager, r *metrics.MockReporter) {
+			},
+			expectedErr: types.NewBadRequestError(ErrPreflightChecksFailed),
 		},
 	}
 
@@ -732,13 +774,24 @@ func TestSetupInfra(t *testing.T) {
 				WithInstallationManager(mockInstallationManager),
 				WithInfraManager(mockInfraManager),
 				WithMetricsReporter(mockMetricsReporter),
+				WithAllowIgnoreHostPreflights(tt.serverAllowIgnoreHostPreflights),
 			)
 			require.NoError(t, err)
 
-			err = controller.SetupInfra(t.Context())
+			err = controller.SetupInfra(t.Context(), tt.clientIgnoreHostPreflights)
 
-			if tt.expectedErr {
+			if tt.expectedErr != nil {
 				require.Error(t, err)
+
+				// Check for specific error types
+				var expectedAPIErr *types.APIError
+				if errors.As(tt.expectedErr, &expectedAPIErr) {
+					// For API errors, check the exact type and status code
+					var actualAPIErr *types.APIError
+					require.True(t, errors.As(err, &actualAPIErr), "expected error to be of type *types.APIError, got %T", err)
+					assert.Equal(t, expectedAPIErr.StatusCode, actualAPIErr.StatusCode, "status codes should match")
+					assert.Contains(t, actualAPIErr.Error(), expectedAPIErr.Unwrap().Error(), "error messages should contain expected content")
+				}
 			} else {
 				require.NoError(t, err)
 

api/controllers/install/infra.go

@@ -2,15 +2,21 @@ package install
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"runtime/debug"
 
 	"github.com/replicatedhq/embedded-cluster/api/types"
 )
 
-func (c *InstallController) SetupInfra(ctx context.Context) (finalErr error) {
+var (
+	ErrPreflightChecksFailed      = errors.New("preflight checks failed")
+	ErrPreflightChecksNotComplete = errors.New("preflight checks not complete")
+)
+
+func (c *InstallController) SetupInfra(ctx context.Context, ignoreHostPreflights bool) (finalErr error) {
 	if c.stateMachine.CurrentState() == StatePreflightsFailed {
-		err := c.bypassPreflights(ctx)
+		err := c.bypassPreflights(ctx, ignoreHostPreflights)
 		if err != nil {
 			return fmt.Errorf("bypass preflights: %w", err)
 		}
@@ -68,7 +74,11 @@ func (c *InstallController) SetupInfra(ctx context.Context) (finalErr error) {
 	return nil
 }
 
-func (c *InstallController) bypassPreflights(ctx context.Context) error {
+func (c *InstallController) bypassPreflights(ctx context.Context, ignoreHostPreflights bool) error {
+	if !ignoreHostPreflights || !c.allowIgnoreHostPreflights {
+		return types.NewBadRequestError(ErrPreflightChecksFailed)
+	}
+
 	lock, err := c.stateMachine.AcquireLock()
 	if err != nil {
 		return types.NewConflictError(err)
@@ -85,6 +95,8 @@ func (c *InstallController) bypassPreflights(ctx context.Context) error {
 	if err != nil {
 		return fmt.Errorf("get install host preflight output: %w", err)
 	}
+
+	// Report that preflights were bypassed
 	if preflightOutput != nil {
 		c.metricsReporter.ReportPreflightsBypassed(ctx, preflightOutput)
 	}