ImageSharp/tests/SixLabors.Core.Tests/Helpers/GuardTests.cs

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

using System;
using System.Collections.Generic;
using System.Linq;
using Xunit;

namespace SixLabors.Helpers.Tests
{
    public class GuardTests
    {
        [Fact]
        public void NotNull_TargetNotNull_ThrowsNoException()
        {
            Guard.NotNull("test", "myParamName");
        }

        [Fact]
        public void NotNull_TargetNull_ThrowsException()
        {
            Assert.Throws<ArgumentNullException>(() =>
            {
                Guard.NotNull(null, "myParamName");
            });
        }

        [Fact]
        public void NotNull_TargetNullWithMessage_ThrowsException()
        {
            var exception = Assert.Throws<ArgumentNullException>(() =>
            {
                Guard.NotNull(null, "myParamName", "myTestMessage");
            });

            Assert.Equal("myParamName", exception.ParamName);
            Assert.True(exception.Message.Contains("myTestMessage"));
        }

        [Fact]
        public void NotNullOrEmpty_TargetNotNullOrEmpty_ThrowsNoException()
        {
            Guard.NotNullOrEmpty("test", "myParamName");
        }

        [Fact]
        public void NotNullOrEmpty_TargetNull_ThrowsException()
        {
            Assert.Throws<ArgumentNullException>(() =>
            {
                Guard.NotNullOrEmpty(null, "myParamName");
            });
        }

        [Fact]
        public void NotNullOrEmpty_TargetWhitespace_ThrowsException()
        {
            Assert.Throws<ArgumentException>(() =>
            {
                Guard.NotNullOrEmpty("\n\n", "myParamName");
            });
        }

        [Fact]
        public void NotNullOrEmpty_TargetEmpty_ThrowsException()
        {
            var exception = Assert.Throws<ArgumentException>(() =>
            {
                Guard.NotNullOrEmpty(string.Empty, "myParamName");
            });

            Assert.Equal("myParamName", exception.ParamName);
            Assert.True(exception.Message.Contains("Value cannot be null, empty, or cannot contain only whitespace."));
        }

        [Fact]
        public void NotNullOrEmpty_TargetEmptyWithMessage_ThrowsException()
        {
            var exception = Assert.Throws<ArgumentException>(() =>
            {
                Guard.NotNullOrEmpty(string.Empty, "myParamName", "myTestMessage");
            });

            Assert.Equal("myParamName", exception.ParamName);
            Assert.True(exception.Message.Contains("myTestMessage"));
        }

        [Fact]
        public void NotNullOrEmptyIEnumerable_TargetNotNullOrEmpty_ThrowsNoException()
        {
            Guard.NotNullOrEmpty(new string[] { "test" }, "myParamName");
        }

        [Fact]
        public void NotNullOrEmptyIEnumerable_TargetNull_ThrowsException()
        {
            Assert.Throws<ArgumentNullException>(() =>
            {
                Guard.NotNullOrEmpty((IEnumerable<string>)null, "myParamName");
            });
        }

        [Fact]
        public void NotNullOrEmptyIEnumerable_TargetEmpty_ThrowsException()
        {
            var exception = Assert.Throws<ArgumentException>(() =>
            {
                Guard.NotNullOrEmpty(new string[] { }, "myParamName");
            });

            Assert.Equal("myParamName", exception.ParamName);
            Assert.True(exception.Message.Contains("Value cannot be empty."));
        }

        [Fact]
        public void NotNullOrEmptyIEnumerable_TargetEmptyWithMessage_ThrowsException()
        {
            var exception = Assert.Throws<ArgumentException>(() =>
            {
                Guard.NotNullOrEmpty(new string[] { }, "myParamName", "myTestMessage");
            });

            Assert.Equal("myParamName", exception.ParamName);
            Assert.True(exception.Message.Contains("myTestMessage"));
        }

        [Fact]
        public void MustBeLessThan_IsLess_ThrowsNoException()
        {
            Guard.MustBeLessThan(0, 1, "myParamName");
        }

        [Theory]
        [InlineData(2, 1)]
        [InlineData(1, 1)]
        public void MustBeLessThan_IsGreaterOrEqual_ThrowsNoException(int value, int max)
        {
            var exception = Assert.Throws<ArgumentOutOfRangeException>(() =>
            {
                Guard.MustBeLessThan(value, max, "myParamName");
            });

            Assert.Equal("myParamName", exception.ParamName);
            Assert.True(exception.Message.Contains($"Value must be less than {max}."));
        }

        [Theory]
        [InlineData(0, 1)]
        [InlineData(1, 1)]
        public void MustBeLessThanOrEqualTo_IsLessOrEqual_ThrowsNoException(int value, int max)
        {
            Guard.MustBeLessThanOrEqualTo(value, max, "myParamName");
        }

