Umbraco-CMS/tests/Umbraco.Tests.Integration/Umbraco.Infrastructure/Persistence/Repositories/RelationRepositoryTest.cs

// Copyright (c) Umbraco.
// See LICENSE for more details.

using System.Collections.Generic;
using System.Linq;
using Microsoft.Extensions.Logging;
using Moq;
using NUnit.Framework;
using Umbraco.Cms.Core;
using Umbraco.Cms.Core.Cache;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Models.Entities;
using Umbraco.Cms.Core.Persistence.Repositories;
using Umbraco.Cms.Core.Services;
using Umbraco.Cms.Infrastructure.Persistence.Repositories.Implement;
using Umbraco.Cms.Infrastructure.Scoping;
using Umbraco.Cms.Tests.Common.Builders;
using Umbraco.Cms.Tests.Common.Testing;
using Umbraco.Cms.Tests.Integration.Testing;

namespace Umbraco.Cms.Tests.Integration.Umbraco.Infrastructure.Persistence.Repositories;

[TestFixture]
[UmbracoTest(Database = UmbracoTestOptions.Database.NewSchemaPerTest)]
public class RelationRepositoryTest : UmbracoIntegrationTest
{
    [SetUp]
    public void SetUp() => CreateTestData();

    private RelationType _relateContent;
    private RelationType _relateContentType;
    private ContentType _contentType;
    private Content _textpage;
    private Content _subpage;
    private Content _subpage2;
    private Relation _relation;
    private Relation _relation2;

    private IContentTypeService ContentTypeService => GetRequiredService<IContentTypeService>();

    private IContentService ContentService => GetRequiredService<IContentService>();

    private IMediaTypeService MediaTypeService => GetRequiredService<IMediaTypeService>();

    private IMediaService MediaService => GetRequiredService<IMediaService>();

    private IMemberTypeService MemberTypeService => GetRequiredService<IMemberTypeService>();

    private IMemberService GetMemberService() => GetRequiredService<IMemberService>();

    private IRelationService RelationService => GetRequiredService<IRelationService>();

    private IFileService FileService => GetRequiredService<IFileService>();

    private RelationRepository CreateRepository(IScopeProvider provider, out RelationTypeRepository relationTypeRepository)
    {
        relationTypeRepository = (RelationTypeRepository)GetRequiredService<IRelationTypeRepository>();
        return (RelationRepository)GetRequiredService<IRelationRepository>();
    }

    [Test]
    public void Can_Perform_Add_On_RelationRepository()
    {
        // Arrange
        using (var scope = ScopeProvider.CreateScope())
        {
            var repository = CreateRepository(ScopeProvider, out var repositoryType);

            // Act
            var relationType = repositoryType.Get(1);
            var relation = new Relation(_textpage.Id, _subpage.Id, relationType);
            repository.Save(relation);

            // Assert
            Assert.That(relation, Is.Not.Null);
            Assert.That(relation.HasIdentity, Is.True);
        }
    }

    [Test]
    public void Can_Perform_Update_On_RelationRepository()
    {
        // Arrange
        using (var scope = ScopeProvider.CreateScope())
        {
            var repository = CreateRepository(ScopeProvider, out var repositoryType);

            // Act
            var relation = repository.Get(1);
            relation.Comment = "This relation has been updated";
            repository.Save(relation);

            var relationUpdated = repository.Get(1);

            // Assert
            Assert.That(relationUpdated, Is.Not.Null);
            Assert.That(relationUpdated.Comment, Is.EqualTo("This relation has been updated"));
            Assert.AreNotEqual(relationUpdated.UpdateDate, relation.UpdateDate);
        }
    }

    [Test]
    public void Can_Perform_Delete_On_RelationRepository()
    {
        // Arrange
        using (var scope = ScopeProvider.CreateScope())
        {
            var repository = CreateRepository(ScopeProvider, out var repositoryType);

            // Act
            var relation = repository.Get(2);
            repository.Delete(relation);

            var exists = repository.Exists(2);

            // Assert
            Assert.That(exists, Is.False);
        }
    }

