pact-foundation/pact.io

Pact Foundation Website

README

pact.io home page

Where are the docs?

• Formal documentation is located at http://leap.mediumra.re/documentation/index.html - accessible from the Documentation link on most demo pages.
• You can find lists of the styled components at pages/components-leap.html and pages/components-bootstrap.html

Getting Set Up (optional)

Setup instructions are located in the docs mentioned above.

Node 14 is required Python 2 is required due to an old version of node-sass.

The short version:

• npm install
• $(npm bin)/gulp

MacOS

brew install pyenv
eval "$(pyenv init -)" # set in your profile (.zshrc / .bashrc etc)
pyenv install 2.7.18
pyenv shell 2.7.18
... npm commands above

pact.io's Issues

Extra Pact Matrix documentation

There's information in this blog post that should probably be distilled and added to the documentation:

http://rea.tech/enter-the-pact-matrix-or-how-to-decouple-the-release-cycles-of-your-microservices/

protobuf support

https://docs.pact.io/faq#what-is-pact-good-for does mentions Protobuf and talks about the questionable need for contract testing when a firm contract exists (protobuf definition) and the compatibility is ensured by the framework. I am wondering if there are any plans for Pact. Personally I believe that the nature of Protobuf (read: gRPC) solves only part of the problem - the backward/forward compatibility of the parser. I believe this is not enough. Consider this: the API goes through incremental changes and the implementations (on both side) may end up being wrong with their assumptions - while the contract is still followed! In Protobuf v3 (again, talking about gRPC) everything is optional. So, introducing a new field unknown to either party is transparent, yes, they won't touch what they do not know. However, fields will get obsolete and the consumer may decide no longer use field A because there is a field A1 that seems to be more appropriate. And the server internally assumes that both values A and A1 are mandatory. Or the server may decide that if the client sends A1, then it would be reading the response field B1 and won't look at B. In other words, protobuf "schema" is not strong and expressive enough to carry the contract enforcement deep enough (which is good, in fact) - so I do belive this scenario can and should be covered by contract tests.

I am not aware of any existing contract testing framework that supports gPRC. I am thinking about using Pact but I do not see a way other than introducing transparent transcoding between gRPC/HTTP2 and JSON/HTTP so Pact would operate in a traditional environment.

Unclear documentation.

Seeing a small issue in the first sentence of getting started specifically "you will need to and install the relevant". I'd correct it but I'm new to the framework and not sure how it should read.

May want to give the rest of the document a read through as well.

generate PACT file through other way rather than writing unit test?

In some case, we would like to generate hundreds of pact file but not enough resources to implement that, Is there a way to generate Pact file easily rather than write unit test?

Add ability to customize contract filename

The contract JSON file that's generated from the consumer pact test is named in the following format by default: "{consumer_name}-{provider_name}". It would be great to have the ability to customize the name of this file. For example, I'd like to follow the following format for the project I'm working on: "{version}-{platform}-{method}" or some other format that isn't necessarily tied to the name that I specify for the consumer and provider in the contract test.

[Bugs] Site Formatting Issues?

Duplicate Introduction

Sidebar has a duplicated title, when it should be something else.

Update JS documentation

Documentation is for < 1.0.0 version, needs to be updated for latest.

Create Pact Python workshop

Create Python version of https://github.com/DiUS/pact-workshop-jvm

Problem understanding example in 5-min-guide.

Where do the values orderProperties and itemProperties come from in here.

What is the difference between Contract driven testing and behavior driven testing?

I have read some of the documents in the pact.io. I cannot differentiate the CDT and the BDD.
The contract testing seems like giving some request and verifying the response.
So what are the differences between CDT and BDD?

Add workshops to website

Add workshops to the website, as a 'getting started' section for each language:

• https://github.com/DiUS/pact-workshop-jvm
• https://github.com/DiUS/pact-workshop-android
• https://github.com/DiUS/pact-workshop-ruby-v2

Add pact+swagger info

Rename documentation branch

The documentation branch is currently called test. A more helpful name would be documentation or gitbook, or similar.

Create Pact Go workshop

Create go version of https://github.com/DiUS/pact-workshop-jvm

When sharing from the browser on iOS, pactflow.io is shared

