Skip to content

MPT-22111 Add MPT pytest fixtures shared library #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
d3rky wants to merge 1 commit into
base: main
Choose a base branch
from
+1,471 −1
Open

MPT-22111 Add MPT pytest fixtures shared library #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Python import: mpt_extension_contrib.<module_with_underscores>

- [`shared/`](shared): internal reusable code exposed as `mpt_extension_contrib.shared`
(distribution `mpt-extension-contrib-shared`).
- [`fixtures/`](fixtures): public package exposed as `mpt_extension_contrib.fixtures` (distribution `mpt-extension-contrib-fixtures`).
- [`custom-notifications/`](custom-notifications): public package exposed as `mpt_extension_contrib.custom_notifications` (distribution `mpt-extension-contrib-custom-notifications`).
- [`due-date/`](due-date): public package exposed as `mpt_extension_contrib.due_date` (distribution `mpt-extension-contrib-due-date`).

Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ of them share the `mpt_extension_contrib` namespace.
| Directory | Distribution | Python import | Visibility |
| --- | --- | --- | --- |
| `shared/` | `mpt-extension-contrib-shared` | `mpt_extension_contrib.shared` | internal |
| `fixtures/` | `mpt-extension-contrib-fixtures` | `mpt_extension_contrib.fixtures` | public |
| `custom-notifications/` | `mpt-extension-contrib-custom-notifications` | `mpt_extension_contrib.custom_notifications` | public |
| `due-date/` | `mpt-extension-contrib-due-date` | `mpt_extension_contrib.due_date` | public |

Expand Down
4 changes: 4 additions & 0 deletions fixtures/.copier-answers.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Managed by Copier — do not edit by hand. Run `copier update` to refresh.
_src_path: /workspace/scripts/templates/module

@coderabbitai coderabbitai Bot Jul 1, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🌐 Web query:

copier _src_path should be relative to project root

💡 Result:

In Copier, the _src_path key stored in the.copier-answers.yml file records the source of the template used to generate or update a project [1][2][3]. It is important to clarify the distinction between _src_path and settings that require paths relative to the project root: 1. The _src_path in.copier-answers.yml: This value represents the template source (which may be a local path or a remote VCS URL) [4][5][1]. It is not strictly forced to be relative to the project root; however, community discussions have highlighted that storing it as a path relative to the current working directory (as Copier sometimes does) can make it difficult to run updates from different locations [6]. 2. Configuration Settings: Certain Copier configuration settings, such as answers_file, must be defined relative to the project root [7][8]. According to the official documentation, the answers_file path must be relative to the project root because it must be accessible at render time and must exist within the version-controlled repository to support project updates [7]. If you are encountering issues where _src_path is not being resolved correctly during updates, it is often because Copier relies on this value to locate the template, and if it was saved as a relative path from a specific directory, it may not be valid if the update command is executed from a different directory [6]. The _src_path is intended to be a persistent reference to the template, and while it is stored in the answers file, it is primarily managed by Copier rather than manually configured by the user [4][1].

Citations:

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "== file =="
cat -n fixtures/.copier-answers.yml

echo
echo "== search for copier mentions =="
rg -n "_src_path|copier-answers|copier" -S . || true

echo
echo "== repo files around fixture/docs =="
fd -HI -t f 'copier' . || true

Repository: softwareone-platform/mpt-extension-python-contrib

Length of output: 2270

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "== template =="
cat -n scripts/templates/module/copier.yml

echo
echo "== answers files =="
for f in custom-notifications/.copier-answers.yml due-date/.copier-answers.yml fixtures/.copier-answers.yml; do
  echo "--- $f ---"
  cat -n "$f"
done

Repository: softwareone-platform/mpt-extension-python-contrib

Length of output: 1608

🌐 Web query:

Copier _src_path answers file absolute local path update behavior

💡 Result:

