Merge pull request #23 from ConductorOne/marcos/fix/config-schema

fix: Config schema

Author: ggreer

.golangci.yml

@@ -66,9 +66,7 @@ linters:
     - bodyclose # checks whether HTTP response body is closed successfully
     - durationcheck # check for two durations multiplied together
     - errorlint # errorlint is a linter for that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13.
-    - execinquery # execinquery is a linter about query string checker in Query function which reads your Go src files and warning it finds
     - exhaustive # check exhaustiveness of enum switch statements
-    - exportloopref # checks for pointers to enclosing loop variables
     - forbidigo # Forbids identifiers
     - gochecknoinits # Checks that no init functions are present in Go code
     - goconst # Finds repeated strings that could be replaced by a constant

cmd/baton-snowflake/config.go

@@ -0,0 +1,54 @@
+package main
+
+import (
+	"github.com/conductorone/baton-sdk/pkg/field"
+)
+
+var (
+	AccountUrlField = field.StringField(
+		"account-url",
+		field.WithRequired(true),
+		field.WithDescription("Account URL."),
+	)
+	AccountIdentifierField = field.StringField(
+		"account-identifier",
+		field.WithRequired(true),
+		field.WithDescription("Account Identifier."),
+	)
+	UserIdentifierField = field.StringField(
+		"user-identifier",
+		field.WithRequired(true),
+		field.WithDescription("User Identifier."),
+	)
+	PublicKeyFingerprintField = field.StringField(
+		"public-key-fingerprint",
+		field.WithRequired(true),
+		field.WithDescription("Public Key Fingerprint."),
+	)
+	PrivateKeyPathField = field.StringField(
+		"private-key-path",
+		field.WithDescription("Private Key Path."),
+	)
+	PrivateKeyField = field.StringField(
+		"private-key",
+		field.WithDescription("Private Key (PEM format)."),
+	)
+	configurationSchema = field.NewConfiguration(
+		[]field.SchemaField{
+			AccountIdentifierField,
+			AccountUrlField,
+			PrivateKeyField,
+			PrivateKeyPathField,
+			PublicKeyFingerprintField,
+			UserIdentifierField,
+		},
+		field.FieldsMutuallyExclusive(
+			PrivateKeyPathField,
+			PrivateKeyField,
+		),
+		field.FieldsAtLeastOneUsed(
+			PrivateKeyPathField,
+			PrivateKeyField,
+		),
+	)
+)

cmd/baton-snowflake/config_test.go

@@ -0,0 +1,44 @@
+package main
+
+import (
+	"testing"
+
+	"github.com/conductorone/baton-sdk/pkg/test"
+	"github.com/conductorone/baton-sdk/pkg/ustrings"
+)
+
+func TestConfigSchema(t *testing.T) {
+	test.ExerciseTestCasesFromExpressions(
+		t,
+		configurationSchema,
+		nil,
+		ustrings.ParseFlags,
+		[]test.TestCaseFromExpression{
+			{
+				"",
+				false,
+				"empty config",
+			},
+			{
+				"--account-url 1 --account-identifier 1 --user-identifier --public-key-fingerprint 1",
+				false,
+				"missing private key",
+			},
+			{
+				"--account-url 1 --account-identifier 1 --user-identifier --public-key-fingerprint 1 --private-key-path 1 --private-key 1",
+				false,
+				"both private key types",
+			},
+			{
+				"--account-url 1 --account-identifier 1 --user-identifier --public-key-fingerprint 1 --private-key-path 1",
+				true,
+				"private key path",
+			},
+			{
+				"--account-url 1 --account-identifier 1 --user-identifier --public-key-fingerprint 1 --private-key 1",
+				true,
+				"private key",
+			},
+		},
+	)
+}

cmd/baton-snowflake/main.go

