#patch: Restrict characters in snapshot name

Fixes #122 
Make '=', '[' and ']' characters illegal in snapshot name and scenario fields

Author: jackmatt2

CONTRIBUTING.md

@@ -21,7 +21,7 @@ We welcome contributions to this project by both internal and external parties
 ## Building
 
 ```java
-./gradlew shadowJar
+./gradlew spotlessApply shadowJar
 ```
 
 ## Deploying locally and deploying to `.m2/`

java-snapshot-testing-core/src/main/java/au/com/origin/snapshots/Expect.java

@@ -52,6 +52,8 @@ public void toMatchSnapshot(Object object) {
     }
     snapshotContext.header.putAll(headers);
 
+    snapshotContext.checkValidContext();
+
     snapshotContext.toMatchSnapshot();
   }
 

java-snapshot-testing-core/src/main/java/au/com/origin/snapshots/SnapshotContext.java

@@ -3,14 +3,12 @@
 import au.com.origin.snapshots.annotations.SnapshotName;
 import au.com.origin.snapshots.comparators.SnapshotComparator;
 import au.com.origin.snapshots.config.SnapshotConfig;
+import au.com.origin.snapshots.exceptions.ReservedWordException;
 import au.com.origin.snapshots.exceptions.SnapshotMatchException;
 import au.com.origin.snapshots.reporters.SnapshotReporter;
 import au.com.origin.snapshots.serializers.SnapshotSerializer;
 import java.lang.reflect.Method;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.List;
-import java.util.Set;
+import java.util.*;
 import java.util.stream.Collectors;
 import lombok.Getter;
 import lombok.Setter;
