README.TXT 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. PJSUA TEST FRAMEWORK
  2. =========================
  3. 0. What is this
  4. ---------------
  5. This is the automated testing scripts for pjsua. It can do many things (just
  6. don't ask it to write good documentation :) ).
  7. 1. Requirements
  8. ---------------
  9. To run the tests you need:
  10. - Python (tested with Python 2.5.2)
  11. - pjsua application, built and placed in pjsip-apps/bin directory
  12. - the pjsua must be built with:
  13. - SRTP enabled (the default)
  14. 2. Using
  15. --------
  16. To run all the tests:
  17. $ python [OPTIONS] runall.py
  18. To run individual test:
  19. $ python [OPTIONS] run.py MODULE CONFIG
  20. Where options:
  21. -e EXE use EXE as pjsua executable
  22. -n use null audio
  23. -r TEST (for runall.py only) resume test at TEST
  24. For each individual tests, the run.py is the main entry for the test. It
  25. imports the various inc_xxx.py files, and it will load the MODULE. The MODULE
  26. contains specific test flows, and we have few of them:
  27. - mod_run.py:
  28. a simple test which just run pjsua with the configuration from CONFIG
  29. file and checks if pjsua can start properly.
  30. - mod_call.py:
  31. call testing where it spawns two pjsua instances each with configura-
  32. tions as specified in CONFIG file, makes one pjsua call the other, and
  33. checks if the call can be established.
  34. - mod_pres.py:
  35. presence testing
  36. - mod_sendto.py:
  37. Simple UAC to send arbitrary SIP message to pjsua. Good to test
  38. various incoming INVITE scenarios
  39. - mod_media_playrec.py:
  40. Mainly for resampling quality testing
  41. - mod_pesq.py
  42. Measure call quality of various call settings with PESQ, for people
  43. who have PESQ tool and license
  44. Example:
  45. $ python run.py mod_run.py scripts-run/100_simple.py
  46. $ python run.py mod_call.py scripts-call/100_simple.py
  47. $ python run.py mod_sipp.py scripts-sipp/uac-bad-ack.xml