Skip to content

Commit d8eab37

Browse files
committed
update doc examples to use the values in tests by default
1 parent 67f110c commit d8eab37

File tree

6 files changed

+87
-6
lines changed

6 files changed

+87
-6
lines changed

Diff for: api-definitions/resource-manager/ChaosStudio/Terraform/ChaosStudioTarget-Resource.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
},
1414
"description": "Manages a Chaos Studio Target",
1515
"displayName": "Chaos Studio Target",
16-
"exampleUsage": "\nresource \"azurerm_kubernetes_cluster\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n dns_prefix = \"acctestaksexample\"\n default_node_pool {\n name = \"example-value\"\n node_count = \"example-value\"\n vm_size = \"example-value\"\n }\n identity {\n type = \"example-value\"\n }\n}\nresource \"azurerm_resource_group\" \"example\" {\n name = \"example-resources\"\n location = \"West Europe\"\n}\nresource \"azurerm_chaos_studio_target\" \"example\" {\n location = azurerm_resource_group.example.location\n target_resource_id = azurerm_kubernetes_cluster.example.id\n target_type = \"example-value\"\n}\n",
16+
"exampleUsage": "\nresource \"azurerm_kubernetes_cluster\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n dns_prefix = \"acctestaksexample\"\n default_node_pool {\n name = \"default\"\n node_count = 1\n vm_size = \"Standard_DS2_v2\"\n }\n identity {\n type = \"SystemAssigned\"\n }\n}\nresource \"azurerm_resource_group\" \"example\" {\n name = \"example-resources\"\n location = \"West Europe\"\n}\nresource \"azurerm_chaos_studio_target\" \"example\" {\n location = azurerm_resource_group.example.location\n target_resource_id = azurerm_kubernetes_cluster.example.id\n target_type = \"Microsoft-AzureKubernetesServiceChaosMesh\"\n}\n",
1717
"generate": true,
1818
"generateIdValidationFunction": true,
1919
"generateModel": true,

Diff for: api-definitions/resource-manager/ContainerService/Terraform/KubernetesClusterTrustedAccessRoleBinding-Resource.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
},
1414
"description": "Manages a Kubernetes Cluster Trusted Access Role Binding\n~\u003e **Note:** This Resource is in **Preview** to use this you must be opted into the Preview. You can do this by running `az feature register --namespace Microsoft.ContainerService --name TrustedAccessPreview` and then `az provider register -n Microsoft.ContainerService`\n",
1515
"displayName": "Kubernetes Cluster Trusted Access Role Binding",
16-
"exampleUsage": "\nresource \"azurerm_application_insights\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n application_type = \"example-value\"\n}\ndata \"azurerm_client_config\" \"test\" {}\nresource \"azurerm_key_vault\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n tenant_id = data.azurerm_client_config.example.tenant_id\n sku_name = \"example-value\"\n soft_delete_retention_days = \"example-value\"\n}\nresource \"azurerm_key_vault_access_policy\" \"example\" {\n key_vault_id = azurerm_key_vault.example.id\n tenant_id = data.azurerm_client_config.example.tenant_id\n object_id = data.azurerm_client_config.example.object_id\n key_permissions = \"example-value\"\n}\nresource \"azurerm_kubernetes_cluster\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n dns_prefix = \"acctestaksexample\"\n default_node_pool {\n name = \"example-value\"\n node_count = \"example-value\"\n vm_size = \"example-value\"\n }\n identity {\n type = \"example-value\"\n }\n}\nresource \"azurerm_machine_learning_workspace\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n key_vault_id = azurerm_key_vault.example.id\n storage_account_id = azurerm_storage_account.example.id\n application_insights_id = azurerm_application_insights.example.id\n identity {\n type = \"example-value\"\n }\n}\nresource \"azurerm_resource_group\" \"example\" {\n name = \"example-resources\"\n location = \"West Europe\"\n}\nresource \"azurerm_storage_account\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n account_tier = \"example-value\"\n account_replication_type = \"example-value\"\n}\nresource \"azurerm_kubernetes_cluster_trusted_access_role_binding\" \"example\" {\n kubernetes_cluster_id = azurerm_kubernetes_cluster.example.id\n name = \"example\"\n roles = \"example-value\"\n source_resource_id = azurerm_machine_learning_workspace.example.id\n}\n",
16+
"exampleUsage": "\nresource \"azurerm_application_insights\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n application_type = \"web\"\n}\ndata \"azurerm_client_config\" \"test\" {}\nresource \"azurerm_key_vault\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n tenant_id = data.azurerm_client_config.example.tenant_id\n sku_name = \"standard\"\n soft_delete_retention_days = 7\n}\nresource \"azurerm_key_vault_access_policy\" \"example\" {\n key_vault_id = azurerm_key_vault.example.id\n tenant_id = data.azurerm_client_config.example.tenant_id\n object_id = data.azurerm_client_config.example.object_id\n key_permissions = [\n \"Create\",\n \"Get\",\n \"Delete\",\n \"Purge\",\n \"GetRotationPolicy\",\n ]\n}\nresource \"azurerm_kubernetes_cluster\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n dns_prefix = \"acctestaksexample\"\n default_node_pool {\n name = \"default\"\n node_count = 1\n vm_size = \"Standard_DS2_v2\"\n }\n identity {\n type = \"SystemAssigned\"\n }\n}\nresource \"azurerm_machine_learning_workspace\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n key_vault_id = azurerm_key_vault.example.id\n storage_account_id = azurerm_storage_account.example.id\n application_insights_id = azurerm_application_insights.example.id\n identity {\n type = \"SystemAssigned\"\n }\n}\nresource \"azurerm_resource_group\" \"example\" {\n name = \"example-resources\"\n location = \"West Europe\"\n}\nresource \"azurerm_storage_account\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n account_tier = \"Standard\"\n account_replication_type = \"LRS\"\n}\nresource \"azurerm_kubernetes_cluster_trusted_access_role_binding\" \"example\" {\n kubernetes_cluster_id = azurerm_kubernetes_cluster.example.id\n name = \"example\"\n roles = [\"Microsoft.MachineLearningServices/workspaces/mlworkload\"]\n source_resource_id = azurerm_machine_learning_workspace.example.id\n}\n",
1717
"generate": true,
1818
"generateIdValidationFunction": true,
1919
"generateModel": true,

