test/README.txt

   1 # $Id$
   2 #
   3
   4 Please read this file before making any modifications to the test suite.
   5
   6
   7
   8 **********************************************************************
   9 **********************************************************************
  10 * Updating existing "golden" files
  11 **********************************************************************
  12 **********************************************************************
  13
  14 ./run_tests.sh --regen <testname>
  15
  16 will regenerate the golden file for <testname>.  I suggest saving
  17 off a copy and using ImageMagick to look for the differences visually.
  18 The run_tests.sh script has examples of comparing .png files.  Make
  19 sure the changes are only the expected ones and then check the new
  20 files back into cvs.  Do not blindly update these files as that defeats
  21 the purpose of the tests.
  22
  23 **********************************************************************
  24 **********************************************************************
  25 * Adding New Tests
  26 **********************************************************************
  27 **********************************************************************
  28
  29 ----------------------------------------------------------------------
  30 Create input files
  31 ----------------------------------------------------------------------
  32
  33 Create a *small* RS274-X or NC-drill input file and put it in the inputs/
  34 directory.  The goal is to have a file which tests one particular aspect
  35 of the capabilities of the respective file format.
  36
  37 ----------------------------------------------------------------------
  38 Add to tests.list
  39 ----------------------------------------------------------------------
  40
  41 Add an entry to the tests.list file for your new tests.  Use existing
  42 entries as an example.
  43
  44 ----------------------------------------------------------------------
  45 Generate the reference files
  46 ----------------------------------------------------------------------
  47
  48 Generate the reference files for your new tests using the following
  49
  50 ./run_tests.sh --regen <new_test_name>
  51
  52 where <new_test_name> is the name of your new test from tests.list.  If you
  53 are adding multiple tests, then you can list them all on the same
  54 command line.
  55
  56 *IMPORTANT*
  57 Verify that the generated .png files for your new tests are correct.  These
  58 files will have been placed in the golden/ subdirectory.
  59
  60 ----------------------------------------------------------------------
  61 Update Makefile.am's
  62 ----------------------------------------------------------------------
  63
  64 Update inputs/Makefile.am and golden/Makefile.am to include your new
  65 files.
  66
  67 ----------------------------------------------------------------------
  68 Add the new files to cvs
  69 ----------------------------------------------------------------------
  70
  71 cvs add -kb golden/<new files>
  72 cvs add inputs/<new files>
  73
  74 the "-kb" flag is required when adding .png files to cvs to prevent cvs
  75 from trying to expand RCS keywords inside of a binary file.
  76
  77