refactor!: Replace runExample / runRejectingExample / runThrowingExample with runInteraction / runRejectingInteraction / runThrowingInteraction

Author: TimothyJones

docs/maintainers/AddingDsl.md

@@ -131,14 +131,14 @@ Create a `ContractDefiner` class. It must:
 1. Have a constructor that takes a `ContractCaseConfig`, and instantiates a private
    `BoundaryContractDefiner`, with a mapped version of the config. See the boundary
    mappings section below.
-2. Expose a `runExample` method
-   - This method delegates to the BoundaryContractDefiner.runExample
+2. Expose a `runInteraction` method
+   - This method delegates to the BoundaryContractDefiner.runInteraction
    - Map the returned `BoundaryResult` into an error (if appropriate). See the error mappings section below.
    - TODO: Describe how to map trigger / testResponse - this is the only place where you may throw a `CaseConfigurationError`
-3. Expose a `runRejectingExample` method.
-   -You may change the name of `runRejectingExample` to `runXXXExample` where `XXX` is an idiomatic word for `rejecting` in your language.
-   - This method delegates to the `BoundaryContractDefiner.runRejectingExample`
-   - Map the `BoundaryResult` the same way as the `runExample` method.
+3. Expose a `runRejectingInteraction` method.
+   -You may change the name of `runRejectingInteraction` to `runXXXExample` where `XXX` is an idiomatic word for `rejecting` in your language.
+   - This method delegates to the `BoundaryContractDefiner.runRejectingInteraction`
+   - Map the `BoundaryResult` the same way as the `runInteraction` method.
    - TODO: Describe how to map trigger / testErrorResponse - this is the only place where you may throw a `CaseConfigurationError`
 
 ### Unmarshalling a `BoundaryFailure`

docs/maintainers/todo.md

@@ -40,7 +40,7 @@ Document
 
 - [ ] `namedLookup` for looking up a named segment
 - [ ] Automatically named request / response pairs
-- [ ] stateHandlers and Config in the runExample or the main contract call
+- [ ] stateHandlers and Config in the runInteraction or the main contract call
 
 Java:
 
@@ -372,7 +372,7 @@ Cool features
   - [ ] Write documentation for every single CaseConfigurationError
 - [ ] Annotate code generally with maintainer debug info
 - [ ] Make raw errors on matcher save print a diff
-- [ ] Make it an error to specify a different consumerName in runExample and defineContract
+- [ ] Make it an error to specify a different consumerName in runInteraction and defineContract
 - [ ] Warn when an autogenerated name is used directly in a test
 - [ ] Debug logs should include state variables
 - [ ] Error collapsers, so if the same spot produces the same errors for different reasons it will only be reported once.

packages/case-connector-proto/proto/contract_case_stream.proto