    [Test]
    public void Can_Perform_Get_On_RelationRepository()
    {
        // Arrange
        using (var scope = ScopeProvider.CreateScope())
        {
            var repository = CreateRepository(ScopeProvider, out var repositoryType);

            // Act
            var relation = repository.Get(1);

            // Assert
            Assert.That(relation, Is.Not.Null);
            Assert.That(relation.HasIdentity, Is.True);
            Assert.That(relation.ChildId, Is.EqualTo(_subpage.Id));
            Assert.That(relation.ParentId, Is.EqualTo(_textpage.Id));
            Assert.That(relation.RelationType.Alias, Is.EqualTo("relateContentOnCopy"));
        }
    }

    [Test]
    public void Can_Perform_GetAll_On_RelationRepository()
    {
        // Arrange
        using (var scope = ScopeProvider.CreateScope())
        {
            var repository = CreateRepository(ScopeProvider, out var repositoryType);

            // Act
            var relations = repository.GetMany().ToArray();

            // Assert
            Assert.That(relations, Is.Not.Null);
            Assert.That(relations.Any(), Is.True);
            Assert.That(relations.Any(x => x == null), Is.False);
            Assert.That(relations.Count(), Is.EqualTo(2));
        }
    }

    [Test]
    public void Can_Perform_GetAll_With_Params_On_RelationRepository()
    {
        // Arrange
        using (var scope = ScopeProvider.CreateScope())
        {
            var repository = CreateRepository(ScopeProvider, out var repositoryType);

            // Act
            var relations = repository.GetMany(1, 2).ToArray();

            // Assert
            Assert.That(relations, Is.Not.Null);
            Assert.That(relations.Any(), Is.True);
            Assert.That(relations.Any(x => x == null), Is.False);
            Assert.That(relations.Count(), Is.EqualTo(2));
        }
    }

