terraform-test

DevOps Community

Repo stars 0
Author repo skills-registry

Interpretation is structured for decision-making; original keeps the upstream SKILL.md unchanged.

Decide Fit First

Core job: WORKFLOW SKILL — Write and run Terraform tests (.tftest.hcl). WHEN: "create terraform test", "write tftest", ".tftest.hcl"…
Best fit: Use it when the task has reusable inputs, steps, and validation criteria rather than a one-off answer.
Avoid forcing it: If the source lacks commands, platform support, or external-service evidence, keep those fields unknown instead of guessing.

Design Intent

Structure: The skill is organized around “Quick Reference”, “File Structure”, “Test File Components”, “Canonical Example”, showing how the author expects the agent to judge fit, collect context, and produce verifiable output.
Trigger evidence: Prioritize the author’s wording around when to use it, what context to collect, and what output shape to produce.
Evidence boundary: Author text states facts, repository files prove commands and paths, and Fluxly only adds fit, limits, and usage judgment.

How To Use It

Inputs: Provide target material, scope, expected result, forbidden changes, and validation method.
Invocation: Name terraform-test directly; if the source includes slash commands, start with the command and then add task context.
Validation: Start small and check whether the result follows “Quick Reference / File Structure / Test File Components” before expanding.

Boundaries And Review

Dependencies: It usually needs no extra API key, so start with a small validation task.
Permissions: Declared permissions include read / write / shell-exec; ask the agent to state file, command, and rollback boundaries before acting.
Quality bar: A useful result names the deliverable, evidence, and next action. Generic prose means the task needs tighter context.

Terraform Test Skill

Write, organize, and run Terraform's built-in test framework for Azure infrastructure modules.

Reference: Terraform Testing Documentation

Quick Reference

Concept	Description	Min Version
Test file	`.tftest.hcl` in `tests/` directory	1.6
Run block	Single test scenario with assertions	1.6
Assert block	Condition that must be true for test to pass	1.6
Plan mode	`command = plan` — validates logic, no resources created	1.6
Apply mode	`command = apply` (default) — creates real infrastructure	1.6
Mock provider	Simulates provider without real API calls	1.7
Parallel execution	`parallel = true` on independent run blocks	1.9
Expect failures	Verify validation rules reject invalid input	1.6

File Structure

my-module/
├── main.tf
├── variables.tf
├── outputs.tf
└── tests/
    ├── defaults_unit_test.tftest.hcl        # Plan mode (fast)
    ├── validation_unit_test.tftest.hcl      # Plan mode (fast)
    └── full_stack_integration_test.tftest.hcl  # Apply mode (creates resources)

Naming convention: *_unit_test.tftest.hcl (plan mode), *_integration_test.tftest.hcl (apply mode).

Test File Components

0–1 test block (test-wide settings)
1+ run blocks (test scenarios, sequential by default)
0–1 variables block (file-level inputs, highest precedence)
0+ provider blocks (provider configuration)
0+ mock_provider blocks (simulated providers, TF 1.7+)

Canonical Example

See references/test-examples.md for a complete Azure Resource Group test (unit tests, tag validation, expect_failures).

Key Syntax Rules

Run Block Attributes

Attribute	Type	Default	Description
`command`	`plan`/`apply`	`apply`	Test mode
`variables`	block	—	Override file-level variables
`module`	block	—	Test alternate module (local/registry only)
`assert`	block (1+)	—	Validation conditions
`expect_failures`	list	—	Expected validation failures

Assert Syntax

assert {
  condition     = <boolean expression>
  error_message = "Human-readable failure description"
}

Assertions can reference: resource attributes, outputs, run.<name>.<output>, var.*, data sources. Variables precedence: run-block > file-level > all other sources. See references/test-examples.md for module blocks, plan options, and prior run references.

Mock Providers (TF 1.7+)

Simulate Azure provider without API calls — ideal for unit tests. Use mock_provider "azurerm" with mock_resource and mock_data blocks. When to use: Unit tests, CI without Azure credentials, fast local development. When NOT to use: Integration tests, validating actual Azure API behavior. See references/mock-providers.md for full mock patterns and examples.

Common Test Patterns

See references/test-examples.md for: conditional resources, tag validation, resource count with for_each, variables precedence, and prior run references.

Steps

