executable-stories-pytest 0.1.0__tar.gz → 0.1.1__tar.gz

executable_stories_pytest-0.1.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

executable_stories_pytest-0.1.1/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: executable-stories-pytest
+Version: 0.1.1
+Summary: pytest plugin for executable-stories BDD documentation
+Author: Jag Reehal
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/jagreehal/executable-stories
+Project-URL: Repository, https://github.com/jagreehal/executable-stories.git
+Project-URL: Documentation, https://github.com/jagreehal/executable-stories#readme
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: otel
+Requires-Dist: opentelemetry-api>=1.20; extra == "otel"
+Provides-Extra: dev
+Requires-Dist: ruff>=0.6.0; extra == "dev"
+Requires-Dist: mypy>=1.5.0; extra == "dev"
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Dynamic: license-file
+
+# executable-stories-pytest
+
+pytest plugin for executable-stories.
+
+Adds BDD-style story helpers and emits raw story run JSON so pytest tests can be rendered into executable documentation.
+
+## Install
+
+```bash
+pip install executable-stories-pytest
+```
+
+The PyPI distribution name is `executable-stories-pytest`, but the import name is `executable_stories`:
+
+```python
+from executable_stories import story
+```
+
+## Usage
+
+```python
+from executable_stories import story
+
+
+def test_login_success():
+    story.init("User logs in", tags=["auth", "smoke"])
+    story.given("a registered user")
+    story.when("they submit valid credentials")
+    story.then("they see the dashboard")
+```
+
+## Features
+
+- BDD steps: `given`, `when`, `then`, `and_`, `but`
+- Aliases: `arrange`, `act`, `assert_`, `setup`, `context`, `execute`, `action`, `verify`
+- Rich docs: `note`, `tag`, `kv`, `json`, `code`, `table`, `link`, `section`, `mermaid`, `screenshot`, `video`, `html`, `state`, `custom`
+- `story.state(value, label=None)` — JSON-serializable snapshot of "what the world looks like" at this step (a storyboard frame); consecutive same-label states are diffed at render time
+- Feature declarations: `story.feature(...)` at module level heads every scenario in the file
+- Planned scenarios: `story.planned("…")` records behaviour that is specified but not built
+- Source coverage links: `covers=[...]` in `story.init(...)`
+- Step timing: `start_timer` / `end_timer`
+- Attachments: `attach(...)`
+- OTel spans + trace links: `attach_spans(...)`, `trace_url_template` in `story.init(...)`, `OTEL_TRACE_URL_TEMPLATE`
+
+## Output
+
+The plugin writes `.executable-stories/raw-run.json` under pytest's root directory when the
+session finishes. Set `EXECUTABLE_STORIES_OUTPUT` to move it: a relative path is resolved
+against the project root, an absolute one is used as given. The file is renamed into place,
+so a reader never sees a half-written run.
+
+Formatting the raw run updates one canonical report per source file under `reports/by-file/`.
+Each run says what it reached so those reports stay honest as tests come and go:
+
+- `coveredSourceFiles` — every file the run executed a test in, whether or not it produced a
+  story, so deleting a file's last scenario retires it
+- `incompleteSourceFiles` — files the run cannot speak for: a skipped test, a broken fixture
+  or teardown, a module that failed to import, or a test that failed before `story.init`
+- `runScope` — `"filtered"` for `-k`, `-m`, `--deselect`, `--last-failed`, a `file.py::test`
+  node id, or a run that ended early (`-x`, `--maxfail`, Ctrl-C, an internal or usage
+  error); otherwise `"full"`
+- `gitSha` and `packageVersion` — which commit the run describes, and what produced it
+
+Source paths are relative to the project root, so a report keeps its identity across machines
+and CI.
+
+pytest exposes no assertion counter. Use `story.expect("claim", callable)` to declare
+assertion evidence. A plain `story.then()` followed by Python `assert` remains unobserved,
+not zero.
+
+Pass that file to the `executable-stories` CLI (from the `executable-stories-formatters` package) to render reports:
+
+```bash
+npx --package executable-stories-formatters executable-stories format .executable-stories/raw-run.json --format html
+
+# The path is optional — `format` defaults to .executable-stories/raw-run.json
+npx --package executable-stories-formatters executable-stories format --format html
+
+# Diagnose the run JSON if a report won't generate (schema drift, empty run)
+npx --package executable-stories-formatters executable-stories doctor
+```
+
+Supported formats include `html`, `markdown`, `junit`, and the Cucumber outputs. Use `--output-dir` to choose where reports are written.
+
+## Verify
+
+From repo root:
+
+```bash
+pnpm run verify:pytest
+```

