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
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,10 +141,10 @@ Running self-validation produces a report containing the following information:

✓ ReviewMark_VersionDisplay - Passed
✓ ReviewMark_HelpDisplay - Passed
ReviewMark_DefinitionPlan - Passed
ReviewMark_DefinitionReport - Passed
ReviewMark_ReviewPlanGeneration - Passed
ReviewMark_ReviewReportGeneration - Passed
✓ ReviewMark_IndexScan - Passed
ReviewMark_Dir - Passed
ReviewMark_WorkingDirectoryOverride - Passed
✓ ReviewMark_Enforce - Passed
✓ ReviewMark_Elaborate - Passed

Expand All @@ -157,10 +157,10 @@ Each test in the report proves:

- **`ReviewMark_VersionDisplay`** - `--version` outputs a valid version string.
- **`ReviewMark_HelpDisplay`** - `--help` outputs usage and options information.
- **`ReviewMark_DefinitionPlan`** - `--definition` + `--plan` generates a review plan.
- **`ReviewMark_DefinitionReport`** - `--definition` + `--report` generates a review report.
- **`ReviewMark_ReviewPlanGeneration`** - `--definition` + `--plan` generates a review plan.
- **`ReviewMark_ReviewReportGeneration`** - `--definition` + `--report` generates a review report.
- **`ReviewMark_IndexScan`** - `--index` scans PDF evidence files and writes `index.json`.
- **`ReviewMark_Dir`** - `--dir` overrides the working directory for file operations.
- **`ReviewMark_WorkingDirectoryOverride`** - `--dir` overrides the working directory for file operations.
- **`ReviewMark_Enforce`** - `--enforce` exits with non-zero code when reviews have issues.
- **`ReviewMark_Elaborate`** - `--elaborate` prints a Markdown elaboration of a review set.

Expand Down
12 changes: 6 additions & 6 deletions docs/guide/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,10 @@ Example validation report:

✓ ReviewMark_VersionDisplay - Passed
✓ ReviewMark_HelpDisplay - Passed
ReviewMark_DefinitionPlan - Passed
ReviewMark_DefinitionReport - Passed
ReviewMark_ReviewPlanGeneration - Passed
ReviewMark_ReviewReportGeneration - Passed
✓ ReviewMark_IndexScan - Passed
ReviewMark_Dir - Passed
ReviewMark_WorkingDirectoryOverride - Passed
✓ ReviewMark_Enforce - Passed
✓ ReviewMark_Elaborate - Passed

Expand All @@ -115,10 +115,10 @@ Each test proves specific functionality works correctly:

- **`ReviewMark_VersionDisplay`** - `--version` outputs a valid version string.
- **`ReviewMark_HelpDisplay`** - `--help` outputs usage and options information.
- **`ReviewMark_DefinitionPlan`** - `--definition` + `--plan` generates a review plan.
- **`ReviewMark_DefinitionReport`** - `--definition` + `--report` generates a review report.
- **`ReviewMark_ReviewPlanGeneration`** - `--definition` + `--plan` generates a review plan.
- **`ReviewMark_ReviewReportGeneration`** - `--definition` + `--report` generates a review report.
- **`ReviewMark_IndexScan`** - `--index` scans PDF evidence files and writes `index.json`.
- **`ReviewMark_Dir`** - `--dir` overrides the working directory for file operations.
- **`ReviewMark_WorkingDirectoryOverride`** - `--dir` overrides the working directory for file operations.
- **`ReviewMark_Enforce`** - `--enforce` exits with non-zero code when reviews have issues.
- **`ReviewMark_Elaborate`** - `--elaborate` prints a Markdown elaboration of a review set.

Expand Down
46 changes: 23 additions & 23 deletions requirements.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@ sections:
tests:
- Context_Create_DefinitionFlag_SetsDefinitionFile
- Context_Create_DefinitionFlag_WithoutValue_ThrowsArgumentException
- ReviewMark_DefinitionPlan
- ReviewMark_DefinitionReport
- ReviewMark_ReviewPlanGeneration
- ReviewMark_ReviewReportGeneration

