Replace the full-catalog integration tests with selected folders of the installed models

Cerrado
#4,149 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Ya se ha fusionado un pull request relacionado.

  • #4150 de @anth-volk — fusionado

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
github-actions, postgresql, python

Línea de trabajo

Start with .github/workflows/v2-integration-check.yml and the two named full-catalog tests; review tests/fixtures/v2_catalog.py to understand the existing fixture. Add pull-request coverage for the specified value shapes in PostgreSQL, and isolate the full-catalog tests behind the described change-path conditions, nightly schedule, and manual dispatch. Done means the lightweight checks run on every pull request, the full tests run when required, and the linked pull request indicates this work is already underway.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Problem

The check "Cross-database integration tests / MySQL, PostgreSQL, and Redis integration" (job catalog-runtime-integration in .github/workflows/v2-integration-check.yml) took 7 to 38 minutes over the last 12 successful pull request runs, with no code change between them; the spread follows the runner that picks the job up. With "Test" split into shards, it becomes the longest pull request job.

Two steps take 85 to 90% of the job. Each loads the complete installed PolicyEngine.py catalog (extract_installed_catalog(), about 1.2 million parameter values) in its own process:

  • "Verify the installed PolicyEngine.py catalog interface" (tests/integration/test_v2_catalog_installed.py): 363 s on run 41067605238, about 120 s on a fast runner.
  • "Qualify production-scale v2 metadata publication" (tests/integration/test_v2_catalog_publication_qualification.py): 1,157 s on the same run, about 180 s on a fast runner.

Their outcome can change only when the installed packages, the catalog code, the v2 schema or the tests themselves change. Every other pull request repeats them for nothing.

The small catalog fixture the other publication tests use (tests/fixtures/v2_catalog.py) holds two parameter values, both plain numbers, so a pull request that skipped the full catalog would not check how PostgreSQL stores the other value shapes extraction accepts.

Change

  1. Add a small catalog of deliberately chosen edge cases (one parameter value of each shape extraction accepts, bracket parameters, open-ended and one-day date ranges, region filters), publish it to PostgreSQL on every pull request, and assert that each value comes back unchanged.
  2. Move the two full-catalog tests into their own job in the same workflow, loading the catalog once for both, with runner diagnostics (nproc, free -m, lscpu) and --durations=10.
  3. In that job, compare the commit with the pull request's base (or the previous push) and run the full-catalog tests only when the change touches uv.lock, pyproject.toml, the catalog code, the catalog's database models, the v2 migrations, the two tests or the workflow. The job itself always runs and passes, so "CI complete" and the release run's check of the merge run keep working.
  4. Run the full-catalog tests every night and on manual dispatch.

Each release still publishes the full catalog to staging and production (seed-v2-database.yml) before it deploys.

Lenguaje dominante
Python
Estrellas
18
Forks
33
Merge medio
2 d 9 h
PR fusionados (30 d)
77

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de PolicyEngine/policyengine-api

Todos los issues de PolicyEngine/policyengine-api

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.