RuleEvaluationTests.cs

using ArchUnitNET.Domain;
using ArchUnitNET.Fluent;
using ArchUnitNET.Fluent.Extensions;
using ArchUnitNET.xUnitV3;
using ArchUnitNETTests.Domain;
using Xunit;
using static System.Environment;
using static ArchUnitNET.Fluent.ArchRuleDefinition;

namespace ArchUnitNETTests.Fluent
{
    public class RuleEvaluationTests
    {
        private const string NoClassName = "NotTheNameOfAnyClass_1592479214";

        private const string ExpectedTrueArchRuleErrorMessage = "All Evaluations passed";
        private static readonly Architecture Architecture =
            StaticTestArchitectures.ArchUnitNETTestArchitecture;

        private static readonly IArchRule TrueArchRule1 = Classes()
            .That()
            .ArePrivate()
            .Should()
            .BePrivate();
        private static readonly IArchRule TrueArchRule2 = Members().Should().Exist();

        private static readonly IArchRule WrongArchRule1 = Classes()
            .That()
            .Are(StaticTestTypes.PublicTestClass)
            .Should()
            .BePrivate();

        private static readonly IArchRule WrongArchRule2 = Classes()
            .That()
            .Are(StaticTestTypes.PublicTestClass)
            .Should()
            .BePrivate()
            .AndShould()
            .BePublic();

        private static readonly IArchRule WrongArchRule3 = Classes()
            .That()
            .Are(StaticTestTypes.PublicTestClass)
            .Should()
            .BePrivate()
            .AndShould()
            .BePublic()
            .OrShould()
            .BeProtected();

        private static readonly IArchRule WrongArchRule4 = Classes()
            .That()
            .HaveName(NoClassName)
            .Should()
            .Exist();

        private static readonly IArchRule WrongArchRule5 = Classes()
            .That()
            .HaveName(NoClassName)
            .Should()
            .BePrivate()
            .AndShould()
            .Exist();

        private static readonly IArchRule WrongArchRule6 = Classes()
            .That()
            .Are(StaticTestTypes.PublicTestClass)
            .Should()
            .NotExist();

        private static readonly IArchRule WrongArchRule7 = Classes()
            .That()
            .Are(StaticTestTypes.PublicTestClass)
            .Should()
            .NotExist()
            .AndShould()
            .BePublic();

        private static readonly IArchRule WrongArchRule8 = Classes()
            .That()
            .Are(StaticTestTypes.PublicTestClass)
            .Should()
            .NotExist()
            .OrShould()
            .BePrivate();

        private static readonly IArchRule WrongArchRule1AndWrongArchRule3 = WrongArchRule1.And(
            WrongArchRule3
        );
        private static readonly IArchRule WrongArchRule4AndWrongArchRule8 = WrongArchRule4.And(
            WrongArchRule8
        );

        private static readonly IArchRule WrongArchRule9 = Classes()
            .That()
            .HaveName(NoClassName)
            .Should()
            .BePrivate();

        private readonly string _expectedWrongArchRule1AndWrongArchRule3ErrorMessage =
            "\"Classes that are \"ArchUnitNETTests.Domain.PublicTestClass\" should be private\" failed:"
            + NewLine
            + "\tArchUnitNETTests.Domain.PublicTestClass is public"
            + NewLine
            + NewLine
            + "\"Classes that are \"ArchUnitNETTests.Domain.PublicTestClass\" should be private and should be public or should be protected\" failed:"
            + NewLine
            + "\tArchUnitNETTests.Domain.PublicTestClass is public"
            + NewLine
            + NewLine;

        private readonly string _expectedWrongArchRule1ErrorMessage =
            "\"Classes that are \"ArchUnitNETTests.Domain.PublicTestClass\" should be private\" failed:"
            + NewLine
            + "\tArchUnitNETTests.Domain.PublicTestClass is public"
            + NewLine
            + NewLine;

        private readonly string _expectedWrongArchRule2ErrorMessage =
            "\"Classes that are \"ArchUnitNETTests.Domain.PublicTestClass\" should be private and should be public\" failed:"
            + NewLine
            + "\tArchUnitNETTests.Domain.PublicTestClass is public"
            + NewLine
            + NewLine;

        private readonly string _expectedWrongArchRule3ErrorMessage =
            "\"Classes that are \"ArchUnitNETTests.Domain.PublicTestClass\" should be private and should be public or should be protected\" failed:"
            + NewLine
            + "\tArchUnitNETTests.Domain.PublicTestClass is public"
            + NewLine
            + NewLine;

        private readonly string _expectedWrongArchRule4AndWrongArchRule8ErrorMessage =
            "\"Classes that have name \"NotTheNameOfAnyClass_1592479214\" should exist\" failed:"
            + NewLine
            + "\tThere are no objects matching the criteria"
            + NewLine
            + NewLine
            + "\"Classes that are \"ArchUnitNETTests.Domain.PublicTestClass\" should not exist or should be private\" failed:"
            + NewLine
            + "\tArchUnitNETTests.Domain.PublicTestClass does exist and is public"
            + NewLine
            + NewLine;

        private readonly string _expectedWrongArchRule4ErrorMessage =
            "\"Classes that have name \"NotTheNameOfAnyClass_1592479214\" should exist\" failed:"
            + NewLine
            + "\tThere are no objects matching the criteria"
            + NewLine
            + NewLine;

        private readonly string _expectedWrongArchRule5ErrorMessage =
            "\"Classes that have name \"NotTheNameOfAnyClass_1592479214\" should be private and should exist\" failed:"
            + NewLine
            + "\tThere are no objects matching the criteria"
            + NewLine
            + NewLine;

        private readonly string _expectedWrongArchRule6ErrorMessage =
            "\"Classes that are \"ArchUnitNETTests.Domain.PublicTestClass\" should not exist\" failed:"
            + NewLine
            + "\tArchUnitNETTests.Domain.PublicTestClass does exist"
            + NewLine
            + NewLine;

        private readonly string _expectedWrongArchRule7ErrorMessage =
            "\"Classes that are \"ArchUnitNETTests.Domain.PublicTestClass\" should not exist and should be public\" failed:"
            + NewLine
            + "\tArchUnitNETTests.Domain.PublicTestClass does exist"
            + NewLine
            + NewLine;

        private readonly string _expectedWrongArchRule8ErrorMessage =
            "\"Classes that are \"ArchUnitNETTests.Domain.PublicTestClass\" should not exist or should be private\" failed:"
            + NewLine
            + "\tArchUnitNETTests.Domain.PublicTestClass does exist and is public"
            + NewLine
            + NewLine;

        private readonly string _expectedWrongArchRule9ErrorMessage =
            "\"Classes that have name \"NotTheNameOfAnyClass_1592479214\" should be private\" failed:"
            + NewLine
            + "\tThe rule requires positive evaluation, not just absence of violations. Use WithoutRequiringPositiveResults() or improve your rule's predicates."
            + NewLine
            + NewLine;

        [Fact]
        public void AssertArchRuleTest()
        {
            ArchRuleAssert.CheckRule(Architecture, TrueArchRule1);
            ArchRuleAssert.CheckRule(Architecture, TrueArchRule2);
            var exception1 = Assert.Throws<FailedArchRuleException>(() =>
                ArchRuleAssert.CheckRule(Architecture, WrongArchRule1)
            );
            var exception2 = Assert.Throws<FailedArchRuleException>(() =>
                ArchRuleAssert.CheckRule(Architecture, WrongArchRule2)
            );
            var exception3 = Assert.Throws<FailedArchRuleException>(() =>
                ArchRuleAssert.CheckRule(Architecture, WrongArchRule3)
            );
            var exception4 = Assert.Throws<FailedArchRuleException>(() =>
                ArchRuleAssert.CheckRule(Architecture, WrongArchRule4)
            );
            var exception5 = Assert.Throws<FailedArchRuleException>(() =>
                ArchRuleAssert.CheckRule(Architecture, WrongArchRule5)
            );
            var exception6 = Assert.Throws<FailedArchRuleException>(() =>
                ArchRuleAssert.CheckRule(Architecture, WrongArchRule6)
            );
            var exception7 = Assert.Throws<FailedArchRuleException>(() =>
                ArchRuleAssert.CheckRule(Architecture, WrongArchRule7)
            );
            var exception8 = Assert.Throws<FailedArchRuleException>(() =>
                ArchRuleAssert.CheckRule(Architecture, WrongArchRule8)
            );
            var exception1And3 = Assert.Throws<FailedArchRuleException>(() =>
                ArchRuleAssert.CheckRule(Architecture, WrongArchRule1AndWrongArchRule3)
            );
            var exception4And8 = Assert.Throws<FailedArchRuleException>(() =>
                ArchRuleAssert.CheckRule(Architecture, WrongArchRule4AndWrongArchRule8)
            );
            var exception9 = Assert.Throws<FailedArchRuleException>(() =>
                ArchRuleAssert.CheckRule(Architecture, WrongArchRule9)
            );

            Assert.Equal(_expectedWrongArchRule1ErrorMessage, exception1.Message);
            Assert.Equal(_expectedWrongArchRule2ErrorMessage, exception2.Message);
            Assert.Equal(_expectedWrongArchRule3ErrorMessage, exception3.Message);
            Assert.Equal(_expectedWrongArchRule4ErrorMessage, exception4.Message);
            Assert.Equal(_expectedWrongArchRule5ErrorMessage, exception5.Message);
            Assert.Equal(_expectedWrongArchRule6ErrorMessage, exception6.Message);
            Assert.Equal(_expectedWrongArchRule7ErrorMessage, exception7.Message);
            Assert.Equal(_expectedWrongArchRule8ErrorMessage, exception8.Message);
            Assert.Equal(
                _expectedWrongArchRule1AndWrongArchRule3ErrorMessage,
                exception1And3.Message
            );
            Assert.Equal(
                _expectedWrongArchRule4AndWrongArchRule8ErrorMessage,
                exception4And8.Message
            );
            Assert.Equal(_expectedWrongArchRule9ErrorMessage, exception9.Message);
        }

        [Fact]
        public void CheckArchRuleTest()
        {
            TrueArchRule1.Check(Architecture);
            TrueArchRule2.Check(Architecture);
            var exception1 = Assert.Throws<FailedArchRuleException>(() =>
                WrongArchRule1.Check(Architecture)
            );
            var exception2 = Assert.Throws<FailedArchRuleException>(() =>
                WrongArchRule2.Check(Architecture)
            );
            var exception3 = Assert.Throws<FailedArchRuleException>(() =>
                WrongArchRule3.Check(Architecture)
            );
            var exception4 = Assert.Throws<FailedArchRuleException>(() =>
                WrongArchRule4.Check(Architecture)
            );
            var exception5 = Assert.Throws<FailedArchRuleException>(() =>
                WrongArchRule5.Check(Architecture)
            );
            var exception6 = Assert.Throws<FailedArchRuleException>(() =>
                WrongArchRule6.Check(Architecture)
            );
            var exception7 = Assert.Throws<FailedArchRuleException>(() =>
                WrongArchRule7.Check(Architecture)
            );
            var exception8 = Assert.Throws<FailedArchRuleException>(() =>
                WrongArchRule8.Check(Architecture)
            );
            var exception1And3 = Assert.Throws<FailedArchRuleException>(() =>
                WrongArchRule1AndWrongArchRule3.Check(Architecture)
            );
            var exception4And8 = Assert.Throws<FailedArchRuleException>(() =>
                WrongArchRule4AndWrongArchRule8.Check(Architecture)
            );

            Assert.Equal(_expectedWrongArchRule1ErrorMessage, exception1.Message);
            Assert.Equal(_expectedWrongArchRule2ErrorMessage, exception2.Message);
            Assert.Equal(_expectedWrongArchRule3ErrorMessage, exception3.Message);
            Assert.Equal(_expectedWrongArchRule4ErrorMessage, exception4.Message);
            Assert.Equal(_expectedWrongArchRule5ErrorMessage, exception5.Message);
            Assert.Equal(_expectedWrongArchRule6ErrorMessage, exception6.Message);
            Assert.Equal(_expectedWrongArchRule7ErrorMessage, exception7.Message);
            Assert.Equal(_expectedWrongArchRule8ErrorMessage, exception8.Message);
            Assert.Equal(
                _expectedWrongArchRule1AndWrongArchRule3ErrorMessage,
                exception1And3.Message
            );
            Assert.Equal(
                _expectedWrongArchRule4AndWrongArchRule8ErrorMessage,
                exception4And8.Message
            );
        }

        [Fact]
        public void CreateErrorMessageTest()
        {
            Assert.Equal(
                ExpectedTrueArchRuleErrorMessage,
                TrueArchRule1.Evaluate(Architecture).ToErrorMessage()
            );
            Assert.Equal(
                ExpectedTrueArchRuleErrorMessage,
                TrueArchRule2.Evaluate(Architecture).ToErrorMessage()
            );
            Assert.Equal(
                _expectedWrongArchRule1ErrorMessage,
                WrongArchRule1.Evaluate(Architecture).ToErrorMessage()
            );
            Assert.Equal(
                _expectedWrongArchRule2ErrorMessage,
                WrongArchRule2.Evaluate(Architecture).ToErrorMessage()
            );
            Assert.Equal(
                _expectedWrongArchRule3ErrorMessage,
                WrongArchRule3.Evaluate(Architecture).ToErrorMessage()
            );
            Assert.Equal(
                _expectedWrongArchRule4ErrorMessage,
                WrongArchRule4.Evaluate(Architecture).ToErrorMessage()
            );
            Assert.Equal(
                _expectedWrongArchRule5ErrorMessage,
                WrongArchRule5.Evaluate(Architecture).ToErrorMessage()
            );
            Assert.Equal(
                _expectedWrongArchRule6ErrorMessage,
                WrongArchRule6.Evaluate(Architecture).ToErrorMessage()
            );
            Assert.Equal(
                _expectedWrongArchRule7ErrorMessage,
                WrongArchRule7.Evaluate(Architecture).ToErrorMessage()
            );
            Assert.Equal(
                _expectedWrongArchRule8ErrorMessage,
                WrongArchRule8.Evaluate(Architecture).ToErrorMessage()
            );
            Assert.Equal(
                _expectedWrongArchRule1AndWrongArchRule3ErrorMessage,
                WrongArchRule1AndWrongArchRule3.Evaluate(Architecture).ToErrorMessage()
            );
            Assert.Equal(
                _expectedWrongArchRule4AndWrongArchRule8ErrorMessage,
                WrongArchRule4AndWrongArchRule8.Evaluate(Architecture).ToErrorMessage()
            );
        }
    }
}