feat: Generate full example configs from within SDK (#61)

Author: hermanschaaf

clients/destination.go

@@ -15,7 +15,13 @@ import (
 type DestinationClient struct {
 	pbClient pb.DestinationClient
 	// this can be used if we have a plugin which is compiled in, so we don't need to do any grpc requests
-	localClient plugins.DestinationPlugin
+	localClient *plugins.DestinationPlugin
+}
+
+// DestinationExampleConfigOptions can be used to override default example values.
+type DestinationExampleConfigOptions struct {
+	Path     string
+	Registry specs.Registry
 }
 
 func NewDestinationClient(cc grpc.ClientConnInterface) *DestinationClient {
@@ -24,7 +30,7 @@ func NewDestinationClient(cc grpc.ClientConnInterface) *DestinationClient {
 	}
 }
 
-func NewLocalDestinationClient(p plugins.DestinationPlugin) *DestinationClient {
+func NewLocalDestinationClient(p *plugins.DestinationPlugin) *DestinationClient {
 	return &DestinationClient{
 		localClient: p,
 	}
@@ -52,17 +58,6 @@ func (c *DestinationClient) Version(ctx context.Context) (string, error) {
 	return res.Version, nil
 }
 
-func (c *DestinationClient) GetExampleConfig(ctx context.Context) (string, error) {
-	if c.localClient != nil {
-		return c.localClient.ExampleConfig(), nil
-	}
-	res, err := c.pbClient.GetExampleConfig(ctx, &pb.GetExampleConfig_Request{})
-	if err != nil {
-		return "", err
-	}
-	return res.Config, nil
-}
-
 func (c *DestinationClient) Initialize(ctx context.Context, spec specs.Destination) error {
 	if c.localClient != nil {
 		return c.localClient.Initialize(ctx, spec)
@@ -80,6 +75,23 @@ func (c *DestinationClient) Initialize(ctx context.Context, spec specs.Destinati
 	return nil
 }
 
+func (c *DestinationClient) GetExampleConfig(ctx context.Context, opts DestinationExampleConfigOptions) (string, error) {
+	if c.localClient != nil {
+		return c.localClient.ExampleConfig(plugins.DestinationExampleConfigOptions{
+			Registry: opts.Registry,
+			Path:     opts.Path,
+		})
+	}
+	res, err := c.pbClient.GetExampleConfig(ctx, &pb.GetDestinationExampleConfig_Request{
+		Registry: opts.Registry.String(),
+		Path:     opts.Path,
+	})
+	if err != nil {
+		return "", err
+	}
+	return res.Config, nil
+}
+
 func (c *DestinationClient) Migrate(ctx context.Context, tables []*schema.Table) error {
 	if c.localClient != nil {
 		return c.localClient.Migrate(ctx, tables)

clients/source.go

@@ -22,6 +22,12 @@ type FetchResultMessage struct {
 	Resource []byte
 }
 
+// SourceExampleConfigOptions can be used to override default example values.
+type SourceExampleConfigOptions struct {
+	Path     string
+	Registry specs.Registry
+}
+
 func NewSourceClient(cc grpc.ClientConnInterface) *SourceClient {
 	return &SourceClient{
 		pbClient: pb.NewSourceClient(cc),
@@ -44,8 +50,11 @@ func (c *SourceClient) Version(ctx context.Context) (string, error) {
 	return res.Version, nil
 }
 
-func (c *SourceClient) ExampleConfig(ctx context.Context) (string, error) {
-	res, err := c.pbClient.GetExampleConfig(ctx, &pb.GetExampleConfig_Request{})
+func (c *SourceClient) ExampleConfig(ctx context.Context, opts SourceExampleConfigOptions) (string, error) {
+	res, err := c.pbClient.GetExampleConfig(ctx, &pb.GetSourceExampleConfig_Request{
+		Registry: opts.Registry.String(),
+		Path:     opts.Path,
+	})
 	if err != nil {
 		return "", fmt.Errorf("failed to get example config: %w", err)
 	}

codegen/doc.go

@@ -1,2 +1,2 @@
-//codgen helps autogenerate cloudquery plugins configured by definition
+// codgen helps autogenerate cloudquery plugins configured by definition
 package codegen

docs/source_test.go

@@ -2,7 +2,6 @@ package docs
 
 import (
 	"context"
-	"io/ioutil"
 	"os"
 	"path"
 	"testing"
@@ -100,7 +99,7 @@ func TestGenerateSourcePluginDocs(t *testing.T) {
 
 	for _, exp := range expectFiles {
 		output := path.Join(tmpdir, exp.Name)
-		got, err := ioutil.ReadFile(output)
+		got, err := os.ReadFile(output)
 		if err != nil {
 			t.Fatalf("error reading %q: %v ", exp.Name, err)
 		}