aboutsummaryrefslogtreecommitdiffstats
path: root/host/tests/devtest/README.md
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2015-10-07 15:06:42 -0700
committerMartin Braun <martin.braun@ettus.com>2015-10-07 15:06:42 -0700
commit90b88a27d27c52c337941a99773dfeb70e9c5917 (patch)
treecc620ca5b5ca5d13a05c45a67e2aa2329992c45a /host/tests/devtest/README.md
parent9401bdbd214a7842c4ba913595cc79e27124589d (diff)
downloaduhd-90b88a27d27c52c337941a99773dfeb70e9c5917.tar.gz
uhd-90b88a27d27c52c337941a99773dfeb70e9c5917.tar.bz2
uhd-90b88a27d27c52c337941a99773dfeb70e9c5917.zip
tests: Added first batch of device tests
- Currently supported: B2xx, X3x0 - Runs some simple examples
Diffstat (limited to 'host/tests/devtest/README.md')
-rw-r--r--host/tests/devtest/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/host/tests/devtest/README.md b/host/tests/devtest/README.md
new file mode 100644
index 000000000..ee1ff3c9f
--- /dev/null
+++ b/host/tests/devtest/README.md
@@ -0,0 +1,28 @@
+# Device Tests
+
+These are a set of tests to be run with one or more attached devices.
+None of these tests require special configuration; e.g., the X3x0 test
+will work regardless of attached daughterboards, FPGIO wiring etc.
+
+## Adding new tests
+
+To add new tests, add new files with classes that derive from unittest.TestCase.
+Most of the time, you'll want to derive from `uhd_test_case` or
+`uhd_example_test_case`.
+
+## Adding new devices
+
+To add new devices, follow these steps:
+
+1) Add an entry to the CMakeLists.txt file in this directory using the
+ `ADD_DEVTEST()` macro.
+2) Add a `devtest_pattern.py` file to this directory, where `pattern` is
+ the same pattern used in the `ADD_DEVTEST()` macro.
+3) Edit this devtest file to import all the tests you want to run. Some
+ may require parameterization.
+
+The devtest file is 'executed' using Python's unittest module, so it doesn't
+require any actual commands. If the device needs special initialization,
+commands inside this file will be executed *if* they are *not* in a
+`if __name__ == "__main__"` conditional.
+