executable_stories_pytest-0.1.1/README.md

@@ -0,0 +1,91 @@
+# executable-stories-pytest
+
+pytest plugin for executable-stories.
+
+Adds BDD-style story helpers and emits raw story run JSON so pytest tests can be rendered into executable documentation.
+
+## Install
+
+```bash
+pip install executable-stories-pytest
+```
+
+The PyPI distribution name is `executable-stories-pytest`, but the import name is `executable_stories`:
+
+```python
+from executable_stories import story
+```
+
+## Usage
+
+```python
+from executable_stories import story
+
+
+def test_login_success():
+    story.init("User logs in", tags=["auth", "smoke"])
+    story.given("a registered user")
+    story.when("they submit valid credentials")
+    story.then("they see the dashboard")
+```
+
+## Features
+
+- BDD steps: `given`, `when`, `then`, `and_`, `but`
+- Aliases: `arrange`, `act`, `assert_`, `setup`, `context`, `execute`, `action`, `verify`
+- Rich docs: `note`, `tag`, `kv`, `json`, `code`, `table`, `link`, `section`, `mermaid`, `screenshot`, `video`, `html`, `state`, `custom`
+- `story.state(value, label=None)` — JSON-serializable snapshot of "what the world looks like" at this step (a storyboard frame); consecutive same-label states are diffed at render time
+- Feature declarations: `story.feature(...)` at module level heads every scenario in the file
+- Planned scenarios: `story.planned("…")` records behaviour that is specified but not built
+- Source coverage links: `covers=[...]` in `story.init(...)`
+- Step timing: `start_timer` / `end_timer`
+- Attachments: `attach(...)`
+- OTel spans + trace links: `attach_spans(...)`, `trace_url_template` in `story.init(...)`, `OTEL_TRACE_URL_TEMPLATE`
+
+## Output
+
+The plugin writes `.executable-stories/raw-run.json` under pytest's root directory when the
+session finishes. Set `EXECUTABLE_STORIES_OUTPUT` to move it: a relative path is resolved
+against the project root, an absolute one is used as given. The file is renamed into place,
+so a reader never sees a half-written run.
+
+Formatting the raw run updates one canonical report per source file under `reports/by-file/`.
+Each run says what it reached so those reports stay honest as tests come and go:
+
+- `coveredSourceFiles` — every file the run executed a test in, whether or not it produced a
+  story, so deleting a file's last scenario retires it
+- `incompleteSourceFiles` — files the run cannot speak for: a skipped test, a broken fixture
+  or teardown, a module that failed to import, or a test that failed before `story.init`
+- `runScope` — `"filtered"` for `-k`, `-m`, `--deselect`, `--last-failed`, a `file.py::test`
+  node id, or a run that ended early (`-x`, `--maxfail`, Ctrl-C, an internal or usage
+  error); otherwise `"full"`
+- `gitSha` and `packageVersion` — which commit the run describes, and what produced it
+
+Source paths are relative to the project root, so a report keeps its identity across machines
+and CI.
+
+pytest exposes no assertion counter. Use `story.expect("claim", callable)` to declare
+assertion evidence. A plain `story.then()` followed by Python `assert` remains unobserved,
+not zero.
+
+Pass that file to the `executable-stories` CLI (from the `executable-stories-formatters` package) to render reports:
+
+```bash
+npx --package executable-stories-formatters executable-stories format .executable-stories/raw-run.json --format html
+
+# The path is optional — `format` defaults to .executable-stories/raw-run.json
+npx --package executable-stories-formatters executable-stories format --format html
+
+# Diagnose the run JSON if a report won't generate (schema drift, empty run)
+npx --package executable-stories-formatters executable-stories doctor
+```
+
+Supported formats include `html`, `markdown`, `junit`, and the Cucumber outputs. Use `--output-dir` to choose where reports are written.
+
+## Verify
+
+From repo root:
+
+```bash
+pnpm run verify:pytest
+```

