feat: add custom upgrade testing framework

Author: SatabdiG

test/test_utils.go

@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"os"
+	"testing"
 
 	"github.com/crossplane-contrib/xp-testing/pkg/envvar"
 	"github.com/crossplane-contrib/xp-testing/pkg/logging"
@@ -242,3 +243,51 @@ func resClient(cfg *envconf.Config) *res.Resources {
 	r, _ := resources.GetResourcesWithRESTConfig(cfg)
 	return r
 }
+
+// CustomAssessmentFunc is a function that performs custom validation
+// before or after a provider upgrade
+type CustomAssessmentFunc func(ctx context.Context, t *testing.T, cfg *envconf.Config) context.Context
+
+// CustomUpgradeTest encapsulates configuration for custom upgrade tests
+type CustomUpgradeTest struct {
+	name                  string
+	fromVersion           string
+	toVersion             string
+	resourceDirectories   []string
+	preUpgradeAssessment  map[string]CustomAssessmentFunc
+	postUpgradeAssessment map[string]CustomAssessmentFunc
+}
+
+// NewCustomUpgradeTest creates a new CustomUpgradeTest builder
+func NewCustomUpgradeTest(name, fromVersion, toVersion string) *CustomUpgradeTest {
+	return &CustomUpgradeTest{
+		name:                  name,
+		preUpgradeAssessment:  make(map[string]CustomAssessmentFunc),
+		postUpgradeAssessment: make(map[string]CustomAssessmentFunc),
+	}
+}
+
+func (c *CustomUpgradeTest) WithResourceDirectories(dirs []string) *CustomUpgradeTest {
+	c.resourceDirectories = dirs
+	return c
+}
+
+func (c *CustomUpgradeTest) ToVersion(version string) *CustomUpgradeTest {
+	c.toVersion = version
+	return c
+}
+
+func (c *CustomUpgradeTest) FromVersion(version string) *CustomUpgradeTest {
+	c.fromVersion = version
+	return c
+}
+
+func (c *CustomUpgradeTest) PreUpgradeAssessment(name string, fn CustomAssessmentFunc) *CustomUpgradeTest {
+	c.preUpgradeAssessment[name] = fn
+	return c
+}
+
+func (c *CustomUpgradeTest) PostUpgradeAssessment(name string, fn CustomAssessmentFunc) *CustomUpgradeTest {
+	c.postUpgradeAssessment[name] = fn
+	return c
+}

test/upgrade/base_upgrade_test.go

@@ -0,0 +1,63 @@
+//go:build upgrade
+
+package upgrade
+
+import (
+	"context"
+	"testing"
+
+	"k8s.io/client-go/features"
+)
+
+func (c *CustomUpgradeTest) Build(t *testing.T) features.Feature {
+	feature := features.New(c.name)
+	feature = feature.Setup(func(ctx context.Context, t *testing.T, cfg *envconf.Config) context.Context {
+		t.Logf("Setting up resources from version %s", c.fromVersion)
+		//TODO: install provider at fromVersion
+		//TODO: Apply manifest at resource directories
+		return ctx
+	})
+	// Pre-upgrade assessments
+	for name, assestmentFunc := range c.preUpgradeAssessment {
+		assestment := assestmentFunc //Capture for closure
+		assestmentName := name 
+		feature = feature.Assess(assestmentName, func(ctx context.Context, t *testing.T, cfg *envconf.Config) config.Context {
+			t.Logf("Running pre-upgrade Assestment %s": assestmentName)
+			return assestment(ctx, t, cfg)
+		})
+
+	}
+
+	//Upgrade Tests
+	feature = feature.Assess("Upgrade Provider", func(ctx context.Context, t *testing.T, cfg *envconf.Config) config.Context {
+			t.Logf("Upgrading provider from %s to %s", c.fromVersion, c.toVersion)
+			//TODO: Put in code for upgrade provider
+			return ctx
+	})
+
+	// Post-upgrade assessments
+	for name, assestmentFunc := range c.postUpgradeAssessment {
+		assestment := assestmentFunc //Capture for closure
+		assestmentName := name 
+		feature = feature.Assess(assestmentName, func(ctx context.Context, t *testing.T, cfg *envconf.Config) config.Context {
+			t.Logf("Running post-upgrade Assestment %s": assestmentName)
+			return assestment(ctx, t, cfg)
+		})
+
+	}
+	//Teardown Phase
+	feature = feature.Teardown(func(ctx context.Context, t *Testing.T, cfg *envconf.Config) context.Context {
+		t.Logf("Cleaning up test resources")
+		//TODO: put in code to delete test resources
+		return ctx
+	})
+	return feature
+
+ }
+
+ func (c *CustomUpgradeTest) Run(t *Testing.T, cfg *envconf.Config) {
+	feature := c.Build(t)
+	testenv.Test(t, feature.Feature())
+ }
+
+