Support organisations query handler (#662)

Adding an organisations query handler to support ds abstraction. At the
moment this will not be exposed to the frontend as a query type but it
can be in the future.

Author: aangelisc

pkg/github/codescanning_test.go

@@ -56,6 +56,10 @@ func (m *mockClient) ListDeployments(ctx context.Context, owner, repo string, op
 	return nil, nil, nil
 }
 
+func (m *mockClient) ListAllOrgRepositories(ctx context.Context, opts *googlegithub.ListOptions) ([]*googlegithub.Repository, *googlegithub.Response, error) {
+	return nil, nil, nil
+}
+
 func TestGetCodeScanningAlerts(t *testing.T) {
 	var (
 		ctx  = context.Background()

pkg/github/datasource.go

@@ -229,6 +229,15 @@ func (d *Datasource) HandleDeploymentsQuery(ctx context.Context, query *models.D
 	return GetDeploymentsInRange(ctx, d.client, opt, req.TimeRange.From, req.TimeRange.To)
 }
 
+// HandleOrganizationsQuery is the query handler for listing GitHub Organizations
+func (d *Datasource) HandleOrganizationsQuery(ctx context.Context, query *models.OrganizationsQuery, req backend.DataQuery) (dfutil.Framer, error) {
+	orgs, err := GetAllOrganizations(ctx, d.client)
+	if err != nil {
+		return nil, err
+	}
+	return Organizations(orgs), nil
+}
+
 // CheckHealth is the health check for GitHub
 func (d *Datasource) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) {
 	_, err := GetAllRepositories(ctx, d.client, models.ListRepositoriesOptions{

pkg/github/organizations.go

@@ -10,15 +10,35 @@ import (
 
 // An Organization is a single GitHub organization
 type Organization struct {
-	Name string
+	Login       string
+	Name        string
+	Description string
+	URL         string `graphql:"url"`
 }
 
 // Organizations is a slice of GitHub Organizations
 type Organizations []Organization
 
 // Frames converts the list of Organizations to a Grafana DataFrame
 func (c Organizations) Frames() data.Frames {
-	return data.Frames{}
+	frame := data.NewFrame(
+		"organizations",
+		data.NewField("login", nil, []string{}),
+		data.NewField("name", nil, []string{}),
+		data.NewField("description", nil, []string{}),
+		data.NewField("url", nil, []string{}),
+	)
+
+	for _, org := range c {
+		frame.AppendRow(
+			org.Login,
+			org.Name,
+			org.Description,
+			org.URL,
+		)
+	}
+
+	return data.Frames{frame}
 }
 
 // QueryListOrganizations is the GraphQL query for listing organizations

pkg/github/organizations_handler.go

@@ -0,0 +1,24 @@
+package github
+
+import (
+	"context"
+
+	"github.com/grafana/github-datasource/pkg/dfutil"
+	"github.com/grafana/github-datasource/pkg/models"
+	"github.com/grafana/grafana-plugin-sdk-go/backend"
+)
+
+func (s *QueryHandler) handleOrganizationsQuery(ctx context.Context, q backend.DataQuery) backend.DataResponse {
+	query := &models.OrganizationsQuery{}
+	if err := UnmarshalQuery(q.JSON, query); err != nil {
+		return *err
+	}
+	return dfutil.FrameResponseWithError(s.Datasource.HandleOrganizationsQuery(ctx, query, q))
+}
+
+// HandleOrganizations handles the plugin query for GitHub Organizations
+func (s *QueryHandler) HandleOrganizations(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
+	return &backend.QueryDataResponse{
+		Responses: processQueries(ctx, req, s.handleOrganizationsQuery),
+	}, nil
+}

pkg/github/query_handler.go

@@ -63,6 +63,7 @@ func GetQueryHandlers(s *QueryHandler) *datasource.QueryTypeMux {
 	mux.HandleFunc(models.QueryTypeWorkflowRuns, s.HandleWorkflowRuns)
 	mux.HandleFunc(models.QueryTypeCodeScanning, s.HandleCodeScanning)
 	mux.HandleFunc(models.QueryTypeDeployments, s.HandleDeployments)
+	mux.HandleFunc(models.QueryTypeOrganizations, s.HandleOrganizations)
 
 	return mux
 }

pkg/models/query.go

@@ -161,3 +161,7 @@ type DeploymentsQuery struct {
 	Query
 	Options ListDeploymentsOptions `json:"options"`
 }
+
+// OrganizationsQuery is used when querying for GitHub organizations
+type OrganizationsQuery struct {
+}

pkg/plugin/datasource.go

@@ -29,6 +29,7 @@ type Datasource interface {
 	HandleWorkflowUsageQuery(context.Context, *models.WorkflowUsageQuery, backend.DataQuery) (dfutil.Framer, error)
 	HandleWorkflowRunsQuery(context.Context, *models.WorkflowRunsQuery, backend.DataQuery) (dfutil.Framer, error)
 	HandleDeploymentsQuery(context.Context, *models.DeploymentsQuery, backend.DataQuery) (dfutil.Framer, error)
+	HandleOrganizationsQuery(context.Context, *models.OrganizationsQuery, backend.DataQuery) (dfutil.Framer, error)
 	CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error)
 	QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error)
 }

pkg/plugin/datasource_caching.go

@@ -272,6 +272,16 @@ func (c *CachedDatasource) HandleDeploymentsQuery(ctx context.Context, q *models
 	return c.saveCache(req, f, err)
 }
 
+// HandleOrganizationsQuery is the cache wrapper for the organizations query handler
+func (c *CachedDatasource) HandleOrganizationsQuery(ctx context.Context, q *models.OrganizationsQuery, req backend.DataQuery) (dfutil.Framer, error) {
+	if value, err := c.getCache(req); err == nil {
+		return value, err
+	}
+
+	f, err := c.datasource.HandleOrganizationsQuery(ctx, q, req)
+	return c.saveCache(req, f, err)
+}
+
 // CheckHealth forwards the request to the datasource and does not perform any caching
 func (c *CachedDatasource) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) {
 	return c.datasource.CheckHealth(ctx, req)

pkg/testutil/client.go

@@ -81,3 +81,8 @@ func (c *TestClient) ListAlertsForOrg(ctx context.Context, owner string, opts *g
 func (c *TestClient) ListDeployments(ctx context.Context, owner, repo string, opts *googlegithub.DeploymentsListOptions) ([]*googlegithub.Deployment, *googlegithub.Response, error) {
 	panic("unimplemented")
 }
+
+// ListAllOrgRepositories is not implemented because it is not being used in tests at the moment.
+func (c *TestClient) ListAllOrgRepositories(ctx context.Context, opts *googlegithub.ListOptions) ([]*googlegithub.Repository, *googlegithub.Response, error) {
+	panic("unimplemented")
+}