    [Test]
    public void Get_Paged_Parent_Entities_By_Child_Id()
    {
        CreateTestDataForPagingTests(out var createdContent, out var createdMembers, out var createdMedia);

        using (var scope = ScopeProvider.CreateScope())
        {
            var repository = CreateRepository(ScopeProvider, out var relationTypeRepository);

            // Get parent entities for child id
            var parents = repository.GetPagedParentEntitiesByChildId(createdMedia[0].Id, 0, 11, out var totalRecords)
                .ToList();
            Assert.AreEqual(9, totalRecords);
            Assert.AreEqual(9, parents.Count);

            // Add the next page
            parents.AddRange(repository.GetPagedParentEntitiesByChildId(createdMedia[0].Id, 1, 11, out totalRecords));
            Assert.AreEqual(9, totalRecords);
            Assert.AreEqual(9, parents.Count);

            var contentEntities = parents.OfType<IDocumentEntitySlim>().ToList();
            var mediaEntities = parents.OfType<IMediaEntitySlim>().ToList();
            var memberEntities = parents.OfType<IMemberEntitySlim>().ToList();

            Assert.AreEqual(3, contentEntities.Count);
            Assert.AreEqual(3, mediaEntities.Count);
            Assert.AreEqual(3, memberEntities.Count);

            // Only of a certain type
            parents.AddRange(repository.GetPagedParentEntitiesByChildId(createdMedia[0].Id, 0, 100, out totalRecords, UmbracoObjectTypes.Document.GetGuid()));
            Assert.AreEqual(3, totalRecords);

            parents.AddRange(repository.GetPagedParentEntitiesByChildId(createdMedia[0].Id, 0, 100, out totalRecords, UmbracoObjectTypes.Member.GetGuid()));
            Assert.AreEqual(3, totalRecords);

            parents.AddRange(repository.GetPagedParentEntitiesByChildId(createdMedia[0].Id, 0, 100, out totalRecords, UmbracoObjectTypes.Media.GetGuid()));
            Assert.AreEqual(3, totalRecords);

            // Test relations on content
            var contentParents = repository
                .GetPagedParentEntitiesByChildId(createdContent[0].Id, 0, int.MaxValue, out totalRecords).ToList();
            Assert.AreEqual(6, totalRecords);
            Assert.AreEqual(6, contentParents.Count);

            // Test getting relations of specified relation types
            var relatedMediaRelType =
                RelationService.GetRelationTypeByAlias(Constants.Conventions.RelationTypes.RelatedMediaAlias);
            var relatedContentRelType =
                RelationService.GetRelationTypeByAlias(Constants.Conventions.RelationTypes.RelatedDocumentAlias);

            parents = repository.GetPagedParentEntitiesByChildId(createdMedia[0].Id, 0, 11, out totalRecords, new[] { relatedContentRelType.Id, relatedMediaRelType.Id }).ToList();
            Assert.AreEqual(6, totalRecords);
            Assert.AreEqual(6, parents.Count);

            parents = repository.GetPagedParentEntitiesByChildId(createdMedia[0].Id, 1, 11, out totalRecords, new[] { relatedContentRelType.Id, relatedMediaRelType.Id }).ToList();
            Assert.AreEqual(6, totalRecords);
            Assert.AreEqual(0, parents.Count);

            parents = repository.GetPagedParentEntitiesByChildId(createdContent[0].Id, 0, 6, out totalRecords, new[] { relatedContentRelType.Id, relatedMediaRelType.Id }).ToList();
            Assert.AreEqual(3, totalRecords);
            Assert.AreEqual(3, parents.Count);

            parents = repository.GetPagedParentEntitiesByChildId(createdContent[0].Id, 1, 6, out totalRecords, new[] { relatedContentRelType.Id, relatedMediaRelType.Id }).ToList();
            Assert.AreEqual(3, totalRecords);
            Assert.AreEqual(0, parents.Count);
        }
    }

    [Test]
    public void Get_Paged_Parent_Child_Entities_With_Same_Entity_Relation()
    {
        // Create a media item and create a relationship between itself (parent -> child)
        var imageType = MediaTypeBuilder.CreateImageMediaType("myImage");
        MediaTypeService.Save(imageType);
        var media = MediaBuilder.CreateMediaImage(imageType, -1);
        MediaService.Save(media);
        var relType = RelationService.GetRelationTypeByAlias(Constants.Conventions.RelationTypes.RelatedMediaAlias);
        RelationService.Relate(media.Id, media.Id, relType);

        using (var scope = ScopeProvider.CreateScope())
        {
            var repository = CreateRepository(ScopeProvider, out var relationTypeRepository);

            // Get parent entities for child id
            var parents = repository.GetPagedParentEntitiesByChildId(media.Id, 0, 10, out var totalRecords).ToList();
            Assert.AreEqual(1, totalRecords);
            Assert.AreEqual(1, parents.Count);

            // Get child entities for parent id
            var children = repository.GetPagedChildEntitiesByParentId(media.Id, 0, 10, out totalRecords).ToList();
            Assert.AreEqual(1, totalRecords);
            Assert.AreEqual(1, children.Count);
        }
    }