- id: ReviewMark-Cmd-Plan
title: The tool shall support --plan flag to write the review plan to a Markdown file.
Expand All @@ -155,7 +155,7 @@ sections:
and coverage status, suitable for inclusion in release documentation.
tests:
- Context_Create_PlanFlag_SetsPlanFile
- ReviewMark_DefinitionPlan
- ReviewMark_ReviewPlanGeneration

- id: ReviewMark-Cmd-PlanDepth
title: The tool shall support --plan-depth flag to set the Markdown heading depth for the review plan.
Expand All @@ -175,7 +175,7 @@ sections:
status of each review set against the evidence index, suitable for release documentation.
tests:
- Context_Create_ReportFlag_SetsReportFile
- ReviewMark_DefinitionReport
- ReviewMark_ReviewReportGeneration

- id: ReviewMark-Cmd-ReportDepth
title: The tool shall support --report-depth flag to set the Markdown heading depth for the review report.
Expand Down Expand Up @@ -220,7 +220,7 @@ sections:
- Context_Create_DirFlag_SetsWorkingDirectory
- Context_Create_NoArguments_WorkingDirectoryIsNull
- Context_Create_DirFlag_MissingValue_ThrowsArgumentException
- ReviewMark_Dir
- ReviewMark_WorkingDirectoryOverride

- id: ReviewMark-Cmd-Elaborate
title: The tool shall support --elaborate <id> flag to print a Markdown elaboration of a review set.
Expand Down Expand Up @@ -315,11 +315,11 @@ sections:
# Tests link to "windows" to ensure results come from Windows platform
- "windows@ReviewMark_VersionDisplay"
- "windows@ReviewMark_HelpDisplay"
- "windows@ReviewMark_DefinitionPlan"
- "windows@ReviewMark_DefinitionReport"
- "windows@ReviewMark_ReviewPlanGeneration"
- "windows@ReviewMark_ReviewReportGeneration"
- "windows@ReviewMark_IndexScan"
- "windows@ReviewMark_Enforce"
- "windows@ReviewMark_Dir"
- "windows@ReviewMark_WorkingDirectoryOverride"
- "windows@ReviewMark_Elaborate"

- id: ReviewMark-Platform-Linux
Expand All @@ -330,11 +330,11 @@ sections:
# Tests link to "ubuntu" to ensure results come from Linux platform
- "ubuntu@ReviewMark_VersionDisplay"
- "ubuntu@ReviewMark_HelpDisplay"
- "ubuntu@ReviewMark_DefinitionPlan"
- "ubuntu@ReviewMark_DefinitionReport"
- "ubuntu@ReviewMark_ReviewPlanGeneration"
- "ubuntu@ReviewMark_ReviewReportGeneration"
- "ubuntu@ReviewMark_IndexScan"
- "ubuntu@ReviewMark_Enforce"
- "ubuntu@ReviewMark_Dir"
- "ubuntu@ReviewMark_WorkingDirectoryOverride"
- "ubuntu@ReviewMark_Elaborate"

- id: ReviewMark-Platform-MacOS
Expand All @@ -345,11 +345,11 @@ sections:
# Tests link to "macos" to ensure results come from macOS platform
- "macos@ReviewMark_VersionDisplay"
- "macos@ReviewMark_HelpDisplay"
- "macos@ReviewMark_DefinitionPlan"
- "macos@ReviewMark_DefinitionReport"
- "macos@ReviewMark_ReviewPlanGeneration"
- "macos@ReviewMark_ReviewReportGeneration"
- "macos@ReviewMark_IndexScan"
- "macos@ReviewMark_Enforce"
- "macos@ReviewMark_Dir"
- "macos@ReviewMark_WorkingDirectoryOverride"
- "macos@ReviewMark_Elaborate"

