path: root/TESTING.md
diff options
authorAsh Wilson <ash.d.wilson@gmail.com>2016-02-25 23:07:50 -0600
committerAsh Wilson <ash.d.wilson@gmail.com>2016-04-10 22:58:35 -0700
commit6791f4db393bc65d116d8893b5e8dc3c1b93d9e2 (patch)
tree50db44c4b109d81329a84183fc15b98d671d1c41 /TESTING.md
parent8cc68595bc228f53070fcdee08d783921a60e652 (diff)
re-structuring testing stuff, adding testing docs and integration tests.
Diffstat (limited to 'TESTING.md')
1 files changed, 15 insertions, 0 deletions
diff --git a/TESTING.md b/TESTING.md
new file mode 100644
index 0000000..0ff928f
--- /dev/null
+++ b/TESTING.md
@@ -0,0 +1,15 @@
+# Testing gr-gsm
+## CI Testing
+CI testing currently consists of attempting to build gr-gsm as described in the .docker files located under gr-gsm/dockerfiles using travis-ci.org. If the build is successful, travis-ci will attempt to decode the test file located under gr-gsm/test_data and compare the results to this file: gr-gsm/test/fixtures/grgsm_decode_test1_expected. See the gr-gsm/test/tests/decode.sh file for details.
+## Integration testing
+Integration testing:
+* Make sure that your RTL SDR dongle is plugged into the system and if you're running on Mac, you need to have the dongle accessible to the VirtualBox VM that's running Docker.
+* cd gr-gsm/test/tests
+* . .integration.sh
+This will copy the entire contents of the currently checked out branch of gr-gsm to a temp folder, and attempt to build the docker images according to the definitions in the .docker files located under gr-gsm/dockerfiles.
+Once the images are created, the scripts instantiates a container to test each band listed on each against each image built. This can take quite a while. If you're running on Mac, consider using the ```caffeinate``` command to keep your machine from sleeping.