    [Test]
    public void Get_Paged_Child_Entities_By_Parent_Id()
    {
        CreateTestDataForPagingTests(out var createdContent, out var createdMembers, out _);

        using (var scope = ScopeProvider.CreateScope())
        {
            var repository = CreateRepository(ScopeProvider, out _);

            // Get parent entities for child id
            var parents = repository.GetPagedChildEntitiesByParentId(createdContent[0].Id, 0, 6, out var totalRecords)
                .ToList();
            Assert.AreEqual(6, totalRecords);
            Assert.AreEqual(6, parents.Count);

            // Add the next page
            parents.AddRange(repository.GetPagedChildEntitiesByParentId(createdContent[0].Id, 1, 6, out totalRecords));
            Assert.AreEqual(6, totalRecords);
            Assert.AreEqual(6, parents.Count);

            var contentEntities = parents.OfType<IDocumentEntitySlim>().ToList();
            var mediaEntities = parents.OfType<IMediaEntitySlim>().ToList();
            var memberEntities = parents.OfType<IMemberEntitySlim>().ToList();

            Assert.AreEqual(3, contentEntities.Count);
            Assert.AreEqual(3, mediaEntities.Count);
            Assert.AreEqual(0, memberEntities.Count);

            // only of a certain type
            parents.AddRange(repository.GetPagedChildEntitiesByParentId(createdContent[0].Id, 0, 100, out totalRecords, UmbracoObjectTypes.Media.GetGuid()));
            Assert.AreEqual(3, totalRecords);

            parents.AddRange(repository.GetPagedChildEntitiesByParentId(createdMembers[0].Id, 0, 100, out totalRecords, UmbracoObjectTypes.Media.GetGuid()));
            Assert.AreEqual(3, totalRecords);

            parents.AddRange(repository.GetPagedChildEntitiesByParentId(createdContent[0].Id, 0, 100, out totalRecords, UmbracoObjectTypes.Member.GetGuid()));
            Assert.AreEqual(0, totalRecords);

            // Test getting relations of specified relation types
            var relatedMediaRelType =
                RelationService.GetRelationTypeByAlias(Constants.Conventions.RelationTypes.RelatedMediaAlias);
            var relatedContentRelType =
                RelationService.GetRelationTypeByAlias(Constants.Conventions.RelationTypes.RelatedDocumentAlias);

            parents = repository.GetPagedChildEntitiesByParentId(createdContent[0].Id, 0, 6, out totalRecords, new[] { relatedContentRelType.Id, relatedMediaRelType.Id }).ToList();
            Assert.AreEqual(3, totalRecords);
            Assert.AreEqual(3, parents.Count);

            parents = repository.GetPagedChildEntitiesByParentId(createdContent[0].Id, 1, 6, out totalRecords, new[] { relatedContentRelType.Id, relatedMediaRelType.Id }).ToList();
            Assert.AreEqual(3, totalRecords);
            Assert.AreEqual(0, parents.Count);
        }
    }

