@contract-case/case-connector 0.6.5 → 0.6.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contract-case/case-connector",
-  "version": "0.6.5",
+  "version": "0.6.7",
   "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",
@@ -13,7 +13,13 @@
     "type": "git",
     "url": "git+ssh://git@github.com/case-contract-testing/case.git"
   },
+  "bin": {
+    "case-connector": "./dist/bin/case-connector.js"
+  },
   "scripts": {
+    "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",
     "lint": "eslint src --ext .ts --config .eslintrc.json",
     "lint:fix": "eslint src --fix --ext .ts --config .eslintrc.json",
@@ -27,17 +33,23 @@
   "devDependencies": {
     "@contract-case/case-maintainer-config": "0.0.3",
     "@contract-case/eslint-config-case-maintainer": "0.0.3",
-    "@types/jest": "^29.5.2",
-    "@types/uuid": "^9.0.2",
+    "@types/google-protobuf": "^3.15.12",
+    "@types/jest": "^29.5.11",
+    "@types/uuid": "^9.0.6",
+    "grpc-tools": "^1.12.4",
+    "grpc_tools_node_protoc_ts": "^5.3.3",
     "prettier": "^3.0.3",
     "rimraf": "^5.0.1",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1"
   },
   "dependencies": {
-    "@contract-case/case-boundary": "0.8.0",
+    "@contract-case/case-boundary": "0.9.2",
+    "@grpc/grpc-js": "^1.9.13",
+    "@grpc/proto-loader": "^0.7.10",
+    "google-protobuf": "^3.21.2",
     "read-pkg-up": "^7.0.1",
-    "uuid": "^9.0.0"
+    "uuid": "^9.0.1"
   },
   "stability": "stable",
   "types": "build/index.d.ts",
@@ -77,5 +89,5 @@
       }
     }
   },
-  "gitHead": "60f586df63e060e3a7f669b9425ef4ac6f9ce133"
+  "gitHead": "745040a8495f2baa1612b672aa22e7244d916c69"
 }

package/proto/contract_case_pure_rpc.proto

@@ -0,0 +1,106 @@
+syntax = "proto3";
+
+import "google/protobuf/struct.proto";
+
+/*
+ *******************************************************************************
+ *******************************************************************************
+ *                              WARNING: UNUSED                                *
+ *******************************************************************************
+ *******************************************************************************
+ *
+ * This is a (currently) unused draft, where each message is an RPC call
+ *
+ * See contract_case_stream.proto for the current actual proto definition
+ */
+
+// Types
+message ContractCaseConfig {
+  message UsernamePassword {
+    string username = 1;
+    string password = 2;
+  }
+
+  message StateHandler {
+    // TODO
+  }
+
+  message TriggerFunction {
+    // TODO
+  }
+
+  string provider_name = 1;
+  string consumer_name = 2;
+  string log_level = 3;
+  string contract_dir = 4;
+  string contract_filename = 5;
+  string publish = 6;
+  string broker_ci_access_token = 7;
+  string broker_base_url = 8;
+  UsernamePassword broker_basic_auth = 9;
+
+  bool print_results = 10;
+  bool throw_on_fail = 11;
+
+  map<string, StateHandler> state_handlers = 12;
+  map<string, TriggerFunction> trigger_function = 13;
+
+  TriggerFunction trigger_and_test = 14;
+
+  string base_url_under_test = 15; // Long term, this will be moved
+}
+
+message ILogPrinter {
+  // TODO
+}
+
+message IResultPrinter {
+  // TODO
+}
+
+// Responses
+message DefinitionHandle {
+  string definition_id = 1;
+}
+
+message BoundaryResult {
+  // TODO
+}
+
+// Requests
+message BeginDefinitionRequest {
+  ContractCaseConfig config = 1;
+  ILogPrinter log_printer = 2;
+  IResultPrinter result_printer = 3;
+  repeated string caller_versions = 4;
+}
+
+message RunExampleRequest {
+  DefinitionHandle handle = 1;
+  google.protobuf.Struct example_definition = 2;
+  ContractCaseConfig config = 3;
+}
+
+message RunRejectingExampleRequest {
+  DefinitionHandle handle = 1;
+  google.protobuf.Struct example_definition = 2;
+  ContractCaseConfig config = 3;
+}
+
+message StripMatchersRequest {
+  DefinitionHandle handle = 1;
+  google.protobuf.Struct matcher_or_data = 2;
+}
+
+message EndDefinitionRequest {
+  DefinitionHandle handle = 1;
+}
+
+service ContractCaseDefiner {
+  rpc BeginDefinition(BeginDefinitionRequest) returns (DefinitionHandle) {}
+  rpc RunExample(RunExampleRequest) returns (BoundaryResult) {}
+  rpc RunRejectingExample(RunRejectingExampleRequest) returns (BoundaryResult) {
+  }
+  rpc StripMatchers(StripMatchersRequest) returns (BoundaryResult) {}
+  rpc EndDefinition(EndDefinitionRequest) returns (BoundaryResult) {}
+}