@@ -6,7 +6,6 @@ import (
 	"os"
 
 	"github.com/conductorone/baton-sdk/pkg/connectorbuilder"
-	"github.com/conductorone/baton-sdk/pkg/field"
 	"github.com/conductorone/baton-sdk/pkg/types"
 	"github.com/grpc-ecosystem/go-grpc-middleware/logging/zap/ctxzap"
 	"github.com/spf13/viper"
@@ -17,32 +16,16 @@ import (
 )
 
 const (
-	version              = "dev"
-	connectorName        = "baton-snowflake"
-	accountUrl           = "account-url"
-	accountIdentifier    = "account-identifier"
-	userIdentifier       = "user-identifier"
-	publicKeyFingerPrint = "public-key-fingerprint"
-	privateKeyPath       = "private-key-path"
-	privateKey           = "private-key"
-)
-
-var (
-	AccountUrlField           = field.StringField(accountUrl, field.WithRequired(true), field.WithDescription("Account URL."))
-	AccountIdentifierField    = field.StringField(accountIdentifier, field.WithRequired(true), field.WithDescription("Account Identifier."))
-	UserIdentifierField       = field.StringField(userIdentifier, field.WithRequired(true), field.WithDescription("User Identifier."))
-	PublicKeyFingerprintField = field.StringField(publicKeyFingerPrint, field.WithRequired(true), field.WithDescription("Public Key Fingerprint."))
-	PrivateKeyPathField       = field.StringField(privateKeyPath, field.WithRequired(false), field.WithDescription("Private Key Path."))
-	PrivateKeyField           = field.StringField(privateKey, field.WithRequired(false), field.WithDescription("Private Key (PEM format)."))
-	configurationFields       = []field.SchemaField{AccountUrlField, AccountIdentifierField, UserIdentifierField, PublicKeyFingerprintField, PrivateKeyPathField, PrivateKeyField}
+	version       = "dev"
+	connectorName = "baton-snowflake"
 )
 
 func main() {
 	ctx := context.Background()
 	_, cmd, err := configSchema.DefineConfiguration(ctx,
 		connectorName,
 		getConnector,
-		field.NewConfiguration(configurationFields),
+		configurationSchema,
 	)
 	if err != nil {
 		fmt.Fprintln(os.Stderr, err.Error())
@@ -59,13 +42,14 @@ func main() {
 
 func getConnector(ctx context.Context, cfg *viper.Viper) (types.ConnectorServer, error) {
 	l := ctxzap.Extract(ctx)
-	cb, err := connector.New(ctx,
-		cfg.GetString(accountUrl),
-		cfg.GetString(accountIdentifier),
-		cfg.GetString(userIdentifier),
-		cfg.GetString(publicKeyFingerPrint),
-		cfg.GetString(privateKeyPath),
-		cfg.GetString(privateKey),
+	cb, err := connector.New(
+		ctx,
+		cfg.GetString(AccountUrlField.FieldName),
+		cfg.GetString(AccountIdentifierField.FieldName),
+		cfg.GetString(UserIdentifierField.FieldName),
+		cfg.GetString(PublicKeyFingerprintField.FieldName),
+		cfg.GetString(PrivateKeyPathField.FieldName),
+		cfg.GetString(PrivateKeyField.FieldName),
 	)
 	if err != nil {
 		l.Error("error creating connector", zap.Error(err))

go.mod

@@ -3,10 +3,10 @@ module github.com/conductorone/baton-snowflake
 go 1.22.1
 
 require (
-	github.com/conductorone/baton-sdk v0.2.20
+	github.com/conductorone/baton-sdk v0.2.24
 	github.com/golang-jwt/jwt v3.2.2+incompatible
 	github.com/grpc-ecosystem/go-grpc-middleware v1.4.0
-	github.com/spf13/viper v1.18.2
+	github.com/spf13/viper v1.19.0
 	github.com/stretchr/testify v1.9.0
 	go.uber.org/zap v1.27.0
 )

go.sum

@@ -52,8 +52,8 @@ github.com/benbjohnson/clock v1.3.5/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZx
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
 github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
-github.com/conductorone/baton-sdk v0.2.20 h1:IpXur6BYJkePwDqOv3AsTP5oFeIDEzgtMvo7FSlOTzE=
-github.com/conductorone/baton-sdk v0.2.20/go.mod h1:hmd/Oz3DPIKD+9QmkusZaA18ZoiinnTDdrxh2skcdUc=
+github.com/conductorone/baton-sdk v0.2.24 h1:o/zndd/fxHFb49+k6w9l9F5uF1faFzzWKx1C/a50FIw=
+github.com/conductorone/baton-sdk v0.2.24/go.mod h1:hmd/Oz3DPIKD+9QmkusZaA18ZoiinnTDdrxh2skcdUc=
 github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -190,8 +190,8 @@ github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0=
 github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho=
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
-github.com/spf13/viper v1.18.2 h1:LUXCnvUvSM6FXAsj6nnfc8Q2tp1dIgUfY9Kc8GsSOiQ=
-github.com/spf13/viper v1.18.2/go.mod h1:EKmWIqdnk5lOcmR72yw6hS+8OPYcwD0jteitLMVB+yk=
+github.com/spf13/viper v1.19.0 h1:RWq5SEjt8o25SROyN3z2OrDB9l7RPd3lwTWU8EcEdcI=
+github.com/spf13/viper v1.19.0/go.mod h1:GQUN9bilAbhU/jgc1bKs99f/suXKeUMct8Adx5+Ntkg=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=