testsuite/misc-mtasc.all/README

   1 This directory contains the testing framework for MTASC output.
   2 The framework is composed by a set of Makefile rules easying the addition
   3 of new tests.
   4
   5 Requirements
   6 ------------
   7
   8 There is a standalone Dejagnu.as class which provides all the Dejagnu.swf
   9 facilities. In addition, there is a check.as file which should be included
  10 in your main .as file, which lets you write
  11   check_equals(a,b);
  12 instead of
  13   Dejagnu.check_equals(a,b);
  14 In addition, it will automatically pass in the filename & line number, so
  15 that on failure this will get printed out.
  16
  17 How to add a new test
  18 ---------------------
  19
  20 To add a new test just write it using MTASC conventions, then add the main
  21 filename to the ASTEST variable in the Makefile.am file. Also, remember
  22 to add any accessory file (additional classes) to the EXTRA_DIST variable,
  23 so they are properly distributed.
  24
  25 If your test needs to compile additional SWFs, but they should not be run on
  26 their own, add the .as files for the additional swfs to AUXMOVIES.
  27
  28 Once you've done so, 'make <yourtestname>.swf' should produce the swf for you
  29 You can play this movie with any player (including the proprietary one) to
  30 confirm it passes all checks contained in it.
  31
  32 Running 'make check' should run all tests, including your new one.
  33
  34 How to write checks
  35 ---------------------
  36
  37 Take a look at the existing .as files to see how you can use the Dejagnu.swf facilities.
  38 Basically, you'd be calling the functions:
  39
  40         check( expression );
  41         check_equals( expression, expected ); // uses equality operator ==
  42
  43 Or the corresponding versions expecting failures (xcheck, xcheck_equals).
  44 For more info see the gnash manual in the Testing/Dejagnu.swf section.
  45 You can build the gnash manual by runnign 'make gnash.html' under the doc/C dir.