In Copier, the _src_path key in the.copier-answers.yml file tracks the location of the template used to generate or last update a project [1][2]. Its behavior regarding paths is as follows: 1. Storage Behavior: Copier typically stores _src_path as it was provided during the initial copy operation [3]. If a relative path is provided, it is stored as a relative path; if an absolute path is provided, it is stored as an absolute path [3]. Note that relative paths are often resolved relative to the current working directory from which the command was executed, which can lead to issues if subsequent updates are run from a different directory [3]. 2. Update Behavior: When you run copier update, Copier relies on the _src_path stored in the answers file to locate the template [1][4]. If the path is relative, Copier will attempt to resolve it based on the directory where the update command is being executed [3]. Because this behavior can be brittle, users are cautioned against manually editing the.copier-answers.yml file [5][6]. Doing so can confuse Copier’s update logic, as the tool uses the stored _src_path and _commit keys to determine how to apply changes while preserving local modifications [5][7]. 3. Recommendations: To ensure reliable updates, it is generally best practice to avoid manual manipulation of _src_path [5]. If the template location changes or the relative path resolution fails, you may need to use copier recopy, which reapplies the template while keeping your existing answers, effectively bypassing the smart diff algorithm that relies on the historical template path and commit [5][8]. In summary, Copier does not automatically normalize _src_path to an absolute local path. It persists the path as originally specified, and the reliability of future updates depends on that path remaining valid relative to where the copier update command is invoked [3][1].

Citations:

Replace the committed _src_path with a repo-relative template path

fixtures/.copier-answers.yml hardcodes /workspace/scripts/templates/module, which ties future Copier updates to one checkout location. Use a repo-relative source path so the answers file stays portable across machines.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@fixtures/.copier-answers.yml` at line 2, The committed _src_path value is
hardcoded to a machine-specific absolute path, so update the Copier answers
entry to use a repo-relative template path instead. Change the _src_path setting
in fixtures/.copier-answers.yml to point to the template location relative to
the repository root, keeping the file portable across checkouts and matching the
expected Copier configuration.

module: fixtures

29 changes: 29 additions & 0 deletions fixtures/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# AGENTS.md

This module is the `fixtures` contrib package.

Read in this order:

1. [README.md](README.md) for the module purpose.
2. [docs/usage.md](docs/usage.md) for installing and using the module.
3. [docs/architecture.md](docs/architecture.md) for the public API boundary.
4. [docs/technical-design-review.md](docs/technical-design-review.md) for the problems, requirements, and how they map to usage.
5. [docs/contributing.md](docs/contributing.md) before changing this module.
6. [docs/testing.md](docs/testing.md) before changing tests.
7. [docs/releases.md](docs/releases.md) before releasing this module.
8. [../AGENTS.md](../AGENTS.md) for repository-wide rules and validation commands.

Operational guidance:

- Public API is re-exported from the package root (`mpt_extension_contrib.fixtures`)
via a lazy PEP 562 `__getattr__`; implementation lives in the `factories`,
`parameters`, `scenarios`, and `errors` submodules.
- Factories build structurally valid SDK models with empty parameters only — no
product-specific parameter values or business logic.
- Resolve implementation lazily in `__init__.py` and `plugin.py` (the `pytest11`
entry point) so startup registration stays measurable by coverage. See
[docs/architecture.md](docs/architecture.md) for the coverage rationale and the
scoped lint ignores it requires.
- Test the plugin with the `pytester` fixture; unit-test each helper directly.
- Add tests under [`tests/`](tests) for every behavior change.
- Run `make check-all pkg=fixtures` from the repository root while iterating.
201 changes: 201 additions & 0 deletions fixtures/LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
20 changes: 20 additions & 0 deletions fixtures/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# mpt-extension-contrib-fixtures

Pytest fixtures and [polyfactory](https://polyfactory.litestar.dev/) factories
for MPT-shaped objects (orders, agreements, subscriptions). Factories build
structurally valid SDK models with empty parameters; the product-specific
parameter catalog stays in the consumer.

Installing the package registers a pytest plugin (`pytest11` entry point), so
its fixtures are available without any `conftest.py` wiring.

See [AGENTS.md](AGENTS.md) for the module documentation map.

## Documentation

- [Usage](docs/usage.md)
- [Architecture](docs/architecture.md)
- [Technical Design Review](docs/technical-design-review.md)
- [Contributing](docs/contributing.md)
- [Testing](docs/testing.md)
- [Releases](docs/releases.md)
Comment on lines +15 to +20

@svazquezco svazquezco Jul 1, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Relative links work on Github but will be broken on pypi. We should add them to the readme property in pyproject.toml files or use absolute urls

Loading