Skip to content

Commit 42bb1b3

Browse files
committed
ci: adjust to and rename extra-args.yaml to test-extra-args.yaml
I misunderstood extra-args.yaml to be a file that was recognized by repo2docker's CLI, but in reality it was just a file recognized by the repo2docker test suite. Following that, I renamed this testing specific file to test-extra-args.yaml to help others avoid making that mistake and added comments to clarify that. This commit also gathers the conda buildpacks separate readme files into a single readme file.
1 parent a6af244 commit 42bb1b3

File tree

17 files changed

+65
-48
lines changed

17 files changed

+65
-48
lines changed

tests/conda/README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Overview of tests for the conda buildpack
2+
3+
## py2
4+
5+
- Test setup of a Python 2 environment by declaring `python=2` in
6+
`environment.yml`.
7+
8+
## py35-binder-dir
9+
10+
- Test setup of a Python 3.5 environment by declaring `python=3.5` in
11+
`environment.yml`.
12+
13+
The reasons for testing 3.5 specifically is that it is the oldest version of
14+
Python 3 supported by repo2docker's conda buildpack. See
15+
`repo2docker/buildpacks/conda` for details.
16+
17+
- Test use of a `.binder` directory, where files outside it shouldn't be
18+
considered. See [this documentation](https://repo2docker.readthedocs.io/en/latest/usage.html#where-to-put-configuration-files)
19+
for details.
20+
21+
## py310-requirements-file
22+
23+
- Test setup of a Python 3.10 environment by declaring `python=3.10` in
24+
`environment.yml`.
25+
26+
The reasons for testing 3.10 specifically is that it is the newest version of
27+
Python 3 supported by repo2docker's conda buildpack. See
28+
`repo2docker/buildpacks/conda` for details.
29+
30+
- Test use of a `requirements.txt` file, where an `environment.yml` file should
31+
take precedence and the `requirements.txt` should be ignored.
32+
33+
## r-postbuild-file
34+
35+
- Test setup of the default Python environment by omitting `python` from
36+
`environment.yml` file.
37+
38+
- Test setup of the default R environment by specifying `r-base` in
39+
`environment.yml`.
40+
41+
- Test use of a `postBuild` file. See [this documentation](https://repo2docker.readthedocs.io/en/latest/config_files.html#postbuild-run-code-after-installing-the-environment)
42+
for details.
43+
44+
## r3.6-target-repo-dir-flag
45+
46+
- Test setup of a R 3.6 environment by specifying `r-base=3.6` in
47+
`environment.yml`.
48+
49+
- Test use of repo2docker with the `--target-repo-dir` flag. See [this documentation](https://repo2docker.readthedocs.io/en/latest/usage.html#cmdoption-jupyter-repo2docker-target-repo-dir)
50+
for details.
51+
52+
`--target-repo-dir` is meant to support custom paths where repositories can be
53+
copied to besides `${HOME}`.
54+
55+
This test makes use of the `test-extra-args.yaml` file to influence additional
56+
arguments passed to `repo2docker` during the test. In this test, specify
57+
`--target-repo-dir=/srv/repo`.

tests/conda/py2/README.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

tests/conda/py310-requirements-file/README.rst

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
dependencies:
22
- python=3.10
33
- numpy
4+
- pip
45
- pip:
5-
- simplejson
6+
- simplejson

tests/conda/py35-binder-dir/README.rst

Lines changed: 0 additions & 9 deletions
This file was deleted.
File renamed without changes.

tests/conda/r-postbuild/README.rst

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)