Relativity.Testing.Framework

👍🎉 Welcome to Relativity.Testing.Framework! 🎉👍

The Relativity.Testing.Framework and Relativity.Testing.Framework.Api are repositories that comprise Relativity.Testing.Framework.

At a high level, Relativity.Testing.Framework handles configuration management and object models, while Relativity.Testing.Framework.Api handles the interactions with the Relativity APIs.

This repository contains a C#/NuGet library that abstracts out common functionality for test setup and teardown.

Table of Contents

• Relativity.Testing.Framework
  • Table of Contents
  • Supported Relativity Versions
  • Documentation
  • Where to get help
  • Build Tasks
  • Local Testing
    • Unit Testing
  • Contributing
  • Maintainers
  • Reporting Issues and Adding Feature Enhancements

Supported Relativity Versions

The Relativity Testing Framework repository for RelativityOne will no longer be available publicly beginning 2024/05/31.  Developers are recommended to move towards using the Relativity APIs directly. See post from Community Site here.

Relativity Testing Framework will continue to be supported for Relativity Server development. Effective with the Server 2023 release you can find the latest Relativity Testing Framework SDK package on the Server SDK package feed here. For more information on the Server SDK feed and go-forward Server SDK strategy please see here.

Documentation

For more details and common usage patterns check out our documentation.

Where to get help

• For general help and questions, please start a Discussion.

Build Tasks

This repository builds with the dotnet sdk. It supports standard tasks like dotnet build, dotnet test, and dotnet pack.

Local Testing

Unit Testing

Run through the standard compile and (unit) test tasks. These can be done without any external environment to test on.

dotnet build source
dotnet test source

Contributing

See CONTRIBUTING.md.

Maintainers

The Developer Environments team is the primary care-taker of this repository.

Reporting Issues and Adding Feature Enhancements

For bug reports or feature enhancements, please create an Issue using the respective template. Before reporting an issue, please follow these guidelines. It helps us in understanding the request and provide a quicker response time.

• Determine if it's a bug report or a feature enhancement.
• Perform a quick search in the issue tracker to see if the issue has already been reported. If it has, add a comment to the existing issue instead of opening a new one.
• If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.