bashunit/.env.example at main · TypedDevs/bashunit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
################################################################################
# bashunit Configuration
# Copy this file to .env and customize as needed
# All values shown are defaults (leave empty to use default)
#
# Precedence: an entry left EMPTY here means "not configured", so a value the
# caller exported or set on the command line still wins
# (`BASHUNIT_OUTPUT_FORMAT=tap ./bashunit` keeps working). Give an entry a value
# and it takes effect for the project, overriding the ambient environment.
# Listing a name with no value is therefore safe and is how a setting is
# documented here.
################################################################################

#───────────────────────────────────────────────────────────────────────────────
# Test Discovery
#───────────────────────────────────────────────────────────────────────────────
BASHUNIT_DEFAULT_PATH=              # Default: tests
BASHUNIT_BOOTSTRAP=                 # Default: tests/bootstrap.sh
BASHUNIT_BOOTSTRAP_ARGS=            # Arguments passed to bootstrap script

#───────────────────────────────────────────────────────────────────────────────
# Output Display
#───────────────────────────────────────────────────────────────────────────────
BASHUNIT_SHOW_HEADER=               # Default: true
BASHUNIT_HEADER_ASCII_ART=          # Default: false
BASHUNIT_SIMPLE_OUTPUT=             # Default: false (use dots instead of test names)
BASHUNIT_VERBOSE=                   # Default: false (show environment variables)
BASHUNIT_NO_OUTPUT=                 # Default: false (suppress all output)
BASHUNIT_SHOW_EXECUTION_TIME=       # Default: auto (true|false|auto; auto skips per-test times when the clock forks)
BASHUNIT_SHOW_SKIPPED=              # Default: false (show skipped test details)
BASHUNIT_SHOW_INCOMPLETE=           # Default: false (show incomplete test details)
BASHUNIT_FAILURES_ONLY=             # Default: false (only show failures)
BASHUNIT_FAIL_ON_RISKY=             # Default: false (treat no-assertion tests as failed)
BASHUNIT_PROFILE=                   # Default: false (report slowest tests after a run)
BASHUNIT_PROFILE_COUNT=             # Default: 10 (how many slowest tests to report)
BASHUNIT_NO_COLOR=                  # Default: false (disable colors)
BASHUNIT_NO_DIFF=                   # Default: false (disable unified diff on multiline assert failures)
BASHUNIT_NO_PROGRESS=               # Default: false (suppress real-time progress, final results only)
BASHUNIT_SHOW_OUTPUT_ON_FAILURE=    # Default: true (show captured test output on failure)
BASHUNIT_OUTPUT_FORMAT=             # Default: empty (text; tap, json or junit go to stdout)
BASHUNIT_SNAPSHOT_PRUNE=            # Default: false (delete snapshot files no test resolved)
BASHUNIT_BENCH_BASELINE=            # Default: empty (bench: compare against this --report-json result)
BASHUNIT_BENCH_BASELINE_TOLERANCE=  # Default: 10 (bench: allowed regression percentage)
BASHUNIT_BENCH_BASELINE_UPDATE=     # Default: empty (bench: write this run as the new baseline)
BASHUNIT_BENCH_REPORT_JSON=         # Default: empty (bench: write machine-readable results to this file)
BASHUNIT_BENCH_REPORT_JUNIT=        # Default: empty (bench: write JUnit XML results to this file)
BASHUNIT_SANDBOX=                   # Default: false (fail tests that run unmocked external commands)
BASHUNIT_SANDBOX_ALLOW=             # Default: empty (extra commands the sandbox allows, comma separated)