terraform test                              # All tests
terraform test tests/defaults.tftest.hcl    # Specific file
terraform test -verbose                     # Detailed output
terraform test -filter=test_resource_group  # Filter by name
terraform test -no-cleanup                  # Debug: keep resources

Rules

Naming: *_unit_test.tftest.hcl / *_integration_test.tftest.hcl
Plan mode first: Use command = plan for fast, cost-free validation
Clear error messages: Describe what went wrong and expected state
Test isolation: Independent run blocks where possible
Variable coverage: Test multiple combinations for all code paths
Mock for speed: Use mock providers in CI without Azure access
Negative testing: Use expect_failures for validation rule coverage
Sequential only when needed: Only chain run blocks via run.<name> when required

Terraform MCP Integration

Use mcp_terraform_search_providers to validate that resource types used in test assertions exist in the target provider version.

Reference Index

File	Contents
`references/test-examples.md`	Canonical example, common patterns, variables, module blocks
`references/test-patterns.md`	Unit vs integration patterns, CI/CD examples, complex assertions
`references/mock-providers.md`	Mock provider setup, mock resources/data sources, override files
`references/test-execution.md`	CLI commands, parallel execution, verbose/debug, diagnostics

Source: aivandelindt/azure-agentic-infraops — distributed by TomeVault.

Fluxly profile Author and license come from source; runtime, permissions, and network are Fluxly detections or estimates

Fluxly category: DevOps
Author-declared agents: No explicit declaration found; this is not inferred or tested compatibility
Static check: 88 / 100 · heuristic scan, not runtime safety proof
Author / version / license: @tomevault-io · no license declared
Fluxly token estimate: Lean
Fluxly setup estimate: Guided setup
External API key: No requirement detected
Detected OS requirements: Unspecified
Runtime requirements: Unspecified
Detected file/system behavior: Read-only
Write / modify
Shell exec
Detected network behavior: Local-only
Install commands: None (reference only)

Profile is derived at build time from SKILL.md and install vectors. Subject to drift from author intent.

Heads up: 未限定 allowed-tools，默认拥有全部工具权限。

Output preview terraform-test.preview

# Canonical Example

See `references/test-examples.md` for a complete Azure Resource Group test (unit tests, tag validation, expect_failures).

SKILL.md SKILL.md

# Terraform Test Skill

Write, organize, and run Terraform's built-in test framework for Azure infrastructure modules.

**Reference:** [Terraform Testing Documentation](https://developer.hashicorp.com/terraform/language/tests)

---

## Quick Reference

| Concept            | Description                                               | Min Version |
| ------------------ | --------------------------------------------------------- | ----------- |
| Test file          | `.tftest.hcl` in `tests/` directory                       | 1.6         |
| Run block          | Single test scenario with assertions                      | 1.6         |
| Assert block       | Condition that must be true for test to pass              | 1.6         |
| Plan mode          | `command = plan` — validates logic, no resources created  | 1.6         |
| Apply mode         | `command = apply` (default) — creates real infrastructure | 1.6         |
| Mock provider      | Simulates provider without real API calls                 | 1.7         |
| Parallel execution | `parallel = true` on independent run blocks               | 1.9         |
| Expect failures    | Verify validation rules reject invalid input              | 1.6         |

## File Structure

```text
my-module/
├── main.tf
├── variables.tf
├── outputs.tf
└── tests/
    ├── defaults_unit_test.tftest.hcl        # Plan mode (fast)
    ├── validation_unit_test.tftest.hcl      # Plan mode (fast)
    └── full_stack_integration_test.tftest.hcl  # Apply mode (creates resources)
```

**Naming convention**: `*_unit_test.tftest.hcl` (plan mode), `*_integration_test.tftest.hcl` (apply mode).

## Test File Components

- **0–1** `test` block (test-wide settings)
- **1+** `run` blocks (test scenarios, sequential by default)

…

Evidence boundary and execution chain

Author text anchors workflow facts; Fluxly only indexes current sections, terms, files, and commands.

sections -> Quick Reference → File Structure → Test File Components → Canonical Example → Key Syntax Rules → Run Block Attributes
terms    -> Reference · Naming convention · 0–1 · 1+ · 0+ · When to use · When NOT to use · Naming
files/cmd -> .tftest.hcl · tests/ · command = plan · command = apply · parallel = true · unittest.tftest.hcl · integrationtest.tftest.hcl · test
body sha256 -> b9fab064687c