Add --base-url flag for connector testability

cmd/baton-zendesk/main.go

@@ -52,6 +52,7 @@ func getConnector(ctx context.Context, cfg *config.Zendesk) (types.ConnectorServ
 		cfg.Subdomain,
 		cfg.Email,
 		cfg.ApiToken,
+		cfg.BaseUrl,
 	)
 	if err != nil {
 		logger.Error("error creating connector", zap.Error(err))

pkg/client/client.go

@@ -33,15 +33,23 @@ type ZendeskClient struct {
 	client *zendesk.Client
 }
 
-func New(ctx context.Context, httpClient *http.Client, subdomain string, email string, apiToken string) (*ZendeskClient, error) {
+func New(ctx context.Context, httpClient *http.Client, subdomain string, email string, apiToken string, baseURL string) (*ZendeskClient, error) {
 	zc := &ZendeskClient{}
 	client, err := zendesk.NewClient(httpClient)
 	if err != nil {
 		return nil, err
 	}
-	err = client.SetSubdomain(subdomain)
-	if err != nil {
-		return nil, err
+	// Custom base URL takes precedence over subdomain-based URL
+	if baseURL != "" {
+		err = client.SetEndpointURL(baseURL)
+		if err != nil {
+			return nil, err
+		}
+	} else {
+		err = client.SetSubdomain(subdomain)
+		if err != nil {
+			return nil, err
+		}
 	}
 	client.SetCredential(zendesk.NewAPITokenCredential(email, apiToken))
 	zc.client = client

pkg/config/config.go

@@ -29,12 +29,20 @@ var (
 		field.WithDisplayName("Organizations"),
 		field.WithDescription("Limit syncing to specific organizations"),
 	)
+	BaseURLField = field.StringField(
+		"base-url",
+		field.WithDisplayName("Base URL"),
+		field.WithDescription("Override the Zendesk API URL (for testing)"),
+		field.WithHidden(true),
+		field.WithExportTarget(field.ExportTargetCLIOnly),
+	)
 
 	ConfigurationFields = []field.SchemaField{
 		SubdomainField,
 		ApiTokenField,
 		EmailField,
 		OrgsField,
+		BaseURLField,
 	}
 )
 

pkg/connector/connector.go

@@ -25,6 +25,7 @@ type Connector struct {
 	subdomain      string
 	email          string
 	apiToken       string
+	baseURL        string
 }
 
 func (c *Connector) cacheUsers(ctx context.Context) ([]zendesk.User, error) {
@@ -124,11 +125,11 @@ func (d *Connector) Validate(ctx context.Context) (annotations.Annotations, erro
 }
 
 // New returns a new instance of the connector.
-func New(ctx context.Context, zendeskOrgs []string, subdomain string, email string, apiToken string) (*Connector, error) {
+func New(ctx context.Context, zendeskOrgs []string, subdomain string, email string, apiToken string, baseURL string) (*Connector, error) {
 	var zc *client.ZendeskClient
 	if apiToken != "" {
 		var err error
-		zc, err = client.New(ctx, nil, subdomain, email, apiToken)
+		zc, err = client.New(ctx, nil, subdomain, email, apiToken, baseURL)
 		if err != nil {
 			return nil, err
 		}
@@ -140,5 +141,6 @@ func New(ctx context.Context, zendeskOrgs []string, subdomain string, email stri
 		subdomain:     subdomain,
 		email:         email,
 		apiToken:      apiToken,
+		baseURL:       baseURL,
 	}, nil
 }