Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Add tests for --is_private flag for different kinds of data

Đang mở
  • Có gì không ổn?
#80 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

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

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
55/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Lĩnh vực
testing-qa

Hướng nghiên cứu

Bắt đầu với phần Data privacy trong docs/usage.md, sau đó kiểm tra các conf/test_.config hiện có, các sheet mẫu và các pattern trong tests/.nf.test dành cho reads, các assembly metagenomic và MAGs/bins. Hãy hỏi một maintainer về các Webin accession private phù hợp trước khi tạo các test. Hoàn thành khi mỗi loại dữ liệu đều bao phủ dữ liệu nguồn private với --is_private và trường hợp lỗi đã được ghi trong tài liệu khi không dùng nó.

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

Mô tả

enhancement

Difficulty: Easy

Why this matters: ENA (European Nucleotide Archive) lets you build a submission on top of data that isn't public yet, as long as your Webin account has access to it. The pipeline supports this through --is_private. There's currently no automated test covering this for any of the three submission types (reads, metagenomic assemblies, MAGs/bins), so a bug in this part of the pipeline could slip through unnoticed.

Some terms: ENA (European Nucleotide Archive) is the public repository this pipeline submits data to. Webin is ENA's account and authentication system, you need a Webin account to submit anything, and registration is free and self-service. "Private data" means data that has been submitted to ENA but isn't publicly visible yet, only accessible to the Webin account that submitted it (or one it's been shared with). docs/usage.md has a "Data privacy" section with a table of the different combinations (public/private source data, public/private submission) and which flags each one needs, that table is the best starting point.

Skills / experience: nf-test: creation and running of tests (see the nf-core nf-test testing guide if this is new to you).

Suggested approach:

  1. Read the "Data privacy" section of docs/usage.md closely, this is the main reference for what --is_private does and when it's needed.
  2. For each of the three data types (reads, metagenomic assemblies, MAGs/bins), add a test that references private source data with --is_private set. No need to also test private vs public submission visibility, just focus on getting private source data covered for all three types.
  3. ** ⭐ You'll need actual private test data already submitted under a Webin test account for this, check with a maintainer whether suitable private accessions already exist, or if you need to submit some first.**
  4. Add a conf/test_*.config per data type and a sample sheet that uses registered private accessions, following the pattern of the existing ones.
  5. Add a matching tests/*.nf.test per data type.
  6. Also worth testing the failure case: private source data referenced without --is_private should fail, as described in the docs table.
Ngôn ngữ chính
Nextflow
Star
22
Fork
11
Merge trung bình
2 ngày 5 giờ
Pull request đã merge (30 ngày)
10

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 nf-core/seqsubmit

Tất cả issue của nf-core/seqsubmit

Issue tương tự

Thêm issue về Testing & QA

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.