Go to file
Mitchell Hashimoto 53ebc5cb51 rpc: fix interface impl 2014-07-22 10:36:37 -07:00
builtin provider/aws: Adding support for aws_s3_bucket 2014-07-21 14:34:50 -04:00
command command: -var-file works 2014-07-18 14:00:40 -07:00
config config: tests 2014-07-22 08:53:03 -07:00
depgraph terraform: turn multi-counts into multiple nodes 2014-07-03 20:42:29 -07:00
digraph digraph: fix docs 2014-07-14 12:10:26 -07:00
flatmap fmt 2014-07-14 21:56:34 -07:00
helper terraform: more test cases 2014-07-22 08:27:16 -07:00
plugin plugin: Adding support for provisioners 2014-07-10 11:38:56 -07:00
rpc rpc: fix interface impl 2014-07-22 10:36:37 -07:00
scripts scripts: unix line endings 2014-06-26 10:07:31 -07:00
terraform terraform: strict checks for state not being nil 2014-07-22 10:31:47 -07:00
test-fixtures main: add main config 2014-05-25 17:39:44 -07:00
website website: remove of a bunch of consul images 2014-07-16 17:57:25 -04:00
.gitignore Add tfplan to gitignore 2014-07-11 22:05:13 -07:00
Makefile testrace won't run acceptance tests 2014-07-10 13:33:57 -07:00
README.md Update README.md 2014-07-14 21:01:23 -07:00
TODO.md Update TODO 2014-07-21 06:10:28 -07:00
commands.go Always enable color on Windows since tty check doesn't work well 2014-07-17 09:50:58 -07:00
config.go providers/digitalocean: initial commit 2014-07-18 20:20:28 -04:00
config_test.go Update config test to handle provisioners 2014-07-10 11:38:57 -07:00
log.go Setup panicwrap 2014-05-30 16:07:26 -07:00
main.go Recognize -version 2014-07-13 10:37:25 -07:00
panic.go Setup panicwrap 2014-05-30 16:07:26 -07:00
version.go Implement CLI, version command 2014-05-24 12:04:43 -07:00

README.md

Terraform

Terraform is a tool for building and changing infrastructure safely and efficiently.

Developing Terraform

If you wish to work on Terraform itself or any of its built-in providers, you'll first need Go installed (version 1.2+ is required). Make sure Go is properly installed, including setting up a GOPATH. Make sure Go is compiled with cgo support. You can verify this by running go env and checking that CGOENABLED is set to "1".

Next, install Git, which is needed for some dependencies.

Then, install Gox, which is used as a compilation tool on top of Go:

$ go get -u github.com/mitchellh/gox

Next, clone this repository into $GOPATH/src/github.com/hashicorp/terraform and then just type make. This will compile some dependencies and then run the tests. If this exits with exit status 0, then everything is working!

$ make
...

To compile a development version of Terraform and the built-in plugins, run make dev. This will put Terraform binaries in the bin folder:

$ make dev
...
$ bin/terraform
...

If you're developing a specific package, you can run tests for just that package by specifying the TEST variable. For example below, only terraform package tests will be run.

$ make test TEST=./terraform
...

Acceptance Tests

Terraform also has a comprehensive acceptance test suite covering most of the major features of the built-in providers.

If you're working on a feature of a provider and want to verify it is functioning (and hasn't broken anything else), we recommend running the acceptance tests. Note that we do not require that you run or write acceptance tests to have a PR accepted. The acceptance tests are just here for your convenience.

Warning: The acceptance tests create/destroy/modify real resources, which may incur real costs. In the presence of a bug, it is technically possible that broken providers could corrupt existing infrastructure as well. Therefore, please run the acceptance providers at your own risk. At the very least, we recommend running them in their own private account for whatever provider you're testing.

To run the acceptance tests, invoke make testacc:

$ make testacc TEST=./builtin/providers/aws TESTARGS='-run=VPC'
...

The TEST variable is required, and you should specify the folder where the provider is. The TESTARGS variable is recommended to filter down to a specific resource to test, since testing all of them at once can take a very long time.

Acceptance tests typically require other environment variables to be set for things such as access keys. The provider itself should error early and tell you what to set, so it is not documented here.