@terpjs/spec 0.14.0

package/corpus/backend/no_raw_file_references/compliant-01/modules/notes/models.py

@@ -0,0 +1,10 @@
+import uuid
+
+from sqlmodel import Field
+from terp.capabilities.files import FileRef
+from terp.core import BaseTable
+
+
+class Note(BaseTable, table=True):
+    title: str = Field(max_length=200)
+    attachment_file_id: uuid.UUID | None = FileRef()

package/corpus/backend/no_raw_file_references/violation-01/modules/notes/models.py

@@ -0,0 +1,9 @@
+import uuid
+
+from sqlmodel import Field
+from terp.core import BaseTable
+
+
+class Note(BaseTable, table=True):
+    title: str = Field(max_length=200)
+    attachment_file_id: uuid.UUID | None = None

package/corpus/backend/no_raw_outbound_http/compliant-01/modules/notes/service.py

@@ -0,0 +1,2 @@
+from urllib import parse
+from terp.core import BaseService

package/corpus/backend/no_raw_outbound_http/compliant-03/modules/notes/service.py

@@ -0,0 +1,12 @@
+"""Compliant near-misses: names that contain a restricted root without being it.
+
+``socketserver`` is not ``socket``; ``httpx_mock`` is not ``httpx``; a comment
+or string naming a client is not an import.
+"""
+
+from socketserver import BaseRequestHandler
+
+import httpx_mock
+
+# import httpx would be refused here.
+CLIENT_DOC = "outbound calls never 'import requests'; use the declared capability"

package/corpus/backend/no_raw_outbound_http/violation-01/expected-findings.json

@@ -0,0 +1,7 @@
+[
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 1
+  }
+]

package/corpus/backend/no_raw_outbound_http/violation-01/modules/notes/service.py

@@ -0,0 +1 @@
+import httpx

package/corpus/backend/no_raw_outbound_http/violation-02/expected-findings.json

@@ -0,0 +1,7 @@
+[
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 1
+  }
+]

package/corpus/backend/no_raw_outbound_http/violation-02/modules/notes/service.py

@@ -0,0 +1 @@
+from urllib.request import urlopen

package/corpus/backend/no_raw_outbound_http/violation-03/expected-findings.json

@@ -0,0 +1,7 @@
+[
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 1
+  }
+]

package/corpus/backend/no_raw_outbound_http/violation-03/modules/notes/service.py

@@ -0,0 +1 @@
+import socket

package/corpus/backend/no_raw_outbound_http/violation-04/expected-findings.json

@@ -0,0 +1,12 @@
+[
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 3
+  },
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 4
+  }
+]

package/corpus/backend/no_raw_outbound_http/violation-04/modules/notes/service.py

@@ -0,0 +1,7 @@
+"""Violation: aliased and multiline import forms of raw HTTP clients."""
+
+import urllib.request as transport
+from aiohttp import (
+    ClientSession,
+    ClientTimeout,
+)

package/corpus/backend/no_raw_outbound_http/violation-05/expected-findings.json

@@ -0,0 +1,12 @@
+[
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 3
+  },
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 5
+  }
+]

package/corpus/backend/no_raw_outbound_http/violation-05/modules/notes/service.py

@@ -0,0 +1,5 @@
+"""Violation: the lower-level escape routes — http.client and an urllib3 submodule."""
+
+from http.client import HTTPSConnection
+
+import urllib3.util

package/corpus/backend/no_raw_outbound_http/violation-06/expected-findings.json

@@ -0,0 +1,12 @@
+[
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 1
+  },
+  {
+    "rule": "backend/no_raw_outbound_http",
+    "path": "modules/notes/service.py",
+    "line": 2
+  }
+]

package/corpus/backend/no_raw_outbound_http/violation-06/modules/notes/service.py

@@ -0,0 +1,2 @@
+import requests
+import aiohttp.client

package/corpus/backend/no_raw_session_construction/compliant-01/modules/notes/service.py

@@ -0,0 +1,3 @@
+from terp.core import SessionDep
+def run(session: SessionDep):
+    return session

package/corpus/backend/no_raw_session_construction/violation-01/modules/notes/service.py

@@ -0,0 +1,3 @@
+def run(engine):
+    with Session(engine) as s:
+        return s

package/corpus/backend/no_star_imports/compliant-01/modules/notes/service.py

@@ -0,0 +1 @@
+from os.path import join, dirname

package/corpus/backend/no_star_imports/violation-01/modules/notes/service.py