#───────────────────────────────────────────────────────────────────────────────
# Test Execution
#───────────────────────────────────────────────────────────────────────────────
BASHUNIT_PARALLEL_RUN=              # Default: false
BASHUNIT_STOP_ON_FAILURE=           # Default: false (stop suite on first failure)
BASHUNIT_PASS_WITH_NO_TESTS=        # Default: false (exit 0 when the run selects no tests)
BASHUNIT_RERUN_FAILED=              # Default: false (replay only last run's failing tests)
BASHUNIT_ORDER_BY=                  # Default: defined (or defects, random)
BASHUNIT_FAIL_ON_FLAKY=             # Default: false (treat retry-passed tests as failed)
BASHUNIT_REPEAT=                    # Default: 1 (run each test N times)
BASHUNIT_GHA_ANNOTATIONS=           # Default: auto (or always, never)
BASHUNIT_REPORT_MD=                 # Default: empty (Markdown summary path)
BASHUNIT_CHANGED=                   # Default: false (run only test files changed since a git ref)
BASHUNIT_CHANGED_REF=               # Default: empty (--changed ref: origin/HEAD, then HEAD)
BASHUNIT_COVERAGE_DIFF=             # Default: empty (restrict coverage to lines changed since this ref)
BASHUNIT_EXCLUDE_FILTER=            # Default: empty (skip tests whose name matches)
BASHUNIT_LIST_TESTS=                # Default: false (print the tests that would run, run none)
BASHUNIT_LIST_FORMAT=               # Default: text (--list rendering: text or json)
BASHUNIT_LIST_TAGS=                 # Default: false (print the tags of the selected files, run none)
BASHUNIT_STOP_ON_ASSERTION_FAILURE= # Default: true (stop test on first assertion fail)
BASHUNIT_STRICT_MODE=               # Default: false (enable set -euo pipefail)
BASHUNIT_LOGIN_SHELL=               # Default: false (source login shell profiles)
BASHUNIT_PARALLEL_JOBS=             # Default: 0 (unlimited; N or auto caps concurrency)
BASHUNIT_RANDOM_ORDER=              # Default: false (shuffle files and tests)
BASHUNIT_SEED=                      # Default: empty (pins --random-order for a replay)
BASHUNIT_RETRY=                     # Default: 0 (re-run a failed test up to N extra times)
BASHUNIT_TEST_TIMEOUT=              # Default: 0 (off; fail a test running longer than N seconds)
BASHUNIT_SHARD_INDEX=               # Default: empty (run shard i of BASHUNIT_SHARD_TOTAL)
BASHUNIT_SHARD_TOTAL=               # Default: empty (how many shards to split the suite into)
BASHUNIT_SKIP_ENV_FILE=             # Default: false (skip .env and .bashunitrc)
BASHUNIT_WATCH_INTERVAL=            # Default: 3 (seconds between polls in the watch fallback)

#───────────────────────────────────────────────────────────────────────────────
# Reports
#───────────────────────────────────────────────────────────────────────────────
BASHUNIT_LOG_JUNIT=                 # JUnit XML report path (e.g., report.xml)
BASHUNIT_LOG_GHA=                   # GitHub Actions workflow-commands log path (e.g., gha.log)
BASHUNIT_REPORT_HTML=               # HTML test report path (e.g., report.html)
BASHUNIT_REPORT_TAP=                # TAP version 13 report path (e.g., report.tap)
BASHUNIT_REPORT_JSON=               # JSON report path (e.g., report.json)

#───────────────────────────────────────────────────────────────────────────────
# Snapshots
#───────────────────────────────────────────────────────────────────────────────
BASHUNIT_SNAPSHOT_UPDATE=           # Default: false (rewrite existing snapshots)
BASHUNIT_SNAPSHOT_CREATE=           # Default: true (record a missing snapshot instead of failing)
BASHUNIT_SNAPSHOT_REPORT_UNUSED=    # Default: false (list snapshots no test resolved)

#───────────────────────────────────────────────────────────────────────────────
# Code Coverage
#───────────────────────────────────────────────────────────────────────────────
BASHUNIT_COVERAGE=                  # Default: false
BASHUNIT_COVERAGE_PATHS=            # Default: src/ (comma-separated paths to track)
BASHUNIT_COVERAGE_EXCLUDE=          # Default: tests/*,vendor/*,*_test.sh,*Test.sh
BASHUNIT_COVERAGE_REPORT=           # Default: coverage/lcov.info
BASHUNIT_COVERAGE_REPORT_HTML=      # HTML coverage report directory (e.g., coverage/html)
BASHUNIT_COVERAGE_REPORT_COBERTURA= # Cobertura XML path for GitLab/Azure/Jenkins (e.g., coverage/cobertura.xml)
BASHUNIT_COVERAGE_MIN=              # Minimum coverage % (fails if below)
BASHUNIT_COVERAGE_THRESHOLD_LOW=    # Default: 50 (red below this)
BASHUNIT_COVERAGE_THRESHOLD_HIGH=   # Default: 80 (green at or above this)
BASHUNIT_COVERAGE_ENGINE=           # Default: auto (or xtrace, trap)
BASHUNIT_COVERAGE_SHOW_LINE_HITS=   # Default: false (print per-line execution counts)
BASHUNIT_COVERAGE_SHOW_FUNCTIONS=   # Default: false (print per-function coverage)
BASHUNIT_COVERAGE_SHOW_UNCOVERED=   # Default: false (print missed line ranges per file)

#───────────────────────────────────────────────────────────────────────────────
# Advanced / Debug
#───────────────────────────────────────────────────────────────────────────────
BASHUNIT_DEV_LOG=                   # Developer log file path
BASHUNIT_BENCH_MODE=                # Default: false (benchmark mode)
BASHUNIT_INTERNAL_LOG=              # Default: false (internal debug logging)
BASHUNIT_NO_DEPRECATION_WARNINGS=   # Default: false (silence unprefixed-alias warnings)