Xping TestLogger

Xping TestLogger is a free and open-source .NET library written in C#. It is a custom test logger designed to integrate with the Visual Studio Test Platform (VSTest) and other compatible test frameworks

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Features
3. Getting Started
   • Installation
4. Configuration
5. Usage
6. Roadmap
7. Contributing
8. License

About The Project

Its primary purpose is to log test events and upload test results to the xping.io server for archiving and storage purposes. This allows for comprehensive analysis, historical data maintenance, and comparison of test results over time.

Features

• Test Event Logging: Captures and logs various test events such as test discovery, test execution, and test results.
• Integration with VSTest: Seamlessly integrates with the Visual Studio Test Platform and other compatible test frameworks.
• Uploads test results to the xping.io server for archiving and storage, enabling detailed analysis and historical comparison.
• Easily configurable via runsettings file or environment variables.

Getting Started

Prerequisites

• .NET 9 SDK
• Visual Studio 2022 or later

Installation

1. Clone the repository:

   git clone https://github.com/xping-dev/test-logger.git
   cd test-logger

2. Build the solution:

  dotnet build 

(back to top)

Configuration

1. Create a .runsettings file to configure the custom logger:

<?xml version="1.0" encoding="utf-8"?>
<RunSettings>
  <TargetPlatform>x64</TargetPlatform>
  <LoggerRunSettings>
    <Loggers>
      <Logger friendlyName="xping" uri="logger://xping/v1" enabled="True">
        <Configuration>
          <UploadToken>{D4E5F6A7-B8C9-4D0E-8F1A-2B3C4D5E6F7A}</UploadToken>
        </Configuration>
      </Logger>
    </Loggers>
  </LoggerRunSettings>
</RunSettings>

2. Specify the runsettings file when running tests:

   dotnet test --settings path/to/your/test.runsettings

(back to top)

Usage

1. Add the Xping.TestLogger project as a reference to your test project.
2. Configure the logger using the runsettings file as shown above.
3. Run your tests using the dotnet test command with the --settings option.

(back to top)

Roadmap

We use Milestones to communicate upcoming changes in Xping SDK:

• Working Set refers to the features that are currently being actively worked on. While not all of these features will be committed in the next release, they do reflect the top priorities of the maintainers for the upcoming period.

• Backlog is a set of feature candidates for some future releases, but are not being actively worked on.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE file for more information.

(back to top)