nf-core / nf-core/tools

Tests are slow due to too many web queries and limits set by web resources

Open
#1,697 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement infrastructure
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

Description of feature

Many tests will pull form the github repo. 55 in total. This means running the tests once already pulls 55 times, running them repeatedly every couple of minutes over the course of a day apparently isn't well appreciated by github. There are other connections, too, that are done by the tests: refgenie 1x, nf-co.re 12x, api.github.com 1x, pypi.org 2x.

The repeated pulls make the tests slow and repeating the pull can probably be avoided for many tests. One pull, should be enough, and the resulting directory used could e.g. just be copied locally. It would even be nice to have the tests be mostly reduced to local folders. Git supports local repos and as such it might be possible to have the complete test suite contained in this project. After all, if we allow arbitrary git repos, it should not be restricted to repos available over http(s).

There might be some parts of the code that might have to be adapted to allow local folders as resources.

E           git.exc.GitCommandError: Cmd('git') failed due to: exit code(1)
E             cmdline: git pull -v --progress origin
E             stderr: 'fatal: unable to access 'https://github.com/nf-core/modules.git/': Could not resolve host: github.com'

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named in the issue. Start by locating the tests that access GitHub, refgenie, nf-co.re, the GitHub API, and PyPI, then trace how repository resources are fetched. Done should mean the suite avoids unnecessary repeated remote pulls and can use local repositories or folders where appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github, python
Domain
testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.