Relativity.Testing.Framework.Api

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

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

Table of Contents

• Relativity.Testing.Framework.Api
  • Supported Relativity Versions
  • Documentation
  • Where to get help
  • Build Tasks
  • Local Testing
    • Unit Testing
    • Functional Testing
      • Creating Runsettings
      • Running Functional Tests
    • Usage Metrics
  • Contributing
  • Reporting Issues

Supported Relativity Versions

• Official support is only provided for the following versions.
  • RelativityOne current and preview versions
  • Relativity Server 2022 (12.1) and later

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

This repository has unit and functional tests in it. Functional tests have Category=FunctionalTests.

Unit Testing

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

dotnet test ./Source/ --filter TestCategory!=FunctionalTests

Functional Testing

To do the rest of the testing, we need to provide an instance of Relativity to test against. This should ideally be an ephemeral one that we can throw away afterwards.

Creating Runsettings

Before we can run the tests, we'll need to provide a runsettings file that points the tests to the instance of Relativity that is being tested against. To create the runsettings file, run the following command, replacing instance settings parameters with what you need:

./DevelopmentScripts/New-TestSettings.ps1 -ServerBindingType "https" -RelativityHostAddress "YOUR_HOST_ADDRESS" -AdminUsername "YOUR_ADMIN_USERNAME" -AdminPassword "YOUR_ADMIN_PASSWORD"

This script will create FunctionalTest.runsettings and put it next to itself. You shall use this file to setup functional testing.

Running Functional Tests

Run Tests in Visual Studio:

• Attach your runsettings file to the solution in Visual Studio.
• Use the built in test runner.

You can also run functional tests from the command line:

dotnet test ./Source/ --filter TestCategory=FunctionalTests -s .\DevelopmentScripts\FunctionalTest.runsettings

Usage Metrics

EnableApplicationInsights can be set in the RunSettings with the following values to set how much is logged. By default this is set to All and information about your code will be sent to Relativity. For more information about the different logging levels, see Metrics-Collection.

• All
• UsageOnly
• None

Contributing

See CONTRIBUTING.md.

Reporting Issues

For feature enhancements or bug reports, 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.