Skip to content

Commit

Permalink
Address review suggestions
Browse files Browse the repository at this point in the history
Signed-off-by: Rashmi Gottipati <chowdary.grashmi@gmail.com>
  • Loading branch information
rashmigottipati committed Apr 25, 2024
1 parent a469cee commit 97bfff2
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 9 deletions.
6 changes: 3 additions & 3 deletions pkg/kapp/crdupgradesafety/change_validator.go
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ func EnumChangeValidation(diff FieldDiff) (bool, error) {

// RequiredFieldChangeValidation adds a validation check to ensure that
// existing required fields can be marked as optional in a CRD schema:
// - No new values are added as required that did not previously have
// - No new values can be added as required that did not previously have
// any required fields present
// - Existing values are removed from the required field
// - Existing values can be removed from the required field
// This function returns:
// - A boolean representation of whether or not the change
// has been fully handled (i.e. the only change was to required field values)
Expand All @@ -88,7 +88,7 @@ func RequiredFieldChangeValidation(diff FieldDiff) (bool, error) {
}

if len(diff.Old.Required) == 0 && len(diff.New.Required) > 0 {
return handled(), fmt.Errorf("new values added as required when previously no required fields existed")
return handled(), fmt.Errorf("new values added as required when previously no required fields existed: %+v", diff.New.Required)
}

oldSet := sets.NewString()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ func TestPreflightCRDUpgradeSafetyInvalidFieldChangeRequiredFieldAdded(t *testin
env := BuildEnv(t)
logger := Logger{}
kapp := Kapp{t, env.Namespace, env.KappBinaryPath, logger}
kubectl := Kubectl{t, env.Namespace, logger}

testName := "preflightcrdupgradesafetyinvalidfieldchangerequiredfieldadded"

Expand Down Expand Up @@ -68,7 +67,6 @@ spec:

cleanUp := func() {
kapp.Run([]string{"delete", "-a", appName})
RemoveClusterResource(t, "ns", testName, "", kubectl)
}
cleanUp()
defer cleanUp()
Expand Down Expand Up @@ -126,5 +124,6 @@ spec:
_, err = kapp.RunWithOpts([]string{"deploy", "--preflight=CRDUpgradeSafety", "-a", appName, "-f", "-"},
RunOpts{StdinReader: strings.NewReader(update), AllowError: true})
require.Error(t, err)
require.Contains(t, err.Error(), "new required fields added")
})
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ func TestPreflightCRDUpgradeSafetyInvalidFieldChangeRequiredFieldAddedWhenNoneEx
env := BuildEnv(t)
logger := Logger{}
kapp := Kapp{t, env.Namespace, env.KappBinaryPath, logger}
kubectl := Kubectl{t, env.Namespace, logger}

testName := "preflightcrdupgradesafetyinvalidfieldchangerequiredfieldaddedwhennonexisted"

Expand Down Expand Up @@ -66,7 +65,6 @@ spec:

cleanUp := func() {
kapp.Run([]string{"delete", "-a", appName})
RemoveClusterResource(t, "ns", testName, "", kubectl)
}
cleanUp()
defer cleanUp()
Expand Down Expand Up @@ -123,5 +121,6 @@ spec:
_, err = kapp.RunWithOpts([]string{"deploy", "--preflight=CRDUpgradeSafety", "-a", appName, "-f", "-"},
RunOpts{StdinReader: strings.NewReader(update), AllowError: true})
require.Error(t, err)
require.Contains(t, err.Error(), "new values added as required when previously no required fields existed")
})
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ func TestPreflightCRDUpgradeSafetyInvalidFieldChangeRequiredFieldRemoved(t *test
env := BuildEnv(t)
logger := Logger{}
kapp := Kapp{t, env.Namespace, env.KappBinaryPath, logger}
kubectl := Kubectl{t, env.Namespace, logger}

testName := "preflightcrdupgradesafetyinvalidfieldchangerequiredfieldremoved"

Expand Down Expand Up @@ -69,7 +68,6 @@ spec:

cleanUp := func() {
kapp.Run([]string{"delete", "-a", appName})
RemoveClusterResource(t, "ns", testName, "", kubectl)
}
cleanUp()
defer cleanUp()
Expand Down

0 comments on commit 97bfff2

Please sign in to comment.