- id: ReviewMark-Platform-Net8
Expand All @@ -359,11 +359,11 @@ sections:
tests:
- "dotnet8.x@ReviewMark_VersionDisplay"
- "dotnet8.x@ReviewMark_HelpDisplay"
- "dotnet8.x@ReviewMark_DefinitionPlan"
- "dotnet8.x@ReviewMark_DefinitionReport"
- "dotnet8.x@ReviewMark_ReviewPlanGeneration"
- "dotnet8.x@ReviewMark_ReviewReportGeneration"
- "dotnet8.x@ReviewMark_IndexScan"
- "dotnet8.x@ReviewMark_Enforce"
- "dotnet8.x@ReviewMark_Dir"
- "dotnet8.x@ReviewMark_WorkingDirectoryOverride"
- "dotnet8.x@ReviewMark_Elaborate"

- id: ReviewMark-Platform-Net9
Expand All @@ -373,11 +373,11 @@ sections:
tests:
- "dotnet9.x@ReviewMark_VersionDisplay"
- "dotnet9.x@ReviewMark_HelpDisplay"
- "dotnet9.x@ReviewMark_DefinitionPlan"
- "dotnet9.x@ReviewMark_DefinitionReport"
- "dotnet9.x@ReviewMark_ReviewPlanGeneration"
- "dotnet9.x@ReviewMark_ReviewReportGeneration"
- "dotnet9.x@ReviewMark_IndexScan"
- "dotnet9.x@ReviewMark_Enforce"
- "dotnet9.x@ReviewMark_Dir"
- "dotnet9.x@ReviewMark_WorkingDirectoryOverride"
- "dotnet9.x@ReviewMark_Elaborate"

- id: ReviewMark-Platform-Net10
Expand All @@ -387,11 +387,11 @@ sections:
tests:
- "dotnet10.x@ReviewMark_VersionDisplay"
- "dotnet10.x@ReviewMark_HelpDisplay"
- "dotnet10.x@ReviewMark_DefinitionPlan"
- "dotnet10.x@ReviewMark_DefinitionReport"
- "dotnet10.x@ReviewMark_ReviewPlanGeneration"
- "dotnet10.x@ReviewMark_ReviewReportGeneration"
- "dotnet10.x@ReviewMark_IndexScan"
- "dotnet10.x@ReviewMark_Enforce"
- "dotnet10.x@ReviewMark_Dir"
- "dotnet10.x@ReviewMark_WorkingDirectoryOverride"
- "dotnet10.x@ReviewMark_Elaborate"

- title: OTS Software
Expand Down
6 changes: 3 additions & 3 deletions src/DemaConsulting.ReviewMark/Validation.cs
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@

// Run the program capturing output to a log file
int exitCode;
using (var testContext = Context.Create(["--silent", "--log", logFile, "--version"]))

Check warning on line 117 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build ubuntu-latest

Define a constant instead of using this literal '--silent' 8 times.

Check warning on line 117 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build ubuntu-latest

Define a constant instead of using this literal '--silent' 8 times.

Check warning on line 117 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build ubuntu-latest

Define a constant instead of using this literal '--silent' 8 times.

Check warning on line 117 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build ubuntu-latest

Define a constant instead of using this literal '--silent' 8 times.

Check warning on line 117 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build ubuntu-latest

Define a constant instead of using this literal '--silent' 8 times.

Check warning on line 117 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build macos-latest

Define a constant instead of using this literal '--silent' 8 times.

Check warning on line 117 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build macos-latest

Define a constant instead of using this literal '--silent' 8 times.

Check warning on line 117 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build macos-latest

Define a constant instead of using this literal '--silent' 8 times.

Check warning on line 117 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build macos-latest

Define a constant instead of using this literal '--silent' 8 times.

Check warning on line 117 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build macos-latest

Define a constant instead of using this literal '--silent' 8 times.

Check warning on line 117 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build windows-latest

Define a constant instead of using this literal '--silent' 8 times.

Check warning on line 117 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build windows-latest

Define a constant instead of using this literal '--silent' 8 times.

Check warning on line 117 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build windows-latest

