mirror of
https://github.com/edgelesssys/constellation.git
synced 2025-05-06 08:15:48 -04:00
cli: state file validation (#2523)
* re-use `ReadFromFile` in `CreateOrRead` Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * [wip]: add constraints Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * [wip] error formatting Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * wip Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * formatted error messages Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * state file validation Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * linter fixes Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * allow overriding the constraints Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * dont validate on read Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * add pre-create constraints Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * [wip] Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * finish pre-init validation test Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * finish post-init validation Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * use state file validation in CLI Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * fix apply tests Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * Update internal/validation/errors.go Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com> * use transformator for tests * tidy * use empty check directly Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * Update cli/internal/state/state.go Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com> * Update cli/internal/state/state.go Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com> * Update cli/internal/state/state.go Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com> * Update cli/internal/state/state.go Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com> * conditional validation per CSP Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * tidy Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * fix rebase Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * add default case Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> * validate state-file as last input Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> --------- Signed-off-by: Moritz Sanft <58110325+msanft@users.noreply.github.com> Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com>
This commit is contained in:
Moritz Sanft
GitHub
parent
eaec73cca4
commit
744a605602
21 changed files with 1779 additions and 247 deletions
379
cli/internal/state/validation_test.go
Normal file
379
cli/internal/state/validation_test.go
Normal file
|
|
@ -0,0 +1,379 @@
|
|||
/*
|
||||
Copyright (c) Edgeless Systems GmbH
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-only
|
||||
*/
|
||||
|
||||
package state
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/edgelesssys/constellation/v2/internal/cloud/cloudprovider"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestPreCreateValidation(t *testing.T) {
|
||||
testCases := map[string]struct {
|
||||
stateFile func() *State
|
||||
wantErr bool
|
||||
errAssertions func(a *assert.Assertions, err error)
|
||||
}{
|
||||
"valid": {
|
||||
stateFile: func() *State {
|
||||
return &State{
|
||||
Version: Version1,
|
||||
}
|
||||
},
|
||||
},
|
||||
"invalid version": {
|
||||
stateFile: func() *State {
|
||||
return &State{
|
||||
Version: "invalid",
|
||||
}
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.version: invalid must be one of [v1]")
|
||||
},
|
||||
},
|
||||
"infrastructure not empty": {
|
||||
stateFile: func() *State {
|
||||
return &State{
|
||||
Version: Version1,
|
||||
Infrastructure: Infrastructure{
|
||||
ClusterEndpoint: "test",
|
||||
},
|
||||
}
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.infrastructure.clusterEndpoint: test must be empty")
|
||||
},
|
||||
},
|
||||
"cluster values not empty": {
|
||||
stateFile: func() *State {
|
||||
return &State{
|
||||
Version: Version1,
|
||||
ClusterValues: ClusterValues{
|
||||
ClusterID: "test",
|
||||
},
|
||||
}
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.clusterValues.clusterID: test must be empty")
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for name, tc := range testCases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
err := tc.stateFile().Validate(PreCreate, cloudprovider.Azure)
|
||||
if tc.wantErr {
|
||||
require.Error(t, err)
|
||||
if tc.errAssertions != nil {
|
||||
tc.errAssertions(assert.New(t), err)
|
||||
}
|
||||
} else {
|
||||
require.NoError(t, err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestPreInitValidation(t *testing.T) {
|
||||
validPreInitState := func() *State {
|
||||
s := defaultState()
|
||||
s.ClusterValues = ClusterValues{}
|
||||
return s
|
||||
}
|
||||
|
||||
testCases := map[string]struct {
|
||||
stateFile func() *State
|
||||
wantErr bool
|
||||
errAssertions func(a *assert.Assertions, err error)
|
||||
}{
|
||||
"valid": {
|
||||
stateFile: validPreInitState,
|
||||
},
|
||||
"invalid version": {
|
||||
stateFile: func() *State {
|
||||
s := validPreInitState()
|
||||
s.Version = "invalid"
|
||||
return s
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.version: invalid must be one of [v1]")
|
||||
},
|
||||
},
|
||||
"cluster endpoint invalid": {
|
||||
stateFile: func() *State {
|
||||
s := validPreInitState()
|
||||
s.Infrastructure.ClusterEndpoint = "invalid"
|
||||
return s
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.infrastructure.clusterEndpoint: invalid must be a valid DNS name")
|
||||
a.Contains(err.Error(), "validating State.infrastructure.clusterEndpoint: invalid must be a valid IP address")
|
||||
},
|
||||
},
|
||||
"in-cluster endpoint invalid": {
|
||||
stateFile: func() *State {
|
||||
s := validPreInitState()
|
||||
s.Infrastructure.InClusterEndpoint = "invalid"
|
||||
return s
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.infrastructure.inClusterEndpoint: invalid must be a valid DNS name")
|
||||
a.Contains(err.Error(), "validating State.infrastructure.inClusterEndpoint: invalid must be a valid IP address")
|
||||
},
|
||||
},
|
||||
"node ip cidr invalid": {
|
||||
stateFile: func() *State {
|
||||
s := validPreInitState()
|
||||
s.Infrastructure.IPCidrNode = "invalid"
|
||||
return s
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.infrastructure.ipCidrNode: invalid must be a valid CIDR")
|
||||
},
|
||||
},
|
||||
"uid empty": {
|
||||
stateFile: func() *State {
|
||||
s := validPreInitState()
|
||||
s.Infrastructure.UID = ""
|
||||
return s
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.infrastructure.uid: must not be empty")
|
||||
},
|
||||
},
|
||||
"name empty": {
|
||||
stateFile: func() *State {
|
||||
s := validPreInitState()
|
||||
s.Infrastructure.Name = ""
|
||||
return s
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.infrastructure.name: must not be empty")
|
||||
},
|
||||
},
|
||||
"gcp empty": {
|
||||
stateFile: func() *State {
|
||||
s := validPreInitState()
|
||||
s.Infrastructure.GCP = &GCP{}
|
||||
return s
|
||||
},
|
||||
},
|
||||
"gcp nil": {
|
||||
stateFile: func() *State {
|
||||
s := validPreInitState()
|
||||
s.Infrastructure.GCP = nil
|
||||
return s
|
||||
},
|
||||
},
|
||||
"gcp invalid": {
|
||||
stateFile: func() *State {
|
||||
s := validPreInitState()
|
||||
s.Infrastructure.GCP.IPCidrPod = "invalid"
|
||||
return s
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.infrastructure.gcp.ipCidrPod: invalid must be a valid CIDR")
|
||||
},
|
||||
},
|
||||
"azure empty": {
|
||||
stateFile: func() *State {
|
||||
s := validPreInitState()
|
||||
s.Infrastructure.Azure = &Azure{}
|
||||
return s
|
||||
},
|
||||
},
|
||||
"azure nil": {
|
||||
stateFile: func() *State {
|
||||
s := validPreInitState()
|
||||
s.Infrastructure.Azure = nil
|
||||
return s
|
||||
},
|
||||
},
|
||||
"azure invalid": {
|
||||
stateFile: func() *State {
|
||||
s := validPreInitState()
|
||||
s.Infrastructure.Azure.NetworkSecurityGroupName = ""
|
||||
return s
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.infrastructure.azure.networkSecurityGroupName: must not be empty")
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for name, tc := range testCases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
err := tc.stateFile().Validate(PreInit, cloudprovider.Azure)
|
||||
if tc.wantErr {
|
||||
require.Error(t, err)
|
||||
if tc.errAssertions != nil {
|
||||
tc.errAssertions(assert.New(t), err)
|
||||
}
|
||||
} else {
|
||||
require.NoError(t, err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestPostInitValidation(t *testing.T) {
|
||||
testCases := map[string]struct {
|
||||
stateFile func() *State
|
||||
provider cloudprovider.Provider
|
||||
wantErr bool
|
||||
errAssertions func(a *assert.Assertions, err error)
|
||||
}{
|
||||
"valid": {
|
||||
stateFile: defaultGCPState,
|
||||
provider: cloudprovider.GCP,
|
||||
},
|
||||
"invalid version": {
|
||||
stateFile: func() *State {
|
||||
s := defaultState()
|
||||
s.Version = "invalid"
|
||||
return s
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.version: invalid must be one of [v1]")
|
||||
},
|
||||
},
|
||||
"cluster endpoint invalid": {
|
||||
stateFile: func() *State {
|
||||
s := defaultState()
|
||||
s.Infrastructure.ClusterEndpoint = "invalid"
|
||||
return s
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.infrastructure.clusterEndpoint: invalid must be a valid DNS name")
|
||||
a.Contains(err.Error(), "validating State.infrastructure.clusterEndpoint: invalid must be a valid IP address")
|
||||
},
|
||||
},
|
||||
"in-cluster endpoint invalid": {
|
||||
stateFile: func() *State {
|
||||
s := defaultState()
|
||||
s.Infrastructure.InClusterEndpoint = "invalid"
|
||||
return s
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.infrastructure.inClusterEndpoint: invalid must be a valid DNS name")
|
||||
a.Contains(err.Error(), "validating State.infrastructure.inClusterEndpoint: invalid must be a valid IP address")
|
||||
},
|
||||
},
|
||||
"node ip cidr invalid": {
|
||||
stateFile: func() *State {
|
||||
s := defaultState()
|
||||
s.Infrastructure.IPCidrNode = "invalid"
|
||||
return s
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.infrastructure.ipCidrNode: invalid must be a valid CIDR")
|
||||
},
|
||||
},
|
||||
"uid empty": {
|
||||
stateFile: func() *State {
|
||||
s := defaultState()
|
||||
s.Infrastructure.UID = ""
|
||||
return s
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.infrastructure.uid: must not be empty")
|
||||
},
|
||||
},
|
||||
"name empty": {
|
||||
stateFile: func() *State {
|
||||
s := defaultState()
|
||||
s.Infrastructure.Name = ""
|
||||
return s
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.infrastructure.name: must not be empty")
|
||||
},
|
||||
},
|
||||
"gcp valid": {
|
||||
stateFile: func() *State {
|
||||
s := defaultGCPState()
|
||||
return s
|
||||
},
|
||||
provider: cloudprovider.GCP,
|
||||
},
|
||||
"azure valid": {
|
||||
stateFile: func() *State {
|
||||
s := defaultAzureState()
|
||||
return s
|
||||
},
|
||||
provider: cloudprovider.Azure,
|
||||
},
|
||||
"gcp, azure not nil": {
|
||||
stateFile: func() *State {
|
||||
s := defaultState()
|
||||
return s
|
||||
},
|
||||
provider: cloudprovider.GCP,
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "must be equal to <nil>")
|
||||
a.Contains(err.Error(), "must be empty")
|
||||
},
|
||||
},
|
||||
"azure, gcp not nil": {
|
||||
stateFile: func() *State {
|
||||
s := defaultState()
|
||||
return s
|
||||
},
|
||||
provider: cloudprovider.Azure,
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "must be equal to <nil>")
|
||||
a.Contains(err.Error(), "must be empty")
|
||||
},
|
||||
},
|
||||
"cluster values invalid": {
|
||||
stateFile: func() *State {
|
||||
s := defaultState()
|
||||
s.ClusterValues.ClusterID = ""
|
||||
return s
|
||||
},
|
||||
wantErr: true,
|
||||
errAssertions: func(a *assert.Assertions, err error) {
|
||||
a.Contains(err.Error(), "validating State.clusterValues.clusterID: must not be empty")
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for name, tc := range testCases {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
err := tc.stateFile().Validate(PostInit, tc.provider)
|
||||
if tc.wantErr {
|
||||
require.Error(t, err)
|
||||
if tc.errAssertions != nil {
|
||||
tc.errAssertions(assert.New(t), err)
|
||||
}
|
||||
} else {
|
||||
require.NoError(t, err)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue