Merge pull request #5910 from fabriziopandini/e2e-collect-kind-logs

🌱 Collect kind logs when e2e bootstrap fails

docs/book/src/developer/providers/v1.0-to-v1.1.md

@@ -58,6 +58,8 @@ are kept in sync with the versions used by `sigs.k8s.io/controller-runtime`.
     * e2e tests:
         * `QuickStartSpec` is now able to test clusters using ClusterClass. Please see this [PR](https://github.com/kubernetes-sigs/cluster-api/pull/5423) for an example on how to use it.
         * `SelfHostedSpec` is now able to test clusters using ClusterClass. Please see this [PR](https://github.com/kubernetes-sigs/cluster-api/pull/5600) for an example on how to use it.
+* Test framework provides better logging in case of failures when creating the bootstrap kind cluster; in order to
+  fully exploit this feature, it is required to pass the `LogFolder` parameter when calling `CreateKindBootstrapClusterAndLoadImages`. Please see this [PR](https://github.com/kubernetes-sigs/cluster-api/pull/5910) for an example on how to use it. 
 * The `gci` linter has been enabled to enforce consistent imports. As usual, feel free to take a look at our linter config, but of course it's not mandatory to adopt it.
 * The Tilt dev setup has been extended with:
     * [an option to deploy Grafana, Loki and promtail](https://github.com/kubernetes-sigs/cluster-api/pull/5336) 

test/e2e/e2e_suite_test.go

@@ -218,6 +218,7 @@ func setupBootstrapCluster(config *clusterctl.E2EConfig, scheme *runtime.Scheme,
 			RequiresDockerSock: config.HasDockerProvider(),
 			Images:             config.Images,
 			IPFamily:           config.GetVariable(IPFamily),
+			LogFolder:          filepath.Join(artifactFolder, "kind"),
 		})
 		Expect(clusterProvider).ToNot(BeNil(), "Failed to create a bootstrap cluster")
 

test/framework/bootstrap/kind_provider.go

@@ -74,6 +74,13 @@ func WithIPv6Family() KindClusterOption {
 	})
 }
 
+// LogFolder implements a New Option that instruct the kindClusterProvider to dump bootstrap logs in a folder in case of errors.
+func LogFolder(path string) KindClusterOption {
+	return kindClusterOptionAdapter(func(k *KindClusterProvider) {
+		k.logFolder = path
+	})
+}
+
 // NewKindClusterProvider returns a ClusterProvider that can create a kind cluster.
 func NewKindClusterProvider(name string, options ...KindClusterOption) *KindClusterProvider {
 	Expect(name).ToNot(BeEmpty(), "name is required for NewKindClusterProvider")
@@ -94,6 +101,7 @@ type KindClusterProvider struct {
 	kubeconfigPath string
 	nodeImage      string
 	ipFamily       clusterv1.ClusterIPFamily
+	logFolder      string
 }
 
 // Create a Kubernetes cluster using kind.
@@ -141,9 +149,18 @@ func (k *KindClusterProvider) createKindCluster() {
 		nodeImage = k.nodeImage
 	}
 	kindCreateOptions = append(kindCreateOptions, kind.CreateWithNodeImage(nodeImage))
+	kindCreateOptions = append(kindCreateOptions, kind.CreateWithRetain(true))
 
-	err := kind.NewProvider(kind.ProviderWithLogger(cmd.NewLogger())).Create(k.name, kindCreateOptions...)
+	provider := kind.NewProvider(kind.ProviderWithLogger(cmd.NewLogger()))
+	err := provider.Create(k.name, kindCreateOptions...)
 	if err != nil {
+		// if requested, dump kind logs
+		if k.logFolder != "" {
+			if err := provider.CollectLogs(k.name, k.logFolder); err != nil {
+				log.Logf("Failed to collect logs from kind: %v", err)
+			}
+		}
+
 		errStr := fmt.Sprintf("Failed to create kind cluster %q: %v", k.name, err)
 		// Extract the details of the RunError, if the cluster creation was triggered by a RunError.
 		var runErr *exec.RunError

test/framework/bootstrap/kind_util.go

@@ -49,6 +49,9 @@ type CreateKindBootstrapClusterAndLoadImagesInput struct {
 
 	// IPFamily is either ipv4 or ipv6. Default is ipv4.
 	IPFamily string
+
+	// LogFolder where to dump logs in case of errors
+	LogFolder string
 }
 
 // CreateKindBootstrapClusterAndLoadImages returns a new Kubernetes cluster with pre-loaded images.
@@ -68,6 +71,9 @@ func CreateKindBootstrapClusterAndLoadImages(ctx context.Context, input CreateKi
 	if input.IPFamily == "IPv6" {
 		options = append(options, WithIPv6Family())
 	}
+	if input.LogFolder != "" {
+		options = append(options, LogFolder(input.LogFolder))
+	}
 
 	clusterProvider := NewKindClusterProvider(input.Name, options...)
 	Expect(clusterProvider).ToNot(BeNil(), "Failed to create a kind cluster")