Skip to content

Docs improvements and ADR cleanup #43

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

Merged
mathieu-ducrot merged 1 commit into from
Aug 28, 2026
Merged

Docs improvements and ADR cleanup #43

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
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
CHANGELOG for 1.x
===================
## v1.5.2 - (2026-07-16)
### Changed
- `docs/phpunit.md` : add "Test Class management" section documenting the 1:1 mapping convention between production and test classes; rename fixture examples from `.yml` to `.yaml` and use a more meaningful fixture filename (`create_simulation.yaml` instead of `test_check_entity.yml`)
- `docs/phpstan.md` : translate `ignoreErrors` comment from French to English; clarify the `ekino/phpstan-banned-code` section title and add an explicit note that only `phpstan-disallowed-calls` is used
- `docs/psalm.md` : name `psalm-taint-stubs.php` explicitly in the custom-stub explanation
- `adr/20260709-php-security-audit-migration.md` : remove Drupal 7 rows from Table 1 (Drupal API absent in a Symfony stack); drop the "Provided by" column from Table 2 and remove rows already covered by the Symfony plugin description

## v1.5.1 - (2026-07-10)
### Added
- `docs/phpunit.md` dedicated testing documentation
Expand Down
39 changes: 12 additions & 27 deletions adr/20260709-php-security-audit-migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,6 @@ Status legend: ✅ covered · 🟡 covered by PHPStan · 🔵 covered by compose
| BadFunctions/PregReplace | `preg_replace` `/e` modifier + input | — | `/e` modifier removed since PHP 7 | ⏳ |
| CVE/20132110 | CVE-2013-2110 (PHP < 5.3.26) | **composer audit** | dependency version scan | 🔵 |
| CVE/20134113 | CVE-2013-4113 (PHP < 5.3.27) | **composer audit** | dependency version scan | 🔵 |
| Drupal7/SQLi | `db_query()` SQLi (Drupal) | **Psalm** (by intent) | `sql` taint via Doctrine stub (`db_query` API absent) | ✅⚪ |
| Drupal7/DynQueries | dynamic queries (where/having…) | **Psalm** (by intent) | `sql` taint via Doctrine stub — replaces the intended usage | ✅ |
| Drupal7/DbQueryAC | access control on queries (Drupal) | ⚪ | Drupal-specific access logic | ⚪ |
| Drupal7/AESModule | `db_query()` AES module (Drupal) | ⚪ | Drupal API absent | ⚪ |
| Drupal7/HttpRequest | SSRF via `drupal_http_request` | **Psalm** (by intent) | `ssrf` taint (curl) for the Symfony equivalent | ✅⚪ |
| Drupal7/XSSHTMLConstruct | HTML built with input | **Psalm** | `html` taint + Twig (Symfony plugin) | ✅ |
| Drupal7/XSSFormValue | XSS via `#value` (Drupal Form API) | ⚪ | Drupal API absent | ⚪ |
| Drupal7/XSSPTheme | XSS via `#theme`/html_tag (Drupal) | ⚪ | Drupal API absent | ⚪ |
| Drupal7/Cachei | cache injection (Drupal) | ⚪ | Drupal cache API absent | ⚪ |
| Drupal7/UserInputWatch | input detection (Drupal) | ⚪ | Drupal-specific heuristic | ⚪ |
| Drupal7/AdvisoriesContrib | vulnerable Drupal contrib modules | **composer audit** | dependency advisories (no Drupal here) | 🔵⚪ |
| Drupal7/AdvisoriesCore | outdated Drupal core | **composer audit** | dependency advisories (no Drupal here) | 🔵⚪ |
| Misc/BadCorsHeader | `Access-Control-Allow-Origin: *` | **nelmio_security** (project) | CORS config handled by nelmio/security-bundle at project level, outside the standard-bundle | ✅⚪ |
| Misc/IncludeMismatch | meta: extensions not scanned by PHPCS | — | PHPCS meta-rule, moot outside PHPCS | ❌ |

Expand All @@ -64,21 +52,18 @@ Status legend: ✅ covered · 🟡 covered by PHPStan · 🔵 covered by compose

### Table 2 — What Psalm taint analysis adds ON TOP (things we didn't have)

