ParseOptions helper function (#50)

Author: andresmgot

completion.go

@@ -16,8 +16,12 @@ const (
 	columns = "columns"
 )
 
-// ErrorNotImplemented is returned if the function is not implemented by the provided Driver (the Completable pointer is nil)
-var ErrorNotImplemented = errors.New("not implemented")
+var (
+	// ErrorNotImplemented is returned if the function is not implemented by the provided Driver (the Completable pointer is nil)
+	ErrorNotImplemented = errors.New("not implemented")
+	// ErrorWrongOptions when trying to parse Options with a invalid JSON
+	ErrorWrongOptions = errors.New("error reading query options")
+)
 
 // Options are used to query schemas, tables and columns. They will be encoded in the request body (e.g. {"database": "mydb"})
 type Options map[string]string
@@ -99,3 +103,14 @@ func (ds *sqldatasource) registerRoutes(mux *http.ServeMux) error {
 	}
 	return nil
 }
+
+func ParseOptions(rawOptions json.RawMessage) (Options, error) {
+	args := Options{}
+	if rawOptions != nil {
+		err := json.Unmarshal(rawOptions, &args)
+		if err != nil {
+			return nil, fmt.Errorf("%w: %v", ErrorWrongOptions, err)
+		}
+	}
+	return args, nil
+}

completion_test.go

@@ -3,12 +3,16 @@ package sqlds
 import (
 	"bytes"
 	"context"
+	"encoding/json"
+	"errors"
 	"fmt"
 	"io"
 	"io/ioutil"
 	"net/http"
 	"net/http/httptest"
 	"testing"
+
+	"github.com/google/go-cmp/cmp"
 )
 
 func Test_handleError(t *testing.T) {
@@ -169,3 +173,34 @@ func Test_registerRoutes(t *testing.T) {
 		}
 	})
 }
+
+func TestParseOptions(t *testing.T) {
+	tests := []struct {
+		description string
+		input       json.RawMessage
+		result      Options
+		err         error
+	}{
+		{
+			description: "parses input",
+			input:       json.RawMessage(`{"foo":"bar"}`),
+			result:      Options{"foo": "bar"},
+		},
+		{
+			description: "returns an error",
+			input:       json.RawMessage(`not a json`),
+			err:         ErrorWrongOptions,
+		},
+	}
+	for _, tc := range tests {
+		t.Run(tc.description, func(t *testing.T) {
+			res, err := ParseOptions(tc.input)
+			if (err != nil || tc.err != nil) && !errors.Is(err, tc.err) {
+				t.Errorf("unexpected error %v", err)
+			}
+			if !cmp.Equal(res, tc.result) {
+				t.Errorf("unexpected result: %v", cmp.Diff(res, tc.result))
+			}
+		})
+	}
+}

go.mod

@@ -5,6 +5,7 @@ go 1.15
 require (
 	github.com/DATA-DOG/go-sqlmock v1.5.0
 	github.com/go-sql-driver/mysql v1.4.0
+	github.com/google/go-cmp v0.5.6
 	github.com/grafana/grafana-plugin-sdk-go v0.94.0
 	github.com/stretchr/testify v1.7.0
 	golang.org/x/net v0.0.0-20210226172049-e18ecbb05110 // indirect

go.sum

@@ -112,8 +112,9 @@ github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMyw
 github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
-github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+github.com/google/go-cmp v0.5.6 h1:BKbKCqvP6I+rmFHt06ZmyQtvB8xAkWdhFyr0ZUNZcxQ=
+github.com/google/go-cmp v0.5.6/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
 github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
 github.com/google/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=