register: add 'version' and 'dumpdata' subcommands (#835)

'dumpdata' allows to inspect host data from the running host as they are
collected during the registration phase: those are the data made
available in the Elemental Label Templates feature.
This subcommand was developed while working at #834 and since could be
handy for debugging and even for users (elemental sysadmins) adding it
to the elemental-register binary.

'version' is the very first step in moving the elemental-register flags
to command, as requested by #832.

Related to issues: #832, #834

Signed-off-by: Francesco Giudici <[email protected]>

cmd/register/main.go

@@ -71,6 +71,10 @@ func main() {
 	stateHandler := register.NewFileStateHandler(fs)
 	client := register.NewClient()
 	cmd := newCommand(fs, client, stateHandler, installer)
+	cmd.AddCommand(
+		newVersionCommand(),
+		newDumpDataCommand(),
+	)
 	if err := cmd.Execute(); err != nil {
 		log.Fatalf("FATAL: %s", err)
 	}

cmd/register/showdata.go

@@ -0,0 +1,104 @@
+/*
+Copyright © 2022 - 2024 SUSE LLC
+
+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 main
+
+import (
+	"encoding/json"
+	"fmt"
+
+	"github.com/rancher/elemental-operator/pkg/dmidecode"
+	"github.com/rancher/elemental-operator/pkg/hostinfo"
+	"github.com/rancher/elemental-operator/pkg/log"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+)
+
+const (
+	DUMPHW     = "hardware"
+	DUMPSMBIOS = "smbios"
+)
+
+func newDumpDataCommand() *cobra.Command {
+	var raw bool
+
+	cmd := &cobra.Command{
+		Use:     "dumpdata",
+		Aliases: []string{"dump"},
+		Short:   "Show host data sent during the registration phase",
+		Long: "Prints to stdout the data sent by the registering client " +
+			"to the Elemental Operator.\nTakes the type of host data to dump " +
+			"as argument, be it '" + DUMPHW + "' or '" + DUMPSMBIOS + "'.",
+		Args:      cobra.MatchAll(cobra.MaximumNArgs(1), cobra.OnlyValidArgs),
+		ValidArgs: []string{DUMPHW, DUMPSMBIOS},
+		RunE: func(_ *cobra.Command, args []string) error {
+			return dumpdata(args, raw)
+		},
+	}
+
+	viper.AutomaticEnv()
+	cmd.Flags().BoolVarP(&raw, "raw", "r", false, "dump raw data before conversion to label templates' variables")
+	_ = viper.BindPFlag("raw", cmd.Flags().Lookup("raw"))
+
+	return cmd
+}
+
+func dumpdata(args []string, raw bool) error {
+	dataType := "hardware"
+	if len(args) > 0 {
+		dataType = args[0]
+	}
+
+	var hostData interface{}
+
+	switch dataType {
+	case DUMPHW:
+		hwData, err := hostinfo.Host()
+		if err != nil {
+			log.Fatalf("Cannot retrieve host data: %s", err)
+		}
+
+		if raw {
+			hostData = hwData
+		} else {
+			dataMap, err := hostinfo.ExtractLabels(hwData)
+			if err != nil {
+				log.Fatalf("Cannot convert host data to labels: %s", err)
+			}
+			hostData = dataMap
+		}
+
+	case DUMPSMBIOS:
+		smbiosData, err := dmidecode.Decode()
+		if err != nil {
+			log.Fatalf("Cannot retrieve SMBIOS data: %s", err)
+		}
+
+		hostData = smbiosData
+
+	default:
+		// Should never happen but manage it anyway
+		log.Fatalf("Unsupported data type: %s", dataType)
+	}
+
+	jsonData, err := json.MarshalIndent(hostData, "", "  ")
+	if err != nil {
+		log.Fatalf("Cannot convert host data to json: %s", err)
+	}
+	fmt.Printf("%s\n", string(jsonData))
+
+	return nil
+}

cmd/register/version.go

@@ -0,0 +1,34 @@
+/*
+Copyright © 2022 - 2024 SUSE LLC
+
+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 main
+
+import (
+	"github.com/rancher/elemental-operator/pkg/log"
+	"github.com/rancher/elemental-operator/pkg/version"
+	"github.com/spf13/cobra"
+)
+
+func newVersionCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "version",
+		Short: "Print version and exit",
+		Run: func(_ *cobra.Command, _ []string) {
+			log.Infof("Register version %s, commit %s, commit date %s", version.Version, version.Commit, version.CommitDate)
+		},
+	}
+	return cmd
+}