Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add test summary status check, handle missing tests #25

Merged
merged 3 commits into from
Mar 8, 2024

Conversation

nwiltsie
Copy link
Member

@nwiltsie nwiltsie commented Mar 8, 2024

Description

This adds a summary Nextflow configuration test job that reports the summary status of all of the discovered tests (closes #17). It reports success if no jobs were discovered (closes #18).

No tests found

Screenshot 2024-03-08 at 12 54 43 PM

All tests pass

Screenshot 2024-03-08 at 12 46 57 PM

Tests fail

Screenshot 2024-03-08 at 12 45 14 PM

I specifically tested the ordering of multiple failures / successes and confirmed that there is no race condition - the last test does not stomp over previous results.

References:
https://github.com/orgs/community/discussions/42010
https://github.com/orgs/community/discussions/26639

Checklist

  • This PR does NOT contain Protected Health Information (PHI). A repo may need to be deleted if such data is uploaded.
    Disclosing PHI is a major problem1 - Even a small leak can be costly2.

  • This PR does NOT contain germline genetic data3, RNA-Seq, DNA methylation, microbiome or other molecular data4.

  • This PR does NOT contain other non-plain text files, such as: compressed files, images (e.g. .png, .jpeg), .pdf, .RData, .xlsx, .doc, .ppt, or other output files.

  To automatically exclude such files using a .gitignore file, see here for example.

  • I have read the code review guidelines and the code review best practice on GitHub check-list.

  • I have set up or verified the main branch protection rule following the github standards before opening this pull request.

  • The name of the branch is meaningful and well formatted following the standards, using [AD_username (or 5 letters of AD if AD is too long)]-[brief_description_of_branch].

  • I have added the major changes included in this pull request to the CHANGELOG.md under the next release version or unreleased, and updated the date.

Footnotes

  1. UCLA Health reaches $7.5m settlement over 2015 breach of 4.5m patient records

  2. The average healthcare data breach costs $2.2 million, despite the majority of breaches releasing fewer than 500 records.

  3. Genetic information is considered PHI.
    Forensic assays can identify patients with as few as 21 SNPs

  4. RNA-Seq, DNA methylation, microbiome, or other molecular data can be used to predict genotypes (PHI) and reveal a patient's identity.

@nwiltsie nwiltsie requested a review from a team March 8, 2024 21:48
Copy link
Contributor

@yashpatel6 yashpatel6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@nwiltsie nwiltsie merged commit 466d426 into main Mar 8, 2024
1 check passed
@nwiltsie nwiltsie deleted the nwiltsie-workflow-summary branch March 8, 2024 22:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Handle case where no tests are discovered Make summary check suitable for blocking PRs
2 participants