Merge branch 'master' into gw0/add-http-headers

Author: julienduchesne

.drone.jsonnet renamed to .drone/drone.jsonnet

@@ -14,10 +14,7 @@ local pipeline(name, trigger) = {
       name: 'test',
       image: image,
       commands: [
-        'go version',
-        'golangci-lint --version',
-        'golangci-lint run ./...',
-        'go test -cover -race -vet all -mod readonly ./...',
+        'make test',
       ],
     },
   ],
@@ -29,6 +26,7 @@ local pipeline(name, trigger) = {
       'pull_request',
     ],
   }),
+
   pipeline('test-master', {
     branch: 'master',
     event: [

.drone/drone.yml

@@ -0,0 +1,45 @@
+---
+kind: pipeline
+type: docker
+name: test-pr
+
+platform:
+  os: linux
+  arch: amd64
+
+steps:
+- name: test
+  image: grafana/build-container:1.2.27
+  commands:
+  - make test
+
+trigger:
+  event:
+  - pull_request
+
+---
+kind: pipeline
+type: docker
+name: test-master
+
+platform:
+  os: linux
+  arch: amd64
+
+steps:
+- name: test
+  image: grafana/build-container:1.2.27
+  commands:
+  - make test
+
+trigger:
+  branch:
+  - master
+  event:
+  - push
+
+---
+kind: signature
+hmac: 4b9e92aa0df11523a1df89ec418113152fa135a012967f3c9e11a9fbc27a7dea
+
+...

Makefile

@@ -0,0 +1,13 @@
+.PHONY: drone, test
+
+drone:
+	drone jsonnet --stream --format --source .drone/drone.jsonnet --target .drone/drone.yml
+	drone lint .drone/drone.yml
+	drone sign --save grafana/grafana-api-golang-client .drone/drone.yml
+
+test:
+	go version
+	golangci-lint --version
+	golangci-lint run ./...
+	go test -cover -race -vet all -mod readonly ./...
+

README.md

@@ -1,17 +1,9 @@
-# DEPRECATED
+# Grafana HTTP API Client for Go
 
-:warning: :warning: :warning:
+This library provides a low-level client to access Grafana [HTTP API](https://grafana.com/docs/grafana/latest/http_api/).
 
-**This repository is no longer being maintained.**
-
-We're in the process of creating our next generation API clients.
-
-In the interim, further changes to this repository should only be to support
-[grafana/terraform-provider-grafana](https://github.com/grafana/terraform-provider-grafana).
-
----
-
-Grafana HTTP API Client for Go
+:warning: This repository is still active but not under heavy development.
+Contributions to this library offering support for the [Terraform provider for Grafana](https://github.com/grafana/terraform-provider-grafana) will be prioritized over generic ones.
 
 ## Tests
 

alertnotification.go

@@ -17,6 +17,8 @@ type AlertNotification struct {
 	SendReminder          bool        `json:"sendReminder"`
 	Frequency             string      `json:"frequency"`
 	Settings              interface{} `json:"settings"`
+	SecureFields          interface{} `json:"secureFields,omitempty"`
+	SecureSettings        interface{} `json:"secureSettings,omitempty"`
 }
 
 // AlertNotifications fetches and returns Grafana alert notifications.

annotation.go

@@ -38,7 +38,7 @@ type GraphiteAnnotation struct {
 // Annotations fetches the annotations queried with the params it's passed
 func (c *Client) Annotations(params url.Values) ([]Annotation, error) {
 	result := []Annotation{}
-	err := c.request("GET", "/api/annotation", params, nil, &result)
+	err := c.request("GET", "/api/annotations", params, nil, &result)
 	if err != nil {
 		return nil, err
 	}

api_key.go

@@ -0,0 +1,67 @@
+package gapi
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"net/url"
+	"strconv"
+	"time"
+)
+
+type CreateAPIKeyRequest struct {
+	Name          string `json:"name"`
+	Role          string `json:"role"`
+	SecondsToLive int64  `json:"secondsToLive,omitempty"`
+}
+
+type CreateAPIKeyResponse struct {
+	// ID field only returned after Grafana v7.
+	ID   int64  `json:"id,omitempty"`
+	Name string `json:"name"`
+	Key  string `json:"key"`
+}
+
+type GetAPIKeysResponse struct {
+	ID         int64     `json:"id"`
+	Name       string    `json:"name"`
+	Role       string    `json:"role"`
+	Expiration time.Time `json:"expiration,omitempty"`
+}
+
+type DeleteAPIKeyResponse struct {
+	Message string `json:"message"`
+}
+
+// CreateAPIKey creates a new Grafana API key.
+func (c *Client) CreateAPIKey(request CreateAPIKeyRequest) (CreateAPIKeyResponse, error) {
+	response := CreateAPIKeyResponse{}
+
+	data, err := json.Marshal(request)
+	if err != nil {
+		return response, err
+	}
+
+	err = c.request("POST", "/api/auth/keys", nil, bytes.NewBuffer(data), &response)
+	return response, err
+}
+
+// GetAPIKeys retrieves a list of all API keys.
+func (c *Client) GetAPIKeys(includeExpired bool) ([]*GetAPIKeysResponse, error) {
+	response := make([]*GetAPIKeysResponse, 0)
+
+	query := url.Values{}
+	query.Add("includeExpired", strconv.FormatBool(includeExpired))
+
+	err := c.request("GET", "/api/auth/keys", query, nil, &response)
+	return response, err
+}
+
+// DeleteAPIKey deletes the Grafana API key with the specified ID.
+func (c *Client) DeleteAPIKey(id int64) (DeleteAPIKeyResponse, error) {
+	response := DeleteAPIKeyResponse{}
+
+	path := fmt.Sprintf("/api/auth/keys/%d", id)
+	err := c.request("DELETE", path, nil, nil, &response)
+	return response, err
+}

api_key_test.go

@@ -0,0 +1,68 @@
+package gapi
+
+import (
+	"testing"
+
+	"github.com/gobs/pretty"
+)
+
+const (
+	createAPIKeyJSON = `{"name":"key-name", "key":"mock-api-key"}`
+	deleteAPIKeyJSON = `{"message":"API key deleted"}`
+
+	getAPIKeysJSON = `[
+		{
+			"id": 1,
+			"name": "key-name-2",
+			"role": "Viewer"
+		},
+		{
+			"id": 2,
+			"name": "key-name-2",
+			"role": "Admin",
+			"expiration": "2021-10-30T10:52:03+03:00"
+		}
+	]`
+)
+
+func TestCreateAPIKey(t *testing.T) {
+	server, client := gapiTestTools(t, 200, createAPIKeyJSON)
+	defer server.Close()
+
+	req := CreateAPIKeyRequest{
+		Name:          "key-name",
+		Role:          "Viewer",
+		SecondsToLive: 0,
+	}
+
+	res, err := client.CreateAPIKey(req)
+	if err != nil {
+		t.Error(err)
+	}
+
+	t.Log(pretty.PrettyFormat(res))
+}
+
+func TestDeleteAPIKey(t *testing.T) {
+	server, client := gapiTestTools(t, 200, deleteAPIKeyJSON)
+	defer server.Close()
+
+	res, err := client.DeleteAPIKey(int64(1))
+	if err != nil {
+		t.Error(err)
+	}
+
+	t.Log(pretty.PrettyFormat(res))
+}
+
+func TestGetAPIKeys(t *testing.T) {
+	server, client := gapiTestTools(t, 200, getAPIKeysJSON)
+	defer server.Close()
+
+	res, err := client.GetAPIKeys(true)
+	if err != nil {
+		t.Error(err)
+	}
+
+	t.Log(pretty.PrettyFormat(res))
+}

builtin_role_assignments.go

@@ -0,0 +1,58 @@
+package gapi
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+)
+
+const baseURL = "/api/access-control/builtin-roles"
+
+type BuiltInRoleAssignment struct {
+	BuiltinRole string `json:"builtInRole"`
+	RoleUID     string `json:"roleUid"`
+	Global      bool   `json:"global"`
+}
+
+// GetBuiltInRoleAssignments gets all built-in role assignments. Available only in Grafana Enterprise 8.+.
+func (c *Client) GetBuiltInRoleAssignments() (map[string][]*Role, error) {
+	br := make(map[string][]*Role)
+	err := c.request("GET", baseURL, nil, nil, &br)
+	if err != nil {
+		return nil, err
+	}
+	return br, nil
+}
+
+// NewBuiltInRoleAssignment creates a new built-in role assignment. Available only in Grafana Enterprise 8.+.
+func (c *Client) NewBuiltInRoleAssignment(builtInRoleAssignment BuiltInRoleAssignment) (*BuiltInRoleAssignment, error) {
+	body, err := json.Marshal(builtInRoleAssignment)
+	if err != nil {
+		return nil, err
+	}
+
+	br := &BuiltInRoleAssignment{}
+
+	err = c.request("POST", baseURL, nil, bytes.NewBuffer(body), &br)
+	if err != nil {
+		return nil, err
+	}
+
+	return br, err
+}
+
+// DeleteBuiltInRoleAssignment remove the built-in role assignments. Available only in Grafana Enterprise 8.+.
+func (c *Client) DeleteBuiltInRoleAssignment(builtInRole BuiltInRoleAssignment) error {
+	data, err := json.Marshal(builtInRole)
+	if err != nil {
+		return err
+	}
+
+	qp := map[string][]string{
+		"global": {fmt.Sprint(builtInRole.Global)},
+	}
+	url := fmt.Sprintf("%s/%s/roles/%s", baseURL, builtInRole.BuiltinRole, builtInRole.RoleUID)
+	err = c.request("DELETE", url, qp, bytes.NewBuffer(data), nil)
+
+	return err
+}