Merge pull request #322 from CodebreakerApp/copilot/fix-289

christiannagel · web-flow · commit 15eb7595f631 · 2025-09-17T14:05:03.000+02:00
Enhance log message with expected move number for invalid moves
diff --git a/src/services/common/Codebreaker.GameAPIs.Analyzers.Tests/Analyzers/ColorGame6x4AnalyzerTests.cs b/src/services/common/Codebreaker.GameAPIs.Analyzers.Tests/Analyzers/ColorGame6x4AnalyzerTests.cs
@@ -24,7 +24,7 @@ public void SetMove_ShouldReturnThreeWhite()
     public void SetMove_UsingVariousData(int expectedBlack, int expectedWhite, params string[] guessValues)
     {
         string[] code = [Red, Green, Blue, Red];
-        ColorResult expectedKeyPegs = new (expectedBlack, expectedWhite);
+        ColorResult expectedKeyPegs = new(expectedBlack, expectedWhite);
         ColorResult resultKeyPegs = AnalyzeGame(code, guessValues);
         Assert.Equal(expectedKeyPegs, resultKeyPegs);
     }
@@ -40,7 +40,7 @@ public void SetMove_UsingVariousDataUsingDataClass(string[] code, string[] guess
     [Fact]
     public void SetMove_ShouldThrowOnInvalidGuessCount()
     {
-        Assert.Throws<ArgumentException>(() => 
+        Assert.Throws<ArgumentException>(() =>
             AnalyzeGame(
                 ["Black", "Black", "Black", "Black"],
                 ["Black"]
@@ -50,7 +50,7 @@ public void SetMove_ShouldThrowOnInvalidGuessCount()
     [Fact]
     public void SetMove_ShouldThrowOnInvalidGuessValues()
     {
-        Assert.Throws<ArgumentException>(() => 
+        Assert.Throws<ArgumentException>(() =>
             AnalyzeGame(
                 ["Black", "Black", "Black", "Black"],
                 ["Black", "Der", "Blue", "Yellow"]      // "Der" is the wrong value
@@ -60,7 +60,7 @@ public void SetMove_ShouldThrowOnInvalidGuessValues()
     [Fact]
     public void SetMove_ShouldThrowOnInvalidMoveNumber()
     {
-        Assert.Throws<ArgumentException>(() => 
+        Assert.Throws<ArgumentException>(() =>
             AnalyzeGame(
                 [Green, Yellow, Green, Black],
                 [Yellow, Green, Black, Blue], moveNumber: 2));
@@ -76,7 +76,19 @@ public void SetMove_ShouldNotIncrementMoveNumberOnInvalidMove()
         Assert.Equal(0, game?.LastMoveNumber);
     }
 
-    private static MockColorGame CreateGame(string[] codes) => 
+    [Fact]
+    public void SetMove_ShouldIncludeExpectedMoveNumberInErrorMessage()
+    {
+        var exception = Assert.Throws<ArgumentException>(() =>
+            AnalyzeGame(
+                [Green, Yellow, Green, Black],
+                [Yellow, Green, Black, Blue], moveNumber: 3));
+
+        Assert.Contains("received 3", exception.Message);
+        Assert.Contains("expected 1", exception.Message);
+    }
+
+    private static MockColorGame CreateGame(string[] codes) =>
         new()
         {
             GameType = GameTypes.Game6x4,
@@ -93,7 +105,7 @@ private static MockColorGame CreateGame(string[] codes) =>
     private static ColorResult AnalyzeGame(string[] codes, string[] guesses, int moveNumber = 1)
     {
         MockColorGame game = CreateGame(codes);
-        ColorGameGuessAnalyzer analyzer = new(game, [.. guesses.ToPegs<ColorField>() ], moveNumber);
+        ColorGameGuessAnalyzer analyzer = new(game, [.. guesses.ToPegs<ColorField>()], moveNumber);
         return analyzer.GetResult();
     }
 
diff --git a/src/services/common/Codebreaker.GameAPIs.Analyzers.Tests/Analyzers/ColorGame8x5AnalyzerTests.cs b/src/services/common/Codebreaker.GameAPIs.Analyzers.Tests/Analyzers/ColorGame8x5AnalyzerTests.cs
@@ -24,7 +24,7 @@ public void SetMove_ShouldReturnThreeWhite()
     public void SetMove_UsingVariousData(int expectedBlack, int expectedWhite, params string[] guessValues)
     {
         string[] code = [Red, Green, Blue, Red, Brown];
-        ColorResult expectedKeyPegs = new (expectedBlack, expectedWhite);
+        ColorResult expectedKeyPegs = new(expectedBlack, expectedWhite);
         ColorResult resultKeyPegs = AnalyzeGame(code, guessValues);
         Assert.Equal(expectedKeyPegs, resultKeyPegs);
     }
@@ -40,7 +40,7 @@ public void SetMove_UsingVariousDataUsingDataClass(string[] code, string[] guess
     [Fact]
     public void SetMove_ShouldThrowOnInvalidGuessCount()
     {
-        Assert.Throws<ArgumentException>(() => 
+        Assert.Throws<ArgumentException>(() =>
             AnalyzeGame(
                 ["Black", "Black", "Black", "Black", "Black"],
                 ["Black"]
@@ -50,14 +50,14 @@ public void SetMove_ShouldThrowOnInvalidGuessCount()
     [Fact]
     public void SetMove_ShouldThrowOnInvalidGuessValues()
     {
-        Assert.Throws<ArgumentException>(() => 
+        Assert.Throws<ArgumentException>(() =>
             AnalyzeGame(
                 ["Black", "Black", "Black", "Black", "Black"],
                 ["Black", "Der", "Blue", "Yellow", "Black"]      // "Der" is the wrong value
             ));
     }
 
-    private static MockColorGame CreateGame(string[] codes) => 
+    private static MockColorGame CreateGame(string[] codes) =>
         new()
         {
             GameType = GameTypes.Game8x5,
diff --git a/src/services/common/Codebreaker.GameAPIs.Analyzers.Tests/Analyzers/ShapeGame5x5x4AnalyzerTests.cs b/src/services/common/Codebreaker.GameAPIs.Analyzers.Tests/Analyzers/ShapeGame5x5x4AnalyzerTests.cs
@@ -178,7 +178,7 @@ private static MockShapeGame CreateGame(string[] codes) =>
                 [FieldCategories.Colors] = TestData5x5x4.Colors5.ToList(),
                 [FieldCategories.Shapes] = TestData5x5x4.Shapes5.ToList()
             },
-            Codes = codes   
+            Codes = codes
         };
 
     private static ShapeAndColorResult AnalyzeGame(string[] codes, string[] guesses)
diff --git a/src/services/common/Codebreaker.GameAPIs.Analyzers.Tests/Analyzers/SimpleGameGuessAnalyzerTests.cs b/src/services/common/Codebreaker.GameAPIs.Analyzers.Tests/Analyzers/SimpleGameGuessAnalyzerTests.cs
@@ -35,7 +35,7 @@ public void SetMove_UsingVariousDataUsingDataClass(string[] code, string[] guess
     [Fact]
     public void SetMove_ShouldThrowOnInvalidGuessCount()
     {
-        Assert.Throws<ArgumentException>(() => 
+        Assert.Throws<ArgumentException>(() =>
             AnalyzeGame(
                 ["Black", "Black", "Black", "Black"],
                 ["Black"]
@@ -45,7 +45,7 @@ public void SetMove_ShouldThrowOnInvalidGuessCount()
     [Fact]
     public void SetMove_ShouldThrowOnInvalidGuessValues()
     {
-        Assert.Throws<ArgumentException>(() => 
+        Assert.Throws<ArgumentException>(() =>
             AnalyzeGame(
                 ["Black", "Black", "Black", "Black"],
                 ["Black", "Der", "Blue", "Yellow"]      // "Der" is the wrong value
@@ -55,7 +55,7 @@ public void SetMove_ShouldThrowOnInvalidGuessValues()
     [Fact]
     public void SetMove_ShouldThrowOnInvalidMoveNumber()
     {
-        Assert.Throws<ArgumentException>(() => 
+        Assert.Throws<ArgumentException>(() =>
             AnalyzeGame(
                 [Green, Yellow, Green, Black],
                 [Yellow, Green, Black, Blue], moveNumber: 2));
@@ -128,7 +128,7 @@ public void GetResult_WithGameNotComplete_ShouldSetCorrectGameEndInformation()
         Assert.False(game.IsVictory);
     }
 
-    private static MockColorGame CreateGame(string[] codes) => 
+    private static MockColorGame CreateGame(string[] codes) =>
         new()
         {
             GameType = GameTypes.Game6x4Mini,
@@ -180,8 +180,8 @@ public IEnumerator<object[]> GetEnumerator()
             new SimpleColorResult(
             [
                 ResultValue.CorrectPositionAndColor,
-                ResultValue.CorrectColor, 
-                ResultValue.Incorrect, 
+                ResultValue.CorrectColor,
+                ResultValue.Incorrect,
                 ResultValue.Incorrect
             ]) // expected
         };
diff --git a/src/services/common/Codebreaker.GameAPIs.Analyzers.Tests/Results/ShapeAndColorResultTests.cs b/src/services/common/Codebreaker.GameAPIs.Analyzers.Tests/Results/ShapeAndColorResultTests.cs
@@ -1,7 +1,7 @@
 namespace Codebreaker.GameAPIs.Analyzer.Tests;
 
 public class ShapeAndColorResultTests
-{ 
+{
     [Fact]
     public void ToStringShouldReturnFormat()
     {
diff --git a/src/services/common/Codebreaker.GameAPIs.Analyzers/Analyzers/ColorGameGuessAnalyzer.cs b/src/services/common/Codebreaker.GameAPIs.Analyzers/Analyzers/ColorGameGuessAnalyzer.cs
@@ -15,8 +15,8 @@ protected override void ValidateGuessValues()
     protected override ColorResult GetCoreResult()
     {
         // Check black and white keyPegs
-        List<ColorField> codesToCheck = [.. _game.Codes.ToPegs<ColorField>() ];
-        List<ColorField> guessPegsToCheck = [.. Guesses ];
+        List<ColorField> codesToCheck = [.. _game.Codes.ToPegs<ColorField>()];
+        List<ColorField> guessPegsToCheck = [.. Guesses];
         int black = 0;
         List<string> whitePegs = [];
 
diff --git a/src/services/common/Codebreaker.GameAPIs.Analyzers/Analyzers/GameGuessAnalyzer.cs b/src/services/common/Codebreaker.GameAPIs.Analyzers/Analyzers/GameGuessAnalyzer.cs
@@ -40,7 +40,7 @@ private void ValidateGuess()
 
         if ((_game.LastMoveNumber + 1) != _moveNumber)
         {
-            throw new ArgumentException($"Incorrect move number received {_moveNumber}") { HResult = 4300 };
+            throw new ArgumentException($"Incorrect move number received {_moveNumber}, expected {_game.LastMoveNumber + 1}") { HResult = 4300 };
         }
 
         _game.LastMoveNumber++;
diff --git a/src/services/common/Codebreaker.GameAPIs.Analyzers/Analyzers/ShapeGameGuessAnalyzer.cs b/src/services/common/Codebreaker.GameAPIs.Analyzers/Analyzers/ShapeGameGuessAnalyzer.cs
@@ -20,8 +20,8 @@ protected override void ValidateGuessValues()
     protected override ShapeAndColorResult GetCoreResult()
     {
         // Check black, white and blue keyPegs
-        List<ShapeAndColorField> codesToCheck = [.._game.Codes.ToPegs<ShapeAndColorField>() ]; // all the codes that need to be verified with the actual check
-        List<ShapeAndColorField> guessPegsToCheck = [.. Guesses ]; // all the guesses that need to be verified with the actual check
+        List<ShapeAndColorField> codesToCheck = [.. _game.Codes.ToPegs<ShapeAndColorField>()]; // all the codes that need to be verified with the actual check
+        List<ShapeAndColorField> guessPegsToCheck = [.. Guesses]; // all the guesses that need to be verified with the actual check
         List<ShapeAndColorField> remainingCodesToCheck = []; // the codes that need to be checked with the check following - filled by the actual check
         List<ShapeAndColorField> remainingGuessPegsToCheck = []; // the guesses that need to be checked with the check following - filled by the actual check
 
@@ -74,9 +74,9 @@ protected override ShapeAndColorResult GetCoreResult()
 
         for (int i = 0; i < guessPegsToCheck.Count; i++)
         {
-            if ((guessPegsToCheck[i] != ShapeAndColorField.Empty || 
+            if ((guessPegsToCheck[i] != ShapeAndColorField.Empty ||
                 codesToCheck[i] != ShapeAndColorField.Empty) &&
-                (guessPegsToCheck[i].Shape == codesToCheck[i].Shape || 
+                (guessPegsToCheck[i].Shape == codesToCheck[i].Shape ||
                 guessPegsToCheck[i].Color == codesToCheck[i].Color))
             {
                 blue++;
diff --git a/src/services/common/Codebreaker.GameAPIs.Analyzers/Analyzers/SimpleGameGuessAnalyzer.cs b/src/services/common/Codebreaker.GameAPIs.Analyzers/Analyzers/SimpleGameGuessAnalyzer.cs
@@ -11,9 +11,9 @@ protected override void ValidateGuessValues()
     protected override SimpleColorResult GetCoreResult()
     {
         // Check black and white keyPegs
-        List<string> codesToCheck = [.. _game.Codes.ToPegs<ColorField>().Select(cf => cf.ToString()) ];
+        List<string> codesToCheck = [.. _game.Codes.ToPegs<ColorField>().Select(cf => cf.ToString())];
         List<string> guessPegsToCheck = [.. Guesses.Select(g => g.ToString())];
-        List<int> positionsToIgnore = []; 
+        List<int> positionsToIgnore = [];
 
         ResultValue[] results = [.. Enumerable.Repeat(ResultValue.Incorrect, 4)];
 
@@ -38,7 +38,7 @@ protected override SimpleColorResult GetCoreResult()
             results[i] = ResultValue.CorrectColor;
             codesToCheck[ix] = string.Empty;
         }
- 
+
         return new SimpleColorResult(results);
     }
 
diff --git a/src/services/common/Codebreaker.GameAPIs.Analyzers/Extensions/FieldExtensions.cs b/src/services/common/Codebreaker.GameAPIs.Analyzers/Extensions/FieldExtensions.cs
@@ -14,7 +14,7 @@ public static IEnumerable<T> ToFields<T>(this string[] fieldStrings)
     public static IEnumerable<string> ToStringFields<T>(this T[] fields)
         where T : IFormattable
     {
-        foreach(var field in fields)
+        foreach (var field in fields)
         {
             yield return field.ToString(default, default);
         }
diff --git a/src/services/common/Codebreaker.GameAPIs.Analyzers/Extensions/PegExtensions.cs b/src/services/common/Codebreaker.GameAPIs.Analyzers/Extensions/PegExtensions.cs
@@ -14,7 +14,7 @@ public static IEnumerable<T> ToPegs<T>(this string[] pegStrings)
     public static IEnumerable<string> AsStringFields<T>(this T[] pegs)
         where T : IFormattable
     {
-        foreach(var peg in pegs)
+        foreach (var peg in pegs)
         {
             yield return peg.ToString(default, default);
         }
diff --git a/src/services/common/Codebreaker.GameAPIs.Analyzers/Results/SimpleColorResult_Equality.cs b/src/services/common/Codebreaker.GameAPIs.Analyzers/Results/SimpleColorResult_Equality.cs
@@ -17,7 +17,7 @@ public bool Equals(SimpleColorResult other) =>
     public override int GetHashCode() =>
         Results.GetHashCode();
 
-    public static bool operator==(SimpleColorResult left, SimpleColorResult right) => left.Equals(right);
+    public static bool operator ==(SimpleColorResult left, SimpleColorResult right) => left.Equals(right);
 
-    public static bool operator!=(SimpleColorResult left, SimpleColorResult right) => !(left == right);
+    public static bool operator !=(SimpleColorResult left, SimpleColorResult right) => !(left == right);
 }
diff --git a/src/services/common/Codebreaker.GameAPIs.Analyzers/Results/SimpleColorResult_ISpanFormattable.cs b/src/services/common/Codebreaker.GameAPIs.Analyzers/Results/SimpleColorResult_ISpanFormattable.cs
@@ -1,5 +1,5 @@
 ﻿namespace Codebreaker.GameAPIs.Models;
-public readonly partial struct SimpleColorResult :  ISpanFormattable
+public readonly partial struct SimpleColorResult : ISpanFormattable
 {
     public override string ToString() => ToString(default, default);
 
@@ -32,8 +32,8 @@ public bool TryFormat(
 
         for (int i = 0, j = 0; i < length; i++, j += 2)
         {
-            destination[j] = (char)((byte)Results[i] + '0'); 
-            if (j < (length * 2 - 2)) 
+            destination[j] = (char)((byte)Results[i] + '0');
+            if (j < (length * 2 - 2))
                 destination[j + 1] = Separator;
         }
         charsWritten = length * 2 - 1;
diff --git a/src/services/common/Codebreaker.GameAPIs.Analyzers/Results/SimpleColorResult_ISpanParsable.cs b/src/services/common/Codebreaker.GameAPIs.Analyzers/Results/SimpleColorResult_ISpanParsable.cs
@@ -29,7 +29,7 @@ public static bool TryParse(ReadOnlySpan<char> s, IFormatProvider? provider, [Ma
             return false;
         }
 
-        var values = new  ResultValue[4];
+        var values = new ResultValue[4];
         for (int i = 0, j = 0; i < 4; i++, j += 2)
         {
 

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public void SetMove_ShouldReturnThreeWhite()`
`24`	`24`	`public void SetMove_UsingVariousData(int expectedBlack, int expectedWhite, params string[] guessValues)`
`25`	`25`	`{`
`26`	`26`	`string[] code = [Red, Green, Blue, Red, Brown];`
`27`		`- ColorResult expectedKeyPegs = new (expectedBlack, expectedWhite);`
	`27`	`+ ColorResult expectedKeyPegs = new(expectedBlack, expectedWhite);`
`28`	`28`	`ColorResult resultKeyPegs = AnalyzeGame(code, guessValues);`
`29`	`29`	`Assert.Equal(expectedKeyPegs, resultKeyPegs);`
`30`	`30`	`}`
`@@ -40,7 +40,7 @@ public void SetMove_UsingVariousDataUsingDataClass(string[] code, string[] guess`
`40`	`40`	`[Fact]`
`41`	`41`	`public void SetMove_ShouldThrowOnInvalidGuessCount()`
`42`	`42`	`{`
`43`		`- Assert.Throws<ArgumentException>(() =>`
	`43`	`+ Assert.Throws<ArgumentException>(() =>`
`44`	`44`	`AnalyzeGame(`
`45`	`45`	`["Black", "Black", "Black", "Black", "Black"],`
`46`	`46`	`["Black"]`
`@@ -50,14 +50,14 @@ public void SetMove_ShouldThrowOnInvalidGuessCount()`
`50`	`50`	`[Fact]`
`51`	`51`	`public void SetMove_ShouldThrowOnInvalidGuessValues()`
`52`	`52`	`{`
`53`		`- Assert.Throws<ArgumentException>(() =>`
	`53`	`+ Assert.Throws<ArgumentException>(() =>`
`54`	`54`	`AnalyzeGame(`
`55`	`55`	`["Black", "Black", "Black", "Black", "Black"],`
`56`	`56`	`["Black", "Der", "Blue", "Yellow", "Black"] // "Der" is the wrong value`
`57`	`57`	`));`
`58`	`58`	`}`
`59`	`59`
`60`		`- private static MockColorGame CreateGame(string[] codes) =>`
	`60`	`+ private static MockColorGame CreateGame(string[] codes) =>`
`61`	`61`	`new()`
`62`	`62`	`{`
`63`	`63`	`GameType = GameTypes.Game8x5,`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`namespace Codebreaker.GameAPIs.Analyzer.Tests;`
`2`	`2`
`3`	`3`	`public class ShapeAndColorResultTests`
`4`		`-{`
	`4`	`+{`
`5`	`5`	`[Fact]`
`6`	`6`	`public void ToStringShouldReturnFormat()`
`7`	`7`	`{`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ private void ValidateGuess()`
`40`	`40`
`41`	`41`	`if ((_game.LastMoveNumber + 1) != _moveNumber)`
`42`	`42`	`{`
`43`		`- throw new ArgumentException($"Incorrect move number received {_moveNumber}") { HResult = 4300 };`
	`43`	`+ throw new ArgumentException($"Incorrect move number received {_moveNumber}, expected {_game.LastMoveNumber + 1}") { HResult = 4300 };`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`_game.LastMoveNumber++;`
Original file line number	Diff line number	Diff line change
`@@ -11,9 +11,9 @@ protected override void ValidateGuessValues()`
`11`	`11`	`protected override SimpleColorResult GetCoreResult()`
`12`	`12`	`{`
`13`	`13`	`// Check black and white keyPegs`
`14`		`- List<string> codesToCheck = [.. _game.Codes.ToPegs<ColorField>().Select(cf => cf.ToString()) ];`
	`14`	`+ List<string> codesToCheck = [.. _game.Codes.ToPegs<ColorField>().Select(cf => cf.ToString())];`
`15`	`15`	`List<string> guessPegsToCheck = [.. Guesses.Select(g => g.ToString())];`
`16`		`- List<int> positionsToIgnore = [];`
	`16`	`+ List<int> positionsToIgnore = [];`
`17`	`17`
`18`	`18`	`ResultValue[] results = [.. Enumerable.Repeat(ResultValue.Incorrect, 4)];`
`19`	`19`
`@@ -38,7 +38,7 @@ protected override SimpleColorResult GetCoreResult()`
`38`	`38`	`results[i] = ResultValue.CorrectColor;`
`39`	`39`	`codesToCheck[ix] = string.Empty;`
`40`	`40`	`}`
`41`		`-`
	`41`	`+`
`42`	`42`	`return new SimpleColorResult(results);`
`43`	`43`	`}`
`44`	`44`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public static IEnumerable<T> ToFields<T>(this string[] fieldStrings)`
`14`	`14`	`public static IEnumerable<string> ToStringFields<T>(this T[] fields)`
`15`	`15`	`where T : IFormattable`
`16`	`16`	`{`
`17`		`- foreach(var field in fields)`
	`17`	`+ foreach (var field in fields)`
`18`	`18`	`{`
`19`	`19`	`yield return field.ToString(default, default);`
`20`	`20`	`}`