Umbraco-CMS/src/Umbraco.Tests/PublishedContent/PublishedContentDataTableTests.cs

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using Moq;
using NUnit.Framework;
using Umbraco.Core;
using Umbraco.Core.Composing;
using Umbraco.Core.Logging;
using Umbraco.Core.Models;
using Umbraco.Core.Models.PublishedContent;
using Umbraco.Core.PropertyEditors;
using Umbraco.Core.Services;
using Umbraco.Tests.TestHelpers;
using Umbraco.Web;

namespace Umbraco.Tests.PublishedContent
{
    /// <summary>
    /// Unit tests for IPublishedContent and extensions
    /// </summary>
    [TestFixture]
    public class PublishedContentDataTableTests : BaseWebTest
    {
        public override void SetUp()
        {
            base.SetUp();

            // need to specify a different callback for testing
            PublishedContentExtensions.GetPropertyAliasesAndNames = (services, alias) =>
                {
                    var userFields = new Dictionary<string, string>()
                        {
                            {"property1", "Property 1"},
                            {"property2", "Property 2"}
                        };
                    if (alias == "Child")
                    {
                        userFields.Add("property4", "Property 4");
                    }
                    else
                    {
                        userFields.Add("property3", "Property 3");
                    }

                    //ensure the standard fields are there
                    var allFields = new Dictionary<string, string>()
                        {
                            {"Id", "Id"},
                            {"NodeName", "NodeName"},
                            {"NodeTypeAlias", "NodeTypeAlias"},
                            {"CreateDate", "CreateDate"},
                            {"UpdateDate", "UpdateDate"},
                            {"CreatorName", "CreatorName"},
                            {"WriterName", "WriterName"},
                            {"Url", "Url"}
                        };
                    foreach (var f in userFields.Where(f => !allFields.ContainsKey(f.Key)))
                    {
                        allFields.Add(f.Key, f.Value);
                    }
                    return allFields;
                };
            var umbracoContext = GetUmbracoContext("/test");

            //set the UmbracoContext.Current since the extension methods rely on it
            Umbraco.Web.Composing.Current.UmbracoContextAccessor.UmbracoContext = umbracoContext;
        }

        public override void TearDown()
        {
            base.TearDown();
            Umbraco.Web.PublishedContentExtensions.GetPropertyAliasesAndNames = null;
        }

        [Test]
        public void To_DataTable()
        {
            var doc = GetContent(true, 1);
            var dt = doc.ChildrenAsTable(Current.Services);

            Assert.AreEqual(11, dt.Columns.Count);
            Assert.AreEqual(3, dt.Rows.Count);
            Assert.AreEqual("value4", dt.Rows[0]["Property 1"]);
            Assert.AreEqual("value5", dt.Rows[0]["Property 2"]);
            Assert.AreEqual("value6", dt.Rows[0]["Property 4"]);
            Assert.AreEqual("value7", dt.Rows[1]["Property 1"]);
            Assert.AreEqual("value8", dt.Rows[1]["Property 2"]);
            Assert.AreEqual("value9", dt.Rows[1]["Property 4"]);
            Assert.AreEqual("value10", dt.Rows[2]["Property 1"]);
            Assert.AreEqual("value11", dt.Rows[2]["Property 2"]);
            Assert.AreEqual("value12", dt.Rows[2]["Property 4"]);
        }

        [Test]
        public void To_DataTable_With_Filter()
        {
            var doc = GetContent(true, 1);
            //change a doc type alias
            var c = (TestPublishedContent)doc.Children().ElementAt(0);
            c.ContentType = new PublishedContentType(22, "DontMatch", PublishedItemType.Content, Enumerable.Empty<string>(), Enumerable.Empty<PublishedPropertyType>(), ContentVariation.Nothing);

            var dt = doc.ChildrenAsTable(Current.Services, "Child");

            Assert.AreEqual(11, dt.Columns.Count);
            Assert.AreEqual(2, dt.Rows.Count);
            Assert.AreEqual("value7", dt.Rows[0]["Property 1"]);
            Assert.AreEqual("value8", dt.Rows[0]["Property 2"]);
            Assert.AreEqual("value9", dt.Rows[0]["Property 4"]);
            Assert.AreEqual("value10", dt.Rows[1]["Property 1"]);
            Assert.AreEqual("value11", dt.Rows[1]["Property 2"]);
            Assert.AreEqual("value12", dt.Rows[1]["Property 4"]);
        }

        [Test]
        public void To_DataTable_No_Rows()
        {
            var doc = GetContent(false, 1);
            var dt = doc.ChildrenAsTable(Current.Services);
            //will return an empty data table
            Assert.AreEqual(0, dt.Columns.Count);
            Assert.AreEqual(0, dt.Rows.Count);
        }

