Merge branch 'main' into handle-for-remote-input

Author: pBouillon

src/AdventOfCode.Commons/AdventOfCode.Commons.csproj

@@ -28,6 +28,7 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
+    <PackageReference Include="Xunit.SkippableFact" Version="1.4.13" />
   </ItemGroup>
 
 </Project>

src/AdventOfCode.Commons/TestEngine.cs

@@ -7,15 +7,15 @@ namespace AdventOfCode.Commons;
 /// <summary>
 /// Test engine for the implemented <typeparamref name="TSolver"/>
 /// </summary>
-/// 
+///
 /// <typeparam name="TSolver">
 /// The <see cref="Solver{TInput, TResult}"/> to use
 /// </typeparam>
-/// 
+///
 /// <typeparam name="TInput">
 /// The type of the data used to solve the puzzle
 /// </typeparam>
-/// 
+///
 /// <typeparam name="TResult">
 /// The type of the result of the puzzle
 /// </typeparam>
@@ -47,6 +47,14 @@ public record Example
     /// </summary>
     public record Puzzle
     {
+        /// <summary>
+        /// If set to <c>true</c>, the tests for this puzzle will be skipped
+        /// </summary>
+        /// <remarks>
+        /// Default is <c>false</c>
+        /// </remarks>
+        public bool ShouldSkipTests { get; init; } = false;
+
         /// <summary>
         /// The <see cref="Example"/> to use to test <see cref="Solver{TInput, TResult}"/>
         /// </summary>
@@ -63,30 +71,40 @@ public record Puzzle
     /// </summary>
     private readonly TSolver _solver;
 
-    protected TestEngine() 
+    protected TestEngine()
         => _solver = new TSolver();
 
     #region Part #1
 
     public abstract Puzzle PartOne { get; }
 
-    [Fact(DisplayName = "Part One - Example")]
+    [SkippableFact(DisplayName = "Part One - Example")]
     public void PartOneExampleTest()
     {
+        Skip.If(PartOne.ShouldSkipTests, "Puzzle.ShouldSkipTests has been set to true, test skipped");
+
+        // Arrange
         var input = PartOne.Example.Input;
 
+        // Act
         var result = _solver.PartOne(input);
 
+        // Assert
         result.Should().Be(PartOne.Example.Result);
     }
 
-    [Fact(DisplayName = "Part One - Solution")]
+    [SkippableFact(DisplayName = "Part One - Solution")]
     public void PartOneSolutionTest()
     {
+        Skip.If(PartOne.ShouldSkipTests, "Puzzle.ShouldSkipTests has been set to true, test skipped");
+
+        // Arrange
         var input = _solver.Input;
 
+        // Act
         var result = _solver.PartOne(input.Value);
 
+        // Assert
         result.Should().Be(PartOne.Solution);
     }
 
@@ -96,23 +114,33 @@ public void PartOneSolutionTest()
 
     public abstract Puzzle PartTwo { get; }
 
-    [Fact(DisplayName = "Part Two - Example")]
+    [SkippableFact(DisplayName = "Part Two - Example")]
     public void PartTwoExampleTest()
     {
+        Skip.If(PartTwo.ShouldSkipTests, "Puzzle.ShouldSkipTests has been set to true, test skipped");
+
+        // Arrange
         var input = PartTwo.Example.Input;
 
+        // Act
         var result = _solver.PartTwo(input);
 
+        // Assert
         result.Should().Be(PartTwo.Example.Result);
     }
 
-    [Fact(DisplayName = "Part Two - Solution")]
+    [SkippableFact(DisplayName = "Part Two - Solution")]
     public void PartTwoSolutionTest()
     {
+        Skip.If(PartTwo.ShouldSkipTests, "Puzzle.ShouldSkipTests has been set to true, test skipped");
+
+        // Arrange
         var input = _solver.Input;
 
+        // Act
         var result = _solver.PartTwo(input.Value);
 
+        // Assert
         result.Should().Be(PartTwo.Solution);
     }
 

src/AdventOfCode.Usage/WithLocalInput/SolverTest.cs

@@ -17,7 +17,6 @@ public class SolverTest : TestEngine<Solver, int[], int>
             Input = new[] { 1, 2, 3 },
             Result = 3,
         },
-
         Solution = 5,
     };
 
@@ -28,7 +27,6 @@ public class SolverTest : TestEngine<Solver, int[], int>
             Input = new[] { 1, 2, 3 },
             Result = 6,
         },
-
         Solution = 15,
     };
 }