Open JP-Ellis opened 9 months ago
👋 Hi! The 'smartbear-supported' label has just been added to this issue, which will create an internal tracking ticket in PactFlow's Jira (PACT-1353). We will use this to prioritise and assign a team member to this task. All activity will be public on this ticket. For now, sit tight and we'll update this ticket once we have more information on the next steps.
See our documentation for more information.
This issue has been linked to a Canny post: Pact V3 Specification for Python :tada:
:memo: Background
Pact Python at present makes use of the Ruby executables. The main functionality of the Ruby executables has been replaced by a core library written in Rust (pact-foundation/pact-reference). This library exposes a foreign function interface which other languages can leverage without the need to re-implement a lot of the logic. The core library helps to maintain parity across the different clients and helps with the adoption of new features.
:arrow_heading_up: Migration Plan
This change will introduce some breaking changes where needed, but it will be done in a staged manner to give everyone the opportunity to migrate.
:construction: Stage 1 (from
v2.2
)pact.v3
and can be used alongside the existing library. During this stage, no guarantees are made about the stability of thepact.v3
module.PendingDeprecationWarning
warnings when it is used (if these warnings are enabled).:hammer_and_wrench: Stage 2 (from
v2.3
, tbc)pact.v3
is considered generally stable and users are encouraged to start migrating to it.DeprecationWarning
warnings when it is used to help raise awareness of the upcoming change.:rocket: Stage 3 (from
v3
)pact.v3
module is renamed topact
pact.v3
should be able to do as/pact.v3/pact/
and have everything work.pact.v2
scope.v2
of Pact Python will not work againstv3
of Pact Python.v2
library will need to update their code to use the newpact.v2
module. As/pact/pact.v2/
should be sufficient.pact.v2
module will be considered deprecated, and will eventually be removed in a future release. No new features and only critical bug fixes will be made to this part of the library.✅ Tasks
v3/message_consumer.feature
v4/message_consumer.feature
v3/message_provider.feature
v4/message_provider.feature
v3/http_matching.feature
v3/http_generators.feature
v3/generators.feature
v4/generators.feature
v3/matching_rules.feature
v4/matching_rules.feature
v4/synchronous_message_consumer.feature
v4/v4.feature
pact.v3
, releasev2.3
of Pact PythonPendingDeprecationWarning
withDeprecationWarning
v3
of Pact Pythonv3
🔗 Prior/Related Work
This change has been a long time coming:
357
366
367
These PRs are all quite large, especially the last with 177 commits and 6.7k lines added. These PRs form the prior attempts to migrate Pact Python to make use of Rust library. While I would have loved to take #367 on and add to it, I think there's too much in there for a single PR.
Having said that, a lot of the work done will be re-used in the tasks above.
234
Migrating away from the Ruby executable will resolve this issue.
243
Supplanted by this issue
245
265
Additional (and very early) PRs with some work on implementing the FFI.
88
A very early issue detailing the need to implement the FFI core.