Add displayname annotations #2971 (#3029)

* add displayname annotations to saddle-points

* add displayname annotations to satellite

* add displayname annotations to say

* add displayname annotations to scrabble-score

* add displayname annotations to secret-handshake

* add displayname annotations to series

* add displayname annotations to sgf-parsing

* add displayname annotations to sieve

* add displayname annotations to simple-cipher

* add displayname annotations to space-age

* add displayname annotations to spiral-matrix

* add displayname annotations to state-of-tic-tac-toe

* add displayname annotations to saddle-points

* add displayname annotations to satellite

* add displayname annotations to say

* add displayname annotations to scrabble-score

* add displayname annotations to secret-handshake

* add displayname annotations to series

* add displayname annotations to sgf-parsing

* add displayname annotations to sieve

* add displayname annotations to simple-cipher

* add displayname annotations to space-age

* add displayname annotations to spiral-matrix

* add displayname annotations to state-of-tic-tac-toe

* simple-cipher

* say

* Update exercises/practice/simple-cipher/src/test/java/SimpleCipherTest.java

simple-cipher-changes

Co-authored-by: Jagdish Prajapati <[email protected]>

* Apply suggestion from @jagdish-15

* Apply suggestion from @jagdish-15

* Apply suggestion from @jagdish-15

* Remove accidently added duplicate tests

* Removing leading spaces in empty lines

---------

Co-authored-by: Jagdish Prajapati <[email protected]>

[no important files changed]

Author: bibekparajuli123

exercises/practice/saddle-points/src/test/java/MatrixTest.java

@@ -1,4 +1,5 @@
 import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 
 import java.util.ArrayList;
