tfxjs

tfxjs is a terrafrom acceptance test framework built with mocha and chai to allow users to quickly and easily create acceptance tests for terraform templates.

View on Github.

Table of Contents

1. Installation
2. Prerequisites
3. Usage
4. Example Usage
5. Methods
6. Contributing
7. Code Test Coverage

Installation

npm install tfxjs -g

Prerequisites

• Terraform CLI
• If mocha is not installed globally run:

npm install mocha -g

Usage

tfx <path to test file>

Example Usage

For a detailed example of using this framework, see example tests

Example File

const tfxjs = require("tfxjs"); // Initialize tfxjs
const tfx = new tfxjs(" <path to template directory> ", {
  my_tf_value_1 : "<data>", // export variable data to template directory
  my_tf_value_2 : "<data>"
}); // Create a new constructor for terraform teplate

tfx.plan("MyModule", () => { // Gerate a plan in the directory
  // Run tests for the module
  tfx.module(
    "Root Module", // decorative module name
    "module.my_module", // module address
    tfx.resource(
      "Activity Tracker Route", // Name of the resource (decorative)
      "ibm_atracker_route.atracker_route", // Expected address within module
      // values to check in that resource
      { 
        name: "tfx-atracker-route",
        receive_global_events: true,
      },
    ),
    ...
  );
});

Example Output

* tfxjs testing

##############################################################################
# 
#  Running `terraform plan`
#  Teplate File:
#     < your file path >
# 
##############################################################################



  MyModule

    ✔ Successfully generates a terraform plan file
    ✔ module.my_module should not contain additional resources

  Module Root Module
    ✔ Plan should contain the module module.my_module
    Activity Tracker Route
      ✔ Module module.my_module should contain resource ibm_atracker_route.atracker_route
      ✔ Activity Tracker Route should have the correct name value
      ✔ Activity Tracker Route should have the correct receive_global_events value


  5 passing (7s)

Methods

For detailed use of the methods see the documentation here.

Contributing

If you have any questions or issues you can create a new [issue here][issues]. See the full contribution guidelines here.

Pull requests are very welcome! Make sure your patches are well tested. Ideally create a topic branch for every separate change you make. For example:

1. Fork the repo
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Code Test Coverage

This module uses nyc for unit test coverage.

To get test coverage, run the command

npm run coverage

End to End Tests

To run end-to-end tests, use the following command

tfx e2e-tests/

Current Test Coverage