Support for GuestOS ID / Family

api/v1alpha1/guestosdescriptor_types.go

@@ -0,0 +1,58 @@
+// Copyright (c) 2022 VMware, Inc. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+//go:generate go run ./internal/generate_guestosidentifiers.go
+
+package v1alpha1
+
+// VirtualMachineGuestOSDescriptor is used to specify information about the
+//
+type VirtualMachineGuestOSDescriptor struct {
+	// VirtualMachineGuestOSIdentifier is the guest OS identifier.
+	//
+	// If ommited the Family field is used to determine a default
+	// VirtualMachineGuestOSIdentifier value.
+	//
+	// +optional
+	ID VirtualMachineGuestOSIdentifier `json:"id,omitempty"`
+
+	// VirtualMachineGuestOSFamily specifies the family of the guest OS.
+	//
+	// If omitted the VirtualMachineImage is used to attempt to determine
+	// the guest's family and/or ID.
+	//
+	// +optional
+	Family VirtualMachineGuestOSFamily `json:"family,omitempty"`
+}
+
+// VirtualMachineGuestOSFamily specifies the family of the guest OS.
+type VirtualMachineGuestOSFamily string
+
+const (
+	VirtualMachineGuestOSFamilyWindows       VirtualMachineGuestOSFamily = "windowsGuest"
+	VirtualMachineGuestOSFamilyLinux         VirtualMachineGuestOSFamily = "linuxGuest"
+	VirtualMachineGuestOSFamilyNovellNetware VirtualMachineGuestOSFamily = "netwareGuest"
+	VirtualMachineGuestOSFamilySolaris       VirtualMachineGuestOSFamily = "solarisGuest"
+	VirtualMachineGuestOSFamilyDarwin        VirtualMachineGuestOSFamily = "darwinGuestFamily"
+	VirtualMachineGuestOSFamilyOther         VirtualMachineGuestOSFamily = "otherGuestFamily"
+)
+
+// VirtualMachineGuestOSIdentifier is the guest operating system identifier.
+type VirtualMachineGuestOSIdentifier string
+
+// validVirtualMachineGuestOSIdentifiers is a map used to determine if a
+// VirtualMachineGuestOSIdentifier value is valid.
+var validVirtualMachineGuestOSIdentifiers map[VirtualMachineGuestOSIdentifier]struct{}
+
+// IsValidVirtualMachineGuestOSIdentifier returns true if the provided value is
+// valid.
+func IsValidVirtualMachineGuestOSIdentifier(s string) bool {
+	return VirtualMachineGuestOSIdentifier(s).IsValid()
+}
+
+// IsValidVirtualMachineGuestOSIdentifier returns true if the identifier is
+// valid.
+func (e VirtualMachineGuestOSIdentifier) IsValid() bool {
+	_, ok := validVirtualMachineGuestOSIdentifiers[e]
+	return ok
+}

api/v1alpha1/guestosdescriptor_types_test.go

@@ -0,0 +1,64 @@
+// Copyright (c) 2020 VMware, Inc. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package v1alpha1_test
+
+import (
+	"testing"
+
+	"github.com/vmware-tanzu/vm-operator-api/api/v1alpha1"
+)
+
+func TestIsValidVirtualMachineGuestOSIdentifier(t *testing.T) {
+
+	t.Run("valid", func(t *testing.T) {
+		testCases := []struct {
+			name string
+			id   string
+		}{
+			{
+				name: "otherLinuxGuest",
+				id:   "otherLinuxGuest",
+			},
+			{
+				name: "genericLinuxGuest",
+				id:   "genericLinuxGuest",
+			},
+		}
+		for i := range testCases {
+			tc := testCases[i]
+			t.Run(tc.name, func(t *testing.T) {
+				if !v1alpha1.IsValidVirtualMachineGuestOSIdentifier(tc.id) {
+					t.Errorf("%s is invalid & should be valid", tc.id)
+				}
+
+			})
+		}
+	})
+
+	t.Run("invalid", func(t *testing.T) {
+		testCases := []struct {
+			name string
+			id   string
+		}{
+			{
+				name: "windows",
+				id:   "windows",
+			},
+			{
+				name: "windowsGuest",
+				id:   "windowsGuest",
+			},
+		}
+		for i := range testCases {
+			tc := testCases[i]
+			t.Run(tc.name, func(t *testing.T) {
+				if v1alpha1.IsValidVirtualMachineGuestOSIdentifier(tc.id) {
+					t.Errorf("%s is valid & should be invalid", tc.id)
+				}
+
+			})
+		}
+	})
+
+}