Define a constant instead of using this literal '--silent' 8 times.

Check warning on line 117 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build windows-latest

Define a constant instead of using this literal '--silent' 8 times.

Check warning on line 117 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build windows-latest

Define a constant instead of using this literal '--silent' 8 times.
{
Program.Run(testContext);
exitCode = testContext.ExitCode;
Expand Down Expand Up @@ -171,7 +171,7 @@
/// <param name="testResults">The test results collection.</param>
private static void RunDefinitionPlanTest(Context context, DemaConsulting.TestResults.TestResults testResults)
{
RunValidationTest(context, testResults, "ReviewMark_DefinitionPlan", () =>
RunValidationTest(context, testResults, "ReviewMark_ReviewPlanGeneration", () =>
{
using var tempDir = new TemporaryDirectory();
var (definitionFile, _) = CreateTestDefinitionFixtures(tempDir.DirectoryPath);
Expand All @@ -179,7 +179,7 @@

// Run the program to generate the plan file
int exitCode;
using (var testContext = Context.Create(["--silent", "--definition", definitionFile, "--plan", planFile]))

Check warning on line 182 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build ubuntu-latest

Define a constant instead of using this literal '--definition' 5 times.

Check warning on line 182 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build ubuntu-latest

Define a constant instead of using this literal '--definition' 5 times.

Check warning on line 182 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build ubuntu-latest

Define a constant instead of using this literal '--definition' 5 times.

Check warning on line 182 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build ubuntu-latest

Define a constant instead of using this literal '--definition' 5 times.

Check warning on line 182 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build ubuntu-latest

Define a constant instead of using this literal '--definition' 5 times.

Check warning on line 182 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build macos-latest

Define a constant instead of using this literal '--definition' 5 times.

Check warning on line 182 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build macos-latest

Define a constant instead of using this literal '--definition' 5 times.

Check warning on line 182 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build macos-latest

Define a constant instead of using this literal '--definition' 5 times.

Check warning on line 182 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build macos-latest

Define a constant instead of using this literal '--definition' 5 times.

Check warning on line 182 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build macos-latest

Define a constant instead of using this literal '--definition' 5 times.

Check warning on line 182 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build windows-latest

Define a constant instead of using this literal '--definition' 5 times.

Check warning on line 182 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build windows-latest

Define a constant instead of using this literal '--definition' 5 times.

Check warning on line 182 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build windows-latest

Define a constant instead of using this literal '--definition' 5 times.

Check warning on line 182 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build windows-latest

Define a constant instead of using this literal '--definition' 5 times.

Check warning on line 182 in src/DemaConsulting.ReviewMark/Validation.cs

View workflow job for this annotation

GitHub Actions / Build / Build windows-latest

Define a constant instead of using this literal '--definition' 5 times.
{
Program.Run(testContext);
exitCode = testContext.ExitCode;
Expand Down Expand Up @@ -208,7 +208,7 @@
/// <param name="testResults">The test results collection.</param>
private static void RunDefinitionReportTest(Context context, DemaConsulting.TestResults.TestResults testResults)
{
RunValidationTest(context, testResults, "ReviewMark_DefinitionReport", () =>
RunValidationTest(context, testResults, "ReviewMark_ReviewReportGeneration", () =>
{
using var tempDir = new TemporaryDirectory();
var (definitionFile, _) = CreateTestDefinitionFixtures(tempDir.DirectoryPath);
Expand Down Expand Up @@ -274,7 +274,7 @@
/// <param name="testResults">The test results collection.</param>
private static void RunDirTest(Context context, DemaConsulting.TestResults.TestResults testResults)
{
RunValidationTest(context, testResults, "ReviewMark_Dir", () =>
RunValidationTest(context, testResults, "ReviewMark_WorkingDirectoryOverride", () =>
{
using var tempDir = new TemporaryDirectory();
var (definitionFile, _) = CreateTestDefinitionFixtures(tempDir.DirectoryPath);
Expand Down
Loading