ImageSharp/tests/ImageSharp.Tests/ConfigurationTests.cs

// Copyright (c) Six Labors.
// Licensed under the Apache License, Version 2.0.

using System;
using System.Linq;
using Moq;
using SixLabors.ImageSharp.Formats.Bmp;
using SixLabors.ImageSharp.IO;

using Xunit;

// ReSharper disable InconsistentNaming
namespace SixLabors.ImageSharp.Tests
{
    /// <summary>
    /// Tests the configuration class.
    /// </summary>
    public class ConfigurationTests
    {
        public Configuration ConfigurationEmpty { get; }

        public Configuration DefaultConfiguration { get; }

        private readonly int expectedDefaultConfigurationCount = 6;

        public ConfigurationTests()
        {
            // The shallow copy of configuration should behave exactly like the default configuration,
            // so by using the copy, we test both the default and the copy.
            this.DefaultConfiguration = Configuration.CreateDefaultInstance().Clone();
            this.ConfigurationEmpty = new Configuration();
        }

        [Fact]
        public void DefaultsToLocalFileSystem()
        {
            Assert.IsType<LocalFileSystem>(this.DefaultConfiguration.FileSystem);
            Assert.IsType<LocalFileSystem>(this.ConfigurationEmpty.FileSystem);
        }

        /// <summary>
        /// Test that the default configuration is not null.
        /// </summary>
        [Fact]
        public void TestDefaultConfigurationIsNotNull() => Assert.True(this.DefaultConfiguration != null);

        /// <summary>
        /// Test that the default configuration read origin options is set to begin.
        /// </summary>
        [Fact]
        public void TestDefaultConfigurationReadOriginIsCurrent() => Assert.True(this.DefaultConfiguration.ReadOrigin == ReadOrigin.Current);

        /// <summary>
        /// Test that the default configuration parallel options max degrees of parallelism matches the
        /// environment processor count.
        /// </summary>
        [Fact]
        public void TestDefaultConfigurationMaxDegreeOfParallelism()
        {
            Assert.True(this.DefaultConfiguration.MaxDegreeOfParallelism == Environment.ProcessorCount);

            var cfg = new Configuration();
            Assert.True(cfg.MaxDegreeOfParallelism == Environment.ProcessorCount);
        }

        [Theory]
        [InlineData(-3, true)]
        [InlineData(-2, true)]
        [InlineData(-1, false)]
        [InlineData(0, true)]
        [InlineData(1, false)]
        [InlineData(5, false)]
        public void MaxDegreeOfParallelism_CompatibleWith_ParallelOptions(int maxDegreeOfParallelism, bool throws)
        {
            var cfg = new Configuration();
            if (throws)
            {
                Assert.Throws<ArgumentOutOfRangeException>(
                    () => cfg.MaxDegreeOfParallelism = maxDegreeOfParallelism);
            }
            else
            {
                cfg.MaxDegreeOfParallelism = maxDegreeOfParallelism;
                Assert.Equal(maxDegreeOfParallelism, cfg.MaxDegreeOfParallelism);
            }
        }

        [Fact]
        public void ConstructorCallConfigureOnFormatProvider()
        {
            var provider = new Mock<IConfigurationModule>();
            var config = new Configuration(provider.Object);

            provider.Verify(x => x.Configure(config));
        }

        [Fact]
        public void AddFormatCallsConfig()
        {
            var provider = new Mock<IConfigurationModule>();
            var config = new Configuration();
            config.Configure(provider.Object);

            provider.Verify(x => x.Configure(config));
        }

        [Fact]
        public void ConfigurationCannotAddDuplicates()
        {
            Configuration config = this.DefaultConfiguration;

            Assert.Equal(this.expectedDefaultConfigurationCount, config.ImageFormats.Count());

            config.ImageFormatsManager.AddImageFormat(BmpFormat.Instance);

            Assert.Equal(this.expectedDefaultConfigurationCount, config.ImageFormats.Count());
        }

        [Fact]
        public void DefaultConfigurationHasCorrectFormatCount()
        {
            var config = Configuration.CreateDefaultInstance();

            Assert.Equal(this.expectedDefaultConfigurationCount, config.ImageFormats.Count());
        }

        [Fact]
        public void WorkingBufferSizeHint_DefaultIsCorrect()
        {
            Configuration config = this.DefaultConfiguration;
            Assert.True(config.WorkingBufferSizeHintInBytes > 1024);
        }

        [Fact]
        public void StreamBufferSize_DefaultIsCorrect()
        {
            Configuration config = this.DefaultConfiguration;
            Assert.True(config.StreamProcessingBufferSize == 8096);
        }

        [Fact]
        public void StreamBufferSize_CannotGoBelowMinimum()
        {
            var config = new Configuration();

            Assert.Throws<ArgumentOutOfRangeException>(
                    () => config.StreamProcessingBufferSize = 0);
        }
    }
}