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

Đang mở
#11,718 6 bình luận 1 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
22/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
docker, python
Lĩnh vực
ci-cd, testing

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
Python
Star
4.2k
Fork
1.5k
Merge trung bình
2 ngày 21 giờ
Pull request đã merge (30 ngày)
74

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của pydata/xarray

Tất cả issue của pydata/xarray

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.