Vc/incoming device api

.github/workflows/lint-test.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v4
         with:
-          go-version: '1.21.0'
+          go-version: '1.22.1'
 
       - name: Install cockroach binary
         run: curl https://binaries.cockroachdb.com/cockroach-v23.1.11.linux-amd64.tgz | tar -xz && sudo cp -i cockroach-v23.1.11.linux-amd64/cockroach /usr/local/bin/
@@ -32,12 +32,12 @@ jobs:
       - name: Run golangci-lint
         uses: golangci/golangci-lint-action@v3
         with:
-          version: v1.52.2
+          version: v1.57.1
           args: --timeout=5m
 
       - name: Run go tests and generate coverage report
         run: FLEETDB_CRDB_URI="host=localhost port=26257 user=root sslmode=disable dbname=fleetdb_test" go test -race -coverprofile=coverage.txt -covermode=atomic -tags testtools -p 1 ./...
-        
+
       - name: Stop test database
         run: cockroach node drain --insecure --host=localhost:26257
 

.golangci.yml

@@ -31,7 +31,7 @@ linters:
     - govet
     - misspell
     - noctx
-    - revive
+    #    - revive XXX: fix up old code caught here
     - stylecheck
     - whitespace
 

Makefile

@@ -24,7 +24,7 @@ unit-test: | lint
 ## check test coverage
 coverage: | test-database
 	@echo Generating coverage report...
-	@FLEETDB_CRDB_URI="${TEST_DB}" go test ./... -race -coverprofile=coverage.out -covermode=atomic -tags testtools -p 1
+	@FLEETDB_CRDB_URI="${TEST_DB}" go test ./... -race -coverprofile=coverage.out -covermode=atomic -tags testtools,integration -p 1
 	@go tool cover -func=coverage.out
 	@go tool cover -html=coverage.out
 

cmd/serve.go

