Elemental Operator: manage empty config in MachineRegistrations (#213)

* operator: manage empty config in MachineRegistrations

We don't deal with empty Spec:Config in MachineRegistrations: in that
case we would end up with a nil Config structure, which we don't check
causing the operator to panic.

Just check and deal with empty (nil) MachineRegistration config.

Fixes #202

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

* operator:trivial: rename var machineRegistration to registration

In order to manage a MachineRegistration resource we instantiate a var named
'registration' in all the functions of the server package,  but in the
'unauthenticatedResponse' function.
Let's stay coherent: rename the variable.

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

* operator: tests: expand the data structure TestInitNewInventory

This has no functional change: just extend the configuration parameter
that can be set in the data structure used for the tests.
Make use of it in the following commit.

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

* operator: tests: check empty config in MachineRegistrations

Signed-off-by: Francesco Giudici <francesco.giudici@suse.com>

Author: fgiudici

pkg/server/register.go

@@ -121,13 +121,17 @@ func upgrade(resp http.ResponseWriter, req *http.Request) (*websocket.Conn, erro
 	return conn, err
 }
 
-func (i *InventoryServer) unauthenticatedResponse(machineRegistration *elm.MachineRegistration, writer io.Writer) error {
-	mRRegistration := machineRegistration.Spec.Config.Elemental.Registration
+func (i *InventoryServer) unauthenticatedResponse(registration *elm.MachineRegistration, writer io.Writer) error {
+	if registration.Spec.Config == nil {
+		registration.Spec.Config = &config.Config{}
+	}
+
+	mRRegistration := registration.Spec.Config.Elemental.Registration
 
 	return yaml.NewEncoder(writer).Encode(config.Config{
 		Elemental: config.Elemental{
 			Registration: config.Registration{
-				URL:             machineRegistration.Status.RegistrationURL,
+				URL:             registration.Status.RegistrationURL,
 				CACert:          i.getRancherCACert(),
 				EmulateTPM:      mRRegistration.EmulateTPM,
 				EmulatedTPMSeed: mRRegistration.EmulatedTPMSeed,
@@ -220,6 +224,10 @@ func (i *InventoryServer) writeMachineInventoryCloudConfig(conn *websocket.Conn,
 	}
 	defer writer.Close()
 
+	if registration.Spec.Config == nil {
+		registration.Spec.Config = &config.Config{}
+	}
+
 	return yaml.NewEncoder(writer).Encode(config.Config{
 		Elemental: config.Elemental{
 			Registration: config.Registration{
@@ -275,6 +283,9 @@ func buildStringFromSmbiosData(data map[string]interface{}, name string) string
 func initInventory(inventory *elm.MachineInventory, registration *elm.MachineRegistration) {
 	const namePrefix = "m-"
 
+	if registration.Spec.Config == nil {
+		registration.Spec.Config = &config.Config{}
+	}
 	inventory.Name = registration.Spec.MachineName
 	if inventory.Name == "" {
 		if registration.Spec.Config.Elemental.Registration.NoSMBIOS {

pkg/server/register_test.go

@@ -32,42 +32,59 @@ func TestInitNewInventory(t *testing.T) {
 	// e.g., m-66588488-3eb6-4a6d-b642-c994f128c6f1
 
 	testCase := []struct {
-		noSMBIOS     bool
+		config       *config.Config
 		initName     string
 		expectedName string
 	}{
 		{
-			noSMBIOS:     false,
+			config: &config.Config{
+				Elemental: config.Elemental{
+					Registration: config.Registration{
+						NoSMBIOS: false,
+					},
+				},
+			},
 			initName:     "custom-name",
 			expectedName: "custom-name",
 		},
+
 		{
-			noSMBIOS:     false,
+			config: &config.Config{
+				Elemental: config.Elemental{
+					Registration: config.Registration{
+						NoSMBIOS: false,
+					},
+				},
+			},
 			expectedName: "m-${System Information/UUID}",
 		},
 		{
-			noSMBIOS: true,
+			config: &config.Config{
+				Elemental: config.Elemental{
+					Registration: config.Registration{
+						NoSMBIOS: true,
+					},
+				},
+			},
+		},
+		{
+			config:       nil,
+			expectedName: "m-${System Information/UUID}",
 		},
 	}
 
 	for _, test := range testCase {
 		registration := &elm.MachineRegistration{
 			Spec: elm.MachineRegistrationSpec{
 				MachineName: test.initName,
-				Config: &config.Config{
-					Elemental: config.Elemental{
-						Registration: config.Registration{
-							NoSMBIOS: test.noSMBIOS,
-						},
-					},
-				},
+				Config:      test.config,
 			},
 		}
 
 		inventory := &elm.MachineInventory{}
 		initInventory(inventory, registration)
 
-		if test.noSMBIOS {
+		if test.config != nil && test.config.Elemental.Registration.NoSMBIOS {
 			assert.Check(t, mUUID.Match([]byte(inventory.Name)), inventory.Name+" is not UUID based")
 		} else {
 			assert.Equal(t, inventory.Name, test.expectedName)