feat(pkger): add check dry functionality

CHANGELOG.md

@@ -5,6 +5,7 @@
 1. [16234](https://github.com/influxdata/influxdb/pull/16234): add support for notification endpoints to influx templates/pkgs.
 2. [16242](https://github.com/influxdata/influxdb/pull/16242): drop id prefix for secret key requirement for notification endpoints 
 3. [16259](https://github.com/influxdata/influxdb/pull/16259): add support for check resource to pkger parser 
+4. [16262](https://github.com/influxdata/influxdb/pull/16262): add support for check resource dry run functionality 
 
 ### Bug Fixes
 

authz.go

@@ -266,15 +266,15 @@ func (p *Permission) Valid() error {
 		}
 	}
 
-	if p.Resource.OrgID != nil && !(*p.Resource.OrgID).Valid() {
+	if p.Resource.OrgID != nil && !p.Resource.OrgID.Valid() {
 		return &Error{
 			Code: EInvalid,
 			Err:  ErrInvalidID,
 			Msg:  "invalid org id for permission",
 		}
 	}
 
-	if p.Resource.ID != nil && !(*p.Resource.ID).Valid() {
+	if p.Resource.ID != nil && !p.Resource.ID.Valid() {
 		return &Error{
 			Code: EInvalid,
 			Err:  ErrInvalidID,

cmd/influx/pkg.go

@@ -597,6 +597,23 @@ func (b *cmdPkgBuilder) printPkgDiff(diff pkger.Diff) {
 		})
 	}
 
+	if checks := diff.Checks; len(checks) > 0 {
+		headers := []string{"New", "ID", "Name", "Description"}
+		tablePrintFn("CHECKS", headers, len(checks), func(i int) []string {
+			c := checks[i]
+			var oldDesc string
+			if c.Old != nil {
+				oldDesc = c.Old.GetDescription()
+			}
+			return []string{
+				boolDiff(c.IsNew()),
+				c.ID.String(),
+				c.Name,
+				diffLn(c.IsNew(), oldDesc, c.New.GetDescription()),
+			}
+		})
+	}
+
 	if dashes := diff.Dashboards; len(dashes) > 0 {
 		headers := []string{"New", "Name", "Description", "Num Charts"}
 		tablePrintFn("DASHBOARDS", headers, len(dashes), func(i int) []string {

cmd/influxd/launcher/launcher.go

@@ -836,12 +836,15 @@ func (m *Launcher) run(ctx context.Context) (err error) {
 	var pkgSVC pkger.SVC
 	{
 		b := m.apibackend
+		authedOrgSVC := authorizer.NewOrgService(b.OrganizationService)
+		authedURMSVC := authorizer.NewURMService(b.OrgLookupService, b.UserResourceMappingService)
 		pkgSVC = pkger.NewService(
 			pkger.WithLogger(m.log.With(zap.String("service", "pkger"))),
 			pkger.WithBucketSVC(authorizer.NewBucketService(b.BucketService)),
+			pkger.WithCheckSVC(authorizer.NewCheckService(b.CheckService, authedURMSVC, authedOrgSVC)),
 			pkger.WithDashboardSVC(authorizer.NewDashboardService(b.DashboardService)),
 			pkger.WithLabelSVC(authorizer.NewLabelService(b.LabelService)),
-			pkger.WithNoticationEndpointSVC(authorizer.NewNotificationEndpointService(b.NotificationEndpointService, b.UserResourceMappingService, b.OrganizationService)),
+			pkger.WithNoticationEndpointSVC(authorizer.NewNotificationEndpointService(b.NotificationEndpointService, authedURMSVC, authedOrgSVC)),
 			pkger.WithSecretSVC(authorizer.NewSecretService(b.SecretService)),
 			pkger.WithTelegrafSVC(authorizer.NewTelegrafConfigService(b.TelegrafService, b.UserResourceMappingService)),
 			pkger.WithVariableSVC(authorizer.NewVariableService(b.VariableService)),

cmd/influxd/launcher/launcher_helpers.go

@@ -335,6 +335,10 @@ func (tl *TestLauncher) BucketService(tb testing.TB) *http.BucketService {
 	return &http.BucketService{Client: tl.HTTPClient(tb), OpPrefix: kv.OpPrefix}
 }
 
+func (tl *TestLauncher) CheckService() platform.CheckService {
+	return tl.kvService
+}
+
 func (tl *TestLauncher) DashboardService(tb testing.TB) *http.DashboardService {
 	tb.Helper()
 	return &http.DashboardService{Client: tl.HTTPClient(tb)}

cmd/influxd/launcher/pkger_test.go

@@ -41,6 +41,7 @@ func TestLauncher_Pkger(t *testing.T) {
 		svc := pkger.NewService(
 			pkger.WithBucketSVC(l.BucketService(t)),
 			pkger.WithDashboardSVC(l.DashboardService(t)),
+			pkger.WithCheckSVC(l.CheckService()),
 			pkger.WithLabelSVC(&fakeLabelSVC{
 				LabelService: l.LabelService(t),
 				killCount:    2, // hits error on 3rd attempt at creating a mapping
@@ -92,9 +93,6 @@ func TestLauncher_Pkger(t *testing.T) {
 
 	hasLabelAssociations := func(t *testing.T, associations []pkger.SummaryLabel, numAss int, expectedNames ...string) {
 		t.Helper()
-
-		require.Len(t, associations, numAss)
-
 		hasAss := func(t *testing.T, expected string) {
 			t.Helper()
 			for _, ass := range associations {
@@ -105,6 +103,7 @@ func TestLauncher_Pkger(t *testing.T) {
 			require.FailNow(t, "did not find expected association: "+expected)
 		}
 
+		require.Len(t, associations, numAss)
 		for _, expected := range expectedNames {
 			hasAss(t, expected)
 		}
@@ -137,6 +136,11 @@ func TestLauncher_Pkger(t *testing.T) {
 		require.Len(t, diffVars, 1)
 		assert.True(t, diffVars[0].IsNew())
 
+		require.Len(t, diff.Checks, 2)
+		for _, ch := range diff.Checks {
+			assert.True(t, ch.IsNew())
+		}
+
 		require.Len(t, diff.Dashboards, 1)
 		require.Len(t, diff.NotificationEndpoints, 1)
 		require.Len(t, diff.Telegrafs, 1)
@@ -150,6 +154,13 @@ func TestLauncher_Pkger(t *testing.T) {
 		assert.Equal(t, "rucket_1", bkts[0].Name)
 		hasLabelAssociations(t, bkts[0].LabelAssociations, 1, "label_1")
 
+		checks := sum.Checks
+		require.Len(t, checks, 2)
+		for i, ch := range checks {
+			assert.Equal(t, fmt.Sprintf("check_%d", i), ch.Check.GetName())
+			hasLabelAssociations(t, ch.LabelAssociations, 1, "label_1")
+		}
+
 		dashs := sum.Dashboards
 		require.Len(t, dashs, 1)
 		assert.Equal(t, "dash_1", dashs[0].Name)
@@ -246,7 +257,7 @@ func TestLauncher_Pkger(t *testing.T) {
 		}
 
 		mappings := sum1.LabelMappings
-		require.Len(t, mappings, 5)
+		require.Len(t, mappings, 7)
 		hasMapping(t, mappings, newSumMapping(bkts[0].ID, bkts[0].Name, influxdb.BucketsResourceType))
 		hasMapping(t, mappings, newSumMapping(dashs[0].ID, dashs[0].Name, influxdb.DashboardsResourceType))
 		hasMapping(t, mappings, newSumMapping(vars[0].ID, vars[0].Name, influxdb.VariablesResourceType))
@@ -549,6 +560,48 @@ spec:
       associations:
         - kind: Label
           name: label_1
+    - kind: Check_Threshold
+      name: check_0
+      every: 1m
+      query:  >
+        from(bucket: "rucket_1")
+          |> range(start: v.timeRangeStart, stop: v.timeRangeStop)
+          |> filter(fn: (r) => r._measurement == "cpu")
+          |> filter(fn: (r) => r._field == "usage_idle")
+          |> aggregateWindow(every: 1m, fn: mean)
+          |> yield(name: "mean")
+      statusMessageTemplate: "Check: ${ r._check_name } is: ${ r._level }"
+      tags:
+        - key: tag_1
+          value: val_1
+      thresholds:
+        - type: inside_range
+          level: INfO
+          min: 30.0
+          max: 45.0
+      associations:
+        - kind: Label
+          name: label_1
+    - kind: Check_Deadman
+      name: check_1
+      description: desc_1
+      every: 5m
+      level: cRiT
+      offset: 10s
+      query:  >
+        from(bucket: "rucket_1")
+          |> range(start: v.timeRangeStart, stop: v.timeRangeStop)
+          |> filter(fn: (r) => r._measurement == "cpu")
+          |> filter(fn: (r) => r._field == "usage_idle")
+          |> aggregateWindow(every: 1m, fn: mean)
+          |> yield(name: "mean")
+      reportZero: true
+      staleTime: 10m
+      statusMessageTemplate: "Check: ${ r._check_name } is: ${ r._level }"
+      timeSince: 90s
+      associations:
+        - kind: Label
+          name: label_1
 `
 
 const updatePkgYMLStr = `apiVersion: 0.1.0

http/middleware.go

@@ -9,12 +9,22 @@ import (
 	"strings"
 	"time"
 
+	"github.com/influxdata/influxdb/kit/tracing"
 	"go.uber.org/zap"
 )
 
 // Middleware constructor.
 type Middleware func(http.Handler) http.Handler
 
+func traceMW(next http.Handler) http.Handler {
+	fn := func(w http.ResponseWriter, r *http.Request) {
+		span, ctx := tracing.StartSpanFromContext(r.Context())
+		defer span.Finish()
+		next.ServeHTTP(w, r.WithContext(ctx))
+	}
+	return http.HandlerFunc(fn)
+}
+
 func skipOptionsMW(next http.Handler) http.Handler {
 	fn := func(w http.ResponseWriter, r *http.Request) {
 		if r.Method == "OPTIONS" {

http/pkger_http_server.go

@@ -11,7 +11,6 @@ import (
 	"github.com/go-chi/chi/middleware"
 	"github.com/influxdata/influxdb"
 	pctx "github.com/influxdata/influxdb/context"
-	"github.com/influxdata/influxdb/kit/tracing"
 	"github.com/influxdata/influxdb/pkg/httpc"
 	"github.com/influxdata/influxdb/pkger"
 	"go.uber.org/zap"
@@ -334,12 +333,3 @@ func newDecodeErr(encoding string, err error) *influxdb.Error {
 		Err:  err,
 	}
 }
-
-func traceMW(next http.Handler) http.Handler {
-	fn := func(w http.ResponseWriter, r *http.Request) {
-		span, ctx := tracing.StartSpanFromContext(r.Context())
-		defer span.Finish()
-		next.ServeHTTP(w, r.WithContext(ctx))
-	}
-	return http.HandlerFunc(fn)
-}

http/swagger.yml

@@ -7209,6 +7209,17 @@ components:
                         type: array
                         items:
                           $ref: "#/components/schemas/PkgSummaryLabel"
+            checks:
+              type: array
+              items:
+                allOf:
+                  - $ref: "#/components/schemas/CheckDiscriminator"
+                  - type: object
+                    properties:
+                      labelAssociations:
+                        type: array
+                        items:
+                          $ref: "#/components/schemas/Label"
             labels:
               type: array
               items:
@@ -7316,6 +7327,19 @@ components:
                         type: string
                       retentionRules:
                         $ref: "#/components/schemas/RetentionRules"
+            checks:
+              type: array
+              items:
+                type: object
+                properties:
+                  id:
+                    type: string
+                  name:
+                    type: string
+                  new:
+                    $ref: "#/components/schemas/CheckDiscriminator"
+                  old:
+                    $ref: "#/components/schemas/CheckDiscriminator"
             dashboards:
               type: array
               items:

pkger/models.go

@@ -147,6 +147,7 @@ type Metadata struct {
 // what is new and or updated from the current state of the platform.
 type Diff struct {
 	Buckets               []DiffBucket               `json:"buckets"`
+	Checks                []DiffCheck                `json:"checks"`
 	Dashboards            []DiffDashboard            `json:"dashboards"`
 	Labels                []DiffLabel                `json:"labels"`
 	LabelMappings         []DiffLabelMapping         `json:"labelMappings"`
@@ -222,6 +223,46 @@ func (d DiffBucket) hasConflict() bool {
 	return !d.IsNew() && d.Old != nil && !reflect.DeepEqual(*d.Old, d.New)
 }
 
+// DiffCheckValues are the varying values for a check.
+type DiffCheckValues struct {
+	influxdb.Check
+}
+
+// UnmarshalJSON decodes the check values.
+func (d *DiffCheckValues) UnmarshalJSON(b []byte) (err error) {
+	d.Check, err = icheck.UnmarshalJSON(b)
+	return
+}
+
+// DiffCheck is a diff of an individual check.
+type DiffCheck struct {
+	ID   SafeID           `json:"id"`
+	Name string           `json:"name"`
+	New  DiffCheckValues  `json:"new"`
+	Old  *DiffCheckValues `json:"old"`
+}
+
+func newDiffCheck(c *check, iCheck influxdb.Check) DiffCheck {
+	diff := DiffCheck{
+		Name: c.Name(),
+		New: DiffCheckValues{
+			Check: c.summarize().Check,
+		},
+	}
+	if iCheck != nil {
+		diff.ID = SafeID(iCheck.GetID())
+		diff.Old = &DiffCheckValues{
+			Check: iCheck,
+		}
+	}
+	return diff
+}
+
+// IsNew determines if the check in the pkg is new to the platform.
+func (d DiffCheck) IsNew() bool {
+	return d.Old == nil
+}
+
 // DiffDashboard is a diff of an individual dashboard.
 type DiffDashboard struct {
 	Name   string      `json:"name"`
@@ -311,21 +352,17 @@ type DiffNotificationEndpointValues struct {
 }
 
 // UnmarshalJSON decodes the notification endpoint. This is necessary unfortunately.
-func (d *DiffNotificationEndpointValues) UnmarshalJSON(b []byte) error {
-	e, err := endpoint.UnmarshalJSON(b)
-	if err != nil {
-		fmt.Println("broken here")
-	}
-	d.NotificationEndpoint = e
-	return err
+func (d *DiffNotificationEndpointValues) UnmarshalJSON(b []byte) (err error) {
+	d.NotificationEndpoint, err = endpoint.UnmarshalJSON(b)
+	return
 }
 
 // DiffNotificationEndpoint is a diff of an individual notification endpoint.
 type DiffNotificationEndpoint struct {
 	ID   SafeID                          `json:"id"`
 	Name string                          `json:"name"`
 	New  DiffNotificationEndpointValues  `json:"new"`
-	Old  *DiffNotificationEndpointValues `json:"old,omitempty"` // using omitempty here to signal there was no prev state with a nil
+	Old  *DiffNotificationEndpointValues `json:"old"`
 }
 
 func newDiffNotificationEndpoint(ne *notificationEndpoint, i influxdb.NotificationEndpoint) DiffNotificationEndpoint {
@@ -434,6 +471,23 @@ type SummaryCheck struct {
 	LabelAssociations []SummaryLabel  `json:"labelAssociations"`
 }
 
+func (s *SummaryCheck) UnmarshalJSON(b []byte) error {
+	var out struct {
+		Status            string          `json:"status"`
+		LabelAssociations []SummaryLabel  `json:"labelAssociations"`
+		Check             json.RawMessage `json:"check"`
+	}
+	if err := json.Unmarshal(b, &out); err != nil {
+		return err
+	}
+	s.Status = influxdb.Status(out.Status)
+	s.LabelAssociations = out.LabelAssociations
+
+	var err error
+	s.Check, err = icheck.UnmarshalJSON(out.Check)
+	return err
+}
+
 // SummaryDashboard provides a summary of a pkg dashboard.
 type SummaryDashboard struct {
 	ID          SafeID         `json:"id"`
@@ -779,6 +833,8 @@ type check struct {
 	thresholds    []threshold
 
 	labels sortedLabels
+
+	existing influxdb.Check
 }
 
 func (c *check) Name() string {