Add google_apigee_custom_report resource

[ogormans-deptstack]

New resource google_apigee_custom_report for managing Apigee Analytics custom report definitions via the organizations.reports API.

Custom reports let users define reusable analytics views with custom metrics, dimensions, filters, and grouping. This resource supports all fields from the API including metrics with aggregation functions, dimensions, time units, sorting, and report properties.

Tested all CRUD operations against a live Apigee evaluation org:

• Create (1s)
• Read with no drift
• Update in-place (display name, metrics, dimensions, time unit)
• Import by full resource path
• Delete

Uses PUT with no update mask (same pattern as DeveloperApp). The name field is a server-assigned UUID used as the path identifier. displayName is user-specified and mutable.

Related to PR #16954 (google_apigee_data_collector).

Release Note Template for Downstream PRs (will be copied)

`google_apigee_custom_report`

[github-actions]

Googlers: For automatic test runs see go/terraform-auto-test-runs.

@zli82016, a repository maintainer, has been assigned to review your changes. If you have not received review feedback within 2 business days, please leave a comment on this PR asking them to take a look.

You can help make sure that review is quick by doing a self-review and by running impacted tests locally.

[modular-magician]

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 5 files changed, 1530 insertions(+), 2 deletions(-))
google-beta provider: Diff ( 5 files changed, 1530 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 347 insertions(+))

Missing test report

Your PR includes resource fields which are not covered by any test.

Resource: google_apigee_custom_report (1 total tests)
Please add an acceptance test which includes these fields. The test should include the following:

resource "google_apigee_custom_report" "primary" {
  chart_type = # value needed
  comments   = # value needed
  filter     = # value needed
  from_time  = # value needed
  limit      = # value needed
  offset     = # value needed
  properties {
    property = # value needed
    value    = # value needed
  }
  sort_by_cols = # value needed
  sort_order   = # value needed
  tags         = # value needed
  time_unit    = # value needed
  to_time      = # value needed
  topk         = # value needed
}

[modular-magician]

Non-exercised tests

🔴 Tests were added that are skipped in VCR:

• TestAccApigeeCustomReport_apigeeCustomReportBasicTestExample

Tests analytics

Total tests: 73
Passed tests: 35
Skipped tests: 38
Affected tests: 0

Click here to see the affected service packages

• apigee

🟢 All tests passed!

View the build log

[ogormans-deptstack]

The disallow-large-prs check is flagging 529 lines (excluding tests/docs), which is just over the 500 line limit. This is a single new resource -- the line count is driven by the number of fields in the Reports API (13 optional fields plus nested objects). Splitting this into multiple PRs would mean shipping a partially-functional resource, which doesn't make sense for a single API endpoint. Happy to trim if the reviewer sees unnecessary code, but the field coverage is 1:1 with the API.

[modular-magician]

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 5 files changed, 1734 insertions(+), 2 deletions(-))
google-beta provider: Diff ( 5 files changed, 1734 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 347 insertions(+))

[modular-magician]

Non-exercised tests

🔴 Tests were added that are skipped in VCR:

• TestAccApigeeCustomReport_apigeeCustomReportBasicTestExample
• TestAccApigeeCustomReport_apigeeCustomReportFullTestExample

Tests analytics

Total tests: 74
Passed tests: 35
Skipped tests: 39
Affected tests: 0

Click here to see the affected service packages

• apigee

🟢 All tests passed!

View the build log

[zli82016]

Can you also add the update tests for the updatable fields?

Doc: https://googlecloudplatform.github.io/magic-modules/test/test/#add-an-update-test

Thanks

[ogormans-deptstack]

Thanks for the thorough review @zli82016! Pushed changes addressing all feedback:

Copyright: Fixed to 2026.

Vars: Added project_id, network_name, range_name, and display_name as vars in both test examples and updated all test templates to reference them.

Update test: Added a handwritten update test (resource_apigee_custom_report_test.go) that creates a report with basic fields, then updates display_name, adds a second metric, changes dimensions, and adds a filter. Includes ConfigPlanChecks to verify in-place update.

exclude_sweeper: The Reports API uses a server-assigned UUID as the resource name (not user-specified). The sweeper can't enumerate resources by a predictable name pattern to identify test leftovers.

skip_vcr: Apigee tests create full org infrastructure (project → APIs → VPC → peering → org) with multi-minute provisioning and timing dependencies that can't be reliably replayed by VCR. This matches all other Apigee org-creating tests (AppGroup, Developer, EnvGroup, etc.).

[github-actions]

@zli82016 This PR has been waiting for review for 3 weekdays. Please take a look! Use the label disable-review-reminders to disable these notifications.

[modular-magician]

Hi there, I'm the Modular magician. I've detected the following information about your changes:

Diff report

Your PR generated some diffs in downstreams - here they are.

google provider: Diff ( 6 files changed, 2081 insertions(+), 2 deletions(-))
google-beta provider: Diff ( 6 files changed, 2081 insertions(+), 2 deletions(-))
terraform-google-conversion: Diff ( 1 file changed, 347 insertions(+))

[modular-magician]

Non-exercised tests

🔴 Tests were added that are skipped in VCR:

• TestAccApigeeCustomReport_apigeeCustomReportBasicTestExample
• TestAccApigeeCustomReport_apigeeCustomReportFullTestExample
• TestAccApigeeCustomReport_update

Tests analytics

Total tests: 79
Passed tests: 35
Skipped tests: 42
Affected tests: 2

Click here to see the affected service packages

• apigee

Action taken

Found 2 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit. Click here to see the affected tests

• TestAccApigeeOrganization_apigeeOrganizationCloudBasicDisableVpcPeeringTestExample
• TestAccApigeeOrganization_apigeeOrganizationCloudFullDisableVpcPeeringTestExample

Get to know how VCR tests work

[modular-magician]

🔴 Tests failed during RECORDING mode:
TestAccApigeeOrganization_apigeeOrganizationCloudBasicDisableVpcPeeringTestExample [Error message] [Debug log]
TestAccApigeeOrganization_apigeeOrganizationCloudFullDisableVpcPeeringTestExample [Error message] [Debug log]

🔴 Errors occurred during RECORDING mode. Please fix them to complete your PR.

View the build log or the debug log for each test

[ogormans-deptstack]

The TestAccApigeeOrganization_apigeeOrganizationCloudBasicDisableVpcPeeringTestExample failure is unrelated to this PR — it's an existing Apigee Organization test, not something introduced by the Custom Report resource. Our three tests (BasicTest, FullTest, update) are skipped in VCR as expected since Apigee requires a live org and can't be recorded.

@zli82016 all your review feedback was addressed in the last push (copyright, vars, update test, sweeper/VCR explanations). Happy to make further changes if needed.

[github-actions]

@ogormans-deptstack, this PR is waiting for action from you. If no action is taken, this PR will be closed in 28 days.

Please address any comments or change requests, or re-request review from a core reviewer if no action is required.

This notification can be disabled with the disable-automatic-closure label.

[zli82016]

Should the field displayName be immutable?

[zli82016]

This comment is still pending.

[zli82016]

