docs/testing.md

   1 # Testing mraa
   2
   3 Mraa has a test suite written in python which can be run by users to check
   4 their platform is working correctly. The aim is to have a full API coverage
   5 using python scripts using unittests. Currently the test suite is far from
   6 complete.
   7
   8 ## Supported platforms
   9
  10 Intel Galileo v1 was used and is currently the only supported platform. Tests
  11 were conducted on Intel Galileo v2, but because of hardware differences, some
  12 failures may occur. Logic will be added to auto-select board to work on. To
  13 start with boards with an arduino type shield/layout should work
  14
  15 ## How to run these tests
  16
  17 You need to compile from source with -DBUILDSWIGPYTHON=ON and then tests can be
  18 executed with:
  19 $ make test
  20
  21 More detail can be seen by running:
  22 $ ctest -VV
  23
  24 Note tests will not run on platforms which cannot initialise, checking the
  25 amount of 'skipped' tests can be useful
  26
  27 ## What's next?
  28
  29 At this point tests were made to do a quick sanity check. In the future the
  30 followings will be implemented:
  31  * Create a physical layer that will emulate sensors behavior and generate I/O
  32    signals. This layer will be available to the community and will help replace
  33    the need of specific sensors. The simplest solution will be chosen allowing
  34    anyone to rapidly implement it.
  35  * Implement stress tests over long periods of time. This feature alone is
  36    possible only with the use of a physical layer since it will behave both as
  37    signals generator and interpreter.
  38  * Analyze a tests result collection solution (and after, interpretation). This
  39    is useful since tests mean nothing without a history and possibility to
  40    check on results.
  41  * Any idea welcome!
  42