RHINENG-21444: update workspace field to use struct

Author: TenSt

base/inventory/inventory.go

@@ -2,6 +2,9 @@ package inventory
 
 import (
 	"app/base/types"
+	"database/sql/driver"
+	"encoding/json"
+	"errors"
 
 	"github.com/google/uuid"
 )
@@ -83,6 +86,35 @@ type Group struct {
 	Name string `json:"name"`
 }
 
+// Groups is a slice of Group that implements driver.Valuer and sql.Scanner
+// for storing/loading as JSONB in the database (e.g. system_inventory.workspaces).
+type Groups []Group
+
+// Value implements driver.Valuer for GORM: marshal to JSON for DB write.
+func (g *Groups) Value() (driver.Value, error) {
+	if g == nil {
+		return nil, nil
+	}
+	return json.Marshal(g)
+}
+
+// Scan implements sql.Scanner for GORM: unmarshal from JSON on DB read.
+func (g *Groups) Scan(value interface{}) error {
+	if value == nil {
+		*g = nil
+		return nil
+	}
+	b, ok := value.([]byte)
+	if !ok {
+		return errors.New("inventory.Groups: type assertion to []byte failed")
+	}
+	if len(b) == 0 {
+		*g = nil
+		return nil
+	}
+	return json.Unmarshal(b, g)
+}
+
 type Workloads struct {
 	Sap     SapWorkload     `json:"sap,omitempty"`
 	Ansible AnsibleWorkload `json:"ansible,omitempty"`

base/models/models.go

@@ -1,6 +1,7 @@
 package models
 
 import (
+	"app/base/inventory"
 	"time"
 
 	"github.com/google/uuid"
@@ -118,9 +119,9 @@ type SystemInventory struct {
 	BuiltPkgcache                    bool    `gorm:"column:built_pkgcache"`
 	Arch                             *string
 	Bootc                            bool
-	Tags                             []byte    `gorm:"column:tags"`
-	Created                          time.Time // set by trigger system_platform_insert_trigger
-	Workspaces                       []byte    `gorm:"column:workspaces"`
+	Tags                             []byte            `gorm:"column:tags"`
+	Created                          time.Time         // set by trigger system_platform_insert_trigger
+	Workspaces                       *inventory.Groups `gorm:"column:workspaces"`
 	StaleTimestamp                   *time.Time
 	StaleWarningTimestamp            *time.Time
 	CulledTimestamp                  *time.Time

listener/upload.go

@@ -428,11 +428,7 @@ func storeOrUpdateSysPlatform(
 		},
 	})
 
-	workspaces, err := json.Marshal(host.Groups)
-	if err != nil {
-		return errors.Wrap(err, "marshalling groups")
-	}
-
+	hostWorkspaces := inventory.Groups(host.Groups)
 	inventoryRecord := models.SystemInventory{
 		ID:                               system.ID,
 		InventoryID:                      system.InventoryID,
@@ -449,7 +445,7 @@ func storeOrUpdateSysPlatform(
 		Arch:                             system.Arch,
 		Bootc:                            system.Bootc,
 		Tags:                             utils.MarshalNilToJSONB(host.Tags),
-		Workspaces:                       utils.MarshalNilToJSONB(workspaces),
+		Workspaces:                       &hostWorkspaces,
 		StaleTimestamp:                   system.StaleTimestamp,
 		StaleWarningTimestamp:            system.StaleWarningTimestamp,
 		CulledTimestamp:                  system.CulledTimestamp,
@@ -466,7 +462,7 @@ func storeOrUpdateSysPlatform(
 		MssqlWorkloadVersion:             utils.EmptyToNil(&host.SystemProfile.Workloads.Mssql.Version),
 	}
 
-	err = database.OnConflictUpdateMulti(txi, []string{"rh_account_id", "inventory_id"}, colsToUpdate...).
+	err := database.OnConflictUpdateMulti(txi, []string{"rh_account_id", "inventory_id"}, colsToUpdate...).
 		Create(&inventoryRecord).Error
 	if err != nil {
 		return base.WrapFatalDBError(err, "unable to insert to system_inventory")

listener/upload_test.go

@@ -11,7 +11,6 @@ import (
 	"app/base/utils"
 	"app/base/vmaas"
 	"context"
-	"encoding/json"
 	"errors"
 	"fmt"
 	"net/http"
@@ -22,6 +21,7 @@ import (
 	"github.com/lib/pq"
 	log "github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 var accountID = int(1)
@@ -395,10 +395,8 @@ func TestStoreOrUpdateSysPlatform(t *testing.T) {
 	assert.Contains(t, string(inventoryAfterInsert.Tags), `"key": "env"`)
 	assert.Contains(t, string(inventoryAfterInsert.Tags), `"value": "prod"`)
 
-	var expectedWorkspaces []inventory.Group
-	err = json.Unmarshal(inventoryAfterInsert.Workspaces, &expectedWorkspaces)
-	assert.Nil(t, err)
-	assert.Equal(t, hostEvent.Host.Groups, expectedWorkspaces)
+	require.NotNil(t, inventoryAfterInsert.Workspaces)
+	assert.Equal(t, hostEvent.Host.Groups, []inventory.Group(*inventoryAfterInsert.Workspaces))
 
 	assert.Equal(t, hostEvent.Host.SystemProfile.OperatingSystem.Name, *inventoryAfterInsert.OSName)
 	assert.Equal(t, hostEvent.Host.SystemProfile.OperatingSystem.Major, *inventoryAfterInsert.OSMajor)