Skip to content

Commit

Permalink
Address review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Peter-Darton-i2 committed Jul 31, 2023
1 parent 96d4e85 commit c1ccf43
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions docs/circleci-recommendation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```yml
- run:
command: |
vstest.console.exe ... --logger:"junit;LogFilePath=TestResults/test-result.xml;FailureBodyFormat=Verbose"
dotnet test ... --logger:"junit;LogFilePath=TestResults/test-result.xml;FailureBodyFormat=Verbose"
- store_test_results:
path: TestResults/
```
Expand All @@ -17,7 +17,8 @@ CircleCI uses just a few pieces of the JUnit XML report to generate the displaye
Maintenance note:
Findings as of July 20 2023.
- Only data in a <testcase> element is shown.
- The logger only puts console text in at the <testsuite> level so CircleCI ignores it.
- e.g. <system-out> from a <testcase> is shown.
- The logger only puts console text (<system-out> and <system-err>) in the <testsuite> level (not into <testcase>) so CircleCI ignores it.
-->
For each failed test (i.e. for each JUnit `<testcase>` element containing a failure or an error),
CircleCI only shows the testcase's failure/error message, any text within the failure/error element, plus any `<system-out>` or `<system-err>` text.
Expand All @@ -36,18 +37,21 @@ This can provide important/useful information,
especially if the test failure message is insufficiently informative on its own.

- `Default`:

![FailureBodyFormat Default](assets/circleci-test-expanded-with-failure-default.png)

- `Verbose`:

![FailureBodyFormat Verbose](assets/circleci-test-expanded-with-failure-verbose.png)

### MethodFormat

CircleCI shows the class names of each failed test so setting `MethodFormat=Class` or `MethodFormat=Full` provides no further information on the CircleCI UI; the effect is purely cosmetic and is a matter of personal preference.

- `Default`:

![MethodFormat Default](assets/circleci-test-collapsed-with-methodname-default.png)
- `Class`:

- `Class` and `Full`:

![MethodFormat Class](assets/circleci-test-collapsed-with-methodname-class.png)
- `Full`:
Same as `Class`.

0 comments on commit c1ccf43

Please sign in to comment.