@@ -91,14 +91,14 @@ message BeginDefinitionRequest {
 
 // From Host to Core, instructs the core to run a particular example as part of
 // contract definition
-message RunExampleRequest {
+message RunInteractionRequest {
   google.protobuf.Struct example_definition = 2;
   ContractCaseConfig config = 3;
 }
 
 // From host to core, instructs the core to run a particular example, that we
 // expect to fail. This is part of contract definition
-message RunRejectingExampleRequest {
+message RunRejectingInteractionRequest {
   google.protobuf.Struct example_definition = 2;
   ContractCaseConfig config = 3;
 }
@@ -346,9 +346,9 @@ message DefinitionRequest {
     // Host language wants to begin a definition
     BeginDefinitionRequest begin_definition = 2;
     // Host language wants to run an example that returns success
-    RunExampleRequest run_example = 3;
+    RunInteractionRequest run_interaction = 3;
     // Host language wants to run an example that returns a failure
-    RunRejectingExampleRequest run_rejecting_example = 4;
+    RunRejectingInteractionRequest run_rejecting_interaction = 4;
     // Host language wants to strip the matchers from a defintion
     StripMatchersRequest strip_matchers = 5;
     // Host langauge has finished the definition

packages/case-connector-proto/src/grpc/proto/contract_case_stream_pb.d.ts

@@ -527,82 +527,82 @@ export namespace BeginDefinitionRequest {
   };
 }
 
-export class RunExampleRequest extends jspb.Message {
+export class RunInteractionRequest extends jspb.Message {
   hasExampleDefinition(): boolean;
   clearExampleDefinition(): void;
   getExampleDefinition(): google_protobuf_struct_pb.Struct | undefined;
   setExampleDefinition(
     value?: google_protobuf_struct_pb.Struct,
-  ): RunExampleRequest;
+  ): RunInteractionRequest;
 
   hasConfig(): boolean;
   clearConfig(): void;
   getConfig(): ContractCaseConfig | undefined;
-  setConfig(value?: ContractCaseConfig): RunExampleRequest;
+  setConfig(value?: ContractCaseConfig): RunInteractionRequest;
 
   serializeBinary(): Uint8Array;
-  toObject(includeInstance?: boolean): RunExampleRequest.AsObject;
+  toObject(includeInstance?: boolean): RunInteractionRequest.AsObject;
   static toObject(
     includeInstance: boolean,
-    msg: RunExampleRequest,
-  ): RunExampleRequest.AsObject;
+    msg: RunInteractionRequest,
+  ): RunInteractionRequest.AsObject;
   static extensions: { [key: number]: jspb.ExtensionFieldInfo<jspb.Message> };
   static extensionsBinary: {
     [key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>;
   };
   static serializeBinaryToWriter(
-    message: RunExampleRequest,
+    message: RunInteractionRequest,
     writer: jspb.BinaryWriter,
   ): void;
-  static deserializeBinary(bytes: Uint8Array): RunExampleRequest;
+  static deserializeBinary(bytes: Uint8Array): RunInteractionRequest;
   static deserializeBinaryFromReader(
-    message: RunExampleRequest,
+    message: RunInteractionRequest,
     reader: jspb.BinaryReader,
-  ): RunExampleRequest;
+  ): RunInteractionRequest;
 }
 
-export namespace RunExampleRequest {
+export namespace RunInteractionRequest {
   export type AsObject = {
     exampleDefinition?: google_protobuf_struct_pb.Struct.AsObject;
     config?: ContractCaseConfig.AsObject;
   };
 }
 
-export class RunRejectingExampleRequest extends jspb.Message {
+export class RunRejectingInteractionRequest extends jspb.Message {
   hasExampleDefinition(): boolean;
   clearExampleDefinition(): void;
   getExampleDefinition(): google_protobuf_struct_pb.Struct | undefined;
   setExampleDefinition(
     value?: google_protobuf_struct_pb.Struct,
-  ): RunRejectingExampleRequest;
+  ): RunRejectingInteractionRequest;
 
   hasConfig(): boolean;
   clearConfig(): void;
   getConfig(): ContractCaseConfig | undefined;
-  setConfig(value?: ContractCaseConfig): RunRejectingExampleRequest;
+  setConfig(value?: ContractCaseConfig): RunRejectingInteractionRequest;
 
   serializeBinary(): Uint8Array;
-  toObject(includeInstance?: boolean): RunRejectingExampleRequest.AsObject;
+  toObject(includeInstance?: boolean): RunRejectingInteractionRequest.AsObject;
   static toObject(
     includeInstance: boolean,
-    msg: RunRejectingExampleRequest,
-  ): RunRejectingExampleRequest.AsObject;
+    msg: RunRejectingInteractionRequest,
+  ): RunRejectingInteractionRequest.AsObject;
   static extensions: { [key: number]: jspb.ExtensionFieldInfo<jspb.Message> };
   static extensionsBinary: {
     [key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>;
   };
   static serializeBinaryToWriter(
-    message: RunRejectingExampleRequest,
+    message: RunRejectingInteractionRequest,
     writer: jspb.BinaryWriter,
   ): void;
-  static deserializeBinary(bytes: Uint8Array): RunRejectingExampleRequest;
+  static deserializeBinary(bytes: Uint8Array): RunRejectingInteractionRequest;
   static deserializeBinaryFromReader(
-    message: RunRejectingExampleRequest,
+    message: RunRejectingInteractionRequest,
     reader: jspb.BinaryReader,
-  ): RunRejectingExampleRequest;
+  ): RunRejectingInteractionRequest;
 }
 
-export namespace RunRejectingExampleRequest {
+export namespace RunRejectingInteractionRequest {
   export type AsObject = {
     exampleDefinition?: google_protobuf_struct_pb.Struct.AsObject;
     config?: ContractCaseConfig.AsObject;
@@ -832,11 +832,11 @@ export namespace CoreFunctionHandle {
 }
 
 export class SetupInfo extends jspb.Message {
-  getStatevariablesMap(): jspb.Map<
+  getStateVariablesMap(): jspb.Map<
     string,
     google_protobuf_wrappers_pb.StringValue
   >;
-  clearStatevariablesMap(): void;
+  clearStateVariablesMap(): void;
 
   getMockMap(): jspb.Map<string, google_protobuf_wrappers_pb.StringValue>;
   clearMockMap(): void;
@@ -864,7 +864,7 @@ export class SetupInfo extends jspb.Message {
 
 export namespace SetupInfo {
   export type AsObject = {
-    statevariablesMap: Array<
+    stateVariablesMap: Array<
       [string, google_protobuf_wrappers_pb.StringValue.AsObject]
     >;
 
@@ -1446,15 +1446,17 @@ export class DefinitionRequest extends jspb.Message {
   getBeginDefinition(): BeginDefinitionRequest | undefined;
   setBeginDefinition(value?: BeginDefinitionRequest): DefinitionRequest;
 
-  hasRunExample(): boolean;
-  clearRunExample(): void;
-  getRunExample(): RunExampleRequest | undefined;
-  setRunExample(value?: RunExampleRequest): DefinitionRequest;
+  hasRunInteraction(): boolean;
+  clearRunInteraction(): void;
+  getRunInteraction(): RunInteractionRequest | undefined;
+  setRunInteraction(value?: RunInteractionRequest): DefinitionRequest;
 
-  hasRunRejectingExample(): boolean;
-  clearRunRejectingExample(): void;
-  getRunRejectingExample(): RunRejectingExampleRequest | undefined;
-  setRunRejectingExample(value?: RunRejectingExampleRequest): DefinitionRequest;
+  hasRunRejectingInteraction(): boolean;
+  clearRunRejectingInteraction(): void;
+  getRunRejectingInteraction(): RunRejectingInteractionRequest | undefined;
+  setRunRejectingInteraction(
+    value?: RunRejectingInteractionRequest,
+  ): DefinitionRequest;
 
   hasStripMatchers(): boolean;
   clearStripMatchers(): void;
@@ -1513,8 +1515,8 @@ export namespace DefinitionRequest {
   export type AsObject = {
     id?: google_protobuf_wrappers_pb.StringValue.AsObject;
     beginDefinition?: BeginDefinitionRequest.AsObject;
-    runExample?: RunExampleRequest.AsObject;
-    runRejectingExample?: RunRejectingExampleRequest.AsObject;
+    runInteraction?: RunInteractionRequest.AsObject;
+    runRejectingInteraction?: RunRejectingInteractionRequest.AsObject;
     stripMatchers?: StripMatchersRequest.AsObject;
     endDefinition?: EndDefinitionRequest.AsObject;
     resultResponse?: ResultResponse.AsObject;
@@ -1526,8 +1528,8 @@ export namespace DefinitionRequest {
   export enum KindCase {
     KIND_NOT_SET = 0,
     BEGIN_DEFINITION = 2,
-    RUN_EXAMPLE = 3,
-    RUN_REJECTING_EXAMPLE = 4,
+    RUN_INTERACTION = 3,
+    RUN_REJECTING_INTERACTION = 4,
     STRIP_MATCHERS = 5,
     END_DEFINITION = 6,
     RESULT_RESPONSE = 7,