package/proto/contract_case_stream.proto

@@ -0,0 +1,303 @@
+syntax = "proto3";
+
+package io.contract_testing.contractcase.grpc;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+
+option java_package = "io.contract_testing.contractcase.grpc";
+
+message ContractCaseConfig {
+  message UsernamePassword {
+    google.protobuf.StringValue username = 1;
+    google.protobuf.StringValue password = 2;
+  }
+
+  google.protobuf.StringValue provider_name = 1;
+  google.protobuf.StringValue consumer_name = 2;
+  google.protobuf.StringValue log_level = 3;
+  google.protobuf.StringValue contract_dir = 4;
+  google.protobuf.StringValue contract_filename = 5;
+  google.protobuf.StringValue publish = 6;
+  google.protobuf.StringValue broker_ci_access_token = 7;
+  google.protobuf.StringValue broker_base_url = 8;
+  UsernamePassword broker_basic_auth = 9;
+
+  google.protobuf.BoolValue print_results = 10;
+  google.protobuf.BoolValue throw_on_fail = 11;
+
+  repeated StateHandlerHandle state_handlers = 12;
+  map<string, TriggerFunctionHandle> trigger_and_tests = 13;
+
+  TriggerFunctionHandle trigger_and_test = 14;
+
+  google.protobuf.StringValue base_url_under_test =
+      15; // Long term, this will be moved
+}
+
+// Indicates a successful response with no payload
+message ResultSuccess {
+}
+message ResultSuccessHasMapPayload {
+  google.protobuf.Struct map = 1;
+}
+message ResultSuccessHasAnyPayload {
+  google.protobuf.Value payload = 1;
+}
+message ResultFailure {
+  google.protobuf.StringValue kind = 1;
+  google.protobuf.StringValue message = 2;
+  google.protobuf.StringValue location = 3;
+}
+
+message BoundaryResult {
+  oneof value {
+    ResultSuccess success = 1;
+    ResultSuccessHasMapPayload success_has_map = 2;
+    ResultSuccessHasAnyPayload success_has_any = 3;
+    ResultFailure failure = 4;
+  }
+}
+
+message StateHandlerHandle {
+  enum Stage {
+    STAGE_SETUP_UNSPECIFIED = 0;
+    STAGE_TEARDOWN = 1;
+  }
+  // The name of the state
+  google.protobuf.StringValue handle = 1;
+  // Whether this is a setup or a teardown handler
+  Stage stage = 2;
+}
+
+message TriggerFunctionHandle {
+  google.protobuf.StringValue handle = 1;
+}
+
+// Requests from client
+message BeginDefinitionRequest {
+  ContractCaseConfig config = 1;
+  repeated google.protobuf.StringValue caller_versions = 4;
+}
+
+message RunExampleRequest {
+  google.protobuf.Struct example_definition = 2;
+  ContractCaseConfig config = 3;
+}
+
+message RunRejectingExampleRequest {
+  google.protobuf.Struct example_definition = 2;
+  ContractCaseConfig config = 3;
+}
+
+message StripMatchersRequest {
+  google.protobuf.Struct matcher_or_data = 2;
+}
+
+message EndDefinitionRequest {
+}
+
+message StateHandlerResponse {
+  StateHandlerHandle state_handler_handle = 1;
+  BoundaryResult result = 2;
+}
+
+message LogPrinterResponse {
+  BoundaryResult result = 1;
+}
+message ResultPrinterResponse {
+  BoundaryResult result = 1;
+}
+
+// Responses from server
+
+message RunStateHandlerRequest {
+  StateHandlerHandle state_handler_handle = 1;
+}
+message TriggerFunctionRequest {
+  TriggerFunctionHandle trigger_function = 1;
+  google.protobuf.Struct config = 2;
+}
+
+message LogRequest {
+  /**
+   * A `LogLevel`   google.protobuf.StringValue , either `error`, `warn`,
+   * `debug`, `maintainerDebug` or `deepMaintainerDebug` Use this to
+   * programmatically decide any colour formatting.. (although `none` is a
+   * possible log level, this function will never be called with `none`).
+   */
+  google.protobuf.StringValue level = 1;
+  /**
+   * The timestamp generated by ContractCase, ready for printing. No extra
+   * formatting is necessary
+   */
+  google.protobuf.StringValue timestamp = 2;
+  /**
+   * The version   google.protobuf.StringValue  for the current ContractCase
+   * stack (at low log levels, this is just the core version)
+   */
+  google.protobuf.StringValue version = 3;
+  /**
+   * A rendered version of the LogLevel. Do not rely on this value
+   * programmatically, use the `level` parameter instead.
+   */
+  google.protobuf.StringValue type_string = 4;
+  /**
+   * A   google.protobuf.StringValue  that represents the location that this log
+   * came from
+   */
+  google.protobuf.StringValue location = 5;
+  /**
+   * The main message of this log line
+   */
+  google.protobuf.StringValue message = 6;
+  /**
+   * Any additional output to print on extra lines (you may want to indent this
+   * when printing)
+   */
+  google.protobuf.StringValue additional = 7;
+}
+
+message PrintMatchErrorRequest {
+  /**
+   * The red highlighted blob, eg "MATCHING ERROR" or "TRIGGER FUNCTION ERROR".
+   * Could be any   google.protobuf.StringValue .
+   */
+  google.protobuf.StringValue kind = 1;
+  /**
+   * A summary of the error. Could be any   google.protobuf.StringValue .
+   */
+  google.protobuf.StringValue message = 2;
+  /**
+   * The location the error happened, for printing at the top of the error
+   * message
+   */
+  google.protobuf.StringValue location = 3;
+  /**
+   * The tag line for the location the error happened, for printing after the
+   * error message. This might have more information than the `location` above.
+   */
+  google.protobuf.StringValue location_tag = 4;
+  /**
+   * The machine-readable type for the cause of this error, for printing after
+   * the error message to make it easy to search for.
+   */
+  google.protobuf.StringValue error_type_tag = 5;
+  /**
+   * A   google.protobuf.StringValue  representation of the expected data (may
+   * contain newlines)
+   */
+  google.protobuf.StringValue expected = 6;
+  /**
+   * A   google.protobuf.StringValue  representation of the actual data received
+   * (may contain newlines)
+   */
+  google.protobuf.StringValue actual = 7;
+}
+
+message PrintMessageErrorRequest {
+  /**
+   * The red highlighted blob, eg "MATCHING ERROR" or "TRIGGER FUNCTION ERROR".
+   * Could be any   google.protobuf.StringValue .
+   */
+  google.protobuf.StringValue kind = 1;
+  /**
+   * A summary of the error. Could be any   google.protobuf.StringValue .
+   */
+  google.protobuf.StringValue message = 2;
+  /**
+   * The location the error happened, for printing at the top of the error
+   * message
+   */
+  google.protobuf.StringValue location = 3;
+  /**
+   * The tag line for the location the error happened, for printing after the
+   * error message. This might have more information than the `location` above.
+   */
+  google.protobuf.StringValue location_tag = 4;
+  /**
+   * The machine-readable type for the cause of this error, for printing after
+   * the error message to make it easy to search for.
+   */
+  google.protobuf.StringValue error_type_tag = 5;
+}
+
+message PrintTestTitleRequest {
+  /**
+   * Either 'success' to indicate success, or 'failure' to indicate failure
+   */
+  google.protobuf.StringValue kind = 1;
+  /**
+   * An icon for the start of the line (usually a single character emoji, but
+   * could be any   google.protobuf.StringValue )
+   */
+  google.protobuf.StringValue icon = 2;
+  /**
+   * The title to print (will not include newlines)
+   */
+  google.protobuf.StringValue title = 3;
+  /**
+   * Any additional text to print after the title (may include newlines)
+   */
+  google.protobuf.StringValue additional_text = 4;
+}
+
+message BeginDefinitionResponse {
+  BoundaryResult result = 1;
+}
+message RunExampleResponse {
+  BoundaryResult result = 1;
+}
+message RunRejectingExampleResponse {
+  BoundaryResult result = 1;
+}
+message StripMatchersResponse {
+  BoundaryResult result = 1;
+}
+message EndDefinitionResponse {
+  BoundaryResult result = 1;
+}
+message TriggerFunctionResponse {
+  BoundaryResult result = 1;
+}
+
+message DefinitionRequest {
+  google.protobuf.StringValue id = 1;
+  oneof kind {
+    // From user calls
+    BeginDefinitionRequest begin_definition = 2;
+    RunExampleRequest run_example = 3;
+    RunRejectingExampleRequest run_rejecting_example = 4;
+    StripMatchersRequest strip_matchers = 5;
+    EndDefinitionRequest end_definition = 6;
+    // Answering server questions
+    StateHandlerResponse state_handler_response = 7;
+    LogPrinterResponse log_printer_response = 8;
+    ResultPrinterResponse result_printer_response = 9;
+    TriggerFunctionResponse trigger_function_response = 10;
+  }
+}
+
+message DefinitionResponse {
+  google.protobuf.StringValue id = 1;
+  oneof kind {
+    // These could come at any time
+    RunStateHandlerRequest run_state_handler = 2;
+    LogRequest log_request = 3;
+    PrintMatchErrorRequest print_match_error_request = 4;
+    PrintMessageErrorRequest print_message_error_request = 5;
+    PrintTestTitleRequest print_test_title_request = 6;
+    TriggerFunctionRequest trigger_function_request = 12;
+    // These indicate the end of an RPC call
+    BeginDefinitionResponse begin_definition_response = 7;
+    RunExampleResponse run_example_response = 8;
+    RunRejectingExampleResponse run_rejecting_example_response = 9;
+    StripMatchersResponse strip_matchers_response = 10;
+    EndDefinitionResponse end_definition_response = 11;
+  }
+}
+
+service ContractCase {
+  rpc ContractDefinition(stream DefinitionRequest)
+      returns (stream DefinitionResponse) {}
+}

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

