|
bash-doxygen
Reference documentation for bash-doxygen
|
Runs the bash-doxygen behavior-focused regression suite. More...
Go to the source code of this file.
Functions | |
| int | tap_ok (String description) |
| Emits one successful TAP assertion. | |
| int | tap_not_ok (String description) |
| Emits one failed TAP assertion and records the failure. | |
| int | tap_diag (String message) |
| Emits diagnostic text that remains valid inside a TAP stream. | |
| int | tap_file_diag (String path) |
| Emits a text file as TAP diagnostic lines. | |
| int | bail_out (String message) |
| Terminates the harness when the test environment is unusable. | |
| int | normalize_warnings (String path) |
| Removes source-location prefixes from filter diagnostics. | |
| int | resolve_filter_path (String path) |
| Resolves a filter path against the repository root when needed. | |
| int | verify_checksum (String path) |
| Verifies the checksum adjacent to one generated AWK artifact. | |
| int | check_artifact_contract (String label, String path) |
| Validates generated-artifact metadata and checksum expectations. | |
| int | run_output_cases () |
| Runs successful translation fixtures against the selected filter. | |
| int | run_diagnostic_cases () |
| Runs warning and strict-mode diagnostic fixtures. | |
| int | run_default_mode_case () |
| Verifies default blank-placeholder line preservation. | |
| int | run_filter_suite (String label, String path) |
| Runs the complete regression contract against one filter. | |
Runs the bash-doxygen behavior-focused regression suite.
Exercises one or more Bash Doxygen filters supplied as LABEL=PATH arguments. Successful fixtures, diagnostic fixtures, generated-artifact contracts, and default line-preserving behavior are reported as one TAP stream. The harness accumulates ordinary assertion failures so callers receive the complete set of regressions from a run while reserving TAP bail-outs for unusable test state.
Definition in file run-tests.sh.
| int bail_out | ( | String | message | ) |
Terminates the harness when the test environment is unusable.
| message | Human-readable reason the harness cannot continue. |
| 1 | The harness terminates because testing cannot continue. |
| int check_artifact_contract | ( | String | label, |
| String | path | ||
| ) |
Validates generated-artifact metadata and checksum expectations.
| label | Logical filter label supplied by the Makefile. |
| path | Absolute path to the filter under test. |
| 0 | Contract assertions were emitted; failures are tracked globally. |
| int normalize_warnings | ( | String | path | ) |
Removes source-location prefixes from filter diagnostics.
| path | File containing raw filter diagnostics. |
| 0 | The sed transformation completed successfully. |
| int resolve_filter_path | ( | String | path | ) |
Resolves a filter path against the repository root when needed.
| path | Absolute or repository-relative filter path. |
| 0 | The path was rendered. |
| int run_default_mode_case | ( | ) |
Verifies default blank-placeholder line preservation.
| 0 | The assertion was emitted; failure is tracked globally. |
| int run_diagnostic_cases | ( | ) |
Runs warning and strict-mode diagnostic fixtures.
| 0 | All diagnostic assertions were emitted; failures are tracked globally. |
| int run_filter_suite | ( | String | label, |
| String | path | ||
| ) |
Runs the complete regression contract against one filter.
| label | Logical name used in TAP assertion descriptions. |
| path | Absolute or repository-relative filter path. |
| 0 | The suite assertions were emitted; failures are tracked globally. |
| int run_output_cases | ( | ) |
Runs successful translation fixtures against the selected filter.
| 0 | All fixture assertions were emitted; failures are tracked globally. |
| int tap_diag | ( | String | message | ) |
Emits diagnostic text that remains valid inside a TAP stream.
| message | Diagnostic text to annotate. |
| 0 | The diagnostic line was emitted. |
| int tap_file_diag | ( | String | path | ) |
Emits a text file as TAP diagnostic lines.
| path | File whose contents should be annotated. |
| 0 | The file was emitted successfully. |
| int tap_not_ok | ( | String | description | ) |
Emits one failed TAP assertion and records the failure.
| description | Human-readable assertion description. |
| 0 | The TAP record was emitted and the failure counter was updated. |
| int tap_ok | ( | String | description | ) |
Emits one successful TAP assertion.
| description | Human-readable assertion description. |
| 0 | The TAP record was emitted. |
| int verify_checksum | ( | String | path | ) |
Verifies the checksum adjacent to one generated AWK artifact.
| path | Absolute path to the generated AWK artifact. |
| 0 | The checksum exists and verifies successfully. |
| 1 | The checksum is missing, no supported verifier exists, or verification fails. |