Tequra.ResultsProcessing.AdapterTemplate 2.3.0

Tequra.ResultsProcessing.AdapterTemplate

This package contains a solution template for a Tequra Results Processing Adapter. Installing this template allows a new solution to be easily created using the .NET Core dotnet new command. The generated solution contains the following:

• A class library (.NET Standard 2.0) where the adapter and configuration classes are defined.
• A console application (.NET 6) which runs the adapter as a standalone process.
• A test project (xUnit) which allows test cases to be defined for testing the functionality of the adapter.

Installation

To install the template run the following command:

dotnet new -i Tequra.ResultsProcessing.AdapterTemplate

This adds "Tequra Results Processing Adapter" (shortname: teqadapt) to the list of installed templates. Note: This command can also be executed to update the existing installed template to the latest version.

To uninstall the template run the following command:

dotnet new -u Tequra.ResultsProcessing.AdapterTemplate

Usage

Enter the following command to create a new solution from the template.

dotnet new teqadapt -o {TARGET_FOLDER}

Recommended naming convention for {TARGET_FOLDER} is: CompanyName.ResultsProcessing.Adapters.AdapterType (e.g. Acme.ResultsProcessing.Adapters.Xcf)

Once the solution has been created, open using Visual Studio or Visual Studio Code.

Complete the following steps to implement a custom adapter:

1. Run the unit tests in the .Test project to check that all the Tequra dependencies have loaded correctly. This uses a dummy adapter and example files, which will be replaced in subsequent steps.
2. Delete the files in the "Example Files" directory in the test project and replace with example files that you want to generate an adapter for.
3. Change the name of the MyAdapter class in the class library project to something more descriptive.
4. Change the name of the MyAdapterConfiguration class in the class library project to something more descriptive.
5. Edit the above two classes to implement your adapter, following the comments generated by the template.
6. Update the unit tests (and add more if necessary) to fully test the functionality of your adapter against different files.

Note: the .App project should not be modified as this is intended to build a console application utilised by the Tequra Analytics Import Service.