logo

Author: speakyourcode

README.md

@@ -1,3 +1,26 @@
 # Grafana Button Control Panel
 
-Docs...
+This panel allows you to create buttons and define actions for them. It can be
+used to add controlling functionality to your dashboards. Actions are defined as
+queries to Datasources.
+
+Multiple buttons are allowed within a single panel, they can be arranged either
+horizontally or vertically.
+
+The query field is a JSON object, that depends on each Datasource type. You can
+use Grafana's Query Inspector to find out what Grafana sends to each Datasource,
+and copy those into the query field.
+
+## Examples
+
+Query field to delete InfluxDB database:
+
+```json
+{
+  "query": "drop databse 'foo'",
+  "rawQuery": true,
+  "resultFormat": "time_series"
+}
+```
+
+`refId`, `datasourceId` are automatically sent, so you don't have to set them.

package.json

@@ -21,6 +21,8 @@
     "@grafana/toolkit": "next",
     "@grafana/ui": "next",
     "@types/enzyme": "^3.10.5",
+    "@types/enzyme-adapter-react-16": "^1.0.6",
+    "@types/jest": "^25.2.3",
     "emotion": "10.0.27",
     "enzyme": "^3.11.0",
     "enzyme-adapter-react-16": "1.15.2"

src/buttonPanel.test.tsx

@@ -65,12 +65,14 @@ describe('button panel', () => {
     wrapper.setProps({ options: { buttons: buttons } });
 
     const mockGet = jest.fn().mockReturnValue({ id: 1 });
-    getDataSourceSrv.mockImplementation(() => ({ get: mockGet }));
+    (getDataSourceSrv as jest.Mock<any>).mockImplementation(() => ({
+      get: mockGet,
+    }));
     const mockDataSourceRequest = jest.fn().mockReturnValue({
       status: status,
       statusText: statusText,
     });
-    getBackendSrv.mockImplementation(() => ({
+    (getBackendSrv as jest.Mock<any>).mockImplementation(() => ({
       datasourceRequest: mockDataSourceRequest,
     }));
     const mockEmit = jest.fn();
@@ -103,14 +105,16 @@ describe('button panel', () => {
     wrapper.setProps({ options: { buttons: buttons } });
 
     const mockGet = jest.fn().mockReturnValue({ id: 1 });
-    getDataSourceSrv.mockImplementation(() => ({ get: mockGet }));
+    (getDataSourceSrv as jest.Mock<any>).mockImplementation(() => ({
+      get: mockGet,
+    }));
     const msg = 'msg';
     const mockDataSourceRequest = jest.fn().mockRejectedValue({
       status: statusError,
       statusText: statusText,
       data: { message: msg },
     });
-    getBackendSrv.mockImplementation(() => ({
+    (getBackendSrv as jest.Mock<any>).mockImplementation(() => ({
       datasourceRequest: mockDataSourceRequest,
     }));
     const mockEmit = jest.fn();

src/editor.test.tsx

@@ -1,6 +1,6 @@
 import { getBackendSrv } from '@grafana/runtime';
 import { Button, Collapse, Field } from '@grafana/ui';
-import { mount, shallow } from 'enzyme';
+import { shallow } from 'enzyme';
 import React from 'react';
 import { Editor, EditorProps } from './editor';
 jest.mock('@grafana/runtime');
@@ -37,9 +37,11 @@ describe('editor', () => {
     };
 
     const mockGet = jest.fn().mockReturnValue([{ name: 'a' }]);
-    getBackendSrv.mockImplementation(() => ({ get: mockGet }));
+    (getBackendSrv as jest.Mock<any>).mockImplementation(() => ({
+      get: mockGet,
+    }));
 
-    const wrapper = mount(<Editor {...props} />);
+    const wrapper = shallow(<Editor {...props} />);
     expect(wrapper.children()).toHaveLength(3);
     const collapse = wrapper.find(Collapse);
     expect(collapse).toHaveLength(2);

src/img/logo.svg

@@ -1455,7 +1455,14 @@
   dependencies:
     "@types/node" "*"
 
-"@types/enzyme@^3.10.5":
+"@types/enzyme-adapter-react-16@^1.0.6":
+  version "1.0.6"
+  resolved "https://registry.yarnpkg.com/@types/enzyme-adapter-react-16/-/enzyme-adapter-react-16-1.0.6.tgz#8aca7ae2fd6c7137d869b6616e696d21bb8b0cec"
+  integrity sha512-VonDkZ15jzqDWL8mPFIQnnLtjwebuL9YnDkqeCDYnB4IVgwUm0mwKkqhrxLL6mb05xm7qqa3IE95m8CZE9imCg==
+  dependencies:
+    "@types/enzyme" "*"
+
+"@types/enzyme@*", "@types/enzyme@^3.10.5":
   version "3.10.5"
   resolved "https://registry.yarnpkg.com/@types/enzyme/-/enzyme-3.10.5.tgz#fe7eeba3550369eed20e7fb565bfb74eec44f1f0"
   integrity sha512-R+phe509UuUYy9Tk0YlSbipRpfVtIzb/9BHn5pTEtjJTF5LXvUjrIQcZvNyANNEyFrd2YGs196PniNT1fgvOQA==
@@ -1615,7 +1622,7 @@
   dependencies:
     jest-diff "*"
 
-"@types/jest@*":
+"@types/jest@*", "@types/jest@^25.2.3":
   version "25.2.3"
   resolved "https://registry.yarnpkg.com/@types/jest/-/jest-25.2.3.tgz#33d27e4c4716caae4eced355097a47ad363fdcaf"
   integrity sha512-JXc1nK/tXHiDhV55dvfzqtmP4S3sy3T3ouV2tkViZgxY/zeUkcpQcQPGRlgF4KmWzWW5oiWYSZwtCB+2RsE4Fw==