E2E: Collect console log from machines

We already try to collect logs by ssh'ing to the machines.
However, that relies on having an IP and bastion/security groups that allow it.
Getting the console log should be able to give us more logs in more situations.

Signed-off-by: Lennart Jern <[email protected]>

Author: lentzi90

pkg/clients/compute.go

@@ -68,6 +68,7 @@ type ComputeClient interface {
 	DeleteAttachedInterface(serverID, portID string) error
 
 	ListServerGroups() ([]servergroups.ServerGroup, error)
+	GetConsoleOutput(serverID string) (string, error)
 	WithMicroversion(required string) (ComputeClient, error)
 }
 
@@ -186,6 +187,11 @@ func (c computeClient) ListServerGroups() ([]servergroups.ServerGroup, error) {
 	return servergroups.ExtractServerGroups(allPages)
 }
 
+func (c computeClient) GetConsoleOutput(serverID string) (string, error) {
+	opts := servers.ShowConsoleOutputOpts{}
+	return servers.ShowConsoleOutput(context.TODO(), c.client, serverID, opts).Extract()
+}
+
 // WithMicroversion checks that the required Nova microversion is supported and sets it for
 // the ComputeClient.
 func (c computeClient) WithMicroversion(required string) (ComputeClient, error) {
@@ -244,6 +250,10 @@ func (e computeErrorClient) ListServerGroups() ([]servergroups.ServerGroup, erro
 	return nil, e.error
 }
 
+func (e computeErrorClient) GetConsoleOutput(_ string) (string, error) {
+	return "", e.error
+}
+
 func (e computeErrorClient) WithMicroversion(_ string) (ComputeClient, error) {
 	return nil, e.error
 }

pkg/clients/mock/compute.go

@@ -191,6 +191,21 @@ func (o OpenStackLogCollector) CollectMachineLog(ctx context.Context, management
 		return fmt.Errorf("couldn't create directory %q for logs: %s", outputPath, err)
 	}
 
+	if m.Spec.ProviderID == nil {
+		return fmt.Errorf("unable to get logs for machine since it has no provider ID")
+	}
+	providerID := getIDFromProviderID(*m.Spec.ProviderID)
+
+	consolLog, err := GetOpenStackServerConsoleLog(o.E2EContext, providerID)
+	if err != nil {
+		return fmt.Errorf("error getting console log for machine: %s", err)
+	}
+	logFile := path.Join(outputPath, "console.log")
+	if err := os.WriteFile(logFile, []byte(consolLog), 0o600); err != nil {
+		return fmt.Errorf("error writing log file: %s", err)
+	}
+	Logf("Console log for machine %q saved", m.Name)
+
 	openStackCluster, err := getOpenStackClusterFromMachine(ctx, managementClusterClient, m)
 	if err != nil {
 		return fmt.Errorf("error getting OpenStackCluster for Machine: %s", err)
@@ -201,7 +216,7 @@ func (o OpenStackLogCollector) CollectMachineLog(ctx context.Context, management
 	}
 	ip := m.Status.Addresses[0].Address
 
-	srv, err := GetOpenStackServerWithIP(o.E2EContext, getIDFromProviderID(*m.Spec.ProviderID), openStackCluster)
+	srv, err := GetOpenStackServerWithIP(o.E2EContext, providerID, openStackCluster)
 	if err != nil {
 		return fmt.Errorf("error getting OpenStack server: %w", err)
 	}

test/e2e/shared/common.go

@@ -929,3 +929,17 @@ func DumpOpenStackLoadBalancers(e2eCtx *E2EContext, filter loadbalancers.ListOpt
 	}
 	return loadBalancersList, nil
 }
+
+func GetOpenStackServerConsoleLog(e2eCtx *E2EContext, id string) (string, error) {
+	providerClient, clientOpts, _, err := GetTenantProviderClient(e2eCtx)
+	if err != nil {
+		_, _ = fmt.Fprintf(GinkgoWriter, "error creating provider client: %s\n", err)
+		return "", nil
+	}
+
+	computeClient, err := clients.NewComputeClient(providerClient, clientOpts)
+	if err != nil {
+		return "", fmt.Errorf("unable to create compute client: %w", err)
+	}
+	return computeClient.GetConsoleOutput(id)
+}