mirror of
https://github.com/helmfile/helmfile.git
synced 2026-10-17 21:56:08 +02:00
Relax the forbid-env-with-releases policy for plain helmfile.yaml on v1 (#684)
This commit is contained in:
@@ -3,6 +3,7 @@ package policy
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/helmfile/helmfile/pkg/runtime"
|
||||
)
|
||||
@@ -12,13 +13,13 @@ var (
|
||||
)
|
||||
|
||||
// checkerFunc is a function that checks the helmState.
|
||||
type checkerFunc func(map[string]interface{}) (bool, error)
|
||||
type checkerFunc func(string, map[string]interface{}) (bool, error)
|
||||
|
||||
func forbidEnvironmentsWithReleases(releaseState map[string]interface{}) (bool, error) {
|
||||
func forbidEnvironmentsWithReleases(filePath string, releaseState map[string]interface{}) (bool, error) {
|
||||
// forbid environments and releases to be defined at the same yaml part
|
||||
_, hasEnvironments := releaseState["environments"]
|
||||
_, hasReleases := releaseState["releases"]
|
||||
if hasEnvironments && hasReleases {
|
||||
if hasEnvironments && hasReleases && (filepath.Ext(filePath) == ".gotmpl" || !runtime.V1Mode) {
|
||||
return runtime.V1Mode, EnvironmentsAndReleasesWithinSameYamlPartErr
|
||||
}
|
||||
return false, nil
|
||||
@@ -29,9 +30,9 @@ var checkerFuncs = []checkerFunc{
|
||||
}
|
||||
|
||||
// Checker is a policy checker for the helmfile state.
|
||||
func Checker(helmState map[string]interface{}) (bool, error) {
|
||||
func Checker(filePath string, helmState map[string]interface{}) (bool, error) {
|
||||
for _, fn := range checkerFuncs {
|
||||
if isStrict, err := fn(helmState); err != nil {
|
||||
if isStrict, err := fn(filePath, helmState); err != nil {
|
||||
return isStrict, err
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,17 +4,23 @@ import (
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/helmfile/helmfile/pkg/runtime"
|
||||
)
|
||||
|
||||
func TestForbidEnvironmentsWithReleases(t *testing.T) {
|
||||
testCases := []struct {
|
||||
name string
|
||||
filePath string
|
||||
v1mode bool
|
||||
helmState map[string]interface{}
|
||||
expectedErr bool
|
||||
isStrict bool
|
||||
}{
|
||||
{
|
||||
name: "no error when only releases",
|
||||
name: "no error when only releases",
|
||||
filePath: "helmfile.yaml",
|
||||
v1mode: false,
|
||||
helmState: map[string]interface{}{
|
||||
"releases": interface{}(nil),
|
||||
},
|
||||
@@ -22,7 +28,9 @@ func TestForbidEnvironmentsWithReleases(t *testing.T) {
|
||||
isStrict: false,
|
||||
},
|
||||
{
|
||||
name: "no error when only environments",
|
||||
name: "no error when only environments",
|
||||
filePath: "helmfile.yaml",
|
||||
v1mode: false,
|
||||
helmState: map[string]interface{}{
|
||||
"environments": map[string]interface{}{},
|
||||
},
|
||||
@@ -30,7 +38,9 @@ func TestForbidEnvironmentsWithReleases(t *testing.T) {
|
||||
isStrict: false,
|
||||
},
|
||||
{
|
||||
name: "error when both releases and environments",
|
||||
name: "error when both releases and environments",
|
||||
filePath: "helmfile.yaml",
|
||||
v1mode: false,
|
||||
helmState: map[string]interface{}{
|
||||
"environments": interface{}(nil),
|
||||
"releases": interface{}(nil),
|
||||
@@ -38,11 +48,28 @@ func TestForbidEnvironmentsWithReleases(t *testing.T) {
|
||||
expectedErr: true,
|
||||
isStrict: false,
|
||||
},
|
||||
{
|
||||
name: "no error when both releases and environments for plain yaml on v1",
|
||||
filePath: "helmfile.yaml",
|
||||
v1mode: true,
|
||||
helmState: map[string]interface{}{
|
||||
"environments": interface{}(nil),
|
||||
"releases": interface{}(nil),
|
||||
},
|
||||
expectedErr: false,
|
||||
isStrict: false,
|
||||
},
|
||||
}
|
||||
|
||||
v1mode := runtime.V1Mode
|
||||
t.Cleanup(func() {
|
||||
runtime.V1Mode = v1mode
|
||||
})
|
||||
|
||||
for _, tc := range testCases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
isStrict, err := forbidEnvironmentsWithReleases(tc.helmState)
|
||||
runtime.V1Mode = tc.v1mode
|
||||
isStrict, err := forbidEnvironmentsWithReleases(tc.filePath, tc.helmState)
|
||||
require.Equal(t, tc.isStrict, isStrict, "expected isStrict=%v, got=%v", tc.isStrict, isStrict)
|
||||
if tc.expectedErr {
|
||||
require.ErrorIsf(t, err, EnvironmentsAndReleasesWithinSameYamlPartErr, "expected error=%v, got=%v", EnvironmentsAndReleasesWithinSameYamlPartErr, err)
|
||||
|
||||
@@ -96,6 +96,8 @@ func (c *StateCreator) Parse(content []byte, baseDir, file string) (*HelmState,
|
||||
|
||||
var intermediate HelmState
|
||||
|
||||
intermediate.FilePath = file
|
||||
|
||||
err := decode(&intermediate)
|
||||
if err == io.EOF {
|
||||
break
|
||||
|
||||
+1
-1
@@ -104,7 +104,7 @@ func (hs *HelmState) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
||||
return err
|
||||
}
|
||||
|
||||
isStrict, err := policy.Checker(helmStateInfo)
|
||||
isStrict, err := policy.Checker(hs.FilePath, helmStateInfo)
|
||||
if err != nil {
|
||||
if isStrict {
|
||||
return err
|
||||
|
||||
Reference in New Issue
Block a user