Skip to content

Commit 065a655

Browse files
CopilotMalcolmnixon
andcommitted
Print test names instead of descriptions in self-validation output
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>
1 parent 04fffe2 commit 065a655

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ Running self-validation produces a report containing the following information:
7878
| DotNet Runtime | <dotnet-runtime-version> |
7979
| Time Stamp | <timestamp> UTC |
8080
81-
Version Display Test - PASSED
82-
Help Display Test - PASSED
81+
TemplateTool_VersionDisplay - Passed
82+
TemplateTool_HelpDisplay - Passed
8383
8484
Total Tests: 2
8585
Passed: 2

docs/guide/guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ Example validation report:
8080
| DotNet Runtime | .NET 10.0.0 |
8181
| Time Stamp | 2024-01-15 10:30:00 UTC |
8282
83-
Version Display Test - PASSED
84-
Help Display Test - PASSED
83+
TemplateTool_VersionDisplay - Passed
84+
TemplateTool_HelpDisplay - Passed
8585
8686
Total Tests: 2
8787
Passed: 2

src/DemaConsulting.TemplateDotNetTool/Validation.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -135,27 +135,27 @@ private static void RunVersionTest(Context context, DemaConsulting.TestResults.T
135135
logContent.Split('.').Length >= 3)
136136
{
137137
test.Outcome = DemaConsulting.TestResults.TestOutcome.Passed;
138-
context.WriteLine($"✓ Version Display Test - PASSED");
138+
context.WriteLine($"✓ TemplateTool_VersionDisplay - Passed");
139139
}
140140
else
141141
{
142142
test.Outcome = DemaConsulting.TestResults.TestOutcome.Failed;
143143
test.ErrorMessage = "Version string not found in log";
144-
context.WriteError($"✗ Version Display Test - FAILED: Version string not found in log");
144+
context.WriteError($"✗ TemplateTool_VersionDisplay - Failed: Version string not found in log");
145145
}
146146
}
147147
else
148148
{
149149
test.Outcome = DemaConsulting.TestResults.TestOutcome.Failed;
150150
test.ErrorMessage = $"Program exited with code {exitCode}";
151-
context.WriteError($"✗ Version Display Test - FAILED: Exit code {exitCode}");
151+
context.WriteError($"✗ TemplateTool_VersionDisplay - Failed: Exit code {exitCode}");
152152
}
153153
}
154154
// Generic catch is justified here as this is a test framework - any exception should be
155155
// recorded as a test failure to ensure robust test execution and reporting.
156156
catch (Exception ex)
157157
{
158-
HandleTestException(test, context, "Version Display Test", ex);
158+
HandleTestException(test, context, "TemplateTool_VersionDisplay", ex);
159159
}
160160

161161
FinalizeTestResult(test, startTime, testResults);
@@ -202,27 +202,27 @@ private static void RunHelpTest(Context context, DemaConsulting.TestResults.Test
202202
if (logContent.Contains("Usage:") && logContent.Contains("Options:"))
203203
{
204204
test.Outcome = DemaConsulting.TestResults.TestOutcome.Passed;
205-
context.WriteLine($"✓ Help Display Test - PASSED");
205+
context.WriteLine($"✓ TemplateTool_HelpDisplay - Passed");
206206
}
207207
else
208208
{
209209
test.Outcome = DemaConsulting.TestResults.TestOutcome.Failed;
210210
test.ErrorMessage = "Help text not found in log";
211-
context.WriteError($"✗ Help Display Test - FAILED: Help text not found in log");
211+
context.WriteError($"✗ TemplateTool_HelpDisplay - Failed: Help text not found in log");
212212
}
213213
}
214214
else
215215
{
216216
test.Outcome = DemaConsulting.TestResults.TestOutcome.Failed;
217217
test.ErrorMessage = $"Program exited with code {exitCode}";
218-
context.WriteError($"✗ Help Display Test - FAILED: Exit code {exitCode}");
218+
context.WriteError($"✗ TemplateTool_HelpDisplay - Failed: Exit code {exitCode}");
219219
}
220220
}
221221
// Generic catch is justified here as this is a test framework - any exception should be
222222
// recorded as a test failure to ensure robust test execution and reporting.
223223
catch (Exception ex)
224224
{
225-
HandleTestException(test, context, "Help Display Test", ex);
225+
HandleTestException(test, context, "TemplateTool_HelpDisplay", ex);
226226
}
227227

228228
FinalizeTestResult(test, startTime, testResults);

0 commit comments

Comments
 (0)