New Resource: wiz_report_graph_query #184

cvirtucio · 2023-12-05T20:28:15Z

This PR adds a new resource for the Report object of type GRAPH_QUERY.

closes #185

cvirtucio · 2023-12-05T21:32:29Z

I'm not entirely sure how to address this failure, but I think it could be that I don't have access to the required token.

…cheduling

jschoombee · 2023-12-06T17:58:05Z

I'm not entirely sure how to address this failure, but I think it could be that I don't have access to the required token.

Hey @cvirtucio 👋

Thanks for the contribution, I'll make some time hopefully this week or weekend to go through the PR. Regarding the CI failure, it was a recently introduced check and suspect it is indeed a security measure. Its not blocking but it should be fixed.

I'll go through it in some more detail, in the meantime:

why was resourceWizReportDelete was split out into resource_report.go? Could we add the function and structs to the main resource_report_graph_query.go?
please add examples (hcl) and run go generate ./..., this will generate the docs with examples for the registry, also add import examples should that work as expected for existing saved reports
any chance you could add acceptance testing as per contributing guide?

Looking good overall, been meaning to get to the open PRs will try get through them most likely over the weekend.

cvirtucio · 2023-12-06T18:43:48Z

Hi, thanks for giving it a look @jschoombee.

* why was `resourceWizReportDelete` was split out into resource_report.go? Could we add the function and structs to the main resource_report_graph_query.go?

I originally had them all in resource_report.go, but split it off to match the other resources' convention. I kept the Delete func since it seemed generic enough to be used on the other Report types.

* please add examples (hcl) and run `go generate ./...`, this will generate the docs with examples for the registry, also add import examples should that work as expected for existing saved reports

Added example and docs: 5927b92