Diff for: api-definitions/resource-manager/ContainerService/Terraform/KubernetesFleetMember-Resource.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
},
1414
"description": "Manages a Kubernetes Fleet Member",
1515
"displayName": "Kubernetes Fleet Member",
16-
"exampleUsage": "\nresource \"azurerm_kubernetes_cluster\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n dns_prefix = \"acctestaksexample\"\n default_node_pool {\n name = \"example-value\"\n node_count = \"example-value\"\n vm_size = \"example-value\"\n }\n identity {\n type = \"example-value\"\n }\n}\nresource \"azurerm_kubernetes_fleet_manager\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n}\nresource \"azurerm_resource_group\" \"example\" {\n name = \"example-resources\"\n location = \"West Europe\"\n}\nresource \"azurerm_kubernetes_fleet_member\" \"example\" {\n kubernetes_cluster_id = azurerm_kubernetes_cluster.example.id\n kubernetes_fleet_id = azurerm_kubernetes_fleet_manager.example.id\n name = \"example\"\n}\n",
16+
"exampleUsage": "\nresource \"azurerm_kubernetes_cluster\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n dns_prefix = \"acctestaksexample\"\n default_node_pool {\n name = \"default\"\n node_count = 1\n vm_size = \"Standard_DS2_v2\"\n }\n identity {\n type = \"SystemAssigned\"\n }\n}\nresource \"azurerm_kubernetes_fleet_manager\" \"example\" {\n name = \"example\"\n location = azurerm_resource_group.example.location\n resource_group_name = azurerm_resource_group.example.name\n}\nresource \"azurerm_resource_group\" \"example\" {\n name = \"example-resources\"\n location = \"West Europe\"\n}\nresource \"azurerm_kubernetes_fleet_member\" \"example\" {\n kubernetes_cluster_id = azurerm_kubernetes_cluster.example.id\n kubernetes_fleet_id = azurerm_kubernetes_fleet_manager.example.id\n name = \"example\"\n}\n",
1717
"generate": true,
1818
"generateIdValidationFunction": true,
1919
"generateModel": true,

Diff for: api-definitions/resource-manager/DevCenter/Terraform/DevCenterProject-Resource.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
},
1414
"description": "Manages a Dev Center Project",
1515
"displayName": "Dev Center Project",
16-
"exampleUsage": "\nresource \"azurerm_dev_center\" \"example\" {\n name = \"example\"\n resource_group_name = azurerm_resource_group.example.name\n location = azurerm_resource_group.example.location\n identity {\n type = \"example-value\"\n }\n}\nresource \"azurerm_resource_group\" \"example\" {\n name = \"example-resources\"\n location = \"West Europe\"\n}\nresource \"azurerm_dev_center_project\" \"example\" {\n dev_center_id = azurerm_dev_center.example.id\n location = azurerm_resource_group.example.location\n name = \"example\"\n resource_group_name = azurerm_resource_group.example.name\n}\n",
16+
"exampleUsage": "\nresource \"azurerm_dev_center\" \"example\" {\n name = \"example\"\n resource_group_name = azurerm_resource_group.example.name\n location = azurerm_resource_group.example.location\n identity {\n type = \"SystemAssigned\"\n }\n}\nresource \"azurerm_resource_group\" \"example\" {\n name = \"example-resources\"\n location = \"West Europe\"\n}\nresource \"azurerm_dev_center_project\" \"example\" {\n dev_center_id = azurerm_dev_center.example.id\n location = azurerm_resource_group.example.location\n name = \"example\"\n resource_group_name = azurerm_resource_group.example.name\n}\n",
1717
"generate": true,
1818
"generateIdValidationFunction": true,
1919
"generateModel": true,

