resilien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
2,752 Commits 1 Branch 0 Tags 185 MiB
Go 99.3%
HTML 0.6%
Go to file
Emil Hessman 65878791c0 Makefile: add vet target 
Add a vet target in order to catch suspicious constructs
reported by go vet.

Vet has successfully detected problems in the past,
for example, see

  482460c4c8
  fc36b1cd94
  68a41035a9
  7b704fb77d
  4f3f85b165
  95fa353ee9
  4bfe18b40d

Some vet flags are noisy. In particular, the following flags
reports a large amount of generally unharmful constructs:

  -assign: check for useless assignments
  -composites: check that composite literals used field-keyed
               elements
  -shadow: check for shadowed variables
  -shadowstrict: whether to be strict about shadowing
  -unreachable: check for unreachable code

In order to skip running the flags mentioned above, vet is
invoked on a directory basis with 'go tool vet .' since package-
level type-checking with 'go vet' doesn't accept flags.

Hence, each file is vetted in isolation, which is weaker than
package-level type-checking. But nevertheless, it might catch
suspicious constructs that pose a real problem.

The vet target runs the following flags on the entire repo:

  -asmdecl: check assembly against Go declarations
  -atomic: check for common mistaken usages of the
           sync/atomic package
  -bool: check for mistakes involving boolean operators
  -buildtags: check that +build tags are valid
  -copylocks: check that locks are not passed by value
  -methods: check that canonically named methods are canonically
            defined
  -nilfunc: check for comparisons between functions and nil
  -printf: check printf-like invocations
  -rangeloops: check that range loop variables are used correctly
  -shift: check for useless shifts
  -structtags: check that struct field tags have canonical format
               and apply to exported fields as needed
  -unsafeptr: check for misuse of unsafe.Pointer

Now and then, it might make sense to check the output of

VETARGS=-unreachable make vet

manually, just in case it detects several lines of dead code etc.
 		2015-01-16 22:20:32 +01:00
builtin Move duplicated envDefaultFunc out of each provider and into Schema. 2015-01-16 17:25:39 +00:00
command command/apply: ask for user variables before validation [GH-736] 2015-01-16 10:46:38 -08:00
config config/lang: verify single quotes syntax error [GH-613] 2015-01-16 10:28:00 -08:00
contrib/zsh-completion Add zsh completion support 2015-01-16 00:34:32 -08:00
depgraph depgraph: Adding method to get incoming edges 2014-09-30 11:20:15 -07:00
digraph Fix TestWriteDot random order error 2014-07-29 10:26:50 -07:00
examples fix invalid mixing of hcl and json 2015-01-09 11:43:29 +11:00
flatmap flatmap: never auto-convert ints 2014-07-24 11:41:01 -07:00
helper Merge pull request #766 from hashicorp/f-exists-api 2015-01-16 10:56:25 -08:00
plugin plugin: Client/Server uses new RPC client/server 2014-09-28 11:19:24 -07:00
remote Switch to github.com/hashicorp/consul/api 2015-01-06 17:11:29 -08:00
rpc rpc: implement provisioner update 2014-10-04 09:54:03 -07:00
scripts quote $DIR to allow $GOPATH to include spaces 2014-11-25 15:26:41 -08:00
terraform terraform: fix bug with crash with no providers [GH-786] 2015-01-16 09:56:51 -08:00
test-fixtures Remove all traces of libucl 2014-08-19 09:57:04 -07:00
website Merge pull request #766 from hashicorp/f-exists-api 2015-01-16 10:56:25 -08:00
.gitignore config: remove unused files 2015-01-13 10:32:03 -08:00
.travis.yml Just test GO 1.4 2015-01-10 15:54:49 -08:00
CHANGELOG.md update CHANGELOG 2015-01-16 10:57:21 -08:00
CONTRIBUTING.md mention dev Vagrant VM in CONTRIBUTING.md 2014-12-02 16:15:25 -08:00
LICENSE Adding license 2014-07-28 13:54:06 -04:00
Makefile Makefile: add vet target 2015-01-16 22:20:32 +01:00
README.md Now Go version must be at least 1.4 2015-01-14 23:51:02 +01:00
Vagrantfile Consistent ordering of arguments for apt-get commands 2014-09-14 01:31:36 +02:00
checkpoint.go Add checkpoint 2014-10-13 14:05:43 -07:00
commands.go command/remote: Adding skeleton 2014-12-10 13:27:08 -08:00
config.go Add checkpoint 2014-10-13 14:05:43 -07:00
config_test.go Update config test to handle provisioners 2014-07-10 11:38:57 -07:00
config_unix.go config looks in a plugin directory if it exists 2014-09-27 12:36:13 -07:00
config_windows.go config looks in a plugin directory if it exists 2014-09-27 12:36:13 -07:00
log.go fmt 2014-10-10 14:50:35 -07:00
main.go Log the version info for easier debugging 2014-10-20 22:32:00 -07:00
panic.go Setup panicwrap 2014-05-30 16:07:26 -07:00
version.go up version for development 2015-01-06 16:32:47 -08:00

README.md

Terraform

Terraform

Terraform is a tool for building, changing, and versioning infrastructure safely and efficiently. Terraform can manage existing and popular service providers as well as custom in-house solutions.

The key features of Terraform are:

  • Infrastructure as Code: Infrastructure is described using a high-level configuration syntax. This allows a blueprint of your datacenter to be versioned and treated as you would any other code. Additionally, infrastructure can be shared and re-used.

  • Execution Plans: Terraform has a "planning" step where it generates an execution plan. The execution plan shows what Terraform will do when you call apply. This lets you avoid any surprises when Terraform manipulates infrastructure.

  • Resource Graph: Terraform builds a graph of all your resources, and parallelizes the creation and modification of any non-dependent resources. Because of this, Terraform builds infrastructure as efficiently as possible, and operators get insight into dependencies in their infrastructure.

  • Change Automation: Complex changesets can be applied to your infrastructure with minimal human interaction. With the previously mentioned execution plan and resource graph, you know exactly what Terraform will change and in what order, avoiding many possible human errors.

For more information, see the introduction section of the Terraform website.

Getting Started & Documentation

All documentation is available on the Terraform website.

Developing Terraform

If you wish to work on Terraform itself or any of its built-in providers, you'll first need Go installed on your machine (version 1.4+ is required). Alternatively, you can use the Vagrantfile in the root of this repo to stand up a virtual machine with the appropriate dev tooling already set up for you.

For local dev first make sure Go is properly installed, including setting up a GOPATH. Next, install the following software packages, which are 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. Install the necessary dependencies by running make updatedeps and then just type make. This will compile some more dependencies and then run the tests. If this exits with exit status 0, then everything is working!

$ make updatedeps
...
$ make
...

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

$ 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, onlyterraform 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.