@contract-case/case-connector 0.7.4 → 0.7.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contract-case/case-connector",
-  "version": "0.7.4",
+  "version": "0.7.5",
   "description": "Connector to allow ContractCase to run as a server. Use only if you're creating a custom wrapper for a new language",
   "author": "Timothy Jones <timothy.l.jones@gmail.com> (https://github.com/TimothyJones)",
   "homepage": "https://case.contract-testing.io/docs",
@@ -20,9 +20,10 @@
     "build:proto": "npm run build:proto:js && npm run build:proto:ts && npm run format:fix",
     "build:proto:js": "grpc_tools_node_protoc --js_out=import_style=commonjs,binary:src/connectors/grpc --grpc_out=grpc_js:src/connectors/grpc ./proto/contract_case_stream.proto",
     "build:proto:ts": "grpc_tools_node_protoc --js_out=import_style=commonjs,binary:src/connectors/grpc --grpc_out=grpc_js:src/connectors/grpc --plugin=protoc-gen-grpc=../../node_modules/grpc_tools_node_protoc_ts/bin/protoc-gen-ts ./proto/contract_case_stream.proto",
-    "build": "rimraf dist && tsc --project tsconfig.build.json",
+    "build": "rimraf {dist,package} && tsc --project tsconfig.build.json && webpack-cli",
     "lint": "eslint src --ext .ts --config .eslintrc.json",
     "lint:fix": "eslint src --fix --ext .ts --config .eslintrc.json",
+    "lint:fix:proto": "protolint --fix ./proto",
     "format:base": "prettier --parser typescript \"src/**/*.ts\"",
     "format:check": "npm run format:base -- --list-different",
     "format:fix": "npm run format:base -- --write "
@@ -32,24 +33,29 @@
   },
   "devDependencies": {
     "@contract-case/case-maintainer-config": "0.0.4",
-    "@contract-case/eslint-config-case-maintainer": "0.0.3",
+    "@contract-case/eslint-config-case-maintainer": "0.1.0",
     "@types/google-protobuf": "^3.15.12",
-    "@types/jest": "^29.5.11",
+    "@types/jest": "^29.5.12",
     "@types/uuid": "^9.0.8",
     "grpc-tools": "^1.12.4",
     "grpc_tools_node_protoc_ts": "^5.3.3",
     "prettier": "3.2.5",
     "rimraf": "^5.0.1",
+    "source-map-loader": "^5.0.0",
+    "terser-webpack-plugin": "^5.3.10",
     "ts-jest": "^29.1.2",
-    "ts-node": "^10.9.2"
+    "ts-node": "^10.9.2",
+    "webpack": "^5.89.0",
+    "webpack-cli": "^5.1.4"
   },
   "dependencies": {
-    "@contract-case/case-boundary": "0.10.4",
-    "@contract-case/case-entities-internal": "0.15.6",
-    "@grpc/grpc-js": "^1.9.13",
+    "@contract-case/case-core": "0.15.7",
+    "@contract-case/case-entities-internal": "0.15.7",
+    "@grpc/grpc-js": "^1.10.2",
     "@grpc/proto-loader": "^0.7.10",
+    "get-port": "^5.1.1",
     "google-protobuf": "^3.21.2",
-    "read-pkg-up": "^7.0.1",
+    "pretty-format": "^29.7.0",
     "uuid": "^9.0.1"
   },
   "stability": "stable",
@@ -90,5 +96,5 @@
       }
     }
   },
-  "gitHead": "8ef36af772b4216af067dc277e59340dd44d79ce"
+  "gitHead": "6e4d0291562476cd6da39007894fcf54a0cfd65e"
 }

package/proto/contract_case_stream.proto

