Elements

graph TD; %% REQVIRE-AUTOGENERATED-DIAGRAM %% Graph styling classDef userRequirement fill:#D1C4E9,stroke:#7E57C2,stroke-width:2px; classDef systemRequirement fill:#E1D8EE,stroke:#673AB7,stroke-width:1.5px; classDef verification fill:#DCEDC8,stroke:#4CAF50,stroke-width:2px; classDef folder fill:#FAFAFA,stroke:#9E9E9E,stroke-width:3px; classDef file fill:#FFF8E1,stroke:#FFCA28,stroke-width:2px; classDef default fill:#F5F5F5,stroke:#424242,stroke-width:1.5px; subgraph e258363212a98952["📁 requirements/Interfaces/CLI/Verifications"] subgraph 81d836bf8ae49ad4["📄 CLIVerifications.md"] 349d095f92fc1135["CLI Git Commit Hash Flag Test"]; class 349d095f92fc1135 verification; click 349d095f92fc1135 "CLIVerifications.html#cli-git-commit-hash-flag-test"; bd0b4833b30da28["CLI Help Structure Verification"]; class bd0b4833b30da28 verification; click bd0b4833b30da28 "CLIVerifications.html#cli-help-structure-verification"; e2664857a303b33e["Verification Traces Element Navigation Test"]; class e2664857a303b33e verification; click e2664857a303b33e "CLIVerifications.html#verification-traces-element-navigation-test"; end end c2377a15dab54ba5["test.sh"]; class c2377a15dab54ba5 default; click c2377a15dab54ba5 "../../../../tests/test-change-impact-detection/test.sh"; 349d095f92fc1135 -->|satisfiedBy| c2377a15dab54ba5; 7478201b4d47e866["test.sh"]; class 7478201b4d47e866 default; click 7478201b4d47e866 "../../../../tests/test-cli-help-structure/test.sh"; bd0b4833b30da28 -->|satisfiedBy| 7478201b4d47e866; 4c7c54f9c1995852["test.sh"]; class 4c7c54f9c1995852 default; click 4c7c54f9c1995852 "../../../../tests/test-verification-traces/test.sh"; e2664857a303b33e -->|satisfiedBy| 4c7c54f9c1995852;

CLI Git Commit Hash Flag Test

This test verifies that the system properly handles the git commit hash flag for change impact analysis.

Details

Acceptance Criteria
  • System shall support –git-commit flag for change impact analysis
  • System shall use specified commit hash as base for comparison
  • System shall default to HEAD when flag is not specified
  • System shall handle relative commit references (HEAD~1, etc.)
Test Criteria
  • Command with explicit –git-commit flag runs successfully
  • Command without flag defaults to HEAD commit
  • Relative commit references are correctly resolved
  • Invalid commit references are reported appropriately
  • Change impact analysis correctly uses specified commit as baseline
Test Procedure
  1. Create test fixtures with git repository containing multiple commits
  2. Run Reqvire with –change-impact –git-commit=HEAD~1
  3. Verify that the specified commit is used as baseline
  4. Run Reqvire with –change-impact (no git-commit flag)
  5. Verify that HEAD is used as default baseline
  6. Run with invalid commit reference and verify appropriate error

Metadata

  • type: test-verification

Relations

CLI Help Structure Verification

This test verifies that the CLI help output displays all commands and their options flattened in the main help, and that all CLI command requirements are covered.

Details

Acceptance Criteria
  • Running reqvire (without arguments) displays the main help output as the default command
  • Main help output shows Usage line: reqvire [OPTIONS] <COMMAND> [COMMAND OPTIONS]
  • Main help lists all available commands under “Commands:” section
  • Main help lists all global options under “Options:” section
  • Command-specific options are displayed under dedicated headings (e.g., “SUMMARY OPTIONS:”, “FORMAT OPTIONS:”)
  • All command options are flattened and visible in the main help without needing to drill down
  • Help output includes nested subcommands expanded (e.g., “traces”, “coverage”)
  • Each command’s help text is descriptive and clear
Test Criteria

  1. Main help output structure Command: reqvire

    • exits code 0
    • output contains “Usage: reqvire [OPTIONS] [COMMAND OPTIONS]”
    • output contains “Commands:” section
    • output contains “Options:” section with -h, --help, -V, --version

  2. Command listing completeness

    • All CLI commands are listed: html, format, validate, summary, section-summary, change-impact, verifications
    • Nested commands are expanded: “traces”, “coverage”

  3. Options flattening - all command-specific option sections present

    • FORMAT OPTIONS section visible
    • SUMMARY OPTIONS section visible
    • SECTION-SUMMARY OPTIONS section visible
    • CHANGE IMPACT OPTIONS section visible
    • VERIFICATIONS TRACES OPTIONS section visible
    • VERIFICATIONS COVERAGE OPTIONS section visible

  4. Help text quality

    • Each command has descriptive help text
    • Options have clear descriptions

Metadata

  • type: test-verification

Relations

Verification Traces Element Navigation Test

Test verifies that verification element names in the traces report are clickable links.

Test Steps

  1. Run reqvire traces command to generate traces report
  2. Verify output contains verification headers as markdown links
  3. Verify links follow format [Verification Name](file_path#fragment)

Expected Results

  • Verification names are rendered as markdown links
  • Links point to source file with verification fragment

Metadata

  • type: test-verification

Relations