feat: dashboard versions API support (#194)

* feat: dashboard versions API support

* chore: add test and update style

* improve naming

Co-authored-by: Giedrius Statkevičius <[email protected]>

Co-authored-by: Vincent Miszczak <[email protected]>
Co-authored-by: Giedrius Statkevičius <[email protected]>

Author: 3 people

rest-dashboard.go

@@ -116,6 +116,38 @@ func (r *Client) GetDashboardBySlug(ctx context.Context, slug string) (Board, Bo
 	return r.getDashboard(ctx, path)
 }
 
+// DashboardVersion represents a response from /api/dashboards/id/:dashboardId/versions API
+type DashboardVersion struct {
+	ID            uint      `json:"id"`
+	DashboardID   uint      `json:"dashboardId"`
+	ParentVersion uint      `json:"parentVersion"`
+	RestoredFrom  uint      `json:"restoredFrom"`
+	Version       uint      `json:"version"`
+	Created       time.Time `json:"created"`
+	CreatedBy     string    `json:"createdBy"`
+	Message       string    `json:"message"`
+}
+
+// GetDashboardVersionsByDashboardID reflects /api/dashboards/id/:dashboardId/versions API call
+func (r *Client) GetDashboardVersionsByDashboardID(ctx context.Context, dashboardID uint, params ...QueryParam) ([]DashboardVersion, error) {
+	var (
+		raw  []byte
+		code int
+		err  error
+	)
+
+	if raw, code, err = r.get(ctx, fmt.Sprintf("api/dashboards/id/%d/versions", dashboardID), queryParams(params...)); err != nil {
+		return nil, err
+	}
+	if code != 200 {
+		return nil, fmt.Errorf("HTTP error %d: returns %s", code, raw)
+	}
+	var versions []DashboardVersion
+	err = json.Unmarshal(raw, &versions)
+
+	return versions, err
+}
+
 // getDashboard loads a dashboard from Grafana instance along with metadata for a dashboard.
 // For dashboards from a filesystem set "file/" prefix for slug. By default dashboards from
 // a database assumed. Database dashboards may have "db/" prefix or may have not, it will
@@ -396,8 +428,34 @@ type (
 	SearchParam func(*url.Values)
 	// SearchParamType is a type accepted by SearchType func.
 	SearchParamType string
+	// QueryParam is a type for specifying arbitrary API parameters
+	QueryParam func(*url.Values)
 )
 
+// queryParams returns url.Values built from multiple QueryParam
+func queryParams(params ...QueryParam) url.Values {
+	u := url.URL{}
+	q := u.Query()
+	for _, p := range params {
+		p(&q)
+	}
+	return q
+}
+
+// QueryParamStart sets `start` parameter
+func QueryParamStart(start uint) QueryParam {
+	return func(v *url.Values) {
+		v.Set("start", strconv.Itoa(int(start)))
+	}
+}
+
+// QueryParamLimit sets `limit` parameter
+func QueryParamLimit(limit uint) QueryParam {
+	return func(v *url.Values) {
+		v.Set("limit", strconv.Itoa(int(limit)))
+	}
+}
+
 // Search entities to be used with SearchType().
 const (
 	SearchTypeFolder    SearchParamType = "dash-folder"

rest-dashboard_integration_test.go

@@ -116,3 +116,69 @@ func Test_Dashboard_CRUD_By_UID(t *testing.T) {
 	}
 
 }
+
+func Test_GetDashboardVersionsByDashboardID(t *testing.T) {
+	var (
+		board sdk.Board
+		err   error
+		start = sdk.QueryParamStart(0)
+		limit = sdk.QueryParamLimit(10)
+	)
+	ctx := context.Background()
+	client := getClient(t)
+	raw, _ := ioutil.ReadFile("testdata/new-empty-dashboard-2.6.json")
+
+	if err = json.Unmarshal(raw, &board); err != nil {
+		t.Fatal(err)
+	}
+	board.UID = "1234"
+	if _, err = client.DeleteDashboardByUID(ctx, board.UID); err != nil {
+		t.Fatal(err)
+	}
+
+	params := sdk.SetDashboardParams{
+		FolderID:  sdk.DefaultFolderId,
+		Overwrite: false,
+	}
+	// create initial dashboard
+	if _, err = client.SetDashboard(ctx, board, params); err != nil {
+		t.Fatal(err)
+	}
+
+	board, _, err = client.GetDashboardByUID(ctx, board.UID)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	// update dashboard to create a new version
+	params.Overwrite = true
+	if _, err = client.SetDashboard(ctx, board, params); err != nil {
+		t.Fatal(err)
+	}
+	board, _, err = client.GetDashboardByUID(ctx, board.UID)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	// fetch versions
+	versions, err := client.GetDashboardVersionsByDashboardID(ctx, board.ID, start, limit)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	// we should have 2 versions
+	if len(versions) != 2 {
+		t.Fatal("dashboard should have 2 versions")
+	}
+	// the latest version in Grafana should match the current version of the board
+	// API returns versions sorted DESC
+	if versions[0].Version != board.Version {
+		t.Fatal("dashboard version from dashboards/uid/:uid API does not match latest dashboard version from dashboards/id/:dashboardId/versions API")
+	}
+
+	// fetch non-existing dashboard to validate error case
+	_, err = client.GetDashboardVersionsByDashboardID(ctx, 42, start, limit)
+	if err == nil {
+		t.Fatal("when fetching dashboard version with erroneous inputs, it should return an error, got nil error")
+	}
+}