@@ -0,0 +1 @@
+from os.path import *

package/corpus/backend/no_todo_fixme/compliant-01/modules/notes/service.py

@@ -0,0 +1,3 @@
+def run():
+    value = 1  # returns the canonical seed value
+    return value

package/corpus/backend/no_todo_fixme/violation-01/modules/notes/service.py

@@ -0,0 +1,3 @@
+def run():
+    value = 1  # TODO: finish this later
+    return value

package/corpus/backend/no_unique_columns_on_soft_delete_models/compliant-01/modules/notes/models.py

@@ -0,0 +1,17 @@
+from sqlalchemy import Index, text
+from sqlmodel import Field
+from terp.core import BaseTable, SoftDeleteMixin
+
+
+class Note(BaseTable, SoftDeleteMixin, table=True):
+    __table_args__ = (
+        Index(
+            'uq_note_slug_live',
+            'slug',
+            unique=True,
+            postgresql_where=text('deleted_at IS NULL'),
+            sqlite_where=text('deleted_at IS NULL'),
+        ),
+    )
+
+    slug: str = Field(max_length=80)

package/corpus/backend/no_unique_columns_on_soft_delete_models/violation-01/expected-findings.json

@@ -0,0 +1,7 @@
+[
+  {
+    "rule": "backend/no_unique_columns_on_soft_delete_models",
+    "path": "modules/notes/models.py",
+    "line": 6
+  }
+]

package/corpus/backend/no_unique_columns_on_soft_delete_models/violation-01/modules/notes/models.py

@@ -0,0 +1,6 @@
+from sqlmodel import Field
+from terp.core import BaseTable, SoftDeleteMixin
+
+
+class Note(BaseTable, SoftDeleteMixin, table=True):
+    slug: str = Field(max_length=80, unique=True)

package/corpus/backend/no_unique_columns_on_soft_delete_models/violation-02/expected-findings.json

@@ -0,0 +1,7 @@
+[
+  {
+    "rule": "backend/no_unique_columns_on_soft_delete_models",
+    "path": "modules/notes/models.py",
+    "line": 11
+  }
+]

package/corpus/backend/no_unique_columns_on_soft_delete_models/violation-02/modules/notes/models.py

@@ -0,0 +1,13 @@
+from sqlalchemy import UniqueConstraint
+from sqlmodel import Field
+from terp.core import BaseTable, SoftDeleteMixin
+
+
+class ArchivableRow(BaseTable, SoftDeleteMixin):
+    pass
+
+
+class Note(ArchivableRow, table=True):
+    __table_args__ = (UniqueConstraint('slug'),)
+
+    slug: str = Field(max_length=80)

package/corpus/backend/no_unique_columns_on_soft_delete_models/violation-03/expected-findings.json

@@ -0,0 +1,7 @@
+[
+  {
+    "rule": "backend/no_unique_columns_on_soft_delete_models",
+    "path": "modules/notes/models.py",
+    "line": 8
+  }
+]

package/corpus/backend/no_unique_columns_on_soft_delete_models/violation-03/modules/notes/models.py

@@ -0,0 +1,16 @@
+from sqlalchemy import Index, text
+from sqlmodel import Field
+from terp.core import BaseTable, SoftDeleteMixin
+
+
+class Note(BaseTable, SoftDeleteMixin, table=True):
+    __table_args__ = (
+        Index(
+            'uq_note_slug_live',
+            'slug',
+            unique=True,
+            postgresql_where=text('deleted_at IS NULL'),
+        ),
+    )
+
+    slug: str = Field(max_length=80)

package/corpus/backend/offset_queries_declare_ordering/compliant-01/modules/notes/service.py

@@ -0,0 +1,4 @@
+def list_notes(session, skip):
+    return session.exec(
+        select(Note).order_by(Note.created_at).offset(skip).limit(20)
+    ).all()

package/corpus/backend/offset_queries_declare_ordering/violation-01/modules/notes/service.py

@@ -0,0 +1,2 @@
+def list_notes(session, skip):
+    return session.exec(select(Note).offset(skip).limit(20)).all()

package/corpus/backend/path_id_params_are_uuid/compliant-01/modules/notes/router.py

@@ -0,0 +1,6 @@
+import uuid
+
+
+@router.get("/{note_id}", response_model=NoteRead)
+def get_note(note_id: uuid.UUID) -> NoteRead:
+    return NoteRead()

package/corpus/backend/path_id_params_are_uuid/violation-01/modules/notes/router.py

