error source (#103)

error source

Author: scottlepp

.drone.yml

@@ -18,11 +18,11 @@ services:
 
 steps:
   - name: "test"
-    image: golang:1.20
+    image: golang:1.21
     commands:
       - go test ./...
   - name: "integraiton_tests"
-    image: golang:1.20
+    image: golang:1.21
     environment:
       INTEGRATION_TESTS: "true"
       MYSQL_URL: "mysql:mysql@tcp(mysql:3306)/mysql"
@@ -31,6 +31,6 @@ steps:
 
 ---
 kind: signature
-hmac: a87eed3ff4ff31806a1f22daad4f283b9c6b0e4f8a8be84ae611016a7c4ac474
+hmac: ee935b524c92f8c6eadfef904268c9a9d8ac6f0309d8a46597e5ae2ec49f1995
 
 ...

datasource.go

@@ -135,9 +135,11 @@ func (ds *SQLDatasource) QueryData(ctx context.Context, req *backend.QueryDataRe
 					}
 				}
 			}
+
 			response.Set(query.RefID, backend.DataResponse{
-				Frames: frames,
-				Error:  err,
+				Frames:      frames,
+				Error:       err,
+				ErrorSource: ErrorSource(err),
 			})
 
 			wg.Done()
@@ -241,8 +243,6 @@ func (ds *SQLDatasource) handleQuery(ctx context.Context, req backend.DataQuery,
 		return res, nil
 	}
 
-	// err = Unwrap(err)
-
 	if errors.Is(err, ErrorNoResults) {
 		return res, nil
 	}

datasource_connect_test.go

@@ -0,0 +1,125 @@
+package sqlds
+
+import (
+	"context"
+	"database/sql"
+	"encoding/json"
+	"errors"
+	"testing"
+
+	"github.com/grafana/grafana-plugin-sdk-go/backend"
+	"github.com/grafana/grafana-plugin-sdk-go/data/sqlutil"
+)
+
+type fakeDriver struct {
+	openDBfn func(msg json.RawMessage) (*sql.DB, error)
+
+	Driver
+}
+
+func (d fakeDriver) Connect(_ context.Context, _ backend.DataSourceInstanceSettings, msg json.RawMessage) (db *sql.DB, err error) {
+	return d.openDBfn(msg)
+}
+
+func (d fakeDriver) Macros() Macros {
+	return Macros{}
+}
+
+func (d fakeDriver) Converters() []sqlutil.Converter {
+	return []sqlutil.Converter{}
+}
+
+func Test_getDBConnectionFromQuery(t *testing.T) {
+	db := &sql.DB{}
+	db2 := &sql.DB{}
+	db3 := &sql.DB{}
+	d := &fakeDriver{openDBfn: func(msg json.RawMessage) (*sql.DB, error) { return db3, nil }}
+	tests := []struct {
+		desc        string
+		dsUID       string
+		args        string
+		existingDB  *sql.DB
+		expectedKey string
+		expectedDB  *sql.DB
+	}{
+		{
+			desc:        "it should return the default db with no args",
+			dsUID:       "uid1",
+			args:        "",
+			expectedKey: "uid1-default",
+			expectedDB:  db,
+		},
+		{
+			desc:        "it should return the cached connection for the given args",
+			dsUID:       "uid1",
+			args:        "foo",
+			expectedKey: "uid1-foo",
+			existingDB:  db2,
+			expectedDB:  db2,
+		},
+		{
+			desc:        "it should create a new connection with the given args",
+			dsUID:       "uid1",
+			args:        "foo",
+			expectedKey: "uid1-foo",
+			expectedDB:  db3,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.desc, func(t *testing.T) {
+			ds := &SQLDatasource{c: d, EnableMultipleConnections: true}
+			settings := backend.DataSourceInstanceSettings{UID: tt.dsUID}
+			key := defaultKey(tt.dsUID)
+			// Add the mandatory default db
+			ds.storeDBConnection(key, dbConnection{db, settings})
+			if tt.existingDB != nil {
+				key = keyWithConnectionArgs(tt.dsUID, []byte(tt.args))
+				ds.storeDBConnection(key, dbConnection{tt.existingDB, settings})
+			}
+
+			key, dbConn, err := ds.getDBConnectionFromQuery(context.Background(), &Query{ConnectionArgs: json.RawMessage(tt.args)}, tt.dsUID)
+			if err != nil {
+				t.Fatalf("unexpected error %v", err)
+			}
+			if key != tt.expectedKey {
+				t.Fatalf("unexpected cache key %s", key)
+			}
+			if dbConn.db != tt.expectedDB {
+				t.Fatalf("unexpected result %v", dbConn.db)
+			}
+		})
+	}
+
+	t.Run("it should return an error if connection args are used without enabling multiple connections", func(t *testing.T) {
+		ds := &SQLDatasource{c: d, EnableMultipleConnections: false}
+		_, _, err := ds.getDBConnectionFromQuery(context.Background(), &Query{ConnectionArgs: json.RawMessage("foo")}, "dsUID")
+		if err == nil || !errors.Is(err, MissingMultipleConnectionsConfig) {
+			t.Errorf("expecting error: %v", MissingMultipleConnectionsConfig)
+		}
+	})
+
+	t.Run("it should return an error if the default connection is missing", func(t *testing.T) {
+		ds := &SQLDatasource{c: d}
+		_, _, err := ds.getDBConnectionFromQuery(context.Background(), &Query{}, "dsUID")
+		if err == nil || !errors.Is(err, MissingDBConnection) {
+			t.Errorf("expecting error: %v", MissingDBConnection)
+		}
+	})
+}
+
+func Test_Dispose(t *testing.T) {
+	t.Run("it should not delete connections", func(t *testing.T) {
+		ds := &SQLDatasource{}
+		ds.dbConnections.Store(defaultKey("uid1"), dbConnection{})
+		ds.dbConnections.Store("foo", dbConnection{})
+		ds.Dispose()
+		count := 0
+		ds.dbConnections.Range(func(key, value interface{}) bool {
+			count++
+			return true
+		})
+		if count != 2 {
+			t.Errorf("missing connections")
+		}
+	})
+}