HierarchicalTopicMappingServiceTest.cs

/*==============================================================================================================================
| Author        Ignia, LLC
| Client        Ignia, LLC
| Project       Topics Library
\=============================================================================================================================*/
using OnTopic.Data.Caching;
using OnTopic.Mapping.Hierarchical;
using OnTopic.Repositories;
using OnTopic.TestDoubles;
using OnTopic.Tests.Fixtures;
using Xunit;

namespace OnTopic.Tests {

  /*============================================================================================================================
  | CLASS: HIERARCHICAL TOPIC MAPPING SERVICE TEST
  \---------------------------------------------------------------------------------------------------------------------------*/
  /// <summary>
  ///   Provides unit tests for the <see cref="HierarchicalTopicMappingService{T}"/>.
  /// </summary>
  [ExcludeFromCodeCoverage]
  [Xunit.Collection("Shared Repository")]
  public class HierarchicalTopicMappingServiceTest: IClassFixture<TopicInfrastructureFixture<StubTopicRepository>> {

    /*==========================================================================================================================
    | PRIVATE VARIABLES
    \-------------------------------------------------------------------------------------------------------------------------*/
    readonly                    ITopicRepository                _topicRepository;
    readonly                    Topic                           _topic;

    /*==========================================================================================================================
    | HIERARCHICAL TOPIC MAPPING SERVICE
    \-------------------------------------------------------------------------------------------------------------------------*/
    private readonly IHierarchicalTopicMappingService<NavigationTopicViewModel> _hierarchicalMappingService;

    /*==========================================================================================================================
    | CONSTRUCTOR
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Initializes a new instance of the <see cref="HierarchicalTopicMappingServiceTest"/> with shared resources.
    /// </summary>
    /// <remarks>
    ///   This uses the <see cref="StubTopicRepository"/> to provide data, and then <see cref="CachedTopicRepository"/> to
    ///   manage the in-memory representation of the data. While this introduces some overhead to the tests, the latter is a
    ///   relatively lightweight façade to any <see cref="ITopicRepository"/>, and prevents the need to duplicate logic for
    ///   crawling the object graph. In addition, it initializes a shared <see cref="Topic"/> reference to use for the various
    ///   tests.
    /// </remarks>
    public HierarchicalTopicMappingServiceTest(TopicInfrastructureFixture<StubTopicRepository> fixture) {

      /*------------------------------------------------------------------------------------------------------------------------
      | Validate parameters
      \-----------------------------------------------------------------------------------------------------------------------*/
      Contract.Requires(fixture, nameof(fixture));

      /*------------------------------------------------------------------------------------------------------------------------
      | Establish dependencies
      \-----------------------------------------------------------------------------------------------------------------------*/
      _topicRepository          = fixture.CachedTopicRepository;
      _topic                    =  _topicRepository.Load("Root:Web:Web_3:Web_3_0")!;

      /*------------------------------------------------------------------------------------------------------------------------
      | Establish hierarchical topic mapping service
      \-----------------------------------------------------------------------------------------------------------------------*/
      _hierarchicalMappingService = new CachedHierarchicalTopicMappingService<NavigationTopicViewModel>(
        new HierarchicalTopicMappingService<NavigationTopicViewModel>(
          fixture.TopicRepository,
          fixture.MappingService
        )
      );

    }

