cli: add status cmd

The new command allows checking the status of an upgrade
and which versions are installed.
Also remove the unused restclient.
And make GetConstellationVersion a function.

cli/internal/cmd/status.go

@@ -0,0 +1,175 @@
+/*
+Copyright (c) Edgeless Systems GmbH
+
+SPDX-License-Identifier: AGPL-3.0-only
+*/
+
+package cmd
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/edgelesssys/constellation/v2/cli/internal/cloudcmd"
+	"github.com/edgelesssys/constellation/v2/cli/internal/helm"
+	"github.com/edgelesssys/constellation/v2/internal/constants"
+	"github.com/edgelesssys/constellation/v2/internal/file"
+	"github.com/edgelesssys/constellation/v2/internal/kubernetes/kubectl"
+	"github.com/edgelesssys/constellation/v2/operators/constellation-node-operator/v2/api/v1alpha1"
+	"github.com/spf13/afero"
+	"github.com/spf13/cobra"
+	corev1 "k8s.io/api/core/v1"
+	"k8s.io/client-go/dynamic"
+	"k8s.io/client-go/tools/clientcmd"
+)
+
+// NewStatusCmd returns a new cobra.Command for the statuus command.
+func NewStatusCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "status",
+		Short: "show status of a Constellation cluster",
+		Long: "Show status of a constellation cluster.\n\n" +
+			"Shows microservice, image and Kubernetes versions installed in the cluster. Also show status of current version upgrades.",
+		Args: cobra.NoArgs,
+		RunE: runStatus,
+	}
+	return cmd
+}
+
+// runStatus runs the terminate command.
+func runStatus(cmd *cobra.Command, args []string) error {
+	log, err := newCLILogger(cmd)
+	if err != nil {
+		return fmt.Errorf("creating logger: %w", err)
+	}
+	defer log.Sync()
+
+	kubeClient := kubectl.New()
+
+	fileHandler := file.NewHandler(afero.NewOsFs())
+	kubeConfig, err := fileHandler.Read(constants.AdminConfFilename)
+	if err != nil {
+		return fmt.Errorf("reading admin.conf: %w", err)
+	}
+
+	// need kubectl client to fetch nodes.
+	if err := kubeClient.Initialize(kubeConfig); err != nil {
+		return err
+	}
+
+	restConfig, err := clientcmd.RESTConfigFromKubeConfig(kubeConfig)
+	if err != nil {
+		return fmt.Errorf("creating k8s client config from kubeconfig: %w", err)
+	}
+	// need unstructed client to fetch NodeVersion CRD.
+	unstructuredClient, err := dynamic.NewForConfig(restConfig)
+	if err != nil {
+		return fmt.Errorf("setting up custom resource client: %w", err)
+	}
+
+	// need helm client to fetch service versions.
+	helmClient, err := helm.NewClient(kubectl.New(), constants.AdminConfFilename, constants.HelmNamespace, log)
+	if err != nil {
+		return fmt.Errorf("setting up helm client: %w", err)
+	}
+
+	output, err := status(cmd.Context(), kubeClient, helmClient, cloudcmd.NewNodeVersionClient(unstructuredClient))
+	if err != nil {
+		return fmt.Errorf("getting status: %w", err)
+	}
+
+	cmd.Print(output)
+	return nil
+}
+
+// status queries the cluster for the relevant status information and returns the output string.
+func status(ctx context.Context, kubeClient kubeClient, helmClient helmClient, dynamicInterface cloudcmd.DynamicInterface) (string, error) {
+	nodeVersion, err := cloudcmd.GetConstellationVersion(ctx, dynamicInterface)
+	if err != nil {
+		return "", fmt.Errorf("getting constellation version: %w", err)
+	}
+	if len(nodeVersion.Status.Conditions) != 1 {
+		return "", fmt.Errorf("expected exactly one condition, got %d", len(nodeVersion.Status.Conditions))
+	}
+
+	targetVersions, err := cloudcmd.NewTargetVersions(nodeVersion)
+	if err != nil {
+		return "", fmt.Errorf("getting configured versions: %w", err)
+	}
+
+	serviceVersions, err := helmClient.Versions()
+	if err != nil {
+		return "", fmt.Errorf("getting service versions: %w", err)
+	}
+
+	status, err := cloudcmd.ClusterStatus(ctx, kubeClient)
+	if err != nil {
+		return "", fmt.Errorf("getting cluster status: %w", err)
+	}
+
+	return statusOutput(targetVersions, serviceVersions, status, nodeVersion), nil
+}
+
+// statusOutput creates the status cmd output string by formatting the received information.
+func statusOutput(targetVersions cloudcmd.TargetVersions, serviceVersions helm.ServiceVersions, status map[string]cloudcmd.NodeStatus, nodeVersion v1alpha1.NodeVersion) string {
+	builder := strings.Builder{}
+
+	builder.WriteString(targetVersionsString(targetVersions))
+	builder.WriteString(serviceVersionsString(serviceVersions))
+	builder.WriteString(fmt.Sprintf("Cluster status: %s\n", nodeVersion.Status.Conditions[0].Message))
+	builder.WriteString(nodeStatusString(status, targetVersions))
+
+	return builder.String()
+}
+
+// nodeStatusString creates the node status part of the output string.
+func nodeStatusString(status map[string]cloudcmd.NodeStatus, targetVersions cloudcmd.TargetVersions) string {
+	var upToDateImages int
+	var upToDateK8s int
+	for _, node := range status {
+		if node.KubeletVersion() == targetVersions.Kubernetes() {
+			upToDateK8s++
+		}
+		if node.ImageVersion() == targetVersions.ImagePath() {
+			upToDateImages++
+		}
+	}
+
+	builder := strings.Builder{}
+	if upToDateImages != len(status) || upToDateK8s != len(status) {
+		builder.WriteString(fmt.Sprintf("\tImage: %d/%d\n", upToDateImages, len(status)))
+		builder.WriteString(fmt.Sprintf("\tKubernetes: %d/%d\n", upToDateK8s, len(status)))
+	}
+
+	return builder.String()
+}
+
+// serviceVersionsString creates the service versions part of the output string.
+func serviceVersionsString(versions helm.ServiceVersions) string {
+	builder := strings.Builder{}
+	builder.WriteString("Installed service versions:\n")
+	builder.WriteString(fmt.Sprintf("\tCilium: %s\n", versions.Cilium()))
+	builder.WriteString(fmt.Sprintf("\tcert-manager: %s\n", versions.CertManager()))
+	builder.WriteString(fmt.Sprintf("\tconstellation-operators: %s\n", versions.ConstellationOperators()))
+	builder.WriteString(fmt.Sprintf("\tconstellation-services: %s\n", versions.ConstellationServices()))
+	return builder.String()
+}
+
+// targetVersionsString creates the target versions part of the output string.
+func targetVersionsString(target cloudcmd.TargetVersions) string {
+	builder := strings.Builder{}
+	builder.WriteString("Target versions:\n")
+	builder.WriteString(fmt.Sprintf("\tImage: %s\n", target.Image()))
+	builder.WriteString(fmt.Sprintf("\tKubernetes: %s\n", target.Kubernetes()))
+
+	return builder.String()
+}
+
+type kubeClient interface {
+	GetNodes(ctx context.Context) ([]corev1.Node, error)
+}
+
+type helmClient interface {
+	Versions() (helm.ServiceVersions, error)
+}