tools/sg_unit_extractor.pl

   1 #! /usr/bin/perl
   2
   3 use strict;
   4
   5 my $progname="sg_unit_extractor";
   6 # Get the args
   7 die "USAGE: $progname infile [outfile]\n"
   8   if (scalar @ARGV == 0 || scalar @ARGV > 2);
   9 my ($infile,$outfile) = @ARGV;
  10
  11 if (not defined($outfile)) {
  12   $outfile =  $infile;
  13   $outfile =~ s/\.c$/_unit.c/;
  14   $outfile =~ s|.*/([^/]*)$|$1| if $outfile =~ m|/|;
  15 }
  16
  17 # Get the unit data
  18 my ($unit_source,$suite_name,$suite_title)=("","","");
  19 my (%tests); # to detect multiple definition
  20 my (@tests); # actual content
  21
  22 open IN, "$infile" || die "$progname: Cannot open input file '$infile': $!\n";
  23
  24 my $takeit=0;
  25 my $line=0;
  26 my $beginline=0;
  27 while (<IN>) {
  28   $line++;
  29   if (m/ifdef +SIMGRID_TEST/) {
  30     $beginline = $line;
  31     $takeit = 1;
  32     next;
  33   }
  34   if (m/endif.*SIMGRID_TEST/) {
  35     $takeit = 0;
  36     next
  37   }
  38
  39   if (m/XBT_TEST_SUITE\(\w*"([^"]*)"\w*,(.*?)\);/) { #"
  40     die "$progname: Multiple suites in the same file ($infile) are not supported yet\n"
  41       if length($suite_name);
  42     ($suite_name,$suite_title)=($1,$2);
  43     next;
  44   }
  45
  46   if (m/XBT_TEST_UNIT\(\w*"([^"]*)"\w*,([^,]*),(.*?)\)/) { #"
  47     die "$progname: multiply defined unit in file $infile: $1\n"
  48       if (defined($tests{$1}));
  49
  50     my @t=($1,$2,$3);
  51     push @tests,\@t;
  52     $tests{$1} = 1;
  53   }
  54   $unit_source .= $_ if $takeit;
  55 }
  56 close IN || die "$progname: cannot close input file '$infile': $!\n";
  57
  58
  59 if ($takeit) {
  60   die "$progname: end of file reached in SIMGRID_TEST block.\n".
  61      "You should end each of the with a line matching: /endif.*SIMGRID_TEST/\n".
  62      "Example:\n".
  63      "#endif /* SIMGRID_TEST */\n"
  64 }
  65
  66 die "$progname: no suite defined in $infile\n"
  67   unless (length($suite_name));
  68
  69 # Write the test
  70
  71 my ($GENERATED)=("/*******************************/\n".
  72                  "/* GENERATED FILE, DO NOT EDIT */\n".
  73                  "/*******************************/\n\n");
  74 $beginline+=2;
  75 open OUT,">$outfile" || die "$progname: Cannot open output file '$outfile': $!\n";
  76 print OUT $GENERATED;
  77 print OUT "#include <stdio.h>\n";
  78 print OUT "#include \"xbt.h\"\n";
  79 print OUT $GENERATED;
  80 print OUT "# $beginline \"$infile\" \n";
  81 print OUT "$unit_source";
  82 print OUT $GENERATED;
  83 close OUT || die "$progname: Cannot close output file '$outfile': $!\n";
  84
  85 # write the main skeleton if needed
  86 if (! -e "simgrid_units_main.c") {
  87   open OUT,">simgrid_units_main.c" || die "$progname: Cannot open main file 'simgrid_units_main.c': $!\n";
  88   print OUT $GENERATED;
  89   print OUT "#include <stdio.h>\n\n";
  90   print OUT "#include \"xbt.h\"\n\n";
  91   print OUT "extern xbt_test_unit_t _xbt_current_unit;\n\n";
  92   print OUT "/* SGU: BEGIN PROTOTYPES */\n";
  93   print OUT "/* SGU: END PROTOTYPES */\n\n";
  94   print OUT $GENERATED;
  95 #  print OUT "# 93 \"sg_unit_extractor.pl\"\n";
  96   print OUT <<EOF;
  97 int main(int argc, char *argv[]) {
  98   xbt_test_suite_t suite;
  99   char selection[1024];
 100   int i;\n
 101   /* SGU: BEGIN SUITES DECLARATION */
 102   /* SGU: END SUITES DECLARATION */
 103
 104   xbt_init(&argc,argv);
 105
 106   /* Search for the tests to do */
 107     selection[0]='\\0';
 108     for (i=1;i<argc;i++) {
 109       if (!strncmp(argv[i],\"--tests=\",strlen(\"--tests=\"))) {
 110         char *p=strchr(argv[i],'=')+1;
 111         if (selection[0] == '\\0') {
 112           strcpy(selection, p);
 113         } else {
 114           strcat(selection, \",\");
 115           strcat(selection, p);
 116         }
 117       } else if (!strncmp(argv[i],\"--dump-only\",strlen(\"--dump-only\"))||
 118                  !strncmp(argv[i],\"--dump\",     strlen(\"--dump\"))) {
 119         xbt_test_dump(selection);
 120         return 0;
 121       } else if (!strncmp(argv[i],\"--help\",strlen(\"--help\"))) {
 122           printf(
 123               "Usage: testall [--help] [--tests=selection] [--dump-only]\\n\\n"
 124               "--help: display this help\\n"
 125               "--dump-only: don't run the tests, but display some debuging info about the tests\\n"
 126               "--tests=selection: Use argument to select which suites/units/tests to run\\n"
 127               "                   --tests can be used more than once, and selection may be a comma\\n"
 128               "                   separated list of directives.\\n\\n"
 129               "Directives are of the form:\\n"
 130               "   [-]suitename[:unitname]\\n\\n"
 131               "If the first char is a '-', the directive disables its argument instead of enabling it\\n"
 132               "suitename/unitname is the set of tests to en/disable. If a unitname is not specified,\\n"
 133               "it applies on any unit.\\n\\n"
 134               "By default, everything is enabled.\\n\\n"
 135               "'all' as suite name apply to all suites.\\n\\n"
 136               "Example 1: \\"-toto,+toto:tutu\\"\\n"
 137               "  disables the whole toto testsuite (any unit in it),\\n"
 138               "  then reenables the tutu unit of the toto test suite.\\n\\n"
 139               "Example 2: \\"-all,+toto\\"\\n"
 140               "  Run nothing but the toto suite.\\n");
 141           return 0;
 142       } else {
 143         printf("testall: Unknown option: %s\\n",argv[i]);
 144         return 1;
 145       }
 146     }
 147   /* Got all my tests to do */
 148
 149   return xbt_test_run(selection);
 150 }
 151 EOF
 152   print OUT $GENERATED;
 153   close OUT || die "$progname: Cannot close main file 'simgrid_units_main.c': $!\n";
 154 }
 155
 156 print "  Suite $suite_name: $suite_title (".(scalar @tests)." tests)\n";
 157 map {
 158   my ($name,$func,$title) = @{$_};
 159   print "    unit $name: func=$func; title=$title\n";
 160 } @tests;
 161
 162 #while (my $t = shift @tests) {
 163
 164 # add this suite to the main
 165 my $newmain="";
 166 open IN,"simgrid_units_main.c" || die "$progname: Cannot open main file 'simgrid_units_main.c': $!\n";
 167   # search prototypes
 168   while (<IN>) {
 169     $newmain .= $_;
 170 #    print "Look for proto: $_";
 171     last if /SGU: BEGIN PROTOTYPES/;
 172   }
 173
 174   # search my prototype
 175   while (<IN>) {
 176 #    print "Seek protos: $_";
 177     last if  (/SGU: END PROTOTYPES/ || /SGU: BEGIN FILE $infile/);
 178     $newmain .= $_;
 179   }
 180   if (/SGU: BEGIN FILE $infile/) { # found an old section for this file. Kill it
 181     while (<IN>) {
 182       last if /SGU: END FILE/;
 183     }
 184     $_ = <IN>; # pass extra blank line
 185     chomp;
 186     die "this line should be blank ($_). Did you edit the file?" if /\W/;
 187   }
 188   my ($old_)=($_);
 189   # add my section
 190   $newmain .= "  /* SGU: BEGIN FILE $infile */\n";
 191   map {
 192     my ($name,$func,$title) = @{$_};
 193     $newmain .=  "    void $func(void);\n"
 194   } @tests;
 195
 196   $newmain .= "  /* SGU: END FILE */\n\n";
 197   if ($old_ =~ /SGU: BEGIN FILE/ || $old_ =~ /SGU: END PROTOTYPES/) {
 198     $newmain .= $old_;
 199   }
 200
 201   # pass remaining prototypes, search declarations
 202   while (<IN>) {
 203     $newmain .= $_ unless /SGU: END PROTOTYPES/;
 204     last if /SGU: BEGIN SUITES DECLARATION/;
 205   }
 206
 207   ### Done with prototypes. And now, the actual code
 208
 209   # search my prototype
 210   while (<IN>) {
 211     last if  (/SGU: END SUITES DECLARATION/ || /SGU: BEGIN FILE $infile/);
 212     $newmain .= $_;
 213   }
 214   if (/SGU: BEGIN FILE $infile/) { # found an old section for this file. Kill it
 215     while (<IN>) {
 216       last if /SGU: END FILE/;
 217     }
 218     $_ = <IN>; # pass extra blank line
 219     chomp;
 220     die "this line should be blank ($_). Did you edit the file?" if /\W/;
 221   }
 222   my ($old_)=($_);
 223   # add my section
 224   $newmain .= "    /* SGU: BEGIN FILE $infile */\n";
 225   $newmain .= "      suite = xbt_test_suite_by_name(\"$suite_name\",$suite_title);\n";
 226   map {
 227     my ($name,$func,$title) = @{$_};
 228     $newmain .=  "      xbt_test_suite_push(suite, \"$name\", $func, $title);\n";
 229   } @tests;
 230
 231   $newmain .= "    /* SGU: END FILE */\n\n";
 232   if ($old_ =~ /SGU: BEGIN FILE/ || $old_ =~ /SGU: END SUITES DECLARATION/) {
 233     $newmain .= $old_;
 234   }
 235
 236   # pass the remaining
 237   while (<IN>) {
 238     $newmain .= $_;
 239   }
 240 close IN || die "$progname: Cannot close main file 'simgrid_units_main.c': $!\n";
 241
 242 # write it back to main
 243 open OUT,">simgrid_units_main.c" || die "$progname: Cannot open main file 'simgrid_units_main.c': $!\n";
 244 print OUT $newmain;
 245 close OUT || die "$progname: Cannot close main file 'simgrid_units_main.c': $!\n";
 246
 247 0;