@@ -237,18 +237,68 @@ message ResultResponse {
 message DefinitionRequest {
   google.protobuf.StringValue id = 1;
   oneof kind {
-    // From user calls
+    // 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;
+    // Host language wants to run an example that returns a failure
     RunRejectingExampleRequest run_rejecting_example = 4;
+    // Host language wants to strip the matchers from a defintion
     StripMatchersRequest strip_matchers = 5;
+    // Host langauge has finished the definition
     EndDefinitionRequest end_definition = 6;
-    // Answering server driven RPC calls
+    // Core returns a response to a host call
     ResultResponse result_response = 7;
   }
 }
 
-message DefinitionResponse {
+message BeginVerificationRequest {
+  // The configuration for this verification
+  ContractCaseConfig config = 1;
+  // Version strings of all ContractCase components for maintainer logs
+  repeated google.protobuf.StringValue caller_versions = 4;
+}
+
+message AvailableContractDefinitions {
+}
+
+message RunVerification {
+  // Any configuration overrides for this verification
+  ContractCaseConfig config = 1;
+}
+
+message StartTestEvent {
+  // The name of this test (human readable)
+  google.protobuf.StringValue test_name = 1;
+  // An ID for a callback to the test invoker when the core is ready
+  google.protobuf.StringValue invoker_id = 2;
+}
+
+message InvokeTest {
+  // Callback ID from the host language in a start test event
+  // Used by the core to invoke a specific test
+  google.protobuf.StringValue invoker_id = 1;
+}
+
+message VerificationRequest {
+  google.protobuf.StringValue id = 1;
+  oneof kind {
+    // Host language wants to start a verification session
+    // Used to do initial setup by the core - must be called before
+    // run_verification
+    BeginVerificationRequest begin_verification = 2;
+    // Host language wants to know what contracts are available
+    AvailableContractDefinitions available_contract_definitions = 3;
+    // Host language wants to run a verification
+    RunVerification run_verification = 4;
+    // Core is responding to a host call
+    ResultResponse result_response = 5;
+    // Core wants to invoke a specific test
+    InvokeTest invoke_test = 9;
+  }
+}
+
+message ContractResponse {
   google.protobuf.StringValue id = 1;
   oneof kind {
     // Run a state handler
@@ -265,10 +315,15 @@ message DefinitionResponse {
     TriggerFunctionRequest trigger_function_request = 7;
     // Answering client driven RPC calls
     ResultResponse result_response = 8;
+    // Invoking tests (verification only)
+    StartTestEvent start_test_event = 9;
   }
 }
 
 service ContractCase {
   rpc ContractDefinition(stream DefinitionRequest)
-      returns (stream DefinitionResponse) {}
+      returns (stream ContractResponse) {}
+
+  rpc ContractVerification(stream VerificationRequest)
+      returns (stream ContractResponse) {}
 }

package/src/connectors/grpc/proto/contract_case_stream_grpc_pb.d.ts

@@ -12,20 +12,34 @@ import * as google_protobuf_wrappers_pb from 'google-protobuf/google/protobuf/wr
 interface IContractCaseService
   extends grpc.ServiceDefinition<grpc.UntypedServiceImplementation> {
   contractDefinition: IContractCaseService_IContractDefinition;
+  contractVerification: IContractCaseService_IContractVerification;
 }
 
 interface IContractCaseService_IContractDefinition
   extends grpc.MethodDefinition<
     proto_contract_case_stream_pb.DefinitionRequest,
-    proto_contract_case_stream_pb.DefinitionResponse
+    proto_contract_case_stream_pb.ContractResponse
   > {
   path: '/io.contract_testing.contractcase.grpc.ContractCase/ContractDefinition';
   requestStream: true;
   responseStream: true;
   requestSerialize: grpc.serialize<proto_contract_case_stream_pb.DefinitionRequest>;
   requestDeserialize: grpc.deserialize<proto_contract_case_stream_pb.DefinitionRequest>;
-  responseSerialize: grpc.serialize<proto_contract_case_stream_pb.DefinitionResponse>;
-  responseDeserialize: grpc.deserialize<proto_contract_case_stream_pb.DefinitionResponse>;
+  responseSerialize: grpc.serialize<proto_contract_case_stream_pb.ContractResponse>;
+  responseDeserialize: grpc.deserialize<proto_contract_case_stream_pb.ContractResponse>;
+}
+interface IContractCaseService_IContractVerification
+  extends grpc.MethodDefinition<
+    proto_contract_case_stream_pb.VerificationRequest,
+    proto_contract_case_stream_pb.ContractResponse
+  > {
+  path: '/io.contract_testing.contractcase.grpc.ContractCase/ContractVerification';
+  requestStream: true;
+  responseStream: true;
+  requestSerialize: grpc.serialize<proto_contract_case_stream_pb.VerificationRequest>;
+  requestDeserialize: grpc.deserialize<proto_contract_case_stream_pb.VerificationRequest>;
+  responseSerialize: grpc.serialize<proto_contract_case_stream_pb.ContractResponse>;
+  responseDeserialize: grpc.deserialize<proto_contract_case_stream_pb.ContractResponse>;
 }
 
 export const ContractCaseService: IContractCaseService;
@@ -33,27 +47,48 @@ export const ContractCaseService: IContractCaseService;
 export interface IContractCaseServer extends grpc.UntypedServiceImplementation {
   contractDefinition: grpc.handleBidiStreamingCall<
     proto_contract_case_stream_pb.DefinitionRequest,
-    proto_contract_case_stream_pb.DefinitionResponse
+    proto_contract_case_stream_pb.ContractResponse
+  >;
+  contractVerification: grpc.handleBidiStreamingCall<
+    proto_contract_case_stream_pb.VerificationRequest,
+    proto_contract_case_stream_pb.ContractResponse
   >;
 }
 
 export interface IContractCaseClient {
   contractDefinition(): grpc.ClientDuplexStream<
     proto_contract_case_stream_pb.DefinitionRequest,
-    proto_contract_case_stream_pb.DefinitionResponse
+    proto_contract_case_stream_pb.ContractResponse
   >;
   contractDefinition(
     options: Partial<grpc.CallOptions>,
   ): grpc.ClientDuplexStream<
     proto_contract_case_stream_pb.DefinitionRequest,
-    proto_contract_case_stream_pb.DefinitionResponse
+    proto_contract_case_stream_pb.ContractResponse
   >;
   contractDefinition(
     metadata: grpc.Metadata,
     options?: Partial<grpc.CallOptions>,
   ): grpc.ClientDuplexStream<
     proto_contract_case_stream_pb.DefinitionRequest,
-    proto_contract_case_stream_pb.DefinitionResponse
+    proto_contract_case_stream_pb.ContractResponse
+  >;
+  contractVerification(): grpc.ClientDuplexStream<
+    proto_contract_case_stream_pb.VerificationRequest,
+    proto_contract_case_stream_pb.ContractResponse
+  >;
+  contractVerification(
+    options: Partial<grpc.CallOptions>,
+  ): grpc.ClientDuplexStream<
+    proto_contract_case_stream_pb.VerificationRequest,
+    proto_contract_case_stream_pb.ContractResponse
+  >;
+  contractVerification(
+    metadata: grpc.Metadata,
+    options?: Partial<grpc.CallOptions>,
+  ): grpc.ClientDuplexStream<
+    proto_contract_case_stream_pb.VerificationRequest,
+    proto_contract_case_stream_pb.ContractResponse
   >;
 }
 
@@ -70,13 +105,26 @@ export class ContractCaseClient
     options?: Partial<grpc.CallOptions>,
   ): grpc.ClientDuplexStream<
     proto_contract_case_stream_pb.DefinitionRequest,
-    proto_contract_case_stream_pb.DefinitionResponse
+    proto_contract_case_stream_pb.ContractResponse
   >;
   public contractDefinition(
     metadata?: grpc.Metadata,
     options?: Partial<grpc.CallOptions>,
   ): grpc.ClientDuplexStream<
     proto_contract_case_stream_pb.DefinitionRequest,
-    proto_contract_case_stream_pb.DefinitionResponse
+    proto_contract_case_stream_pb.ContractResponse
+  >;
+  public contractVerification(
+    options?: Partial<grpc.CallOptions>,
+  ): grpc.ClientDuplexStream<
+    proto_contract_case_stream_pb.VerificationRequest,
+    proto_contract_case_stream_pb.ContractResponse
+  >;
+  public contractVerification(
+    metadata?: grpc.Metadata,
+    options?: Partial<grpc.CallOptions>,
+  ): grpc.ClientDuplexStream<
+    proto_contract_case_stream_pb.VerificationRequest,
+    proto_contract_case_stream_pb.ContractResponse
   >;
 }

package/src/connectors/grpc/proto/contract_case_stream_grpc_pb.js

@@ -6,6 +6,17 @@ var proto_contract_case_stream_pb = require('../proto/contract_case_stream_pb.js
 var google_protobuf_struct_pb = require('google-protobuf/google/protobuf/struct_pb.js');
 var google_protobuf_wrappers_pb = require('google-protobuf/google/protobuf/wrappers_pb.js');
 
+function serialize_io_contract_testing_contractcase_grpc_ContractResponse(arg) {
+  if (!(arg instanceof proto_contract_case_stream_pb.ContractResponse)) {
+    throw new Error('Expected argument of type io.contract_testing.contractcase.grpc.ContractResponse');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_io_contract_testing_contractcase_grpc_ContractResponse(buffer_arg) {
+  return proto_contract_case_stream_pb.ContractResponse.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
 function serialize_io_contract_testing_contractcase_grpc_DefinitionRequest(arg) {
   if (!(arg instanceof proto_contract_case_stream_pb.DefinitionRequest)) {
     throw new Error('Expected argument of type io.contract_testing.contractcase.grpc.DefinitionRequest');
@@ -17,15 +28,15 @@ function deserialize_io_contract_testing_contractcase_grpc_DefinitionRequest(buf
   return proto_contract_case_stream_pb.DefinitionRequest.deserializeBinary(new Uint8Array(buffer_arg));
 }
 
-function serialize_io_contract_testing_contractcase_grpc_DefinitionResponse(arg) {
-  if (!(arg instanceof proto_contract_case_stream_pb.DefinitionResponse)) {
-    throw new Error('Expected argument of type io.contract_testing.contractcase.grpc.DefinitionResponse');
+function serialize_io_contract_testing_contractcase_grpc_VerificationRequest(arg) {
+  if (!(arg instanceof proto_contract_case_stream_pb.VerificationRequest)) {
+    throw new Error('Expected argument of type io.contract_testing.contractcase.grpc.VerificationRequest');
   }
   return Buffer.from(arg.serializeBinary());
 }
 
-function deserialize_io_contract_testing_contractcase_grpc_DefinitionResponse(buffer_arg) {
-  return proto_contract_case_stream_pb.DefinitionResponse.deserializeBinary(new Uint8Array(buffer_arg));
+function deserialize_io_contract_testing_contractcase_grpc_VerificationRequest(buffer_arg) {
+  return proto_contract_case_stream_pb.VerificationRequest.deserializeBinary(new Uint8Array(buffer_arg));
 }
 
 
@@ -35,11 +46,22 @@ var ContractCaseService = exports.ContractCaseService = {
     requestStream: true,
     responseStream: true,
     requestType: proto_contract_case_stream_pb.DefinitionRequest,
-    responseType: proto_contract_case_stream_pb.DefinitionResponse,
+    responseType: proto_contract_case_stream_pb.ContractResponse,
     requestSerialize: serialize_io_contract_testing_contractcase_grpc_DefinitionRequest,
     requestDeserialize: deserialize_io_contract_testing_contractcase_grpc_DefinitionRequest,
-    responseSerialize: serialize_io_contract_testing_contractcase_grpc_DefinitionResponse,
-    responseDeserialize: deserialize_io_contract_testing_contractcase_grpc_DefinitionResponse,
+    responseSerialize: serialize_io_contract_testing_contractcase_grpc_ContractResponse,
+    responseDeserialize: deserialize_io_contract_testing_contractcase_grpc_ContractResponse,
+  },
+  contractVerification: {
+    path: '/io.contract_testing.contractcase.grpc.ContractCase/ContractVerification',
+    requestStream: true,
+    responseStream: true,
+    requestType: proto_contract_case_stream_pb.VerificationRequest,
+    responseType: proto_contract_case_stream_pb.ContractResponse,
+    requestSerialize: serialize_io_contract_testing_contractcase_grpc_VerificationRequest,
+    requestDeserialize: deserialize_io_contract_testing_contractcase_grpc_VerificationRequest,
+    responseSerialize: serialize_io_contract_testing_contractcase_grpc_ContractResponse,
+    responseDeserialize: deserialize_io_contract_testing_contractcase_grpc_ContractResponse,
   },
 };