KubeOps.Testing 7.2.0

KubeOps Testing Utilities

The KubeOps.Testing package provides tools to test the custom operator.

To have an example for integration testing a custom operator have a look at the test code in the repository: Integration Tests

The tools provided aid with Integration testing. For normal unit testing, you can just mock all the things.

The main entry point for testing your custom operator is the KubernetesOperatorFactory class. It is meant to be injected into your test.

The following documentation assumes you are using xUnit as a testing framework. The techniques used should be present with other testing frameworks as well.

The following steps are needed for integration testing the controller:

• Create a TestStartup.cs file (or any other name you want)
• Inject the KubernetesOperatorFactory
• Use the mocked client and helper functions to test your operator

Test Startup

This file is very similar to a "normal" Startup.cs file of an asp.net application. Either you subclass it and replace your test mocked services, or you create a new one.

Mocked elements

The main part of this operator factory does mock the used Kubernetes client and helper functions to enqueue events and finalizer events.

Both mocked elements can be retrieved via the operator factory with:

• "MockedKubernetesClient"
• "KubernetesOperatorFactory.EnqueueEvent"
• "KubernetesOperatorFactory.EnqueueFinalization"

Mocked events

With the mentioned factory functions one can fire events for entities. This can be used to test your controllers.

The controllers are normally instantiated via the scope of the DI system.

Mocked IKubernetesClient

The client is essentially an empty implementation of the interface. All methods do return null or the object that was passed into the mocked class. There are five different object references that can be set to return certain results upon calling the client.

The mocked client is injected as singleton, this means the used "result" references can vary. Be aware of that and don't run your tests in parallel if you rely on those results.

Writing a test

Now with all parts in place, we can write a test. You probably need to set the solution relative content root for asp.net testing. But then you can run the factory and create a test.

// Constructor
public TestControllerTest(KubernetesOperatorFactory<TestStartup> factory)
{
    _factory = factory.WithSolutionRelativeContentRoot("tests/KubeOps.TestOperator");

    _controller = _factory.Services
        .GetRequiredService<IControllerInstanceBuilder>()
        .BuildControllers<V1TestEntity>()
        .First();

    _managerMock = _factory.Services.GetRequiredService<Mock<IManager>>();
    _managerMock.Reset();
}

// snip

[Fact]
public async Task Test_If_Manager_Created_Is_Called()
{
    _factory.Run();

    _managerMock.Setup(o => o.Reconciled(It.IsAny<V1TestEntity>()));
    _managerMock.Verify(o => o.Reconciled(It.IsAny<V1TestEntity>()), Times.Never);

    await _controller.StartAsync();
    await _factory.EnqueueEvent(ResourceEventType.Reconcile, new V1TestEntity());
    await _controller.StopAsync();

    _managerMock.Verify(o => o.Reconciled(It.IsAny<V1TestEntity>()), Times.Once);
}