sigs.k8s.io/cluster-api-provider-azure@v1.17.0/test/e2e/azure_test.go

//go:build e2e
// +build e2e

/*
Copyright 2020 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 e2e

import (
	"context"
	"fmt"
	"os"
	"time"

	"github.com/Azure/azure-service-operator/v2/pkg/common/config"
	. "github.com/onsi/ginkgo/v2"
	. "github.com/onsi/gomega"
	corev1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/types"
	capi_e2e "sigs.k8s.io/cluster-api/test/e2e"
	"sigs.k8s.io/cluster-api/test/framework/clusterctl"
	"sigs.k8s.io/cluster-api/util"
	"sigs.k8s.io/controller-runtime/pkg/client"
)

var _ = Describe("Workload cluster creation", func() {
	var (
		ctx                    = context.TODO()
		specName               = "create-workload-cluster"
		namespace              *corev1.Namespace
		cancelWatches          context.CancelFunc
		result                 *clusterctl.ApplyClusterTemplateAndWaitResult
		clusterName            string
		clusterNamePrefix      string
		additionalCleanup      func()
		specTimes              = map[string]time.Time{}
		skipResourceGroupCheck = false
	)

	BeforeEach(func() {
		logCheckpoint(specTimes)

		Expect(ctx).NotTo(BeNil(), "ctx is required for %s spec", specName)
		Expect(e2eConfig).NotTo(BeNil(), "Invalid argument. e2eConfig can't be nil when calling %s spec", specName)
		Expect(clusterctlConfigPath).To(BeAnExistingFile(), "Invalid argument. clusterctlConfigPath must be an existing file when calling %s spec", specName)
		Expect(bootstrapClusterProxy).NotTo(BeNil(), "Invalid argument. bootstrapClusterProxy can't be nil when calling %s spec", specName)
		Expect(os.MkdirAll(artifactFolder, 0o755)).To(Succeed(), "Invalid argument. artifactFolder can't be created for %s spec", specName)
		Expect(e2eConfig.Variables).To(HaveKey(capi_e2e.KubernetesVersion))

		// CLUSTER_NAME and CLUSTER_NAMESPACE allows for testing existing clusters
		// if CLUSTER_NAMESPACE is set don't generate a new prefix otherwise
		// the correct namespace won't be found and a new cluster will be created
		clusterNameSpace := os.Getenv("CLUSTER_NAMESPACE")
		if clusterNameSpace == "" {
			clusterNamePrefix = fmt.Sprintf("capz-e2e-%s", util.RandomString(6))
		} else {
			clusterNamePrefix = clusterNameSpace
		}

		// Setup a Namespace where to host objects for this spec and create a watcher for the namespace events.
		var err error
		namespace, cancelWatches, err = setupSpecNamespace(ctx, clusterNamePrefix, bootstrapClusterProxy, artifactFolder)
		Expect(err).NotTo(HaveOccurred())

		result = new(clusterctl.ApplyClusterTemplateAndWaitResult)

		asoSecretName := e2eConfig.GetVariable("ASO_CREDENTIAL_SECRET_NAME")
		asoSecret := &corev1.Secret{
			ObjectMeta: metav1.ObjectMeta{
				Namespace: namespace.Name,
				Name:      asoSecretName,
			},
			StringData: map[string]string{
				config.AzureSubscriptionID: e2eConfig.GetVariable(AzureSubscriptionID),
				config.AzureTenantID:       e2eConfig.GetVariable(AzureTenantID),
				config.AzureClientID:       e2eConfig.GetVariable(AzureClientIDUserAssignedIdentity),
				config.AuthMode:            e2eConfig.GetVariable("ASO_CREDENTIAL_SECRET_MODE"),
			},
		}
		err = bootstrapClusterProxy.GetClient().Create(ctx, asoSecret)
		Expect(client.IgnoreAlreadyExists(err)).NotTo(HaveOccurred())

		identityName := e2eConfig.GetVariable(ClusterIdentityName)
		Expect(os.Setenv(ClusterIdentityName, identityName)).To(Succeed())
		Expect(os.Setenv(ClusterIdentityNamespace, defaultNamespace)).To(Succeed())
		additionalCleanup = nil
	})

	AfterEach(func() {
		if result.Cluster == nil {
			// this means the cluster failed to come up. We make an attempt to find the cluster to be able to fetch logs for the failed bootstrapping.
			_ = bootstrapClusterProxy.GetClient().Get(ctx, types.NamespacedName{Name: clusterName, Namespace: namespace.Name}, result.Cluster)
		}

		CheckTestBeforeCleanup()

		cleanInput := cleanupInput{
			SpecName:               specName,
			Cluster:                result.Cluster,
			ClusterProxy:           bootstrapClusterProxy,
			Namespace:              namespace,
			CancelWatches:          cancelWatches,
			IntervalsGetter:        e2eConfig.GetIntervals,
			SkipCleanup:            skipCleanup,
			SkipLogCollection:      skipLogCollection,
			AdditionalCleanup:      additionalCleanup,
			ArtifactFolder:         artifactFolder,
			SkipResourceGroupCheck: skipResourceGroupCheck,
		}
		dumpSpecResourcesAndCleanup(ctx, cleanInput)
		Expect(os.Unsetenv(AzureResourceGroup)).To(Succeed())
		Expect(os.Unsetenv(AzureCustomVnetResourceGroup)).To(Succeed())
		Expect(os.Unsetenv(AzureVNetName)).To(Succeed())
		Expect(os.Unsetenv(ClusterIdentityName)).To(Succeed())
		Expect(os.Unsetenv(ClusterIdentityNamespace)).To(Succeed())

		Expect(os.Unsetenv("WINDOWS_WORKER_MACHINE_COUNT")).To(Succeed())
		Expect(os.Unsetenv("K8S_FEATURE_GATES")).To(Succeed())

		logCheckpoint(specTimes)
	})

	if os.Getenv("USE_LOCAL_KIND_REGISTRY") != "true" {
		// This spec expects a user-assigned identity with Contributor role assignment named "cloud-provider-user-identity" in a "capz-ci"
		// resource group. Override these defaults by setting the USER_IDENTITY and CI_RG environment variables.
		Context("Creating a private cluster [OPTIONAL]", func() {
			It("Creates a public management cluster in a custom vnet", func() {
				clusterName = getClusterName(clusterNamePrefix, "public-custom-vnet")
				By("Creating a custom virtual network", func() {
					Expect(os.Setenv(AzureCustomVNetName, "custom-vnet")).To(Succeed())
					Expect(os.Setenv(AzureCustomVnetResourceGroup, clusterName+"-vnetrg")).To(Succeed())
					additionalCleanup = SetupExistingVNet(ctx,
						"10.0.0.0/16",
						map[string]string{fmt.Sprintf("%s-controlplane-subnet", os.Getenv(AzureCustomVNetName)): "10.0.0.0/24"},
						map[string]string{fmt.Sprintf("%s-node-subnet", os.Getenv(AzureCustomVNetName)): "10.0.1.0/24"},
						fmt.Sprintf("%s-azure-bastion-subnet", os.Getenv(AzureCustomVNetName)),
						"10.0.2.0/24",
					)
				})

				clusterctl.ApplyClusterTemplateAndWait(ctx, createApplyClusterTemplateInput(
					specName,
					withFlavor("custom-vnet"),
					withNamespace(namespace.Name),
					withClusterName(clusterName),
					withControlPlaneMachineCount(1),
					withWorkerMachineCount(1),
					withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
						WaitForControlPlaneInitialized: EnsureControlPlaneInitializedNoAddons,
					}),
					withPostMachinesProvisioned(func() {
						EnsureDaemonsets(ctx, func() DaemonsetsSpecInput {
							return DaemonsetsSpecInput{
								BootstrapClusterProxy: bootstrapClusterProxy,
								Namespace:             namespace,
								ClusterName:           clusterName,
							}
						})
					}),
				), result)

				By("Creating a private cluster from the management cluster", func() {
					AzurePrivateClusterSpec(ctx, func() AzurePrivateClusterSpecInput {
						return AzurePrivateClusterSpecInput{
							BootstrapClusterProxy: bootstrapClusterProxy,
							Namespace:             namespace,
							ClusterName:           clusterName,
							ClusterctlConfigPath:  clusterctlConfigPath,
							E2EConfig:             e2eConfig,
							ArtifactFolder:        artifactFolder,
							SkipCleanup:           skipCleanup,
							CancelWatches:         cancelWatches,
						}
					})
				})

				By("PASSED!")
			})
		})
	} else {
		fmt.Fprintf(GinkgoWriter, "INFO: skipping test requires pushing container images to external repository")
	}

	Context("Creating a highly available cluster [REQUIRED]", func() {
		It("With 3 control-plane nodes and 2 Linux and 2 Windows worker nodes", func() {
			clusterName = getClusterName(clusterNamePrefix, "ha")

			// Opt into using windows with prow template
			Expect(os.Setenv("WINDOWS_WORKER_MACHINE_COUNT", "2")).To(Succeed())

			clusterctl.ApplyClusterTemplateAndWait(ctx, createApplyClusterTemplateInput(
				specName,
				withNamespace(namespace.Name),
				withClusterName(clusterName),
				withControlPlaneMachineCount(3),
				withWorkerMachineCount(2),
				withControlPlaneInterval(specName, "wait-control-plane-ha"),
				withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
					WaitForControlPlaneInitialized: EnsureControlPlaneInitializedNoAddons,
				}),
				withPostMachinesProvisioned(func() {
					EnsureDaemonsets(ctx, func() DaemonsetsSpecInput {
						return DaemonsetsSpecInput{
							BootstrapClusterProxy: bootstrapClusterProxy,
							Namespace:             namespace,
							ClusterName:           clusterName,
						}
					})
				}),
			), result)

			By("Verifying expected VM extensions are present on the node", func() {
				AzureVMExtensionsSpec(ctx, func() AzureVMExtensionsSpecInput {
					return AzureVMExtensionsSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
					}
				})
			})

			By("Verifying security rules are deleted on azure side", func() {
				AzureSecurityGroupsSpec(ctx, func() AzureSecurityGroupsSpecInput {
					return AzureSecurityGroupsSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						Cluster:               result.Cluster,
						WaitForUpdate:         e2eConfig.GetIntervals(specName, "wait-nsg-update"),
					}
				})
			})

			By("Validating failure domains", func() {
				AzureFailureDomainsSpec(ctx, func() AzureFailureDomainsSpecInput {
					return AzureFailureDomainsSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Cluster:               result.Cluster,
						Namespace:             namespace,
						ClusterName:           clusterName,
					}
				})
			})

			By("Creating an accessible load balancer", func() {
				AzureLBSpec(ctx, func() AzureLBSpecInput {
					return AzureLBSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						SkipCleanup:           skipCleanup,
					}
				})
			})

			By("Validating network policies", func() {
				AzureNetPolSpec(ctx, func() AzureNetPolSpecInput {
					return AzureNetPolSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						SkipCleanup:           skipCleanup,
					}
				})
			})

			By("Creating an accessible load balancer for windows", func() {
				AzureLBSpec(ctx, func() AzureLBSpecInput {
					return AzureLBSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						SkipCleanup:           skipCleanup,
						Windows:               true,
					}
				})
			})

			By("PASSED!")
		})
	})

	When("Creating a highly available cluster with Azure CNI v1 [REQUIRED]", Label("Azure CNI v1"), func() {
		It("can create 3 control-plane nodes and 2 Linux worker nodes", func() {
			clusterName = getClusterName(clusterNamePrefix, "azcni-v1")

			clusterctl.ApplyClusterTemplateAndWait(ctx, createApplyClusterTemplateInput(
				specName,
				withAzureCNIv1Manifest(e2eConfig.GetVariable(AzureCNIv1Manifest)), // AzureCNIManifest is set
				withFlavor("azure-cni-v1"),
				withNamespace(namespace.Name),
				withClusterName(clusterName),
				withControlPlaneMachineCount(3),
				withWorkerMachineCount(2),
				withControlPlaneInterval(specName, "wait-control-plane-ha"),
				withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
					WaitForControlPlaneInitialized: EnsureControlPlaneInitializedNoAddons,
				}),
				withPostMachinesProvisioned(func() {
					EnsureDaemonsets(ctx, func() DaemonsetsSpecInput {
						return DaemonsetsSpecInput{
							BootstrapClusterProxy: bootstrapClusterProxy,
							Namespace:             namespace,
							ClusterName:           clusterName,
						}
					})
				}),
			), result)

			By("can expect VM extensions are present on the node", func() {
				AzureVMExtensionsSpec(ctx, func() AzureVMExtensionsSpecInput {
					return AzureVMExtensionsSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
					}
				})
			})

			By("can validate failure domains", func() {
				AzureFailureDomainsSpec(ctx, func() AzureFailureDomainsSpecInput {
					return AzureFailureDomainsSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Cluster:               result.Cluster,
						Namespace:             namespace,
						ClusterName:           clusterName,
					}
				})
			})

			By("can create an accessible load balancer", func() {
				AzureLBSpec(ctx, func() AzureLBSpecInput {
					return AzureLBSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						SkipCleanup:           skipCleanup,
					}
				})
			})
		})
	})

	Context("Creating a Flatcar cluster [OPTIONAL]", func() {
		It("With Flatcar control-plane and worker nodes", func() {
			clusterName = getClusterName(clusterNamePrefix, "flatcar")
			clusterctl.ApplyClusterTemplateAndWait(ctx, createApplyClusterTemplateInput(
				specName,
				withFlavor("flatcar"),
				withNamespace(namespace.Name),
				withClusterName(clusterName),
				withKubernetesVersion(e2eConfig.GetVariable(FlatcarKubernetesVersion)),
				withControlPlaneMachineCount(1),
				withWorkerMachineCount(1),
				withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
					WaitForControlPlaneInitialized: EnsureControlPlaneInitializedNoAddons,
				}),
				withPostMachinesProvisioned(func() {
					EnsureDaemonsets(ctx, func() DaemonsetsSpecInput {
						return DaemonsetsSpecInput{
							BootstrapClusterProxy: bootstrapClusterProxy,
							Namespace:             namespace,
							ClusterName:           clusterName,
						}
					})
				}),
			), result)

			By("can create and access a load balancer", func() {
				AzureLBSpec(ctx, func() AzureLBSpecInput {
					return AzureLBSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						SkipCleanup:           skipCleanup,
					}
				})
			})
		})
	})

	Context("Creating a cluster with spot vms [OPTIONAL]", func() {
		It("With spot vm machine deployments", func() {
			clusterName = getClusterName(clusterNamePrefix, "spot")
			clusterctl.ApplyClusterTemplateAndWait(ctx, createApplyClusterTemplateInput(
				specName,
				withFlavor("spot"),
				withNamespace(namespace.Name),
				withClusterName(clusterName),
				withControlPlaneMachineCount(1),
				withWorkerMachineCount(1),
				withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
					WaitForControlPlaneInitialized: EnsureControlPlaneInitializedNoAddons,
				}),
				withPostMachinesProvisioned(func() {
					EnsureDaemonsets(ctx, func() DaemonsetsSpecInput {
						return DaemonsetsSpecInput{
							BootstrapClusterProxy: bootstrapClusterProxy,
							Namespace:             namespace,
							ClusterName:           clusterName,
						}
					})
				}),
			), result)

			By("can create and access a load balancer", func() {
				AzureLBSpec(ctx, func() AzureLBSpecInput {
					return AzureLBSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						SkipCleanup:           skipCleanup,
					}
				})
			})
		})
	})

	Context("Creating a ipv6 control-plane cluster [REQUIRED]", func() {
		It("With ipv6 worker node", func() {
			clusterName = getClusterName(clusterNamePrefix, "ipv6")
			clusterctl.ApplyClusterTemplateAndWait(ctx, createApplyClusterTemplateInput(
				specName,
				withFlavor("ipv6"),
				withNamespace(namespace.Name),
				withClusterName(clusterName),
				withControlPlaneMachineCount(3),
				withWorkerMachineCount(1),
				withControlPlaneInterval(specName, "wait-control-plane-ha"),
				withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
					WaitForControlPlaneInitialized: EnsureControlPlaneInitializedNoAddons,
				}),
				withPostMachinesProvisioned(func() {
					EnsureDaemonsets(ctx, func() DaemonsetsSpecInput {
						return DaemonsetsSpecInput{
							BootstrapClusterProxy: bootstrapClusterProxy,
							Namespace:             namespace,
							ClusterName:           clusterName,
						}
					})
				}),
			), result)

			By("Verifying expected VM extensions are present on the node", func() {
				AzureVMExtensionsSpec(ctx, func() AzureVMExtensionsSpecInput {
					return AzureVMExtensionsSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
					}
				})
			})

			By("Creating an accessible ipv6 load balancer", func() {
				AzureLBSpec(ctx, func() AzureLBSpecInput {
					return AzureLBSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						SkipCleanup:           skipCleanup,
						// Setting IPFamily to ipv6 is not required for single-stack IPv6 clusters. The clusterIP
						// will be automatically assigned IPv6 address. However, setting this config so that
						// we can use the same test code for both single-stack and dual-stack IPv6 clusters.
						IPFamilies: []corev1.IPFamily{corev1.IPv6Protocol},
					}
				})
			})

			By("PASSED!")
		})
	})

	Context("Creating a VMSS cluster [REQUIRED]", func() {
		It("with a single control plane node and an AzureMachinePool with 2 Linux and 2 Windows worker nodes", func() {
			clusterName = getClusterName(clusterNamePrefix, "vmss")

			// Opt into using windows with prow template
			Expect(os.Setenv("WINDOWS_WORKER_MACHINE_COUNT", "2")).To(Succeed())

			clusterctl.ApplyClusterTemplateAndWait(ctx, createApplyClusterTemplateInput(
				specName,
				withFlavor("machine-pool"),
				withNamespace(namespace.Name),
				withClusterName(clusterName),
				withControlPlaneMachineCount(1),
				withWorkerMachineCount(2),
				withMachineDeploymentInterval(specName, ""),
				withControlPlaneInterval(specName, "wait-control-plane"),
				withMachinePoolInterval(specName, "wait-machine-pool-nodes"),
				withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
					WaitForControlPlaneInitialized: EnsureControlPlaneInitializedNoAddons,
				}),
				withPostMachinesProvisioned(func() {
					EnsureDaemonsets(ctx, func() DaemonsetsSpecInput {
						return DaemonsetsSpecInput{
							BootstrapClusterProxy: bootstrapClusterProxy,
							Namespace:             namespace,
							ClusterName:           clusterName,
						}
					})
				}),
			), result)

			By("Verifying expected VM extensions are present on the node", func() {
				AzureVMExtensionsSpec(ctx, func() AzureVMExtensionsSpecInput {
					return AzureVMExtensionsSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
					}
				})
			})

			By("Creating an accessible load balancer", func() {
				AzureLBSpec(ctx, func() AzureLBSpecInput {
					return AzureLBSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						SkipCleanup:           skipCleanup,
					}
				})
			})

			By("Creating an accessible load balancer for windows", func() {
				AzureLBSpec(ctx, func() AzureLBSpecInput {
					return AzureLBSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						SkipCleanup:           skipCleanup,
						Windows:               true,
					}
				})
			})

			By("PASSED!")
		})
	})

	// ci-e2e.sh and Prow CI skip this test by default, since N-series GPUs are relatively expensive
	// and may require specific quota limits on the subscription.
	// To include this test, set `GINKGO_SKIP=""`.
	// You can override the default SKU `Standard_NV12s_v3` and `Premium_LRS` storage by setting
	// the `AZURE_GPU_NODE_MACHINE_TYPE` and `AZURE_GPU_NODE_STORAGE_TYPE` environment variables.
	// See https://azure.microsoft.com/en-us/pricing/details/virtual-machines/linux/ for pricing.
	Context("Creating a GPU-enabled cluster [OPTIONAL]", func() {
		It("with a single control plane node and 1 node", func() {
			Skip("Skipping since the e2e subscription has no quota for GPU SKUs")
			clusterName = getClusterName(clusterNamePrefix, "gpu")
			clusterctl.ApplyClusterTemplateAndWait(ctx, createApplyClusterTemplateInput(
				specName,
				withFlavor("nvidia-gpu"),
				withNamespace(namespace.Name),
				withClusterName(clusterName),
				withControlPlaneMachineCount(1),
				withWorkerMachineCount(1),
				withMachineDeploymentInterval(specName, "wait-gpu-nodes"),
				withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
					WaitForControlPlaneInitialized: EnsureControlPlaneInitializedNoAddons,
				}),
				withPostMachinesProvisioned(func() {
					EnsureDaemonsets(ctx, func() DaemonsetsSpecInput {
						return DaemonsetsSpecInput{
							BootstrapClusterProxy: bootstrapClusterProxy,
							Namespace:             namespace,
							ClusterName:           clusterName,
						}
					})
					InstallGPUOperator(ctx, func() GPUOperatorSpecInput {
						return GPUOperatorSpecInput{
							BootstrapClusterProxy: bootstrapClusterProxy,
							Namespace:             namespace,
							ClusterName:           clusterName,
						}
					})
				}),
			), result)

			By("Verifying expected VM extensions are present on the node", func() {
				AzureVMExtensionsSpec(ctx, func() AzureVMExtensionsSpecInput {
					return AzureVMExtensionsSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
					}
				})
			})

			By("Running a GPU-based calculation", func() {
				AzureGPUSpec(ctx, func() AzureGPUSpecInput {
					return AzureGPUSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						SkipCleanup:           skipCleanup,
					}
				})
			})

			By("PASSED!")
		})
	})

	// ci-e2e.sh and Prow CI skip this test by default. To include this test, set `GINKGO_SKIP=""`.
	Context("Creating a cluster with VMSS flex machinepools [OPTIONAL]", func() {
		It("with 1 control plane node and 1 machinepool", func() {
			clusterName = getClusterName(clusterNamePrefix, "flex")
			clusterctl.ApplyClusterTemplateAndWait(ctx, createApplyClusterTemplateInput(
				specName,
				withFlavor("machine-pool-flex"),
				withNamespace(namespace.Name),
				withClusterName(clusterName),
				withControlPlaneMachineCount(1),
				withWorkerMachineCount(1),
				withMachineDeploymentInterval(specName, ""),
				withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
					WaitForControlPlaneInitialized: EnsureControlPlaneInitializedNoAddons,
				}),
				withMachinePoolInterval(specName, "wait-machine-pool-nodes"),
				withControlPlaneInterval(specName, "wait-control-plane"),
			), result)

			By("Verifying machinepool can scale out and in", func() {
				AzureMachinePoolsSpec(ctx, func() AzureMachinePoolsSpecInput {
					return AzureMachinePoolsSpecInput{
						Cluster:               result.Cluster,
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						WaitIntervals:         e2eConfig.GetIntervals(specName, "wait-worker-nodes"),
					}
				})
			})

			By("Verifying expected VM extensions are present on the node", func() {
				AzureVMExtensionsSpec(ctx, func() AzureVMExtensionsSpecInput {
					return AzureVMExtensionsSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
					}
				})
			})

			By("Creating an accessible load balancer", func() {
				AzureLBSpec(ctx, func() AzureLBSpecInput {
					return AzureLBSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						SkipCleanup:           skipCleanup,
					}
				})
			})

			By("PASSED!")
		})
	})

	// You can override the default SKU `Standard_D2s_v3` by setting the
	// `AZURE_AKS_NODE_MACHINE_TYPE` environment variable.
	Context("Creating an AKS cluster for control plane tests [Managed Kubernetes]", func() {
		It("with a single control plane node and 1 node", func() {
			clusterName = getClusterName(clusterNamePrefix, aksClusterNameSuffix)
			kubernetesVersionUpgradeFrom, err := GetAKSKubernetesVersion(ctx, e2eConfig, AKSKubernetesVersionUpgradeFrom)
			Byf("Upgrading from k8s version %s", kubernetesVersionUpgradeFrom)
			Expect(err).NotTo(HaveOccurred())
			kubernetesVersion, err := GetAKSKubernetesVersion(ctx, e2eConfig, AKSKubernetesVersion)
			Byf("Upgrading to k8s version %s", kubernetesVersion)
			Expect(err).NotTo(HaveOccurred())

			clusterTemplate := createApplyClusterTemplateInput(
				specName,
				withFlavor("aks"),
				withAzureCNIv1Manifest(e2eConfig.GetVariable(AzureCNIv1Manifest)),
				withNamespace(namespace.Name),
				withClusterName(clusterName),
				withKubernetesVersion(kubernetesVersionUpgradeFrom),
				withControlPlaneMachineCount(1),
				withWorkerMachineCount(1),
				withMachineDeploymentInterval(specName, ""),
				withMachinePoolInterval(specName, "wait-worker-nodes"),
				withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
					WaitForControlPlaneInitialized:   WaitForAKSControlPlaneInitialized,
					WaitForControlPlaneMachinesReady: WaitForAKSControlPlaneReady,
				}),
			)

			clusterctl.ApplyClusterTemplateAndWait(ctx, clusterTemplate, result)

			// This test should be first to make sure that the template re-applied here matches the current
			// state of the cluster exactly.
			By("orphaning and adopting the cluster", func() {
				AKSAdoptSpec(ctx, func() AKSAdoptSpecInput {
					return AKSAdoptSpecInput{
						ApplyInput:   clusterTemplate,
						ApplyResult:  result,
						Cluster:      result.Cluster,
						MachinePools: result.MachinePools,
					}
				})
			})

			By("adding an AKS marketplace extension", func() {
				AKSMarketplaceExtensionSpec(ctx, func() AKSMarketplaceExtensionSpecInput {
					return AKSMarketplaceExtensionSpecInput{
						Cluster:       result.Cluster,
						WaitIntervals: e2eConfig.GetIntervals(specName, "wait-machine-pool-nodes"),
					}
				})
			})

			By("attaching the cluster to azure fleet", func() {
				AKSFleetsMemberSpec(ctx, func() AKSFleetsMemberInput {
					return AKSFleetsMemberInput{
						Cluster:       result.Cluster,
						WaitIntervals: e2eConfig.GetIntervals(specName, "wait-machine-pool-nodes"),
					}
				})
			})

			By("Upgrading the Kubernetes version of the cluster", func() {
				AKSUpgradeSpec(ctx, func() AKSUpgradeSpecInput {
					return AKSUpgradeSpecInput{
						Cluster:                    result.Cluster,
						MachinePools:               result.MachinePools,
						KubernetesVersionUpgradeTo: kubernetesVersion,
						WaitForControlPlane:        e2eConfig.GetIntervals(specName, "wait-machine-upgrade"),
						WaitForMachinePools:        e2eConfig.GetIntervals(specName, "wait-machine-pool-upgrade"),
					}
				})
			})

			By("modifying the azure cluster-autoscaler settings", func() {
				AKSAzureClusterAutoscalerSettingsSpec(ctx, func() AKSAzureClusterAutoscalerSettingsSpecInput {
					return AKSAzureClusterAutoscalerSettingsSpecInput{
						Cluster:       result.Cluster,
						WaitIntervals: e2eConfig.GetIntervals(specName, "wait-control-plane"),
					}
				})
			})
		})
	})

	Context("Creating an AKS cluster for node pool tests [Managed Kubernetes]", func() {
		It("with a single control plane node and 1 node", func() {
			clusterName = getClusterName(clusterNamePrefix, "pool")
			kubernetesVersion, err := GetAKSKubernetesVersion(ctx, e2eConfig, AKSKubernetesVersion)
			Expect(err).NotTo(HaveOccurred())

			clusterctl.ApplyClusterTemplateAndWait(ctx, createApplyClusterTemplateInput(
				specName,
				withFlavor("aks"),
				withAzureCNIv1Manifest(e2eConfig.GetVariable(AzureCNIv1Manifest)),
				withNamespace(namespace.Name),
				withClusterName(clusterName),
				withKubernetesVersion(kubernetesVersion),
				withControlPlaneMachineCount(1),
				withWorkerMachineCount(1),
				withMachineDeploymentInterval(specName, ""),
				withMachinePoolInterval(specName, "wait-worker-nodes"),
				withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
					WaitForControlPlaneInitialized:   WaitForAKSControlPlaneInitialized,
					WaitForControlPlaneMachinesReady: WaitForAKSControlPlaneReady,
				}),
			), result)

			By("Exercising machine pools", func() {
				AKSMachinePoolSpec(ctx, func() AKSMachinePoolSpecInput {
					return AKSMachinePoolSpecInput{
						Cluster:       result.Cluster,
						MachinePools:  result.MachinePools,
						WaitIntervals: e2eConfig.GetIntervals(specName, "wait-machine-pool-nodes"),
					}
				})
			})

			By("creating a machine pool with public IP addresses from a prefix", func() {
				// This test is also currently serving as the canonical
				// "create/delete node pool" test. Eventually, that should be
				// made more distinct from this public IP prefix test.
				AKSPublicIPPrefixSpec(ctx, func() AKSPublicIPPrefixSpecInput {
					return AKSPublicIPPrefixSpecInput{
						Cluster:           result.Cluster,
						KubernetesVersion: kubernetesVersion,
						WaitIntervals:     e2eConfig.GetIntervals(specName, "wait-worker-nodes"),
					}
				})
			})

			By("creating a machine pool with spot max price and scale down mode", func() {
				AKSSpotSpec(ctx, func() AKSSpotSpecInput {
					return AKSSpotSpecInput{
						Cluster:           result.Cluster,
						KubernetesVersion: kubernetesVersion,
						WaitIntervals:     e2eConfig.GetIntervals(specName, "wait-worker-nodes"),
					}
				})
			})

			By("modifying nodepool autoscaling configuration", func() {
				AKSAutoscaleSpec(ctx, func() AKSAutoscaleSpecInput {
					return AKSAutoscaleSpecInput{
						Cluster:       result.Cluster,
						MachinePool:   result.MachinePools[0],
						WaitIntervals: e2eConfig.GetIntervals(specName, "wait-machine-pool-nodes"),
					}
				})
			})

			By("modifying additionalTags configuration", func() {
				AKSAdditionalTagsSpec(ctx, func() AKSAdditionalTagsSpecInput {
					return AKSAdditionalTagsSpecInput{
						Cluster:       result.Cluster,
						MachinePools:  result.MachinePools,
						WaitForUpdate: e2eConfig.GetIntervals(specName, "wait-machine-pool-nodes"),
					}
				})
			})

			By("modifying node labels configuration", func() {
				AKSNodeLabelsSpec(ctx, func() AKSNodeLabelsSpecInput {
					return AKSNodeLabelsSpecInput{
						Cluster:       result.Cluster,
						MachinePools:  result.MachinePools,
						WaitForUpdate: e2eConfig.GetIntervals(specName, "wait-machine-pool-nodes"),
					}
				})
			})

			By("modifying taints configuration", func() {
				AKSNodeTaintsSpec(ctx, func() AKSNodeTaintsSpecInput {
					return AKSNodeTaintsSpecInput{
						Cluster:       result.Cluster,
						MachinePools:  result.MachinePools,
						WaitForUpdate: e2eConfig.GetIntervals(specName, "wait-machine-pool-nodes"),
					}
				})
			})

			By("creating a byo nodepool", func() {
				AKSBYONodeSpec(ctx, func() AKSBYONodeSpecInput {
					return AKSBYONodeSpecInput{
						Cluster:             result.Cluster,
						KubernetesVersion:   kubernetesVersion,
						WaitIntervals:       e2eConfig.GetIntervals(specName, "wait-worker-nodes"),
						ExpectedWorkerNodes: result.ExpectedWorkerNodes(),
					}
				})
			})

			By("modifying custom patches", func() {
				AKSPatchSpec(ctx, func() AKSPatchSpecInput {
					return AKSPatchSpecInput{
						Cluster:       result.Cluster,
						MachinePools:  result.MachinePools,
						WaitForUpdate: e2eConfig.GetIntervals(specName, "wait-machine-pool-nodes"),
					}
				})
			})
		})
	})

	Context("Creating an AKS cluster using ClusterClass [Managed Kubernetes]", func() {
		It("with a single control plane node and 1 node", func() {
			// Use default as the clusterclass name so test infra can find the clusterclass template
			os.Setenv("CLUSTER_CLASS_NAME", "default")

			// Use "cc" as spec name because NAT gateway pip name exceeds limit.
			clusterName = getClusterName(clusterNamePrefix, "cc")
			kubernetesVersionUpgradeFrom, err := GetAKSKubernetesVersion(ctx, e2eConfig, AKSKubernetesVersionUpgradeFrom)
			Byf("Upgrading from k8s version %s", kubernetesVersionUpgradeFrom)
			Expect(err).NotTo(HaveOccurred())
			kubernetesVersion, err := GetAKSKubernetesVersion(ctx, e2eConfig, AKSKubernetesVersion)
			Byf("Upgrading to k8s version %s", kubernetesVersion)
			Expect(err).NotTo(HaveOccurred())

			// Create a cluster using the cluster class created above
			clusterctl.ApplyClusterTemplateAndWait(ctx, createApplyClusterTemplateInput(
				specName,
				withFlavor("aks-topology"),
				withAzureCNIv1Manifest(e2eConfig.GetVariable(AzureCNIv1Manifest)),
				withNamespace(namespace.Name),
				withClusterName(clusterName),
				withKubernetesVersion(kubernetesVersionUpgradeFrom),
				withControlPlaneMachineCount(1),
				withWorkerMachineCount(1),
				withMachineDeploymentInterval(specName, ""),
				withMachinePoolInterval(specName, "wait-machine-pool-nodes"),
				withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
					WaitForControlPlaneInitialized:   WaitForAKSControlPlaneInitialized,
					WaitForControlPlaneMachinesReady: WaitForAKSControlPlaneReady,
				}),
			), result)

			By("Performing ClusterClass operations on the cluster", func() {
				AKSClusterClassSpec(ctx, func() AKSClusterClassInput {
					return AKSClusterClassInput{
						Cluster:                    result.Cluster,
						MachinePool:                result.MachinePools[0],
						WaitIntervals:              e2eConfig.GetIntervals(specName, "wait-machine-pool-nodes"),
						WaitUpgradeIntervals:       e2eConfig.GetIntervals(specName, "wait-machine-pool-upgrade"),
						KubernetesVersionUpgradeTo: kubernetesVersion,
					}
				})
			})
		})
	})

	Context("Creating an AKS cluster with the ASO API [Managed Kubernetes]", func() {
		It("with a single control plane node and 1 node", func() {
			clusterName = getClusterName(clusterNamePrefix, "asoapi")
			kubernetesVersion, err := GetAKSKubernetesVersion(ctx, e2eConfig, AKSKubernetesVersion)
			Expect(err).NotTo(HaveOccurred())

			clusterctl.ApplyClusterTemplateAndWait(ctx, createApplyClusterTemplateInput(
				specName,
				withFlavor("aks-aso"),
				withNamespace(namespace.Name),
				withClusterName(clusterName),
				withKubernetesVersion(kubernetesVersion),
				withWorkerMachineCount(1),
				withMachinePoolInterval(specName, "wait-worker-nodes"),
				withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
					WaitForControlPlaneInitialized:   WaitForAKSControlPlaneInitialized,
					WaitForControlPlaneMachinesReady: WaitForAKSControlPlaneReady,
				}),
			), result)

			By("Exercising machine pools", func() {
				AKSMachinePoolSpec(ctx, func() AKSMachinePoolSpecInput {
					return AKSMachinePoolSpecInput{
						Cluster:       result.Cluster,
						MachinePools:  result.MachinePools,
						WaitIntervals: e2eConfig.GetIntervals(specName, "wait-machine-pool-nodes"),
					}
				})
			})
		})
	})

	// ci-e2e.sh and Prow CI skip this test by default. To include this test, set `GINKGO_SKIP=""`.
	// This spec expects a user-assigned identity named "cloud-provider-user-identity" in a "capz-ci"
	// resource group. Override these defaults by setting the USER_IDENTITY and CI_RG environment variables.
	Context("Creating a dual-stack cluster [OPTIONAL]", func() {
		It("With dual-stack worker node", func() {
			By("using user-assigned identity")
			clusterName = getClusterName(clusterNamePrefix, "dual-stack")
			clusterctl.ApplyClusterTemplateAndWait(ctx, createApplyClusterTemplateInput(
				specName,
				withClusterProxy(bootstrapClusterProxy),
				withFlavor("dual-stack"),
				withNamespace(namespace.Name),
				withClusterName(clusterName),
				withControlPlaneMachineCount(3),
				withWorkerMachineCount(1),
				withControlPlaneInterval(specName, "wait-control-plane-ha"),
				withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
					WaitForControlPlaneInitialized: EnsureControlPlaneInitializedNoAddons,
				}),
				withPostMachinesProvisioned(func() {
					EnsureDaemonsets(ctx, func() DaemonsetsSpecInput {
						return DaemonsetsSpecInput{
							BootstrapClusterProxy: bootstrapClusterProxy,
							Namespace:             namespace,
							ClusterName:           clusterName,
						}
					})
				}),
			), result)

			By("Verifying expected VM extensions are present on the node", func() {
				AzureVMExtensionsSpec(ctx, func() AzureVMExtensionsSpecInput {
					return AzureVMExtensionsSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
					}
				})
			})

			// dual-stack external IP for dual-stack clusters is not yet supported
			// first ip family in ipFamilies is used for the primary clusterIP and cloud-provider
			// determines the elb/ilb ip family based on the primary clusterIP
			By("Creating an accessible ipv4 load balancer", func() {
				AzureLBSpec(ctx, func() AzureLBSpecInput {
					return AzureLBSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						SkipCleanup:           skipCleanup,
						IPFamilies:            []corev1.IPFamily{corev1.IPv4Protocol},
					}
				})
			})

			By("Creating an accessible ipv6 load balancer", func() {
				AzureLBSpec(ctx, func() AzureLBSpecInput {
					return AzureLBSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						SkipCleanup:           skipCleanup,
						IPFamilies:            []corev1.IPFamily{corev1.IPv6Protocol},
					}
				})
			})

			By("PASSED!")
		})
	})

	Context("Creating clusters using clusterclass [OPTIONAL]", func() {
		It("with a single control plane node, one linux worker node, and one windows worker node", func() {
			// Use ci-default as the clusterclass name so test infra can find the clusterclass template
			os.Setenv("CLUSTER_CLASS_NAME", "ci-default")

			// Use "cc" as spec name because NAT gateway pip name exceeds limit.
			clusterName = getClusterName(clusterNamePrefix, "cc")

			// Opt into using windows with prow template
			Expect(os.Setenv("WINDOWS_WORKER_MACHINE_COUNT", "1")).To(Succeed())

			// Create a cluster using the cluster class created above
			clusterctl.ApplyClusterTemplateAndWait(ctx, createApplyClusterTemplateInput(
				specName,
				withFlavor("topology"),
				withNamespace(namespace.Name),
				withClusterName(clusterName),
				withControlPlaneMachineCount(1),
				withWorkerMachineCount(1),
				withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
					WaitForControlPlaneInitialized: EnsureControlPlaneInitializedNoAddons,
				}),
				withPostMachinesProvisioned(func() {
					EnsureDaemonsets(ctx, func() DaemonsetsSpecInput {
						return DaemonsetsSpecInput{
							BootstrapClusterProxy: bootstrapClusterProxy,
							Namespace:             namespace,
							ClusterName:           clusterName,
						}
					})
				}),
			), result)

			By("Verifying expected VM extensions are present on the node", func() {
				AzureVMExtensionsSpec(ctx, func() AzureVMExtensionsSpecInput {
					return AzureVMExtensionsSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
					}
				})
			})

			By("PASSED!")
		})
	})

	// ci-e2e.sh and Prow CI skip this test by default. To include this test, set `GINKGO_SKIP=""`.
	// This spec expects a user-assigned identity named "cloud-provider-user-identity" in a "capz-ci"
	// resource group. Override these defaults by setting the USER_IDENTITY and CI_RG environment variables.
	// You can also override the default SKU `Standard_DS2_v2` and `Standard_DS4_v2` storage by setting
	// the `AZURE_EDGEZONE_CONTROL_PLANE_MACHINE_TYPE` and `AZURE_EDGEZONE_NODE_MACHINE_TYPE` environment variables.
	Context("Creating clusters on public MEC [OPTIONAL]", func() {
		It("with 1 control plane nodes and 1 worker node", func() {
			Skip("Skipping public MEC test until a new edgezone is available")
			By("using user-assigned identity")
			clusterName = getClusterName(clusterNamePrefix, "edgezone")
			clusterctl.ApplyClusterTemplateAndWait(ctx, createApplyClusterTemplateInput(
				specName,
				withFlavor("edgezone"),
				withNamespace(namespace.Name),
				withClusterName(clusterName),
				withControlPlaneMachineCount(1),
				withWorkerMachineCount(1),
				withControlPlaneWaiters(clusterctl.ControlPlaneWaiters{
					WaitForControlPlaneInitialized: EnsureControlPlaneInitializedNoAddons,
				}),
				withPostMachinesProvisioned(func() {
					EnsureDaemonsets(ctx, func() DaemonsetsSpecInput {
						return DaemonsetsSpecInput{
							BootstrapClusterProxy: bootstrapClusterProxy,
							Namespace:             namespace,
							ClusterName:           clusterName,
						}
					})
				}),
			), result)

			By("Verifying extendedLocation property in Azure VMs is corresponding to extendedLocation property in edgezone yaml file", func() {
				AzureEdgeZoneClusterSpec(ctx, func() AzureEdgeZoneClusterSpecInput {
					return AzureEdgeZoneClusterSpecInput{
						BootstrapClusterProxy: bootstrapClusterProxy,
						Namespace:             namespace,
						ClusterName:           clusterName,
						E2EConfig:             e2eConfig,
					}
				})
			})

			By("PASSED!")
		})
	})
})