Update Test Generation: resource doc + OiCS (#15629)

Author: shuyama1

mmv1/provider/terraform_oics.go

@@ -75,7 +75,7 @@ func (toics TerraformOiCS) GenerateObject(object api.Resource, outputFolder, res
 	}
 }
 
-func (toics TerraformOiCS) GenerateResource(object api.Resource, templateData TemplateData, outputFolder string, generateCode, generateDocs bool) {
+func (toics TerraformOiCS) GenerateResourceLegacy(object api.Resource, templateData TemplateData, outputFolder string, generateCode, generateDocs bool) {
 	if !generateDocs {
 		return
 	}
@@ -119,6 +119,60 @@ func (toics TerraformOiCS) GenerateResource(object api.Resource, templateData Te
 	}
 }
 
+func (toics TerraformOiCS) GenerateResource(object api.Resource, templateData TemplateData, outputFolder string, generateCode, generateDocs bool) {
+	if object.Samples != nil && object.Examples != nil {
+		log.Fatalf("Both Samples and Examples block exist in %v", object.Name)
+	}
+	if object.Examples != nil {
+		toics.GenerateResourceLegacy(object, templateData, outputFolder, generateCode, generateDocs)
+		return
+	}
+
+	if !generateDocs {
+		return
+	}
+
+	for _, sample := range object.TestSamples() {
+		for _, step := range sample.NewConfigFuncs {
+			if len(step.TestEnvVars) > 0 {
+				continue
+			}
+
+			step.SetOiCSHCLText()
+
+			targetFolder := path.Join(outputFolder, step.Name)
+
+			if err := os.MkdirAll(targetFolder, os.ModePerm); err != nil {
+				log.Println(fmt.Errorf("error creating oics example directory %v: %v", targetFolder, err))
+			}
+
+			oicsExampleTemplatePath := "templates/terraform/samples/base_configs/oics_example_file.tf.tmpl"
+			oicsExampleTemplates := []string{
+				oicsExampleTemplatePath,
+			}
+			templateData.GenerateFile(path.Join(targetFolder, "main.tf"), oicsExampleTemplatePath, step, false, oicsExampleTemplates...)
+
+			tutorialTemplatePath := "templates/terraform/samples/base_configs/tutorial.md.tmpl"
+			tutorialTemplates := []string{
+				tutorialTemplatePath,
+			}
+			templateData.GenerateFile(path.Join(targetFolder, "tutorial.md"), tutorialTemplatePath, step, false, tutorialTemplates...)
+
+			backingTemplatePath := "templates/terraform/samples/base_configs/example_backing_file.tf.tmpl"
+			backingTemplates := []string{
+				backingTemplatePath,
+			}
+			templateData.GenerateFile(path.Join(targetFolder, "backing_file.tf"), backingTemplatePath, step, false, backingTemplates...)
+
+			motdTemplatePath := "templates/terraform/samples/static/motd.tmpl"
+			motdTemplates := []string{
+				motdTemplatePath,
+			}
+			templateData.GenerateFile(path.Join(targetFolder, "motd"), motdTemplatePath, step, false, motdTemplates...)
+		}
+	}
+}
+
 func (toics TerraformOiCS) CompileCommonFiles(outputFolder string, products []*api.Product, overridePath string) {
 
 }

mmv1/templates/terraform/resource.html.markdown.tmpl

@@ -41,7 +41,7 @@ To get more information about {{$.Name}}, see:
     * [{{$title}}]({{$link}})
 		{{- end }}
 	{{- end }}
-	{{- if gt (len $.Examples) 0}}
+	{{- if or (gt (len $.Examples) 0) (gt (len $.Samples) 0) }}
 {{ "" }}
 	{{- end }}
 {{- else }}
@@ -82,6 +82,28 @@ values will be stored in the raw state as plain text: {{ $.SensitivePropsToStrin
 	{{- end }}
 {{- end }}
 
+{{- if $.Samples }}
+	{{- range $sample := $.Samples }}
+		{{- range $step := $sample.Steps }}
+			{{- if not $step.ExcludeDocs }}
+				{{- if not (or $sample.ExcludeTest $step.TestEnvVars) }}
+<div class = "oics-button" style="float: right; margin: 0 0 -15px">
+  <a href="{{ $step.OiCSLink }}" target="_blank">
+    <img alt="Open in Cloud Shell" src="//gstatic.com/cloudssh/images/open-btn.svg" style="max-height: 44px; margin: 32px auto; max-width: 100%;">
+  </a>
+</div>
+				{{- end }}
+## Example Usage - {{ title (camelize $step.Name "upper" )}}
+
+
+```hcl
+{{ $step.DocumentationHCLText -}}
+	```
+			{{- end }}
+		{{- end }}
+	{{- end }}
+{{- end }}
+
 ## Argument Reference
 
 The following arguments are supported:

mmv1/templates/terraform/samples/base_configs/example_backing_file.tf.tmpl

@@ -0,0 +1,15 @@
+# This file has some scaffolding to make sure that names are unique and that
+# a region and zone are selected when you try to create your Terraform resources.
+
+locals {
+  name_suffix = "${random_pet.suffix.id}"
+}
+
+resource "random_pet" "suffix" {
+  length = 2
+}
+
+provider "google" {
+  region = "us-central1"
+  zone   = "us-central1-c"
+}

mmv1/templates/terraform/samples/base_configs/oics_example_file.tf.tmpl

@@ -0,0 +1 @@
+{{ $.OicsHCLText -}}

mmv1/templates/terraform/samples/base_configs/tutorial.md.tmpl

@@ -0,0 +1,79 @@
+# {{ title (camelize $.Name "upper") }} - Terraform
+
+## Setup
+
+<walkthrough-author name="[email protected]" analyticsId="UA-125550242-1" tutorialName="{{ underscore $.Name }}" repositoryUrl="https://github.com/terraform-google-modules/docs-examples"></walkthrough-author>
+
+Welcome to Terraform in Google Cloud Shell! We need you to let us know what project you'd like to use with Terraform.
+
+<walkthrough-project-billing-setup></walkthrough-project-billing-setup>
+
+Terraform provisions real GCP resources, so anything you create in this session will be billed against this project.
+
+## Terraforming!
+
+Let's use {{"{{"}}project-id{{"}}"}} with Terraform! Click the Cloud Shell icon below to copy the command
+to your shell, and then run it from the shell by pressing Enter/Return. Terraform will pick up
+the project name from the environment variable.
+
+```bash
+export GOOGLE_CLOUD_PROJECT={{"{{"}}project-id{{"}}"}}
+```
+
+After that, let's get Terraform started. Run the following to pull in the providers.
+
+```bash
+terraform init
+```
+
+With the providers downloaded and a project set, you're ready to use Terraform. Go ahead!
+
+```bash
+terraform apply
+```
+
+Terraform will show you what it plans to do, and prompt you to accept. Type "yes" to accept the plan.
+
+```bash
+yes
+```
+
+
+## Post-Apply
+
+### Editing your config
+
+Now you've provisioned your resources in GCP! If you run a "plan", you should see no changes needed.
+
+```bash
+terraform plan
+```
+
+So let's make a change! Try editing a number, or appending a value to the name in the editor. Then,
+run a 'plan' again.
+
+```bash
+terraform plan
+```
+
+Afterwards you can run an apply, which implicitly does a plan and shows you the intended changes
+at the 'yes' prompt.
+
+```bash
+terraform apply
+```
+
+```bash
+yes
+```
+
+## Cleanup
+
+Run the following to remove the resources Terraform provisioned:
+
+```bash
+terraform destroy
+```
+```bash
+yes
+```

mmv1/templates/terraform/samples/static/motd.tmpl

@@ -0,0 +1,7 @@
+===
+
+These examples use real resources that will be billed to the
+Google Cloud Platform project you use - so make sure that you
+run "terraform destroy" before quitting!
+
+===