Umbraco-CMS/src/Umbraco.Tests/Scoping/ScopeFileSystemsTests.cs

using System;
using System.IO;
using System.Text;
using NUnit.Framework;
using Umbraco.Core;
using Umbraco.Core.Composing;
using Umbraco.Core.IO;
using Umbraco.Tests.TestHelpers;
using Umbraco.Tests.Testing;
using Umbraco.Core.Composing.CompositionExtensions;
using FileSystems = Umbraco.Core.IO.FileSystems;

namespace Umbraco.Tests.Scoping
{
    [TestFixture]
    [UmbracoTest(Database = UmbracoTestOptions.Database.NewEmptyPerTest)]
    public class ScopeFileSystemsTests : TestWithDatabaseBase
    {
        public override void SetUp()
        {
            base.SetUp();

            SafeCallContext.Clear();
            ClearFiles(this.IOHelper);
        }

        protected override void ComposeApplication(bool withApplication)
        {
            base.ComposeApplication(withApplication);

            if (!withApplication) return;

            // re-register with actual media fs
            Composition.ComposeFileSystems();
        }

        public override void TearDown()
        {
            base.TearDown();
            SafeCallContext.Clear();
            FileSystems.ResetShadowId();
            ClearFiles(this.IOHelper);
        }

        private static void ClearFiles(IIOHelper ioHelper)
        {
            TestHelper.DeleteDirectory(ioHelper.MapPath("media"));
            TestHelper.DeleteDirectory(ioHelper.MapPath("FileSysTests"));
            TestHelper.DeleteDirectory(ioHelper.MapPath(SystemDirectories.TempData.EnsureEndsWith('/') + "ShadowFs"));
        }

        [TestCase(true)]
        [TestCase(false)]
        public void CreateMediaTest(bool complete)
        {
            var physMediaFileSystem = new PhysicalFileSystem(IOHelper.MapPath("media"), "ignore", IOHelper);
            var mediaFileSystem = Current.MediaFileSystem;

            Assert.IsFalse(physMediaFileSystem.FileExists("f1.txt"));

            var scopeProvider = ScopeProvider;
            using (var scope = scopeProvider.CreateScope(scopeFileSystems: true))
            {
                using (var ms = new MemoryStream(Encoding.UTF8.GetBytes("foo")))
                    mediaFileSystem.AddFile("f1.txt", ms);
                Assert.IsTrue(mediaFileSystem.FileExists("f1.txt"));
                Assert.IsFalse(physMediaFileSystem.FileExists("f1.txt"));
                if (complete)
                    scope.Complete();
                Assert.IsTrue(mediaFileSystem.FileExists("f1.txt"));
                Assert.IsFalse(physMediaFileSystem.FileExists("f1.txt"));
            }

            if (complete)
            {
                Assert.IsTrue(Current.MediaFileSystem.FileExists("f1.txt"));
                Assert.IsTrue(physMediaFileSystem.FileExists("f1.txt"));
            }
            else
            {
                Assert.IsFalse(Current.MediaFileSystem.FileExists("f1.txt"));
                Assert.IsFalse(physMediaFileSystem.FileExists("f1.txt"));
            }
        }

        [Test]
        public void MultiThread()
        {
            var physMediaFileSystem = new PhysicalFileSystem(IOHelper.MapPath("media"), "ignore", new IOHelper());
            var mediaFileSystem = Current.MediaFileSystem;

            var scopeProvider = ScopeProvider;
            using (var scope = scopeProvider.CreateScope(scopeFileSystems: true))
            {
                using (var ms = new MemoryStream(Encoding.UTF8.GetBytes("foo")))
                    mediaFileSystem.AddFile("f1.txt", ms);
                Assert.IsTrue(mediaFileSystem.FileExists("f1.txt"));
                Assert.IsFalse(physMediaFileSystem.FileExists("f1.txt"));

                using (new SafeCallContext())
                {
                    Assert.IsFalse(mediaFileSystem.FileExists("f1.txt"));

                    using (var ms = new MemoryStream(Encoding.UTF8.GetBytes("foo")))
                        mediaFileSystem.AddFile("f2.txt", ms);
                    Assert.IsTrue(mediaFileSystem.FileExists("f2.txt"));
                    Assert.IsTrue(physMediaFileSystem.FileExists("f2.txt"));
                }

                Assert.IsTrue(mediaFileSystem.FileExists("f2.txt"));
                Assert.IsTrue(physMediaFileSystem.FileExists("f2.txt"));
            }
        }

        [Test]
        public void SingleShadow()
        {
            var scopeProvider = ScopeProvider;
            using (var scope = scopeProvider.CreateScope(scopeFileSystems: true))
            {
                using (new SafeCallContext()) // not nesting!
                {
                    // ok to create a 'normal' other scope
                    using (var other = scopeProvider.CreateScope())
                    {
                        other.Complete();
                    }

                    // not ok to create a 'scoped filesystems' other scope
                    // because at the moment we don't support concurrent scoped filesystems
                    Assert.Throws<InvalidOperationException>(() =>
                    {
                        var other = scopeProvider.CreateScope(scopeFileSystems: true);
                    });
                }
            }
        }

        [Test]
        public void SingleShadowEvenDetached()
        {
            var scopeProvider = ScopeProvider;
            using (var scope = scopeProvider.CreateScope(scopeFileSystems: true))
            {
                using (new SafeCallContext()) // not nesting!
                {
                    // not ok to create a 'scoped filesystems' other scope
                    // because at the moment we don't support concurrent scoped filesystems
                    // even a detached one
                    Assert.Throws<InvalidOperationException>(() =>
                    {
                        var other = scopeProvider.CreateDetachedScope(scopeFileSystems: true);
                    });
                }
            }

            var detached = scopeProvider.CreateDetachedScope(scopeFileSystems: true);

            Assert.IsNull(scopeProvider.AmbientScope);

            Assert.Throws<InvalidOperationException>(() =>
            {
                // even if there is no ambient scope, there's a single shadow
                using (var other = scopeProvider.CreateScope(scopeFileSystems: true))
                { }
            });

            scopeProvider.AttachScope(detached);
            detached.Dispose();
        }
    }
}