Skip to content

Commit

Permalink
Added CloudQuotas service and Create QuotaPreference Resource (G…
Browse files Browse the repository at this point in the history
…oogleCloudPlatform#10019)

* setup resoruce config and add create tests

* add create and update test

* fix lint error

* fix lint error

* update yaml config

* remove trailing spaces

* modify update test

* update acceptance test and cleanup

* add upsert scenario for testing

* update acceptance test syntax

* remove allow-missing flag & fix update test failure

* add import and id format

* teamcity test failure - manually add cloudquotas service

* teamcity test failure - manually add cloudquotas service for beta

* add field 'validate_only' to tests

* address comments & fix test failure

* remove unused import

* remove `validate_only` field, add ignore read feature to `annotations` field

* add input only fields to ImportStateVerifyIgnore

* update field name

* VCR test failure: remove batch service creation

* fix formatting
  • Loading branch information
lola98 authored and BBBmau committed Mar 27, 2024
1 parent 41b3220 commit 3cc5255
Show file tree
Hide file tree
Showing 5 changed files with 353 additions and 3 deletions.
158 changes: 158 additions & 0 deletions mmv1/products/cloudquotas/QuotaPreference.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
# Copyright 2024 Google Inc.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

--- !ruby/object:Api::Resource
name: 'QuotaPreference'
description: |
QuotaPreference represents the preferred quota configuration specified for a project, folder or organization. There is only one QuotaPreference resource for a quota value targeting a unique set of dimensions.
references: !ruby/object:Api::Resource::ReferenceLinks
guides:
'Cloud Quotas Overview': 'https://cloud.google.com/docs/quotas/overview'
api: 'https://cloud.google.com/docs/quotas/reference/rest/v1/projects.locations.quotaPreferences'
base_url: '{{parent}}/locations/global/quotaPreferences'
self_link: '{{parent}}/locations/global/quotaPreferences/{{name}}'
create_url: '{{parent}}/locations/global/quotaPreferences?quotaPreferenceId={{name}}&ignoreSafetyChecks={{ignore_safety_checks}}'
update_url: '{{parent}}/locations/global/quotaPreferences/{{name}}?ignoreSafetyChecks={{ignore_safety_checks}}'
update_verb: :PATCH
update_mask: true
skip_delete: true
autogen_async: false
import_format: ['{{%parent}}/locations/global/quotaPreferences/{{name}}']
id_format: '{{parent}}/locations/global/quotaPreferences/{{name}}'

examples:
- !ruby/object:Provider::Terraform::Examples
name: "cloudquotas_quota_preference_basic"
primary_resource_id: "preference"
skip_test: true
vars:
name: "compute_googleapis_com-CPUS-per-project_us-east1"
test_env_vars:
project: :PROJECT_NAME

parameters:
- !ruby/object:Api::Type::String
name: 'parent'
immutable: true
url_param_only: true
required: true
default_from_api: true
description: The parent of the quota preference. Allowed parents are "projects/[project-id / number]" or "folders/[folder-id / number]" or "organizations/[org-id / number]".
- !ruby/object:Api::Type::Enum
name: 'ignore_safety_checks'
url_param_only: true
default_value: :QUOTA_SAFETY_CHECK_UNSPECIFIED
description: The list of quota safety checks to be ignored.
values:
- :QUOTA_SAFETY_CHECK_UNSPECIFIED
- :QUOTA_DECREASE_BELOW_USAGE
- :QUOTA_DECREASE_PERCENTAGE_TOO_HIGH

properties:
- !ruby/object:Api::Type::String
name: 'name'
default_from_api: true
pattern: '{{parent}}/locations/global/quotaPreferences/{{name}}'
description: |
The resource name of the quota preference. Required except in the CREATE requests.
diff_suppress_func: 'tpgresource.CompareSelfLinkOrResourceName'
custom_expand: templates/terraform/custom_expand/resource_from_self_link.go.erb
custom_flatten: templates/terraform/custom_flatten/name_from_self_link.erb
- !ruby/object:Api::Type::String
name: 'service'
required: true
default_from_api: true
description: The name of the service to which the quota preference is applied.
- !ruby/object:Api::Type::String
name: 'quotaId'
required: true
default_from_api: true
description: |
The id of the quota to which the quota preference is applied. A quota id is unique in the service.
Example: `CPUS-per-project-region`.
- !ruby/object:Api::Type::NestedObject
name: 'quotaConfig'
required: true
description: The preferred quota configuration.
properties:
- !ruby/object:Api::Type::String
name: 'preferredValue'
required: true
description: |
The preferred value. Must be greater than or equal to -1. If set to -1, it means the value is "unlimited".
- !ruby/object:Api::Type::String
name: 'stateDetail'
output: true
description: Optional details about the state of this quota preference.
- !ruby/object:Api::Type::String
name: 'grantedValue'
output: true
description: Granted quota value.
- !ruby/object:Api::Type::String
name: 'traceId'
output: true
description: |
The trace id that the Google Cloud uses to provision the requested quota. This trace id may be used by the client to contact Cloud support to track the state of a quota preference request. The trace id is only produced for increase requests and is unique for each request. The quota decrease requests do not have a trace id.
- !ruby/object:Api::Type::KeyValuePairs
name: 'annotations'
custom_flatten: 'templates/terraform/custom_flatten/cloudquotas_quota_preference_annotations.go.erb'
description: |-
The annotations map for clients to store small amounts of arbitrary data. Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations.
An object containing a list of "key: value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
- !ruby/object:Api::Type::String
name: 'requestOrigin'
output: true
description: The origin of the quota preference request.
- !ruby/object:Api::Type::KeyValuePairs
name: 'dimensions'
default_from_api: true
description: |-
The dimensions that this quota preference applies to. The key of the map entry is the name of a dimension, such as "region", "zone", "network_id", and the value of the map entry is the dimension value. If a dimension is missing from the map of dimensions, the quota preference applies to all the dimension values except for those that have other quota preferences configured for the specific value.
NOTE: QuotaPreferences can only be applied across all values of "user" and "resource" dimension. Do not set values for "user" or "resource" in the dimension map.
Example: `{"provider": "Foo Inc"}` where "provider" is a service specific dimension.
- !ruby/object:Api::Type::String
name: 'etag'
output: true
description: |
The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.
- !ruby/object:Api::Type::String
name: 'createTime'
output: true
description: |
Create time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `2014-10-02T15:01:23Z` and `2014-10-02T15:01:23.045123456Z`.
- !ruby/object:Api::Type::String
name: 'updateTime'
output: true
description: |
Update time stamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `2014-10-02T15:01:23Z` and `2014-10-02T15:01:23.045123456Z`.
- !ruby/object:Api::Type::Boolean
name: 'reconciling'
output: true
description: |
Is the quota preference pending Google Cloud approval and fulfillment.
- !ruby/object:Api::Type::String
name: 'justification'
ignore_read: true
description: The reason / justification for this quota preference.
- !ruby/object:Api::Type::String
name: 'contactEmail'
ignore_read: true
description: |-
An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted.
The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
func flatten<%= prefix -%><%= titlelize_property(property) -%>(v interface{}, d *schema.ResourceData, config *transport_tpg.Config) interface{} {
// ignore read on this field
return d.Get("quota_config.0.annotations")
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
resource "google_cloud_quotas_quota_preference" "<%= ctx[:primary_resource_id] %>" {
parent = "projects/<%= ctx[:test_env_vars]['project'] %>"
name = "<%= ctx[:vars]['name'] %>"
dimensions = { region = "us-east1" }
service = "compute.googleapis.com"
quota_id = "CPUS-per-project-region"
contact_email = "[email protected]"
quota_config {
preferred_value = 200
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@ import (
"github.com/hashicorp/terraform-provider-google/google/services/dataflow"
"github.com/hashicorp/terraform-provider-google/google/services/servicenetworking"
"github.com/hashicorp/terraform-provider-google/google/tpgiamresource"
<% if version == 'ga' -%> // https://github.com/hashicorp/terraform-provider-google/issues/15633 for details
"github.com/hashicorp/terraform-provider-google/google/services/cloudquotas"
<% end -%>
)

// Datasources
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
package cloudquotas_test

import (
"testing"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"

"github.com/hashicorp/terraform-provider-google/google/acctest"
"github.com/hashicorp/terraform-provider-google/google/envvar"
)

func TestAccCloudQuotasQuotaPreference_cloudquotasQuotaPreferenceBasicExample_update(t *testing.T) {
t.Parallel()

context := map[string]interface{}{
"org_id": envvar.GetTestOrgFromEnv(t),
"billing_account": envvar.GetTestBillingAccountFromEnv(t),
"random_suffix": acctest.RandString(t, 10),
}

acctest.VcrTest(t, resource.TestCase{
PreCheck: func() { acctest.AccTestPreCheck(t) },
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories(t),
ExternalProviders: map[string]resource.ExternalProvider{
"time": {},
},
Steps: []resource.TestStep{
{
Config: testAccCloudQuotasQuotaPreference_cloudquotasQuotaPreferenceBasicExample_basic(context),
},
{
ResourceName: "google_cloud_quotas_quota_preference.my_preference",
ImportState: true,
ImportStateVerify: true,
ImportStateVerifyIgnore: []string{"parent", "quota_preference_id", "ignore_safety_checks", "contact_email"},
},
{
Config: testAccCloudQuotasQuotaPreference_cloudquotasQuotaPreferenceBasicExample_increaseQuota(context),
},
{
ResourceName: "google_cloud_quotas_quota_preference.my_preference",
ImportState: true,
ImportStateVerify: true,
ImportStateVerifyIgnore: []string{"parent", "quota_preference_id", "ignore_safety_checks", "contact_email", "justification", "quota_config.0.annotations"},
},
{
Config: testAccCloudQuotasQuotaPreference_cloudquotasQuotaPreferenceBasicExample_decreaseQuota(context),
},
{
ResourceName: "google_cloud_quotas_quota_preference.my_preference",
ImportState: true,
ImportStateVerify: true,
ImportStateVerifyIgnore: []string{"parent", "quota_preference_id", "ignore_safety_checks", "contact_email", "justification", "quota_config.0.annotations"},
},
},
})
}

func testAccCloudQuotasQuotaPreference_cloudquotasQuotaPreferenceBasicExample_basic(context map[string]interface{}) string {
return acctest.Nprintf(`
resource "google_project" "new_project" {
project_id = "tf-test%{random_suffix}"
name = "tf-test%{random_suffix}"
org_id = "%{org_id}"
billing_account = "%{billing_account}"
}
resource "google_project_service" "cloudquotas" {
project = google_project.new_project.project_id
service = "cloudquotas.googleapis.com"
}
resource "google_project_service" "compute" {
project = google_project.new_project.project_id
service = "compute.googleapis.com"
depends_on = [google_project_service.cloudquotas]
}
resource "google_project_service" "billing" {
project = google_project.new_project.project_id
service = "cloudbilling.googleapis.com"
depends_on = [google_project_service.compute]
}
resource "time_sleep" "wait_120_seconds" {
create_duration = "120s"
depends_on = [google_project_service.billing]
}
resource "google_cloud_quotas_quota_preference" "my_preference"{
parent = "projects/${google_project.new_project.project_id}"
name = "compute_googleapis_com-CPUS-per-project_us-central1"
dimensions = { region = "us-central1" }
service = "compute.googleapis.com"
quota_id = "CPUS-per-project-region"
contact_email = "[email protected]"
quota_config {
preferred_value = 70
}
ignore_safety_checks = "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH"
depends_on = [
time_sleep.wait_120_seconds
]
}
`, context)
}

func testAccCloudQuotasQuotaPreference_cloudquotasQuotaPreferenceBasicExample_increaseQuota(context map[string]interface{}) string {
return acctest.Nprintf(`
resource "google_project" "new_project" {
project_id = "tf-test%{random_suffix}"
name = "tf-test%{random_suffix}"
org_id = "%{org_id}"
billing_account = "%{billing_account}"
}
resource "google_project_service" "cloudquotas" {
project = google_project.new_project.project_id
service = "cloudquotas.googleapis.com"
}
resource "google_project_service" "compute" {
project = google_project.new_project.project_id
service = "compute.googleapis.com"
depends_on = [google_project_service.cloudquotas]
}
resource "google_project_service" "billing" {
project = google_project.new_project.project_id
service = "cloudbilling.googleapis.com"
depends_on = [google_project_service.compute]
}
resource "google_cloud_quotas_quota_preference" "my_preference"{
contact_email = "[email protected]"
justification = "Ignore. Increase quota for Terraform testing."
quota_config {
preferred_value = 72
annotations = { label = "terraform" }
}
depends_on = [google_project_service.billing]
}
`, context)
}

func testAccCloudQuotasQuotaPreference_cloudquotasQuotaPreferenceBasicExample_decreaseQuota(context map[string]interface{}) string {
return acctest.Nprintf(`
resource "google_project" "new_project" {
project_id = "tf-test%{random_suffix}"
name = "tf-test%{random_suffix}"
org_id = "%{org_id}"
billing_account = "%{billing_account}"
}
resource "google_project_service" "cloudquotas" {
project = google_project.new_project.project_id
service = "cloudquotas.googleapis.com"
}
resource "google_project_service" "compute" {
project = google_project.new_project.project_id
service = "compute.googleapis.com"
depends_on = [google_project_service.cloudquotas]
}
resource "google_project_service" "billing" {
project = google_project.new_project.project_id
service = "cloudbilling.googleapis.com"
depends_on = [google_project_service.compute]
}
resource "google_cloud_quotas_quota_preference" "my_preference"{
ignore_safety_checks = "QUOTA_DECREASE_PERCENTAGE_TOO_HIGH"
quota_config {
preferred_value = 65
}
depends_on = [google_project_service.billing]
}
`, context)
}

0 comments on commit 3cc5255

Please sign in to comment.