feat(bandchart): Add pkger stuff

Author: ebb-tide

pkger/clone_resource.go

@@ -682,6 +682,17 @@ func convertCellView(cell influxdb.Cell) chart {
 				Visible:     fieldOpt.Visible,
 			})
 		}
+	case influxdb.BandViewProperties:
+		setCommon(chartKindBand, p.ViewColors, influxdb.DecimalPlaces{}, p.Queries)
+		setNoteFixes(p.Note, p.ShowNoteWhenEmpty, "", "")
+		setLegend(p.Legend)
+		ch.Axes = convertAxes(p.Axes)
+		ch.Geom = p.Geom
+		ch.HoverDimension = p.HoverDimension
+		ch.XCol = p.XColumn
+		ch.YCol = p.YColumn
+		ch.UpperColumn = p.UpperColumn
+		ch.LowerColumn = p.LowerColumn
 	case influxdb.XYViewProperties:
 		setCommon(chartKindXY, p.ViewColors, influxdb.DecimalPlaces{}, p.Queries)
 		setNoteFixes(p.Note, p.ShowNoteWhenEmpty, "", "")
@@ -726,6 +737,12 @@ func convertChartToResource(ch chart) Resource {
 	if len(ch.YSeriesColumns) > 0 {
 		r[fieldChartYSeriesColumns] = ch.YSeriesColumns
 	}
+	if len(ch.UpperColumn) > 0 {
+		r[fieldChartUpperColumn] = ch.UpperColumn
+	}
+	if len(ch.LowerColumn) > 0 {
+		r[fieldChartLowerColumn] = ch.LowerColumn
+	}
 	if ch.EnforceDecimals {
 		r[fieldChartDecimalPlaces] = ch.DecimalPlaces
 	}

pkger/parser.go

@@ -1421,6 +1421,8 @@ func (p *Template) parseChart(dashMetaName string, chartIdx int, r Resource) (*c
 		YPos:           r.intShort(fieldChartYPos),
 		FillColumns:    r.slcStr(fieldChartFillColumns),
 		YSeriesColumns: r.slcStr(fieldChartYSeriesColumns),
+		UpperColumn:    r.stringShort(fieldChartUpperColumn),
+		LowerColumn:    r.stringShort(fieldChartLowerColumn),
 	}
 
 	if presLeg, ok := r[fieldChartLegend].(legend); ok {

pkger/parser_models.go

@@ -432,14 +432,15 @@ const (
 	chartKindSingleStatPlusLine chartKind = "single_stat_plus_line"
 	chartKindTable              chartKind = "table"
 	chartKindXY                 chartKind = "xy"
+	chartKindBand               chartKind = "band"
 )
 
 func (c chartKind) ok() bool {
 	switch c {
 	case chartKindGauge, chartKindHeatMap, chartKindHistogram,
 		chartKindMarkdown, chartKindMosaic, chartKindScatter,
 		chartKindSingleStat, chartKindSingleStatPlusLine, chartKindTable,
-		chartKindXY:
+		chartKindXY, chartKindBand:
 		return true
 	default:
 		return false
@@ -552,6 +553,8 @@ const (
 	fieldChartTickSuffix     = "tickSuffix"
 	fieldChartTimeFormat     = "timeFormat"
 	fieldChartYSeriesColumns = "ySeriesColumns"
+	fieldChartUpperColumn    = "upperColumn"
+	fieldChartLowerColumn    = "lowerColumn"
 	fieldChartWidth          = "width"
 	fieldChartXCol           = "xCol"
 	fieldChartXPos           = "xPos"
@@ -579,6 +582,8 @@ type chart struct {
 	Geom            string
 	YSeriesColumns  []string
 	XCol, YCol      string
+	UpperColumn     string
+	LowerColumn     string
 	XPos, YPos      int
 	Height, Width   int
 	BinSize         int
@@ -666,6 +671,23 @@ func (c *chart) properties() influxdb.ViewProperties {
 			ShowNoteWhenEmpty: c.NoteOnEmpty,
 			TimeFormat:        c.TimeFormat,
 		}
+	case chartKindBand:
+		return influxdb.BandViewProperties{
+			Type:              influxdb.ViewPropertyTypeBand,
+			Queries:           c.Queries.influxDashQueries(),
+			ViewColors:        c.Colors.influxViewColors(),
+			Legend:            c.Legend.influxLegend(),
+			HoverDimension:    c.HoverDimension,
+			XColumn:           c.XCol,
+			YColumn:           c.YCol,
+			UpperColumn:       c.UpperColumn,
+			LowerColumn:       c.LowerColumn,
+			Axes:              c.Axes.influxAxes(),
+			Geom:              c.Geom,
+			Note:              c.Note,
+			ShowNoteWhenEmpty: c.NoteOnEmpty,
+			TimeFormat:        c.TimeFormat,
+		}
 	case chartKindScatter:
 		return influxdb.ScatterViewProperties{
 			Type:              influxdb.ViewPropertyTypeScatter,

pkger/parser_test.go

@@ -1291,6 +1291,57 @@ spec:
 				})
 			})
 
+			t.Run("band chart", func(t *testing.T) {
+				t.Run("happy path", func(t *testing.T) {
+					testfileRunner(t, "testdata/dashboard_band.yml", func(t *testing.T, template *Template) {
+						sum := template.Summary()
+						require.Len(t, sum.Dashboards, 1)
+
+						actual := sum.Dashboards[0]
+						assert.Equal(t, KindDashboard, actual.Kind)
+						assert.Equal(t, "dash-1", actual.Name)
+						assert.Equal(t, "a dashboard w/ single band chart", actual.Description)
+
+						require.Len(t, actual.Charts, 1)
+						actualChart := actual.Charts[0]
+						assert.Equal(t, 3, actualChart.Height)
+						assert.Equal(t, 6, actualChart.Width)
+						assert.Equal(t, 1, actualChart.XPosition)
+						assert.Equal(t, 2, actualChart.YPosition)
+
+						props, ok := actualChart.Properties.(influxdb.BandViewProperties)
+						require.True(t, ok)
+						assert.Equal(t, "band note", props.Note)
+						assert.True(t, props.ShowNoteWhenEmpty)
+						assert.Equal(t, "y", props.HoverDimension)
+						assert.Equal(t, "foo", props.UpperColumn)
+						assert.Equal(t, "bar", props.LowerColumn)
+
+						require.Len(t, props.ViewColors, 1)
+						c := props.ViewColors[0]
+						assert.Equal(t, "laser", c.Name)
+						assert.Equal(t, "scale", c.Type)
+						assert.Equal(t, "#8F8AF4", c.Hex)
+						assert.Equal(t, 3.0, c.Value)
+
+						require.Len(t, props.Queries, 1)
+						q := props.Queries[0]
+						expectedQuery := `from(bucket: v.bucket)  |> range(start: v.timeRangeStart)  |> filter(fn: (r) => r._measurement == "mem")  |> filter(fn: (r) => r._field == "used_percent")  |> aggregateWindow(every: v.windowPeriod, fn: mean, createEmpty: false)  |> yield(name: "mean")`
+						assert.Equal(t, expectedQuery, q.Text)
+						assert.Equal(t, "advanced", q.EditMode)
+
+						for _, key := range []string{"x", "y"} {
+							xAxis, ok := props.Axes[key]
+							require.True(t, ok, "key="+key)
+							assert.Equal(t, key+"_label", xAxis.Label, "key="+key)
+							assert.Equal(t, key+"_prefix", xAxis.Prefix, "key="+key)
+							assert.Equal(t, key+"_suffix", xAxis.Suffix, "key="+key)
+						}
+
+					})
+				})
+			})
+
 			t.Run("scatter chart", func(t *testing.T) {
 				t.Run("happy path", func(t *testing.T) {
 					testfileRunner(t, "testdata/dashboard_scatter", func(t *testing.T, template *Template) {

pkger/service_test.go

@@ -2224,6 +2224,31 @@ func TestService(t *testing.T) {
 								},
 							},
 						},
+						{
+							name:    "band",
+							newName: "new name",
+							expectedView: influxdb.View{
+								ViewContents: influxdb.ViewContents{
+									Name: "view name",
+								},
+								Properties: influxdb.BandViewProperties{
+									Type:              influxdb.ViewPropertyTypeBand,
+									Axes:              newAxes(),
+									Geom:              "step",
+									Legend:            influxdb.Legend{Type: "type", Orientation: "horizontal"},
+									Note:              "a note",
+									Queries:           []influxdb.DashboardQuery{newQuery()},
+									HoverDimension:    "y",
+									ShowNoteWhenEmpty: true,
+									ViewColors:        []influxdb.ViewColor{{Type: "text", Hex: "red"}},
+									XColumn:           "x",
+									YColumn:           "y",
+									UpperColumn:       "upper",
+									LowerColumn:       "lower",
+									TimeFormat:        "",
+								},
+							},
+						},
 						{
 							name:    "markdown",
 							newName: "new name",

pkger/testdata/dashboard_band.yml

@@ -0,0 +1,46 @@
+apiVersion: influxdata.com/v2alpha1
+kind: Dashboard
+metadata:
+  name: dash-1
+spec:
+  description: a dashboard w/ single band chart
+  charts:
+    - kind: Band
+      name: band chart
+      note: band note
+      noteOnEmpty: true
+      prefix: sumtin
+      suffix: days
+      xPos: 1
+      yPos: 2
+      xCol: _time
+      yCol: _value
+      upperColumn: foo
+      lowerColumn: bar
+      hoverDimension: "y"
+      geom: line
+      width: 6
+      height: 3
+      queries:
+        - query: >
+            from(bucket: v.bucket)  |> range(start: v.timeRangeStart)  |> filter(fn: (r) => r._measurement == "mem")  |> filter(fn: (r) => r._field == "used_percent")  |> aggregateWindow(every: v.windowPeriod, fn: mean, createEmpty: false)  |> yield(name: "mean")
+      colors:
+        - name: laser
+          type: scale
+          hex: "#8F8AF4"
+          value: 3
+      axes:
+        - name: "x"
+          label: x_label
+          prefix: x_prefix
+          suffix: x_suffix
+          domain:
+            - 0
+            - 10
+        - name: "y"
+          label: y_label
+          prefix: y_prefix
+          suffix: y_suffix
+          domain:
+            - 0
+            - 100