chore(v3)!: make util module private #884
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #884 +/- ##
===================================
Coverage 78% 78%
===================================
Files 30 30
Lines 3365 3373 +8
===================================
+ Hits 2634 2642 +8
Misses 731 731
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Within the `pact.v3.util` module, a _find_free_port utility has been
added. It is used within tests, and more importantly, it is used to find
a free port for the Pact server.
As part of this change, "find a port for me" option is denoted using
`None` as opposed to `0`. The value of 0 will still allocate a random
port, though this is done using the Pact Core Library as opposed to the
higher leve Python library.
This should _not_ be a breaking change for anyone as:
1. If someone explicitly used the default value of `0`, the behaviour
remains unchanged (that is, port is allocated by the Pact Core
library).
2. If the default is implicitly provided, a random port is still being
allocated, albeit now by the Python library as opposed to the Rust
core library.
Signed-off-by: JP-Ellis <josh@jpellis.me>
The `pact.v3.util` module was created as a public module, but serves no
purpose to end-users of Pact Python. This commit renames it and marks it
as private.
If anyone was relying on functions from this module, they are still
accessible within the (now private) `pact.v3._util` module.
BREAKING CHANGE: `pact.v3.util` has been renamed to `pact.v3._util` and
is now private.
Signed-off-by: JP-Ellis <josh@jpellis.me>
JP-Ellis
force-pushed
the
chore/util-refactor
branch
from
fe609b9
to
ccad5fc
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
The
pact.v3.utilmodule contains useful utility functions used internally, but otherwise should not be used by Pact Python end-users. As a result, I am making it private now.🚨 Breaking Changes
pact.v3.utilis renamed topact.v3._utilFurthermore, as
pact.v3._utilis now a private module, breaking changes to private functions will not be considered breaking changes to the Pact Python library.🔥 Motivation
Simplify the ongoing maintenance of the utility functions without burdening ourselves with backward compatibility.
🔨 Test Plan
Regular CI
🔗 Related issues/PRs
None