    private void CreateTestDataForPagingTests(out List<IContent> createdContent, out List<IMember> createdMembers, out List<IMedia> createdMedia)
    {
        // Create content
        createdContent = new List<IContent>();
        var contentType = ContentTypeBuilder.CreateBasicContentType("blah");
        ContentTypeService.Save(contentType);
        for (var i = 0; i < 3; i++)
        {
            var c1 = ContentBuilder.CreateBasicContent(contentType);
            ContentService.Save(c1);
            createdContent.Add(c1);
        }

        // Create related content
        var relatedContent = new List<IContent>();
        for (var i = 0; i < 3; i++)
        {
            var c1 = ContentBuilder.CreateBasicContent(contentType);
            ContentService.Save(c1);
            relatedContent.Add(c1);
        }

        // Create media
        createdMedia = new List<IMedia>();
        var imageType = MediaTypeBuilder.CreateImageMediaType("myImage");
        MediaTypeService.Save(imageType);
        for (var i = 0; i < 3; i++)
        {
            var c1 = MediaBuilder.CreateMediaImage(imageType, -1);
            MediaService.Save(c1);
            createdMedia.Add(c1);
        }

        // Create members
        var memberType = MemberTypeBuilder.CreateSimpleMemberType("simple");
        MemberTypeService.Save(memberType);
        createdMembers = MemberBuilder.CreateSimpleMembers(memberType, 3).ToList();
        GetMemberService().Save(createdMembers);

        var relatedMediaRelType =
            RelationService.GetRelationTypeByAlias(Constants.Conventions.RelationTypes.RelatedMediaAlias);
        var relatedContentRelType =
            RelationService.GetRelationTypeByAlias(Constants.Conventions.RelationTypes.RelatedDocumentAlias);

        // Relate content to media
        foreach (var content in createdContent)
        {
            foreach (var media in createdMedia)
            {
                RelationService.Relate(content.Id, media.Id, relatedMediaRelType);
            }
        }

        // Relate content to content
        foreach (var relContent in relatedContent)
        {
            foreach (var content in createdContent)
            {
                RelationService.Relate(relContent.Id, content.Id, relatedContentRelType);
            }
        }

        // Relate members to media
        foreach (var member in createdMembers)
        {
            foreach (var media in createdMedia)
            {
                RelationService.Relate(member.Id, media.Id, relatedMediaRelType);
            }
        }

        // Create copied content
        var copiedContent = new List<IContent>();
        for (var i = 0; i < 3; i++)
        {
            var c1 = ContentBuilder.CreateBasicContent(contentType);
            ContentService.Save(c1);
            copiedContent.Add(c1);
        }

        var copiedContentRelType =
            RelationService.GetRelationTypeByAlias(Constants.Conventions.RelationTypes.RelateDocumentOnCopyAlias);

        // Relate content to content (mimics copy)
        foreach (var content in createdContent)
        {
            foreach (var cpContent in copiedContent)
            {
                RelationService.Relate(content.Id, cpContent.Id, copiedContentRelType);
            }
        }

        // Create trashed content
        var trashedContent = new List<IContent>();
        for (var i = 0; i < 3; i++)
        {
            var c1 = ContentBuilder.CreateBasicContent(contentType);
            ContentService.Save(c1);
            trashedContent.Add(c1);
        }

        var trashedRelType =
            RelationService.GetRelationTypeByAlias(
                Constants.Conventions.RelationTypes.RelateParentDocumentOnDeleteAlias);

        // Relate to trashed content
        foreach (var trContent in trashedContent)
        {
            foreach (var content in createdContent)
            {
                RelationService.Relate(trContent.Id, content.Id, trashedRelType);
            }
        }

        // Create trashed media
        var trashedMedia = new List<IMedia>();
        for (var i = 0; i < 3; i++)
        {
            var m1 = MediaBuilder.CreateMediaImage(imageType, -1);
            MediaService.Save(m1);
            trashedMedia.Add(m1);
        }

        var trashedMediaRelType =
            RelationService.GetRelationTypeByAlias(Constants.Conventions.RelationTypes
                .RelateParentMediaFolderOnDeleteAlias);

        // Relate to trashed media
        foreach (var trMedia in trashedMedia)
        {
            foreach (var media in createdMedia)
            {
                RelationService.Relate(trMedia.Id, media.Id, trashedMediaRelType);
            }
        }
    }

    [Test]
    public void Can_Perform_Exists_On_RelationRepository()
    {
        // Arrange
        using (var scope = ScopeProvider.CreateScope())
        {
            var repository = CreateRepository(ScopeProvider, out var repositoryType);

            // Act
            var exists = repository.Exists(2);
            var doesntExist = repository.Exists(5);

            // Assert
            Assert.That(exists, Is.True);
            Assert.That(doesntExist, Is.False);
        }
    }

    [Test]
    public void Can_Perform_Count_On_RelationRepository()
    {
        // Arrange
        using (var scope = ScopeProvider.CreateScope())
        {
            var repository = CreateRepository(ScopeProvider, out var repositoryType);

            // Act
            var query = ScopeProvider.CreateQuery<IRelation>().Where(x => x.ParentId == _textpage.Id);
            var count = repository.Count(query);

            // Assert
            Assert.That(count, Is.EqualTo(2));
        }
    }