@@ -0,0 +1,6 @@
+import uuid
+
+
+@router.get("/{note_id}", response_model=NoteRead)
+def get_note(note_id: int) -> NoteRead:
+    return NoteRead()

package/corpus/backend/policy_refs_resolve/compliant-01/modules/notes/module.py

@@ -0,0 +1,7 @@
+from terp.core import ModuleSpec, Policy, Roles
+
+spec = ModuleSpec(
+    name="notes",
+    router=router,
+    policy=Policy(read=Roles.VIEWER, write=Roles.EDITOR),
+)

package/corpus/backend/policy_refs_resolve/violation-01/modules/notes/module.py

@@ -0,0 +1,8 @@
+from control_plane import permissions as perms
+from terp.core import ModuleSpec, Policy
+
+spec = ModuleSpec(
+    name="notes",
+    router=router,
+    policy=Policy(read=perms.NOTES_READ, write=perms.NOTES_WRITE),
+)

package/corpus/backend/public_modules_are_read_only/compliant-01/modules/notes/module.py

@@ -0,0 +1,7 @@
+from terp.core import ModuleSpec, Policy
+
+spec = ModuleSpec(
+    name="notes",
+    router=router,
+    policy=Policy.public(reason="published notes are world-readable"),
+)

package/corpus/backend/public_modules_are_read_only/compliant-01/modules/notes/router.py

@@ -0,0 +1,3 @@
+@router.get('/', response_model=Page[NoteRead])
+def list_notes() -> Page[NoteRead]:
+    return Page()

package/corpus/backend/public_modules_are_read_only/violation-01/expected-findings.json

@@ -0,0 +1,7 @@
+[
+  {
+    "rule": "backend/public_modules_are_read_only",
+    "path": "modules/notes/module.py",
+    "line": 6
+  }
+]

package/corpus/backend/public_modules_are_read_only/violation-01/modules/notes/module.py

@@ -0,0 +1,7 @@
+from terp.core import ModuleSpec, Policy
+
+spec = ModuleSpec(
+    name="notes",
+    router=router,
+    policy=Policy.public(reason="published notes are world-readable"),
+)

package/corpus/backend/public_modules_are_read_only/violation-01/modules/notes/router.py

@@ -0,0 +1,3 @@
+@router.post('/', response_model=NoteRead)
+def create_note(payload) -> NoteRead:
+    return NoteRead()

package/corpus/backend/public_modules_are_read_only/violation-02/expected-findings.json

@@ -0,0 +1,7 @@
+[
+  {
+    "rule": "backend/public_modules_are_read_only",
+    "path": "modules/notes/module.py",
+    "line": 6
+  }
+]

package/corpus/backend/public_modules_are_read_only/violation-02/modules/notes/module.py

@@ -0,0 +1,7 @@
+from terp.core import ModuleSpec, Policy
+
+spec = ModuleSpec(
+    name="notes",
+    router=router,
+    policy=Policy.public(reason="published notes are world-readable"),
+)

package/corpus/backend/public_modules_are_read_only/violation-02/modules/notes/router.py

@@ -0,0 +1,5 @@
+def purge_note(note_id):
+    return None
+
+
+router.add_api_route("/{note_id}", purge_note, methods=["DELETE"])

package/corpus/backend/reads_use_base_query/compliant-01/modules/notes/models.py

@@ -0,0 +1,6 @@
+from sqlmodel import Field
+from terp.core import BaseTable, SoftDeleteMixin
+
+
+class Note(BaseTable, SoftDeleteMixin, table=True):
+    slug: str = Field(max_length=80)

package/corpus/backend/reads_use_base_query/compliant-01/modules/notes/service.py

@@ -0,0 +1,8 @@
+from terp.core import BaseService
+
+
+class NoteService(BaseService):
+    model = Note
+
+    def find_by_slug(self, session, slug):
+        return session.exec(self.base_query().where(Note.slug == slug)).first()

package/corpus/backend/reads_use_base_query/compliant-02/modules/notes/models.py

@@ -0,0 +1,9 @@
+from sqlmodel import Field
+from terp.core import BaseTable
+
+
+class Tag(BaseTable, table=True):
+    """No scope trait (SoftDeleteMixin / TenantScopedMixin) — a raw select
+    of an unscoped model drops no row scope and is not policed."""
+
+    label: str = Field(max_length=40)

package/corpus/backend/reads_use_base_query/compliant-02/modules/notes/service.py

