Introduce OrchardCore.Testing APIs

[hishamco]

This is one of the PRs that I'm working on testing part of Orchard Core, the plan is to provide an essential testing APIs infrastructure for creating unit tests easily for OC APIs and modules

For reference #11865 (comment)
Fixes #11865.

[hishamco]

@sebastienros could you please have a look, coz we need to move forward after this to cover UI testing

[sebastienros]

Can you give more details about the changes in this PR? Like "New project named ... that users can reference to create tests", and other new interfaces or methods.

[MichaelPetrinolis]

OrchardCore.Testing should not depend on CMS.Web project

[MichaelPetrinolis]

add a static action to be able to configure the IHostBuilder
public static Action ConfigureHostBuilderAction { get; set; }
So in a Context, in a static constructor one could configure the host eg. to use NServicebus

[hishamco]

We might defer this for now and add it later, the aim is to extract what we have nowadays into OC.Testing then we can add helper features

[MichaelPetrinolis]

override the CreateHost method to configure the IHostBuilder based on the SiteContextOptions.ConfigureHostBuilderAction
eg.

    protected override IHost CreateHost(IHostBuilder builder)
    {
        if (SiteContextOptions.ConfigureHostBuilderAction != null)
        {
            SiteContextOptions.ConfigureHostBuilderAction.Invoke(builder);
        }
        return base.CreateHost(builder);
    }

[hishamco]

Thanks @MichaelPetrinolis for your comment, I will try to react to them, but still I'm asking can we add it as a separated NuGet package or for OC use

[MichaelPetrinolis]

@hishamco an official OC Testing NuGet package, which is used internally by OC project for unit/integration testing, would be beneficial for the community. As a developer, having OOB stubs and mocks that I can use in my own module testing, would be nice to have. Also easily configuring a Site Context and perform integration testing to my module controllers, would be awesome.

please note that the UseCultureAttribute causes issues when running dotnet test from CLI. The reference to xunit seems to cause the failure.

  An assembly specified in the application dependencies manifest (OrchardCore.Testing.deps.json) was not found:
    package: 'AngleSharp', version: '0.17.1'
    path: 'lib/netstandard2.0/AngleSharp.dll'
. Please check the diagnostic logs for more information.

[hishamco]

@hishamco an official OC Testing NuGet package, which is used internally by OC project for unit/integration testing, would be beneficial for the community. As a developer, having OOB stubs and mocks that I can use in my own module testing, would be nice to have. Also easily configuring a Site Context and perform integration testing to my module controllers, would be awesome.

My proposal from the begging to have OrchardCore.Testing for unit testing purpose and probably functional testing, I'm still prefer to separate integration and UI testing into another packages after this PR

please note that the UseCultureAttribute causes issues when running dotnet test from CLI. The reference to xunit seems to cause the failure.

AngleSharp is not related to what I did

[github-actions]

This pull request has merge conflicts. Please resolve those before requesting a review.

[Piedone]

Do you want to get back to this anytime soon, @hishamco? Starting with addressing #13018 (comment).

Otherwise, I welcome refactoring the tests and providing some common packages to make it easier for community members to write tests for their OC modules. (A bit of that we also address with the Lombiq Testing Toolbox but this would be better as part of OC itself.) I didn't look deeply into the code under this PR yet.

Also, you may want to look into AutoMocker: I briefly checked out the code and I see a lot of manual dependency resolution with mocks, while this library takes care of that.

[hishamco]

I am delaying this because I've been working on Playwright and OC integrations last few weeks, hope to have a demo ASAP. Regarding I will try AutoMock and MockQueryable.Moq because they are so useful

[MichaelPetrinolis]

Hello @hishamco, will this PR be a part of OC 2?

[hishamco]

I will try to resolve the changes, there're too much :)

[MichaelPetrinolis]

@hishamco Perfect! If I can help, please let me know.

[hishamco]

@MichaelPetrinolis if you fix the conflict I will be thankful, coz I'm working on other PRs and issues

[MichaelPetrinolis]

@hishamco weekend is over but i will try to get time for it this week.