Changeset 2087 for pjproject

Timestamp:

Jun 28, 2008 12:40:17 AM (16 years ago)

Author:

bennylp

Message:

Updated python test readme doc

File:

• pjproject/trunk/pjsip-apps/src/test-pjsua/README.TXT (modified) (3 diffs)

pjproject/trunk/pjsip-apps/src/test-pjsua/README.TXT

@@ -5 +5 @@
 0. What is this
 ---------------
-This is the automated testing scripts for pjsua. It can do many things (just don't ask 
-it to write good documentation :) ).
+This is the automated testing scripts for pjsua. It can do many things (just 
+don't ask it to write good documentation :) ).
 
 
@@ -21 +21 @@
 --------
 To run all the tests:
-  $ python runall.py
+  $ python [OPTIONS] runall.py
 
 To run individual test:
-  $ python run.py MODULE CONFIG
+  $ python [OPTIONS] run.py MODULE CONFIG
 
-The run.py is the main entry for the test. It imports the various inc_xxx.py files, and 
-it will load the MODULE. The MODULE contains specific test flows, and we have few of 
-them:
+Where options:
+  -e EXE        use EXE as pjsua executable
+  -n            use null audio
+  -r TEST       (for runall.py only) resume test at TEST
+
+  
+For each individual tests, the run.py is the main entry for the test. It 
+imports the various inc_xxx.py files, and it will load the MODULE. The MODULE 
+contains specific test flows, and we have few of them:
 
   - mod_run.py: 
-        a simple test which just run pjsua with the configuration from CONFIG file 
-        and checks if pjsua can start properly.
+        a simple test which just run pjsua with the configuration from CONFIG 
+        file and checks if pjsua can start properly.
 
   - mod_call.py: 
-        call testing where it spawns two pjsua instances each with configurations as 
-        specified in CONFIG file, makes one pjsua call the other, and checks if the call 
-        can be established.
+        call testing where it spawns two pjsua instances each with configura-
+        tions as specified in CONFIG file, makes one pjsua call the other, and 
+        checks if the call can be established.
 
   - mod_pres.py:
@@ -43 +49 @@
 
   - mod_sendto.py:
-        Simple UAC to send arbitrary SIP message
+        Simple UAC to send arbitrary SIP message to pjsua. Good to test
+        various incoming INVITE scenarios
 
   - mod_media_playrec.py:
-        Media testing
+        Mainly for resampling quality testing
+
+  - mod_pesq.py
+        Measure call quality of various call settings with PESQ, for people 
+        who have PESQ tool and license
 
 Example: