Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for Dashboard Timeframe #21

Merged
merged 3 commits into from
Dec 19, 2023
Merged

Support for Dashboard Timeframe #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b2ec12
support dashboard timeframes
shaswot77 Dec 19, 2023
4dfd8a4
timeframe docs
shaswot77 Dec 19, 2023
c4dc328
cspell configuration
shaswot77 Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions .vscode/settings.json → cspell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
{
"cSpell.words": [
"version": "0.2",
"language": "en,en-US",
"allowCompoundWords": true,
"dictionaries": [
"en_US",
"en_GB",
"softwareTerms",
"golang",
"bash"
],
"words": [
"basetypes",
"cbroglie",
"datasource",
Expand All @@ -16,7 +26,8 @@
"stringvalidator",
"tfprotov",
"tfsdk",
"timeframe",
"unmarshalling",
"visualisation"
]
}
}
2 changes: 2 additions & 0 deletions docs/resources/dashboard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ EOT
})
workspace_id = squaredup_workspace.application_workspace.id
display_name = "Sample Dashboard"
timeframe = "last12hours"
}
```

Expand All @@ -144,6 +145,7 @@ EOT
### Optional

- `template_bindings` (String) Template Bindings used for replacing mustache template in the dashboard template. Needs to be a JSON encoded string.
- `timeframe` (String) The timeframe of the dashboard. It should be one of the following: last1hour, last12hours, last24hours, last7days, last30days, thisMonth, thisQuarter, thisYear, lastMonth, lastQuarter, lastYear

### Read-Only

Expand Down
1 change: 1 addition & 0 deletions examples/resources/squaredup_dashboard/resource.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,5 @@ EOT
})
workspace_id = squaredup_workspace.application_workspace.id
display_name = "Sample Dashboard"
timeframe = "last12hours"
}
6 changes: 4 additions & 2 deletions internal/provider/client_dashboard.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ import (
"strings"
)

func (c *SquaredUpClient) CreateDashboard(displayName string, workspaceId string, dashboardContent string) (*Dashboard, error) {
func (c *SquaredUpClient) CreateDashboard(displayName string, workspaceId string, timeframe string, dashboardContent string) (*Dashboard, error) {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does adding a required argument (timeframe) impact upgrades of Terraform provider versions? e.g. user upgrades to this version of provider and their Terraform deployment breaks as now they need to provide an extra string argument.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

timeframe is not a required argument. Its optional in internal/provider/resource_dashboard.go


DashboardPayload := map[string]interface{}{
"displayName": displayName,
"workspaceId": workspaceId,
"timeframe": timeframe,
}

rb, err := json.Marshal(DashboardPayload)
Expand Down Expand Up @@ -59,10 +60,11 @@ func (c *SquaredUpClient) GetDashboard(dashboardId string) (*Dashboard, error) {
return &newDashboard, nil
}

func (c *SquaredUpClient) UpdateDashboard(dashboardId string, displayName string, workspaceId string, dashboardContent string) (*Dashboard, error) {
func (c *SquaredUpClient) UpdateDashboard(dashboardId string, displayName string, workspaceId string, timeframe string, dashboardContent string) (*Dashboard, error) {
DashboardPayload := map[string]interface{}{
"displayName": displayName,
"workspaceId": workspaceId,
shaswot77 marked this conversation as resolved.
Show resolved Hide resolved
"timeframe": timeframe,
}

rb, err := json.Marshal(DashboardPayload)
Expand Down
1 change: 1 addition & 0 deletions internal/provider/models.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ type Dashboard struct {
Group string `json:"group,omitempty"`
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't want to advertise Group (it was an old thing left over from Beacon days)

Name string `json:"name"`
SchemaVersion string `json:"schemaVersion"`
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't want to advertise SchemaVersion (it's an internal thing used for dashboard migrations). Perhaps we need to strip SchemaVersion and Group from Dashobard reads (GETs) too.

Timeframe string `json:"timeframe,omitempty"`
}

type SquaredupGremlinQuery struct {
Expand Down
28 changes: 26 additions & 2 deletions internal/provider/resource_dashboard.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ import (

"github.com/cbroglie/mustache"
"github.com/hashicorp/terraform-plugin-framework-jsontypes/jsontypes"
"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
"github.com/hashicorp/terraform-plugin-framework/path"
"github.com/hashicorp/terraform-plugin-framework/resource"
"github.com/hashicorp/terraform-plugin-framework/resource/schema"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
"github.com/hashicorp/terraform-plugin-framework/types"
)

Expand All @@ -36,6 +38,7 @@ type squaredupDashboard struct {
DashboardTemplate jsontypes.Normalized `tfsdk:"dashboard_template"`
TemplateBindings jsontypes.Normalized `tfsdk:"template_bindings"`
DashboardContent jsontypes.Normalized `tfsdk:"dashboard_content"`
Timeframe types.String `tfsdk:"timeframe"`
Group types.String `tfsdk:"group"`
Name types.String `tfsdk:"name"`
SchemaVersion types.String `tfsdk:"schema_version"`
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto previous comment on SchemaVersion and Group

Expand Down Expand Up @@ -81,6 +84,24 @@ func (r *DashboardResource) Schema(_ context.Context, _ resource.SchemaRequest,
Computed: true,
CustomType: jsontypes.NormalizedType{},
},
"timeframe": schema.StringAttribute{
Description: "The timeframe of the dashboard. It should be one of the following: last1hour, last12hours, last24hours, last7days, last30days, thisMonth, thisQuarter, thisYear, lastMonth, lastQuarter, lastYear",
Optional: true,
Computed: true,
Copy link

@wigsaparelli wigsaparelli Dec 20, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is timeframe marked as Computed (in fact lots of attribs are - obviously doesn't mean what I think it does)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its to handle null value as its marked as optional.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its to handle null value as its marked as optional.

Ah, ta, so what value will it compute when null?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just an empty string "". Because terraform store states based on response it expect some value than null

Validators: []validator.String{stringvalidator.OneOf(
"last1hour",
"last12hours",
"last24hours",
"last7days",
"last30days",
"thisMonth",
"thisQuarter",
"thisYear",
"lastMonth",
"lastQuarter",
"lastYear",
)},
},
"group": schema.StringAttribute{
Description: "The group of the dashboard",
Computed: true,
Expand Down Expand Up @@ -149,7 +170,7 @@ func (r *DashboardResource) Create(ctx context.Context, req resource.CreateReque
plan.TemplateBindings = jsontypes.NewNormalizedNull()
}

dashboard, err := r.client.CreateDashboard(plan.DisplayName.ValueString(), plan.WorkspaceID.ValueString(), updatedDashboard)
dashboard, err := r.client.CreateDashboard(plan.DisplayName.ValueString(), plan.WorkspaceID.ValueString(), plan.Timeframe.ValueString(), updatedDashboard)
if err != nil {
resp.Diagnostics.AddError(
"Unable to create dashboard",
Expand All @@ -165,6 +186,7 @@ func (r *DashboardResource) Create(ctx context.Context, req resource.CreateReque
DashboardTemplate: plan.DashboardTemplate,
TemplateBindings: plan.TemplateBindings,
DashboardContent: jsontypes.NewNormalizedValue(updatedDashboard),
Timeframe: types.StringValue(dashboard.Timeframe),
Group: types.StringValue(dashboard.Group),
Name: types.StringValue(dashboard.Name),
SchemaVersion: types.StringValue(dashboard.SchemaVersion),
Expand Down Expand Up @@ -203,6 +225,7 @@ func (r *DashboardResource) Read(ctx context.Context, req resource.ReadRequest,
DashboardTemplate: state.DashboardTemplate,
TemplateBindings: state.TemplateBindings,
DashboardContent: state.DashboardContent,
Timeframe: types.StringValue(dashboard.Timeframe),
Group: types.StringValue(dashboard.Group),
Name: types.StringValue(dashboard.Name),
SchemaVersion: types.StringValue(dashboard.SchemaVersion),
Expand Down Expand Up @@ -253,7 +276,7 @@ func (r *DashboardResource) Update(ctx context.Context, req resource.UpdateReque
plan.TemplateBindings = jsontypes.NewNormalizedNull()
}

dashboard, err := r.client.UpdateDashboard(state.DashboardID.ValueString(), plan.DisplayName.ValueString(), state.DashboardID.String(), updatedDashboard)
dashboard, err := r.client.UpdateDashboard(state.DashboardID.ValueString(), plan.DisplayName.ValueString(), state.DashboardID.String(), plan.Timeframe.ValueString(), updatedDashboard)
if err != nil {
resp.Diagnostics.AddError(
"Unable to update dashboard",
Expand All @@ -269,6 +292,7 @@ func (r *DashboardResource) Update(ctx context.Context, req resource.UpdateReque
DashboardTemplate: plan.DashboardTemplate,
TemplateBindings: plan.TemplateBindings,
DashboardContent: jsontypes.NewNormalizedValue(updatedDashboard),
Timeframe: types.StringValue(dashboard.Timeframe),
Group: types.StringValue(dashboard.Group),
Name: types.StringValue(dashboard.Name),
SchemaVersion: types.StringValue(dashboard.SchemaVersion),
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto previous comments on SchemaVersion and Group (both fields are referened in a few other places in this repo I haven't commented on too as not changed in this PR)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will do a cleanup of these based on our new API documentation. I have raised a JIRA for this

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will do a cleanup of these based on our new API documentation. I have raised a JIRA for this

Thanks @shaswot77

Expand Down
Loading