feat(dashboards): Added a new field called excluded in dashboard variables' (Testing PR)

pkg/dashboards/dashboard.go

@@ -100,6 +100,7 @@ const getDashboardEntityQuery = `query ($guid: EntityGuid!) {
           }
           name
 		  options {
+			excluded
 			ignoreTimeRange
 		  }
           nrqlQuery {

pkg/dashboards/dashboards_api_integration_test.go

@@ -276,6 +276,8 @@ func TestIntegrationDashboard_Variables(t *testing.T) {
 
 	// Test vars
 	dashboardName := "newrelic-client-go test-dashboard-" + mock.RandSeq(5)
+	ignoreTimeRangeValue := true
+	excludedValue := true
 	dashboardInput := DashboardInput{
 		Description: "Test description",
 		Name:        dashboardName,
@@ -314,7 +316,8 @@ func TestIntegrationDashboard_Variables(t *testing.T) {
 				},
 				Name: "variable",
 				Options: &DashboardVariableOptionsInput{
-					IgnoreTimeRange: true,
+					IgnoreTimeRange: &ignoreTimeRangeValue,
+					Excluded:        &excludedValue,
 				},
 				NRQLQuery: &DashboardVariableNRQLQueryInput{
 					AccountIDs: []int{testAccountID},
@@ -347,10 +350,12 @@ func TestIntegrationDashboard_Variables(t *testing.T) {
 	assert.Equal(t, dashboardInput.Name, dash.Name)
 	assert.Equal(t, entities.DashboardEntityPermissions(string(dashboardInput.Permissions)), dash.Permissions)
 
-	if dash.Variables[0].Options.IgnoreTimeRange != dashboardInput.Variables[0].Options.IgnoreTimeRange {
-		t.Errorf("Expected value to be %v but got %v\n", dashboardInput.Variables[0].Options.IgnoreTimeRange, dash.Variables[0].Options.IgnoreTimeRange)
+	if dash.Variables[0].Options.IgnoreTimeRange != *dashboardInput.Variables[0].Options.IgnoreTimeRange {
+		t.Errorf("Expected value to be %v but got %v\n", *dashboardInput.Variables[0].Options.IgnoreTimeRange, dash.Variables[0].Options.IgnoreTimeRange)
+	}
+	if dash.Variables[0].Options.Excluded != *dashboardInput.Variables[0].Options.Excluded {
+		t.Errorf("Expected value to be %v but got %v\n", *dashboardInput.Variables[0].Options.Excluded, dash.Variables[0].Options.Excluded)
 	}
-
 	// Input and Pages are different types so we can not easily compare them...
 	assert.Equal(t, len(dashboardInput.Pages), len(dash.Pages))
 	require.Equal(t, 1, len(dash.Pages))
@@ -362,6 +367,8 @@ func TestIntegrationDashboard_Variables(t *testing.T) {
 	assert.Greater(t, len(dash.Pages[0].Widgets[0].RawConfiguration), 1)
 
 	// Test: DashboardUpdate
+	ignoreTimeRangeValue = false
+	excludedValue = false
 	updatedDashboard := DashboardInput{
 		Name:        dash.Name,
 		Permissions: result.EntityResult.Permissions,
@@ -396,7 +403,8 @@ func TestIntegrationDashboard_Variables(t *testing.T) {
 				},
 				Name: "variableUpdated",
 				Options: &DashboardVariableOptionsInput{
-					IgnoreTimeRange: true,
+					IgnoreTimeRange: &ignoreTimeRangeValue,
+					Excluded:        &excludedValue,
 				},
 				NRQLQuery: &DashboardVariableNRQLQueryInput{
 					AccountIDs: []int{testAccountID},

pkg/dashboards/types.go

@@ -507,14 +507,18 @@ type DashboardVariableNRQLQueryInput struct {
 
 // DashboardVariableOptions - Options applied to the variable.
 type DashboardVariableOptions struct {
+	// With this turned on, query condition defined with the variable will not be included in the query.
+	Excluded bool `json:"excluded,omitempty"`
 	// Only applies to variables of type NRQL. With this turned on, the time range for the NRQL query will override the time picker on dashboards and other pages. Turn this off to use the time picker as normal.
 	IgnoreTimeRange bool `json:"ignoreTimeRange,omitempty"`
 }
 
 // DashboardVariableOptionsInput - Options applied to the variable
 type DashboardVariableOptionsInput struct {
+	// With this turned on, query condition defined with the variable will not be included in the query.
+	Excluded *bool `json:"excluded,omitempty"`
 	// Only applies to variables of type NRQL. With this turned on, the time range for the NRQL query will override the time picker on dashboards and other pages. Turn this off to use the time picker as normal.
-	IgnoreTimeRange bool `json:"ignoreTimeRange"`
+	IgnoreTimeRange *bool `json:"ignoreTimeRange,omitempty"`
 }
 
 // DashboardWidgetConfigurationInput - Typed configuration for known visualizations. At most one may be populated.

pkg/entities/types.go

@@ -28,7 +28,7 @@
 	USER: "USER",
 }
 
 // AgentApplicationSettingsBrowserLoader - Determines which browser loader will be configured. Some allowed return values are specified for backwards-compatability and do not represent currently allowed values for new applications.
 // See [documentation](https://docs.newrelic.com/docs/browser/browser-monitoring/installation/install-browser-monitoring-agent/#agent-types) for further information.
 type AgentApplicationSettingsBrowserLoader string
 
@@ -45,7 +45,7 @@
 	RUM AgentApplicationSettingsBrowserLoader
 	// Pro+SPA: This is the default installed agent when you enable browser monitoring. Gives you access to all of the Browser Pro features and to Single Page App (SPA) monitoring. Provides detailed page timing data and the most up-to-date New Relic features, including distributed tracing, for all types of applications.
 	SPA AgentApplicationSettingsBrowserLoader
 	// This value is specified for backwards-compatability.
 	XHR AgentApplicationSettingsBrowserLoader
 }{
 	// Use PRO instead
@@ -60,7 +60,7 @@
 	RUM: "RUM",
 	// Pro+SPA: This is the default installed agent when you enable browser monitoring. Gives you access to all of the Browser Pro features and to Single Page App (SPA) monitoring. Provides detailed page timing data and the most up-to-date New Relic features, including distributed tracing, for all types of applications.
 	SPA: "SPA",
 	// This value is specified for backwards-compatability.
 	XHR: "XHR",
 }
 
@@ -5312,6 +5312,8 @@
 
 // DashboardVariableOptions - Options applied to the variable.
 type DashboardVariableOptions struct {
+	// With this turned on, query condition defined with the variable will not be included in the query.
+	Excluded bool `json:"excluded,omitempty"`
 	// Only applies to variables of type NRQL. With this turned on, the time range for the NRQL query will override the time picker on dashboards and other pages. Turn this off to use the time picker as normal.
 	IgnoreTimeRange bool `json:"ignoreTimeRange,omitempty"`
 }