@@ -0,0 +1,9 @@
+from sqlmodel import select
+from terp.core import BaseService
+
+
+class TagService(BaseService):
+    model = Tag
+
+    def find_by_label(self, session, label):
+        return session.exec(select(Tag).where(Tag.label == label)).first()

package/corpus/backend/reads_use_base_query/violation-01/modules/notes/models.py

@@ -0,0 +1,6 @@
+from sqlmodel import Field
+from terp.core import BaseTable, SoftDeleteMixin
+
+
+class Note(BaseTable, SoftDeleteMixin, table=True):
+    slug: str = Field(max_length=80)

package/corpus/backend/reads_use_base_query/violation-01/modules/notes/service.py

@@ -0,0 +1,9 @@
+from sqlmodel import select
+from terp.core import BaseService
+
+
+class NoteService(BaseService):
+    model = Note
+
+    def find_by_slug(self, session, slug):
+        return session.exec(select(Note).where(Note.slug == slug)).first()

package/corpus/backend/reads_use_base_query/violation-02/expected-findings.json

@@ -0,0 +1,7 @@
+[
+  {
+    "rule": "backend/reads_use_base_query",
+    "path": "modules/notes/service.py",
+    "line": 8
+  }
+]

package/corpus/backend/reads_use_base_query/violation-02/modules/notes/models.py

@@ -0,0 +1,6 @@
+from sqlmodel import Field
+from terp.core import BaseTable, SoftDeleteMixin
+
+
+class Note(BaseTable, SoftDeleteMixin, table=True):
+    slug: str = Field(max_length=80)

package/corpus/backend/reads_use_base_query/violation-02/modules/notes/service.py

@@ -0,0 +1,8 @@
+from terp.core import BaseService
+
+
+class NoteService(BaseService):
+    model = Note
+
+    def load(self, session, note_id):
+        return session.get(Note, note_id)

package/corpus/backend/response_model_not_table_model/compliant-01/modules/notes/models.py

@@ -0,0 +1,6 @@
+from sqlmodel import Field
+from terp.core import BaseTable
+
+
+class Note(BaseTable, table=True):
+    title: str = Field(max_length=200)

package/corpus/backend/response_model_not_table_model/compliant-01/modules/notes/router.py

@@ -0,0 +1,3 @@
+@router.get('/{note_id}', response_model=NoteRead)
+def get_note(note_id) -> NoteRead:
+    return _service.get(note_id)

package/corpus/backend/response_model_not_table_model/compliant-01/modules/notes/schemas.py

@@ -0,0 +1,5 @@
+from terp.core import BaseSchema
+
+
+class NoteRead(BaseSchema):
+    title: str

package/corpus/backend/response_model_not_table_model/violation-01/modules/notes/models.py

@@ -0,0 +1,6 @@
+from sqlmodel import Field
+from terp.core import BaseTable
+
+
+class Note(BaseTable, table=True):
+    title: str = Field(max_length=200)

package/corpus/backend/response_model_not_table_model/violation-01/modules/notes/router.py

@@ -0,0 +1,3 @@
+@router.get('/{note_id}', response_model=Note)
+def get_note(note_id) -> Note:
+    return _service.get(note_id)

package/corpus/backend/routes_declare_response_model/compliant-01/modules/notes/router.py

@@ -0,0 +1,8 @@
+@router.get('/', response_model=Page[NoteRead])
+def list_notes() -> Page[NoteRead]:
+    return Page()
+
+
+@router.delete('/{note_id}', status_code=204)
+def delete_note(note_id) -> None:
+    _service.delete(note_id)

package/corpus/backend/routes_declare_response_model/violation-01/modules/notes/router.py

@@ -0,0 +1,3 @@
+@router.get('/')
+def list_notes():
+    return notes

package/corpus/backend/safe_methods_are_read_only/compliant-01/modules/notes/router.py

@@ -0,0 +1,6 @@
+@router.get('/', response_model=Page[NoteRead])
+def list_notes() -> Page[NoteRead]:
+    return service.list()
+@router.post('/', response_model=NoteRead)
+def create_note(payload) -> NoteRead:
+    return service.create(payload)

package/corpus/backend/safe_methods_are_read_only/compliant-02/modules/notes/router.py

@@ -0,0 +1,5 @@
+@router.get('/stats', response_model=NoteStats)
+def note_stats(filters):
+    merged = {}
+    merged.update(filters)
+    return NoteStats(**merged)

package/corpus/backend/safe_methods_are_read_only/violation-01/expected-findings.json

@@ -0,0 +1,7 @@
+[
+  {
+    "rule": "backend/safe_methods_are_read_only",
+    "path": "modules/notes/router.py",
+    "line": 3
+  }
+]

package/corpus/backend/safe_methods_are_read_only/violation-01/modules/notes/router.py

@@ -0,0 +1,3 @@
+@router.get('/refresh', response_model=NoteRead)
+def refresh_note(payload) -> NoteRead:
+    return service.update(payload)

package/corpus/backend/safe_methods_are_read_only/violation-02/expected-findings.json

@@ -0,0 +1,7 @@
+[
+  {
+    "rule": "backend/safe_methods_are_read_only",
+    "path": "modules/notes/router.py",
+    "line": 2
+  }
+]

package/corpus/backend/safe_methods_are_read_only/violation-02/modules/notes/router.py

@@ -0,0 +1,5 @@
+def cleanup_notes(payload):
+    return service.delete(payload)
+
+
+router.add_api_route("/cleanup", cleanup_notes, methods=["GET"])

package/corpus/backend/safe_methods_are_read_only/violation-03/expected-findings.json

@@ -0,0 +1,7 @@
+[
+  {
+    "rule": "backend/safe_methods_are_read_only",
+    "path": "modules/notes/router.py",
+    "line": 3
+  }
+]

package/corpus/backend/safe_methods_are_read_only/violation-03/modules/notes/router.py

@@ -0,0 +1,3 @@
+@router.api_route('/sync', methods=['GET', 'POST'])
+def sync_notes(payload):
+    return store._remove(payload)

package/corpus/backend/schemas_exclude_sensitive_fields/compliant-01/modules/users/schemas.py

@@ -0,0 +1,5 @@
+class UserCreate(BaseSchema):
+    password: str = Field(max_length=128)
+class UserRead(BaseSchema):
+    id: uuid.UUID
+    token_version: int

package/corpus/backend/schemas_exclude_sensitive_fields/compliant-02/modules/accounts/schemas.py

@@ -0,0 +1,12 @@
+from sqlmodel import Field
+from terp.core import BaseSchema, BaseTable
+
+
+class AccountRead(BaseSchema):
+    passwordless: bool
+    tokens_issued: int
+    secretive_mode: bool
+
+
+class Account(BaseTable, table=True):
+    hashed_password: str = Field(max_length=200)

package/corpus/backend/schemas_exclude_sensitive_fields/violation-01/expected-findings.json

@@ -0,0 +1,7 @@
+[
+  {
+    "rule": "backend/schemas_exclude_sensitive_fields",
+    "path": "modules/users/schemas.py",
+    "line": 3
+  }
+]

package/corpus/backend/schemas_exclude_sensitive_fields/violation-01/modules/users/schemas.py

@@ -0,0 +1,3 @@
+class UserRead(BaseSchema):
+    id: uuid.UUID
+    hashed_password: str

package/corpus/backend/schemas_exclude_sensitive_fields/violation-02/expected-findings.json

@@ -0,0 +1,7 @@
+[
+  {
+    "rule": "backend/schemas_exclude_sensitive_fields",
+    "path": "modules/connectors/router.py",
+    "line": 3
+  }
+]

package/corpus/backend/schemas_exclude_sensitive_fields/violation-02/modules/connectors/router.py

@@ -0,0 +1,8 @@
+class ConnectorStatus:
+    name: str
+    api_key: str
+
+
+@router.get('/status', response_model=ConnectorStatus)
+def connector_status() -> ConnectorStatus:
+    return ConnectorStatus()

package/corpus/backend/schemas_exclude_sensitive_fields/violation-03/expected-findings.json

@@ -0,0 +1,17 @@
+[
+  {
+    "rule": "backend/schemas_exclude_sensitive_fields",
+    "path": "modules/integrations/schemas.py",
+    "line": 5
+  },
+  {
+    "rule": "backend/schemas_exclude_sensitive_fields",
+    "path": "modules/integrations/schemas.py",
+    "line": 6
+  },
+  {
+    "rule": "backend/schemas_exclude_sensitive_fields",
+    "path": "modules/integrations/schemas.py",
+    "line": 7
+  }
+]

package/corpus/backend/schemas_exclude_sensitive_fields/violation-03/modules/integrations/schemas.py

@@ -0,0 +1,7 @@
+from terp.core import BaseSchema
+
+
+class IntegrationRead(BaseSchema):
+    client_secret: str
+    private_key: str
+    refresh_token: str