| Addition | Detail | Provided by |
|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|
| **Real data-flow analysis** | Source → sink tracking across calls (controller input → sink in a service several calls away). phpcs was single-file / token-based. | Psalm (engine) |
| **Near-zero false positives** | Only flags a proven flow, instead of alerting on every variable near a query (no more mass `phpcs:ignore`). | Psalm (engine) |
| **SQLi on Doctrine ORM/DQL** | `createQuery`, `QueryBuilder::where/andWhere/having/groupBy` marked as SQL sinks — phpcs only did pattern matching. | `psalm-taint-stubs.php` stub |
| **XSS in Twig templates** | Taint analysis of Twig templates (unescaped variables). **No** equivalent in phpcs-security-audit. | Symfony plugin |
| **XSS via Symfony Response** | `Response`/HTML content marked as `html` sink. | Symfony plugin |
| **Symfony HTTP sources modeled** | `Request`, `InputBag`, `ParameterBag`, `HeaderBag` (query/request/attributes/headers) as sources, versioned per Symfony release. | Symfony plugin |
| **LDAP injection** | `ldap_search` as `ldap` sink. | Psalm native |
| **Header injection** | `header()` as `header` sink. | Psalm native |
| **Object injection / unserialize** | `unserialize` as `unserialize` sink. | Psalm native |
| **SSRF** | `curl_init/curl_setopt/getimagesize` as `ssrf` sink. | Psalm native |
| **Path/file injection** | `file` family (fopen, file_get_contents, include…). | Psalm native |
| **Cookie injection** | `setcookie` as `cookie` sink. | Psalm native |
| **Tooled false-positive handling** | Dedicated taint baseline (`--set-baseline`/`--use-baseline`) + inline suppression via `@psalm-taint-escape sql` (not `@psalm-suppress`). | Psalm |
| Addition | Detail |
|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Real data-flow analysis** | Source → sink tracking across calls (controller input → sink in a service several calls away). phpcs was single-file / token-based. |
| **Near-zero false positives** | Only flags a proven flow, instead of alerting on every variable near a query (no more mass `phpcs:ignore`). |
| **SQLi on Doctrine ORM/DQL** | `createQuery`, `QueryBuilder::where/andWhere/having/groupBy` marked as SQL sinks — phpcs only did pattern matching. |
| **LDAP injection** | `ldap_search` as `ldap` sink. |
| **Header injection** | `header()` as `header` sink. |
| **Object injection / unserialize** | `unserialize` as `unserialize` sink. |
| **SSRF** | `curl_init/curl_setopt/getimagesize` as `ssrf` sink. |
| **Path/file injection** | `file` family (fopen, file_get_contents, include…). |
| **Cookie injection** | `setcookie` as `cookie` sink. |
| **Tooled false-positive handling** | Dedicated taint baseline (`--set-baseline`/`--use-baseline`) + inline suppression via `@psalm-taint-escape sql` (not `@psalm-suppress`). |

---

Expand Down
7 changes: 4 additions & 3 deletions docs/phpstan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ Otherwise, use the config format to specify a path, for example

