You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We need to broaden our test suite to ensure reliability and consistency across multiple areas of the project. The following tests should be added or expanded:
Docker Tests
Validate that running the pipeline or individual commands inside our Docker container works as expected.
Include at least one end-to-end test using Docker (e.g., mounting local data, running a pipeline command, verifying output).
API Tests
If we have an API layer, confirm endpoint functionality (e.g., job submission, status checking, result retrieval).
Ensure JSON responses, error handling, and edge cases are tested.
CLI Tests with adVNTR
Confirm that --extra-modules advntr works correctly.
Verify that relevant output files (e.g., output_adVNTR_result.tsv) are generated.
Test new or existing parameters for the adVNTR module (e.g., --advntr-max-coverage).
Subcommand Tests
Cover each subcommand (pipeline, report, cohort, online, etc.) with at least one basic run-through.
Test optional arguments (e.g., --keep-intermediates, --archive-results) to confirm files are retained or removed as expected.
Parameter Combinations
Run tests that toggle various flags: --keep-intermediates, --delete-intermediates, --fast-mode, etc.
Confirm that the required files are present or deleted after each run, depending on the parameters.
Additional FASTQ Cases
Add a second FASTQ example to confirm robust handling.
Include a FASTQ test without the Shark module (e.g., no --extra-modules shark) to confirm the pipeline still runs normally.
Acceptance Criteria:
Docker
At least one test that builds/pulls the Docker image, runs the pipeline, and verifies success.
API
Confirm endpoints respond with correct statuses, handle invalid inputs gracefully, and generate valid JSON outputs.
CLI + adVNTR
A test scenario that runs vntyper pipeline --extra-modules advntr with a known input and verifies correct adVNTR output.
Subcommands
Each subcommand (pipeline, report, cohort, online) has at least one passing test scenario.
Parameter Matrix
Tests that toggle various command-line arguments and confirm the presence or absence of intermediate or final files.
Additional FASTQ Scenarios
At least one new test using an alternate FastQ dataset.
Confirm pipeline runs fine with no Shark filtering if --extra-modules shark is omitted.
The text was updated successfully, but these errors were encountered:
berntpopp
changed the title
test: expand test coverage for Docker, API, CLI subcommands, and various parameter combos
Test: expand test coverage for Docker, API, CLI subcommands, and various parameter combos
Dec 25, 2024
We need to broaden our test suite to ensure reliability and consistency across multiple areas of the project. The following tests should be added or expanded:
Docker Tests
API Tests
CLI Tests with adVNTR
--extra-modules advntr
works correctly.output_adVNTR_result.tsv
) are generated.--advntr-max-coverage
).Subcommand Tests
pipeline
,report
,cohort
,online
, etc.) with at least one basic run-through.--keep-intermediates
,--archive-results
) to confirm files are retained or removed as expected.Parameter Combinations
--keep-intermediates
,--delete-intermediates
,--fast-mode
, etc.Additional FASTQ Cases
--extra-modules shark
) to confirm the pipeline still runs normally.Acceptance Criteria:
Docker
API
CLI + adVNTR
vntyper pipeline --extra-modules advntr
with a known input and verifies correct adVNTR output.Subcommands
pipeline
,report
,cohort
,online
) has at least one passing test scenario.Parameter Matrix
Additional FASTQ Scenarios
--extra-modules shark
is omitted.The text was updated successfully, but these errors were encountered: