ocu-267 - Leveraging go-enum

Makefile

@@ -146,8 +146,8 @@ install-go-fmt-tools:
 
 fmt-go:
 	@echo "Tidying up Go files"
-	@gofmt -l -w $$(find . -name *.go -not -path "./vendor/*" | xargs -n 1 dirname | uniq)
-	@goimports -local $$(cat go.mod | grep -E "^module" | sed 's/module //') -w $$(find . -name *.go -not -path "./vendor/*" | xargs -n 1 dirname | uniq)
+	@gofmt -l -w $$(find . -name *.go -not -path "**/vendor/*" | xargs -n 1 dirname | uniq)
+	@goimports -local $$(cat go.mod | grep -E "^module" | sed 's/module //') -w $$(find . -name *.go -not -path "**/vendor/*" | xargs -n 1 dirname | uniq)
 
 install-md-fmt-tools:
 	@npm ci

sdk/component/conf.go

@@ -10,11 +10,6 @@ import (
 )
 
 const (
-	logLevelDebug RunnerConfigLoggingLevel = "debug"
-	logLevelInfo  RunnerConfigLoggingLevel = "info"
-	logLevelError RunnerConfigLoggingLevel = "error"
-	logLevelWarn  RunnerConfigLoggingLevel = "warn"
-
 	// Err reasons.
 	errReasonCannotBeEmpty    = "cannot be empty"
 	errReasonUnsupportedValue = "unsupported value"
@@ -47,13 +42,9 @@ type (
 		storerConfig runnerConfigStorer
 	}
 
-	// RunnerConfigLoggingLevel is used to represent log levels.
-	RunnerConfigLoggingLevel string
-
 	// RunnerConfigLogging contains the configuration related with the runner logger.
 	RunnerConfigLogging struct {
-		Level RunnerConfigLoggingLevel
-
+		Level  RunnerConfigLoggingLevel
 		Logger Logger
 	}
 
@@ -91,10 +82,6 @@ func (er ErrInvalidRunnerConfig) Error() string {
 	return fmt.Sprintf("invalid configuration, field '%s': %s", er.FieldName, er.Reason)
 }
 
-func (rl RunnerConfigLoggingLevel) String() string {
-	return string(rl)
-}
-
 func (rc *RunnerConfig) isValid() error {
 	switch {
 	case rc.SDKVersion == "":
@@ -190,7 +177,7 @@ func RunnerWithStorer(stType string, store Storer) RunnerOption {
 			}
 		}
 		r.config.storerConfig.store = store
-		r.config.storerConfig.storeType = storeTypeLocal
+		r.config.storerConfig.storeType = StoreTypeLocal
 		return nil
 	}
 }
