Integration Testing

A guide to getting started with integration testing in Umbraco

These examples are for Umbraco 14. They use NUnit as the testing framework. Leveraging Umbraco.Cms.Tests.Integration providing base classes.

The Umbraco.Tests.Integration project uses version 3.14.0 of the NUnit NuGet package. It is essential to use this version to ensure compatibility. You can check the current package versions used by the Umbraco.Tests.Integration project here.

Getting started

First you have to create a new UnitTest project based on NUnit and install the package into the project.

//Create project
dotnet new nunit
//Install Umbraco.Tests.Integration package
dotnet add package Umbraco.Cms.Tests.Integration

After the project is created and the package is added we have to create a JSON file, named appsettings.Tests.Local.json and a GlobalSetup class.

The package already created an appsettings.Tests.json file. For both files make sure to go to "properties" and set "Copy to output directory" to "always" or "copy if newer".

The GlobalSetup is necessary to call the GlobalSetupTeardown class present in the package. This class makes sure that configuration is read and everything is setup as needed. Here is a sample that can be used:

[SetUpFixture]
public class CustomGlobalSetupTeardown
{
    private static GlobalSetupTeardown _setupTearDown;

    [OneTimeSetUp]
    public void SetUp()
    {
        _setupTearDown = new GlobalSetupTeardown();
        _setupTearDown.SetUp();
    }

    [OneTimeTearDown]
    public void TearDown()
    {
        _setupTearDown.TearDown();
    }
}

The class should not have a namespace.

Creating a test

To create a test you have to create a new class in your project. This class has to be derived from UmbracoIntegrationTest. This gives you access to some helper methods that you can use.

Second is the [UmbracoTest]- attribute that has to be set on the class. This attribute is responsible to set which type of database setup you want to use in your test class.

The available options are:

• None

• NewEmptyPerFixture

• NewEmptyPerTest

• NewSchemaPerFixture

• NewSchemaPerTest

Basic sample:

using Umbraco.Cms.Tests.Integration;

[TestFixture]
[UmbracoTest(Database = UmbracoTestOptions.Database.NewSchemaPerTest)]
public class IntegrationTests : UmbracoIntegrationTest
{

}

Testing a notification

Start by making a NotificationHandler, this example will be of one canceling overwrites on content named "Root", so if you have some content named "Root" published, you cannot change it.

public class MyNotificationHandler : INotificationHandler<ContentSavingNotification>
{
    public void Handle(ContentSavingNotification notification)
    {
        foreach (var content in notification.SavedEntities)
        {
            if (content.PublishName == "Root")
            {
                notification.CancelOperation(new EventMessage("Cancelled", "Please do not change root content",
                    EventMessageType.Error));
            }
        }
    }
}

Then we can make an integration test, we do have to register our notification in the test like you would do with a composer, we can do this by overriding the CustomTestSetupMethod and adding the notification. After this, we can build our ContentType and Content with their respective builders. When we are saving both the ContentType & Content, we need the services to do so, so we use the GetRequiredService<IService> method that can get the services we need. We can then use Assert.Multiple() to do multiple asserts.

[TestFixture]
[UmbracoTest(Database = UmbracoTestOptions.Database.NewSchemaPerTest)]
public class UmbracoTests : UmbracoIntegrationTest
{
    protected override void CustomTestSetup(IUmbracoBuilder builder)
    {
        builder.AddNotificationHandler<ContentSavingNotification, MyNotificationHandler>();
    }

    [Test]
    [TestCase("Root", true, OperationResultType.FailedCancelledByEvent)]
    [TestCase("Home Page", false, OperationResultType.Success)]
    public void Notification_Cancels_ContentType_If_AllowAsRoot(string name, bool hasErrors, OperationResultType expectedResult)
    {
        // Make ContentType and save
        var contentType = new ContentTypeBuilder()
            .WithId(0)
            .WithContentVariation(ContentVariation.Nothing)
            .Build();
        var contentTypeService = GetRequiredService<IContentTypeService>();
        contentTypeService.Save(contentType);

        // Make some Content and publish it
        var content = new ContentBuilder()
            .WithContentType(contentType)
            .WithName(name)
            .Build();

        var contentService = GetRequiredService<IContentService>();
        contentService.Save(content);
        contentService.Publish(content, ["*"]);

        // Try to save the content
        var saveResult = contentService.Save(content);

        // Assert
        var errors = saveResult.EventMessages
            .GetAll()
            .Where(x => x.MessageType == EventMessageType.Error);

        Assert.Multiple(() =>
        {
            Assert.AreEqual(hasErrors, errors.Any());
            Assert.AreEqual(expectedResult, saveResult.Result);
        });
    }
}

Testing with a schema

So one of the awesome things about integration tests, is that you can set up a site, download the package for it, and we can run this state for every test. This means that you do not have to go through and set up your tests with data like we do in the above example with the builder pattern.

To start with we decorate our class with the [UmbracoTest] attribute with your preferred database setup and we again derive from UmbracoIntegrationTest. Then what you wanna do is set up your Umbraco site, go to the packages section and create your own package. Download the package and place the XML file next to your testing class. You want to have the build action of that XML file to be EmbeddedResource and you can set that again in the file's "properties".

Now we're almost ready to start testing! The last thing we wanna do is have a SetUp method to install the package on your site.

[SetUp]
public void MySetup()
{
    var xml = PackageMigrationResource.GetEmbeddedPackageDataManifest(this.GetType());
    var packagingService = GetRequiredService<IPackagingService>();
    packagingService.InstallCompiledPackageData(xml);
}

Now you're all set to start testing with your own site! Let's try and see how that would look! Here's an example test, where we test that content is deleted, if you delete the Document Types, as you can see, this time we do not have to use builder patterns to set up our site!

[Test]
public void Ensure_No_Content_After_Doctype_Is_Deleted()
{
    var contentTypeService = GetRequiredService<IContentTypeService>();
    var contentTypes = contentTypeService.GetAll();
    Assert.AreEqual(true, contentTypes.Any());

    foreach (var contentType in contentTypes)
    {
        if (contentType.ParentId == Constants.System.Root)
        {
            contentTypeService.Delete(contentType);
        }
    }
    var contentService = GetRequiredService<IContentService>();
    var contents = contentService.GetRootContent();

    Assert.AreEqual(0, contents.Count());
    Assert.AreEqual(0, contentTypeService.GetAll().Count());
}

Testing from controller to database

Sometimes we want to test from a controller action and down to the database. In this case, we use the built-in concept of a test server. All you need to do is to use the base class UmbracoTestServerTestBase. Let’s take an example:

[TestFixture]
public class AllCultureControllerTests : UmbracoTestServerTestBase
{
    [Test]
    public async Task EnsureUnauthorizedStatusCode()
    {
        // Arrange
        var url = GetManagementApiUrl<AllCultureController>(x => x.GetAll(CancellationToken.None, 0, 100));

        // Act
        var response = await Client.GetAsync(url);

        // Assert
        Assert.AreEqual(HttpStatusCode.Unauthorized, response.StatusCode);
    }
}

In this example you have to note three things:

• You still need the CustomGlobalSetupTeardown class.

• Use the GetManagementApiUrl to get the URL of an Action and ensure all services use this URL information when requested.

• The Client is a standard HttpClient, but the base URL points to the test server that is set up for each test.

You can still use GetRequiredService to get the services required to seed data.

Keep in mind that integration tests require a lot of setup before the test executes. So execution time will be many times longer compared to a unit test.