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

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

using System;
using System.Collections.Generic;
using System.Data;
using System.IO;
using System.Linq;
using System.Text;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using NUnit.Framework;
using Umbraco.Cms.Core.Configuration.Models;
using Umbraco.Cms.Core.Hosting;
using Umbraco.Cms.Core.IO;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Persistence.Repositories;
using Umbraco.Cms.Infrastructure.Persistence.Repositories.Implement;
using Umbraco.Cms.Tests.Common.TestHelpers;
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.None, Logger = UmbracoTestOptions.Logger.Console)]
    public class StylesheetRepositoryTest : UmbracoIntegrationTest
    {
        private FileSystems _fileSystems;
        private IFileSystem _fileSystem;

        private IHostingEnvironment HostingEnvironment => GetRequiredService<IHostingEnvironment>();

        [SetUp]
        public void SetUpFileSystem()
        {
            string path = HostingEnvironment.MapPathWebRoot(GlobalSettings.UmbracoCssPath);
            _fileSystem = new PhysicalFileSystem(IOHelper, HostingEnvironment, GetRequiredService<ILogger<PhysicalFileSystem>>(), path, "/css");

            _fileSystems = FileSystemsCreator.CreateTestFileSystems(LoggerFactory, IOHelper, GetRequiredService<IOptions<GlobalSettings>>(),
                HostingEnvironment,
                null, null, _fileSystem, null, null);

            Stream stream = CreateStream("body {background:#EE7600; color:#FFF;}");
            _fileSystem.AddFile("styles.css", stream);
        }

        [TearDown]
        public void TearDownFileSystem()
        {
            // Delete all files
            Purge((PhysicalFileSystem)_fileSystem, string.Empty);
            _fileSystem = null;
        }

        private IStylesheetRepository CreateRepository()
        {
            var globalSettings = new GlobalSettings();
            return new StylesheetRepository(_fileSystems);
        }

        [Test]
        public void Can_Instantiate_Repository()
        {
            // Arrange
            using (ScopeProvider.CreateScope())
            {
                // Act
                IStylesheetRepository repository = CreateRepository();

                // Assert
                Assert.That(repository, Is.Not.Null);
            }
        }

        [Test]
        public void Can_Perform_Add()
        {
            // Arrange
            using (ScopeProvider.CreateScope())
            {
                IStylesheetRepository repository = CreateRepository();

                // Act
                var stylesheet = new Stylesheet("test-add.css") { Content = "body { color:#000; } .bold {font-weight:bold;}" };
                repository.Save(stylesheet);

                // Assert
                Assert.That(_fileSystem.FileExists("test-add.css"), Is.True);
            }
        }

        [Test]
        public void Can_Perform_Update()
        {
            // Arrange
            using (ScopeProvider.CreateScope())
            {
                IStylesheetRepository repository = CreateRepository();

                // Act
                var stylesheet = new Stylesheet("test-update.css") { Content = "body { color:#000; } .bold {font-weight:bold;}" };
                repository.Save(stylesheet);

                IStylesheet stylesheetUpdate = repository.Get("test-update.css");
                stylesheetUpdate.Content = "body { color:#000; }";
                repository.Save(stylesheetUpdate);

                IStylesheet stylesheetUpdated = repository.Get("test-update.css");

                // Assert
                Assert.That(stylesheetUpdated, Is.Not.Null);
                Assert.That(stylesheetUpdated.HasIdentity, Is.True);
                Assert.That(stylesheetUpdated.Content, Is.EqualTo("body { color:#000; }"));
            }
        }

        [Test]
        public void Can_Perform_Update_With_Property()
        {
            // Arrange
            using (ScopeProvider.CreateScope())
            {
                IStylesheetRepository repository = CreateRepository();

                // Act
                IStylesheet stylesheet = new Stylesheet("test-update.css") { Content = "body { color:#000; } .bold {font-weight:bold;}" };
                repository.Save(stylesheet);

                stylesheet.AddProperty(new StylesheetProperty("Test", "p", "font-size:2em;"));

                repository.Save(stylesheet);

                // re-get
                stylesheet = repository.Get(stylesheet.Name);

                // Assert
                Assert.That(stylesheet.Content, Is.EqualTo("body { color:#000; } .bold {font-weight:bold;}\r\n\r\n/**umb_name:Test*/\r\np {\r\n\tfont-size:2em;\r\n}".Replace("\r\n", Environment.NewLine)));
                Assert.AreEqual(1, stylesheet.Properties.Count());
            }
        }

        [Test]
        public void Throws_When_Adding_Duplicate_Properties()
        {
            // Arrange
            using (ScopeProvider.CreateScope())
            {
                IStylesheetRepository repository = CreateRepository();

                // Act
                var stylesheet = new Stylesheet("test-update.css") { Content = "body { color:#000; } .bold {font-weight:bold;}" };
                repository.Save(stylesheet);

                stylesheet.AddProperty(new StylesheetProperty("Test", "p", "font-size:2em;"));

                Assert.Throws<DuplicateNameException>(() => stylesheet.AddProperty(new StylesheetProperty("test", "p", "font-size:2em;")));
            }
        }

        [Test]
        public void Can_Perform_Delete()
        {
            // Arrange
            using (ScopeProvider.CreateScope())
            {
                IStylesheetRepository repository = CreateRepository();

                // Act
                var stylesheet = new Stylesheet("test-delete.css") { Content = "body { color:#000; } .bold {font-weight:bold;}" };
                repository.Save(stylesheet);

                repository.Delete(stylesheet);

                // Assert
                Assert.That(_fileSystem.FileExists("test-delete.css"), Is.False);
            }
        }

        [Test]
        public void Can_Perform_Get()
        {
            // Arrange
            using (ScopeProvider.CreateScope())
            {
                IStylesheetRepository repository = CreateRepository();

                // Act
                IStylesheet stylesheet = repository.Get("styles.css");

                // Assert
                Assert.That(stylesheet, Is.Not.Null);
                Assert.That(stylesheet.HasIdentity, Is.True);
                Assert.That(stylesheet.Content, Is.EqualTo("body {background:#EE7600; color:#FFF;}"));
                //// Assert.That(repository.ValidateStylesheet(stylesheet), Is.True); //TODO this can't be activated before we handle file systems correct
            }
        }

        [Test]
        public void Can_Perform_GetAll()
        {
            // Arrange
            using (ScopeProvider.CreateScope())
            {
                IStylesheetRepository repository = CreateRepository();

                var stylesheet = new Stylesheet("styles-v2.css") { Content = "body { color:#000; } .bold {font-weight:bold;}" };
                repository.Save(stylesheet);

                // Act
                IEnumerable<IStylesheet> stylesheets = repository.GetMany();

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

        [Test]
        public void Can_Perform_GetAll_With_Params()
        {
            // Arrange
            using (ScopeProvider.CreateScope())
            {
                IStylesheetRepository repository = CreateRepository();

                var stylesheet = new Stylesheet("styles-v2.css") { Content = "body { color:#000; } .bold {font-weight:bold;}" };
                repository.Save(stylesheet);

                // Act
                IEnumerable<IStylesheet> stylesheets = repository.GetMany("styles-v2.css", "styles.css");

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

        [Test]
        public void Can_Perform_Exists()
        {
            // Arrange
            using (ScopeProvider.CreateScope())
            {
                IStylesheetRepository repository = CreateRepository();

                // Act
                bool exists = repository.Exists("styles.css");

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

        [Test]
        public void PathTests()
        {
            // unless noted otherwise, no changes / 7.2.8
            using (ScopeProvider.CreateScope())
            {
                IStylesheetRepository repository = CreateRepository();

                IStylesheet stylesheet = new Stylesheet("test-path-1.css") { Content = "body { color:#000; } .bold {font-weight:bold;}" };
                repository.Save(stylesheet);

                Assert.IsTrue(_fileSystem.FileExists("test-path-1.css"));
                Assert.AreEqual("test-path-1.css", stylesheet.Path);
                Assert.AreEqual("/css/test-path-1.css", stylesheet.VirtualPath);

                stylesheet = new Stylesheet("path-2/test-path-2.css") { Content = "body { color:#000; } .bold {font-weight:bold;}" };
                repository.Save(stylesheet);

                Assert.IsTrue(_fileSystem.FileExists("path-2/test-path-2.css"));
                Assert.AreEqual("path-2\\test-path-2.css".Replace("\\", $"{Path.DirectorySeparatorChar}"), stylesheet.Path);
                Assert.AreEqual("/css/path-2/test-path-2.css", stylesheet.VirtualPath);

                stylesheet = repository.Get("path-2/test-path-2.css");
                Assert.IsNotNull(stylesheet);
                Assert.AreEqual("path-2\\test-path-2.css".Replace("\\", $"{Path.DirectorySeparatorChar}"), stylesheet.Path);
                Assert.AreEqual("/css/path-2/test-path-2.css", stylesheet.VirtualPath);

                stylesheet = new Stylesheet("path-2\\test-path-3.css") { Content = "body { color:#000; } .bold {font-weight:bold;}" };
                repository.Save(stylesheet);

                Assert.IsTrue(_fileSystem.FileExists("path-2/test-path-3.css"));
                Assert.AreEqual("path-2\\test-path-3.css".Replace("\\", $"{Path.DirectorySeparatorChar}"), stylesheet.Path);
                Assert.AreEqual("/css/path-2/test-path-3.css", stylesheet.VirtualPath);

                stylesheet = repository.Get("path-2/test-path-3.css");
                Assert.IsNotNull(stylesheet);
                Assert.AreEqual("path-2\\test-path-3.css".Replace("\\", $"{Path.DirectorySeparatorChar}"), stylesheet.Path);
                Assert.AreEqual("/css/path-2/test-path-3.css", stylesheet.VirtualPath);

                stylesheet = repository.Get("path-2\\test-path-3.css");
                Assert.IsNotNull(stylesheet);
                Assert.AreEqual("path-2\\test-path-3.css".Replace("\\", $"{Path.DirectorySeparatorChar}"), stylesheet.Path);
                Assert.AreEqual("/css/path-2/test-path-3.css", stylesheet.VirtualPath);

                stylesheet = new Stylesheet("..\\test-path-4.css") { Content = "body { color:#000; } .bold {font-weight:bold;}" };
                Assert.Throws<UnauthorizedAccessException>(() =>
                    repository.Save(stylesheet));

                stylesheet = new Stylesheet("\\test-path-5.css") { Content = "body { color:#000; } .bold {font-weight:bold;}" };
                repository.Save(stylesheet);

                stylesheet = repository.Get("\\test-path-5.css");
                Assert.IsNotNull(stylesheet);
                Assert.AreEqual("test-path-5.css", stylesheet.Path);
                Assert.AreEqual("/css/test-path-5.css", stylesheet.VirtualPath);

                stylesheet = repository.Get("missing.css");
                Assert.IsNull(stylesheet);

                // #7713 changes behaviour to return null when outside the filesystem
                // to accomodate changing the CSS path and not flooding the backoffice with errors
                stylesheet = repository.Get("..\\test-path-4.css"); // outside the filesystem, does not exist
                Assert.IsNull(stylesheet);

                stylesheet = repository.Get("../packages.config"); // outside the filesystem, exists
                Assert.IsNull(stylesheet);
            }
        }

        private void Purge(PhysicalFileSystem fs, string path)
        {
            IEnumerable<string> files = fs.GetFiles(path, "*.css");
            foreach (string file in files)
            {
                fs.DeleteFile(file);
            }

            IEnumerable<string> dirs = fs.GetDirectories(path);
            foreach (string dir in dirs)
            {
                Purge(fs, dir);
                fs.DeleteDirectory(dir);
            }
        }

        protected Stream CreateStream(string contents = null)
        {
            if (string.IsNullOrEmpty(contents))
            {
                contents = "/* test */";
            }

            byte[] bytes = Encoding.UTF8.GetBytes(contents);
            var stream = new MemoryStream(bytes);

            return stream;
        }
    }
}