Report: Add last_day_of_month option (#686)

Closes #625

Also, I converted all values used in the report code to constants

Author: julienduchesne

docs/resources/report.md

@@ -51,9 +51,9 @@ resource "grafana_report" "test" {
 
 - `include_dashboard_link` (Boolean) Whether to include a link to the dashboard in the report. Defaults to `true`.
 - `include_table_csv` (Boolean) Whether to include a CSV file of table panel data. Defaults to `false`.
-- `layout` (String) Layout of the report. `simple` or `grid` Defaults to `grid`.
+- `layout` (String) Layout of the report. Allowed values: `simple`, `grid`. Defaults to `grid`.
 - `message` (String) Message to be sent in the report.
-- `orientation` (String) Orientation of the report. `landscape` or `portrait` Defaults to `landscape`.
+- `orientation` (String) Orientation of the report. Allowed values: `landscape`, `portrait`. Defaults to `landscape`.
 - `reply_to` (String) Reply-to email address of the report.
 - `time_range` (Block List, Max: 1) Time range of the report. (see [below for nested schema](#nestedblock--time_range))
 
@@ -66,13 +66,14 @@ resource "grafana_report" "test" {
 
 Required:
 
-- `frequency` (String) Frequency of the report. One of `never`, `once`, `hourly`, `daily`, `weekly`, `monthly` or `custom`.
+- `frequency` (String) Frequency of the report. Allowed values: `never`, `once`, `hourly`, `daily`, `weekly`, `monthly`, `custom`.
 
 Optional:
 
 - `custom_interval` (String) Custom interval of the report.
 **Note:** This field is only available when frequency is set to `custom`.
 - `end_time` (String) End time of the report. If empty, the report will be sent indefinitely (according to frequency). Note that times will be saved as UTC in Grafana.
+- `last_day_of_month` (Boolean) Send the report on the last day of the month Defaults to `false`.
 - `start_time` (String) Start time of the report. If empty, the start date will be set to the creation time. Note that times will be saved as UTC in Grafana.
 - `workdays_only` (Boolean) Whether to send the report only on work days. Defaults to `false`.
 

examples/resources/grafana_report/monthly.tf

@@ -0,0 +1,19 @@
+resource "grafana_dashboard" "test" {
+  config_json = <<EOD
+{
+  "title": "Dashboard for report",
+  "uid": "report"
+}
+EOD
+  message     = "inital commit."
+}
+
+resource "grafana_report" "test" {
+  name         = "my report"
+  dashboard_id = grafana_dashboard.test.dashboard_id
+  recipients   = ["[email protected]"]
+  schedule {
+    frequency         = "monthly"
+    last_day_of_month = true
+  }
+}

go.mod

@@ -5,7 +5,7 @@ go 1.18
 require (
 	github.com/Masterminds/semver/v3 v3.1.1
 	github.com/grafana/amixr-api-go-client v0.0.5
-	github.com/grafana/grafana-api-golang-client v0.12.0
+	github.com/grafana/grafana-api-golang-client v0.12.1
 	github.com/grafana/machine-learning-go-client v0.1.1
 	github.com/grafana/synthetic-monitoring-agent v0.9.4
 	github.com/grafana/synthetic-monitoring-api-go-client v0.6.3

go.sum

@@ -115,8 +115,8 @@ github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/grafana/amixr-api-go-client v0.0.5 h1:jqmljnd5FozuOsCNuyhZVpooxmj0BW9MmeLA7PaLK6U=
 github.com/grafana/amixr-api-go-client v0.0.5/go.mod h1:N6x26XUrM5zGtK5zL5vNJnAn2JFMxLFPPLTw/6pDkFE=
-github.com/grafana/grafana-api-golang-client v0.12.0 h1:EqoBKAeDeWQdb9PXrTc7vvVMzJTLTFYR+MbbEJhua+o=
-github.com/grafana/grafana-api-golang-client v0.12.0/go.mod h1:24W29gPe9yl0/3A9X624TPkAOR8DpHno490cPwnkv8E=
+github.com/grafana/grafana-api-golang-client v0.12.1 h1:GLkNXslTWf/ZBxjRHK6VYW6FSqFnhaiA47pTZe9GUBw=
+github.com/grafana/grafana-api-golang-client v0.12.1/go.mod h1:24W29gPe9yl0/3A9X624TPkAOR8DpHno490cPwnkv8E=
 github.com/grafana/machine-learning-go-client v0.1.1 h1:Gw6cX8xAd6IVF2LApkXOIdBK8Gzz07B3jQPukecw7fc=
 github.com/grafana/machine-learning-go-client v0.1.1/go.mod h1:QFfZz8NkqVF8++skjkKQXJEZfpCYd8S0yTWJUpsLLTA=
 github.com/grafana/synthetic-monitoring-agent v0.9.4 h1:Enx5s6gFbc/RAzL5KDX/00catAlbcY7/1IFPBe5lo/c=

grafana/resource_report.go

@@ -18,6 +18,28 @@ import (
 	gapi "github.com/grafana/grafana-api-golang-client"
 )
 
+const (
+	reportFrequencyHourly  = "hourly"
+	reportFrequencyDaily   = "daily"
+	reportFrequencyWeekly  = "weekly"
+	reportFrequencyMonthly = "monthly"
+	reportFrequencyCustom  = "custom"
+	reportFrequencyOnce    = "once"
+	reportFrequencyNever   = "never"
+
+	reportOrientationPortrait  = "portrait"
+	reportOrientationLandscape = "landscape"
+
+	reportLayoutGrid   = "grid"
+	reportLayoutSimple = "simple"
+)
+
+var (
+	reportLayouts      = []string{reportLayoutSimple, reportLayoutGrid}
+	reportOrientations = []string{reportOrientationLandscape, reportOrientationPortrait}
+	reportFrequencies  = []string{reportFrequencyNever, reportFrequencyOnce, reportFrequencyHourly, reportFrequencyDaily, reportFrequencyWeekly, reportFrequencyMonthly, reportFrequencyCustom}
+)
+
 func ResourceReport() *schema.Resource {
 	return &schema.Resource{
 		Description: `
@@ -85,16 +107,16 @@ func ResourceReport() *schema.Resource {
 			"layout": {
 				Type:         schema.TypeString,
 				Optional:     true,
-				Description:  "Layout of the report. `simple` or `grid`",
-				Default:      "grid",
-				ValidateFunc: validation.StringInSlice([]string{"simple", "grid"}, false),
+				Description:  allowedValuesDescription("Layout of the report", reportLayouts),
+				Default:      reportLayoutGrid,
+				ValidateFunc: validation.StringInSlice(reportLayouts, false),
 			},
 			"orientation": {
 				Type:         schema.TypeString,
 				Optional:     true,
-				Description:  "Orientation of the report. `landscape` or `portrait`",
-				Default:      "landscape",
-				ValidateFunc: validation.StringInSlice([]string{"landscape", "portrait"}, false),
+				Description:  allowedValuesDescription("Orientation of the report", reportOrientations),
+				Default:      reportOrientationLandscape,
+				ValidateFunc: validation.StringInSlice(reportOrientations, false),
 			},
 			"time_range": {
 				Type:        schema.TypeList,
@@ -129,8 +151,8 @@ func ResourceReport() *schema.Resource {
 						"frequency": {
 							Type:         schema.TypeString,
 							Required:     true,
-							Description:  "Frequency of the report. One of `never`, `once`, `hourly`, `daily`, `weekly`, `monthly` or `custom`.",
-							ValidateFunc: validation.StringInSlice([]string{"never", "once", "hourly", "daily", "weekly", "monthly", "custom"}, false),
+							Description:  allowedValuesDescription("Frequency of the report", reportFrequencies),
+							ValidateFunc: validation.StringInSlice(reportFrequencies, false),
 						},
 						"start_time": {
 							Type:         schema.TypeString,
@@ -179,6 +201,12 @@ func ResourceReport() *schema.Resource {
 								return diag.FromErr(err)
 							},
 						},
+						"last_day_of_month": {
+							Type:        schema.TypeBool,
+							Optional:    true,
+							Description: "Send the report on the last day of the month",
+							Default:     false,
+						},
 					},
 				},
 			},
@@ -253,6 +281,9 @@ func ReadReport(ctx context.Context, d *schema.ResourceData, meta interface{}) d
 	if r.Schedule.EndDate != nil {
 		schedule["end_time"] = r.Schedule.EndDate.Format(time.RFC3339)
 	}
+	if r.Schedule.DayOfMonth == "last" {
+		schedule["last_day_of_month"] = true
+	}
 
 	d.Set("schedule", []interface{}{schedule})
 
@@ -320,7 +351,7 @@ func schemaToReport(d *schema.ResourceData) (gapi.Report, error) {
 	}
 
 	// Set schedule start time
-	if frequency != "never" {
+	if frequency != reportFrequencyNever {
 		if startTimeStr := d.Get("schedule.0.start_time").(string); startTimeStr != "" {
 			startDate, err := time.Parse(time.RFC3339, startTimeStr)
 			if err != nil {
@@ -332,7 +363,7 @@ func schemaToReport(d *schema.ResourceData) (gapi.Report, error) {
 	}
 
 	// Set schedule end time
-	if frequency != "once" && frequency != "never" {
+	if frequency != reportFrequencyOnce && frequency != reportFrequencyNever {
 		if endTimeStr := d.Get("schedule.0.end_time").(string); endTimeStr != "" {
 			endDate, err := time.Parse(time.RFC3339, endTimeStr)
 			if err != nil {
@@ -343,10 +374,16 @@ func schemaToReport(d *schema.ResourceData) (gapi.Report, error) {
 		}
 	}
 
+	if frequency == reportFrequencyMonthly {
+		if lastDayOfMonth := d.Get("schedule.0.last_day_of_month").(bool); lastDayOfMonth {
+			report.Schedule.DayOfMonth = "last"
+		}
+	}
+
 	if reportWorkdaysOnlyConfigAllowed(frequency) {
 		report.Schedule.WorkdaysOnly = d.Get("schedule.0.workdays_only").(bool)
 	}
-	if frequency == "custom" {
+	if frequency == reportFrequencyCustom {
 		customInterval := d.Get("schedule.0.custom_interval").(string)
 		amount, unit, err := parseCustomReportInterval(customInterval)
 		if err != nil {
@@ -360,7 +397,7 @@ func schemaToReport(d *schema.ResourceData) (gapi.Report, error) {
 }
 
 func reportWorkdaysOnlyConfigAllowed(frequency string) bool {
-	return frequency == "hourly" || frequency == "daily" || frequency == "custom"
+	return frequency == reportFrequencyHourly || frequency == reportFrequencyDaily || frequency == reportFrequencyCustom
 }
 
 func parseCustomReportInterval(i interface{}) (int, string, error) {

grafana/resource_report_test.go

@@ -65,6 +65,27 @@ func TestAccResourceReport(t *testing.T) {
 					resource.TestCheckResourceAttr("grafana_report.test", "time_range.0.to", "now"),
 				),
 			},
+			{
+				Config: testAccExample(t, "resources/grafana_report/monthly.tf"),
+				Check: resource.ComposeTestCheckFunc(
+					testAccReportCheckExists("grafana_report.test", &report),
+					resource.TestCheckResourceAttrSet("grafana_report.test", "id"),
+					resource.TestCheckResourceAttrSet("grafana_report.test", "dashboard_id"),
+					resource.TestCheckResourceAttr("grafana_report.test", "name", "my report"),
+					resource.TestCheckResourceAttr("grafana_report.test", "recipients.0", "[email protected]"),
+					resource.TestCheckNoResourceAttr("grafana_report.test", "recipients.1"),
+					resource.TestCheckResourceAttr("grafana_report.test", "schedule.0.frequency", "monthly"),
+					resource.TestCheckResourceAttrSet("grafana_report.test", "schedule.0.start_time"), // Date set to current time
+					resource.TestCheckResourceAttr("grafana_report.test", "schedule.0.end_time", ""),  // No end time
+					resource.TestCheckResourceAttr("grafana_report.test", "schedule.0.last_day_of_month", "true"),
+					resource.TestCheckResourceAttr("grafana_report.test", "orientation", "landscape"),
+					resource.TestCheckResourceAttr("grafana_report.test", "layout", "grid"),
+					resource.TestCheckResourceAttr("grafana_report.test", "include_dashboard_link", "true"),
+					resource.TestCheckResourceAttr("grafana_report.test", "include_table_csv", "false"),
+					resource.TestCheckNoResourceAttr("grafana_report.test", "time_range.0.from"),
+					resource.TestCheckNoResourceAttr("grafana_report.test", "time_range.0.to"),
+				),
+			},
 		},
 	})
 }

grafana/schema.go

@@ -1,7 +1,9 @@
 package grafana
 
 import (
+	"fmt"
 	"strconv"
+	"strings"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
@@ -43,3 +45,7 @@ func cloneResourceSchemaForDatasource(r *schema.Resource, updates map[string]*sc
 	}
 	return clone
 }
+
+func allowedValuesDescription(description string, allowedValues []string) string {
+	return fmt.Sprintf("%s. Allowed values: `%s`.", description, strings.Join(allowedValues, "`, `"))
+}