@@ -12,6 +13,7 @@
 public class MatrixTest {
 
     @Test
+    @DisplayName("Can identify single saddle point")
     public void testCanIdentifySingleSaddlePoint() {
         Matrix matrix = new Matrix(Arrays.asList(
             Arrays.asList(9, 8, 7),
@@ -26,6 +28,7 @@ public void testCanIdentifySingleSaddlePoint() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Can identify that empty matrix has no saddle points")
     public void testCanIdentifyThatEmptyMatrixHasNoSaddlePoints() {
         Matrix matrix = new Matrix(new ArrayList<>());
 
@@ -36,6 +39,7 @@ public void testCanIdentifyThatEmptyMatrixHasNoSaddlePoints() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Can identify lack of saddle points when there are none")
     public void testCanIdentifyLackOfSaddlePointsWhenThereAreNone() {
         Matrix matrix = new Matrix(Arrays.asList(
             Arrays.asList(1, 2, 3),
@@ -50,6 +54,7 @@ public void testCanIdentifyLackOfSaddlePointsWhenThereAreNone() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Can identify multiple saddle points in a column")
     public void testCanIdentifyMultipleSaddlePointsInAColumn() {
         Matrix matrix = new Matrix(Arrays.asList(
             Arrays.asList(4, 5, 4),
@@ -68,6 +73,7 @@ public void testCanIdentifyMultipleSaddlePointsInAColumn() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Can identify multiple saddle points in a Row")
     public void testCanIdentifyMultipleSaddlePointsInARow() {
         Matrix matrix = new Matrix(Arrays.asList(
                 Arrays.asList(6, 7, 8),
@@ -86,6 +92,7 @@ public void testCanIdentifyMultipleSaddlePointsInARow() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Can identify saddle point in bottom right corner")
     public void testCanIdentifySaddlePointInBottomRightCorner() {
         Matrix matrix = new Matrix(Arrays.asList(
             Arrays.asList(8, 7, 9),
@@ -100,6 +107,7 @@ public void testCanIdentifySaddlePointInBottomRightCorner() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Can identify saddle points in a non square matrix")
     public void testCanIdentifySaddlePointsInANonSquareMatrix() {
         Matrix matrix = new Matrix(Arrays.asList(
                 Arrays.asList(3, 1, 3),
@@ -116,6 +124,7 @@ public void testCanIdentifySaddlePointsInANonSquareMatrix() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Can identify that saddle points in a single column matrix are those with the minimum value")
     public void testCanIdentifyThatSaddlePointsInASingleColumnMatrixAreThoseWithMinimumValue() {
         Matrix matrix = new Matrix(Arrays.asList(
                 Collections.singletonList(2),
@@ -134,6 +143,7 @@ public void testCanIdentifyThatSaddlePointsInASingleColumnMatrixAreThoseWithMini
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Can identify that saddle points in a single row matrix are those with the maximum value")
     public void testCanIdentifyThatSaddlePointsInASingleRowMatrixAreThoseWithMaximumValue() {
         Matrix matrix = new Matrix(Arrays.asList(
                 Arrays.asList(2, 5, 3, 5)

exercises/practice/satellite/src/test/java/SatelliteTest.java

@@ -3,12 +3,14 @@
 
 import java.util.List;
 import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 
 public class SatelliteTest {
     Satellite satellite = new Satellite();
 
     @Test
+    @DisplayName("Empty tree")
     public void emptyTree() {
         List<Character> preorder = List.of();
         List<Character> inorder = List.of();
@@ -22,6 +24,7 @@ public void emptyTree() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Tree with one item")
     public void treeWithOneItem() {
         List<Character> preorder = List.of('a');
         List<Character> inorder = List.of('a');
@@ -35,6 +38,7 @@ public void treeWithOneItem() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Tree with many items")
     public void treeWithManyItems() {
         List<Character> preorder = List.of('a', 'i', 'x', 'f', 'r');
         List<Character> inorder = List.of('i', 'a', 'f', 'x', 'r');
@@ -48,6 +52,7 @@ public void treeWithManyItems() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Reject traversals of different length")
     public void rejectTraversalsOfDifferentLengths() {
         List<Character> preorder = List.of('a', 'b');
         List<Character> inorder = List.of('b', 'a', 'r');
@@ -60,6 +65,7 @@ public void rejectTraversalsOfDifferentLengths() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Reject inconsistent traversals of same length")
     public void rejectInconsistentTraversalsOfSameLength() {
         List<Character> preorder = List.of('x', 'y', 'z');
         List<Character> inorder = List.of('a', 'b', 'c');
@@ -71,6 +77,7 @@ public void rejectInconsistentTraversalsOfSameLength() {
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("Reject traversals with repeated items")
     public void rejectTraversalsWithRepeatedItems() {
         List<Character> preorder = List.of('a', 'b', 'a');
         List<Character> inorder = List.of('b', 'a', 'a');

exercises/practice/say/src/test/java/SayTest.java

@@ -1,5 +1,6 @@
-import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
 
 import static org.assertj.core.api.Assertions.*;
 
@@ -8,102 +9,119 @@ public class SayTest {
     private Say say = new Say();
 
     @Test
+    @DisplayName("zero")
     public void zero() {
         assertThat(say.say(0)).isEqualTo("zero");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("one")
     public void one() {
         assertThat(say.say(1)).isEqualTo("one");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("fourteen")
     public void fourteen() {
         assertThat(say.say(14)).isEqualTo("fourteen");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("twenty")
     public void twenty() {
         assertThat(say.say(20)).isEqualTo("twenty");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("twenty-two")
     public void twentyTwo() {
         assertThat(say.say(22)).isEqualTo("twenty-two");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("thirty")
     public void thirty() {
         assertThat(say.say(30)).isEqualTo("thirty");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("ninety-nine")
     public void ninetyNine() {
         assertThat(say.say(99)).isEqualTo("ninety-nine");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("one hundred")
     public void oneHundred() {
         assertThat(say.say(100)).isEqualTo("one hundred");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("one hundred twenty-three")
     public void oneHundredTwentyThree() {
         assertThat(say.say(123)).isEqualTo("one hundred twenty-three");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("two hundred")
     public void twoHundred() {
         assertThat(say.say(200)).isEqualTo("two hundred");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("nine hundred ninety-nine")
     public void nineHundredNinetyNine() {
         assertThat(say.say(999)).isEqualTo("nine hundred ninety-nine");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("one thousand")
     public void oneThousand() {
         assertThat(say.say(1_000)).isEqualTo("one thousand");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("one thousand two hundred thirty-four")
     public void oneThousandTwoHundredThirtyFour() {
         assertThat(say.say(1_234)).isEqualTo("one thousand two hundred thirty-four");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("one million")
     public void oneMillion() {
         assertThat(say.say(1_000_000)).isEqualTo("one million");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("one million two thousand three hundred forty-five")
     public void oneMillionTwoThousandThreeHundredFortyFive() {
         assertThat(say.say(1_002_345)).isEqualTo("one million two thousand three hundred forty-five");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("one billion")
     public void oneBillion() {
         assertThat(say.say(1_000_000_000)).isEqualTo("one billion");
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("a big number")
     public void nineHundredEightySevenBillionSixHundredFiftyFourThreeHundredTwentyOneThousandOneHundredTwentyThree() {
         assertThat(say.say(987_654_321_123L))
                 .isEqualTo("nine hundred eighty-seven billion six hundred fifty-four million" +
@@ -112,13 +130,15 @@ public void nineHundredEightySevenBillionSixHundredFiftyFourThreeHundredTwentyOn
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("numbers below zero are out of range")
     public void illegalNegativeNumber() {
         assertThatExceptionOfType(IllegalArgumentException.class)
                 .isThrownBy(() -> say.say(-1));
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("numbers above 999,999,999,999 are out of range")
     public void illegalTooBigNumber() {
         assertThatExceptionOfType(IllegalArgumentException.class)
                 .isThrownBy(() -> say.say(1_000_000_000_000L));

exercises/practice/scrabble-score/src/test/java/ScrabbleScoreTest.java

@@ -1,81 +1,93 @@
 import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 public class ScrabbleScoreTest {
 
     @Test
+    @DisplayName("lowercase letter")
     public void testALowerCaseLetter() {
         Scrabble scrabble = new Scrabble("a");
         assertThat(scrabble.getScore()).isEqualTo(1);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("uppercase letter")
     public void testAUpperCaseLetter() {
         Scrabble scrabble = new Scrabble("A");
         assertThat(scrabble.getScore()).isEqualTo(1);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("valuable letter")
     public void testAValuableLetter() {
         Scrabble scrabble = new Scrabble("f");
         assertThat(scrabble.getScore()).isEqualTo(4);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("short word")
     public void testAShortWord() {
         Scrabble scrabble = new Scrabble("at");
         assertThat(scrabble.getScore()).isEqualTo(2);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("short, valuable word")
     public void testAShortValuableWord() {
         Scrabble scrabble = new Scrabble("zoo");
         assertThat(scrabble.getScore()).isEqualTo(12);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("medium word")
     public void testAMediumWord() {
         Scrabble scrabble = new Scrabble("street");
         assertThat(scrabble.getScore()).isEqualTo(6);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("medium, valuable word")
     public void testAMediumValuableWord() {
         Scrabble scrabble = new Scrabble("quirky");
         assertThat(scrabble.getScore()).isEqualTo(22);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("long, mixed-case word")
     public void testALongMixCaseWord() {
         Scrabble scrabble = new Scrabble("OxyphenButazone");
         assertThat(scrabble.getScore()).isEqualTo(41);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("english-like word")
     public void testAEnglishLikeWord() {
         Scrabble scrabble = new Scrabble("pinata");
         assertThat(scrabble.getScore()).isEqualTo(8);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("empty input")
     public void testAnEmptyInput() {
         Scrabble scrabble = new Scrabble("");
         assertThat(scrabble.getScore()).isEqualTo(0);
     }
 
     @Disabled("Remove to run test")
     @Test
+    @DisplayName("entire alphabet available")
     public void testEntireAlphabetAvailable() {
         Scrabble scrabble = new Scrabble("abcdefghijklmnopqrstuvwxyz");
         assertThat(scrabble.getScore()).isEqualTo(87);