galaxyproject / galaxyproject/tools-iuc

Testing using paths with spaces

Open
#577 5 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
201
Forks
525
Avg merge
23h 54m
Merged PRs (30d)
59

Description

Spin out from discussion on #455 where is is good practice to defensively quote path and filenames in the `` template (etc?) when wrapping tools. This intended to cope with the corner case where Galaxy or one of the working folders has been setup using a directory name with a space.

While we recognise using spaces in directories is a bad idea given how command line parsing works, and expect that many Galaxy tools will break in this situation (perhaps also parts of Galaxy), it would be nice for `tools-iuc` to illustrate best practise guidelines by quoting filenames/paths.

This issue is about deliberately including such paths in any automated testing for `tools-iuc`, e.g. using Travis https://github.com/galaxyproject/tools-iuc/tree/travis

Assuming Galaxy copes, we could tweak the Travis (etc) setup to install all of Galaxy on a path with a space. Otherwise we could try just set a few key paths, e.g. maybe:

```
job_working_directory = database/job working directory
```

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Travis setup at the linked tools-iuc/travis tree and the discussion in issue #455. Determine whether Galaxy can be installed or configured under a path containing spaces, then add automated coverage for such paths and verify that the Travis setup passes with the new configuration.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.