From 1e4bc50a771909aa03ccda6da2877c51c08e500f Mon Sep 17 00:00:00 2001 From: Erik Sundell Date: Sun, 16 Oct 2022 11:04:10 +0200 Subject: [PATCH] refactor readme files: in julia tests --- tests/julia/README.md | 38 +++++++++++++++++++ tests/julia/project-1.0.2/README.rst | 4 -- tests/julia/project/README.rst | 5 --- .../REQUIRE | 0 .../requirements.txt | 0 .../verify | 0 tests/julia/require-1-requirements/README.rst | 8 ---- tests/julia/require/README.rst | 9 ----- 8 files changed, 38 insertions(+), 26 deletions(-) create mode 100644 tests/julia/README.md delete mode 100644 tests/julia/project-1.0.2/README.rst delete mode 100644 tests/julia/project/README.rst rename tests/julia/{require-1-requirements => require-1-requirements-file}/REQUIRE (100%) rename tests/julia/{require-1-requirements => require-1-requirements-file}/requirements.txt (100%) rename tests/julia/{require-1-requirements => require-1-requirements-file}/verify (100%) delete mode 100644 tests/julia/require-1-requirements/README.rst delete mode 100644 tests/julia/require/README.rst diff --git a/tests/julia/README.md b/tests/julia/README.md new file mode 100644 index 00000000..f6d2996f --- /dev/null +++ b/tests/julia/README.md @@ -0,0 +1,38 @@ +# Overview of tests for the julia buildpack + +## Tested configuration files + +- [`Project.toml`](https://repo2docker.readthedocs.io/en/latest/config_files.html#project-toml-install-a-julia-environment) +- [`REQUIRE`](https://repo2docker.readthedocs.io/en/latest/config_files.html#require-install-a-julia-environment-legacy) +- [`requirements.txt`](https://repo2docker.readthedocs.io/en/latest/config_files.html#requirements-txt-install-a-python-environment) + +## Test folders + +### project + +- Tests use of a `Project.toml` file for Julia, using the repo2docker default + version of Julia as specified in `julia_project.py`. + +### project-1.0.2 + +- Tests use of a `Project.toml` file for Julia, using a version of Julia + specified via `julia = "=1.0.2"` in `Project.toml`'s `[compat]` section. + +### require + +- Tests use of a `REQUIRE` file for Julia, using the repo2docker default version + of Julia as specified in `julia_require.py`. Note that this is default version + is currently 0.6.4! + +- Starting with Julia v0.7 and up, the package manager has changed, so this + tests that the Julia version below that can be installed correctly as well. + +### require-1-requirements-file + +- Tests use of a `REQUIRE` file for Julia, using a major version version + specification. Note that this major version specification is currently + resolving to a pinned minor and patch version as declared in + `julia_require.py`. + +- Test use of a `requirements.txt` file, where it is expected to be respected + alongside the `REQUIRE` file. diff --git a/tests/julia/project-1.0.2/README.rst b/tests/julia/project-1.0.2/README.rst deleted file mode 100644 index 80d8710c..00000000 --- a/tests/julia/project-1.0.2/README.rst +++ /dev/null @@ -1,4 +0,0 @@ -Julia - Project.toml --------------------- - -Test a Project.toml file with a specified version for julia. diff --git a/tests/julia/project/README.rst b/tests/julia/project/README.rst deleted file mode 100644 index d638b067..00000000 --- a/tests/julia/project/README.rst +++ /dev/null @@ -1,5 +0,0 @@ -Julia - Project.toml --------------------- - -This tests a Project.toml file for julia, using the repo2docker default version -of julia as specified in ``julia_project.py``. diff --git a/tests/julia/require-1-requirements/REQUIRE b/tests/julia/require-1-requirements-file/REQUIRE similarity index 100% rename from tests/julia/require-1-requirements/REQUIRE rename to tests/julia/require-1-requirements-file/REQUIRE diff --git a/tests/julia/require-1-requirements/requirements.txt b/tests/julia/require-1-requirements-file/requirements.txt similarity index 100% rename from tests/julia/require-1-requirements/requirements.txt rename to tests/julia/require-1-requirements-file/requirements.txt diff --git a/tests/julia/require-1-requirements/verify b/tests/julia/require-1-requirements-file/verify similarity index 100% rename from tests/julia/require-1-requirements/verify rename to tests/julia/require-1-requirements-file/verify diff --git a/tests/julia/require-1-requirements/README.rst b/tests/julia/require-1-requirements/README.rst deleted file mode 100644 index 2aea8932..00000000 --- a/tests/julia/require-1-requirements/README.rst +++ /dev/null @@ -1,8 +0,0 @@ -Julia - REQUIRE, and a requirements.txt file --------------------------------------------- - -This tests a REQUIRE file for julia, using the repo2docker default version of -julia as specified in ``julia_require.py``. - -This tests the use of the legacy REQUIRE file together with the an -``requirements.txt`` file. diff --git a/tests/julia/require/README.rst b/tests/julia/require/README.rst deleted file mode 100644 index 0d90b554..00000000 --- a/tests/julia/require/README.rst +++ /dev/null @@ -1,9 +0,0 @@ -Julia - REQUIRE, and use of old package manager ------------------------------------------------ - -This tests a REQUIRE file for julia, using the repo2docker default version of -julia as specified in ``julia_require.py``. Note that this is default version is -0.6.4! - -Starting with Julia v0.7 and up, the package manager has changed, so this tests -that the Julia version below that can be installed correctly as well.