Diff for: tools/importer-rest-api-specs/components/terraform/examples/resource_test.go

+82
Original file line numberDiff line numberDiff line change
@@ -113,3 +113,85 @@ resource "azurerm_load_test" "example" {
113113
}
114114
testhelpers.AssertTemplatedCodeMatches(t, expected, *actual)
115115
}
116+
117+
func TestResourceExampleFromTests_WithTemplate_FleetMember(t *testing.T) {
118+
input := resourcemanager.TerraformResourceTestsDefinition{
119+
BasicConfiguration: `
120+
resource "azurerm_kubernetes_fleet_member" "test" {
121+
kubernetes_cluster_id = azurerm_kubernetes_cluster.test.id
122+
kubernetes_fleet_id = azurerm_kubernetes_fleet_manager.test.id
123+
name = "acctestkfm-${var.random_string}"
124+
}
125+
`,
126+
TemplateConfiguration: pointer.To(`
127+
variable "primary_location" {}
128+
variable "random_integer" {}
129+
variable "random_string" {}
130+
131+
resource "azurerm_kubernetes_cluster" "test" {
132+
name = "acctestaks${var.random_string}"
133+
location = azurerm_resource_group.test.location
134+
resource_group_name = azurerm_resource_group.test.name
135+
dns_prefix = "acctestaks${var.random_string}"
136+
137+
default_node_pool {
138+
name = "default"
139+
node_count = 1
140+
vm_size = "Standard_DS2_v2"
141+
}
142+
143+
identity {
144+
type = "SystemAssigned"
145+
}
146+
}
147+
148+
149+
resource "azurerm_kubernetes_fleet_manager" "test" {
150+
name = "acctestkfm${var.random_string}"
151+
location = azurerm_resource_group.test.location
152+
resource_group_name = azurerm_resource_group.test.name
153+
}
154+
155+
156+
resource "azurerm_resource_group" "test" {
157+
name = "acctestrg-${var.random_integer}"
158+
location = var.primary_location
159+
}
160+
`),
161+
}
162+
expected := `
163+
resource "azurerm_kubernetes_cluster" "example" {
164+
name = "example"
165+
location = azurerm_resource_group.example.location
166+
resource_group_name = azurerm_resource_group.example.name
167+
dns_prefix = "acctestaksexample"
168+
default_node_pool {
169+
name = "default"
170+
node_count = 1
171+
vm_size = "Standard_DS2_v2"
172+
}
173+
identity {
174+
type = "SystemAssigned"
175+
}
176+
}
177+
resource "azurerm_kubernetes_fleet_manager" "example" {
178+
name = "example"
179+
location = azurerm_resource_group.example.location
180+
resource_group_name = azurerm_resource_group.example.name
181+
}
182+
resource "azurerm_resource_group" "example" {
183+
name = "example-resources"
184+
location = "West Europe"
185+
}
186+
resource "azurerm_kubernetes_fleet_member" "example" {
187+
kubernetes_cluster_id = azurerm_kubernetes_cluster.example.id
188+
kubernetes_fleet_id = azurerm_kubernetes_fleet_manager.example.id
189+
name = "example"
190+
}
191+
`
192+
actual, err := ResourceExampleFromTests(input)
193+
if err != nil {
194+
t.Fatalf(err.Error())
195+
}
196+
testhelpers.AssertTemplatedCodeMatches(t, expected, *actual)
197+
}

Diff for: tools/importer-rest-api-specs/components/terraform/examples/variable_replacements.go

+1-2
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,5 @@ func updatedValueForAttribute(resourceKey, fieldKey string, value string) (*hclw
7575
return &updatedValue, nil
7676
}
7777

78-
out := hclwrite.TokensForValue(cty.StringVal("example-value"))
79-
return &out, nil
78+
return nil, nil
8079
}

0 commit comments

Comments
 (0)