        private IPublishedContent GetContent(bool createChildren, int indexVals)
        {
            var dataTypeService = new TestObjects.TestDataTypeService(
                new DataType(new VoidEditor(Mock.Of<ILogger>())) { Id = 1 });

            var factory = new PublishedContentTypeFactory(Mock.Of<IPublishedModelFactory>(), new PropertyValueConverterCollection(Array.Empty<IPropertyValueConverter>()), dataTypeService);
            var contentTypeAlias = createChildren ? "Parent" : "Child";
            var d = new TestPublishedContent
                {
                    CreateDate = DateTime.Now,
                    CreatorId = 1,
                    CreatorName = "Shannon",
                    Id = 3,
                    SortOrder = 4,
                    TemplateId = 5,
                    UpdateDate = DateTime.Now,
                    Path = "-1,3",
                    Version = Guid.NewGuid(),
                    WriterId = 1,
                    WriterName = "Shannon",
                    Parent = null,
                    Level = 1,
                    Children = new List<IPublishedContent>()
                };
            d.SetName("Page" + Guid.NewGuid());
            d.SetUrlSegment("home-page");
            d.Properties = new Collection<IPublishedProperty>(new List<IPublishedProperty>
            {
                new RawValueProperty(factory.CreatePropertyType("property1", 1), d, "value" + indexVals),
                new RawValueProperty(factory.CreatePropertyType("property2", 1), d, "value" + (indexVals + 1))
            });
            if (createChildren)
            {
                d.Children = new List<IPublishedContent>()
                    {
                        GetContent(false, indexVals + 3),
                        GetContent(false, indexVals + 6),
                        GetContent(false, indexVals + 9)
                    };
            }

            if (!createChildren)
            {
                //create additional columns, used to test the different columns for child nodes
                ((Collection<IPublishedProperty>) d.Properties).Add(
                    new RawValueProperty(factory.CreatePropertyType("property4",1), d, "value" + (indexVals + 2)));
            }
            else
            {
                ((Collection<IPublishedProperty>) d.Properties).Add(
                    new RawValueProperty(factory.CreatePropertyType("property3", 1), d, "value" + (indexVals + 2)));
            }

            d.ContentType = new PublishedContentType(22, contentTypeAlias, PublishedItemType.Content, Enumerable.Empty<string>(), Enumerable.Empty<PublishedPropertyType>(), ContentVariation.Nothing);
            return d;
        }

        // note - could probably rewrite those tests using SolidPublishedContentCache
        // l8tr...
        private class TestPublishedContent : IPublishedContent
        {
            private readonly Dictionary<string, string> _names = new Dictionary<string, string>();
            private readonly Dictionary<string, string> _urlSegments = new Dictionary<string, string>();

            public string Url(string culture = null, UrlMode mode = UrlMode.Auto) => default;

            IPublishedContent IPublishedContent.Parent() => Parent;

            IEnumerable<IPublishedContent> IPublishedContent.Children(string culture = null) => Children;

            public IPublishedContent Parent { get; set; }
            public int Id { get; set; }
            public Guid Key { get; set; }
            public int? TemplateId { get; set; }
            public int SortOrder { get; set; }
            public string Name(string culture = null) => _names.TryGetValue(culture ?? "", out var name) ? name : null;
            public void SetName(string name, string culture = null) => _names[culture ?? ""] = name;
            public DateTime CultureDate(string culture = null) => throw new NotSupportedException();
            public IReadOnlyList<string> Cultures => throw new NotSupportedException();
            public string UrlSegment(string culture = null) => _urlSegments.TryGetValue(culture ?? "", out var urlSegment) ? urlSegment : null;
            public void SetUrlSegment(string urlSegment, string culture = null) => _urlSegments[culture ?? ""] = urlSegment;
            public string WriterName { get; set; }
            public string CreatorName { get; set; }
            public int WriterId { get; set; }
            public int CreatorId { get; set; }
            public string Path { get; set; }
            public DateTime CreateDate { get; set; }
            public DateTime UpdateDate { get; set; }
            public Guid Version { get; set; }
            public int Level { get; set; }
            public bool IsDraft(string culture = null) => false;
            public bool IsPublished(string culture = null) => true;

            public IEnumerable<IPublishedProperty> Properties { get; set; }

            public IEnumerable<IPublishedContent> Children { get; set; }

            public IPublishedProperty GetProperty(string alias)
            {
                return Properties.FirstOrDefault(x => x.Alias.InvariantEquals(alias));
            }

            public IPublishedProperty GetProperty(string alias, bool recurse)
            {
                var property = GetProperty(alias);
                if (recurse == false) return property;

                IPublishedContent content = this;
                while (content != null && (property == null || property.HasValue() == false))
                {
                    content = content.Parent();
                    property = content == null ? null : content.GetProperty(alias);
                }

                return property;
            }

            public IPublishedContentType ContentType { get; set; }
        }
    }
}