Add Terratest Example for Compute Module

.gitignore

@@ -9,7 +9,7 @@ terraform.tfvars
 
 # Module directory
 .terraform/
-
+.test-data/
 
 ### https://raw.github.com/github/gitignore/abad92dac5a4306f72242dae3bca6e277bce3615/Global/Vim.gitignore
 

Dockerfile

@@ -1,5 +1,5 @@
 # Pull the base image with given version.
-ARG BUILD_TERRAFORM_VERSION="0.11.1"
+ARG BUILD_TERRAFORM_VERSION="0.11.3"
 FROM microsoft/terraform-test:${BUILD_TERRAFORM_VERSION}
 
 ARG MODULE_NAME="terraform-azurerm-compute"
@@ -20,10 +20,25 @@ ENV ARM_TENANT_ID=${BUILD_ARM_TENANT_ID}
 ENV ARM_TEST_LOCATION=${BUILD_ARM_TEST_LOCATION}
 ENV ARM_TEST_LOCATION_ALT=${BUILD_ARM_TEST_LOCATION_ALT}
 
+# Set work directory and generate ssh key
 RUN mkdir /usr/src/${MODULE_NAME}
 COPY . /usr/src/${MODULE_NAME}
-
+WORKDIR /usr/src/${MODULE_NAME}
 RUN ssh-keygen -q -t rsa -b 4096 -f $HOME/.ssh/id_rsa
 
-WORKDIR /usr/src/${MODULE_NAME}
+# Install new version of terraform and golang
+RUN wget https://releases.hashicorp.com/terraform/0.11.7/terraform_0.11.7_linux_amd64.zip >/dev/null 2>&1
+RUN unzip terraform_0.11.7_linux_amd64.zip >/dev/null
+RUN wget https://storage.googleapis.com/golang/go1.10.3.linux-amd64.tar.gz >/dev/null 2>&1
+RUN tar -zxvf go1.10.3.linux-amd64.tar.gz -C /usr/local/ >/dev/null
+RUN mv terraform /usr/local/bin
+
+# Install required go packages
+ENV GOPATH $HOME/go
+ENV PATH /usr/local/go/bin:$PATH
+RUN /bin/bash -c "go get github.com/gruntwork-io/terratest/modules/ssh"
+RUN /bin/bash -c "go get github.com/gruntwork-io/terratest/modules/retry"
+RUN /bin/bash -c "go get github.com/gruntwork-io/terratest/modules/terraform"
+RUN /bin/bash -c "go get github.com/gruntwork-io/terratest/modules/test-structure"
+
 RUN ["bundle", "install", "--gemfile", "./Gemfile"]

Gemfile

@@ -6,6 +6,4 @@ group :test do
   git 'https://github.com/Azure/terramodtest.git' do
     gem 'terramodtest', :tag => 'v0.2.0'
   end
-  gem 'test-kitchen', '1.16.0'
-  gem 'kitchen-terraform', '3.0.0'
 end

README.md