@@ -19,6 +17,8 @@
 @Slf4j
 public class SnapshotContext {
 
+  private static final List<String> RESERVED_WORDS = Arrays.asList("=", "[", "]");
+
   private final SnapshotConfig snapshotConfig;
   private final SnapshotFile snapshotFile;
 
@@ -141,11 +141,24 @@ private Snapshot takeSnapshot() {
 
   String resolveSnapshotIdentifier() {
     String scenarioFormat = scenario == null ? "" : "[" + scenario + "]";
+    return snapshotName() + scenarioFormat;
+  }
+
+  private String snapshotName() {
     SnapshotName snapshotName = testMethod.getAnnotation(SnapshotName.class);
-    String pathFormat =
-        snapshotName == null
-            ? testClass.getName() + "." + testMethod.getName()
-            : snapshotName.value();
-    return pathFormat + scenarioFormat;
+    return snapshotName == null
+        ? testClass.getName() + "." + testMethod.getName()
+        : snapshotName.value();
+  }
+
+  void checkValidContext() {
+    for (String rw : RESERVED_WORDS) {
+      if (snapshotName().contains(rw)) {
+        throw new ReservedWordException("snapshot name", rw, RESERVED_WORDS);
+      }
+      if (scenario != null && scenario.contains(rw)) {
+        throw new ReservedWordException("scenario name", rw, RESERVED_WORDS);
+      }
+    }
   }
 }

java-snapshot-testing-core/src/main/java/au/com/origin/snapshots/exceptions/ReservedWordException.java

@@ -0,0 +1,18 @@
+package au.com.origin.snapshots.exceptions;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class ReservedWordException extends RuntimeException {
+
+  public ReservedWordException(String message) {
+    super(message);
+  }
+
+  public ReservedWordException(String element, String reservedWord, List<String> reservedWords) {
+    super(
+        String.format(
+            "You cannot use the '%s' character inside '%s'. Reserved characters are ",
+            reservedWord, element, reservedWords.stream().collect(Collectors.joining(","))));
+  }
+}

java-snapshot-testing-core/src/test/java/au/com/origin/snapshots/SnapshotNameAnnotationTest.java

@@ -1,7 +1,10 @@
 package au.com.origin.snapshots;
 
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
 import au.com.origin.snapshots.annotations.SnapshotName;
 import au.com.origin.snapshots.config.BaseSnapshotConfig;
+import au.com.origin.snapshots.exceptions.ReservedWordException;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestInfo;
@@ -32,4 +35,61 @@ void canUseSnapshotNameAnnotationWithSpaces(TestInfo testInfo) {
     expect.toMatchSnapshot("Hello World");
     snapshotVerifier.validateSnapshots();
   }
+
+  @SnapshotName("can't use '=' character in snapshot name")
+  @Test
+  void cannotUseEqualsInsideSnapshotName(TestInfo testInfo) {
+    SnapshotVerifier snapshotVerifier =
+        new SnapshotVerifier(new BaseSnapshotConfig(), testInfo.getTestClass().get());
+    Expect expect = Expect.of(snapshotVerifier, testInfo.getTestMethod().get());
+    assertThrows(ReservedWordException.class, () -> expect.toMatchSnapshot("FooBar"));
+  }
+
+  @SnapshotName("can't use '[' character in snapshot name")
+  @Test
+  void cannotUseOpeningSquareBracketInsideSnapshotName(TestInfo testInfo) {
+    SnapshotVerifier snapshotVerifier =
+        new SnapshotVerifier(new BaseSnapshotConfig(), testInfo.getTestClass().get());
+    Expect expect = Expect.of(snapshotVerifier, testInfo.getTestMethod().get());
+    assertThrows(ReservedWordException.class, () -> expect.toMatchSnapshot("FooBar"));
+  }
+
+  @SnapshotName("can't use ']' character in snapshot name")
+  @Test
+  void cannotUseClosingSquareBracketInsideSnapshotName(TestInfo testInfo) {
+    SnapshotVerifier snapshotVerifier =
+        new SnapshotVerifier(new BaseSnapshotConfig(), testInfo.getTestClass().get());
+    Expect expect = Expect.of(snapshotVerifier, testInfo.getTestMethod().get());
+    assertThrows(ReservedWordException.class, () -> expect.toMatchSnapshot("FooBar"));
+  }
+
+  @Test
+  void cannotUseEqualsInsideScenarioName(TestInfo testInfo) {
+    SnapshotVerifier snapshotVerifier =
+        new SnapshotVerifier(new BaseSnapshotConfig(), testInfo.getTestClass().get());
+    Expect expect = Expect.of(snapshotVerifier, testInfo.getTestMethod().get());
+    assertThrows(
+        ReservedWordException.class,
+        () -> expect.scenario("can't use = symbol in scenario").toMatchSnapshot("FooBar"));
+  }
+
+  @Test
+  void cannotUseOpeningSquareBracketInsideScenarioName(TestInfo testInfo) {
+    SnapshotVerifier snapshotVerifier =
+        new SnapshotVerifier(new BaseSnapshotConfig(), testInfo.getTestClass().get());
+    Expect expect = Expect.of(snapshotVerifier, testInfo.getTestMethod().get());
+    assertThrows(
+        ReservedWordException.class,
+        () -> expect.scenario("can't use [ symbol in scenario").toMatchSnapshot("FooBar"));
+  }
+
+  @Test
+  void cannotUseClosingSquareBracketInsideScenarioName(TestInfo testInfo) {
+    SnapshotVerifier snapshotVerifier =
+        new SnapshotVerifier(new BaseSnapshotConfig(), testInfo.getTestClass().get());
+    Expect expect = Expect.of(snapshotVerifier, testInfo.getTestMethod().get());
+    assertThrows(
+        ReservedWordException.class,
+        () -> expect.scenario("can't use ] symbol in scenario").toMatchSnapshot("FooBar"));
+  }
 }

java-snapshot-testing-junit4/src/test/java/au/com/origin/snapshots/ParameterizedTest.java

@@ -20,19 +20,19 @@ public class ParameterizedTest {
 
   private Expect expect;
 
-  @Parameters(name = "letter={0}")
+  @Parameters(name = "letter is {0}")
   public static Iterable<Object[]> data() {
-    return Arrays.asList(new Object[][] {{'a'}, {'b'}, {'c'}});
+    return Arrays.asList(new Object[][] {{"a"}, {"b"}, {"c"}});
   }
 
-  private char input;
+  private String input;
 
-  public ParameterizedTest(char input) {
+  public ParameterizedTest(String input) {
     this.input = input;
   }
 
   @Test
   public void test() {
-    expect.scenario(testName.getMethodName()).toMatchSnapshot(input);
+    expect.scenario(input).toMatchSnapshot(input);
   }
 }

java-snapshot-testing-junit4/src/test/java/au/com/origin/snapshots/__snapshots__/ParameterizedTest.snap

@@ -1,13 +1,13 @@
-au.com.origin.snapshots.ParameterizedTest.test[test[letter=a]]=[
+au.com.origin.snapshots.ParameterizedTest.test[a]=[
 a
 ]
 
 
-au.com.origin.snapshots.ParameterizedTest.test[test[letter=b]]=[
+au.com.origin.snapshots.ParameterizedTest.test[b]=[
 b
 ]
 
 
-au.com.origin.snapshots.ParameterizedTest.test[test[letter=c]]=[
+au.com.origin.snapshots.ParameterizedTest.test[c]=[
 c
 ]