Consumer Compatibility Suite (V1) #468
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add two methods to the Pact Server which allow for the verification of interactions. By default, if there are any mismatches, the server will raise an exception on exit. It is possible to bypass this if the failures are expected (such as in unit testing). Signed-off-by: JP-Ellis <josh@jpellis.me>
I have debated whether to include a submodule or a subtree. Given that we purely want to use the compatibility suite as a reference and not modify it, I thought it best to used a submodule. A subtree provides better compatibility when the files need to subsequently be changed, but has the downside of being more difficult to update. Signed-off-by: JP-Ellis <josh@jpellis.me>
Signed-off-by: JP-Ellis <josh@jpellis.me>
TD002 is a rule pertaining to TODO items and enforces the assignment of an actor/owner for the task. As this is an open source project, I don't think this is particularly relevant, and it should hopefully suffice to have the URL of the related issue. Signed-off-by: JP-Ellis <josh@jpellis.me>
In order to more closely match the behaviour of the FFI, where the FFI allows a `NULL` pointer, the Python wrapper allows a `None` to be passed. This is change is also reflect in the methods of the user-facing Pact class. Signed-off-by: JP-Ellis <josh@jpellis.me>
To help ensure consistency with the `with_body`, I have renamed the `with_binary_file` to `with_binary_body`, as the former implies that it expects a path to a file, as opposed to some byte array. Signed-off-by: JP-Ellis <josh@jpellis.me>
Implement the compability test suite as defined in the V1 consumer feature file from the Pact Compability Suite. Signed-off-by: JP-Ellis <josh@jpellis.me> Signed-off-by: JP-Ellis <josh@jpellis.me>
A recent change to the `content_type` type uncovered an accidental error in the order of the arguments. Signed-off-by: JP-Ellis <josh@jpellis.me>
JP-Ellis
added
type:feature
As I have opted to use a submodule for the compatibility suite, it needs to be checked out explicitly when running tests. Signed-off-by: JP-Ellis <josh@jpellis.me>
|
LGTM |
mefellows
approved these changes
Nov 13, 2023
|
It should is pretty standard Python regex, with the main uncommon feature being the naming of groups using PS: I will look into what's going on with the failing tests tomorrow morning. |
|
Oh, I just meant it's kind of funky to read it in the descriptions that way. The |
|
Might be worth adding in the docs that to run these, one would have to pull in the submodules
|
|
Nice work, I had assumed we would be able to see the python code, for each feature file example, which is why I kept talking about potentially using these as examples of lib usage for a particular scenario but I like the way it has been designed. Great work |
YOU54F
approved these changes
Nov 13, 2023
|
cirrus-ci looks like they are failing due to not checking out submodules 👍🏾 |
There are two hatch scripts which call pytest, `hatch run test` and `hatch run example`. The scripts allow for additional arguments which get passed along to `pytest` with an optional default. This was misconfigured for the examples: \## Before `hatch run examples` becomes `pytest run examples/` `hatch run examples --broker-url=...` becomes `pytest run --broker-url=...` \## Now `hatch run examples` becomes `pytest run examples/` `hatch run examples --broker-url=...` becomes `pytest run examples/ --broker-url=...` Signed-off-by: JP-Ellis <josh@jpellis.me>
Signed-off-by: JP-Ellis <josh@jpellis.me>
With the addition of a git submodule for the compatibility suite, the contributing docs needed to be updated to ensure the additional step is documented. Signed-off-by: JP-Ellis <josh@jpellis.me>
In order to reduce the burden for new contributors, I have added a pytest fixture which checks that the submodule has been created. If it is not, it will try and run `git submodule init`. Signed-off-by: JP-Ellis <josh@jpellis.me>
Signed-off-by: JP-Ellis <josh@jpellis.me>
JP-Ellis
force-pushed
the
feat/consumer-compatibility-suite
branch
from
2de1197
to
5d16769
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Summary
This implements the first (of many) compatibility suite tests:
V1/http_consumer.feature.This PR focuses primarily on the compatibility suite, but also includes a few changes to the
v3module in order to implement features required for the compatibility suite, or bugs identified as a result of the compatibility suite.A couple of scenarios from the feature file have been disabled for now, pending on a resolution from upstream.
Note to the reviewer
As this PR includes a few changes to other parts of the codebase, it might be best to review the PR on a per-commit basis.
🚨 Breaking Changes
None related to the existing
v2module🔥 Motivation🔨 Test Plan
Compatibility suite is the test plan.
🔗 Related issues/PRs
v1/http_consumer.feature#473