add displayname annotations to sgf-parsing

Author: bibekparajuli123

exercises/practice/sgf-parsing/src/test/java/SgfParsingTest.java

@@ -5,11 +5,13 @@
 import java.util.Map;
 
 import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 
 public class SgfParsingTest {
 
     @Test
+    @DisplayName("empty input")
     public void emptyInput() {
         String input = "";
         assertThatExceptionOfType(SgfParsingException.class).as("tree missing")
@@ -18,6 +20,7 @@ public void emptyInput() {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("tree with no nodes")
     public void treeWithNoNodes() {
         String input = "()";
         assertThatExceptionOfType(SgfParsingException.class)
@@ -27,6 +30,7 @@ public void treeWithNoNodes() {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("node without tree")
     public void nodeWithoutTree() {
         String input = ";";
         assertThatExceptionOfType(SgfParsingException.class).as("tree missing")
@@ -35,6 +39,7 @@ public void nodeWithoutTree() {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("node without properties")
     public void nodeWithoutProperties() throws SgfParsingException {
         String input = "(;)";
         SgfNode expected = new SgfNode();
@@ -44,6 +49,7 @@ public void nodeWithoutProperties() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("single node tree")
     public void singleNodeTree() throws SgfParsingException {
         String input = "(;A[B])";
         SgfNode expected = new SgfNode(Map.of("A", List.of("B")));
@@ -53,6 +59,7 @@ public void singleNodeTree() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("multiple properties")
     public void multipleProperties() throws SgfParsingException {
         String input = "(;A[b]C[d])";
         SgfNode expected = new SgfNode(Map.of("A", List.of("b"),
@@ -63,6 +70,7 @@ public void multipleProperties() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("properties without delimiter")
     public void propertiesWithoutDelimiter() {
         String input = "(;A)";
         assertThatExceptionOfType(SgfParsingException.class).as("properties without delimiter")
@@ -71,6 +79,7 @@ public void propertiesWithoutDelimiter() {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("all lowercase property")
     public void allLowercaseProperty() {
         String input = "(;a[b])";
         assertThatExceptionOfType(SgfParsingException.class).as("property must be in uppercase")
@@ -79,6 +88,7 @@ public void allLowercaseProperty() {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("upper and lowercase property")
     public void upperAndLowercaseProperty() {
         String input = "(;Aa[b])";
         assertThatExceptionOfType(SgfParsingException.class).as("property must be in uppercase")
@@ -87,6 +97,7 @@ public void upperAndLowercaseProperty() {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("two nodes")
     public void twoNodes() throws SgfParsingException {
         String input = "(;A[B];B[C])";
         SgfNode expected = new SgfNode(Map.of("A", List.of("B")),
@@ -99,6 +110,7 @@ public void twoNodes() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("two child trees")
     public void twoChildTrees() throws SgfParsingException {
         String input = "(;A[B](;B[C])(;C[D]))";
         SgfNode expected = new SgfNode(Map.of("A", List.of("B")),
@@ -112,6 +124,7 @@ public void twoChildTrees() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("multiple property values")
     public void multiplePropertyValues() throws SgfParsingException {
         String input = "(;A[b][c][d])";
         SgfNode expected = new SgfNode(Map.of("A", List.of("b", "c", "d")));
@@ -121,6 +134,7 @@ public void multiplePropertyValues() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("within property values, whitespace characters such as tab are converted to spaces")
     public void withinPropertyValueWhitespace() throws SgfParsingException {
         String input = "(;A[hello\t\tworld])";
         SgfNode expected = new SgfNode(Map.of("A", List.of("hello  world")));
@@ -130,6 +144,7 @@ public void withinPropertyValueWhitespace() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("within property values, newlines remain as newlines")
     public void withinPropertyValueNewline() throws SgfParsingException {
         String input = "(;A[hello\n\nworld])";
         SgfNode expected = new SgfNode(Map.of("A", List.of("hello\n\nworld")));
@@ -139,6 +154,7 @@ public void withinPropertyValueNewline() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("escaped closing bracket within property value becomes just a closing bracket")
     public void escapedClosingBracket() throws SgfParsingException {
         String input = "(;A[\\]])";
         SgfNode expected = new SgfNode(Map.of("A", List.of("]")));
@@ -148,6 +164,7 @@ public void escapedClosingBracket() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("escaped backslash in property value becomes just a backslash")
     public void escapedBacklash() throws SgfParsingException {
         String input = "(;A[\\\\])";
         SgfNode expected = new SgfNode(Map.of("A", List.of("\\")));
@@ -157,6 +174,7 @@ public void escapedBacklash() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("opening bracket within property value doesn't need to be escaped")
     public void openingBracketNeedNotToBeEscaped() throws SgfParsingException {
         String input = "(;A[x[y\\]z][foo]B[bar];C[baz])";
         SgfNode expected = new SgfNode(Map.of("A", List.of("x[y]z", "foo"),
@@ -170,6 +188,7 @@ public void openingBracketNeedNotToBeEscaped() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("semicolon in property value doesn't need to be escaped")
     public void semicolonNeedNotToBeEscaped() throws SgfParsingException {
         String input = "(;A[a;b][foo]B[bar];C[baz])";
         SgfNode expected = new SgfNode(Map.of("A", List.of("a;b", "foo"),
@@ -183,6 +202,7 @@ public void semicolonNeedNotToBeEscaped() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("parentheses in property value don't need to be escaped")
     public void paranthesesNeedNotToBeEscaped() throws SgfParsingException {
         String input = "(;A[x(y)z][foo]B[bar];C[baz])";
         SgfNode expected = new SgfNode(Map.of("A", List.of("x(y)z", "foo"),
@@ -196,6 +216,7 @@ public void paranthesesNeedNotToBeEscaped() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("escaped tab in property value is converted to space")
     public void escapedTab() throws SgfParsingException {
         String input = "(;A[hello\\\tworld])";
         SgfNode expected = new SgfNode(Map.of("A", List.of("hello world")));
@@ -205,6 +226,7 @@ public void escapedTab() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("escaped newline in property value is converted to nothing at all")
     public void escapedNewline() throws SgfParsingException {
         String input = "(;A[hello\\\nworld])";
         SgfNode expected = new SgfNode(Map.of("A", List.of("helloworld")));
@@ -215,6 +237,7 @@ public void escapedNewline() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("escaped t and n in property value are just letters, not whitespace")
     public void escapedTAndN() throws SgfParsingException {
         String input = "(;A[\\t = t and \\n = n])";
         SgfNode expected = new SgfNode(Map.of("A", List.of("t = t and n = n")));
@@ -225,6 +248,7 @@ public void escapedTAndN() throws SgfParsingException {
 
     @Test
     @Disabled("Remove to run test")
+    @DisplayName("mixing various kinds of whitespace and escaped characters in property value")
     public void mixOfEscapedCharactersAndWhitespaces() throws SgfParsingException {
         String input = "(;A[\\]b\nc\\\nd\t\te\\\\ \\\n\\]])";
         SgfNode expected = new SgfNode(Map.of("A", List.of("]b\ncd  e\\ ]")));