feat!: Change config map for a more convenient SetupInfo object

Author: TimothyJones

src/main/java/io/contract_testing/contractcase/BoundaryTriggerMapper.java

@@ -12,15 +12,23 @@ static <T> ITriggerFunction map(
       TestResponseFunction<T> testResponseFunction) {
 
     return config -> {
+
+      SetupInfo setupInfo;
+      try {
+        setupInfo = SetupInfo.from(config);
+      } catch (Throwable e) {
+        return ConnectorExceptionMapper.map(e);
+      }
+
       T ret;
       try {
-        ret = trigger.call(config);
+        ret = trigger.call(setupInfo);
       } catch (Throwable e) {
         return ConnectorExceptionMapper.mapAsTriggerFailure(e);
       }
 
       try {
-        testResponseFunction.call(ret);
+        testResponseFunction.call(ret, setupInfo);
       } catch (Throwable e) {
         return ConnectorExceptionMapper.mapAsVerifyFailure(e);
       }
@@ -32,13 +40,19 @@ static <T> ITriggerFunction map(
   static <T> ITriggerFunction map(Trigger<T> trigger,
       TestErrorResponseFunction testErrorResponseFunction) {
     return config -> {
+      SetupInfo setupInfo;
+      try {
+        setupInfo = SetupInfo.from(config);
+      } catch (Throwable e) {
+        return ConnectorExceptionMapper.map(e);
+      }
       try {
-        trigger.call(config);
+        trigger.call(setupInfo);
         return ConnectorExceptionMapper.mapAsTriggerFailure(
             new RuntimeException("Expected the trigger to fail, but it did not"));
       } catch (Throwable triggerException) {
         try {
-          testErrorResponseFunction.call(triggerException);
+          testErrorResponseFunction.call(triggerException, setupInfo);
         } catch (Throwable verifyException) {
           return ConnectorExceptionMapper.mapAsVerifyFailure(verifyException);
         }

src/main/java/io/contract_testing/contractcase/ContractCaseCoreError.java

@@ -31,7 +31,7 @@ public ContractCaseCoreError(Throwable e) {
   }
 
   public ContractCaseCoreError(@NotNull String message, Throwable cause) {
-    super(message, cause);
+    super(message + "(" + cause.getMessage() + ")", cause);
     if (cause instanceof ContractCaseCoreError) {
       this.location = ((ContractCaseCoreError) cause).getLocation();
     } else {

src/main/java/io/contract_testing/contractcase/SetupInfo.java

@@ -0,0 +1,87 @@
+package io.contract_testing.contractcase;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+/**
+ * Container for information about the mock side of a particular example
+ */
+public class SetupInfo {
+
+  public static final String STATE_VARIABLES_KEY = "variables";
+  private final Map<String, Object> config;
+
+  private final Map<String, String> stateVariables;
+
+  private SetupInfo(Map<String, Object> config) {
+    this.config = config;
+    var variables = config.get(STATE_VARIABLES_KEY);
+    if (variables == null) {
+      this.stateVariables = Map.of();
+    } else {
+      try {
+        this.stateVariables = Collections.unmodifiableMap((Map<String, String>) variables);
+      } catch (ClassCastException e) {
+        throw new ContractCaseCoreError("Invalid variables array in SetupInfo constructor", e);
+      }
+    }
+  }
+
+  /**
+   * Get a state variable set by a state definition or state handler
+   *
+   * @param key the state variable key that was defined in the state handler
+   * @return The value of this state variable
+   * @throws ContractCaseConfigurationError if there is no value for this key
+   */
+  public String getStateVariable(String key) {
+    if (this.stateVariables.get(key) == null) {
+      var stateKeys = new ArrayList<>(this.stateVariables.keySet());
+      throw new ContractCaseConfigurationError("No state variable present with name '" + key
+          + "'. Check the variable is defined in the contract. "
+          + (stateKeys.size() == 0
+          ? "There are no currently defined state variables"
+          : "Currently defined variables are: \n"
+              + stateKeys
+              .stream().map(s -> "    " + s)
+              .collect(Collectors.joining("\n"))));
+    }
+    return this.stateVariables.get(key);
+  }
+
+  /**
+   * Get a configuration parameter for the running mock example
+   *
+   * @param key the configuration key for this mock
+   * @return The value of this configuration setting
+   * @throws ContractCaseConfigurationError if there is no value for this key
+   */
+  public String getInfo(String key) {
+    if (this.config.get(key) == null) {
+      throw new ContractCaseConfigurationError("No setup information for key '" + key
+          + "'. Check the key is correct for this mock type");
+    }
+
+    try {
+      return (String) this.config.get(key);
+    } catch (ClassCastException e) {
+      throw new ContractCaseCoreError(
+          "The setup key '" + key + "' contained something that couldn't cast to a string",
+          e
+      );
+    }
+  }
+
+  /**
+   * Construct a new SetupInfo convenience object from this configuration map
+   *
+   * @param config The configuration map from the Connector
+   * @return a new SetupInfo object
+   */
+  static SetupInfo from(Map<String, Object> config) {
+    return new SetupInfo(config);
+  }
+
+}

src/main/java/io/contract_testing/contractcase/TestErrorResponseFunction.java

@@ -2,5 +2,5 @@
 
 public interface TestErrorResponseFunction {
 
-  void call(Throwable e);
+  void call(Throwable e, SetupInfo config);
 }

src/main/java/io/contract_testing/contractcase/TestResponseFunction.java

@@ -2,5 +2,5 @@
 
 public interface TestResponseFunction<T> {
 
-  void call(T returnedObject);
+  void call(T returnedObject, SetupInfo config);
 }

src/main/java/io/contract_testing/contractcase/Trigger.java

@@ -1,9 +1,8 @@
 package io.contract_testing.contractcase;
 
-import java.util.Map;
 import org.jetbrains.annotations.NotNull;
 
 public interface Trigger<T> {
 
-  T call(final @NotNull Map<String, Object> config);
+  T call(final @NotNull SetupInfo setupInfo);
 }

src/main/java/io/contract_testing/contractcase/edge/ConnectorExceptionMapper.java

@@ -1,5 +1,6 @@
 package io.contract_testing.contractcase.edge;
 
+import io.contract_testing.contractcase.ContractCaseConfigurationError;
 import io.contract_testing.contractcase.ContractCaseCoreError;
 import java.util.Arrays;
 import java.util.stream.Collectors;
@@ -13,7 +14,10 @@ public static String stackTraceToString(Throwable e) {
 
   public static ConnectorFailure map(Throwable e) {
     var failure = new ConnectorFailure(
-        e.getClass().getName(),
+        e instanceof ContractCaseConfigurationError
+            ? ConnectorFailureKindConstants.CASE_CONFIGURATION_ERROR
+            : ConnectorFailureKindConstants.CASE_CORE_ERROR
+        ,
         e.getMessage(),
         stackTraceToString(e)
     );