@@ -0,0 +1,82 @@
+// package: io.contract_testing.contractcase.grpc
+// file: proto/contract_case_stream.proto
+
+/* tslint:disable */
+/* eslint-disable */
+
+import * as grpc from '@grpc/grpc-js';
+import * as proto_contract_case_stream_pb from '../proto/contract_case_stream_pb';
+import * as google_protobuf_struct_pb from 'google-protobuf/google/protobuf/struct_pb';
+import * as google_protobuf_wrappers_pb from 'google-protobuf/google/protobuf/wrappers_pb';
+
+interface IContractCaseService
+  extends grpc.ServiceDefinition<grpc.UntypedServiceImplementation> {
+  contractDefinition: IContractCaseService_IContractDefinition;
+}
+
+interface IContractCaseService_IContractDefinition
+  extends grpc.MethodDefinition<
+    proto_contract_case_stream_pb.DefinitionRequest,
+    proto_contract_case_stream_pb.DefinitionResponse
+  > {
+  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>;
+}
+
+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
+  >;
+}
+
+export interface IContractCaseClient {
+  contractDefinition(): grpc.ClientDuplexStream<
+    proto_contract_case_stream_pb.DefinitionRequest,
+    proto_contract_case_stream_pb.DefinitionResponse
+  >;
+  contractDefinition(
+    options: Partial<grpc.CallOptions>,
+  ): grpc.ClientDuplexStream<
+    proto_contract_case_stream_pb.DefinitionRequest,
+    proto_contract_case_stream_pb.DefinitionResponse
+  >;
+  contractDefinition(
+    metadata: grpc.Metadata,
+    options?: Partial<grpc.CallOptions>,
+  ): grpc.ClientDuplexStream<
+    proto_contract_case_stream_pb.DefinitionRequest,
+    proto_contract_case_stream_pb.DefinitionResponse
+  >;
+}
+
+export class ContractCaseClient
+  extends grpc.Client
+  implements IContractCaseClient
+{
+  constructor(
+    address: string,
+    credentials: grpc.ChannelCredentials,
+    options?: Partial<grpc.ClientOptions>,
+  );
+  public contractDefinition(
+    options?: Partial<grpc.CallOptions>,
+  ): grpc.ClientDuplexStream<
+    proto_contract_case_stream_pb.DefinitionRequest,
+    proto_contract_case_stream_pb.DefinitionResponse
+  >;
+  public contractDefinition(
+    metadata?: grpc.Metadata,
+    options?: Partial<grpc.CallOptions>,
+  ): grpc.ClientDuplexStream<
+    proto_contract_case_stream_pb.DefinitionRequest,
+    proto_contract_case_stream_pb.DefinitionResponse
+  >;
+}

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

@@ -0,0 +1,46 @@
+// GENERATED CODE -- DO NOT EDIT!
+
+'use strict';
+var grpc = require('@grpc/grpc-js');
+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_DefinitionRequest(arg) {
+  if (!(arg instanceof proto_contract_case_stream_pb.DefinitionRequest)) {
+    throw new Error('Expected argument of type io.contract_testing.contractcase.grpc.DefinitionRequest');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_io_contract_testing_contractcase_grpc_DefinitionRequest(buffer_arg) {
+  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');
+  }
+  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));
+}
+
+
+var ContractCaseService = exports.ContractCaseService = {
+  contractDefinition: {
+    path: '/io.contract_testing.contractcase.grpc.ContractCase/ContractDefinition',
+    requestStream: true,
+    responseStream: true,
+    requestType: proto_contract_case_stream_pb.DefinitionRequest,
+    responseType: proto_contract_case_stream_pb.DefinitionResponse,
+    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,
+  },
+};
+
+exports.ContractCaseClient = grpc.makeGenericClientConstructor(ContractCaseService);