{executable_stories_pytest-0.1.0 → executable_stories_pytest-0.1.1}/pyproject.toml

@@ -4,10 +4,10 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "executable-stories-pytest"
-version = "0.1.0"
+version = "0.1.1"
 description = "pytest plugin for executable-stories BDD documentation"
-requires-python = ">=3.12"
-license = "MIT"
+requires-python = ">=3.10"
+license = "Apache-2.0"
 readme = "README.md"
 authors = [{ name = "Jag Reehal" }]
 
@@ -21,7 +21,7 @@ otel = ["opentelemetry-api>=1.20"]
 dev = [
     "ruff>=0.6.0",
     "mypy>=1.5.0",
-    "pytest>=7.4.0",
+    "pytest>=8.0.0",
 ]
 
 [project.entry-points.pytest11]
@@ -32,7 +32,7 @@ where = ["src"]
 
 [tool.ruff]
 line-length = 120
-target-version = "py312"
+target-version = "py310"
 
 [tool.ruff.format]
 quote-style = "double"
@@ -61,12 +61,12 @@ ignore = [
 known-first-party = ["executable_stories"]
 
 [tool.pytest.ini_options]
-minversion = "6.0"
+minversion = "8.0"
 testpaths = ["tests"]
 addopts = "-q"
 
 [tool.mypy]
-python_version = "3.12"
+python_version = "3.10"
 warn_return_any = true
 warn_unused_configs = true
 strict_optional = true

{executable_stories_pytest-0.1.0 → executable_stories_pytest-0.1.1}/src/executable_stories/_collector.py

@@ -16,6 +16,7 @@ class _Collector:
     def __init__(self) -> None:
         self._lock = threading.Lock()
         self._cases: list[dict[str, Any]] = []
+        self._features: dict[str, dict[str, Any]] = {}
 
     def record(self, test_case: dict[str, Any]) -> None:
         """Append a completed RawTestCase dict."""
@@ -27,10 +28,24 @@ class _Collector:
         with self._lock:
             return list(self._cases)
 
+    def record_feature(self, feature: dict[str, Any]) -> None:
+        """Store a declaration, replacing an earlier one for the same file.
+
+        A re-declaration then reads the way it does in source order.
+        """
+        with self._lock:
+            self._features[feature.get("sourceFile", "")] = feature
+
+    def get_features(self) -> list[dict[str, Any]]:
+        """Return all declared features."""
+        with self._lock:
+            return list(self._features.values())
+
     def clear(self) -> None:
         """Reset the collector."""
         with self._lock:
             self._cases.clear()
+            self._features.clear()
 
 
 # Module-level singleton

executable_stories_pytest-0.1.1/src/executable_stories/_json_writer.py

@@ -0,0 +1,31 @@
+"""Simple JSON serialization for RawRun output."""
+
+from __future__ import annotations
+
+import json
+import os
+import tempfile
+from typing import Any
+
+
+def write_raw_run(raw_run: dict[str, Any], output_path: str) -> None:
+    """Write a RawRun dict to a JSON file.
+
+    Creates parent directories if they don't exist. The file appears whole:
+    it is written alongside the destination and then renamed over it, so a
+    reader never sees a half-written run and a crash mid-write leaves the
+    previous file intact.
+    """
+    parent = os.path.dirname(output_path) or "."
+    os.makedirs(parent, exist_ok=True)
+
+    fd, temp_path = tempfile.mkstemp(dir=parent, prefix=".raw-run-", suffix=".json")
+    try:
+        with os.fdopen(fd, "w", encoding="utf-8") as f:
+            json.dump(raw_run, f, indent=2)
+            f.write("\n")
+        os.replace(temp_path, output_path)
+    except BaseException:
+        if os.path.exists(temp_path):
+            os.unlink(temp_path)
+        raise