Categorygithub.com/hashicorp/terraform-plugin-test/v2
modulepackage
2.2.1
Repository: https://github.com/hashicorp/terraform-plugin-test.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
14
Dependents
2
Files
620 SLOC

# README

ARCHIVED: This project has been merged into terraform-plugin-sdk as the plugintest package.

Terraform Plugin Test Helper Library

This is an experimental library for testing Terraform plugins in their natural habitat as child processes of a real terraform executable.

# Functions

AcceptanceTest is a test guard that will produce a log and call SkipNow on the given TestControl if the environment variable TF_ACC isn't set to indicate that the caller wants to run acceptance tests.
AutoInitHelper uses the auto-discovery behavior of DiscoverConfig to prepare a configuration and then calls InitHelper with it.
AutoInitProviderHelper is the main entrypoint for testing provider plugins using this package.
DiscoverConfig uses environment variables and other means to automatically discover a reasonable test helper configuration.
InitHelper prepares a testing helper with the given configuration.
LongTest is a test guard that will produce a log and call SkipNow on the given TestControl if the test harness is currently running in "short mode".
RunningAsPlugin returns true if it detects the usual Terraform plugin detection environment variables, suggesting that the current process is being launched as a plugin server.

# Constants

No description provided by the author
No description provided by the author

# Structs

Config is used to configure the test helper.
Helper is intended as a per-package singleton created in TestMain which other tests in a package can use to create Terraform execution contexts.
WorkingDir represents a distinct working directory that can be used for running tests.

# Interfaces

TestControl is an interface requiring a subset of *testing.T which is used by the test guards and helpers in this package.