NextGenSoftware.Holochain.HoloNET.Client.TestHarness 2.0.1

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package NextGenSoftware.Holochain.HoloNET.Client.TestHarness --version 2.0.1
NuGet\Install-Package NextGenSoftware.Holochain.HoloNET.Client.TestHarness -Version 2.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="NextGenSoftware.Holochain.HoloNET.Client.TestHarness" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add NextGenSoftware.Holochain.HoloNET.Client.TestHarness --version 2.0.1
#r "nuget: NextGenSoftware.Holochain.HoloNET.Client.TestHarness, 2.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install NextGenSoftware.Holochain.HoloNET.Client.TestHarness as a Cake Addin
#addin nuget:?package=NextGenSoftware.Holochain.HoloNET.Client.TestHarness&version=2.0.1

// Install NextGenSoftware.Holochain.HoloNET.Client.TestHarness as a Cake Tool
#tool nuget:?package=NextGenSoftware.Holochain.HoloNET.Client.TestHarness&version=2.0.1

HoloNET Test Harness

Test Harness for HoloNET Holochain Client.

https://github.com/holochain-open-dev/holochain-client-csharp
https://github.com/NextGenSoftwareUK/holochain-client-csharp

You need to clone the following repo: https://github.com/holochain/happ-build-tutorial

And follow the instructions here: https://github.com/holochain-open-dev/wiki/wiki/Installing-Holochain--&-Building-hApps-Natively-On-Windows

Once you have Holochain setup on your machine and got the example hApp ready above, you need to copy it into a hApps folder in the root of the output folder (Debug or Release) where you installed this Test Harness package. HoloNET will be looking for it there.

The Test Harness sets the paths to the test hApp you compiled above using the following lines:

_holoNETClient.Config.FullPathToRootHappFolder = string.Concat(Environment.CurrentDirectory, @"\hApps\happ-build-tutorial-develop");
_holoNETClient.Config.FullPathToCompiledHappFolder = string.Concat(Environment.CurrentDirectory, @"\hApps\happ-build-tutorial-develop\workdir\happ");

If you wish to run the OASIS test (real world use case saving and loading an entry) then you will need to clone this repo:
https://github.com/NextGenSoftwareUK/OASIS-Holochain-hApp

The Test Harness will set the paths to the OASIS hApp you compiled above using the following lines:

_holoNETClient.Config.FullPathToRootHappFolder = string.Concat(Environment.CurrentDirectory, @"\hApps\OASIS-Holochain-hApp");
_holoNETClient.Config.FullPathToCompiledHappFolder = string.Concat(Environment.CurrentDirectory, @"\hApps\OASIS-Holochain-hApp\zomes\workdir\happ");

Finally, from within your app simply call the following method:

using NextGenSoftware.Holochain.HoloNET.Client.TestHarness;

await HoloNETTestHarness.TestHoloNETClientAsync(TestToRun testToRun);

You can pass in one of these values:

Test Description
WhoAmI Will call zome function whoami on the whoami zome (part of the happ-build-tutorial above).
Numbers Will call zome function add_ten on the numbers zome (part of the happ-build-tutorial above).
Signal Will call zome function test_signal_as_string on the oasis zome.
SaveLoadOASISEntry Will call the zome function create_entry_avatar on the oasis zome and once it receives the ActionHash back from the Holochain Conductor, it will load that entry using get_entry_avatar zome function (part of the OASIS hApp above).
SaveLoadOASISEntryUsingSingleHoloNETAuditEntryBaseClass Will test the new HoloNETAuditEntryBaseClass by extending it with the Avatar class. It will call create_entry_avatar, get_entry_avatar, update_entry_avatar & delete_entry_avatar on the oasis zome and verify the results are as expected. This version will instantiate its own internal HoloNET Client to make calls to the Holochain Conductor.
SaveLoadOASISEntryUsingMultipleHoloNETAuditEntryBaseClasses Will test the new HoloNETAuditEntryBaseClass by extending it with the AvatarMultiple & Holon class. It will call create_entry_avatar, get_entry_avatar, update_entry_avatar & delete_entry_avatar on the oasis zome and verify the results are as expected. This version passes in a HoloNETClient instance that is shared between the AvatarMultiple & Holon classes.
LoadTestNumbers Will call zome function add_ten on the numbers zome 100 times (part of the happ-build-tutorial above).
LoadTestSaveLoadOASISEntry Will call SaveLoadOASISEntry test 100 times (part of the OASIS happ above).

You can also view the full source and run the Test Harness (and edit to suit your needs etc) here:
https://github.com/holochain-open-dev/holochain-client-csharp/tree/main/NextGenSoftware.Holochain.HoloNET.Client.TestHarness

NuGet Package:
https://www.nuget.org/packages/NextGenSoftware.Holochain.HoloNET.Client.TestHarness

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.4 43 5/26/2024
3.0.3 88 5/5/2024
3.0.2 94 4/19/2024
2.2.0 172 5/22/2023
2.1.4 166 4/27/2023
2.1.3 202 4/2/2023
2.1.2 241 3/18/2023
2.1.0 252 2/6/2023
2.0.2 290 1/2/2023
2.0.1 267 12/29/2022
2.0.0 259 12/28/2022
1.3.1 395 10/7/2022
1.3.0 379 10/7/2022
1.2.0 369 10/6/2022
1.1.1 349 9/29/2022
1.1.0 397 9/29/2022
1.0.2 411 8/24/2022
1.0.1 417 8/24/2022
1.0.0 391 8/23/2022

- Now defaults to Auto-Starting and Auto-Shutting down the Holochain Conductors (as it use to in previous versions).
- Fixed a bug in the SaveLoadOASISEntry test where additional new properties needed to be passed in (new audit ones) to match the latest hApp OASIS rust code.
- Added new OnHolochainConductorsShutdownComplete & OnHoloNETShutdownComplete event handlers to HoloNET Test Harness.
- Organised examples into new Examples folder in HoloNET Test Harness so is easier to find and understand.
- Added additional commenting/documentation on how to use the new HoloNETAuditEntryBaseClass so is easier to understand in in HoloNET Test Harness.
- Added new AvatarEntryDataObject to HoloNET Test Harness to use as example of how to use the CallZomeFunction overloads that either pass in the type of a EntryDataObject to map to or the actual object itself.