Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions .reviewmark.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ reviews:
paths:
- "docs/reqstream/version-mark/cli/cli.yaml" # subsystem requirements
- "docs/design/version-mark/cli/cli.md" # subsystem design
- "test/**/Cli/CliSubsystemTests.cs" # subsystem tests
- "test/**/Cli/CliTests.cs" # subsystem tests

- id: VersionMark-Cli-Program
title: Review that VersionMark Cli Program Implementation is Correct
Expand All @@ -87,8 +87,7 @@ reviews:
paths:
- "docs/reqstream/version-mark/configuration/configuration.yaml" # subsystem requirements
- "docs/design/version-mark/configuration/configuration.md" # subsystem design
- "test/**/Configuration/ConfigurationSubsystemTests.cs" # subsystem tests
- "test/**/Configuration/ConfigurationLoadSubsystemTests.cs" # load subsystem tests
- "test/**/Configuration/ConfigurationTests.cs" # subsystem tests

- id: VersionMark-Configuration-VersionMarkConfig
title: Review that VersionMark Configuration VersionMarkConfig Implementation is Correct
Expand Down Expand Up @@ -121,7 +120,7 @@ reviews:
paths:
- "docs/reqstream/version-mark/capture/capture.yaml" # subsystem requirements
- "docs/design/version-mark/capture/capture.md" # subsystem design
- "test/**/Capture/CaptureSubsystemTests.cs" # subsystem tests
- "test/**/Capture/CaptureTests.cs" # subsystem tests

- id: VersionMark-Capture-VersionInfo
title: Review that VersionMark Capture VersionInfo Implementation is Correct
Expand All @@ -137,7 +136,7 @@ reviews:
paths:
- "docs/reqstream/version-mark/publishing/publishing.yaml" # subsystem requirements
- "docs/design/version-mark/publishing/publishing.md" # subsystem design
- "test/**/Publishing/PublishingSubsystemTests.cs" # subsystem tests
- "test/**/Publishing/PublishingTests.cs" # subsystem tests

- id: VersionMark-Publishing-MarkdownFormatter
title: Review that VersionMark Publishing MarkdownFormatter Implementation is Correct
Expand All @@ -153,15 +152,15 @@ reviews:
paths:
- "docs/reqstream/version-mark/self-test/self-test.yaml" # subsystem requirements
- "docs/design/version-mark/self-test/self-test.md" # subsystem design
- "test/**/SelfTest/SelfTestSubsystemTests.cs" # subsystem tests
- "test/**/SelfTest/SelfTestTests.cs" # subsystem tests

- id: VersionMark-SelfTest-Validation
title: Review that VersionMark SelfTest Validation Implementation is Correct
paths:
- "docs/reqstream/version-mark/self-test/validation.yaml" # requirements
- "docs/design/version-mark/self-test/validation.md" # design
- "src/**/SelfTest/Validation.cs" # implementation
- "test/**/SelfTest/SelfTestSubsystemTests.cs" # subsystem tests (no separate unit test file)
- "test/**/SelfTest/SelfTestTests.cs" # subsystem tests (no separate unit test file)

- id: VersionMark-SelfTest-PathHelpers
title: Review that VersionMark SelfTest PathHelpers Implementation is Correct
Expand Down
24 changes: 12 additions & 12 deletions docs/reqstream/version-mark/capture/capture.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sections:
tags:
- capture
tests:
- CaptureSubsystem_Context_CaptureFlag_SetsCaptureMode
- Capture_Context_CaptureFlag_SetsCaptureMode

- id: VersionMark-Capture-JobId
title: The tool shall require --job-id parameter when capture mode is enabled.
Expand All @@ -22,7 +22,7 @@ sections:
tags:
- capture
tests:
- CaptureSubsystem_Context_WithJobId_SetsJobId
- Capture_Context_WithJobId_SetsJobId

- id: VersionMark-Capture-Output
title: The tool shall support --output parameter to specify the JSON output file path.
Expand All @@ -32,7 +32,7 @@ sections:
tags:
- capture
tests:
- CaptureSubsystem_SaveAndLoad_PreservesAllVersionData
- Capture_SaveAndLoad_PreservesAllVersionData

- id: VersionMark-Capture-DefaultOutput
title: The tool shall default output filename to versionmark-<job-id>.json when --output is not specified.
Expand All @@ -42,7 +42,7 @@ sections:
tags:
- capture
tests:
- CaptureSubsystem_Run_NoOutputFlagSpecified_UsesDefaultFilename
- Capture_Run_NoOutputFlagSpecified_UsesDefaultFilename