Sharing from the share button () in Safari or Chrome on iOS results in sharing pactflow.io (https://pactflow.io/).

This is because the shared URL also becomes pactflow.io, specified by rel="canonical".

pact.io/pages/index.html

Line 20 in d4523e1

<link rel="canonical" href="https://pactflow.io" />

Getting started guides aren't very user friendly

Pact.io directs new users to the Readme pages of the various pact implementations. It would be an improvement to have step-by-step guides for getting started.

gists linked to in pact.io/best_practices/provider.md are invalid

I was viewing pact.io/best_practices/provider.md and I tried to view the two gists linked to from that page. They both failed with "Secure Connection Failed". They are actually both links to the same page.

The gist link is https://gist.github.com/bethesque/43eef1bf47afea4445c8b8bdebf28df0 .

Update gitbook with information about verifications

Link the broker wiki (and other main documentation) from the header bar

In the new version of GitBook, we can add header links:

https://docs.gitbook.com/content-editing/customization#add-header-links

It'd be good to use this as a place to bring together the main documentation entry points for Pact.

This definitely includes the Broker wiki - I'm not sure what else.

[Question] About the last several questions of FAQ section

Hi there,

I am translating the pact documents to Chinese version with @wldandan. But in the FAQ section, about the last several questions from here, I can not find the source text either in gitbook branch or master branch of this repo. The repo only contains those questions before this question I mentioned. Could you help find out where are the sources of the docs.pact.io site ? Thanks.

Chinese version of docs.pact.io announced to release!

Hi all,

We're Cloud Native User Group from China, members consist of @tongzh, @wldandan, @iambowen and @lzufengye. We're glad to announce that the first Chinese translated version of docs.pact.io is released at www.pact.net.cn ! All the contents of this site adhere strictly to the original documents published.
And the next thing to do may be to interchange the links to each other on both the docs.pact.io and www.pact.net.cn. What kind of formats do you prefer to do that? Please let me know if there're suggestions. Thanks! :)

Have Pact on stackshare.io

Would be nice to be able to have Pact in my stack on stackshare.io 😁

We can submit the tool at https://stackshare.io/submit.

Create Pact JS Workshop

Create JS version of https://github.com/DiUS/pact-workshop-jvm

Brainstorming on what to add to the docs

Please put one point per comment, so we can use upvote counts to get an indication of what people are most interested in.

Fix missing link on "How Pact Works"

Pact tests should be data independent. Pact tests are best when successful verification doesn’t depend on the specific data that the provider returns. See this guide for best practices when describing interactions.

The link for the bold sentence above is not present on https://docs.pact.io/how_pact_works

Travis build fails on documentation branch

When the documentation branch (currently called test) builds on travis, it fails because there's no Rake file.

It would be better if the build for the documentation branch provided information about whether the documentation built successfully.

The repl for the 'Run the provider tests' step in the 5 minute guide is broken.

Great work on the documentation and 5 minute guide.

The repl for the final scenario ('Run the provider tests') step is broken. It doesn't seem to be able to retrieive the files.

https://repl.it/@mefellows/docspactio-getting-started-provider

Diagram CI/CD infrastructure

How best to setup the CI/CD infrastructure is a common question. We could more easily answer these with a diagram or two in the documentation.

Where is this gist url?

Excuse me, where is the url of this gist mentioned in Why Pact may not be the best tool for testing pass through APIs? :

Check out this gist for an example of how to use the Pact contract generation and matching code to test non-HTTP communications.

Merge broker documentation into pact.io?

The pact.io documentation should probably include the documentation that's currently in the Broker Wiki, so that documentation is all in one place

Update Pact Go documentation

Usage documentation out of date with repository.

default branch set to documentation but this is state, default branch is now master

as title, we should probably change the default branch but note it may have unintended consequences

About the interchanged link

Hi @mefellows ,

As the Chinese version of the pact documents has been published, we have put a link button to the English version of documents site on the top of Chinese site. Can you also please put a link button to the Chinese site on the top of English site as well ? That'll be fine for Chinese developers to find the entry of Chinese site.
A recommended way to implement that is to add a toolbar-button plugin to gitbook, which means you can put the following config into book.json file:

{
    "plugins": [
        "toolbar-button"
    ],
    "pluginsConfig": {
        "toolbar-button": {
            "icon": "fa-globe",
            "label": "中",
            "url": "https://www.pact.net.cn"
        }
    }
}

Thanks in advance! If there're any other ideas of how to do that, please let me know.