```yaml
ignoreErrors:
# method.nonObject ignoré dans tests/ : les fixtures initialisent des objets partiels
# dont certaines methodes peuvent retourner null avant d'etre completement renseignes.
# method.nonObject ignored in tests/: fixtures initialize partial objects,
# so some methods might return null before being fully defined.
-
identifier: method.nonObject
path: tests/
Expand All @@ -70,7 +70,8 @@ See the PHPStan docs on [ignoreErrors](https://phpstan.org/user-guide/ignoring-e
- Taint analysis such as injection/XSS (data-flow) is handled by [Psalm](psalm.md);
- dependency CVEs check by `composer audit`.

**A note on `ekino/phpstan-banned-code`.**
**Why we do not use `ekino/phpstan-banned-code`.**
Note: This PHPStan extension is not used in this project. We rely exclusively on `phpstan-disallowed-calls`.
- Also listed in the [PHPStan extension library](https://phpstan.org/user-guide/extension-library), it can look like an alternative to
`phpstan-disallowed-calls` — it isn't: it only bans global functions and a handful of language constructs (`echo`, `print`, `eval`, `exit`,
backticks), with no support for banning method calls, static calls, namespaces, constants, superglobals or attributes.
Expand Down
31 changes: 24 additions & 7 deletions docs/phpunit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ Each project has a `tests/Admin/AdminAvailabilityTest.php` extending `AbstractWe
public function testPageIsOk(): void
{
$this->logIn([
$this->getMinimalFixturesDir() . '/vendor.yml',
$this->getFixturesDir() . '/common/smart_parameter.yml',
$this->getMinimalFixturesDir() . '/vendor.yaml',
$this->getFixturesDir() . '/common/smart_parameter.yaml',
]);

$urls = [
Expand Down Expand Up @@ -74,8 +74,8 @@ For dynamic URLs (show/edit pages needing an entity id), load a dedicated fixtur
public function testDynamicOrganizationPageIsOk(): void
{
$this->logIn([
$this->getMinimalFixturesDir() . '/vendor.yml',
$this->getFixturesDir() . '/Admin/AdminAvailabilityTest/organization.yml',
$this->getMinimalFixturesDir() . '/vendor.yaml',
$this->getFixturesDir() . '/Admin/AdminAvailabilityTest/organization.yaml',
]);

$urls = [
Expand All @@ -96,6 +96,23 @@ public function testDynamicOrganizationPageIsOk(): void

**Rule : Every new page added to the project must be added to this test.**

### Test Class management

When [organizing your test suite in PHPUnit](https://docs.phpunit.de/en/12.5/writing-tests-for-phpunit.html), the industry standard relies on a clean **1:1 mapping** between your production classes and your test classes. Rather than creating isolated test classes for each individual method (like `MethodATest`), you should write a single test class matching your target service (e.g., `ServiceATest` for `ServiceA`).

Inside this class, the best practice is to split your assertions so that **each test method targets exactly one specific scenario** rather than wrapping all validation logic into a single, giant method. This guarantees that if one assertion fails, PHPUnit doesn't halt early and obscure other potential bugs.

```text
project/
├── src/
│ └── Manager/
│ └── CloudSimulationManager.php # Contains create() and rollback() methods
│
└── tests/
├── Manager/
│ └── CloudSimulationManagerTest.php # Tests both create() and rollback()
```

### Test fixtures management

Fixtures are written as [nelmio/alice](https://github.com/nelmio/alice) YAML files and loaded with
Expand All @@ -117,10 +134,10 @@ tests/
│ └── user_administrator.yaml
├── Admin/
│ └── AdminAvailabilityTest/ # data owned by that test class only
│ └── organization.yml
│ └── organization.yaml
└── Manager/
└── CloudSimulationManager/
└── test_check_entity.yml
└── create_simulation.yaml
```

Why this separation: a test must be able to evolve its data without silently breaking other tests. Sharing one big fixture set across the suite
Expand All @@ -132,7 +149,7 @@ Load them in tests through the `AbstractWebTestCase` helpers:
```php
$this->loadFixtureFiles([
$this->getFixturesDir() . '/common/user_administrator.yaml',
$this->getFixturesDir() . '/Manager/CloudSimulationManager/test_check_entity.yml',
$this->getFixturesDir() . '/Manager/CloudSimulationManager/create_simulation.yaml',
]);
```

Expand Down
2 changes: 1 addition & 1 deletion docs/psalm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Three pieces make taint analysis understand our Symfony/Doctrine stack:
| [`psalm/plugin-symfony`](https://github.com/psalm/psalm-plugin-symfony) | **sources**: Symfony HTTP input (`Request`, `InputBag`, `ParameterBag`, `HeaderBag`) + XSS **sinks** (Twig, `Response`) |
| `psalm-taint-stubs.php` (custom) | **sinks**: Doctrine ORM/DBAL SQL methods (`createQuery`, `QueryBuilder::where/andWhere/having/groupBy`, `Connection::executeQuery`…) |

The custom stub is required and cannot be replaced by a plugin: no Psalm plugin marks the Doctrine **ORM** query path as an SQL sink
The custom stub `psalm-taint-stubs.php` is required and cannot be replaced by a plugin: no Psalm plugin marks the Doctrine **ORM** query path as an SQL sink
(`weirdan/doctrine-psalm-plugin` only covers low-level DBAL, and its type stubs even collide with ours).

Native Psalm already ships SQL sinks for raw `mysqli`/`PDO`, but our code goes through Doctrine.
Expand Down
Loading