- id: VersionMark-Capture-ToolFilter
title: The tool shall accept an optional list of tool names after -- separator in capture mode.
Expand All @@ -52,7 +52,7 @@ sections:
tags:
- capture
tests:
- CaptureSubsystem_Context_WithToolFilter_SetsToolNames
- Capture_Context_WithToolFilter_SetsToolNames

- id: VersionMark-Capture-MultipleTools
title: The tool shall capture all tools defined in configuration when no tool names are specified.
Expand All @@ -62,7 +62,7 @@ sections:
tags:
- capture
tests:
- CaptureSubsystem_Run_NoToolFilter_CapturesAllConfiguredTools
- Capture_Run_NoToolFilter_CapturesAllConfiguredTools

- id: VersionMark-Capture-Config
title: The tool shall read .versionmark.yaml from the current directory in capture mode.
Expand All @@ -72,7 +72,7 @@ sections:
tags:
- capture
tests:
- CaptureSubsystem_Config_ReadFromFile_LoadsToolDefinitions
- Capture_Config_ReadFromFile_LoadsToolDefinitions

- id: VersionMark-Capture-Command
title: The tool shall execute configured commands and extract version information using regex patterns.
Expand All @@ -82,7 +82,7 @@ sections:
tags:
- capture
tests:
- CaptureSubsystem_FindVersions_ExecutesCommandAndExtractsVersion
- Capture_FindVersions_ExecutesCommandAndExtractsVersion

- id: VersionMark-Capture-JsonOutput
title: The tool shall save captured version information to a JSON file with job ID and version mappings.
Expand All @@ -92,8 +92,8 @@ sections:
tags:
- capture
tests:
- CaptureSubsystem_SaveAndLoad_PreservesAllVersionData
- CaptureSubsystem_MultipleCaptures_EachFileHasDistinctJobId
- Capture_SaveAndLoad_PreservesAllVersionData
- Capture_MultipleCaptures_EachFileHasDistinctJobId

- id: VersionMark-Capture-Display
title: The tool shall display captured tool names and versions to the user.
Expand All @@ -103,7 +103,7 @@ sections:
tags:
- capture
tests:
- CaptureSubsystem_Run_DisplaysCapturedVersionsAfterCapture
- Capture_Run_DisplaysCapturedVersionsAfterCapture

- id: VersionMark-Capture-ConfigError
title: The tool shall report errors when .versionmark.yaml cannot be found or read in capture mode.
Expand All @@ -113,4 +113,4 @@ sections:
tags:
- capture
tests:
- CaptureSubsystem_LoadFromFile_NonExistentFile_ThrowsArgumentException
- Capture_LoadFromFile_NonExistentFile_ThrowsArgumentException
24 changes: 12 additions & 12 deletions docs/reqstream/version-mark/cli/cli.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ sections:
tags:
- cli
tests:
- CliSubsystem_Run_VersionFlag_ExitsCleanly
- CliSubsystem_Run_SilentWithVersionFlag_SuppressesOutput
- Cli_Run_VersionFlag_ExitsCleanly
- Cli_Run_SilentWithVersionFlag_SuppressesOutput

- id: VersionMark-CommandLine-Version
title: The tool shall support -v and --version flags to display version information.
Expand All @@ -23,7 +23,7 @@ sections:
tags:
- cli
tests:
- CliSubsystem_Run_VersionFlag_ExitsCleanly
- Cli_Run_VersionFlag_ExitsCleanly

- id: VersionMark-CommandLine-Help
title: The tool shall support -?, -h, and --help flags to display usage information.
Expand All @@ -33,7 +33,7 @@ sections:
tags:
- cli
tests:
- CliSubsystem_Run_HelpFlag_DisplaysUsageInformation
- Cli_Run_HelpFlag_DisplaysUsageInformation

- id: VersionMark-CommandLine-Silent
title: The tool shall support --silent flag to suppress console output.
Expand All @@ -43,7 +43,7 @@ sections:
tags:
- cli
tests:
- CliSubsystem_Run_SilentWithVersionFlag_SuppressesOutput
- Cli_Run_SilentWithVersionFlag_SuppressesOutput

- id: VersionMark-CommandLine-Validate
title: The tool shall support --validate flag to run self-validation tests.
Expand All @@ -53,7 +53,7 @@ sections:
tags:
- cli
tests:
- CliSubsystem_Run_ValidateFlag_RunsValidation
- Cli_Run_ValidateFlag_RunsValidation

