Skip to content

Commit b22b311

Browse files
Add output examples
Add documentation to help find the output. Resolves #916.
1 parent 8951660 commit b22b311

File tree

4 files changed

+41
-0
lines changed

4 files changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,42 @@ See below for links to more examples:
133133
- [Unit tests][example-unit-tests]
134134
- [Integration tests for an ASP.NET Core HTTP application][example-integration-tests]
135135

136+
## Example Output
137+
138+
If your tests (and the system under test) are correctly configured, then you should see output from the
139+
tests in the same places you would expected to see [output from xunit tests][xunit-output].
140+
141+
See below for some examples from the [`Http_Get_Many`][example-test] test in this repository.
142+
143+
<!-- markdownlint-disable MD033 -->
144+
145+
### Visual Studio
146+
147+
<details>
148+
<summary>Click to expand</summary>
149+
150+
![Visual Studio Output][output-vs]
151+
152+
</details>
153+
154+
### Visual Studio Code
155+
156+
<details>
157+
<summary>Click to expand</summary>
158+
159+
![Visual Studio Code Output][output-vscode]
160+
161+
</details>
162+
163+
### Windows Terminal and .NET CLI
164+
165+
<details>
166+
<summary>Click to expand</summary>
167+
168+
![Windows Terminal Output][output-windows-terminal]
169+
170+
</details>
171+
136172
## Migrating to xunit v3
137173

138174
[Xunit v3][xunit-v3-whats-new] contains many major architectural changes which means the same package
@@ -182,9 +218,13 @@ cd xunit-logging
182218
[scorecard-report]: https://securityscorecards.dev/viewer/?uri=github.com/martincostello/xunit-logging "OpenSSF Scorecard for this project"
183219
[dotnet-sdk]: https://dot.net/download "Download the .NET SDK"
184220
[example-integration-tests]: https://github.com/martincostello/xunit-logging/blob/main/tests/Shared/Integration/HttpApplicationTests.cs "Integration test examples"
221+
[example-test]: https://github.com/martincostello/xunit-logging/blob/8951660a4667cfa5b07e2558b741b335a31d1e59/tests/Shared/Integration/HttpApplicationTests.cs#L26-L58 "Http_Get_Many"
185222
[example-unit-tests]: https://github.com/martincostello/xunit-logging/blob/main/tests/Shared/Examples.cs "Unit test examples"
186223
[issues]: https://github.com/martincostello/xunit-logging/issues "Issues for this project on GitHub.com"
187224
[license]: https://www.apache.org/licenses/LICENSE-2.0.txt "The Apache 2.0 license"
225+
[output-vs]: ./docs/images/output-vs.png "xunit Output in Visual Studio"
226+
[output-vscode]: ./docs/images/output-vscode.png "xunit Output in Visual Studio Code"
227+
[output-windows-terminal]: ./docs/images/output-terminal.png "xunit Output in Windows Terminal with the .NET CLI"
188228
[package-badge-downloads-v2]: https://img.shields.io/nuget/dt/MartinCostello.Logging.XUnit?logo=nuget&label=Downloads&color=blue
189229
[package-badge-downloads-v3]: https://img.shields.io/nuget/dt/MartinCostello.Logging.XUnit.v3?logo=nuget&label=Downloads&color=blue
190230
[package-badge-version-v2]: https://img.shields.io/nuget/v/MartinCostello.Logging.XUnit?logo=nuget&label=Latest&color=blue
@@ -194,5 +234,6 @@ cd xunit-logging
194234
[repo]: https://github.com/martincostello/xunit-logging "This project on GitHub.com"
195235
[serilog]: https://serilog.net/ "Serilog website"
196236
[serilog-sinks-xunit]: https://github.com/trbenning/serilog-sinks-xunit "Serilog.Sinks.XUnit on GitHub"
237+
[xunit-output]: https://xunit.net/docs/capturing-output "Capturing Output - xUnit.net Documentation"
197238
[xunit-v3-migration]: https://xunit.net/docs/getting-started/v3/migration "Migrating from xunit v2 to v3"
198239
[xunit-v3-whats-new]: https://xunit.net/docs/getting-started/v3/whats-new "What's New in v3"

docs/images/output-terminal.png

69.3 KB
Loading

docs/images/output-vs.png

89.5 KB
Loading

docs/images/output-vscode.png

90.9 KB
Loading

0 commit comments

Comments
 (0)