mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
A simple version control system for dashboards. Closes #1504. Goals 1. To create a new dashboard version every time a dashboard is saved. 2. To allow users to view all versions of a given dashboard. 3. To allow users to rollback to a previous version of a dashboard. 4. To allow users to compare two versions of a dashboard. Usage Navigate to a dashboard, and click the settings cog. From there, click the "Changelog" button to be brought to the Changelog view. In this view, a table containing each version of a dashboard can be seen. Each entry in the table represents a dashboard version. A selectable checkbox, the version number, date created, name of the user who created that version, and commit message is shown in the table, along with a button that allows a user to restore to a previous version of that dashboard. If a user wants to restore to a previous version of their dashboard, they can do so by clicking the previously mentioned button. If a user wants to compare two different versions of a dashboard, they can do so by clicking the checkbox of two different dashboard versions, then clicking the "Compare versions" button located below the dashboard. From there, the user is brought to a view showing a summary of the dashboard differences. Each summarized change contains a link that can be clicked to take the user a JSON diff highlighting the changes line by line. Overview of Changes Backend Changes - A `dashboard_version` table was created to store each dashboard version, along with a dashboard version model and structs to represent the queries and commands necessary for the dashboard version API methods. - API endpoints were created to support working with dashboard versions. - Methods were added to create, update, read, and destroy dashboard versions in the database. - Logic was added to compute the diff between two versions, and display it to the user. - The dashboard migration logic was updated to save a "Version 1" of each existing dashboard in the database. Frontend Changes - New views - Methods to pull JSON and HTML from endpoints New API Endpoints Each endpoint requires the authorization header to be sent in the format, ``` Authorization: Bearer <jwt> ``` where `<jwt>` is a JSON web token obtained from the Grafana admin panel. `GET "/api/dashboards/db/:dashboardId/versions?orderBy=<string>&limit=<int>&start=<int>"` Get all dashboard versions for the given dashboard ID. Accepts three URL parameters: - `orderBy` String to order the results by. Possible values are `version`, `created`, `created_by`, `message`. Default is `versions`. Ordering is always in descending order. - `limit` Maximum number of results to return - `start` Position in results to start from `GET "/api/dashboards/db/:dashboardId/versions/:id"` Get an individual dashboard version by ID, for the given dashboard ID. `POST "/api/dashboards/db/:dashboardId/restore"` Restore to the given dashboard version. Post body is of content-type `application/json`, and must contain. ```json { "dashboardId": <int>, "version": <int> } ``` `GET "/api/dashboards/db/:dashboardId/compare/:versionA...:versionB"` Compare two dashboard versions by ID for the given dashboard ID, returning a JSON delta formatted representation of the diff. The URL format follows what GitHub does. For example, visiting [/api/dashboards/db/18/compare/22...33](http://ec2-54-80-139-44.compute-1.amazonaws.com:3000/api/dashboards/db/18/compare/22...33) will return the diff between versions 22 and 33 for the dashboard ID 18. Dependencies Added - The Go package [gojsondiff](https://github.com/yudai/gojsondiff) was added and vendored.
93 lines
3.2 KiB
TypeScript
93 lines
3.2 KiB
TypeScript
import {describe, beforeEach, it, sinon, expect, angularMocks} from 'test/lib/common';
|
|
|
|
import helpers from 'test/specs/helpers';
|
|
import AuditSrv from '../audit/audit_srv';
|
|
import { versions, compare, restore } from 'test/mocks/audit-mocks';
|
|
|
|
describe('auditSrv', function() {
|
|
var ctx = new helpers.ServiceTestContext();
|
|
|
|
var versionsResponse = versions();
|
|
var compareResponse = compare();
|
|
var restoreResponse = restore;
|
|
|
|
beforeEach(angularMocks.module('grafana.core'));
|
|
beforeEach(angularMocks.module('grafana.services'));
|
|
beforeEach(angularMocks.inject(function($httpBackend) {
|
|
ctx.$httpBackend = $httpBackend;
|
|
$httpBackend.whenRoute('GET', 'api/dashboards/db/:id/versions').respond(versionsResponse);
|
|
$httpBackend.whenRoute('GET', 'api/dashboards/db/:id/compare/:original...:new').respond(compareResponse);
|
|
$httpBackend.whenRoute('POST', 'api/dashboards/db/:id/restore')
|
|
.respond(function(method, url, data, headers, params) {
|
|
const parsedData = JSON.parse(data);
|
|
return [200, restoreResponse(parsedData.version)];
|
|
});
|
|
}));
|
|
beforeEach(ctx.createService('auditSrv'));
|
|
|
|
describe('getAuditLog', function() {
|
|
it('should return a versions array for the given dashboard id', function(done) {
|
|
ctx.service.getAuditLog({ id: 1 }).then(function(versions) {
|
|
expect(versions).to.eql(versionsResponse);
|
|
done();
|
|
});
|
|
ctx.$httpBackend.flush();
|
|
});
|
|
|
|
it('should return an empty array when not given an id', function(done) {
|
|
ctx.service.getAuditLog({ }).then(function(versions) {
|
|
expect(versions).to.eql([]);
|
|
done();
|
|
});
|
|
ctx.$httpBackend.flush();
|
|
});
|
|
|
|
it('should return an empty array when not given a dashboard', function(done) {
|
|
ctx.service.getAuditLog().then(function(versions) {
|
|
expect(versions).to.eql([]);
|
|
done();
|
|
});
|
|
ctx.$httpBackend.flush();
|
|
});
|
|
});
|
|
|
|
describe('compareVersions', function() {
|
|
it('should return a diff object for the given dashboard revisions', function(done) {
|
|
var compare = { original: 6, new: 4 };
|
|
ctx.service.compareVersions({ id: 1 }, compare).then(function(response) {
|
|
expect(response).to.eql(compareResponse);
|
|
done();
|
|
});
|
|
ctx.$httpBackend.flush();
|
|
});
|
|
|
|
it('should return an empty object when not given an id', function(done) {
|
|
var compare = { original: 6, new: 4 };
|
|
ctx.service.compareVersions({ }, compare).then(function(response) {
|
|
expect(response).to.eql({});
|
|
done();
|
|
});
|
|
ctx.$httpBackend.flush();
|
|
});
|
|
});
|
|
|
|
describe('restoreDashboard', function() {
|
|
it('should return a success response given valid parameters', function(done) {
|
|
var version = 6;
|
|
ctx.service.restoreDashboard({ id: 1 }, version).then(function(response) {
|
|
expect(response).to.eql(restoreResponse(version));
|
|
done();
|
|
});
|
|
ctx.$httpBackend.flush();
|
|
});
|
|
|
|
it('should return an empty object when not given an id', function(done) {
|
|
ctx.service.restoreDashboard({}, 6).then(function(response) {
|
|
expect(response).to.eql({});
|
|
done();
|
|
});
|
|
ctx.$httpBackend.flush();
|
|
});
|
|
});
|
|
});
|