Skip to content

docs(testing): update testing-validation.md to reflect actual test frameworks #144

Description

@WilliamBerryiii

Summary

The testing documentation (docs/contributing/testing-validation.md) references Terratest (Go-based) with go test examples, but the actual test implementation uses native terraform test with .tftest.hcl files. This discrepancy confuses contributors and misrepresents the testing approach.

Wave 0 — Foundation: This issue must merge before #145 so the test policy document references accurate frameworks.

Background

OSSF Passing Badge Criteria:

Current State:

  • docs/contributing/testing-validation.md (306 lines) references Terratest and go test
  • Actual tests use native terraform test with .tftest.hcl files
  • 15 components have tests following the native terraform test pattern
  • No Go files or Terratest dependencies exist in the repository

Acceptance Criteria

  • Terratest references and go test examples removed from testing-validation.md
  • Native terraform test patterns documented with .tftest.hcl examples
  • Examples reference actual test files from existing components (e.g., 000-resource-group)
  • Vitest documentation for JavaScript testing is current and accurate
  • Rust testing section added or updated (if not present)

Implementation Guidance

Update docs/contributing/testing-validation.md to:

  1. Replace Terratest section with native terraform test section
  2. Include example from src/000-cloud/000-resource-group/terraform/tests/
  3. Document npm run tf-test and npm run tf-test-all commands
  4. Verify JavaScript testing section references vitest correctly
  5. Add or update Rust testing section with cargo test patterns

Reference the actual test files in the repository for accurate examples.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions