Added test_nothing nf-test and updated CI #1632
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: nf-core CI | |
# This workflow runs the pipeline with the minimal test dataset to check that it completes without any syntax errors | |
on: | |
push: | |
branches: | |
- dev | |
pull_request: | |
release: | |
types: [published] | |
env: | |
NXF_ANSI_LOG: false | |
NFT_VER: "0.8.4" | |
NFT_WORKDIR: "~" | |
NFT_DIFF: "pdiff" | |
NFT_DIFF_ARGS: "--line-numbers --expand-tabs=2" | |
concurrency: | |
group: "${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}" | |
cancel-in-progress: true | |
jobs: | |
test: | |
name: Run pipeline with test data | |
# Only run on push if this is the nf-core dev branch (merged PRs) | |
if: "${{ github.event_name != 'push' || (github.event_name == 'push' && github.repository == 'nf-core/mag') }}" | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
NXF_VER: | |
- "23.04.0" | |
- "latest-everything" | |
steps: | |
- name: Free some space | |
run: | | |
sudo rm -rf "/usr/local/share/boost" | |
sudo rm -rf "$AGENT_TOOLSDIRECTORY" | |
- name: Check out pipeline code | |
uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4 | |
- name: Install Nextflow | |
uses: nf-core/setup-nextflow@v2 | |
with: | |
version: "${{ matrix.NXF_VER }}" | |
- name: Disk space cleanup | |
uses: jlumbroso/free-disk-space@54081f138730dfa15788a46383842cd2f914a1be # v1.3.1 | |
- name: Run pipeline with test data | |
run: | | |
nextflow run ${GITHUB_WORKSPACE} -profile test,docker --outdir ./results | |
profiles: | |
name: Run workflow profile | |
# Only run on push if this is the nf-core dev branch (merged PRs) | |
if: ${{ github.event_name != 'push' || (github.event_name == 'push' && github.repository == 'nf-core/mag') }} | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
# Run remaining test profiles with minimum nextflow version | |
profile: | |
[ | |
test_host_rm, | |
test_hybrid, | |
test_hybrid_host_rm, | |
test_busco_auto, | |
test_ancient_dna, | |
test_adapterremoval, | |
test_binrefinement, | |
test_virus_identification, | |
test_single_end, | |
test_concoct, | |
] | |
steps: | |
- name: Free some space | |
run: | | |
sudo rm -rf "/usr/local/share/boost" | |
sudo rm -rf "$AGENT_TOOLSDIRECTORY" | |
- name: Check out pipeline code | |
uses: actions/checkout@v2 | |
- name: Install Nextflow | |
run: | | |
wget -qO- get.nextflow.io | bash | |
sudo mv nextflow /usr/local/bin/ | |
- name: Run pipeline with ${{ matrix.profile }} test profile | |
run: | | |
nextflow run ${GITHUB_WORKSPACE} -profile ${{ matrix.profile }},docker --outdir ./results | |
checkm: | |
name: Run single test to checkm due to database download | |
# Only run on push if this is the nf-core dev branch (merged PRs) | |
if: ${{ github.event_name != 'push' || (github.event_name == 'push' && github.repository == 'nf-core/mag') }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: Free some space | |
run: | | |
sudo rm -rf "/usr/local/share/boost" | |
sudo rm -rf "$AGENT_TOOLSDIRECTORY" | |
- name: Check out pipeline code | |
uses: actions/checkout@v2 | |
- name: Install Nextflow | |
run: | | |
wget -qO- get.nextflow.io | bash | |
sudo mv nextflow /usr/local/bin/ | |
- name: Download and prepare CheckM database | |
run: | | |
mkdir -p databases/checkm | |
wget https://data.ace.uq.edu.au/public/CheckM_databases/checkm_data_2015_01_16.tar.gz -P databases/checkm | |
tar xzvf databases/checkm/checkm_data_2015_01_16.tar.gz -C databases/checkm/ | |
- name: Run pipeline with ${{ matrix.profile }} test profile | |
run: | | |
nextflow run ${GITHUB_WORKSPACE} -profile test,docker --outdir ./results --binqc_tool checkm --checkm_db databases/checkm | |
# Adam and Carson's method for running only necessary nf-tests | |
changes: | |
name: Check for changes | |
runs-on: ubuntu-latest | |
outputs: | |
nf_test_files: ${{ steps.list.outputs.components }} | |
steps: | |
- uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
- name: List nf-test files | |
id: list | |
uses: adamrtalbot/[email protected] | |
with: | |
head: ${{ github.sha }} | |
base: origin/${{ github.base_ref }} | |
include: .github/include.yaml | |
- name: print list of nf-test files | |
run: | | |
echo ${{ steps.list.outputs.components }} | |
nf-test: | |
name: ${{ matrix.nf_test_files }} ${{ matrix.profile }} NF-${{ matrix.NXF_VER }} | |
needs: [changes] | |
if: needs.changes.outputs.nf_test_files != '[]' | |
runs-on: ubuntu-latest | |
strategy: | |
fail-fast: false | |
matrix: | |
NXF_VER: | |
- "latest-everything" | |
- "23.04" | |
nf_test_files: ["${{ fromJson(needs.changes.outputs.nf_test_files) }}"] | |
profile: | |
- "docker" | |
steps: | |
- name: Check out pipeline code | |
uses: actions/checkout@v4 | |
- name: Install Nextflow | |
uses: nf-core/setup-nextflow@v2 | |
with: | |
version: "${{ matrix.NXF_VER }}" | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: "3.11" | |
architecture: "x64" | |
- name: Install pdiff to see diff between nf-test snapshots | |
run: | | |
python -m pip install --upgrade pip | |
pip install pdiff | |
- name: Cache nf-test installation | |
id: cache-software | |
uses: actions/cache@v3 | |
with: | |
path: | | |
/usr/local/bin/nf-test | |
/home/runner/.nf-test/nf-test.jar | |
key: ${{ runner.os }}-${{ env.NFT_VER }}-nftest | |
- name: Install nf-test | |
if: steps.cache-software.outputs.cache-hit != 'true' | |
run: | | |
wget -qO- https://code.askimed.com/install/nf-test | bash | |
sudo mv nf-test /usr/local/bin/ | |
- name: Run nf-test | |
run: | | |
nf-test test --verbose ${{ matrix.nf_test_files }} --profile "+${{ matrix.profile }}" --junitxml=test.xml --tap=test.tap | |
- uses: pcolby/tap-summary@v1 | |
with: | |
path: >- | |
test.tap | |
- name: Output log on failure | |
if: failure() | |
run: | | |
sudo apt install bat > /dev/null | |
batcat --decorations=always --color=always ${{ github.workspace }}/.nf-test/tests/*/meta/nextflow.log | |
- name: Publish Test Report | |
uses: mikepenz/action-junit-report@v3 | |
if: always() # always run even if the previous step fails | |
with: | |
report_paths: test.xml | |
confirm-pass: | |
runs-on: ubuntu-latest | |
needs: | |
- changes | |
- nf-test | |
if: always() | |
steps: | |
- name: All tests ok | |
if: ${{ !contains(needs.*.result, 'failure') }} | |
run: exit 0 | |
- name: One or more tests failed | |
if: ${{ contains(needs.*.result, 'failure') }} | |
run: exit 1 | |
- name: debug-print | |
if: always() | |
run: | | |
echo "toJSON(needs) = ${{ toJSON(needs) }}" | |
echo "toJSON(needs.*.result) = ${{ toJSON(needs.*.result) }}" |