TAO/orbsvcs/tests/Concurrency/README

   1
   2
   3 This is the readme file for the tests of the concurrency service.
   4
   5 The test program has been changed to use a configuration file instead of
   6 hard coded test procedures. The old test procedures are left in the
   7 program for backwards compatibility, but they will be removed at a later
   8 point in time.
   9
  10 The description of the old tests is in the readme file for the
  11 concurrency service in the directory:
  12         $TAO_ROOT/orbsvcs/Concurrency_Control
  13 please consult this file for a decription of these tests.
  14
  15 The new tests are described by this simle test language:
  16
  17 start:          /* empty */
  18                 | cmd_list
  19                 ;
  20
  21 cmd_list:       cmd_list cmd
  22                 | cmd
  23                 ;
  24
  25 cmd:              start <config_file_name> ;
  26                 | create <lock_set_name> ;
  27                 | create ;
  28                 | lock <lock_set_name> <lock_mode> ;
  29                 | lock <lock_mode> ;
  30                 | unlock <lock_set_name> <lock_mode> ;
  31                 | unlock <lock_mode> ;
  32                 | try_lock <lock_set_name> <lock_mode> ;
  33                 | try_lock <lock_mode> ;
  34                 | change_mode <lock_set_name> <lock_mode> <lock_mode> ;
  35                 | change_mode <lock_mode> <lock_mode> ;
  36                 | lookup <lock_set_name> ;
  37                 | sleep <int> ;
  38                 | repeat <int> ;
  39                 | wait ;
  40                 | wait <prompt> ;
  41                 ;
  42
  43 lock_mode:      read | intention_read | upgrade | write | intention_write
  44
  45 prompt:         " string "
  46
  47 If the lock set name is left out the default lock set is used. The
  48 repeat command just sets a global variable in the test, i.e. the last
  49 repeat command is the one that will take effect - the whole script is
  50 run the specified number of times.
  51
  52 An example of a script (assuming it's called 'test.cfg' - comments are
  53 not supported):
  54
  55   // Start a new CC_client with test.txt as script file
  56   start test.txt;
  57   // Create the lock set "ls1" and register it in the naming service
  58   create ls1;
  59   // Lock the read lock in the lock set
  60   lock ls1 read;
  61   // Try the read lock
  62   try_lock ls1 read;
  63   // sleep two seconds
  64   sleep 2;
  65   // Wait for the user to press enter
  66   wait;
  67   // Unlock the read lock in the ls1 lock set
  68   unlock ls1 read;
  69   // Change the mode of the read lock in the ls1 lock set to write mode
  70   change_mode ls1 read write;
  71
  72 The test can be run with the command ./CC_client -c test.cfg.
  73
  74 There are currentlig the following tests in the
  75    $TAO_ROOT/orbsvcs/tests/Concurrency
  76 directory:
  77   basic_tests.cfg    The same as running ./CC_client -b
  78   extended_tests.cfg The same as running ./CC_client -e '1;test'
  79                                          ./CC_client -e '2;test'
  80                                          ./CC_client -e '3;test'
  81   test.dinphil       Dining philosophers. Uses test.phil[1-5]
  82
  83 ----------------------------------------
  84
  85 THE IMPLEMENTATION
  86
  87 The implementation of the concurrency service tests is located in
  88 the $TAO_ROOT/orbsvcs/tests/Concurrency directory and consists of
  89 the following files:
  90
  91         CC_client.{h,cpp} contain initialization and the main function.
  92
  93         CC_tests.{h,cpp} The old tests [-b] and [-e] options to CC_client
  94
  95         CC_command.{h,cpp} The commands that can be used in the scripting
  96                 language are implemented in these files. The list of
  97                 commands to execute is also implemented here.
  98
  99         CC_command.l The lex file for the script language.
 100
 101         CC_command.y The yacc file for the script language.
 102
 103         CC_command.tab.{h,cpp} and lex.CC_command.cpp Derived files from
 104                 the lex and yacc files.
 105
 106         CC_naming_service.{h,cpp} A wrapper class around the necessary
 107                 naming service functinallity for the tests.
 108
 109         CC_test_utils.{h,cpp} provides a namespace for utility functions.
 110
 111         test.* Test scripts for the concurrency service.