TestAccApigeeCustomReport_apigeeCustomReportFullTestExample failed

    resource_apigee_custom_report_generated_test.go:194: Step 1/3 error: Error running apply: exit status 1
        
        Error: Error creating CustomReport: googleapi: Error 400: Invalid value at 'custom_report.properties[0].values[0]' (type.googleapis.com/google.cloud.apigee.v1.Attribute), "true"
        Details:
        [
          {
            "@type": "type.googleapis.com/google.rpc.BadRequest",
            "fieldViolations": [
              {
                "description": "Invalid value at 'custom_report.properties[0].values[0]' (type.googleapis.com/google.cloud.apigee.v1.Attribute), \"true\"",
                "field": "custom_report.properties[0].values[0]"
              }
            ]
          }
        ]
        
          with google_apigee_custom_report.apigee_custom_report,
          on terraform_plugin_test.tf line 81, in resource "google_apigee_custom_report" "apigee_custom_report":
          81: resource "google_apigee_custom_report" "apigee_custom_report" {

[ogormans-deptstack]

Thanks @zli82016 — pushed addressing the remaining feedback:

FullTest failure (properties.value): Root cause was a schema mismatch. The API's ReportProperty.value field expects an array of Attribute objects ({name, value}), not flat strings. Fixed the YAML schema to model value as a NestedObject with name and value fields, and updated both template examples accordingly.

Custom import template: Simplified to use standard ParseImportId with two regex patterns as suggested — much cleaner.

displayName immutability: displayName is intentionally updatable — our handwritten update test exercises this (changes from tf-test-cr to tf-test-cr-updated). The PUT API accepts updates to this field.

[ogormans-deptstack]

Thanks for your patience and thorough reviews @zli82016 — really appreciate the time you've put into this.

Pushed two commits addressing the remaining feedback:

1. FullTest failure fix (properties.value schema)
The root cause was that ReportProperty.value in the API expects an array of Attribute objects ({name, value}), not flat strings. The previous schema modeled it as Array<String> which caused the 400: Invalid value at 'custom_report.properties[0].values[0]' (type.googleapis.com/google.cloud.apigee.v1.Attribute) error you reported. Fixed the YAML to use NestedObject with name and value fields, and updated both template examples to use the block syntax.

2. Custom import simplified
Replaced the manual string-splitting logic with standard ParseImportId using two regex patterns, as you suggested.

3. project_id declared as var
Added project_id: 'my-project' to all four examples in the YAML and updated templates to use {{index $.Vars "project_id"}} — matching the ControlPlaneAccess pattern you referenced.

Re: displayName immutability — it's intentionally updatable. The handwritten update test exercises this (changes display_name from tf-test-cr to tf-test-cr-updated), and the PUT API accepts the change.

[modular-magician]

Hi there, I'm the Modular magician. I've detected the following information about your changes for commit e674203:

Diff report

Your PR generated the following diffs in downstream repositories:

Repository	Diff Link	Changes
google provider	View Diff	5 files changed, 2209 insertions(+)
google-beta provider	View Diff	5 files changed, 2209 insertions(+)
terraform-google-conversion	View Diff	1 file changed, 383 insertions(+)

Test report

Analytics

Total Tests	Passed	Skipped	Affected
79	39	38	2

Affected Service Packages

• apigee

Learn how VCR tests work

---

Step 1: Replaying Mode

Action taken

Found 2 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit.

Click here to see the affected tests

• TestAccApigeeCustomReport_apigeeCustomReportBasicTestExample
• TestAccApigeeCustomReport_apigeeCustomReportFullTestExample

View the replaying VCR build log

---

Step 2: Recording Mode

Recording Mode	Replaying Rerun	Test Name
✅ Log	✅	TestAccApigeeCustomReport_apigeeCustomReportBasicTestExample
❌ Error · Log	-	TestAccApigeeCustomReport_apigeeCustomReportFullTestExample

Caution

Issues requiring attention before PR completion

🔴 Initial Recording Failed: Some tests failed during the recording step. See the table above for details.

Please address these issues to complete your PR. If you believe these detections are incorrect or unrelated to your change, please raise the concern with your reviewer.

View the recording VCR build log or the debug logs folder for detailed results.

@ogormans-deptstack, @zli82016 VCR tests complete for e674203!

[zli82016]

=== CONT  TestAccApigeeCustomReport_apigeeCustomReportFullTestExample
    resource_apigee_custom_report_generated_test.go:199: Step 1/3 error: After applying this test step, the non-refresh plan was not empty.
        stdout:
        
        
        Terraform used the selected providers to generate the following execution
        plan. Resource actions are indicated with the following symbols:
          ~ update in-place
        
        Terraform will perform the following actions:
        
          # google_apigee_custom_report.apigee_custom_report will be updated in-place
          ~ resource "google_apigee_custom_report" "apigee_custom_report" {
              ~ comments         = [
                  + "Daily traffic report",
                ]
              + from_time        = "1609459200000"
                id               = "organizations/tf-test-my-projectyocb9j37r9/reports/a765ed69-93e9-446b-a1e3-80785e6f15da"
              + limit            = "100"
                name             = "a765ed69-93e9-446b-a1e3-80785e6f15da"
              + offset           = "0"
              ~ sort_by_cols     = [
                  + "message_count",
                ]
              + sort_order       = "DESC"
              ~ tags             = [
                  + "production",
                  + "analytics",
                ]
              + to_time          = "1640995200000"
              + topk             = "10"
                # (12 unchanged attributes hidden)
        
                # (3 unchanged blocks hidden)
            }

These fields causing diffs are not in the GET response.

[zli82016]

Please fix the test.

[ogormans-deptstack]

Pushed fixes for both test failures:

1. Project name too long: Shortened project_id var from my-project to proj (14 chars total with suffix, well under 30).

2. Non-empty plan (comments/from_time/limit): Added ignore_read: true to the 6 query-parameter fields (fromTime, toTime, topk, limit, offset, comments). The Apigee Reports API accepts these on create/update but doesn't return them on GET, so Read was setting them to nil and causing plan drift.

Re: displayName immutability — it's intentionally updatable. The PUT API accepts changes, and the handwritten update test exercises this (changes display_name from tf-test-cr to tf-test-cr-updated).

[zli82016]

2. Non-empty plan (comments/from_time/limit): Added ignore_read: true to the 6 query-parameter fields (fromTime, toTime, topk, limit, offset, comments). The Apigee Reports API accepts these on create/update but doesn't return them on GET, so Read was setting them to nil and causing plan drift.

Thanks for the fix.

Will the API return them on GET in the future? If the API is not ready to return them and will return them in the future, these fields can be removed now and then be added once the API returns them.

[modular-magician]

Hi there, I'm the Modular magician. I've detected the following information about your changes for commit 5cd354d:

Diff report

Your PR generated the following diffs in downstream repositories:

Repository	Diff Link	Changes
google provider	View Diff	5 files changed, 2167 insertions(+)
google-beta provider	View Diff	5 files changed, 2167 insertions(+)
terraform-google-conversion	View Diff	1 file changed, 383 insertions(+)

Test report

Analytics

Total Tests	Passed	Skipped	Affected
79	39	38	2

Affected Service Packages

• apigee

Learn how VCR tests work

---

Step 1: Replaying Mode

Action taken

Found 2 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit.

Click here to see the affected tests

• TestAccApigeeCustomReport_apigeeCustomReportBasicTestExample
• TestAccApigeeCustomReport_apigeeCustomReportFullTestExample

View the replaying VCR build log

---

Step 2: Recording Mode

Recording Mode	Replaying Rerun	Test Name
✅ Log	✅	TestAccApigeeCustomReport_apigeeCustomReportBasicTestExample
❌ Error · Log	-	TestAccApigeeCustomReport_apigeeCustomReportFullTestExample

Caution

Issues requiring attention before PR completion

🔴 Initial Recording Failed: Some tests failed during the recording step. See the table above for details.

Please address these issues to complete your PR. If you believe these detections are incorrect or unrelated to your change, please raise the concern with your reviewer.

View the recording VCR build log or the debug logs folder for detailed results.

@ogormans-deptstack, @zli82016 VCR tests complete for 5cd354d!

[ogormans-deptstack]

Honestly, I'm not sure whether the API will return them in the future — they're documented in the CustomReport resource spec as top-level fields, but the GET response doesn't include them even after they're set via POST/PUT.

I'll remove them entirely for now. That's cleaner than ignore_read for fields that don't fully round-trip — better to go with real API response rather than doc drift. They can be added back if/when the API starts returning them on GET.

Removing all 6: fromTime, toTime, topk, limit, offset, comments.

[modular-magician]

Hi there, I'm the Modular magician. I've detected the following information about your changes for commit 45ec085:

Diff report

Your PR generated the following diffs in downstream repositories:

Repository	Diff Link	Changes
google provider	View Diff	5 files changed, 1996 insertions(+)
google-beta provider	View Diff	5 files changed, 1996 insertions(+)
terraform-google-conversion	View Diff	1 file changed, 323 insertions(+)

Test report

Analytics

Total Tests	Passed	Skipped	Affected
79	40	38	1

Affected Service Packages

• apigee

Learn how VCR tests work

---

Step 1: Replaying Mode

Action taken

Found 1 affected test(s) by replaying old test recordings. Starting RECORDING based on the most recent commit.

Click here to see the affected tests

• TestAccApigeeCustomReport_apigeeCustomReportFullTestExample

View the replaying VCR build log

---

Step 2: Recording Mode

Recording Mode	Replaying Rerun	Test Name
❌ Error · Log	-	TestAccApigeeCustomReport_apigeeCustomReportFullTestExample

Caution

Issues requiring attention before PR completion

🔴 Initial Recording Failed: Some tests failed during the recording step. See the table above for details.

Please address these issues to complete your PR. If you believe these detections are incorrect or unrelated to your change, please raise the concern with your reviewer.

View the recording VCR build log or the debug logs folder for detailed results.

@ogormans-deptstack, @zli82016 VCR tests complete for 45ec085!

[zli82016]

More fields sort_by_cols, sort_order, tags need to be removed from the support.

=== CONT  TestAccApigeeCustomReport_apigeeCustomReportFullTestExample
    resource_apigee_custom_report_generated_test.go:199: Step 1/3 error: After applying this test step, the non-refresh plan was not empty.
        stdout:
        
        
        Terraform used the selected providers to generate the following execution
        plan. Resource actions are indicated with the following symbols:
          ~ update in-place
        
        Terraform will perform the following actions:
        
          # google_apigee_custom_report.apigee_custom_report will be updated in-place
          ~ resource "google_apigee_custom_report" "apigee_custom_report" {
                id               = "organizations/tf-test-proji0xlclte63/reports/c58ac590-d37e-4ce0-ad82-f58c48bb99c0"
                name             = "c58ac590-d37e-4ce0-ad82-f58c48bb99c0"
              ~ sort_by_cols     = [
                  + "message_count",
                ]
              + sort_order       = "DESC"
              ~ tags             = [
                  + "production",
                  + "analytics",
                ]
                # (12 unchanged attributes hidden)
        
                # (3 unchanged blocks hidden)
            }
        
        Plan: 0 to add, 1 to change, 0 to destroy.