Test Logger

https://github.com/spekt/testlogger
Admin
Test Logger provides JUnit, NUnit, and Xunit logger extensions for .NET test platforms (VSTest and...
Tokens:6,336
Snippets:102
Trust Score:6.8
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example JUnit XML Structure for CircleCI

Source: https://github.com/spekt/testlogger/blob/master/docs/circleci-recommendation.md

This XML structure demonstrates how CircleCI interprets data within a `<testcase>` element. Elements like `<system-out>` and `<failure>` are displayed, but `<properties>` are not.

```xml
<testsuites>
  <testsuite>
    <testcase name="Displayed in bold on the CircleCI WebUI" classname="Also shown" time="Used for test splitting">
      <properties>
        <property name="CircleCI" value="Does not show these" />
      </properties>
      <failure message="This can be seen in CircleCI">So can this</failure>
      <system-out>This is also shown by CircleCI<system-out>
      <system-err>Same for system-err too</system-err>
    </testcase>
    <system-out>CircleCI ignores data here</system-out>
    <system-err>Same for system-err too</system-err>
  </testsuite>
</testsuites>
```

--------------------------------

### Configure console output via CLI

Source: https://github.com/spekt/testlogger/blob/master/src/JUnit.Xml.Package/README.md

Example command to disable console output capture when running tests.

```bash
dotnet test --logger:"junit;StoreConsoleOutput=false"
```

--------------------------------

### Package Project

Source: https://github.com/spekt/testlogger/blob/master/CLAUDE.md

Creates NuGet packages for the project.

```bash
dotnet pack
```

--------------------------------

### Run Full Build and Test (Linux/macOS)

Source: https://github.com/spekt/testlogger/blob/master/CLAUDE.md

Executes the full build and test suite for the project on Linux or macOS systems.

```shell
./build.sh
```

--------------------------------

### MTP support command line options

Source: https://github.com/spekt/testlogger/blob/master/src/NUnit.Xml.Package/README.md

Commands for using the logger with Microsoft.Testing.Platform.

```bash
> dotnet test -- --report-spekt-nunit --report-spekt-nunit-filename test-result.xml
```

```bash
> dotnet test -- --report-spekt-nunit "key1=value1;key2=value2"
```

--------------------------------

### Basic Xunit Test Logger Usage

Source: https://github.com/spekt/testlogger/blob/master/src/Xunit.Xml.Package/README.md

Use this command to enable the xunit logger for test projects. Test results will be generated in the `TestResults` directory.

```bash
> dotnet test --logger:xunit
```

--------------------------------

### Run Full Build and Test (Windows)

Source: https://github.com/spekt/testlogger/blob/master/CLAUDE.md

Executes the full build and test suite for the project on Windows systems.

```powershell
.\build.ps1
```

--------------------------------

### NUnit test framework settings

Source: https://github.com/spekt/testlogger/blob/master/src/NUnit.Xml.Package/README.md

Advanced configuration for NUnit internal properties and output directory.

```bash
dotnet test --logger:nunit -- NUnit.ShowInternalProperties=true
```

```bash
dotnet test --logger:nunit -- NUnit.TestOutputXml=<foldername relative to test binary directory>
```

--------------------------------

### Run tests with JSON logger

Source: https://github.com/spekt/testlogger/blob/master/README.md

Use this command to run tests and output results in JSON format. Ensure you are in the root of the repository.

```sh
# Run from root of repo
> dotnet test --no-build --logger:"json;LogFilePath=test-results.json" test/assets/Json.TestLogger.MSTest.NetCore.Tests/Json.TestLogger.MSTest.NetCore.Tests.csproj
```

--------------------------------

### Run tests with NUnit logger

Source: https://github.com/spekt/testlogger/blob/master/src/NUnit.Xml.Package/README.md

Basic command to execute tests and generate an NUnit XML report.

```bash
> dotnet test --logger:nunit
```

--------------------------------

### Project Structure

Source: https://github.com/spekt/testlogger/blob/master/CLAUDE.md

Illustrates the directory structure of the TestLogger project, showing the organization of core libraries, format-specific loggers, package projects, and test directories.

```tree
src/
├── TestLogger/               # Core library
├── JUnit.Xml.TestLogger/     # JUnit format implementation
├── NUnit.Xml.TestLogger/     # NUnit format implementation
├── Xunit.Xml.TestLogger/     # Xunit format implementation
└── *.Package/               # NuGet package projects

test/
├── *UnitTests/              # Unit tests for each logger
├── *AcceptanceTests/        # End-to-end tests
├── TestLogger.UnitTests/     # Core library tests
└── assets/                  # Test project assets
```

--------------------------------

### MTP Support with JUnit Logger

Source: https://github.com/spekt/testlogger/blob/master/src/JUnit.Xml.Package/README.md

Enable JUnit reporting for tests running with Microsoft.Testing.Platform (MTP). Use '--report-spekt-junit' to activate and specify the filename.

```bash
> dotnet test -- --report-spekt-junit --report-spekt-junit-filename test-result.xml
```

--------------------------------

### MTP JUnit Logger with Configuration Arguments

Source: https://github.com/spekt/testlogger/blob/master/src/JUnit.Xml.Package/README.md

Pass custom key-value configuration arguments to the MTP JUnit logger. Ensure arguments are enclosed in quotes.

```bash
> dotnet test -- --report-spekt-junit "key1=value1;key2=value2"
```

--------------------------------

### Specify Log File Path

Source: https://github.com/spekt/testlogger/wiki/Logger-Configuration

Use `LogFilePath` to provide an absolute path for the result file. The parent directory will be created if it doesn't exist. Tokens like `{assembly}` or `{framework}` can be used for dynamic naming.

```sh
# Use assembly name or framework token in test results file
> dotnet test --logger:"xunit;LogFilePath=/tmp/SampleTests/results/{assembly}.results.xml"
Results File: /tmp/SampleTests/results/SampleTests.results.xml
```

```sh
> dotnet test --logger:"xunit;LogFilePath=/tmp/SampleTests/results/{assembly}.{framework}.results.xml"
Results File: /tmp/SampleTests/results/SampleTests.NETCoreApp31.results.xml
```

--------------------------------

### MTP Xunit Test Logger with Configuration Arguments

Source: https://github.com/spekt/testlogger/blob/master/src/Xunit.Xml.Package/README.md

Pass custom configuration arguments to the Xunit Test Logger when using it with Microsoft.Testing.Platform (MTP). Arguments are provided as a semicolon-separated string.

```bash
> dotnet test -- --report-spekt-xunit "key1=value1;key2=value2"
```

--------------------------------

### Run Specific Acceptance Test

Source: https://github.com/spekt/testlogger/blob/master/CLAUDE.md

Executes a specific acceptance test for the TestLogger project.

```bash
dotnet test test/TestLogger.AcceptanceTests/TestLogger.AcceptanceTests.csproj
```

--------------------------------

### Specify NUnit log file path

Source: https://github.com/spekt/testlogger/blob/master/src/NUnit.Xml.Package/README.md

Command to define a custom output path for the generated XML report.

```bash
> dotnet test --logger:"nunit;LogFilePath=test-result.xml"
```

--------------------------------

### MTP Support with Xunit Test Logger

Source: https://github.com/spekt/testlogger/blob/master/src/Xunit.Xml.Package/README.md

Enable Xunit Test Logger for Microsoft.Testing.Platform (MTP) using specific command-line arguments. This allows for xunit v2 report generation within the MTP framework.

```bash
> dotnet test -- --report-spekt-xunit --report-spekt-xunit-filename test_result.xml
```

--------------------------------

### Customizing JUnit XML Contents

Source: https://github.com/spekt/testlogger/blob/master/src/JUnit.Xml.Package/README.md

Apply custom key-value pairs to tailor the JUnit XML output for specific CI/CD systems. Note that quotes are required and key names are case-sensitive.

```bash
> dotnet test --test-adapter-path:. --logger:"junit;key1=value1;key2=value2"
```

--------------------------------

### Basic JUnit Test Logger Usage

Source: https://github.com/spekt/testlogger/blob/master/src/JUnit.Xml.Package/README.md

Use this command to enable the JUnit logger for your .NET tests. Test results will be generated in the 'TestResults' directory.

```bash
> dotnet test --logger:junit
```

--------------------------------

### Logger Configuration Options

Source: https://github.com/spekt/testlogger/blob/master/src/JUnit.Xml.Package/README.md

Overview of available logger options for customizing test result output.

```APIDOC
## Logger Configuration Options

### Description
Configure the behavior of the test logger using command-line arguments, typically passed via `dotnet test --logger:"junit;Option=Value"`.

### Parameters
#### Query Parameters
- **LogFileName** (string) - Optional - Customize test result file name with {assembly} or {framework} tokens.
- **LogFilePath** (string) - Optional - Test result file full path.
- **UseRelativeAttachmentPath** (boolean) - Optional - Use attachment paths relative to test result file. Default: false.
- **MethodFormat** (string) - Optional - Alter test case name. Allowed: Default, Class, Full.
- **FailureBodyFormat** (string) - Optional - Control test result output. Allowed: Default, Verbose.
- **StoreConsoleOutput** (string) - Optional - Show or hide console output. Allowed: true, false, testsuite, testcase. Default: true.
```

--------------------------------

### Specify Xunit Test Logger File Path

Source: https://github.com/spekt/testlogger/blob/master/src/Xunit.Xml.Package/README.md

Customize the output file name and path for the xunit test results. The specified file will be generated in the same directory as the `test.csproj`.

```bash
> dotnet test --logger:"xunit;LogFilePath=test_result.xml"
```

--------------------------------

### Specify Log File Name

Source: https://github.com/spekt/testlogger/wiki/Logger-Configuration

Use `LogFileName` to set the name of the output log file. Tokens like `{assembly}` or `{framework}` can be used for dynamic naming.

```sh
# Replace xunit with the relevant logger name
# > dotnet test --logger:"<loggername>;<option>=<value>"
> dotnet test --logger:"xunit;LogFileName=mytestresults.xml"
```

```sh
# Use assembly name or framework token in test results file
> dotnet test --logger:"xunit;LogFileName={assembly}.results.xml"
Results File: /tmp/SampleTests/TestResults/SampleTests.results.xml
```

```sh
> dotnet test --logger:"xunit;LogFileName={assembly}.{framework}.results.xml"
Results File: /tmp/SampleTests/TestResults/SampleTests.NETCoreApp31.results.xml
```

--------------------------------

### Run Specific Unit Test

Source: https://github.com/spekt/testlogger/blob/master/CLAUDE.md

Executes a specific unit test for the TestLogger core library.

```bash
dotnet test test/TestLogger.UnitTests/TestLogger.UnitTests.csproj
```

--------------------------------

### NUnit Jenkinsfile Pipeline Step

Source: https://github.com/spekt/testlogger/blob/master/docs/jenkins-recommendation.md

Collects NUnit test results in a Jenkins pipeline; ensure this runs in a post or always stage.

```groovy
nunit testResultsPattern: '**/TestResults/*.nunit.xml'
```

--------------------------------

### Configure GitLab CI/CD for Improved Test Reporting

Source: https://github.com/spekt/testlogger/blob/master/docs/gitlab-recommendation.md

This .yml snippet configures a GitLab CI/CD job to run .NET tests. It specifies the JUnit logger with options to format the method name as 'Class' and the failure body as 'Verbose' for more detailed output. It also collects and uploads the XML test results as artifacts.

```yml
Test:
  stage: Test
  script: 
    - 'dotnet test --test-adapter-path:. --logger:"junit;LogFilePath=..\artifacts\{assembly}-test-result.xml;MethodFormat=Class;FailureBodyFormat=Verbose"'
  artifacts:
    when: always
    paths: 
     - .\artifacts\*test-result.xml
    reports:
      junit: 
       - .\artifacts\*test-result.xml
```

--------------------------------

### Reproduce MTP Logger Issue

Source: https://github.com/spekt/testlogger/blob/master/CLAUDE.md

Reproduces a Microsoft.Testing.Platform (MTP) logger issue by running a specific test asset with MTP-specific flags and JSON reporting. The DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 environment variable is used for consistent behavior on Linux.

```bash
DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1

# Reproduce MTP logger issue
dotnet test test/assets/Json.TestLogger.MSTest.NetCore.Tests/Json.TestLogger.MSTest.NetCore.Tests.csproj -p:IsMTP=true -- --report-spekt-json --report-spekt-json test-results-mtp.json
```

--------------------------------

### Configure .NET Test Logging in CircleCI

Source: https://github.com/spekt/testlogger/blob/master/docs/circleci-recommendation.md

This configuration runs .NET tests and specifies the JUnit logger with custom formatting for CircleCI. Ensure the 'junit' logger is available in your .NET environment.

```yml
- run:
    name: Run Tests
    command: |
      dotnet test ... --logger:"junit;LogFilePath=TestResults/test-result.xml;FailureBodyFormat=Verbose;MethodFormat=Class"
- store_test_results:
    path: TestResults/
- store_artifacts:
    path: TestResults/
```

--------------------------------

### JUnit Jenkinsfile Pipeline Step

Source: https://github.com/spekt/testlogger/blob/master/docs/jenkins-recommendation.md

Collects JUnit test results in a Jenkins pipeline; ensure this runs in a post or always stage.

```groovy
junit allowEmptyResults: false, testResults: '**/TestResults/*.junit.xml'
```

--------------------------------

### Configure NUnit Logger in .runsettings

Source: https://github.com/spekt/testlogger/blob/master/docs/jenkins-recommendation.md

Defines the NUnit logger configuration within the RunSettings file for test execution.

```xml
<?xml version="1.0" encoding="utf-8" ?>
<RunSettings>
  <LoggerRunSettings>
    <Loggers>
      <Logger friendlyName="console" enabled="True">
        <Configuration>
          <Verbosity>minimal</Verbosity>
        </Configuration>
      </Logger>
      <Logger friendlyName="nunit" enabled="True">
        <Configuration>
          <LogFileName>{assembly}.{framework}.nunit.xml</LogFileName>
        </Configuration>
      </Logger>
    </Loggers>
  </LoggerRunSettings>
</RunSettings>
```

--------------------------------

### Reproduce VSTest Logger Issue

Source: https://github.com/spekt/testlogger/blob/master/CLAUDE.md

Reproduces a Visual Studio Test Platform (VSTest) logger issue by running a specific test asset with JSON logging enabled. The DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1 environment variable is used for consistent behavior on Linux.

```bash
DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=1

# Reproduce VSTest logger issue
dotnet test --logger:"json;LogFilePath=test-results-vstest.json" test/assets/Json.TestLogger.MSTest.NetCore.Tests/Json.TestLogger.MSTest.NetCore.Tests.csproj
```

--------------------------------

### Use Relative Attachment Path

Source: https://github.com/spekt/testlogger/wiki/Logger-Configuration

Set `UseRelativeAttachmentPath` to `true` to make attachment paths in test results relative to the test result file directory. The default is `false`.

```sh
# Assume we have this directory structure of tests
> tree
.
├── SampleTests
│   ├── UnitTest1.cs
│   └── SampleTests.csproj

> cd SampleTests
> dotnet test --logger:"xunit;LogFilePath=/tmp/SampleTests/results/mytestfile.xml;UseRelativeAttachmentPath=true"

# Note the output file
> tree
.
├── SampleTests
│   ├── results
│   │   ├── mytestfile.xml    # test result file
│   ├── UnitTest1.cs
│   └── SampleTests.csproj
|   └── attachment.txt

# Expected attachment path in mytestfile.xml (if UseRelativeAttachmentPath=true)
../attachment.txt

# Expected attachment path in mytestfile.xml (if UseRelativeAttachmentPath=false [default])
/tmp/SampleTests/attachment.txt
```

--------------------------------

### Configure JUnit Logger in .runsettings

Source: https://github.com/spekt/testlogger/blob/master/docs/jenkins-recommendation.md

Defines the JUnit logger configuration within the RunSettings file for test execution.

```xml
<?xml version="1.0" encoding="utf-8" ?>
<RunSettings>
  <LoggerRunSettings>
    <Loggers>
      <Logger friendlyName="console" enabled="True">
        <Configuration>
          <Verbosity>minimal</Verbosity>
        </Configuration>
      </Logger>
      <Logger friendlyName="junit" enabled="True">
        <Configuration>
          <LogFileName>{assembly}.{framework}.junit.xml</LogFileName>
        </Configuration>
      </Logger>
    </Loggers>
  </LoggerRunSettings>
</RunSettings>
```

--------------------------------

### Specify JUnit Report File Path

Source: https://github.com/spekt/testlogger/blob/master/src/JUnit.Xml.Package/README.md

Configure the JUnit logger to save the report to a specific file name. The file will be created in the same directory as your test project.

```bash
> dotnet test --logger:"junit;LogFilePath=test-result.xml"
```

--------------------------------

### Store Test Artifacts in CircleCI

Source: https://github.com/spekt/testlogger/blob/master/docs/circleci-recommendation.md

Storing test results as artifacts allows users to view and download the raw XML file for further troubleshooting. This is useful for information not directly displayed by CircleCI.

```yml
- store_artifacts:
    path: TestResults/
```

--------------------------------

### Store Test Results in CircleCI

Source: https://github.com/spekt/testlogger/blob/master/docs/circleci-recommendation.md

This step is crucial for CircleCI to display test results on the job's page and enable features like Test Insights and Test Splitting. The path should match the LogFilePath specified in the logger configuration.

```yml
- store_test_results:
    path: TestResults/
```
Tokens:
Raw