@pact-foundation/pact-core 13.9.1 → 13.11.0

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [13.11.0](https://github.com/pact-foundation/pact-js-core/compare/v13.10.0...v13.11.0) (2022-10-31)
+
+
+### Features
+
+* add additional FFI methods to support plugins ([246e86f](https://github.com/pact-foundation/pact-js-core/commit/246e86f8f41a2228ec656425447e28c6e4227433))
+* support branch/autoDetectVersionProperties when publishing pacts ([64ab2ea](https://github.com/pact-foundation/pact-js-core/commit/64ab2ea110ea78315fb4609ad92a5fb90e96ddc7))
+
+
+### Fixes and Improvements
+
+* Add error messages to the ignored option debug logs ([8c8386d](https://github.com/pact-foundation/pact-js-core/commit/8c8386ddc356f279f3f7b3c503b403bf9f3b912a))
+
+## [13.10.0](https://github.com/pact-foundation/pact-js-core/compare/v13.9.1...v13.10.0) (2022-10-18)
+
+
+### Features
+
+* expose faiIfNoPactsFound on the VerifierOptions ([72eeb08](https://github.com/pact-foundation/pact-js-core/commit/72eeb08ab50f64364e5fba38d5d18a5b3e9e5489))
+
+
+### Fixes and Improvements
+
+* only set failIfNoPactsFound if set by user ([577e49f](https://github.com/pact-foundation/pact-js-core/commit/577e49f41927a48808005da1b7b317f0be9b9ad2))
+
 ### [13.9.1](https://github.com/pact-foundation/pact-js-core/compare/v13.9.0...v13.9.1) (2022-09-28)
 
 

package/README.md

@@ -55,12 +55,12 @@ In order to get better statistics as to who is using Pact, we have an anonymous
 
 ```json
 {
-	"name": "some-project",
-	...
-	"config": {
-		"pact_do_not_track": true
-	},
-	...
+ "name": "some-project",
+ ...
+ "config": {
+  "pact_do_not_track": true
+ },
+ ...
 }
 ```
 
@@ -87,7 +87,7 @@ Simply require the library and call the create function to start the mock servic
 var pact = require("@pact-foundation/pact-core");
 var server = pact.createServer({ port: 9999 });
 server.start().then(function() {
-	// Do your testing/development here
+ // Do your testing/development here
 });
 ```
 
@@ -97,7 +97,7 @@ Or if you're using Typescript instead of plain old Javascript
 import pact from "@pact-foundation/pact-core";
 const server = pact.createServer({ port: 9999 });
 server.start().then(() => {
-	// Do your testing/development here
+ // Do your testing/development here
 });
 ```
 
@@ -127,7 +127,7 @@ Mock servers are used by Pact to record interactions and create pact contracts.
 ```js
 var pact = require('@pact-foundation/pact-core');
 var server = pact.createServer({
-	...
+ ...
 });
 ```
 
@@ -138,7 +138,7 @@ var server = pact.createServer({
 | `port`              | false     | number                             | Port number that the server runs on, defaults to random available port                                                               |
 | `host`              | false     | string                             | Host on which to bind the server on, defaults to 'localhost'. Supports '0.0.0.0' to bind on all IPv4 addresses on the local machine. |
 | `log`               | false     | string                             | File to log output on relative to current working directory, defaults to none                                                        |
-| `logLevel`		  | false     | LogLevel (string)				   | Log level to pass to the pact core. One of "DEBUG", "ERROR", "WARN", "INFO" |
+| `logLevel`    | false     | LogLevel (string)       | Log level to pass to the pact core. One of "DEBUG", "ERROR", "WARN", "INFO" |
 | `ssl`               | false     | boolean                            | Create a self-signed SSL cert to run the server over HTTPS , defaults to `false`                                                     |
 | `sslcert`           | false     | string                             | Path to a custom self-signed SSL cert file, 'ssl' option must be set to true to use this option, defaults to none                    |
 | `sslkey`            | false     | string                             | Path a custom key and self-signed SSL cert key file, 'ssl' option must be set to true to use this, defaults to none                  |
@@ -178,10 +178,10 @@ Start the current server.
 ```js
 var pact = require("@pact-foundation/pact-core");
 pact.createServer()
-	.start()
-	.then(function() {
-		// Do something after it started
-	});
+ .start()
+ .then(function() {
+  // Do something after it started
+ });
 ```
 
 #### Stop a Mock server
@@ -191,10 +191,10 @@ Stop the current server.
 ```js
 var pact = require("@pact-foundation/pact-core");
 pact.createServer()
-	.stop()
-	.then(function() {
-		// Do something after it stopped
-	});
+ .stop()
+ .then(function() {
+  // Do something after it stopped
+ });
 ```
 
 #### Delete a Mock server
@@ -204,10 +204,10 @@ Stop the current server and deletes it from the list.
 ```js
 var pact = require("@pact-foundation/pact-core");
 pact.createServer()
-	.delete()
-	.then(function() {
-		// Do something after it was killed
-	});
+ .delete()
+ .then(function() {
+  // Do something after it was killed
+ });
 ```
 
 #### Check if a Mock server is running
@@ -225,13 +225,13 @@ There's 3 different events available, 'start', 'stop' and 'delete'. They can be
 var pact = require("@pact-foundation/pact-core");
 var server = pact.createServer();
 server.on("start", function() {
-	console.log("started");
+ console.log("started");
 });
 server.on("stop", function() {
-	console.log("stopped");
+ console.log("stopped");
 });
 server.on("delete", function() {
-	console.log("deleted");
+ console.log("deleted");
 });
 ```
 
@@ -243,7 +243,7 @@ Read more about [Verify Pacts](https://github.com/realestate-com-au/pact/wiki/Ve
 var pact = require('@pact-foundation/pact-core');
 
 pact.verifyPacts({
-	...
+ ...
 });
 ```
 
@@ -294,11 +294,11 @@ See the [Pact Broker documentation on selectors](https://docs.pact.io/pact_broke
 ```js
 var pact = require('@pact-foundation/pact-core');
 var opts = {
-	...
+ ...
 };
 
 pact.publishPacts(opts).then(function () {
-	// do something
+ // do something
 });
 ```
 
@@ -313,6 +313,8 @@ pact.publishPacts(opts).then(function () {
 | `pactBrokerPassword` | false     | string | Password for Pact Broker basic authentication. Optional             |
 | `pactBrokerToken`    | false     | string | Bearer token for Pact Broker authentication. Optional               |
 | `tags`               | false     | array  | An array of Strings to tag the Pacts being published. Optional      |
+| `branch`               | false     | string  | The branch to associate with the published pacts. Optional but recommended      |
+| `autoDetectVersionProperties`               | false     | boolean  | Automatically detect the repository branch from known CI environment variables or git CLI. Supports Buildkite, Circle CI, Travis CI, GitHub Actions, Jenkins, Hudson, AppVeyor, GitLab, CodeShip, Bitbucket and Azure DevOps. Optional      |
 | `buildUrl`           | false     | string | The build URL that created the pact. Optional                       |
 | `verbose`           |  false  | boolean | Enables verbose output for underlying pact binary. |
 
@@ -321,30 +323,30 @@ pact.publishPacts(opts).then(function () {
 ```js
 var pact = require('@pact-foundation/pact-core');
 var opts = {
-	...
+ ...
 };
 
 pact.canDeploy(opts)
-	.then(function (result) {
-		// You can deploy this
+ .then(function (result) {
+  // You can deploy this
     // If output is not specified or is json, result describes the result of the check.
     // If outout is 'table', it is the human readable string returned by the check
-	})
-	.catch(function(error) {
-		// You can't deploy this
+ })
+ .catch(function(error) {
+  // You can't deploy this
     // if output is not specified, or is json, error will be an object describing
     // the result of the check (if the check failed),
     // if output is 'table', then the error will be a string describing the output from the binary,
 
     // In both cases, `error` will be an Error object if something went wrong during the check.
-	});
+ });
 ```
 
 **Options**:
 
 | Parameter            | Required? | Type        | Description                                                                         |
 | -------------------- | --------- | ----------- | ----------------------------------------------------------------------------------- |
-| `pacticipants`       | true      | []objects	     | An array of version [selectors](docs.pact.io/selectors) in the form `{ name: String, latest?: string | boolean, version?: string }` |
+| `pacticipants`       | true      | []objects      | An array of version [selectors](docs.pact.io/selectors) in the form `{ name: String, latest?: string | boolean, version?: string }` |
 |                      |           |             | specify a tag, use the tagname with latest. Specify one of these per pacticipant    |
 |                      |           |             | that you want to deploy                                                             |
 | `pactBroker`         | true      | string      | URL of the Pact Broker to query about deployment. Required.                         |
@@ -368,7 +370,7 @@ The interface is comparable to the Mock Server API.
 ```js
 var pact = require('@pact-foundation/pact-core');
 var server = pact.createStub({
-	...
+ ...
 });
 ```
 
@@ -380,14 +382,13 @@ var server = pact.createStub({
 | port      | false     | number  | Port number that the server runs on, defaults to random available port                                                               |
 | host      | false     | string  | Host on which to bind the server on, defaults to 'localhost'. Supports '0.0.0.0' to bind on all IPv4 addresses on the local machine. |
 | log       | false     | string  | File to log output on relative to current working directory, defaults to none                                                        |
-| logLevel		  | false     | LogLevel (string)				   | Log level to pass to the pact core. One of "DEBUG", "ERROR", "WARN", "INFO" |
+| logLevel    | false     | LogLevel (string)       | Log level to pass to the pact core. One of "DEBUG", "ERROR", "WARN", "INFO" |
 | ssl       | false     | boolean | Create a self-signed SSL cert to run the server over HTTPS , defaults to 'false'                                                     |
 | sslcert   | false     | string  | Path to a custom self-signed SSL cert file, 'ssl' option must be set to true to use this option. Defaults false                      | to none |
 | sslkey    | false     | string  | Path a custom key and self-signed SSL cert key file, 'ssl' option must be set to true to use this option false. Defaults to none     |
 | cors      | false     | boolean | Allow CORS OPTION requests to be accepted, defaults to 'false'                                                                       |
 | timeout               | false     | number                             | How long to wait for the stub server to start up (in milliseconds). Defaults to 30000 (30 seconds)                                                      |
 
-
 ### Message Pacts
 
 #### Create Message Pacts
@@ -395,7 +396,7 @@ var server = pact.createStub({
 ```js
 var pact = require('@pact-foundation/pact-core');
 var message = pact.createMessage({
-	...
+ ...
 });
 ```
 
@@ -412,15 +413,15 @@ var message = pact.createMessage({
 
 ```js
 const messageFactory = messageFactory({
-	consumer: "consumer",
-	provider: "provider",
-	dir: dirname(`${__filename}/pacts`),
-	content: `{
-		"description": "a test mesage",
-		"content": {
-			"name": "Mary"
-		}
-	}`
+ consumer: "consumer",
+ provider: "provider",
+ dir: dirname(`${__filename}/pacts`),
+ content: `{
+  "description": "a test mesage",
+  "content": {
+   "name": "Mary"
+  }
+ }`
 });
 
 messageFactory.createMessage();
@@ -453,12 +454,12 @@ The verification between the latest version of Banana Service (1.0.0) and versio
 
 The following are the binaries currently made available:
 
-* `pact-mock-service`
-* `pact-broker`
-* `pact-stub-service`
-* `pact-message`
-* `pact-provider-verifier`
-* `pact`
+- `pact-mock-service`
+- `pact-broker`
+- `pact-stub-service`
+- `pact-message`
+- `pact-provider-verifier`
+- `pact`
 
 ## Windows Issues
 

package/build/Makefile

@@ -319,7 +319,7 @@ endif
 
 quiet_cmd_regen_makefile = ACTION Regenerating $@
 cmd_regen_makefile = cd $(srcdir); /opt/hostedtoolcache/node/12.22.12/x64/lib/node_modules/npm/node_modules/node-gyp/gyp/gyp_main.py -fmake --ignore-environment "-Dlibrary=shared_library" "-Dvisibility=default" "-Dnode_root_dir=/home/runner/.cache/node-gyp/12.22.12" "-Dnode_gyp_dir=/opt/hostedtoolcache/node/12.22.12/x64/lib/node_modules/npm/node_modules/node-gyp" "-Dnode_lib_file=/home/runner/.cache/node-gyp/12.22.12/<(target_arch)/node.lib" "-Dmodule_root_dir=/home/runner/work/pact-js-core/pact-js-core" "-Dnode_engine=v8" "--depth=." "-Goutput_dir=." "--generator-output=build" -I/home/runner/work/pact-js-core/pact-js-core/build/config.gypi -I/opt/hostedtoolcache/node/12.22.12/x64/lib/node_modules/npm/node_modules/node-gyp/addon.gypi -I/home/runner/.cache/node-gyp/12.22.12/include/node/common.gypi "--toplevel-dir=." binding.gyp
-Makefile: $(srcdir)/binding.gyp $(srcdir)/../../../.cache/node-gyp/12.22.12/include/node/common.gypi $(srcdir)/build/config.gypi $(srcdir)/../../../../../opt/hostedtoolcache/node/12.22.12/x64/lib/node_modules/npm/node_modules/node-gyp/addon.gypi
+Makefile: $(srcdir)/binding.gyp $(srcdir)/../../../.cache/node-gyp/12.22.12/include/node/common.gypi $(srcdir)/../../../../../opt/hostedtoolcache/node/12.22.12/x64/lib/node_modules/npm/node_modules/node-gyp/addon.gypi $(srcdir)/build/config.gypi
 	$(call do_cmd,regen_makefile)
 
 # "all" is a concatenation of the "all" targets from all the included

package/ffi/pact-cpp.h

@@ -2648,6 +2648,26 @@ void pactffi_verifier_set_provider_info(VerifierHandle *handle,
                                         unsigned short port,
                                         const char *path);
 
+/**
+ * Adds a new transport for the given provider. Passing a NULL for any field will
+ * use the default value for that field.
+ *
+ * For non-plugin based message interactions, set protocol to "message" and set scheme
+ * to an empty string or "https" if secure HTTP is required. Communication to the calling
+ * application will be over HTTP to the default provider hostname.
+ *
+ * # Safety
+ *
+ * All string fields must contain valid UTF-8. Invalid UTF-8
+ * will be replaced with U+FFFD REPLACEMENT CHARACTER.
+ *
+ */
+void pactffi_verifier_add_provider_transport(VerifierHandle *handle,
+                                             const char *protocol,
+                                             unsigned short port,
+                                             const char *path,
+                                             const char *scheme);
+
 /**
  * Set the filters for the Pact verifier.
  *

package/ffi/pact.h

@@ -2646,6 +2646,26 @@ void pactffi_verifier_set_provider_info(struct VerifierHandle *handle,
                                         unsigned short port,
                                         const char *path);
 
+/**
+ * Adds a new transport for the given provider. Passing a NULL for any field will
+ * use the default value for that field.
+ *
+ * For non-plugin based message interactions, set protocol to "message" and set scheme
+ * to an empty string or "https" if secure HTTP is required. Communication to the calling
+ * application will be over HTTP to the default provider hostname.
+ *
+ * # Safety
+ *
+ * All string fields must contain valid UTF-8. Invalid UTF-8
+ * will be replaced with U+FFFD REPLACEMENT CHARACTER.
+ *
+ */
+void pactffi_verifier_add_provider_transport(struct VerifierHandle *handle,
+                                             const char *protocol,
+                                             unsigned short port,
+                                             const char *path,
+                                             const char *scheme);
+
 /**
  * Set the filters for the Pact verifier.
  *

package/native/addon.cc

@@ -13,8 +13,10 @@ Napi::Object Init(Napi::Env env, Napi::Object exports) {
   exports.Set(Napi::String::New(env, "pactffiMockServerMatched"), Napi::Function::New(env, PactffiMockServerMatched));
   exports.Set(Napi::String::New(env, "pactffiMockServerMismatches"), Napi::Function::New(env, PactffiMockServerMismatches));
   exports.Set(Napi::String::New(env, "pactffiCreateMockServerForPact"), Napi::Function::New(env, PactffiCreateMockServerForPact));
+  exports.Set(Napi::String::New(env, "pactffiCreateMockServerForTransport"), Napi::Function::New(env, PactffiCreateMockServerForTransport));
   exports.Set(Napi::String::New(env, "pactffiCleanupMockServer"), Napi::Function::New(env, PactffiCleanupMockServer));
   exports.Set(Napi::String::New(env, "pactffiWritePactFile"), Napi::Function::New(env, PactffiWritePactFile));
+  exports.Set(Napi::String::New(env, "pactffiWritePactFileByPort"), Napi::Function::New(env, PactffiWritePactFileByPort));
   exports.Set(Napi::String::New(env, "pactffiNewPact"), Napi::Function::New(env, PactffiNewPact));
   exports.Set(Napi::String::New(env, "pactffiNewInteraction"), Napi::Function::New(env, PactffiNewInteraction));
   exports.Set(Napi::String::New(env, "pactffiUponReceiving"), Napi::Function::New(env, PactffiUponReceiving));
@@ -38,6 +40,7 @@ Napi::Object Init(Napi::Env env, Napi::Object exports) {
   // exports.Set(Napi::String::New(env, "pactffiWithMessagePactMetadata"), Napi::Function::New(env, PactffiWithMessagePactMetadata));
   exports.Set(Napi::String::New(env, "pactffiNewAsyncMessage"), Napi::Function::New(env, PactffiNewAsyncMessage));
   exports.Set(Napi::String::New(env, "pactffiNewSyncMessage"), Napi::Function::New(env, PactffiNewSyncMessage));
+  // exports.Set(Napi::String::New(env, "pactffiSyncMessageSetDescription"), Napi::Function::New(env, PactffiSyncMessageSetDescription));
   // exports.Set(Napi::String::New(env, "pactffiNewMessage"), Napi::Function::New(env, PactffiNewMessage));
   exports.Set(Napi::String::New(env, "pactffiMessageReify"), Napi::Function::New(env, PactffiMessageReify));
   exports.Set(Napi::String::New(env, "pactffiMessageGiven"), Napi::Function::New(env, PactffiMessageGiven));
@@ -57,13 +60,16 @@ Napi::Object Init(Napi::Env env, Napi::Object exports) {
   exports.Set(Napi::String::New(env, "pactffiVerifierSetFilterInfo"), Napi::Function::New(env, PactffiVerifierSetFilterInfo));
   exports.Set(Napi::String::New(env, "pactffiVerifierSetProviderState"), Napi::Function::New(env, PactffiVerifierSetProviderState));
   exports.Set(Napi::String::New(env, "pactffiVerifierSetConsumerFilters"), Napi::Function::New(env, PactffiVerifierSetConsumerFilters));
+  exports.Set(Napi::String::New(env, "pactffiVerifierSetFailIfNoPactsFound"), Napi::Function::New(env, PactffiVerifierSetFailIfNoPactsFound));
   exports.Set(Napi::String::New(env, "pactffiVerifierAddCustomHeader"), Napi::Function::New(env, PactffiVerifierAddCustomHeader));
   exports.Set(Napi::String::New(env, "pactffiVerifierAddFileSource"), Napi::Function::New(env, PactffiVerifierAddFileSource));
   exports.Set(Napi::String::New(env, "pactffiVerifierAddDirectorySource"), Napi::Function::New(env, PactffiVerifierAddDirectorySource));
   exports.Set(Napi::String::New(env, "pactffiVerifierUrlSource"), Napi::Function::New(env, PactffiVerifierUrlSource));
   exports.Set(Napi::String::New(env, "pactffiVerifierBrokerSourceWithSelectors"), Napi::Function::New(env, PactffiVerifierBrokerSourceWithSelectors));
+  exports.Set(Napi::String::New(env, "pactffiVerifierAddProviderTransport"), Napi::Function::New(env, PactffiVerifierAddProviderTransport));
+  exports.Set(Napi::String::New(env, "pactffiVerifierSetNoPactsIsError"), Napi::Function::New(env, PactffiVerifierSetNoPactsIsError));
 
   return exports;
 }
 
-NODE_API_MODULE(pact, Init)
+NODE_API_MODULE(pact, Init)