Core functions with identical implementations for Terraform, OpenTofu, Terratest, and other software in the so-called Terra/Fu ecosystem.
While some of these can be implemented in HCL, some of them begin to push up against the limits of Terraform and the HCL2 configuration language. Exposing these functions as both a Go library as well as a Terraform/OpenTofu provider enables us to use the same functionality in both our Terraform/OpenTofu applies as well as while using a testing framework.
The goal of this provider is not to call any network APIs, but to provide pre-built functions in the form of Data Sources or Provider Functions.
View the list of issues, and give a thumbs-up to the ones you'd like to see. This is how we prioritize the work.
- We have automated testing that runs on every commit and every pull request.
- We intend for the Go libraries to work with all non-EOL versions of Go (i.e., current, current-1).
- Built using the Terraform Plugin Framework, which speaks Terraform Protocol v6.
| Testing type | Details | Description |
|---|---|---|
| integration | Terraform 1.0–1.13 | Executes the provider with this release, pulling from registry.terraform.io. |
| integration | OpenTofu 1.6–1.10 | Executes the provider with this release, pulling from registry.opentofu.org. |
| unit | Go 1.24–1.25 | Tests using these versions. |
| mutation | Go 1.24–1.25 | Tests using these versions. |
| fuzz | Go 1.24–1.25 | Tests using these versions. |
| terratest | Go 1.24–1.25 | Tests using these versions. |
See the docs/ directory for user-facing documentation.
If you are using this as a Go library, see the documentation at pkg.go.dev.
go get -u github.com/northwood-labs/terraform-provider-corefunc/v2/corefuncAfter the provider is installed, you can run terraform-provider-corefunc on the CLI.
- Install with either
terraform initormake build. - The Go binary path (discovered by running
./find-go-bin.sh) is on your$PATH.
This will display the following text:
terraform-provider-corefuncThis binary is a plugin. These are not meant to be executed directly.
Please execute the program that consumes these plugins, which will
load any plugins automatically
However, by passing the --help flag, you can see the other options available, including a description of the software.
terraform-provider-corefunc --helpWe've also bundled some CLI commands that you might find as useful as we have.
terraform-provider-corefunc json2toml file.json > file.tomlterraform-provider-corefunc toml2json file.toml > file.jsonNorthwood Labs takes testing seriously, and quality is a high priority for us. This software undergoes the following types of testing before every release.
- Unit testing of the Go library to ensure that the code behaves (and doesn't behave) as expected.
- Unit testing of the Go library’s documentation examples to ensure that the examples actually work.
- Mutation testing of the Go library to ensure that our tests are good at testing the code (as opposed to chasing code coverage).
- Acceptance testing of the provider (through both Terraform and OpenTofu) which uses table-driven testing to ensure that the inputs and expected outputs are correct.
- Terratest tests the provider using the same tools as one might use to test their own Terraform/OpenTofu modules.
- A very strict set of linting rules using golangci-lint.
- Fuzzing of the Go library which throws garbage at the code to ensure edge-cases don't slip through.
- We use the Bash Automated Testing System together with tfschema to ensure that nothing weird or unexpected occurs with the Terraform Plugin Protocol v6 between releases.
Supply-chain testing and validation. Some of these are on every commit, while a couple run before every release.
- Dependabot with auto-merging (by GitHub).
- Dependency Review (by GitHub).
- Go Dependency Submission (by GitHub).
- govulncheck (by the Go team).
- Harden-Runner (by StepSecurity).
- OSSF Scorecard (by OpenSSF).
- OSV Scanner (by Google).
- Trufflehog OSS (by Truffle Security).