tox-envfile: add support for env file

RIOT-OS · Sep 28, 2021 · b5d0ffa · b5d0ffa
1 parent 9287224
commit b5d0ffa
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 0 deletions.
diff --git a/.devdata.env.sample b/.devdata.env.sample
@@ -0,0 +1,6 @@
+# Use this file as a template for .devdata.env
+
+### General
+
+# Path to RIOTBASE
+# RIOTBASE=/path/to/RIOT
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 test-report.xml
+.devdata.env
 
 #### joe made this: http://goel.io/joe
 

diff --git a/README.md b/README.md
@@ -306,6 +306,17 @@ tox -- -k spec03 -k "task01 or task05"
 
 is identical to the first example.
 
+##### Using an env file to keep persistent environment variables
+
+Most tests require a set of user specific environment variable (path to
+RIOTBASE, LoRaWAN keys, etc). In order to keep these variables persistent, a
+.devdata.env file can be place in the root directory. For that, please make
+a copy of ".devdata.env.sample" and modify accordingly:
+
+```sh
+cp .devdata.env.sample .devdata.env
+```
+
 [pytest]: https://pytest.org
 [riotctrl]: https://pypi.org/project/riotctrl/
 [IoT-LAB saclay site]: https://www.iot-lab.info/deployment/saclay/

diff --git a/tox.ini b/tox.ini
@@ -1,6 +1,7 @@
 [tox]
 envlist = test,flake8,pylint
 skipsdist = True
+requires = tox-envfile
 
 [testenv]
 basepython = python3