@@ -1,8 +1,8 @@
-# terraform-azurerm-compute #
-[![Build Status](https://travis-ci.org/Azure/terraform-azurerm-compute.svg?branch=master)](https://travis-ci.org/Azure/terraform-azurerm-compute)
+# terraform-azurerm-compute
 
-Deploys 1+ Virtual Machines to your provided VNet
-=================================================
+[![Build Status](https://travis-ci.org/foreverXZC/terraform-azurerm-compute.svg?branch=master)](https://travis-ci.org/foreverXZC/terraform-azurerm-compute)
+
+## Deploys 1+ Virtual Machines to your provided VNet
 
 This Terraform module deploys Virtual Machines in Azure with the following characteristics:
 
@@ -14,8 +14,7 @@ This Terraform module deploys Virtual Machines in Azure with the following chara
 
 > Note: Terraform module registry is incorrect in the number of required parameters since it only deems required based on variables with non-existent values.  The actual minimum required variables depends on the configuration and is specified below in the usage.
 
-Simple Usage
------
+## Simple Usage
 
 This contains the bare minimum options to be configured for the VM to be provisioned.  The entire code block provisions a Windows and a Linux VM, but feel free to delete one or the other and corresponding outputs. The outputs are also not necessary to provision, but included to make it convenient to know the address to connect to the VMs after provisioning completes.
 
@@ -58,8 +57,7 @@ Provisions an Ubuntu Server 16.04-LTS VM and a Windows 2016 Datacenter Server VM
   }
 ```
 
-Advanced Usage
------
+## Advanced Usage
 
 The following example illustrates some of the configuration options available to deploy a virtual machine. Feel free to remove the Linux or Windows modules and corresponding outputs.
 
@@ -81,7 +79,7 @@ More specifically this provisions:
 - Two Public IP addresses (one for each VM)
 - Opens up port 3389 for RDP access using the password as shown
 
-```hcl 
+```hcl
   module "linuxservers" {
     source              = "Azure/compute/azurerm"
     resource_group_name = "terraform-advancedvms"
@@ -149,10 +147,10 @@ More specifically this provisions:
 
 ```
 
-Test
------
+## Test
 
 ### Configurations
+
 - [Configure Terraform for Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/terraform-install-configure)
 - [Generate and add SSH Key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/) Save the key in ~/.ssh/id_rsa.  This is not required for Windows deployments.
 
@@ -161,9 +159,11 @@ We provide 2 ways to build, run, and test the module on a local development mach
 ### Native (Mac/Linux)
 
 #### Prerequisites
+
 - [Ruby **(~> 2.3)**](https://www.ruby-lang.org/en/downloads/)
 - [Bundler **(~> 1.15)**](https://bundler.io/)
-- [Terraform **(~> 0.11.0)**](https://www.terraform.io/downloads.html)
+- [Terraform **(~> 0.11.7)**](https://www.terraform.io/downloads.html)
+- [Golang **(~> 1.10.3)**](https://golang.org/dl/)
 
 #### Quick Run
 
@@ -173,7 +173,16 @@ We provide simple script to quickly set up module development environment:
 $ curl -sSL https://raw.githubusercontent.com/Azure/terramodtest/master/tool/env_setup.sh | sudo bash
 ```
 
-Then simply run it in local shell:
+Then use dep ensure to install go packages:
+
+```sh
+$ cd $GOPATH/src/{directory_name}/test/compute
+$ dep ensure
+$ cd ../..
+```
+
+Finally simply run it in local shell:
+
 ```sh
 $ bundle install
 $ rake build
@@ -184,7 +193,7 @@ $ rake e2e
 
 We provide a Dockerfile to build a new image based `FROM` the `microsoft/terraform-test` Docker hub image which adds additional tools / packages specific for this module (see Custom Image section).  Alternatively use only the `microsoft/terraform-test` Docker hub image [by using these instructions](https://github.com/Azure/terraform-test).
 
-#### Prerequisites
+#### Prerequisites (Docker)
 
 - [Docker](https://www.docker.com/community-edition#/download)
 
@@ -208,11 +217,16 @@ This runs the end to end tests:
 $ docker run --rm azure-compute /bin/bash -c "bundle install && rake e2e"
 ```
 
-Authors
-=======
+This runs the full tests:
+
+```sh
+$ docker run --rm azure-compute /bin/bash -c "bundle install && rake full"
+```
+
+## Authors
+
 Originally created by [David Tesar](http://github.com/dtzar)
 
-License
-=======
+## License
 
 [MIT](LICENSE)

Rakefile

@@ -6,13 +6,6 @@ require 'rspec/core/rake_task'
 require 'bundler/setup'
 require 'terramodtest'
 
-namespace :presteps do
-  task :clean_up do
-    clean_up_kitchen
-    clean_up_terraform
-  end
-end
-
 namespace :static do
   task :style do
     style_tf
@@ -26,21 +19,15 @@ namespace :static do
 end
 
 namespace :integration do
-  task :converge do
-    kitchen_converge
-  end
-  task :verify do
-    kitchen_verify
-  end
   task :test do
-    kitchen_test
-  end
-  task :destroy do
-    kitchen_destroy
+    success = system ("go test -v ./test/compute/ -timeout 20m -args azureuser ~/.ssh/id_rsa")
+    if not success 
+      raise "ERROR: Go test failed!\n".red
+    end
   end
 end
 
-task :prereqs => [ 'presteps:clean_up' ]
+task :prereqs => []
 
 task :validate => [ 'static:style', 'static:lint' ]
 
@@ -54,4 +41,4 @@ task :e2e => [ 'integration:test' ]
 
 task :default => [ 'build' ]
 
-task :full => [ 'build', 'unit', 'e2e']
+task :full => [ 'build', 'unit', 'e2e' ]

test/README.md

@@ -0,0 +1,61 @@
+# Compute Example
+
+Use terraform azure module "compute" to deploy one or more virtual machines on azure. Then use terratest to ssh to virtual machines.
+
+## Fixture
+
+These terraform files enable users to deploy one or more virtual machines on azure, as well as virtual network. To use these files, you should provide path to ssh public key file in [fixture/terraform.tfvars](/test/fixture/terraform.tfvars). You can just test the infrastructure code manually without terratest.
+
+## Compute
+
+This folder includes only one file. [compute/terraform_ssh_example_test.go](/test/compute/terraform_ssh_example_test.go) is the go test file which represents the whole process of testing the module. First, it uses terraform compute module to deploy virtual machines on azure. After that, it calls functions from terratest ssh section, so as to ssh to these virtual machines and check whether they are running properly. Next, everything will be cleaned up after validation. Of course you can write your own test code, or even take advantage of deprecated methods. Finally, in order to make this program work, you should provide your own ssh private key.
+
+## Running this module manually
+
+1. Sign up for [Azure](https://portal.azure.com/).
+
+1. Configure your Azure credentials. For instance, you may use [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli) and execute `az login`.
+
+1. Install [Terraform](https://www.terraform.io/) and make sure it's on your `PATH`.
+
+1. Fill in blank of your ssh public key in [fixture/terraform.tfvars](/test/fixture/terraform.tfvars) and make sure your configuration is correct.
+
+1. Direct to folder [fixture](/test/fixture) and run `terraform init`.
+
+1. Run `terraform apply`.
+
+1. When you're done, run `terraform destroy`.
+
+## Running automated tests against this module
+
+1. Sign up for [Azure](https://portal.azure.com/).
+
+1. Configure your Azure credentials. For instance, you may use [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli) and execute `az login`.
+
+1. Install [Terraform](https://www.terraform.io/) and make sure it's on your `PATH`.
+
+1. Install [Golang](https://golang.org/) and make sure this code is checked out into your `GOPATH`.
+
+1. Fill in blank of your ssh public key in [fixture/terraform.tfvars](/test/fixture/terraform.tfvars) and make sure your configuration is correct.
+
+1. Direct to folder [compute](/test/compute) and make sure all packages are installed, such as executing `go get github.com/gruntwork-io/terratest/modules/terraform`, etc.
+
+1. Run `go test -timeout timelimit -args username path/to/your/private/key`. For example, `go test -timeout 20m -args azureuser id_rsa`. Be aware that `-timeout` is set to 10 minutes by default and can be omitted, but it should be defined before `-args`.
+
+## Postscript
+
+This is a universal manual which is written based on official terratest document. To test the compute module using Mac or Linux more conveniently or to take advantage of docker, you may refer to [README.md/Test](#test).
+
+## Reference
+
+[Terraform Azure Compute Module](https://registry.terraform.io/modules/Azure/compute/azurerm/)
+
+[Terratest SSH Source Code](https://github.com/gruntwork-io/terratest/blob/master/test/terraform_ssh_example_test.go)
+
+[SSH Golang Document](https://godoc.org/golang.org/x/crypto/ssh)
+
+[SSH Client Connection Example in Golang](http://blog.ralch.com/tutorial/golang-ssh-connection/)
+
+[Azure Linux Virtual Machine Document](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/)
+
+[Azure Virtual Network Document](https://docs.microsoft.com/en-us/azure/virtual-network/)