Migrating tests that depend on Published Cache from the old test project

[Shazwazza]

There are many tests that weren't ported to netcore due to their reliance on the published cache infrastructure. These tests primarily relied on the old XML cache implementation. These changes make it possible to translate the old XML structures into the 'nucache' Published Cache layer. This is all done in the Unit Tests project because it doesn't rely on integration tests, databases, etc...

The way this works is fairly simple:

• There is a TestNuCacheContentService which is an implementation of INuCacheContentService used to populate nucache. This just takes a collection of ContentNodeKit just like what would happen on startup when we create collections of these from either reading from the bplustree file or from the db.
• For the old XML based tests, there's an adapter: PublishedContentXmlAdapter.GetContentNodeKits. This gets passed some XML and it outputs IEnumerable<ContentNodeKit>. It also outputs a collection of ContentType and DataType that correspond with the XML data. These outputs are then also used to initialize the cache. An example of using this:

          // get some legacy xml
          string xml = GetXml();
          
          // generate some kits
          IEnumerable<ContentNodeKit> kits = PublishedContentXmlAdapter.GetContentNodeKits(
              xml,
              TestHelper.ShortStringHelper,
              out ContentType[] contentTypes,
              out DataType[] dataTypes).ToList();
  
          // initialize the cache with this data (this method is on the base class)
          InitializedCache(kits, contentTypes, dataTypes: dataTypes);
  
          // get the published snapshot (this is on the base class and initializes IPublishedSnapshotAccessor too)
          var snapshot = GetPublishedSnapshot();
  
          // now you can query content/media
          var content = snapshot.Content.GetById(123);

• For tests that are not based on the legacy XML and if you just want to use nucache, there are some new builders:
  • ContentDataBuilder creates ContentData to be used to populate a ContentNodeKit for nucache. This builder will dynamically update any ContentType passed to the Build method based on the data being created in the builder. This helps save some code by not having to manually define all corresponding property types on the ContentType. This also allows for building up variant content data (the XML translator above does not support variant data because the Xml didn't support it).

        var contentType1 = new ContentType(ShortStringHelper, -1);
    
        ContentData item1Data = new ContentDataBuilder()
            .WithName("Content 1")
            .WithProperties(new PropertyDataBuilder()
                .WithPropertyData("welcomeText", "Welcome")
                .WithPropertyData("welcomeText", "Welcome", "en-US")
                .WithPropertyData("welcomeText", "Willkommen", "de")
                .WithPropertyData("welcomeText", "Welkom", "nl")
                .WithPropertyData("welcomeText2", "Welcome")
                .WithPropertyData("welcomeText2", "Welcome", "en-US")
                .WithPropertyData("noprop", "xxx")
                .Build())
            // build with a dynamically created content type
            .Build(ShortStringHelper, propertyDataTypes, contentType1, "ContentType1");

  • ContentNodeKitBuilder: builds a ContentNodeKit for use with nucache. It has a bunch of methods but for the most part it's simpler to use the helper method: ContentNodeKitBuilder.CreateWithContent which gets passed ContentData previously built. The data passed to the Path will dynamically set things like ParentId and Level, though those can be explicitly passed in too. Example (there's lots of examples in this PR):

         ContentNodeKit item1 = ContentNodeKitBuilder.CreateWithContent(
             contentType1.Id,
             1, "-1,1",
             draftData: item1Data,
             publishedData: item1Data);

Completed:

• Delete all old tests, test files, etc... from the old test project that are no longer relevant or have been migrated
• Migrates new v8 tests to the v9 test projects, there were several that weren't migrated after v8 - v9 merges
• Fixes issue for ChildrenAsTable since that was broken
• Removes old dead/test code
• Migrates almost all published cache + routing tests

Breaking changes

These need reviewing but mostly it's just that we had models that should be immutable and based on ctor injection but they weren't. Now they are, but this means binary breaking changes, though some of these may be internal which would be ok. It would be simple to unbreak them by just making the properties mutable again and having an empty ctor overload. But these models should really be immutable in future versions!

TODO

There's only a few more tests to port over:

• MediaUrlProviderTests
• ScopedNuCacheTests - might be tricky, not really sure
• AuthenticationControllerTests

With a little work the builder pattern for ContentNodeKit could probably be simplified further to make creating a nucache data source even easier.

Important!

I had to revert changes from #10845 for SiteDomainMapper + UrlProviderExtensions.

The changes in that PR break functionality and diverge from what is happening in v8. I've made a comment about this here: #10845 (comment)
I'm unsure if other parts of that PR break functionality but the SiteMapperChanges there break several of the tests that have been ported over such as nested domain tests, etc...

IMO I think the whole PR #10845 should be reverted and then re-investigated and also based on v8 because we haven't changed the logic there so if there's a bug, it will in theory also be in v8. And then whatever is fixed must be covered by these tests.

This PR

Next steps

Whenever migrating from v8 -> v9 make sure that you look at any new tests that have been written in the old test project, they will need to be manually moved.