Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 docs/reviewer-pack.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ Before treating the repo as v1-style consolidated:
- Keep the four-demo matrix stable, or document any intentional retirement in the README, reviewer path, reviewer pack, roadmap, and tests.
- Keep reviewer-visible artifact names stable, or update the artifact naming contract and committed sample outputs in the same change.
- Keep `docs/reviewer-path.md`, this reviewer pack, `docs/architecture.md`, and demo READMEs aligned with actual CLI behavior.
- Keep README, package metadata, and repository metadata aligned with the local, file-based detection workflow lab framing.
- Regenerate and inspect committed artifacts after behavior changes.
- Run `pytest` and confirm reviewer-doc tests still cover the demo matrix, artifact contract, and architecture boundaries.
- Do not add SIEM, dashboard, alert routing, case-management, real-time ingestion, autonomous response, or final-verdict claims.
Expand Down
3 changes: 1 addition & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
[project]
name = "telemetry-window-demo"
version = "0.1.0"
description = "A small prototype for windowed telemetry analytics on timestamped event streams."
description = "A local, file-based detection workflow lab for reviewer-verifiable telemetry and detection demos."
readme = "README.md"
license = { file = "LICENSE" }
requires-python = ">=3.11"
Expand All @@ -27,4 +27,3 @@ where = ["src"]
[tool.pytest.ini_options]
pythonpath = ["src"]
testpaths = ["tests"]

18 changes: 18 additions & 0 deletions tests/test_reviewer_docs.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from __future__ import annotations

import tomllib
from pathlib import Path


Expand Down Expand Up @@ -76,6 +77,10 @@ def _read_repo_file(relative_path: str) -> str:
return (REPO_ROOT / relative_path).read_text(encoding="utf-8")


def _read_pyproject() -> dict[str, object]:
return tomllib.loads(_read_repo_file("pyproject.toml"))


def test_reviewer_path_keeps_detection_lab_positioning() -> None:
reviewer_path = _read_repo_file("docs/reviewer-path.md")
normalized = reviewer_path.lower()
Expand Down Expand Up @@ -107,6 +112,18 @@ def test_readme_links_reviewer_path_and_uses_lab_framing() -> None:
assert "[`docs/architecture.md`](docs/architecture.md)" in readme


def test_package_metadata_uses_detection_lab_framing() -> None:
pyproject = _read_pyproject()
description = str(pyproject["project"]["description"])

assert description == (
"A local, file-based detection workflow lab for "
"reviewer-verifiable telemetry and detection demos."
)
assert "small prototype" not in description.lower()
assert "monitoring platform" not in description.lower()


def test_top_level_reviewer_pack_covers_matrix_and_artifact_contract() -> None:
reviewer_pack = _read_repo_file("docs/reviewer-pack.md")

Expand Down Expand Up @@ -139,6 +156,7 @@ def test_reviewer_pack_defines_v1_readiness_gate() -> None:
assert "## v1 Readiness Gate" in reviewer_pack
assert "four-demo matrix stable" in reviewer_pack
assert "reviewer-visible artifact names stable" in reviewer_pack
assert "package metadata, and repository metadata" in reviewer_pack
assert "Regenerate and inspect committed artifacts" in reviewer_pack
assert "Run `pytest`" in reviewer_pack
assert "Do not add SIEM, dashboard, alert routing" in reviewer_pack
Expand Down
Loading