* any chance you could add acceptance testing as per [contributing guide](https://github.com/AxtonGrams/terraform-provider-wiz/blob/main/_about/CONTRIBUTING.md)?

Added test: dacd275. Do I have to run these tests on our own Wiz environment?

jschoombee · 2023-12-06T19:04:54Z

Added test: dacd275. Do I have to run these tests on our own Wiz environment?

thanks, please reference one of the merged PRs, you generally set env vars WIZ_URL WIZ_AUTH_CLIENT_ID and WIZ_AUTH_CLIENT_SECRET targeting your own environment and then share the test results on the PR description

cvirtucio · 2023-12-06T19:41:44Z

Added test: dacd275. Do I have to run these tests on our own Wiz environment?

thanks, please reference one of the merged PRs, you generally set env vars WIZ_URL WIZ_AUTH_CLIENT_ID and WIZ_AUTH_CLIENT_SECRET targeting your own environment and then share the test results on the PR description

Done:

christopher.virtucio@KGYF7CQGCT terraform-provider-wiz % go test -run TestAccResourceWizReportGraphQuery_basic ./...
?   	wiz.io/hashicorp/terraform-provider-wiz	[no test files]
?   	wiz.io/hashicorp/terraform-provider-wiz/internal	[no test files]
?   	wiz.io/hashicorp/terraform-provider-wiz/internal/config	[no test files]
?   	wiz.io/hashicorp/terraform-provider-wiz/internal/utils	[no test files]
?   	wiz.io/hashicorp/terraform-provider-wiz/internal/wiz	[no test files]
ok  	wiz.io/hashicorp/terraform-provider-wiz/internal/acceptance	9.074s
ok  	wiz.io/hashicorp/terraform-provider-wiz/internal/client	(cached) [no tests to run]
ok  	wiz.io/hashicorp/terraform-provider-wiz/internal/provider	(cached) [no tests to run]
christopher.virtucio@KGYF7CQGCT terraform-provider-wiz %

We can't run all of them because we don't have some of the integrations, like ServiceNow.

.github/workflows/pull.yml

internal/provider/resource_report_graph_query.go

jschoombee · 2023-12-07T17:59:46Z

internal/provider/resource_report_graph_query.go

+	runIntervalHours, hasOk := d.GetOk("run_interval_hours")
+	if hasOk {
+		runIntervalHoursVal, _ := runIntervalHours.(int)
+		vars.RunIntervalHours = &runIntervalHoursVal
+
+		runStartsAt, hasOk := d.GetOk("run_starts_at")
+		if !hasOk {
+			return append(diags, diag.FromErr(fmt.Errorf("both run_interval_hours ad run_starts_at must be set to enable scheduling"))...)
+		}
+
+		runStartsAtVal, _ := runStartsAt.(string)
+		dt, err := time.Parse(reportRunStartsAtLayout, runStartsAtVal)
+		if err != nil {
+			return append(diags, diag.FromErr(fmt.Errorf("run_starts_at %s does not match layout %s", runStartsAtVal, reportRunStartsAtLayout))...)
+		}
+
+		vars.RunStartsAt = &dt
+	}


Can this be refactored into another func as the logic is repeated in update context?

fixed: 38f2edc

internal/wiz/structs.go

…g the appropriate repo

Signed-off-by: Christopher Virtucio <[email protected]>

examples/resources/wiz_report_graph_query/resource.tf

jschoombee · 2023-12-12T17:27:20Z

internal/provider/resource_report_graph_query.go

+
+func resourceWizReportGraphQuery() *schema.Resource {
+	return &schema.Resource{
+		Description: "TBD.",


Just spotted this TBD value, If you could please update then we can get this PR merged.

fixed: ec26333

please run go generate ./... to update the docs and push the committed changes

done: f3c5f9e

Signed-off-by: JP Schoombee <[email protected]>

* New Resource: wiz_report_graph_query --------- Signed-off-by: Christopher Virtucio <[email protected]> Signed-off-by: JP Schoombee <[email protected]> Co-authored-by: JP Schoombee <[email protected]>

cvirtucio added 9 commits December 5, 2023 12:14

early draft

f20d519

mvp

1566fa0

refactored to type-specific resources

91e8bfe

moved Read() func to graph_query resource for now; setting query on data

12c2dd0

removed cruft comments

d07bb27

removed more cruft

25783a9

brought back comments for resource_report.go structs

21b3041

added comments to address lint warnings

34c2e43

attempt to fix codeowners job

cf8896c

cvirtucio marked this pull request as ready for review December 5, 2023 21:21

cvirtucio requested a review from a team as a code owner December 5, 2023 21:21

cvirtucio mentioned this pull request Dec 5, 2023

New Resource: wiz_report_graph_query #185

Closed

cvirtucio added 2 commits December 5, 2023 16:28

force ci

ccf1f3e

force ci

4b8793a

cvirtucio added 2 commits December 6, 2023 09:47

run_interval_hours is nullable, per schema; added configuration for s…

5c1670d

…cheduling

switched to layout used by wiz API

9bb5fbf

cvirtucio added 3 commits December 6, 2023 13:15

minor message improvement

a8ebe98

string formatting fixes; added acceptance test

dacd275

added example and generated docs

5927b92

cvirtucio added 2 commits December 6, 2023 14:07

Merge branch 'main' into reports

b4ca1e9

fixed test

86897a0

go fmt

7b052c3

jschoombee requested changes Dec 7, 2023

View reviewed changes

cvirtucio added 2 commits December 8, 2023 09:48

attempt to have the checkout step in the codeowners job checkout usin…

572bc9a

…g the appropriate repo

specifying pull_request event HEAD instead

cf0fc0e

cvirtucio and others added 5 commits December 8, 2023 12:43

defaulting to star project_id; project_id requires recreating the report

07449dc

refactored scheduling code into a func

38f2edc

updated comment about CreateReportExportDestinationInput

bd8e538

Signed-off-by: Christopher Virtucio <[email protected]>

regenerated docs

bc2efb8

lint fix

589940a

cvirtucio force-pushed the reports branch from 8df3aad to 589940a Compare December 8, 2023 18:24

fixed docs rendering

5b873a5

jschoombee reviewed Dec 10, 2023

View reviewed changes

examples/resources/wiz_report_graph_query/resource.tf Outdated Show resolved Hide resolved

cvirtucio added 2 commits December 11, 2023 13:00

rounding to the hour in the example

dab2fbd

regen docs

eccee03

jschoombee reviewed Dec 12, 2023

View reviewed changes

cvirtucio added 2 commits December 12, 2023 12:33

description updates

ec26333

regenerated docs

f3c5f9e

jschoombee previously approved these changes Dec 12, 2023

View reviewed changes

jschoombee added 2 commits December 12, 2023 19:10

Merge branch 'main' into reports

85db7b9

Delete .terraform-version

e3c0a90

Signed-off-by: JP Schoombee <[email protected]>

jschoombee dismissed their stale review via e3c0a90 December 12, 2023 18:12

jschoombee approved these changes Dec 12, 2023

View reviewed changes

jschoombee merged commit 12b703d into AxtonGrams:main Dec 12, 2023
6 of 7 checks passed

cvirtucio deleted the reports branch December 12, 2023 18:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Resource: wiz_report_graph_query #184

New Resource: wiz_report_graph_query #184

cvirtucio commented Dec 5, 2023 •

edited by jschoombee

Loading

cvirtucio commented Dec 5, 2023

jschoombee commented Dec 6, 2023

cvirtucio commented Dec 6, 2023 •

edited

Loading

jschoombee commented Dec 6, 2023

cvirtucio commented Dec 6, 2023

jschoombee Dec 7, 2023

cvirtucio Dec 8, 2023

jschoombee Dec 12, 2023

cvirtucio Dec 12, 2023

jschoombee Dec 12, 2023

cvirtucio Dec 12, 2023

New Resource: wiz_report_graph_query #184

New Resource: wiz_report_graph_query #184

Conversation

cvirtucio commented Dec 5, 2023 • edited by jschoombee Loading

cvirtucio commented Dec 5, 2023

jschoombee commented Dec 6, 2023

cvirtucio commented Dec 6, 2023 • edited Loading

jschoombee commented Dec 6, 2023

cvirtucio commented Dec 6, 2023

jschoombee Dec 7, 2023

Choose a reason for hiding this comment

cvirtucio Dec 8, 2023

Choose a reason for hiding this comment

jschoombee Dec 12, 2023

Choose a reason for hiding this comment

cvirtucio Dec 12, 2023

Choose a reason for hiding this comment

jschoombee Dec 12, 2023

Choose a reason for hiding this comment

cvirtucio Dec 12, 2023

Choose a reason for hiding this comment

cvirtucio commented Dec 5, 2023 •

edited by jschoombee

Loading

cvirtucio commented Dec 6, 2023 •

edited

Loading