Merge pull request #5 from ConductorOne/marcos/feat/roles

ref: Refresh connector pattern

.github/workflows/ci.yaml

@@ -7,7 +7,7 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v3
         with:
-          go-version: 1.19.x
+          go-version: 1.22.x
       - name: Checkout code
         uses: actions/checkout@v3
       - name: Run linters
@@ -18,7 +18,7 @@ jobs:
   go-test:
     strategy:
       matrix:
-        go-version: [1.18.x, 1.19.x]
+        go-version: [1.22.x]
         platform: [ubuntu-latest]
     runs-on: ${{ matrix.platform }}
     steps:

.github/workflows/main.yaml

@@ -10,7 +10,7 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v3
         with:
-          go-version: 1.19.x
+          go-version: 1.22.x
       - name: Checkout code
         uses: actions/checkout@v3
       - name: Run linters
@@ -21,7 +21,7 @@ jobs:
   go-test:
     strategy:
       matrix:
-        go-version: [ 1.18.x, 1.19.x ]
+        go-version: [ 1.22.x ]
         platform: [ ubuntu-latest ]
     runs-on: ${{ matrix.platform }}
     steps:

.github/workflows/release.yaml

@@ -16,7 +16,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.19
+          go-version: 1.22
       - name: Set up Gon
         run: brew tap conductorone/gon && brew install conductorone/gon/gon
       - name: Import Keychain Certs
@@ -43,7 +43,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.19
+          go-version: 1.22
       - name: Docker Login
         uses: docker/login-action@v1
         with:

README.md

@@ -41,7 +41,10 @@ baton resources
 
 # Contributing, Support and Issues
 
