MPT-22108 add phase-step provisioning-phase gating library

.github/CODEOWNERS

@@ -7,3 +7,4 @@
 /custom-notifications/ @softwareone-platform/sirius
 /order-status/ @softwareone-platform/sirius
 /reports/ @softwareone-platform/sirius
+/phase-step/ @softwareone-platform/sirius

AGENTS.md

@@ -39,6 +39,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`).
 - [`order-status/`](order-status): public package exposed as `mpt_extension_contrib.order_status` (distribution `mpt-extension-contrib-order-status`).
+- [`phase-step/`](phase-step): public package exposed as `mpt_extension_contrib.phase_step` (distribution `mpt-extension-contrib-phase-step`).
 - [`custom-notifications/`](custom-notifications): public package exposed as `mpt_extension_contrib.custom_notifications` (distribution `mpt-extension-contrib-custom-notifications`).
 - [`reports/`](reports): public package exposed as `mpt_extension_contrib.reports` (distribution `mpt-extension-contrib-reports`).
 - [`due-date/`](due-date): public package exposed as `mpt_extension_contrib.due_date` (distribution `mpt-extension-contrib-due-date`).

README.md

@@ -13,6 +13,7 @@ of them share the `mpt_extension_contrib` namespace.
 | --- | --- | --- | --- |
 | `shared/` | `mpt-extension-contrib-shared` | `mpt_extension_contrib.shared` | internal |
 | `order-status/` | `mpt-extension-contrib-order-status` | `mpt_extension_contrib.order_status` | public |
+| `phase-step/` | `mpt-extension-contrib-phase-step` | `mpt_extension_contrib.phase_step` | public |
 | `custom-notifications/` | `mpt-extension-contrib-custom-notifications` | `mpt_extension_contrib.custom_notifications` | public |
 | `reports/` | `mpt-extension-contrib-reports` | `mpt_extension_contrib.reports` | public |
 | `due-date/` | `mpt-extension-contrib-due-date` | `mpt_extension_contrib.due_date` | public |

make/common.mk

@@ -2,7 +2,7 @@ DC = docker compose -f compose.yaml
 RUN = $(DC) run --rm app
 RUN_IT = $(DC) run --rm -it app
 
-PACKAGES := shared order-status custom-notifications reports due-date
+PACKAGES := shared order-status phase-step custom-notifications reports due-date
 TARGETS := $(if $(pkg),$(pkg),$(PACKAGES))
 LINT_TARGETS := $(if $(pkg),$(pkg),$(PACKAGES) tests scripts)
 TYPE_TARGETS := $(if $(pkg),$(pkg),$(PACKAGES) scripts)

phase-step/.copier-answers.yml

@@ -0,0 +1,4 @@
+# Managed by Copier — do not edit by hand. Run `copier update` to refresh.
+_src_path: /workspace/scripts/templates/module
+module: phase-step
+

phase-step/AGENTS.md

@@ -0,0 +1,21 @@
+# AGENTS.md
+
+This module is the `phase-step` 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/contributing.md](docs/contributing.md) before changing this module.
+5. [docs/testing.md](docs/testing.md) before changing tests.
+6. [docs/releases.md](docs/releases.md) before releasing this module.
+7. [../AGENTS.md](../AGENTS.md) for repository-wide rules and validation commands.
+
+Operational guidance:
+
+- Keep the public API under `mpt_extension_contrib.phase_step`.
+- Keep the library free of product-specific phase values and parameter ids;
+  they come from the extension via `PhaseStepSettings`.
+- Add tests under [`tests/`](tests) for every behavior change.
+- Run `make check-all pkg=phase-step` from the repository root while iterating.

phase-step/LICENSE

@@ -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.

phase-step/README.md

@@ -0,0 +1,108 @@
+# mpt-extension-contrib-phase-step
+
+Shared **provisioning-phase gating** for SoftwareONE MPT extensions built on the
+Extension SDK. A step declares the single provisioning phase it runs for; when
+the order's phase parameter holds a different value the step is skipped and the
+pipeline records the skip, instead of the step deciding to no-op inside its own
+body.
+
+It replaces ad-hoc phase checks inside individual extension steps with one
+reusable gating mechanism shared across pipelines.
+
+See [AGENTS.md](AGENTS.md) for the module documentation map.
+
+## Install
+
+```bash
+pip install mpt-extension-contrib-phase-step
+```
+
+Requires the Extension SDK (`mpt-extension-sdk >= 6.3, < 7`), which is pulled in as a
+dependency.
+
+## Public API
+
+`mpt_extension_contrib.phase_step` exposes a base step, two functions, and one
+settings contract:
+
+| Object | Purpose |
+| --- | --- |
+| `PhaseGatedStep(expected_phases)` | Base step that runs only when the order phase is one of `expected_phases` (a phase or a list of phases); subclass and implement `process()`. |
+| `require_phase(context, expected_phases)` | Guard for a hand-written `pre()`: skip the step unless the phase is one of `expected_phases`. |
+| `advance_phase(context, phase)` | Persist a new phase on the order (and refresh the context) to move the flow forward; call it from `process()`. |
+| `PhaseStepSettings` | `Protocol` describing the settings the API reads. |
+
+## Design in one line
+
+The SDK already skips a step when its `pre()` raises `SkipStepError` (the
+pipeline logs the skip and continues). This library adds only the missing
+convention — read the phase parameter, compare, raise — as a function and a
+thin base step, and keeps phase values and the parameter id out of the library.
+No decorators or wrappers: gating is expressed by subclassing and, when needed,
+an explicit `await super().pre(context)`.
+
+## Usage
+
+Expose the phase parameter external id in the extension settings:
+
+```python
+from dataclasses import dataclass
+from typing import Self, override
+
+from mpt_extension_sdk.settings.extension import BaseExtensionSettings
+
+from mpt_extension_contrib.phase_step import PhaseStepSettings
+
+
+@dataclass(frozen=True)
+class ExtensionSettings(BaseExtensionSettings, PhaseStepSettings):
+    phase_parameter: str = "phase"
+
+    @override
+    @classmethod
+    def load(cls) -> Self:
+        return cls()
+```
+
+Seed the phase before the first gated step: `PhaseGatedStep.pre()` runs before
+`process()`, so a first step with an unset phase would skip before it could
+initialize it. Set an initial value via a product default or an ungated
+initializer step.
+
+Gate a step by subclassing `PhaseGatedStep` and binding the phase when the
+pipeline is composed:
+
+```python
+from typing import override
+
+from mpt_extension_sdk.pipeline import BasePipeline, BaseStep, OrderContext
+
+from mpt_extension_contrib.phase_step import PhaseGatedStep
+
+
+class CreateSubscription(PhaseGatedStep):
+    @override
+    async def process(self, context: OrderContext) -> None:
+        # runs only while the phase parameter equals the bound value
+        ...
+
+
+class PurchasePipeline(BasePipeline):
+    @property
+    def steps(self) -> list[BaseStep]:
+        return [
+            CreateSubscription("createSubscription"),
+            # ... more phase-gated steps ...
+        ]
+```
+
+See [Usage](docs/usage.md) for a step that adds its own `pre()` guard and for
+advancing the phase.
+
+## Documentation
+
+- [Usage](docs/usage.md) — install, configure, gate steps, advance the phase
+- [Architecture](docs/architecture.md)
+- [Contributing](docs/contributing.md)
+- [Testing](docs/testing.md)
+- [Releases](docs/releases.md)