        [Fact]
        public void MustBeLessThanOrEqualTo_IsGreater_ThrowsNoException()
        {
            var exception = Assert.Throws<ArgumentOutOfRangeException>(() =>
            {
                Guard.MustBeLessThanOrEqualTo(2, 1, "myParamName");
            });

            Assert.Equal("myParamName", exception.ParamName);
            Assert.True(exception.Message.Contains($"Value must be less than or equal to 1."));
        }

        [Fact]
        public void MustBeGreaterThan_IsGreater_ThrowsNoException()
        {
            Guard.MustBeGreaterThan(2, 1, "myParamName");
        }

        [Theory]
        [InlineData(1, 2)]
        [InlineData(1, 1)]
        public void MustBeGreaterThan_IsLessOrEqual_ThrowsNoException(int value, int min)
        {
            var exception = Assert.Throws<ArgumentOutOfRangeException>(() =>
            {
                Guard.MustBeGreaterThan(value, min, "myParamName");
            });

            Assert.Equal("myParamName", exception.ParamName);
            Assert.True(exception.Message.Contains($"Value must be greater than {min}."));
        }

        [Theory]
        [InlineData(2, 1)]
        [InlineData(1, 1)]
        public void MustBeGreaterThanOrEqualTo_IsGreaterOrEqual_ThrowsNoException(int value, int min)
        {
            Guard.MustBeGreaterThanOrEqualTo(value, min, "myParamName");
        }

        [Fact]
        public void MustBeGreaterThanOrEqualTo_IsLess_ThrowsNoException()
        {
            var exception = Assert.Throws<ArgumentOutOfRangeException>(() =>
            {
                Guard.MustBeGreaterThanOrEqualTo(1, 2, "myParamName");
            });

            Assert.Equal("myParamName", exception.ParamName);
            Assert.True(exception.Message.Contains($"Value must be greater than or equal to 2."));
        }

        [Theory]
        [InlineData(1, 1, 3)]
        [InlineData(2, 1, 3)]
        [InlineData(3, 1, 3)]
        public void MustBeBetweenOrEqualTo_IsBetweenOrEqual_ThrowsNoException(int value, int min, int max)
        {
            Guard.MustBeBetweenOrEqualTo(value, min, max, "myParamName");
        }

        [Theory]
        [InlineData(0, 1, 3)]
        [InlineData(4, 1, 3)]
        public void MustBeBetweenOrEqualTo_IsLessOrGreater_ThrowsNoException(int value, int min, int max)
        {
            var exception = Assert.Throws<ArgumentOutOfRangeException>(() =>
            {
                Guard.MustBeBetweenOrEqualTo(value, min, max, "myParamName");
            });

            Assert.Equal("myParamName", exception.ParamName);
            Assert.True(exception.Message.Contains($"Value must be greater than or equal to {min} and less than or equal to {max}."));
        }

        [Fact]
        public void IsTrue_IsTrue_ThrowsNoException()
        {
            Guard.IsTrue(true, "myParamName", "myTestMessage");
        }

        [Fact]
        public void IsTrue_IsFalse_ThrowsException()
        {
            var exception = Assert.Throws<ArgumentException>(() =>
            {
                Guard.IsTrue(false, "myParamName", "myTestMessage");
            });

            Assert.Equal("myParamName", exception.ParamName);
            Assert.True(exception.Message.Contains("myTestMessage"));
        }

        [Fact]
        public void IsFalse_IsFalse_ThrowsNoException()
        {
            Guard.IsFalse(false, "myParamName", "myTestMessage");
        }

        [Fact]
        public void IsFalse_IsTrue_ThrowsException()
        {
            var exception = Assert.Throws<ArgumentException>(() =>
            {
                Guard.IsFalse(true, "myParamName", "myTestMessage");
            });

            Assert.Equal("myParamName", exception.ParamName);
            Assert.True(exception.Message.Contains("myTestMessage"));
        }

        [Theory]
        [InlineData(2, 1)]
        [InlineData(2, 2)]
        public void MustBeSizedAtLeast_Array_LengthIsGreaterOrEqual_ThrowsNoException(int valueLength, int minLength)
        {
            Guard.MustBeSizedAtLeast<int>(new int[valueLength], minLength, "myParamName");
        }

        [Fact]
        public void MustBeSizedAtLeast_Array_LengthIsLess_ThrowsException()
        {
            var exception = Assert.Throws<ArgumentException>(() =>
            {
                Guard.MustBeSizedAtLeast<int>(new int[] { 1, 2 }, 3, "myParamName");
            });

            Assert.Equal("myParamName", exception.ParamName);
            Assert.True(exception.Message.Contains($"The size must be at least 3."));
        }
    }
}