Flaky pydap network tests due to `test.opendap.org` outages

Abierto
#11,718 6 comentarios 1 reacción 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
22/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
docker, python
Área
ci-cd, testing

Línea de trabajo

The network tests that depend on test.opendap.org are in the pydap test modules, including TestPyDAPDatatreeIO in test_datatree.py, which uses the three /opendap/dap4/ files. The open question is which of the five options to adopt, so read the thread before writing code. Using the unaligned_datatree_nc fixture and the code near line 499 as a reference, check whether CI can generate the datatree files locally. Done means a maintainer has chosen an approach and the flaky job no longer fails on server outages.

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

Descripción

Automation CI needs discussion topic-testing
What is your issue?

The pydap network tests depend on the public test.opendap.org server. Whenever that server is unreachable or returns errors (e.g. HTTP 503), the flaky/network CI job fails for unrelated PRs.

Some options:

  1. Run our own OPeNDAP server in CI. OPeNDAP publishes the server behind test.opendap.org as a Docker image (opendap/hyrax). Most of the test data is already in the image, and the rest could be added in CI. The tests would then read the server URL from an environment variable that defaults to test.opendap.org. The downside is a large image (~1.4 GB) and some extra CI setup.
  2. Use pydap's built-in server. Start pydap[server] from a pytest fixture with local files. This is lightweight, but as far as I can tell it doesn't serve DAP4 data responses, so it would only cover part of the tests.
  3. Record and replay HTTP responses. Store the server responses in the repo (e.g. with vcrpy/pytest-recording) and replay them in the tests. This is fast and needs no network, but the recordings need refreshing and wouldn't catch server-side changes.
  4. Skip when the server is unavailable. Check reachability once in a fixture and skip the tests if the server is down. This is the simplest option, but the tests silently stop running during outages.
  5. Move the tests to a scheduled job. Run them nightly instead of on every PR, so outages don't block PRs. Breakages would only show up later, though.

I think 1. could be feasable. Some things to consider:

  • Maybe we should mirror the dockerhub image to ghcr.
  • Not sure how to handle hyrax updates (another CI to update those?)
  • Caching is probably not worth
  • Not covered yet: the datatree tests (TestPyDAPDatatreeIO in test_datatree.py) use three files under /opendap/dap4/ that the image doesn't include:
    • SimpleGroup.nc4.h5: in OPeNDAP's server repo at modules/hdf5_handler/data/ (30 KB). We could commit it or download it in CI.
    • unaligned_simple_datatree.nc.h5 and all_aligned_child_nodes.nc.h5: these look like custom uploads to the public server. test_datatree.py already builds equivalent files locally (the unaligned_datatree_nc fixture and the code at line 499). Since the tests only check structure, CI could generate them before starting the container.
Lenguaje dominante
Python
Estrellas
4.2k
Forks
1.5k
Merge medio
2 d 21 h
PR fusionados (30 d)
74

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

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 pydata/xarray

Todos los issues de pydata/xarray

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.