mirror of https://github.com/hashicorp/vault.git synced 2026-04-03 12:52:15 +02:00

Vault Automation e47c5b5e39

UI: hackweek: add copilot instructions to ui repo (#8680 ) (#8728 )

* add copilot instructions to repository

use copilot resources example repo (https://github.com/hashicorp/copilot-resources/tree/main)

* address PR comments (https://github.com/hashicorp/vault/pull/31361)

Co-authored-by: Shannon Roberts (Beagin) <beagins@users.noreply.github.com>

2025-09-02 14:29:45 -07:00

1.2 KiB

Raw Blame History

applyTo, description

applyTo	description
*/_test.go,*/_spec.rb	Practical guidance for writing tests across languages

Philosophy & Principles

Testing:

Test coverage is not a metric to optimize for
Test behavior and not implementation detail
Write tests that are robust to refactoring the code under test

Value of a test

Test is code that needs to be maintained
If a test is not valuable, delete it

Tests are documentation

Use the given-when-then pattern to communicate each test case
Test names should express intent

Test Design & Quality

How to design reliable, maintainable tests

Test Isolation

A unit test should only fail for one reason
Do not share state between tests
Cleanup resources after the test
If files are needed, use a temp directory (in Go, prefer t.TempDir() for automatic cleanup)

Test Stability

Do not use sleeping in a test

Test Structure

Consider parametrized tests where it makes sense

Mocks

Preferably do not use mocks
If you use mocks, assert the mock expectations

Supporting Code Quality

Making the code under test more testable

Code under test

If the code relies on magic numbers or constants: Extract them
Consider introducing interfaces

1.2 KiB Raw Blame History