PageRenderTime 40ms CodeModel.GetById 9ms RepoModel.GetById 0ms app.codeStats 0ms

/external/webkit/Source/JavaScriptCore/tests/mozilla/README-jsDriver.html

https://gitlab.com/brian0218/rk3188_r-box_android4.2.2_sdk
HTML | 344 lines | 335 code | 8 blank | 1 comment | 0 complexity | f3c25c3bd6a87a347247f06e0859f257 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
    2. 

  2. <html>
    3. 

  3.   <head>
    4. 

  4.     <title>jsDriver.pl</title>
    5. 

  5.   </head>
    6. 

  6. 

  7.   <body bgcolor="white">
    8. 

  8.     <h1 align="right">jsDriver.pl</h1>
    9. 

  9. 

  10.     <dl>
    11. 

  11.       <dt><b>NAME</b></dt>
    12. 

  12.       <dd>
    13. 

  13.         <b>jsDriver.pl</b> - execute JavaScript programs in various shells in
    14. 

  14.         batch or single mode, reporting on failures encountered.
    15. 

  15.         <br>
    16. 

  16.         <br>
    17. 

  17. 

  18.       <dt><b>SYNOPSIS</b></dt>
    19. 

  19.       <dd>
    20. 

  20.         <table>
    21. 

  21.           <tr>
    22. 

  22.             <td align="right" valign="top">
    23. 

  23.               <code>
    24. 

  24.                 <b>jsDriver.pl</b>
    25. 

  25.               </code>
    26. 

  26.             </td>
    27. 

  27.             <td>
    28. 

  28.               <code>
    29. 

  29.                 [-hkt] [-b BUGURL] [-c CLASSPATH] [-f OUTFILE]
    30. 

  30.                 [-j JAVAPATH] [-l TESTLIST ...] [-L NEGLIST ...] [-p TESTPATH]
    31. 

  31.                 [-s SHELLPATH] [-u LXRURL] [--help] [--confail] [--trace]
    32. 

  32.                 [--classpath=CLASSPATH] [--file=OUTFILE] [--javapath=JAVAPATH]
    33. 

  33.                 [--list=TESTLIST] [--neglist=TESTLIST] [--testpath=TESTPATH]
    34. 

  34.                 [--shellpath=SHELLPATH] [--lxrurl=LXRURL] {-e ENGINETYPE |
    35. 

  35.                 --engine=ENGINETYPE}
    36. 

  36.               </code>
    37. 

  37.             </td>
    38. 

  38.           </tr>
    39. 

  39.         </table>
    40. 

  40.         <br>
    41. 

  41.         <br>
    42. 

  42. 

  43.       <dt><b>DESCRIPTION</b></dt>
    44. 

  44.       <dd>
    45. 

  45.         <b>jsDriver.pl</b> is normally used to run a series of tests against
    46. 

  46.         one of the JavaScript shells.  These tests are expected to be laid out
    47. 

  47.         in a directory structure exactly three levels deep.  The first level
    48. 

  48.         is considered the <b>root</b> of the tests, subdirectories under the
    49. 

  49.         <b>root</b> represent <b>Test Suites</b> and generally mark broad
    50. 

  50.         categories such as <i>ECMA Level 1</i> or <i>Live Connect 3</i>.  Under the
    51. 

  51.         <b>Test Suites</b> are the <b>Test Categories</b>, which divide the 
    52. 

  52.         <b>Test Suite</b> into smaller categories, such as <i>Execution Contexts</i>
    53. 

  53.         or <i>Lexical Rules</i>.  Testcases are located under the
    54. 

  54.         <B>Test Categories</b> as normal JavaScript (*.js) files.  
    55. 

  55.         <p>
    56. 

  56.           If a file named <b>shell.js</b> exists in either the
    57. 

  57.           <b>Test Suite</b> or the <b>Test Category</b> directory, it is
    58. 

  58.           loaded into the shell before the testcase.  If <b>shell.js</b>
    59. 

  59.           exists in both directories, the version in the <b>Test Suite</b>
    60. 

  60.           directory is loaded <i>first</i>, giving the version associated with
    61. 

  61.           the <b>Test Category</b> the ability to override functions previously
    62. 

  62.           declared.  You can use this to
    63. 

  63.           create functions and variables common to an entire suite or category.
    64. 

  64.         <p>
    65. 

  65.           Testcases can report failures back to <b>jsDriver.pl</b> in one of
    66. 

  66.           two ways.  The most common is to write a line of text containing
    67. 

  67.           the word <code>FAILED!</code> to <b>STDOUT</b> or <b>STDERR</b>.
    68. 

  68.           When the engine encounters a matching line, the test is marked as
    69. 

  69.           failed, and any line containing <code>FAILED!</code> is displayed in
    70. 

  70.           the failure report.  The second way a test case can report failure is
    71. 

  71.           to return an unexpected exit code.  By default, <b>jsDriver.pl</b>
    72. 

  72.           expects all test cases to return exit code 0, although a test
    73. 

  73.           can output a line containing <code>EXPECT EXIT <i>n</i></code> where
    74. 

  74.           <i>n</i> is the exit code the driver should expect to see.  Testcases
    75. 

  75.           can return a nonzero exit code by calling the shell function
    76. 

  76.           <code>quit(<i>n</i>)</code> where <code><i>n</i></code> is the
    77. 

  77.           code to exit with.  The various JavaScript shells report
    78. 

  78.           non-zero exit codes under the following conditions:
    79. 

  79. 

  80.           <center>
    81. 

  81.             <table border="1">
    82. 

  82.               <tr>
    83. 

  83.                 <th>Reason</th>
    84. 

  84.                 <th>Exit Code</th>
    85. 

  85.               </tr>
    86. 

  86.               <tr>
    87. 

  87.                 <td>
    88. 

  88.                   Engine initialization failure.
    89. 

  89.                 </td>
    90. 

  90.                 <td>
    91. 

  91.                   1
    92. 

  92.                 </td>
    93. 

  93.               </tr>
    94. 

  94.               <tr>
    95. 

  95.                 <td>
    96. 

  96.                   Invalid argument on command line.
    97. 

  97.                 </td>
    98. 

  98.                 <td>
    99. 

  99.                   2
    100. 

  100.                 </td>
    101. 

  101.               </tr>
    102. 

  102.               <tr>
    103. 

  103.                 <td>
    104. 

  104.                   Runtime error (uncaught exception) encountered.
    105. 

  105.                 </td>
    106. 

  106.                 <td>
    107. 

  107.                   3
    108. 

  108.                 </td>
    109. 

  109.               </tr>
    110. 

  110.               <tr>
    111. 

  111.                 <td>
    112. 

  112.                   File argument specified on command line not found.
    113. 

  113.                 </td>
    114. 

  114.                 <td>
    115. 

  115.                   4
    116. 

  116.                 </td>
    117. 

  117.               </tr>
    118. 

  118.               <tr>
    119. 

  119.                 <td>
    120. 

  120.                   Reserved for future use.
    121. 

  121.                 </td>
    122. 

  122.                 <td>
    123. 

  123.                   5-9
    124. 

  124.                 </td>
    125. 

  125.               </tr>
    126. 

  126.             </table>
    127. 

  127.           </center>
    128. 

  128.           <br>
    129. 

  129.           <br>
    130. 

  130. 

  131.       <dt><b>OPTIONS</b></dt>
    132. 

  132.       <dd>
    133. 

  133.         <dl>
    134. 

  134.           <dt><b>-b URL, --bugurl=URL</b></dt>
    135. 

  135.           <dd>
    136. 

  136.             Bugzilla URL.  When a testcase writes a line in the format
    137. 

  137.             <code>BUGNUMBER <i>n</i></code> to <b>STDOUT</b> or <b>STDERR</b>,
    138. 

  138.             <b>jsDriver.pl</b> interprets <code><i>n</i></code> as a bugnumber
    139. 

  139.             in the <a href="http://bugzilla.mozilla.org">BugZilla</a> bug
    140. 

  140.             tracking system.  In the event that a testcase which has specified
    141. 

  141.             a bugnumber fails, a hyperlink to the BugZilla database
    142. 

  142.             will be included in the output by prefixing the bugnumber with the
    143. 

  143.             URL specified here.  By default, URL is assumed to be
    144. 

  144.             &quot;http://bugzilla.mozilla.org/show_bug.cgi?id=&quot;.
    145. 

  145.             <br>
    146. 

  146.             <br>
    147. 

  147.             <a name="classpath"></a>
    148. 

  148.           <dt><b>-c PATH, --classpath=PATH</b></dt>
    149. 

  149.           <dd>
    150. 

  150.             Classpath to pass the the Java Virtual Machine.  When running tests
    151. 

  151.             against the <b>Rhino</b> engine, PATH will be passed in as the value
    152. 

  152.             to an argument named &quot;-classpath&quot;.  If your particular JVM
    153. 

  153.             does not support this option, it is recommended you specify your
    154. 

  154.             class path via an environment setting.  Refer to your JVM
    155. 

  155.             documentation for more details about CLASSPATH.
    156. 

  156.             <br>
    157. 

  157.             <br>
    158. 

  158.           <dt><b>-e TYPE ..., --engine=TYPE ...</b></dt>
    159. 

  159.           <dd>
    160. 

  160.             Required.  Type of engine(s) to run the tests against.  TYPE can be
    161. 

  161.             one or more of the following values:
    162. 

  162.             <center>
    163. 

  163.               <table border="1">
    164. 

  164.                 <tr>
    165. 

  165.                   <th>TYPE</th>
    166. 

  166.                   <th>Engine</th>
    167. 

  167.                 </tr>
    168. 

  168.                 <tr>
    169. 

  169.                   <td>lcopt</td>
    170. 

  170.                   <td>LiveConnect, optimized</td>
    171. 

  171.                 </tr>
    172. 

  172.                 <tr>
    173. 

  173.                   <td>lcdebug</td>
    174. 

  174.                   <td>LiveConnect, debug</td>
    175. 

  175.                 </tr>
    176. 

  176.                 <tr>
    177. 

  177.                   <td>rhino</td>
    178. 

  178.                   <td>Rhino compiled mode</td>
    179. 

  179.                 </tr>
    180. 

  180.                 <tr>
    181. 

  181.                   <td>rhinoi</td>
    182. 

  182.                   <td>Rhino interpreted mode</td>
    183. 

  183.                 </tr>
    184. 

  184.                 <tr>
    185. 

  185.                   <td>rhinoms</td>
    186. 

  186.                   <td>Rhino compiled mode for the Microsoft VM (jview)</td>
    187. 

  187.                 </tr>
    188. 

  188.                 <tr>
    189. 

  189.                   <td>rhinomsi</td>
    190. 

  190.                   <td>Rhino interpreted mode for the Microsoft VM (jview)</td>
    191. 

  191.                 </tr>
    192. 

  192.                 <tr>
    193. 

  193.                   <td>smopt</td>
    194. 

  194.                   <td>Spider-Monkey, optimized</td>
    195. 

  195.                 </tr>
    196. 

  196.                 <tr>
    197. 

  197.                   <td>smdebug</td>
    198. 

  198.                   <td>Spider-Monkey, debug</td>
    199. 

  199.                 </tr>
    200. 

  200.                 <tr>
    201. 

  201.                   <td>xpcshell</td>
    202. 

  202.                   <td>XPConnect shell</td>
    203. 

  203.                 </tr>
    204. 

  204.               </table>
    205. 

  205.             </center>
    206. 

  206.             <br>
    207. 

  207.             <br>
    208. 

  208.           <dt><b>-f FILE, --file=FILE</b></dt>
    209. 

  209.           <dd>
    210. 

  210.             Generate html output to the HTML file named by FILE.  By default,
    211. 

  211.             a filename will be generated using a combination of the engine type
    212. 

  212.             and a date/time stamp, in the format: 
    213. 

  213.             <code>results-<i>&lt;engine-type&gt;</i>-<i>&lt;date-stamp&gt;</i>.html</code>
    214. 

  214.             <br>
    215. 

  215.             <br>
    216. 

  216.           <dt><b>-h, --help</b></dt>
    217. 

  217.           <dd>
    218. 

  218.             Prints usage information.
    219. 

  219.             <br>
    220. 

  220.             <br>
    221. 

  221.           <dt><b>-j PATH, --javapath=PATH</b></dt>
    222. 

  222.           <dd>
    223. 

  223.             Set the location of the Java Virtual Machine to use when running
    224. 

  224.             tests against the <b>Rhino</b> engine.  This can be used to test
    225. 

  225.             against multiple JVMs on the same system.
    226. 

  226.             <br>
    227. 

  227.             <br>
    228. 

  228.           <dt><b>-k, --confail</b></dt>
    229. 

  229.           <dd>
    230. 

  230.             Log failures to the console.  This will show any failures, as they
    231. 

  231.             occur, on <b>STDERR</b> in addition to creating the HTML results
    232. 

  232.             file.  This can be useful for times when it may be 
    233. 

  233.             counter-productive to load an HTML version of the results each time
    234. 

  234.             a test is re-run.
    235. 

  235.             <br>
    236. 

  236.             <br>
    237. 

  237.           <dt><b>-l FILE ..., --list=FILE ...</b></dt>
    238. 

  238.           <dd>
    239. 

  239.             Specify a list of tests to execute.  FILE can be a plain text file
    240. 

  240.             containing a list of testcases to execute, a subdirectory 
    241. 

  241.             in which to
    242. 

  242.             <a href="http://www.instantweb.com/~foldoc/foldoc.cgi?query=grovel">grovel</a>
    243. 

  243.             for tests, or a single testcase to execute.  Any number of FILE 
    244. 

  244.             specifiers may follow this option.  The driver uses the fact that a
    245. 

  245.             valid testcase should be a file ending in .js to make the distinction
    246. 

  246.             between a file containing a list of tests and an actual testcase.
    247. 

  247.             <br>
    248. 

  248.             <br>
    249. 

  249.           <dt><b>-L FILE ..., --neglist=FILE ...</b></dt>
    250. 

  250.           <dd>
    251. 

  251.             Specify a list of tests to skip.  FILE has the same meaning as in
    252. 

  252.             the <b>-l</b> option.  This option is evaluated after
    253. 

  253.             <b>all</b> <b>-l</b> and <b>--list</b> options, allowing a user
    254. 

  254.             to subtract a single testcase, a directory of testcases, or a
    255. 

  255.             collection of unrelated testcases from the execution list.
    256. 

  256.             <br>
    257. 

  257.             <br>
    258. 

  258.           <dt><b>-p PATH, --testpath=PATH</b></dt>
    259. 

  259.           <dd>
    260. 

  260.             Directory holding the &quot;Test Suite&quot; subdirectories.  By
    261. 

  261.             default this is ./
    262. 

  262.             <br>
    263. 

  263.             <br>
    264. 

  264.           <dt><b>-s PATH, --shellpath=PATH</b></dt>
    265. 

  265.           <dd>
    266. 

  266.             Directory holding the JavaScript shell.  This can be used to override
    267. 

  267.             the automatic shell location <b>jsDriver.pl</b> performs based on
    268. 

  268.             you OS and engine type.  For Non <b>Rhino</b> engines, this 
    269. 

  269.             includes the name of the executable as well as the path.  In
    270. 

  270.             <b>Rhino</b>, this path will be appended to your 
    271. 

  271.             <a href="#classpath">CLASSPATH</a>.  For the 
    272. 

  272.             <b>SpiderMonkey</b> shells, this value defaults to
    273. 

  273.             ../src/&lt;Platform-and-buildtype-specific-directory&gt;/[js|jsshell],
    274. 

  274.             for the
    275. 

  275.             <b>LiveConnect</b> shells,
    276. 

  276.             ../src/liveconnect/src/&lt;Platform-and-buildtype-specific-directory&gt;/lschell
    277. 

  277.             and for the <b>xpcshell</b> the default is the value of your 
    278. 

  278.             <code>MOZILLA_FIVE_HOME</code> environment variable.  There is no
    279. 

  279.             default (as it is usually not needed) for the <b>Rhino</b> shell.
    280. 

  280.             <br>
    281. 

  281.             <br>
    282. 

  282.           <dt><b>-t, --trace</b></dt>
    283. 

  283.           <dd>
    284. 

  284.             Trace execution of <b>jsDriver.pl</b>.  This option is primarily
    285. 

  285.             used for debugging of the script itself, but if you are interested in
    286. 

  286.             seeing the actual command being run, or generally like gobs of
    287. 

  287.             useless information, you may find it entertaining.
    288. 

  288.             <br>
    289. 

  289.             <br>
    290. 

  290.           <dt><b>-u URL, --lxrurl=URL</b></dt>
    291. 

  291.           <dd>
    292. 

  292.             Failures listed in the HTML results will be hyperlinked to the
    293. 

  293.             lxr source available online by prefixing the test path and
    294. 

  294.             name with this URL.  By default, URL is
    295. 

  295.             http://lxr.mozilla.org/mozilla/source/js/tests/
    296. 

  296.             <br>
    297. 

  297.             <br>
    298. 

  298. 

  299.         </dl>
    300. 

  300.       <dt><b>SEE ALSO</b></dt>
    301. 

  301.       <dd>
    302. 

  302.         <a href="http://lxr.mozilla.org/mozilla/source/js/tests/jsDriver.pl">jsDriver.pl</a>,
    303. 

  303.         <a href="http://lxr.mozilla.org/mozilla/source/js/tests/mklistpage.pl">mklistpage.pl</a>,
    304. 

  304.         <a href="http://www.mozilla.org/js/">http://www.mozilla.org/js/</a>,
    305. 

  305.         <a href="http://www.mozilla.org/js/tests/library.html">http://www.mozilla.org/js/tests/library.html</a>
    306. 

  306.         <br>
    307. 

  307.         <br>
    308. 

  308. 

  309.       <dt><b>REQUIREMENTS</b></dt>
    310. 

  310.       <dd>
    311. 

  311.         <b>jsDriver.pl</b> requires the
    312. 

  312.         <a href="http://search.cpan.org/search?module=Getopt::Mixed">Getopt::Mixed</a>
    313. 

  313.         perl package, available from <a href="http://www.cpan.org">cpan.org</a>.
    314. 

  314.         <br>
    315. 

  315.         <br>
    316. 

  316.       <dt><b>EXAMPLES</b></dt>
    317. 

  317.       <dd>
    318. 

  318.           <code>perl jsDriver.pl -e smdebug -L lc*</code><br>
    319. 

  319.           Executes all tests EXCEPT the liveconnect tests against the
    320. 

  320.           SpiderMonkey debug shell, writing the results
    321. 

  321.           to the default result file.  (NOTE: Unix shells take care of wildcard
    322. 

  322.           expansion, turning <code>lc*</code> into <code>lc2 lc3</code>.  Under
    323. 

  323.           a DOS shell, you must explicitly list the directories.)
    324. 

  324.         <p>
    325. 

  325.           <code>perl jsDriver.pl -e rhino -L rhino-n.tests</code><br>
    326. 

  326.           Executes all tests EXCEPT those listed in the
    327. 

  327.           <code>rhino-n.tests</code> file.
    328. 

  328.         <p>
    329. 

  329.           <code>perl -I/home/rginda/perl/lib/ jsDriver.pl -e lcopt -l lc2
    330. 

  330.             lc3 -f lcresults.html -k</code><br>
    331. 

  331.           Executes ONLY the tests under the <code>lc2</code> and <code>lc3</code>
    332. 

  332.           directories against the LiveConnect shell.  Results will be written to
    333. 

  333.           the file <code>lcresults.html</code> <b>AND</b> the console.  The 
    334. 

  334.           <code>-I</code> option tells perl to look for modules in the
    335. 

  335.           <code>/home/rginda/perl/lib</code> directory (in addition to the
    336. 

  336.           usual places), useful if you do not have root access to install new
    337. 

  337.           modules on the system.
    338. 

  338.     </dl>
    339. 

  339.     <hr>
    340. 

  340.     Author: Robert Ginda<br>
    341. 

  341.     Currently maintained by <i><a href="mailto:pschwartau@netscape.com">Phil Schwartau</a> </i><br>
    342. 

  342. <!-- Created: Thu Dec  2 19:08:05 PST 1999 -->
    343. 

  343.   </body>
    344. 

  344. </html>
    345. 

  345.