github.com/lukahartwig/terraform@v0.11.4-0.20180302171601-664391c254ea/command/e2etest/doc.go (about)

     1  // Package e2etest contains a small number of tests that run against a real
     2  // Terraform binary, compiled on the fly at the start of the test run.
     3  //
     4  // These tests help ensure that key end-to-end Terraform use-cases are working
     5  // for a real binary, whereas other tests always have at least _some_ amount
     6  // of test stubbing.
     7  //
     8  // The goal of this package is not to duplicate the functional testing done
     9  // in other packages but rather to fully exercise a few important workflows
    10  // in a realistic way.
    11  //
    12  // These tests can be used in two ways. The simplest way is to just run them
    13  // with "go test" as normal:
    14  //
    15  //     go test -v github.com/hashicorp/terraform/command/e2etest
    16  //
    17  // This will compile on the fly a Terraform binary and run the tests against
    18  // it.
    19  //
    20  // Alternatively, the make-archive.sh script can be used to produce a
    21  // self-contained zip file that can be shipped to another machine to run
    22  // the tests there without needing a locally-installed Go compiler. This
    23  // is primarily useful for testing cross-compiled builds. For more information,
    24  // see the commentary in make-archive.sh.
    25  //
    26  // The TF_ACC environment variable must be set for the tests to reach out
    27  // to external network services. Since these are end-to-end tests, only a
    28  // few very basic tests can execute without this environment variable set.
    29  package e2etest