    /*==========================================================================================================================
    | TEST: GET HIERARCHICAL ROOT: WITH NULL TOPIC: RETURNS DEFAULT ROOT
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Calls <see cref="HierarchicalTopicMappingService{T}.GetHierarchicalRoot(Topic?, Int32, String)"/> method with no
    ///   <c>currentTopic</c> and ensures it falls back to the <c>defaultRoot</c>.
    /// </summary>
    [Fact]
    public void GetHierarchicalRoot_WithNullTopic_ReturnsDefaultRoot() {

      var rootTopic             = _hierarchicalMappingService.GetHierarchicalRoot(null, 2, "Configuration");

      Assert.NotNull(rootTopic);
      Assert.Equal("Configuration", rootTopic?.Key);

    }

    /*==========================================================================================================================
    | TEST: GET HIERARCHICAL ROOT: WITH NULL TOPIC: THROWS EXCEPTION
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Calls <see cref="HierarchicalTopicMappingService{T}.GetHierarchicalRoot(Topic?, Int32, String)"/> method with no
    ///   <c>currentTopic</c> or <c>defaultRoot</c> and ensures it throws an <see cref="ArgumentNullException"/>.
    /// </summary>
    [Fact]
    public void GetHierarchicalRoot_WithNullTopic_ThrowsException() =>
      Assert.Throws<ArgumentNullException>(() =>
        _hierarchicalMappingService.GetHierarchicalRoot(null, 2, "")
      );

    /*==========================================================================================================================
    | TEST: GET HIERARCHICAL ROOT: WITH INVALID DEFAULT ROOT: TRHOWS EXCEPTION
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Calls <see cref="HierarchicalTopicMappingService{T}.GetHierarchicalRoot(Topic?, Int32, String)"/> method with no
    ///   <c>currentTopic</c> and throws an <see cref="ArgumentException"/> when it cannot identify the <c>defaultRoot</c>.
    /// </summary>
    [Fact]
    public void GetHierarchicalRoot_WithInvalidDefaultRoot_ThrowsException() =>
      Assert.Throws<ArgumentOutOfRangeException>(() =>
        _hierarchicalMappingService.GetHierarchicalRoot(null, 2, "InvalidDefaultRoot")
      );

    /*==========================================================================================================================
    | TEST: GET HIERARCHICAL ROOT: WITH DEEP TOPIC: RETURNS ROOT
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Calls <see cref="HierarchicalTopicMappingService{T}.GetHierarchicalRoot(Topic?, Int32, String)"/> method with a deeply
    ///   nested topic and ensures that it returns the expected root.
    /// </summary>
    [Fact]
    public void GetHierarchicalRoot_WithDeepTopic_ReturnsRoot() {

      var rootTopic             = _hierarchicalMappingService.GetHierarchicalRoot(_topic, 2, "Configuration");

      Assert.NotNull(rootTopic);
      Assert.Equal("Web", rootTopic?.Key);

    }

    /*==========================================================================================================================
    | TEST: GET VIEW MODEL: WITH TWO LEVELS: RETURNS GRAPH
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Calls <see cref="HierarchicalTopicMappingService{T}.GetViewModelAsync(Topic?, Int32, Func{Topic, Boolean}?)"/> method
    ///   and ensures that the expected data is returned.
    /// </summary>
    [Fact]
    public async Task GetViewModel_WithTwoLevels_ReturnsGraph() {

      var rootTopic             = _topicRepository.Load("Root:Web");
      var viewModel             = await _hierarchicalMappingService.GetViewModelAsync(rootTopic, 1).ConfigureAwait(false);

      Assert.NotNull(viewModel);
      Assert.Equal(3, viewModel?.Children.Count);
      Assert.Empty(viewModel?.Children[0].Children);

    }

    /*==========================================================================================================================
    | TEST: GET VIEW MODEL: WITH VALIDATION DELEGATE: EXCLUDES TOPICS
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Calls <see cref="HierarchicalTopicMappingService{T}.GetViewModelAsync(Topic?, Int32, Func{Topic, Boolean}?)"/> method
    ///   with a <c>validationDelegate</c> and ensures that it correctly trims the topic graph.
    /// </summary>
    [Fact]
    public async Task GetViewModel_WithValidationDelegate_ExcludesTopics() {

      var rootTopic             = _topicRepository.Load("Root:Web");
      var viewModel             = await _hierarchicalMappingService
        .GetViewModelAsync(rootTopic, 2, (t) => t.Key.EndsWith("1", StringComparison.Ordinal))
        .ConfigureAwait(false);

      Assert.NotNull(viewModel);
      Assert.Single(viewModel?.Children);
      Assert.Single(viewModel?.Children[0].Children);

    }

    /*==========================================================================================================================
    | TEST: GET VIEW MODEL: WITH DISABLED: EXCLUDES DISABLED
    \-------------------------------------------------------------------------------------------------------------------------*/
    /// <summary>
    ///   Calls <see cref="HierarchicalTopicMappingService{T}.GetViewModelAsync(Topic?, Int32, Func{Topic, Boolean}?)"/> method
    ///   with a <see cref="Topic.IsDisabled"/> topic in the graph, and ensures it is not returned.
    /// </summary>
    [Fact]
    public async Task GetViewModel_WithDisabled_ExcludesDisabled() {

      var rootTopic             = _topicRepository.Load("Root:Web:Web_3")!;
      var disabledTopic         = _topicRepository.Load("Root:Web:Web_3:Web_3_0");

      Contract.Assume(disabledTopic);

      rootTopic.IsDisabled      = true;
      disabledTopic.IsDisabled  = true;

      var viewModel             = await _hierarchicalMappingService.GetViewModelAsync(rootTopic, 1).ConfigureAwait(false);

      Assert.NotNull(viewModel);
      Assert.Single(viewModel?.Children);

      //Revert state
      rootTopic.IsDisabled      = false;
      disabledTopic.IsDisabled  = false;

    }

  } //Class
} //Namespace