chore: minor cleanup tasks

Author: lizardruss

.github/workflows/e2e.yaml

@@ -30,7 +30,7 @@ jobs:
         - "**.go"
         - "!**_test.go" # exclude test files to ignore unit test changes
         - "test/**" # include test files in e2e again
-        - "e2e-next/**" #include e2e-next tests
+        - "!e2e-next/**" # exclude e2e-next tests
         - "!**.md"
         - "Dockerfile.release"
         - ".github/workflows/e2e.yaml"

e2e-next/README.md

@@ -6,27 +6,32 @@
 4. If you created a new folder, make sure to add the import in `e2e_suite_test.go`.
 
 ### Preparations
-* Install [vcluster cli](https://www.vcluster.com/docs/vcluster)
-* Install ginkgo cli via `go install github.com/onsi/ginkgo/v2/ginkgo@v2.23.4`
+* Install ginkgo cli via `go install github.com/onsi/ginkgo/v2/ginkgo`
 * Install [kind](https://kind.sigs.k8s.io/docs/user/quick-start/)
 ```
 
+### Setup an environment for manual testing
+If you only want an environment that matches a test, you can create the environment without running the tests:
+1. Run `just build-snapshot`
+2. Run `just build-cli-snapshot`
+3. Run `just setup [LABEL]`
+4. Perform any manual testing using the deployed virtual cluster environment
+
 ### Develop a test
 If you want to iterate over a test, you can do:
 1. Run `just build-snapshot`
-2. Run `just setup [LABEL]` and it will do the following:
-  * Create a kind cluster
-  * Load vcluster image into kind cluster
-
-Then iterate via:
-1. Run `just iterate-e2e [LABEL]`
-2. Change things, then rerun above command
+2. Run `just build-cli-snapshot`
+3. Run `just iterate-e2e [LABEL]`
+4. Rerun step 1 if you modify the vCluster code
+5. Rerun step 2 if you modify the vCluster CLI code
+6. Rerun step 2 as you modify the tests
 
 ### Run a test
 If you just want to run a test, you can do:
 1. Run `just build-snapshot`
-2. Run `just iterate-e2e [LABEL]`
+2. Run `just build-cli-snapshot`
+3. Run `just iterate-e2e [LABEL]`
 
 ### Destroy the kind cluster
-If you want to cleanup the state, you can do:
-1. Run `just teardown my-feature`
+If you want to cleanup test environment you can do:
+1. Run `just teardown [LABEL]`

e2e-next/clusters/clusters.go

@@ -36,7 +36,7 @@ var (
 		providervcluster.WithPath(filepath.Join(os.Getenv("GOBIN"), "vcluster")),
 		providervcluster.WithLocalChartDir("../chart"),
 		providervcluster.WithUpgrade(true),
-		providervcluster.WithBackgroundProxyImage(constants.GetVclusterImage()),
+		providervcluster.WithBackgroundProxyImage(constants.GetVClusterImage()),
 	}
 )
 var (

e2e-next/constants/cluster.go

@@ -1,9 +1,15 @@
 package constants
 
+import "os"
+
 var hostCluster string
 
 func GetHostClusterName() string {
 	if hostCluster == "" {
+		if kindName, ok := os.LookupEnv("KIND_NAME"); ok && kindName != "" {
+			return kindName
+		}
+
 		return "kind-cluster"
 	}
 	return hostCluster

e2e-next/constants/image.go

@@ -9,7 +9,7 @@ var (
 	tag        string
 )
 
-func GetVclusterImage() string {
+func GetVClusterImage() string {
 	if repository == "" && tag == "" {
 		return "ghcr.io/loft-sh/vcluster:dev-next"
 	}
@@ -33,7 +33,7 @@ func GetTag() string {
 	return tag
 }
 
-func SetVclusterImage(image string) {
+func SetVClusterImage(image string) {
 	if strings.Contains(image, "@") {
 		// Handle digest format: repo@sha256:xxx
 		parts := strings.SplitN(image, "@", 2)

e2e-next/e2e_suite_test.go

@@ -38,7 +38,7 @@ var (
 
 // Register your flags in an init function.  This ensures they are registered _before_ `go test` calls flag.Parse().
 func handleFlags() {
-	flag.StringVar(&vclusterImage, "vcluster-image", constants.GetVclusterImage(), "vCluster image to test")
+	flag.StringVar(&vclusterImage, "vcluster-image", constants.GetVClusterImage(), "vCluster image to test")
 	flag.StringVar(&clusterName, "cluster-name", constants.GetHostClusterName(), "The kind cluster to run test against. Optional.")
 	flag.BoolVar(&setupOnly, "setup-only", false, "Skip tests and setup the environment")
 	flag.BoolVar(&teardown, "teardown", true, "Disables [e2e.AfterSuite] [e2e.AfterAll] to leave environment in place.")
@@ -52,7 +52,7 @@ func handleFlags() {
 	}
 
 	constants.SetHostClusterName(clusterName)
-	constants.SetVclusterImage(vclusterImage)
+	constants.SetVClusterImage(vclusterImage)
 
 	e2e.SetSetupOnly(setupOnly)
 	e2e.SetTeardown(!setupOnly && teardown)

e2e-next/test_core/sync/test_node.go

@@ -2,7 +2,6 @@ package test_core
 
 import (
 	"context"
-	"os"
 
 	"github.com/loft-sh/e2e-framework/pkg/setup/cluster"
 	"github.com/loft-sh/vcluster/e2e-next/clusters"
@@ -37,9 +36,6 @@ var _ = Describe("Node sync",
 		It("Sync nodes using label selector", func(ctx context.Context) {
 
 			hostname := constants.GetHostClusterName() + "-control-plane"
-			if kindName, ok := os.LookupEnv("KIND_NAME"); ok && kindName != "" {
-				hostname = kindName + "-control-plane"
-			}
 			Eventually(func(g Gomega) {
 				hostNodes, err := hostClient.CoreV1().Nodes().List(ctx, metav1.ListOptions{})
 				g.Expect(err).NotTo(HaveOccurred(), "Failed to list host nodes")

e2e-next/test_deploy/test_helm_charts.go

@@ -8,13 +8,13 @@ import (
 	"github.com/loft-sh/e2e-framework/pkg/setup/cluster"
 	"github.com/loft-sh/vcluster/e2e-next/clusters"
 	"github.com/loft-sh/vcluster/e2e-next/constants"
-	e2eLabels "github.com/loft-sh/vcluster/e2e-next/labels"
+	"github.com/loft-sh/vcluster/e2e-next/labels"
 	"github.com/loft-sh/vcluster/pkg/controllers/deploy"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	appsv1 "k8s.io/api/apps/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/labels"
+	k8slabels "k8s.io/apimachinery/pkg/labels"
 	"k8s.io/client-go/kubernetes"
 )
 
@@ -28,7 +28,7 @@ const (
 
 var _ = Describe("Helm charts (regular and OCI) are synced and applied as expected",
 	Ordered,
-	e2eLabels.Deploy,
+	labels.Deploy,
 	cluster.Use(clusters.HelmChartsVCluster),
 	func() {
 		var (
@@ -69,7 +69,7 @@ var _ = Describe("Helm charts (regular and OCI) are synced and applied as expect
 		It("Test nginx release secret existence in vcluster (regular chart)", func(ctx context.Context) {
 			Eventually(func(g Gomega) {
 				secList, err := vClusterClient.CoreV1().Secrets(ChartNamespace).List(ctx, metav1.ListOptions{
-					LabelSelector: labels.SelectorFromSet(HelmSecretLabels).String(),
+					LabelSelector: k8slabels.SelectorFromSet(HelmSecretLabels).String(),
 				})
 				g.Expect(err).NotTo(HaveOccurred(), "Should be able to list secrets")
 				g.Expect(secList.Items).To(HaveLen(1), "Should have exactly one helm secret")
@@ -84,7 +84,7 @@ var _ = Describe("Helm charts (regular and OCI) are synced and applied as expect
 		It("Test fluent-bit release deployment existence in vcluster (OCI chart)", func(ctx context.Context) {
 			Eventually(func(g Gomega) []appsv1.Deployment {
 				deployList, err := vClusterClient.AppsV1().Deployments(ChartOCINamespace).List(ctx, metav1.ListOptions{
-					LabelSelector: labels.SelectorFromSet(HelmOCIDeploymentLabels).String(),
+					LabelSelector: k8slabels.SelectorFromSet(HelmOCIDeploymentLabels).String(),
 				})
 				g.Expect(err).NotTo(HaveOccurred(), "Should be able to list deployments")
 				return deployList.Items