    [Test]
    public void Can_Perform_GetByQuery_On_RelationRepository()
    {
        // Arrange
        using (var scope = ScopeProvider.CreateScope())
        {
            var repository = CreateRepository(ScopeProvider, out var repositoryType);

            // Act
            var query = ScopeProvider.CreateQuery<IRelation>().Where(x => x.RelationTypeId == _relateContent.Id);
            var relations = repository.Get(query).ToArray();

            // Assert
            Assert.That(relations, Is.Not.Null);
            Assert.That(relations.Any(), Is.True);
            Assert.That(relations.Any(x => x == null), Is.False);
            Assert.That(relations.Count(), Is.EqualTo(2));
        }
    }

    [Test]
    public void Can_Delete_Content_And_Verify_Relation_Is_Removed()
    {
        // Arrange
        using (var scope = ScopeProvider.CreateScope())
        {
            var repository = CreateRepository(ScopeProvider, out var repositoryType);

            var content = ContentService.GetById(_subpage.Id);
            ContentService.Delete(content, -1);

            // Act
            var shouldntExist = repository.Exists(1);
            var shouldExist = repository.Exists(2);

            // Assert
            Assert.That(shouldntExist, Is.False);
            Assert.That(shouldExist, Is.True);
        }
    }

    public void CreateTestData()
    {
        _relateContent = new RelationType(
            "Relate Content on Copy",
            "relateContentOnCopy",
            true,
            Constants.ObjectTypes.Document,
            new Guid("C66BA18E-EAF3-4CFF-8A22-41B16D66A972"),
            false);

        _relateContentType = new RelationType(
            "Relate ContentType on Copy",
            "relateContentTypeOnCopy",
            true,
            Constants.ObjectTypes.DocumentType,
            new Guid("A2CB7800-F571-4787-9638-BC48539A0EFB"),
            false);

        using (var scope = ScopeProvider.CreateScope())
        {
            var accessor = (IScopeAccessor)ScopeProvider;
            var relationTypeRepository = new RelationTypeRepository(accessor, AppCaches.Disabled, Mock.Of<ILogger<RelationTypeRepository>>());
            var entityRepository = new EntityRepository(accessor, AppCaches.Disabled);
            var relationRepository = new RelationRepository(accessor, Mock.Of<ILogger<RelationRepository>>(), relationTypeRepository, entityRepository);

            relationTypeRepository.Save(_relateContent);
            relationTypeRepository.Save(_relateContentType);

            var template = TemplateBuilder.CreateTextPageTemplate();
            FileService.SaveTemplate(template);

            // Create and Save ContentType "umbTextpage" -> (NodeDto.NodeIdSeed)
            _contentType =
                ContentTypeBuilder.CreateSimpleContentType("umbTextpage", "Textpage", defaultTemplateId: template.Id);

            ContentTypeService.Save(_contentType);

            // Create and Save Content "Homepage" based on "umbTextpage" -> (NodeDto.NodeIdSeed + 1)
            _textpage = ContentBuilder.CreateSimpleContent(_contentType);
            ContentService.Save(_textpage, -1);

            // Create and Save Content "Text Page 1" based on "umbTextpage" -> (NodeDto.NodeIdSeed + 2)
            _subpage = ContentBuilder.CreateSimpleContent(_contentType, "Text Page 1", _textpage.Id);
            ContentService.Save(_subpage, -1);

            // Create and Save Content "Text Page 1" based on "umbTextpage" -> (NodeDto.NodeIdSeed + 3)
            _subpage2 = ContentBuilder.CreateSimpleContent(_contentType, "Text Page 2", _textpage.Id);
            ContentService.Save(_subpage2, -1);

            _relation = new Relation(_textpage.Id, _subpage.Id, _relateContent) { Comment = string.Empty };
            _relation2 = new Relation(_textpage.Id, _subpage2.Id, _relateContent) { Comment = string.Empty };
            relationRepository.Save(_relation);
            relationRepository.Save(_relation2);
            scope.Complete();
        }
    }
}