fixup! test(e2e): Use long cluster names

Author: jimmidyson

test/e2e/clusterautoscaler_helpers.go

@@ -85,8 +85,7 @@ func WaitForClusterAutoscalerToBeReadyForWorkloadCluster(
 			Deployment: &appsv1.Deployment{
 				ObjectMeta: metav1.ObjectMeta{
 					Name: fmt.Sprintf(
-						"%s-%s",
-						clusterAutoscalerReleaseName,
+						"cluster-autoscaler-%s",
 						input.WorkloadCluster.Name,
 					),
 					Namespace: input.WorkloadCluster.Namespace,

test/e2e/framework/self_hosted.go

@@ -18,6 +18,7 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/klog/v2"
+	"k8s.io/utils/ptr"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	clusterctlv1 "sigs.k8s.io/cluster-api/cmd/clusterctl/api/v1alpha3"
 	capie2e "sigs.k8s.io/cluster-api/test/e2e"
@@ -38,6 +39,10 @@ type SelfHostedSpecInput struct {
 	ControlPlaneWaiters   clusterctl.ControlPlaneWaiters
 	Flavor                string
 
+	// Cluster name allows to specify a deterministic clusterName.
+	// If not set, a random one will be generated.
+	ClusterName *string
+
 	// InfrastructureProviders specifies the infrastructure to use for clusterctl
 	// operations (Example: get cluster templates).
 	// Note: In most cases this need not be specified. It only needs to be specified when
@@ -109,6 +114,10 @@ func SelfHostedSpec(ctx context.Context, inputGetter func() SelfHostedSpecInput)
 			Succeed(),
 			"Invalid argument. input.ArtifactFolder can't be created for %s spec", specName,
 		)
+		Expect(len(ptr.Deref(input.ClusterName, ""))).To(
+			BeNumerically("<=", 63),
+			"Invalid argument. input.ClusterName %q can't be longer than 63 characters", input.ClusterName,
+		)
 
 		// Use KubernetesVersion if no upgrade step is defined by test input.
 		Expect(input.E2EConfig.Variables).To(HaveKey(capie2e.KubernetesVersion))
@@ -140,6 +149,10 @@ func SelfHostedSpec(ctx context.Context, inputGetter func() SelfHostedSpecInput)
 		By("Creating a workload cluster")
 
 		workloadClusterName := fmt.Sprintf("%s-%s", specName, util.RandomString(6))
+		if input.ClusterName != nil {
+			workloadClusterName = *input.ClusterName
+		}
+
 		clusterctlVariables := map[string]string{}
 
 		// In case the infrastructure-docker provider is installed, ensure to add the preload images variable to load the

test/e2e/quick_start_test.go

@@ -20,6 +20,7 @@ import (
 	capie2e "sigs.k8s.io/cluster-api/test/e2e"
 	capiframework "sigs.k8s.io/cluster-api/test/framework"
 	"sigs.k8s.io/cluster-api/test/framework/clusterctl"
+	"sigs.k8s.io/cluster-api/util"
 
 	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/api/v1alpha1"
 	apivariables "github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/api/variables"
@@ -129,7 +130,30 @@ var _ = Describe("Quick start", func() {
 											))
 										}
 
+										clusterNamePrefix := "quick-start-"
+										// To be able to test the self-hosted cluster with long name, we need to set the
+										// maxClusterNameength to 63 which is the maximum length of a cluster name.
+										maxClusterNameLength := 63
+										// However, if the provider is Docker, we need to reduce the maxClusterNameLength
+										// because CAPI adds multiple random suffixes to the cluster name which are used in
+										// Docker cluster, and then in MachineDeployment, and finally in the machine names,
+										// resulting in 23 extra characters added to the cluster name for the actual worker node
+										// machine names. These machine names are used for Docker container names. The Docker
+										// image used by KinD have a maximum hostname length of 64 characters. This can be
+										// determined by running `getconf HOST_NAME_MAX` in a Docker container and is different
+										// from the host which generally allows 255 characters nowadays.
+										// Any longer than this prevents the container from starting, returning an error such
+										// as `error during container init: sethostname: invalid argument: unknown`.
+										// Therefore we reduce the maximum cluster to 64 (max hostname length) - 23 (random suffixes).
+										if lowercaseProvider == "docker" {
+											maxClusterNameLength = 64 - 23
+										}
+
 										return capie2e.QuickStartSpecInput{
+											ClusterName: ptr.To(clusterNamePrefix +
+												util.RandomString(
+													maxClusterNameLength-len(clusterNamePrefix),
+												)),
 											E2EConfig:              testE2EConfig,
 											ClusterctlConfigPath:   clusterLocalClusterctlConfigPath,
 											BootstrapClusterProxy:  bootstrapClusterProxy,

test/e2e/self_hosted_test.go

@@ -14,6 +14,7 @@ import (
 	"k8s.io/utils/ptr"
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	capiframework "sigs.k8s.io/cluster-api/test/framework"
+	"sigs.k8s.io/cluster-api/util"
 
 	"github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/api/v1alpha1"
 	apivariables "github.com/nutanix-cloud-native/cluster-api-runtime-extensions-nutanix/api/variables"
@@ -57,6 +58,25 @@ var _ = Describe("Self-hosted", Serial, func() {
 									framework.SelfHostedSpec(
 										ctx,
 										func() framework.SelfHostedSpecInput {
+											clusterNamePrefix := "self-hosted-"
+											// To be able to test the self-hosted cluster with long name, we need to set the
+											// maxClusterNameLength to 63 which is the maximum length of a cluster name.
+											maxClusterNameLength := 63
+											// However, if the provider is Docker, we need to reduce the maxClusterNameLength
+											// because CAPI adds multiple random suffixes to the cluster name which are used in
+											// Docker cluster, and then in MachineDeployment, and finally in the machine names,
+											// resulting in 23 extra characters added to the cluster name for the actual worker node
+											// machine names. These machine names are used for Docker container names. The Docker
+											// image used by KinD have a maximum hostname length of 64 characters. This can be
+											// determined by running `getconf HOST_NAME_MAX` in a Docker container and is different
+											// from the host which generally allows 255 characters nowadays.
+											// Any longer than this prevents the container from starting, returning an error such
+											// as `error during container init: sethostname: invalid argument: unknown`.
+											// Therefore we reduce the maximum cluster to 64 (max hostname length) - 23 (random suffixes).
+											if lowercaseProvider == "docker" {
+												maxClusterNameLength = 64 - 23
+											}
+
 											return framework.SelfHostedSpecInput{
 												E2EConfig:              e2eConfig,
 												ClusterctlConfigPath:   clusterctlConfigPath,
@@ -65,6 +85,10 @@ var _ = Describe("Self-hosted", Serial, func() {
 												SkipCleanup:            skipCleanup,
 												Flavor:                 flavour,
 												InfrastructureProvider: ptr.To(lowercaseProvider),
+												ClusterName: ptr.To(clusterNamePrefix +
+													util.RandomString(
+														maxClusterNameLength-len(clusterNamePrefix),
+													)),
 												PostClusterMoved: func(proxy capiframework.ClusterProxy, cluster *clusterv1.Cluster) {
 													By(
 														"Waiting for all requested addons to be ready in workload cluster",