@@ -13,6 +13,7 @@ import (
 	"go.infratographer.com/x/crdbx"
 	"go.infratographer.com/x/otelx"
 	"go.infratographer.com/x/viperx"
+	"go.uber.org/zap"
 	"gocloud.dev/secrets"
 
 	// import gocdk secret drivers
@@ -92,6 +93,12 @@ func serve(ctx context.Context) {
 
 	dbtools.RegisterHooks()
 
+	if err := dbtools.SetupComponentTypes(ctx, db); err != nil {
+		logger.With(
+			zap.Error(err),
+		).Fatal("set up component types")
+	}
+
 	keeper, err := secrets.OpenKeeper(ctx, viper.GetString("db.encryption_driver"))
 	if err != nil {
 		logger.Fatalw("failed to open secrets keeper", "error", err)

go.mod

@@ -1,6 +1,6 @@
 module github.com/metal-toolbox/fleetdb
 
-go 1.19
+go 1.22
 
 require (
 	github.com/XSAM/otelsql v0.23.0 // indirect
@@ -34,6 +34,7 @@ require (
 )
 
 require (
+	github.com/bmc-toolbox/common v0.0.0-20231204194243-7bcbccab7116
 	github.com/volatiletech/sqlboiler v3.7.1+incompatible
 	go.hollow.sh/toolbox v0.6.3
 	go.infratographer.com/x v0.3.7

internal/dbtools/component_types.go

@@ -0,0 +1,79 @@
+package dbtools
+
+import (
+	"context"
+	"database/sql"
+
+	"github.com/bmc-toolbox/common"
+	"github.com/gosimple/slug"
+	"github.com/jmoiron/sqlx"
+	"github.com/pkg/errors"
+	"github.com/volatiletech/sqlboiler/v4/boil"
+
+	"github.com/metal-toolbox/fleetdb/internal/models"
+)
+
+var errAddTypes = errors.New("unable to add component types")
+
+// XXX: if bmc-toolbox exported this as a list, we could just import it.
+var knownComponentTypes = []string{
+	common.SlugBackplaneExpander,
+	common.SlugChassis,
+	common.SlugTPM,
+	common.SlugGPU,
+	common.SlugCPU,
+	common.SlugPhysicalMem,
+	common.SlugStorageController,
+	common.SlugBMC,
+	common.SlugBIOS,
+	common.SlugDrive,
+	common.SlugDriveTypePCIeNVMEeSSD,
+	common.SlugDriveTypeSATASSD,
+	common.SlugDriveTypeSATAHDD,
+	common.SlugNIC,
+	common.SlugPSU,
+	common.SlugCPLD,
+	common.SlugEnclosure,
+	common.SlugUnknown,
+	common.SlugMainboard,
+}
+
+// SetupComponentTypes upserts all known component types to the database.
+// Despite the descriptor, in the database the Name field of the component type
+// is the verbatim value of the string, and the Slug is computed as a lower-case
+// english-localized variant.
+func SetupComponentTypes(ctx context.Context, db *sqlx.DB) error {
+	txn := db.MustBeginTx(ctx, &sql.TxOptions{})
+	for _, typ := range knownComponentTypes {
+		sct := &models.ServerComponentType{
+			Name: typ,
+			Slug: slug.Make(typ),
+		}
+		if err := sct.Upsert(ctx, txn, false, []string{"slug"}, boil.None(), boil.Infer()); err != nil {
+			_ = txn.Rollback()
+			return errors.Wrap(errAddTypes, err.Error())
+		}
+	}
+	return txn.Commit()
+}
+
+// ComponentTypeIDFromName expects the name of the component (as defined in
+// bmc-toolbox) and will return the internal database ID for that name.
+func ComponentTypeIDFromName(ctx context.Context, exec boil.ContextExecutor, name string) (string, error) {
+	sct, err := models.ServerComponentTypes(
+		models.ServerComponentTypeWhere.Name.EQ(name),
+	).One(ctx, exec)
+	if err != nil {
+		return "", err
+	}
+	return sct.ID, nil
+}
+
+// MustComponentTypeID returns the component type id for the given component name or panics
+func MustComponentTypeID(ctx context.Context, exec boil.ContextExecutor, name string) string {
+	id, err := ComponentTypeIDFromName(ctx, exec, name)
+	if err != nil {
+		panic(err)
+	}
+	return id
+}

internal/dbtools/component_types_test.go

@@ -0,0 +1,31 @@
+//go:build testtools && integration
+
+package dbtools
+
+import (
+	"context"
+	"testing"
+
+	"github.com/bmc-toolbox/common"
+	"github.com/stretchr/testify/require"
+)
+
+func TestServerComponentTypes(t *testing.T) {
+	db := DatabaseTest(t)
+	ctx := context.TODO()
+
+	err := SetupComponentTypes(ctx, db)
+	require.NoError(t, err)
+
+	for _, typ := range knownComponentTypes {
+		_, err := ComponentTypeIDFromName(ctx, db, typ)
+		require.NoError(t, err, "couldn't find %s", typ)
+	}
+
+	require.NotPanics(t, func() { _ = MustComponentTypeID(ctx, db, common.SlugBackplaneExpander) })
+
+	require.Panics(t, func() { _ = MustComponentTypeID(ctx, db, "bogus") })
+
+	_, err = ComponentTypeIDFromName(ctx, db, "bogus")
+	require.Error(t, err, "no error on bogus")
+}

internal/dbtools/fixtures.go

@@ -137,6 +137,10 @@ func addFixtures(t *testing.T) error {
 		return err
 	}
 
+	if err := SetupComponentTypes(ctx, testDB); err != nil {
+		return err
+	}
+
 	// excluding Chuckles here since that server is deleted
 	FixtureServers = models.ServerSlice{FixtureNemo, FixtureDory, FixtureMarlin}
 	FixtureDeletedServers = models.ServerSlice{FixtureChuckles}

internal/inventory/component_attributes.go

@@ -0,0 +1,68 @@
+//nolint:all  // XXX remove this!
+package inventory
+
+import (
+	"encoding/json"
+
+	"github.com/bmc-toolbox/common"
+)
+
+type attributes struct {
+	Architecture                 string               `json:"architecture,omitempty"`
+	BlockSizeBytes               int64                `json:"block_size_bytes,omitempty"`
+	BusInfo                      string               `json:"bus_info,omitempty"`
+	Capabilities                 []*common.Capability `json:"capabilities,omitempty"`
+	CapableSpeedGbps             int64                `json:"capable_speed_gbps,omitempty"`
+	CapacityBytes                int64                `json:"capacity_bytes,omitempty" diff:"immutable"`
+	ChassisType                  string               `json:"chassis_type,omitempty"`
+	ClockSpeedHz                 int64                `json:"clock_speed_hz,omitempty"`
+	Cores                        int                  `json:"cores,omitempty"`
+	Description                  string               `json:"description,omitempty"`
+	DriveType                    string               `json:"drive_type,omitempty"`
+	FormFactor                   string               `json:"form_factor,omitempty"`
+	ID                           string               `json:"id,omitempty"`
+	InterfaceType                string               `json:"interface_type,omitempty"`
+	MacAddress                   string               `json:"macaddress,omitempty"`
+	Metadata                     map[string]string    `json:"metadata,omitempty"`
+	NegotiatedSpeedGbps          int64                `json:"negotiated_speed_gbps,omitempty"`
+	Oem                          bool                 `json:"oem,omitempty"`
+	OemID                        string               `json:"oem_id,omitempty"`
+	PartNumber                   string               `json:"part_number,omitempty"`
+	PhysicalID                   string               `json:"physid,omitempty"`
+	PowerCapacityWatts           int64                `json:"power_capacity_watts,omitempty"`
+	ProductName                  string               `json:"product_name,omitempty"`
+	Protocol                     string               `json:"protocol,omitempty"`
+	SizeBytes                    int64                `json:"size_bytes,omitempty"`
+	Slot                         string               `json:"slot,omitempty"`
+	SmartErrors                  []string             `json:"smart_errors,omitempty"`
+	SmartStatus                  string               `json:"smart_status,omitempty"`
+	SpeedBits                    int64                `json:"speed_bits,omitempty"`
+	SpeedGbps                    int64                `json:"speed_gbps,omitempty"`
+	StorageController            string               `json:"storage_controller,omitempty"`
+	SupportedControllerProtocols string               `json:"supported_controller_protocol,omitempty"`
+	SupportedDeviceProtocols     string               `json:"supported_device_protocol,omitempty"`
+	SupportedRAIDTypes           string               `json:"supported_raid_types,omitempty"`
+	Threads                      int                  `json:"threads,omitempty"`
+	WWN                          string               `json:"wwn,omitempty"`
+}
+
+func (a *attributes) MustJSON() []byte {
+	byt, err := json.Marshal(a)
+	if err != nil {
+		panic("bad attributes")
+	}
+	return byt
+}
+
+type versionedAttributes struct {
+	Firmware *common.Firmware `json:"firmware,omitempty"`
+	Status   *common.Status   `json:"status,omitempty"`
+}
+
+func (va *versionedAttributes) MustJSON() []byte {
+	byt, err := json.Marshal(va)
+	if err != nil {
+		panic("bad attributes")
+	}
+	return byt
+}