@@ -221,7 +208,11 @@ func newRunnerConfig() (*RunnerConfig, error) {
 	// --- END - BASIC ENV - END ---
 
 	// --- BEGIN - LOGGING ENV - BEGIN ---
-	logLevel, err := fromEnvOrDefault(envVarKeyLoggingLogLevel, logLevelDebug.String(), withFallbackToDefaultOnError(true))
+	logLevel, err := fromEnvOrDefault(
+		envVarKeyLoggingLogLevel,
+		RunnerConfigLoggingLevelDebug.String(),
+		withFallbackToDefaultOnError(true),
+	)
 	if err != nil {
 		return nil, errors.Errorf("could not lookup environment for '%s': %w", envVarKeyLoggingLogLevel, err)
 	}

sdk/component/enricher_test.go

@@ -9,10 +9,9 @@ import (
 	"github.com/stretchr/testify/require"
 	"go.uber.org/mock/gomock"
 
+	"github.com/smithy-security/smithy/sdk/component"
 	"github.com/smithy-security/smithy/sdk/component/internal/mocks"
 	"github.com/smithy-security/smithy/sdk/component/internal/uuid"
-
-	"github.com/smithy-security/smithy/sdk/component"
 	ocsf "github.com/smithy-security/smithy/sdk/gen/com/github/ocsf/ocsf_schema/v1"
 )
 

sdk/component/enum.go

@@ -0,0 +1,10 @@
+package component
+
+type (
+	// RunnerConfigLoggingLevel is used to represent log levels.
+	// ENUM(debug, info, error, warn)
+	RunnerConfigLoggingLevel string
+
+	// ENUM(local)
+	storeType string
+)

sdk/component/internal/storer/local/sqlite/enum.go

@@ -0,0 +1,6 @@
+package sqlite
+
+type (
+	// ENUM(findings, instance_id, updated_at)
+	columnName string
+)

sdk/component/internal/storer/local/sqlite/sqlite.go

@@ -17,13 +17,7 @@ import (
 	ocsf "github.com/smithy-security/smithy/sdk/gen/com/github/ocsf/ocsf_schema/v1"
 )
 
-const (
-	errInvalidConstructorEmptyReason = "cannot be empty"
-
-	columnNameFindings   columnName = "findings"
-	columnNameinstanceID columnName = "instance_id"
-	columnNameUpdatedAt  columnName = "updated_at"
-)
+const errInvalidConstructorEmptyReason = "cannot be empty"
 
 type (
 	manager struct {
@@ -33,8 +27,6 @@ type (
 
 	managerOption func(*manager) error
 
-	columnName string
-
 	// ErrInvalidConstructor should be used for invalid manager constructor errors.
 	ErrInvalidConstructor struct {
 		argName string
@@ -53,10 +45,6 @@ func ManagerWithClock(clock clockwork.Clock) managerOption {
 	}
 }
 
-func (cn columnName) String() string {
-	return string(cn)
-}
-
 func (e ErrInvalidConstructor) Error() string {
 	return fmt.Sprintf("invalid argument '%s': %s", e.argName, e.reason)
 }
@@ -113,7 +101,7 @@ func (m *manager) Read(ctx context.Context, instanceID uuid.UUID) ([]*ocsf.Vulne
 	err = stmt.
 		QueryRowContext(
 			ctx,
-			sql.Named(columnNameinstanceID.String(), instanceID.String()),
+			sql.Named(ColumnNameInstanceId.String(), instanceID.String()),
 		).
 		Scan(&jsonFindingsStr)
 	if err != nil {
@@ -159,8 +147,8 @@ func (m *manager) Write(ctx context.Context, instanceID uuid.UUID, findings []*o
 	defer stmt.Close()
 
 	if _, err = stmt.Exec(
-		sql.Named(columnNameinstanceID.String(), instanceID.String()),
-		sql.Named(columnNameFindings.String(), jsonFindings),
+		sql.Named(ColumnNameInstanceId.String(), instanceID.String()),
+		sql.Named(ColumnNameFindings.String(), jsonFindings),
 	); err != nil {
 		return errors.Errorf("could not insert findings: %w", err)
 	}
@@ -192,9 +180,9 @@ func (m *manager) Update(ctx context.Context, instanceID uuid.UUID, findings []*
 	defer stmt.Close()
 
 	res, err := stmt.Exec(
-		sql.Named(columnNameinstanceID.String(), instanceID.String()),
-		sql.Named(columnNameUpdatedAt.String(), m.clock.Now().UTC().Format(time.RFC3339)),
-		sql.Named(columnNameFindings.String(), jsonFindings),
+		sql.Named(ColumnNameInstanceId.String(), instanceID.String()),
+		sql.Named(ColumnNameUpdatedAt.String(), m.clock.Now().UTC().Format(time.RFC3339)),
+		sql.Named(ColumnNameFindings.String(), jsonFindings),
 	)
 	if err != nil {
 		return errors.Errorf("could not update findings: %w", err)

sdk/component/logger.go

@@ -86,7 +86,7 @@ func ContextWithLogger(ctx context.Context, logger Logger) context.Context {
 func LoggerFromContext(ctx context.Context) Logger {
 	logger := ctx.Value(ctxLoggerKey)
 	if logger == nil {
-		l, _ := newDefaultLogger(logLevelDebug)
+		l, _ := newDefaultLogger(RunnerConfigLoggingLevelDebug)
 		return l
 	}
 	return logger.(Logger)
@@ -96,13 +96,13 @@ func newDefaultLogger(level RunnerConfigLoggingLevel) (*defaultLogger, error) {
 	var logLevel slog.Level
 
 	switch level {
-	case logLevelDebug:
+	case RunnerConfigLoggingLevelDebug:
 		logLevel = slog.LevelDebug
-	case logLevelInfo:
+	case RunnerConfigLoggingLevelInfo:
 		logLevel = slog.LevelInfo
-	case logLevelError:
+	case RunnerConfigLoggingLevelError:
 		logLevel = slog.LevelError
-	case logLevelWarn:
+	case RunnerConfigLoggingLevelWarn:
 		logLevel = slog.LevelWarn
 	default:
 		return nil, errors.Errorf("unknown logger level: %s", level)

sdk/component/storer.go

@@ -6,16 +6,12 @@ import (
 	"github.com/smithy-security/smithy/sdk/component/internal/storer/local/sqlite"
 )
 
-type storeType string
-
-const storeTypeLocal storeType = "local"
-
 func isAllowedStoreType(st storeType) bool {
-	return st == storeTypeLocal
+	return st == StoreTypeLocal
 }
 
 func newStorer(conf runnerConfigStorer) (Storer, error) {
-	if conf.storeType == storeTypeLocal {
+	if conf.storeType == StoreTypeLocal {
 		localMgr, err := sqlite.NewManager(conf.dbDSN)
 		if err != nil {
 			return nil, errors.Errorf("unable to initialize local sqlite manager: %w", err)

sdk/component/target_test.go

@@ -9,10 +9,9 @@ import (
 	"github.com/stretchr/testify/require"
 	"go.uber.org/mock/gomock"
 
+	"github.com/smithy-security/smithy/sdk/component"
 	"github.com/smithy-security/smithy/sdk/component/internal/mocks"
 	"github.com/smithy-security/smithy/sdk/component/internal/uuid"
-
-	"github.com/smithy-security/smithy/sdk/component"
 )
 
 func runTargetHelper(t *testing.T, ctx context.Context, target component.Target, store component.Storer) error {