From fc8c5f62c397a0239ef213ab45a26a1def50f9eb Mon Sep 17 00:00:00 2001
From: Marcel Bargull <mbargull@users.noreply.github.com>
Date: Wed, 20 Oct 2021 20:40:25 +0200
Subject: [PATCH] docs: Mention required openssl dep for rust-script (#1216)

* docs: Add OpenSSL, C compiler deps for rust-script

OpenSSL is added indirectly via dependencies pulled in from the
json_typegen=0.7 Crate. The compilation needs OpenSSL sources from the
conda-forge::openssl package and a C compiler that uses the Conda
prefix's path to look for headers/libraries which is provided via
conda-forge::c-compiler.

* chore: Fix test_conda: check python<3.10 output

Help text output changed with Python 3.10 due to renamed optionals
group; ref: https://github.com/python/cpython/pull/23858/files
---
 docs/snakefiles/rules.rst        | 12 ++++++++----
 tests/test_conda/test-env.yaml   |  1 +
 tests/test_script/envs/rust.yaml |  3 +++
 3 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/docs/snakefiles/rules.rst b/docs/snakefiles/rules.rst
index 8d086a835..6be2b2eda 100644
--- a/docs/snakefiles/rules.rst
+++ b/docs/snakefiles/rules.rst
@@ -744,10 +744,11 @@ Rust_
         script:
             "path/to/script.rs"
 
-The ability to execute Rust scripts is facilitated by |rust-script|_. As such, the
-script must be a valid ``rust-script`` script and ``rust-script`` must be available in the
-environment the rule is run in.
-The minimum required ``rust-script`` version is `1.15.0`, so in the example above, the contents of ``rust.yaml`` might look like this:
+The ability to execute Rust scripts is facilitated by |rust-script|_.
+As such, the script must be a valid ``rust-script`` script and ``rust-script``
+(plus OpenSSL and a C compiler toolchain, provided by Conda packages ``openssl``, ``c-compiler``, ``pkg-config``)
+must be available in the environment the rule is run in.
+The minimum required ``rust-script`` version is 1.15.0, so in the example above, the contents of ``rust.yaml`` might look like this:
 
 .. code block:: yaml
 
@@ -756,6 +757,9 @@ The minimum required ``rust-script`` version is `1.15.0`, so in the example abov
       - bioconda
     dependencies:
       - rust-script>=0.15.0
+      - openssl
+      - c-compiler
+      - pkg-config
 
 
 
diff --git a/tests/test_conda/test-env.yaml b/tests/test_conda/test-env.yaml
index 51e322434..8a4213ddb 100644
--- a/tests/test_conda/test-env.yaml
+++ b/tests/test_conda/test-env.yaml
@@ -3,3 +3,4 @@ channels:
   - conda-forge
 dependencies:
   - melt ==1.0.3
+  - python <3.10
diff --git a/tests/test_script/envs/rust.yaml b/tests/test_script/envs/rust.yaml
index 1cb4c5bb4..644d65705 100644
--- a/tests/test_script/envs/rust.yaml
+++ b/tests/test_script/envs/rust.yaml
@@ -3,3 +3,6 @@ channels:
   - bioconda
 dependencies:
   - rust-script>=0.15.0
+  - openssl
+  - c-compiler
+  - pkg-config