-We started Baton because we were tired of taking screenshots and manually building spreadsheets. We welcome contributions, and ideas, no matter how small -- our goal is to make identity and permissions sprawl less painful for everyone. If you have questions, problems, or ideas: Please open a Github Issue!
+We started Baton because we were tired of taking screenshots and manually
+building spreadsheets. We welcome contributions, and ideas, no matter how
+small—our goal is to make identity and permissions sprawl less painful for
+everyone. If you have questions, problems, or ideas: Please open a GitHub Issue!
 
 See [CONTRIBUTING.md](https://github.com/ConductorOne/baton/blob/main/CONTRIBUTING.md) for more details.
 
@@ -55,18 +58,23 @@ Usage:
   baton-bamboohr [command]
 
 Available Commands:
+  capabilities       Get connector capabilities
   completion         Generate the autocompletion script for the specified shell
   help               Help about any command
 
 Flags:
-  -f, --file string                         The path to the c1z file to sync with ($BATON_FILE) (default "sync.c1z")
-      --company-domain string               The company domain used for the BambooHR account. ($BATON_COMPANY_DOMAIN)
-      --api-key string                      The api-key for the BambooHR account. ($BATON_API_KEY)
-  -h, --help                                help for baton-bamboohr
-      --log-format string                   The output format for logs: json, console ($BATON_LOG_FORMAT) (default "json")
-      --log-level string                    The log level: debug, info, warn, error ($BATON_LOG_LEVEL) (default "info")
-  -v, --version                             version for baton-bamboohr
+      --api-key string          required: The api key for your BambooHR account ($BATON_API_KEY)
+      --client-id string        The client ID used to authenticate with ConductorOne ($BATON_CLIENT_ID)
+      --client-secret string    The client secret used to authenticate with ConductorOne ($BATON_CLIENT_SECRET)
+      --company-domain string   required: The company domain for your BambooHR account ($BATON_COMPANY_DOMAIN)
+  -f, --file string             The path to the c1z file to sync with ($BATON_FILE) (default "sync.c1z")
+  -h, --help                    help for baton-bamboohr
+      --log-format string       The output format for logs: json, console ($BATON_LOG_FORMAT) (default "json")
+      --log-level string        The log level: debug, info, warn, error ($BATON_LOG_LEVEL) (default "info")
+  -p, --provisioning            This must be set in order for provisioning actions to be enabled ($BATON_PROVISIONING)
+      --skip-full-sync          This must be set to skip a full sync ($BATON_SKIP_FULL_SYNC)
+      --ticketing               This must be set to enable ticketing support ($BATON_TICKETING)
+  -v, --version                 version for baton-bamboohr
 
 Use "baton-bamboohr [command] --help" for more information about a command.
-
 ```

cmd/baton-bamboohr/config.go

@@ -1,34 +1,23 @@
 package main
 
 import (
-	"context"
-	"fmt"
-
-	"github.com/conductorone/baton-sdk/pkg/cli"
-	"github.com/spf13/cobra"
+	"github.com/conductorone/baton-sdk/pkg/field"
 )
 
-// config defines the external configuration required for the connector to run.
-type config struct {
-	cli.BaseConfig `mapstructure:",squash"` // Puts the base config options in the same place as the connector options
-
-	CompanyDomain string `mapstructure:"company-domain"`
-	ApiKey        string `mapstructure:"api-key"`
-}
-
-// validateConfig is run after the configuration is loaded, and should return an error if it isn't valid.
-func validateConfig(ctx context.Context, cfg *config) error {
-	if cfg.CompanyDomain == "" {
-		return fmt.Errorf("company domain is missing")
+var (
+	CompanyDomainField = field.StringField(
+		"company-domain",
+		field.WithDescription("The company domain for your BambooHR account"),
+		field.WithRequired(true),
+	)
+	ApiKeyField = field.StringField(
+		"api-key",
+		field.WithDescription("The api key for your BambooHR account"),
+		field.WithRequired(true),
+	)
+	configurationFields = []field.SchemaField{
+		CompanyDomainField,
+		ApiKeyField,
 	}
-	if cfg.ApiKey == "" {
-		return fmt.Errorf("api key is missing")
-	}
-	return nil
-}
-
-// cmdFlags sets the cmdFlags required for the connector.
-func cmdFlags(cmd *cobra.Command) {
-	cmd.PersistentFlags().String("company-domain", "", "The company domain for your BambooHR account. ($BATON_COMPANY_DOMAIN)")
-	cmd.PersistentFlags().String("api-key", "", "The api key for your BambooHR account. ($BATON_API_KEY)")
-}
+	Configuration = field.NewConfiguration(configurationFields)
+)

cmd/baton-bamboohr/main.go

@@ -5,12 +5,13 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/ConductorOne/BambooHR/pkg/connector"
-	"github.com/conductorone/baton-sdk/pkg/cli"
+	"github.com/conductorone/baton-bamboohr/pkg/connector"
+	"github.com/conductorone/baton-sdk/pkg/config"
 	"github.com/conductorone/baton-sdk/pkg/connectorbuilder"
-	"github.com/conductorone/baton-sdk/pkg/sdk"
+	"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"
 	"go.uber.org/zap"
 )
 
@@ -19,68 +20,46 @@ var version = "dev"
 func main() {
 	ctx := context.Background()
 
-	cfg := &config{}
-	cmd, err := cli.NewCmd(ctx, "baton-bamboohr", cfg, validateConfig, getConnector, run)
+	_, cmd, err := config.DefineConfiguration(
+		ctx,
+		"baton-bamboohr",
+		getConnector,
+		Configuration,
+	)
 	if err != nil {
 		fmt.Fprintln(os.Stderr, err.Error())
 		os.Exit(1)
 	}
 
 	cmd.Version = version
 
-	cmdFlags(cmd)
-
 	err = cmd.Execute()
 	if err != nil {
 		fmt.Fprintln(os.Stderr, err.Error())
 		os.Exit(1)
 	}
 }
 
-func getConnector(ctx context.Context, cfg *config) (types.ConnectorServer, error) {
+func getConnector(ctx context.Context, v *viper.Viper) (types.ConnectorServer, error) {
 	l := ctxzap.Extract(ctx)
-	config := connector.Config{
-		CompanyDomain: cfg.CompanyDomain,
-		ApiKey:        cfg.ApiKey,
+	err := field.Validate(Configuration, v)
+	if err != nil {
+		return nil, err
 	}
 
-	cb, err := connector.New(ctx, config)
+	cb, err := connector.New(
+		ctx,
+		v.GetString(CompanyDomainField.FieldName),
+		v.GetString(ApiKeyField.FieldName),
+	)
 	if err != nil {
 		l.Error("error creating connector", zap.Error(err))
 		return nil, err
 	}
-
 	connector, err := connectorbuilder.NewConnector(ctx, cb)
 	if err != nil {
 		l.Error("error creating connector", zap.Error(err))
 		return nil, err
 	}
-
 	return connector, nil
 }
-
-// run is where the process of syncing with the connector is implemented.
-func run(ctx context.Context, cfg *config) error {
-	l := ctxzap.Extract(ctx)
-
-	c, err := getConnector(ctx, cfg)
-	if err != nil {
-		l.Error("error creating connector", zap.Error(err))
-		return err
-	}
-
-	r, err := sdk.NewConnectorRunner(ctx, c, cfg.C1zPath)
-	if err != nil {
-		l.Error("error creating connector runner", zap.Error(err))
-		return err
-	}
-	defer r.Close()
-
-	err = r.Run(ctx)
-	if err != nil {
-		l.Error("error running connector", zap.Error(err))
-		return err
-	}
-
-	return nil
-}