Clean up source code and restructuring API calls (#19)

Author: Patrick-Eichhorn

pkg/plugin/git_api.go

@@ -39,11 +39,6 @@ func NewGitApi(gitUrl string, privateKey []byte) GitApi {
 // helper function to create the git authenticator
 func createAuthenticator(privateKey []byte) (*ssh.PublicKeys, error) {
 	// git authentication with ssh
-	// _, err := os.Stat(privateKeyFilePath)
-	// if err != nil {
-	// 	log.DefaultLogger.Error("read file failed", privateKeyFilePath, err.Error())
-	// 	return nil, err
-	// }
 	authenticator, err := ssh.NewPublicKeys("git", privateKey, "")
 	if err != nil {
 		log.DefaultLogger.Error("generate public keys failed", "error", err.Error())

pkg/plugin/grafana_api.go

@@ -43,13 +43,20 @@ func (grafanaApi GrafanaApi) GetDashboardObjectByID(uid string) (sdk.Board, sdk.
 	return dashboardObject, props, err
 }
 
-// UpdateDashboardObjectByID update the Dashboard with the given dashboard object
-func (grafanaApi GrafanaApi) UpdateDashboardObjectByID(dashboard sdk.Board, folderId int) (sdk.StatusMessage, error) {
-	statusMessage, err := grafanaApi.grafanaClient.SetDashboard(context.Background(), dashboard, sdk.SetDashboardParams{
-		Overwrite: false,
-		FolderID:  folderId,
+// CreateOrUpdateDashboardObjectByID create or update the Dashboard with the given dashboard object
+func (grafanaApi GrafanaApi) CreateOrUpdateDashboardObjectByID(rawDashboard []byte, folderId int, message string) (sdk.StatusMessage) {
+	statusMessage, err := grafanaApi.grafanaClient.SetRawDashboardWithParam(context.Background(), sdk.RawBoardRequest{
+		Dashboard: rawDashboard,
+		Parameters: sdk.SetDashboardParams{
+			Overwrite: true,
+			FolderID:  folderId,
+			Message:   message,
+		},
 	})
-	return statusMessage, err
+	if err != nil {
+		log.DefaultLogger.Error("set dashboard error", "error", err.Error())
+	}
+	return statusMessage
 }
 
 // CreateFolder create a folder in Grafana
@@ -130,25 +137,15 @@ func (grafanaApi GrafanaApi) parseGetDashboardError(error error, gitBoardID int,
 // CreateDashboardObjects set a Dashboard with the given raw dashboard object
 func (grafanaApi GrafanaApi) CreateDashboardObjects(fileMap map[string]map[string][]byte) {
 	for dashboardDir, dashboardFile := range fileMap {
-		dirID := grafanaApi.GetOrCreateFolderID(dashboardDir)
+		folderID := grafanaApi.GetOrCreateFolderID(dashboardDir)
 		for dashboardName, rawDashboard := range dashboardFile {
 			gitDashboardObject := getDashboardObjectFromRawDashboard(rawDashboard)
 			// get grafana dashboard to compare version with git dashboard
 			grafanaDashboardObject, _, err := grafanaApi.GetDashboardObjectByID(gitDashboardObject.UID)
 			grafanaDashboardVersionMessageId := grafanaApi.parseGetDashboardError(err, int(gitDashboardObject.ID), int(grafanaDashboardObject.ID))
 
 			if grafanaDashboardVersionMessageId != int(gitDashboardObject.Version) {
-				_, err := grafanaApi.grafanaClient.SetRawDashboardWithParam(context.Background(), sdk.RawBoardRequest{
-					Dashboard: rawDashboard,
-					Parameters: sdk.SetDashboardParams{
-						Overwrite: true,
-						FolderID:  dirID,
-						Message:   "Synchronized from Version " + strconv.Itoa(int(gitDashboardObject.Version)),
-					},
-				})
-				if err != nil {
-					log.DefaultLogger.Error("set dashboard error", "error", err.Error())
-				}
+				grafanaApi.CreateOrUpdateDashboardObjectByID(rawDashboard, folderID, "Synchronized from Version " + strconv.Itoa(int(gitDashboardObject.Version)))
 				log.DefaultLogger.Debug("Dashboard created", "name", dashboardName)
 			} else {
 				log.DefaultLogger.Info("Dashboard already up-to-date", "name", dashboardName)

pkg/plugin/plugin.go

@@ -3,6 +3,7 @@ package plugin
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 
 	"github.com/grafana/grafana-plugin-sdk-go/backend"
 	"github.com/grafana/grafana-plugin-sdk-go/backend/instancemgmt"
@@ -90,28 +91,29 @@ func (d *SampleDatasource) CheckHealth(_ context.Context, req *backend.CheckHeal
 	dashboardTag := uiProperties.PushConfiguration.TagPattern
 	privateKey := []byte(uiSecureProperties["privateSshKey"])
 
-	// privateKeyFilePath := uiSecureProperties["privateKeyFilePath"]
-
 	grafanaApi := NewGrafanaApi(grafanaUrl, token)
 
 	gitApi := NewGitApi(uiProperties.GitUrl, privateKey)
 	log.DefaultLogger.Info("Using Git repository from: %s", uiProperties.GitUrl)
 
+	// clone and fetch repo
 	repository, err := gitApi.CloneRepo()
 	if err != nil {
 		return nil, err
 	}
 	gitApi.FetchRepo(*repository)
 
+	// Pull
 	if uiProperties.PullConfiguration.Enable {
 		log.DefaultLogger.Info("Pull from git repo", "url", gitUrl)
 
 		gitApi.PullRepo(*repository)
 		fileMap := gitApi.GetFileContent()
 		grafanaApi.CreateDashboardObjects(fileMap)
-		log.DefaultLogger.Info("Dashboards created")
+		log.DefaultLogger.Info("Pull process finished and dashboards created")
 	}
 
+	// Push
 	if uiProperties.PushConfiguration.Enable {
 		log.DefaultLogger.Info("Push to git repo", "url", gitUrl)
 
@@ -133,19 +135,17 @@ func (d *SampleDatasource) CheckHealth(_ context.Context, req *backend.CheckHeal
 			folderName := boardProperties.FolderTitle
 			folderId := boardProperties.FolderID
 
-			// update dashboard with deleted Tag in Grafana
-			_, err = grafanaApi.UpdateDashboardObjectByID(dashboardWithDeletedTag, folderId)
-			if err != nil {
-				log.DefaultLogger.Error("update dashboard", "error", err.Error())
-			}
-
 			// get raw Json Dashboard, required for import and export
-			dashboardJson, _, err := grafanaApi.GetRawDashboardByID(dashboard.UID)
+			dashboardJson, err := json.Marshal(dashboardWithDeletedTag)
 			if err != nil {
 				log.DefaultLogger.Error("get raw dashboard", "error", err.Error())
 			}
 
+			// update dashboard with deleted Tag in Grafana
+			grafanaApi.CreateOrUpdateDashboardObjectByID(dashboardJson, folderId, fmt.Sprintf("Deleted '%s' tag", dashboardTag))
 			log.DefaultLogger.Debug("Dashboard preparation successfully ")
+
+			// Add Dashboard to in memory file system
 			gitApi.AddFileWithContent(folderName+"/"+dashboardObject.Title+".json", string(dashboardJson))
 			log.DefaultLogger.Debug("Dashboard added to in memory file system")
 		}
@@ -155,7 +155,7 @@ func (d *SampleDatasource) CheckHealth(_ context.Context, req *backend.CheckHeal
 			gitApi.PushRepo(*repository)
 		}
 
-		log.DefaultLogger.Info("Dashboard pushed successfully")
+		log.DefaultLogger.Info("Dashboards pushed successfully")
 	}
 
 	return &backend.CheckHealthResult{