Skip to content

Commit

Permalink
Add tests for external patch appy
Browse files Browse the repository at this point in the history 
Signed-off-by: killianmuldoon <[email protected]>
  • Loading branch information
@killianmuldoon
killianmuldoon committed Jun 17, 2022
1 parent 8d7f010 commit b682941
Show file tree
Hide file tree
Showing 2 changed files with 178 additions and 15 deletions.
188 changes: 174 additions & 14 deletions internal/controllers/topology/cluster/patches/engine_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package patches

import (
"context"
"encoding/json"
"fmt"
"strings"
"testing"
Expand All @@ -26,20 +27,22 @@ import (
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/types"
utilfeature "k8s.io/component-base/featuregate/testing"
"k8s.io/utils/pointer"

clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
runtimev1 "sigs.k8s.io/cluster-api/exp/runtime/api/v1alpha1"
runtimehooksv1 "sigs.k8s.io/cluster-api/exp/runtime/hooks/api/v1alpha1"
"sigs.k8s.io/cluster-api/feature"
"sigs.k8s.io/cluster-api/internal/controllers/topology/cluster/scope"
runtimecatalog "sigs.k8s.io/cluster-api/internal/runtime/catalog"
runtimeclient "sigs.k8s.io/cluster-api/internal/runtime/client"
runtimeregistry "sigs.k8s.io/cluster-api/internal/runtime/registry"
fakeruntimeclient "sigs.k8s.io/cluster-api/internal/runtime/client/fake"
"sigs.k8s.io/cluster-api/internal/test/builder"
. "sigs.k8s.io/cluster-api/internal/test/matchers"
)

func TestApply(t *testing.T) {
defer utilfeature.SetFeatureGateDuringTest(t, feature.Gates, feature.RuntimeSDK, true)()
type expectedFields struct {
infrastructureCluster map[string]interface{}
controlPlane map[string]interface{}
Expand All @@ -49,9 +52,11 @@ func TestApply(t *testing.T) {
}

tests := []struct {
name string
patches []clusterv1.ClusterClassPatch
expectedFields expectedFields
name string
patches []clusterv1.ClusterClassPatch
externalPatchResponses map[string]runtimehooksv1.ResponseObject
expectedFields expectedFields
wantErr bool
}{
{
name: "Should preserve desired state, if there are no patches",
Expand Down Expand Up @@ -348,6 +353,132 @@ func TestApply(t *testing.T) {
},
},
},
{
name: "Successfully apply external jsonPatch with generate and validate",
patches: []clusterv1.ClusterClassPatch{
{
Name: "fake-patch1",
External: &clusterv1.ExternalPatchDefinition{
GenerateExtension: pointer.String("patch-infrastructureCluster"),
ValidateExtension: pointer.String("validate-infrastructureCluster"),
},
},
},
externalPatchResponses: map[string]runtimehooksv1.ResponseObject{
"patch-infrastructureCluster": &runtimehooksv1.GeneratePatchesResponse{
Items: []runtimehooksv1.GeneratePatchesResponseItem{
{
UID: "1",
PatchType: runtimehooksv1.JSONPatchType,
Patch: bytesPatch([]jsonPatchRFC6902{{
Op: "add",
Path: "/spec/template/spec/resource",
Value: &apiextensionsv1.JSON{Raw: []byte(`"infraCluster"`)}}}),
},
},
},
"validate-infrastructureCluster": &runtimehooksv1.ValidateTopologyResponse{
CommonResponse: runtimehooksv1.CommonResponse{
Status: runtimehooksv1.ResponseStatusSuccess,
},
},
},
expectedFields: expectedFields{
infrastructureCluster: map[string]interface{}{
"spec.resource": "infraCluster",
},
},
},
{
name: "error on failed validation with external jsonPatch",
patches: []clusterv1.ClusterClassPatch{
{
Name: "fake-patch1",
External: &clusterv1.ExternalPatchDefinition{
GenerateExtension: pointer.String("patch-infrastructureCluster"),
ValidateExtension: pointer.String("validate-infrastructureCluster"),
},
},
},
externalPatchResponses: map[string]runtimehooksv1.ResponseObject{
"patch-infrastructureCluster": &runtimehooksv1.GeneratePatchesResponse{
Items: []runtimehooksv1.GeneratePatchesResponseItem{
{
UID: "1",
PatchType: runtimehooksv1.JSONPatchType,
Patch: bytesPatch([]jsonPatchRFC6902{{
Op: "add",
Path: "/spec/template/spec/resource",
Value: &apiextensionsv1.JSON{Raw: []byte(`"invalid-infraCluster"`)}}}),
},
},
},
"validate-infrastructureCluster": &runtimehooksv1.ValidateTopologyResponse{
CommonResponse: runtimehooksv1.CommonResponse{
Status: runtimehooksv1.ResponseStatusFailure,
Message: "not a valid infrastructureCluster",
},
},
},
wantErr: true,
},
{
name: "Successfully apply multiple external jsonPatch",
patches: []clusterv1.ClusterClassPatch{
{
Name: "fake-patch1",
External: &clusterv1.ExternalPatchDefinition{
GenerateExtension: pointer.String("patch-infrastructureCluster"),
},
},
{
Name: "fake-patch2",
External: &clusterv1.ExternalPatchDefinition{
GenerateExtension: pointer.String("patch-controlPlane"),
},
},
},

externalPatchResponses: map[string]runtimehooksv1.ResponseObject{
"patch-infrastructureCluster": &runtimehooksv1.GeneratePatchesResponse{
Items: []runtimehooksv1.GeneratePatchesResponseItem{
{
UID: "1",
PatchType: runtimehooksv1.JSONPatchType,
Patch: bytesPatch([]jsonPatchRFC6902{{
Op: "add",
Path: "/spec/template/spec/resource",
Value: &apiextensionsv1.JSON{Raw: []byte(`"infraCluster"`)}}}),
},
{
UID: "1",
PatchType: runtimehooksv1.JSONPatchType,
Patch: bytesPatch([]jsonPatchRFC6902{{
Op: "add",
Path: "/spec/template/spec/another",
Value: &apiextensionsv1.JSON{Raw: []byte(`"resource"`)}}}),
},
},
},
"patch-controlPlane": &runtimehooksv1.GeneratePatchesResponse{
Items: []runtimehooksv1.GeneratePatchesResponseItem{
{
UID: "2",
PatchType: runtimehooksv1.JSONMergePatchType,
Patch: []byte(`{"spec":{"template":{"spec":{"resource": "controlPlane"}}}}`)},
},
},
},
expectedFields: expectedFields{
infrastructureCluster: map[string]interface{}{
"spec.resource": "infraCluster",
"spec.another": "resource",
},
controlPlane: map[string]interface{}{
"spec.resource": "controlPlane",
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
Expand All @@ -366,17 +497,26 @@ func TestApply(t *testing.T) {
blueprint, desired := setupTestObjects()

// If there are patches, set up patch generators.
// FIXME(sbueringer) implement test for external patches
cat := runtimecatalog.New()
g.Expect(runtimehooksv1.AddToCatalog(cat)).To(Succeed())

registry := runtimeregistry.New()
g.Expect(registry.WarmUp(&runtimev1.ExtensionConfigList{})).To(Succeed())
runtimeClient := runtimeclient.New(runtimeclient.Options{
Catalog: cat,
Registry: registry,
})
runtimeClient := fakeruntimeclient.NewRuntimeClientBuilder().WithCatalog(cat).Build()

if tt.externalPatchResponses != nil {
// replace the package variable uuidGenerator with one that returns an incremented integer.
// each patch will have a new uuid in the order in which they're defined and called.
var uuid int32
uuidGenerator = func() types.UID {
uuid++
return types.UID(fmt.Sprintf("%d", uuid))
}
runtimeClient = fakeruntimeclient.NewRuntimeClientBuilder().
WithCallExtensionResponses(tt.externalPatchResponses).
WithCatalog(cat).
Build()
}
patchEngine := NewEngine(runtimeClient)

if len(tt.patches) > 0 {
// Add the patches.
blueprint.ClusterClass.Spec.Patches = tt.patches
Expand Down Expand Up @@ -412,7 +552,12 @@ func TestApply(t *testing.T) {
}

// Apply patches.
g.Expect(patchEngine.Apply(context.Background(), blueprint, desired)).To(Succeed())
if err := patchEngine.Apply(context.Background(), blueprint, desired); err != nil {
if !tt.wantErr {
t.Fatal(err)
}
return
}

// Compare the patched desired objects with the expected desired objects.
g.Expect(desired.Cluster).To(EqualObject(expectedCluster))
Expand Down Expand Up @@ -587,3 +732,18 @@ func setSpecFields(obj *unstructured.Unstructured, fields map[string]interface{}
}
}
}

// jsonPatchRFC6902 represents a jsonPatch.
type jsonPatchRFC6902 struct {
Op string `json:"op"`
Path string `json:"path"`
Value *apiextensionsv1.JSON `json:"value,omitempty"`
}

func bytesPatch(patch []jsonPatchRFC6902) []byte {
out, err := json.Marshal(patch)
if err != nil {
panic(err)
}
return out
}
5 changes: 4 additions & 1 deletion internal/controllers/topology/cluster/patches/template.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,14 @@ func (t *requestItemBuilder) WithHolder(object client.Object, fieldPath string)
return t
}

// uuidGenerator is defined as a package variable to enable changing it during testing.
var uuidGenerator func() types.UID = uuid.NewUUID

// Build builds a GeneratePatchesRequestItem.
func (t *requestItemBuilder) Build() (*runtimehooksv1.GeneratePatchesRequestItem, error) {
tpl := &runtimehooksv1.GeneratePatchesRequestItem{
HolderReference: t.holder,
UID: uuid.NewUUID(),
UID: uuidGenerator(),
}

jsonObj, err := json.Marshal(t.template)
Expand Down

0 comments on commit b682941

Please sign in to comment.