tepyd 0.5.0__tar.gz

tepyd-0.5.0/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 2026 Stefane Fermigier
+
+   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.

tepyd-0.5.0/PKG-INFO

@@ -0,0 +1,299 @@
+Metadata-Version: 2.4
+Name: tepyd
+Version: 0.5.0
+Summary: TEst PYramid Doctor — diagnose a project's test pyramid: mass, structure, and coverage.
+Author: Stefane Fermigier
+Author-email: Stefane Fermigier <sf@abilian.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# Tepyd — The TEst PYramid Doctor
+
+*Diagnose your test pyramid: is the shape what you say you want?*
+
+Tepyd looks at a project's test suite and tells you whether its *shape* matches the test pyramid you say you want: a broad base of cheap unit tests, fewer integration tests, a thin cap of end-to-end tests. It automates the checks you'd otherwise do by hand — which packages are under- or over-tested, where the cheap tests are missing, whether the test tree mirrors the source tree, and — by running your suite under coverage — which tier actually exercises each package.
+
+It's configuration-driven: point it at any project, describe that project's layout once in `pyproject.toml`, and run one command. The author's own layout ships as the default, so for projects that share it there's nothing to configure.
+
+> Think `tepyd doctor`: diagnose my pyramid.
+
+## The lenses
+
+Tepyd looks at a suite through several complementary lenses. Each is useful alone; together they catch failure modes the others miss.
+
+| Lens | Command | Question | Runs tests? | Status |
+|------|---------|----------|-------------|--------|
+| **Mass** | `tepyd mass` | How much test code is there, and what shape does it make? | no | ✅ implemented |
+| **Mirror** | `tepyd mirror` | Does the test tree structurally parallel the source tree? | no | ✅ implemented |
+| **Cover** | `tepyd cover` | Which tier actually *executes* each unit — and is it the cheap one? | yes | ✅ implemented |
+| **Report** | `tepyd report` | All the checks at once, plus advice: the *why* and the *how*, not just the *what*. | no | ✅ implemented |
+| **Audit** | `tepyd audit` | Does each test file's imports match the tier it lives in? | no | 🔜 planned |
+
+## Requirements
+
+- Python ≥ 3.12.
+- `mass`, `mirror`, and `report` have no runtime dependencies — the line counter is built in.
+- `cover` additionally needs the analysed project's own `pytest` and `coverage` to be importable, so run it from that project's environment (see [`tepyd cover`](#tepyd-cover)).
+- `cloc` is an optional opt-in for the line counter (`counter = "cloc"`).
+
+## Install
+
+```bash
+uv sync                                 # for development in this repo
+# once published to PyPI (not yet):
+# uv tool install tepyd
+```
+
+After `uv sync`, prefix commands with `uv run` (or activate the venv). Once published, `uv tool install tepyd` puts `tepyd` on your PATH directly.
+
+The default line counter is built in — no external dependency. Set `counter = "cloc"` in config to use the [`cloc`](https://github.com/AlDanial/cloc) binary instead, if you want its stricter, multi-language counting.
+
+## Quick start
+
+```bash
+uv run tepyd init                      # detect this project's layout, write a config
+uv run tepyd mass --min-src 1          # analyse the current directory
+uv run tepyd -C /path/to/project mass  # analyse another project
+uv run tepyd report                    # the checks + advice, in one read
+```
+
+(`--min-src` skips source units under 20 LOC by default; pass `--min-src 1` on small projects to see every unit. Drop the `uv run` prefix once Tepyd is on your PATH.)
+
+`mass`, `mirror`, and `cover` take `--json` for machine-readable output — the contract `report` and a future CI gate build on (`report` itself renders text or Markdown via `--format`). All commands take `-C/--root DIR` to point at a project other than the current directory.
+
+## Concepts
+
+- **Source unit** — a meaningful slice of the source tree that Tepyd analyses as a whole, derived from configurable glob patterns (by default: each package under `modules/`, plus every other top-level package).
+- **Tier** — one rung of the pyramid: a directory of tests of a given cost (e.g. `tests/a_unit`). Tiers are listed cheapest-first in config; any number is allowed, not just three.
+- **Unit share** — the fraction of a unit's test code that lives in the cheapest tier. The headline pyramid-health metric.
+- **Shape glyph** — a one-character read on a unit's pyramid:
+
+  | Glyph | Meaning |
+  |-------|---------|
+  | `▲` | healthy — the cheapest tier is the largest *and* ≥ 40 % of test LOC |
+  | `◇` | balanced — neither clearly healthy nor inverted |
+  | `▼` | inverted — the most expensive tier is the largest *and* unit share < 30 % |
+  | `·` | no tests at all |
+
+## `tepyd mass`
+
+Counts test LOC against source LOC for every source unit and reports the per-tier breakdown, ratios, and pyramid shape.
+
+```bash
+tepyd mass
+tepyd mass --json
+tepyd mass --min-src 50      # skip source units under 50 LOC (default: 20)
+tepyd mass --exclude faker   # skip a unit, on top of config exclusions (repeatable)
+```
+
+```
+package       src  unit  integration  http-e2e  browser  tests  ratio    u%
+------------  ---  ----  -----------  --------  -------  -----  -----  ----  -
+modules/biz    24    32            8         4        0     44  1.83x   73%  ▲
+modules/wire   24     0            0         0       24     24  1.00x    0%  ▼
+services       16     0           16         0        0     16  1.00x    0%  ◇
+models         16     0            0         0        0      0  0.00x     —  ·
+
+=== Summary ===
+...                            (per-tier totals and outlier lists)
+Tier mix across the codebase : unit 50%  /  integration 20%  /  http-e2e 10%  /  browser 20%
+  ⚠ unit share is 50%, below the 60% target — the pyramid is flattened.
+Caveat : tier is by directory, not by what each test actually exercises.
+```
+
+**How to read it.** Each tier has its own column; `ratio` is total test LOC ÷ source LOC; `u%` is unit share. The summary lists outliers (untested, under-tested below 0.5×, heavily-tested above 2×), flags inverted pyramids, and warns when the codebase-wide unit share falls below the first tier's `target_share`.
+
+**A caveat Tepyd states up front:** LOC is a *proxy* for effort, not a measure of quality, and a test's tier is decided by its directory, not by what it actually exercises. Mass tells you where to look; the [`cover` lens](#tepyd-cover) tells you whether the tests are real.
+
+## `tepyd mirror`
+
+Static, no-execution comparison of the test tree against the source tree, per tier, at sub-package granularity.
+
+```bash
+tepyd mirror
+tepyd mirror --json
+tepyd mirror --max-depth 1   # only check top-level source packages
+tepyd mirror --exclude faker
+```
+
+```
+Mirror — test tree vs source tree (6 source units)
+
+unit: 3/6 mirrored (50%)
+  gap     domain/models
+  gap     web
+  orphan  tests/a_unit/legacy
+
+integration: 1/6 mirrored (17%)
+  gap     domain
+  ...
+```
+
+**How to read it.** For each tier:
+
+- **present** — the source package has a matching test directory that contains tests (counted in the `X/Y mirrored` figure),
+- **gap** — a source package with no test counterpart at this tier,
+- **orphan** — a test directory that contains tests but has no source on disk (tests for code that moved or vanished).
+
+Orphan detection checks whether the source actually exists, so it's independent of `--max-depth` and of exclusions. Mirror coverage is presented as data, not a pass/fail — a browser tier showing `1/20 mirrored` is often by design.
+
+## `tepyd cover`
+
+The only lens that **runs your test suite**. For each tier it does one `coverage run -m pytest <tier-dir>` (the tiers partition the suite, so the cost is roughly one full run), then measures, per source unit, what fraction of its statements each tier actually executes.
+
+> **Run `cover` from your project's own environment.** Unlike the other lenses, it imports and executes your code, so it must run where your package, `pytest`, and `coverage` are installed. Add Tepyd there (`uv add --dev tepyd`) and run `uv run tepyd cover` from the project root. Installing Tepyd standalone (`uv tool install`) and pointing it at the project with `-C` will fail to import your tests.
+
+```bash
+tepyd cover                  # all tiers
+tepyd cover --tier a_unit    # just the unit tier (repeatable)
+tepyd cover --json
+```
+
+```
+unit      stmts  unit  e2e   any
+--------  -----  ----  ---  ----
+checkout      7    0%  88%   88%  v hidden
+domain        9  100%   0%  100%
+```
+
+The **any** column is the union across tiers — a unit's true reachable-by-tests coverage. The flag marks the **hidden inverted pyramid**: a unit that's well covered overall (`any` high) but barely by its unit tier — the lines run, but only the expensive tiers run them. A global coverage report would show both rows as green; only this lens reveals that `checkout`'s coverage is entirely e2e.
+
+Requirements & behavior:
+- `coverage` and `pytest` must be importable in the environment you run it from (run it from the project's venv, e.g. `uv run tepyd cover`); if not, it exits with a clear install hint.
+- It **ignores the project's own `[tool.coverage]` config** so the numbers don't depend on it, and attributes coverage by resolved path (robust to multi-file units and absolute coverage paths).
+- A tier that **fails to run** is shown as a 0% column and listed as not-measured (distinct from "0% because untested"); a tier whose tests **ran but failed** is used with a warning that the numbers are a floor. Both also print to stderr.
+
+## `tepyd report`
+
+Runs every check at once and synthesises the results into a list of **findings**, each carrying not just *what* is wrong but *why* it matters (the pyramid principle behind it) and *how* to fix it.
+
+```bash
+tepyd report                     # console report, "senior" level
+tepyd report --format md         # Markdown, for a PR comment or a committed file
+tepyd report --level newb        # teach the concepts (intro + glossary + advice)
+tepyd report --level expert      # a terse one-line-per-finding checklist
+```
+
+Every report opens with a **context lead-in** — what's being measured and why — and the `--level` knob tunes how much it explains, not which problems it finds:
+
+| Level | What you get |
+|-------|--------------|
+| `newb` | A full plain-language explanation of the pyramid, every finding's what/why/fix, general advice, and a glossary. |
+| `junior` | A shorter context, every finding's what/why/fix, and general advice. |
+| `senior` (default) | A brief context, then each finding's what/why/fix — no hand-holding. |
+| `expert` | A one-line context note, then one line per finding: the marker, the title, and the action. |
+
+It reports an overall **health verdict** (`healthy` / `fair` / `needs work`), a one-line summary of each lens, and findings ordered by severity (`✗` problem, `⚠` warning, `ℹ` info). `--min-src`, `--max-depth`, and `--exclude` work as they do on the individual lenses.
+
+## `tepyd init`
+
+Rather than write the config by hand, let Tepyd guess it. `tepyd init` looks around the project for the usual clues — a `src/` package (or a flat top-level one), a `tests/` tree split into tiers, a `modules/` sub-layout, a top-level browser-test root — and **appends** a commented `[tool.tepyd]` block to `pyproject.toml`, leaving the rest of the file untouched.
+
+```bash
+tepyd init             # detect and write the section
+tepyd init --dry-run   # print what it would write, change nothing
+```
+
+When it can't make a confident guess — for example, several packages under `src/` with none named `app` or matching the project name — it **asks you to choose** (when run interactively). In a non-interactive context (a pipe, CI), it falls back to the first candidate and prints a note rather than blocking. It also refuses to overwrite an existing `[tool.tepyd]` section, and prints a note for anything else it had to guess (an undetected source root, no test tiers). The result is a head start to review — not necessarily a finished config.
+
+## Configuration
+
+`tepyd init` writes this for you, but here is the full reference. Everything is configured under `[tool.tepyd]` in `pyproject.toml`. With no section at all, the defaults below apply (except `exclude`, which is always empty unless set — exclusions are per-project policy, not a layout default).
+
+```toml
+[tool.tepyd]
+src_root    = "src/app"   # filesystem root of the analysed source
+src_package = "app"       # dotted import path; reserved — not read by any lens yet
+
+# How to slice the source tree into units (globs, first-match-wins): explode
+# each package under modules/ one level deep, then take every other
+# top-level package as a unit.
+units = ["modules/*", "*"]
+
+# Line counter: "internal" (built-in, no dependency) or "cloc".
+counter = "internal"
+
+# Source units excluded from analysis — a reason is REQUIRED, so the policy
+# decision is documented where it's made.
+[tool.tepyd.exclude]
+faker = "seed/fake-data generator, exercised via fixtures"
+
+# Test tiers, cheapest first (bottom of the pyramid first). Any number of tiers.
+[[tool.tepyd.tiers]]
+name = "a_unit"
+root = "tests/a_unit"
+label = "unit"
+target_share = 0.60          # policy gate: ≥ 60 % of test LOC should be here
+
+[[tool.tepyd.tiers]]
+name = "b_integration"
+root = "tests/b_integration"
+label = "integration"
+
+[[tool.tepyd.tiers]]
+name = "c_e2e"
+root = "tests/c_e2e"
+label = "http-e2e"
+
+[[tool.tepyd.tiers]]
+name = "e2e_playwright"
+root = "e2e_playwright"      # an arbitrary root — needn't live under tests/
+label = "browser"
+strip_prefix = "modules/"    # this tier flattens the layout: modules/biz → biz
+```
+
+### Reference
+
+| Key | Default | Meaning |
+|-----|---------|---------|
+| `src_root` | `"src/app"` | Filesystem root of the analysed source. |
+| `src_package` | `"app"` | Dotted import path of the source. Currently informational — no lens reads it yet (`cover` keys off `src_root`). |
+| `units` | `["modules/*", "*"]` | Glob patterns slicing the source tree into units; first match wins, and a container whose children were already claimed is skipped. A pattern ending in `.py` (e.g. `["*.py"]`) makes each top-level **module** a unit — for flat packages with no sub-packages; `["*"]` stays directories-only. |
+| `counter` | `"internal"` | `internal` (tokenize-based; counts non-blank, non-comment lines) or `cloc`. |
+| `exclude` | `{}` | Table of `unit = "reason"`; the reason is required. |
+| `tiers` | four tiers (see above) | Array of tables, cheapest-first. |
+
+Per-tier keys: `name` (required), `root` (required), `label` (defaults to `name`), `target_share` (0–1, optional policy gate), `strip_prefix` (mapping rewrite for tiers that flatten the layout).
+
+A different project just describes itself — e.g. a flat `src/` with two tiers:
+
+```toml
+[tool.tepyd]
+src_root = "src"
+src_package = "mypkg"
+units = ["*"]
+
+[[tool.tepyd.tiers]]
+name = "unit"
+root = "tests/unit"
+
+[[tool.tepyd.tiers]]
+name = "e2e"
+root = "tests/e2e"
+```
+
+## What Tepyd is not
+
+- **Not a test runner**, and not a replacement for pytest or coverage — `cover` orchestrates them.
+- **Not a correctness checker.** LOC is a *proxy* for effort, and a test's tier is decided by its directory, not by what it exercises.
+- **Not a pass/fail gate** (today): it reports data and advice. The mirror and cover figures are diagnostics, not targets — `1/20 mirrored` for a browser tier is often correct by design.
+
+## Development
+
+```bash
+make test    # pytest
+make lint    # ruff + ty + pyrefly + mypy
+make format  # ruff format + autofix
+```
+
+Tests are themselves organised as a pyramid (`tests/a_unit`, `tests/b_integration`, `tests/c_e2e`) — Tepyd eats its own dog food.
+
+## Changelog
+
+See [CHANGES.md](CHANGES.md).
+
+## License
+
+Tepyd is licensed under the Apache License 2.0 — see [LICENSE](LICENSE).