Merge pull request #450 from crandles/add-vcluster

feat: add vcluster e2e cluster provider

examples/vcluster/vcluster_with_config/main_test.go

@@ -0,0 +1,78 @@
+/*
+Copyright 2024 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package vcluster
+
+import (
+	"context"
+	"log"
+	"os"
+	"testing"
+
+	"sigs.k8s.io/e2e-framework/klient/conf"
+	"sigs.k8s.io/e2e-framework/pkg/env"
+	"sigs.k8s.io/e2e-framework/pkg/envconf"
+	"sigs.k8s.io/e2e-framework/pkg/envfuncs"
+	"sigs.k8s.io/e2e-framework/support"
+	"sigs.k8s.io/e2e-framework/support/kind"
+	"sigs.k8s.io/e2e-framework/third_party/vcluster"
+)
+
+var testenv env.Environment
+
+func TestMain(m *testing.M) {
+	opts := []support.ClusterOpts{}
+	// vcluster requires a "host" cluster to install into, so we should resolve one
+	if os.Getenv("REAL_CLUSTER") == "true" {
+		cfg := conf.ResolveKubeConfigFile()
+		opts = append(opts, vcluster.WithHostKubeConfig(cfg))
+	} else {
+		// create a kind cluster to use as the vcluster "host"
+		cfg, err := kind.NewProvider().WithName("kind-vc-host").Create(context.Background())
+		if err != nil {
+			log.Fatal(err)
+		}
+		opts = append(opts, vcluster.WithHostKubeConfig(cfg))
+	}
+
+	testenv, _ = env.NewFromFlags()
+	vclusterName := envconf.RandomName("vcluster-with-config", 16)
+	namespace := envconf.RandomName("vcluster-ns", 16)
+	opts = append(opts, vcluster.WithNamespace(namespace))
+	testenv.Setup(
+		envfuncs.CreateNamespace(namespace),
+		envfuncs.CreateClusterWithConfig(vcluster.NewProvider(), vclusterName, "values.yaml", opts...),
+	)
+
+	testenv.Finish(
+		envfuncs.DestroyCluster(vclusterName),
+		envfuncs.DeleteNamespace(namespace),
+	)
+
+	if os.Getenv("REAL_CLUSTER") != "true" {
+		// cleanup the vcluster "host"-kind-cluster
+		testenv.Finish(
+			func(ctx context.Context, c *envconf.Config) (context.Context, error) {
+				if err := kind.NewProvider().WithName("kind-vc-host").Destroy(ctx); err != nil {
+					return ctx, err
+				}
+				return ctx, nil
+			},
+		)
+	}
+
+	os.Exit(testenv.Run(m))
+}

examples/vcluster/vcluster_with_config/values.yaml

@@ -0,0 +1 @@
+# TODO: add vcluster configs

go.mod

@@ -11,6 +11,7 @@ require (
 	k8s.io/component-base v0.31.2
 	k8s.io/klog/v2 v2.130.1
 	sigs.k8s.io/controller-runtime v0.19.1
+	sigs.k8s.io/yaml v1.4.0
 )
 
 require (
@@ -63,5 +64,4 @@ require (
 	k8s.io/utils v0.0.0-20240711033017-18e509b52bc8 // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
-	sigs.k8s.io/yaml v1.4.0 // indirect
 )

pkg/env/env.go

@@ -226,7 +226,7 @@ func (e *testEnv) processTestFeature(ctx context.Context, t *testing.T, featureN
 	t.Helper()
 	skipped, message := e.requireFeatureProcessing(feature)
 	if skipped {
-		t.Skipf(message)
+		t.Skip(message)
 	}
 	// execute beforeEachFeature actions
 	ctx = e.processFeatureActions(ctx, t, feature, e.getBeforeFeatureActions())
@@ -510,7 +510,7 @@ func (e *testEnv) execFeature(ctx context.Context, t *testing.T, featName string
 				internalT.Helper()
 				skipped, message := e.requireAssessmentProcessing(assess, i+1)
 				if skipped {
-					internalT.Skipf(message)
+					internalT.Skip(message)
 				}
 				// Set shouldFailNow to true before actually running the assessment, because if the assessment
 				// calls t.FailNow(), the function will be abruptly stopped in the middle of `e.executeSteps()`.

third_party/flux/flux_setup.go

@@ -18,6 +18,7 @@ package flux
 
 import (
 	"context"
+	"errors"
 	"fmt"
 
 	"sigs.k8s.io/e2e-framework/pkg/env"
@@ -44,7 +45,7 @@ func InstallFlux(opts ...Option) env.Func {
 func CreateGitRepo(gitRepoName, gitRepoURL string, opts ...Option) env.Func {
 	return func(ctx context.Context, c *envconf.Config) (context.Context, error) {
 		if manager == nil {
-			return ctx, fmt.Errorf(NoFluxInstallationFoundMsg)
+			return ctx, errors.New(NoFluxInstallationFoundMsg)
 		}
 		err := manager.createSource(Git, gitRepoName, gitRepoURL, opts...)
 		if err != nil {
@@ -58,7 +59,7 @@ func CreateGitRepo(gitRepoName, gitRepoURL string, opts ...Option) env.Func {
 func CreateHelmRepository(name, url string, opts ...Option) env.Func {
 	return func(ctx context.Context, c *envconf.Config) (context.Context, error) {
 		if manager == nil {
-			return ctx, fmt.Errorf(NoFluxInstallationFoundMsg)
+			return ctx, errors.New(NoFluxInstallationFoundMsg)
 		}
 		err := manager.createSource(Helm, name, url, opts...)
 		if err != nil {
@@ -72,7 +73,7 @@ func CreateHelmRepository(name, url string, opts ...Option) env.Func {
 func CreateKustomization(kustomizationName, sourceRef string, opts ...Option) env.Func {
 	return func(ctx context.Context, c *envconf.Config) (context.Context, error) {
 		if manager == nil {
-			return ctx, fmt.Errorf(NoFluxInstallationFoundMsg)
+			return ctx, errors.New(NoFluxInstallationFoundMsg)
 		}
 		err := manager.createKustomization(kustomizationName, sourceRef, opts...)
 		if err != nil {
@@ -87,7 +88,7 @@ func CreateKustomization(kustomizationName, sourceRef string, opts ...Option) en
 func CreateHelmRelease(name, source, chart string, opts ...Option) env.Func {
 	return func(ctx context.Context, c *envconf.Config) (context.Context, error) {
 		if manager == nil {
-			return ctx, fmt.Errorf(NoFluxInstallationFoundMsg)
+			return ctx, errors.New(NoFluxInstallationFoundMsg)
 		}
 		err := manager.createHelmRelease(name, source, chart, opts...)
 		if err != nil {
@@ -101,7 +102,7 @@ func CreateHelmRelease(name, source, chart string, opts ...Option) env.Func {
 func UninstallFlux(opts ...Option) env.Func {
 	return func(ctx context.Context, c *envconf.Config) (context.Context, error) {
 		if manager == nil {
-			return ctx, fmt.Errorf(NoFluxInstallationFoundMsg)
+			return ctx, errors.New(NoFluxInstallationFoundMsg)
 		}
 		err := manager.uninstallFlux(opts...)
 		if err != nil {
@@ -115,7 +116,7 @@ func UninstallFlux(opts ...Option) env.Func {
 func DeleteKustomization(kustomizationName string, opts ...Option) env.Func {
 	return func(ctx context.Context, c *envconf.Config) (context.Context, error) {
 		if manager == nil {
-			return ctx, fmt.Errorf(NoFluxInstallationFoundMsg)
+			return ctx, errors.New(NoFluxInstallationFoundMsg)
 		}
 		err := manager.deleteKustomization(kustomizationName, opts...)
 		if err != nil {
@@ -129,7 +130,7 @@ func DeleteKustomization(kustomizationName string, opts ...Option) env.Func {
 func DeleteHelmRelease(name string, opts ...Option) env.Func {
 	return func(ctx context.Context, c *envconf.Config) (context.Context, error) {
 		if manager == nil {
-			return ctx, fmt.Errorf(NoFluxInstallationFoundMsg)
+			return ctx, errors.New(NoFluxInstallationFoundMsg)
 		}
 		err := manager.deleteHelmRelease(name, opts...)
 		if err != nil {
@@ -143,7 +144,7 @@ func DeleteHelmRelease(name string, opts ...Option) env.Func {
 func DeleteGitRepo(gitRepoName string, opts ...Option) env.Func {
 	return func(ctx context.Context, c *envconf.Config) (context.Context, error) {
 		if manager == nil {
-			return ctx, fmt.Errorf(NoFluxInstallationFoundMsg)
+			return ctx, errors.New(NoFluxInstallationFoundMsg)
 		}
 		err := manager.deleteSource(Git, gitRepoName, opts...)
 		if err != nil {
@@ -157,7 +158,7 @@ func DeleteGitRepo(gitRepoName string, opts ...Option) env.Func {
 func DeleteHelmRepo(name string, opts ...Option) env.Func {
 	return func(ctx context.Context, c *envconf.Config) (context.Context, error) {
 		if manager == nil {
-			return ctx, fmt.Errorf(NoFluxInstallationFoundMsg)
+			return ctx, errors.New(NoFluxInstallationFoundMsg)
 		}
 		err := manager.deleteSource(Helm, name, opts...)
 		if err != nil {

third_party/helm/helm.go

@@ -18,6 +18,7 @@ package helm
 
 import (
 	"bytes"
+	"errors"
 	"fmt"
 	"strings"
 
@@ -237,7 +238,7 @@ func (m *Manager) run(opts *Opts) (err error) {
 	}
 	log.V(4).InfoS("Determining if helm binary is available or not", "executable", m.path)
 	if m.e.Prog().Avail(m.path) == "" {
-		err = fmt.Errorf(missingHelm)
+		err = errors.New(missingHelm)
 		return
 	}
 	command, err := m.getCommand(opts)

third_party/ko/ko.go

@@ -19,6 +19,7 @@ package ko
 import (
 	"bytes"
 	"context"
+	"errors"
 	"fmt"
 	"strings"
 
@@ -159,7 +160,7 @@ func (m *Manager) GetLocalImage(ctx context.Context, packagePath string) (string
 func (m *Manager) run(opts *Opts) (out string, err error) {
 	log.V(4).InfoS("Determining if ko binary is available or not", "executable", m.path)
 	if m.e.Prog().Avail(m.path) == "" {
-		return "", fmt.Errorf(missingKo)
+		return "", errors.New(missingKo)
 	}
 
 	envs := m.getEnvs(opts)

third_party/kubetest2/pkg/tester/e2e-tester_test.go

@@ -17,8 +17,9 @@ limitations under the License.
 package tester
 
 import (
-	"github.com/octago/sflags/gen/gpflag"
 	"testing"
+
+	"github.com/octago/sflags/gen/gpflag"
 )
 
 func TestBuildFlags(t *testing.T) {