- id: VersionMark-CommandLine-Results
title: The tool shall support --results flag to write validation results in TRX or JUnit format.
Expand All @@ -62,7 +62,7 @@ sections:
tags:
- cli
tests:
- CliSubsystem_Run_ResultsFlag_WritesResultsFile
- Cli_Run_ResultsFlag_WritesResultsFile

- id: VersionMark-CommandLine-Log
title: The tool shall support --log flag to write output to a log file.
Expand All @@ -71,7 +71,7 @@ sections:
tags:
- cli
tests:
- CliSubsystem_Run_LogFlag_WritesOutputToLogFile
- Cli_Run_LogFlag_WritesOutputToLogFile

- id: VersionMark-CommandLine-ErrorOutput
title: The tool shall write error messages to stderr.
Expand All @@ -81,7 +81,7 @@ sections:
tags:
- cli
tests:
- CliSubsystem_Run_InvalidArgs_ThrowsArgumentException
- Cli_Run_InvalidArgs_ThrowsArgumentException

- id: VersionMark-CommandLine-InvalidArgs
title: The tool shall reject unknown or malformed command-line arguments with a descriptive error.
Expand All @@ -91,7 +91,7 @@ sections:
tags:
- cli
tests:
- CliSubsystem_Run_InvalidArgs_ThrowsArgumentException
- Cli_Run_InvalidArgs_ThrowsArgumentException

- id: VersionMark-CommandLine-ExitCode
title: The tool shall return a non-zero exit code on failure.
Expand All @@ -101,7 +101,7 @@ sections:
tags:
- cli
tests:
- CliSubsystem_Run_InvalidArgs_ThrowsArgumentException
- Cli_Run_InvalidArgs_ThrowsArgumentException

- id: VersionMark-CommandLine-Lint
title: The tool shall support --lint to check the configuration file for issues.
Expand All @@ -113,4 +113,4 @@ sections:
- cli
- lint
tests:
- CliSubsystem_Run_LintFlag_ValidConfig_Succeeds
- Cli_Run_LintFlag_ValidConfig_Succeeds
12 changes: 6 additions & 6 deletions docs/reqstream/version-mark/configuration/configuration.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sections:
tags:
- configuration
tests:
- ConfigurationSubsystem_ReadFromFile_MultipleTools_AllToolsAccessible
- Configuration_ReadFromFile_MultipleTools_AllToolsAccessible

- id: VersionMark-Configuration-ToolDefinition
title: The tool shall support tool definitions with command and regex properties.
Expand All @@ -22,7 +22,7 @@ sections:
tags:
- configuration
tests:
- ConfigurationSubsystem_ReadFromFile_MultipleTools_AllToolsAccessible
- Configuration_ReadFromFile_MultipleTools_AllToolsAccessible

- id: VersionMark-Configuration-OsCommandOverride
title: The tool shall support OS-specific command overrides using -win, -linux, and -macos suffixes.
Expand All @@ -32,7 +32,7 @@ sections:
tags:
- configuration
tests:
- ConfigurationSubsystem_ReadFromFile_WithOsOverrides_SelectsAppropriateCommand
- Configuration_ReadFromFile_WithOsOverrides_SelectsAppropriateCommand

- id: VersionMark-Configuration-OsRegexOverride
title: The tool shall support OS-specific regex overrides using -win, -linux, and -macos suffixes.
Expand All @@ -42,7 +42,7 @@ sections:
tags:
- configuration
tests:
- ConfigurationSubsystem_ReadFromFile_OsRegexOverride_SelectsAppropriateRegex
- Configuration_ReadFromFile_OsRegexOverride_SelectsAppropriateRegex

- id: VersionMark-Configuration-ValidateTools
title: The tool shall validate that configuration files contain at least one tool definition.
Expand All @@ -52,7 +52,7 @@ sections:
tags:
- configuration
tests:
- ConfigurationSubsystem_ReadFromFile_EmptyTools_ThrowsArgumentException
- Configuration_ReadFromFile_EmptyTools_ThrowsArgumentException

- id: VersionMark-Configuration-ParseError
title: The tool shall report errors when configuration files cannot be read or parsed.
Expand All @@ -62,4 +62,4 @@ sections:
tags:
- configuration
tests:
- ConfigurationSubsystem_ReadFromFile_InvalidYaml_ThrowsArgumentException
- Configuration_ReadFromFile_InvalidYaml_ThrowsArgumentException
Loading
Loading