Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Call xbt_exit in the test runner (to check leaks)
[simgrid.git] / 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   int res;\n
102   /* SGU: BEGIN SUITES DECLARATION */
103   /* SGU: END SUITES DECLARATION */
104       
105   xbt_init(&argc,argv);
106     
107   /* Search for the tests to do */
108     selection[0]='\\0';
109     for (i=1;i<argc;i++) {
110       if (!strncmp(argv[i],\"--tests=\",strlen(\"--tests=\"))) {
111         char *p=strchr(argv[i],'=')+1;
112         if (selection[0] == '\\0') {
113           strcpy(selection, p);
114         } else {
115           strcat(selection, \",\");
116           strcat(selection, p);
117         }
118       } else if (!strncmp(argv[i],\"--dump-only\",strlen(\"--dump-only\"))||
119                  !strncmp(argv[i],\"--dump\",     strlen(\"--dump\"))) {
120         xbt_test_dump(selection);
121         return 0;
122       } else if (!strncmp(argv[i],\"--help\",strlen(\"--help\"))) {
123           printf(
124               "Usage: testall [--help] [--tests=selection] [--dump-only]\\n\\n"
125               "--help: display this help\\n"
126               "--dump-only: don't run the tests, but display some debuging info about the tests\\n"
127               "--tests=selection: Use argument to select which suites/units/tests to run\\n"
128               "                   --tests can be used more than once, and selection may be a comma\\n"
129               "                   separated list of directives.\\n\\n"
130               "Directives are of the form:\\n"
131               "   [-]suitename[:unitname]\\n\\n"
132               "If the first char is a '-', the directive disables its argument instead of enabling it\\n"
133               "suitename/unitname is the set of tests to en/disable. If a unitname is not specified,\\n"
134               "it applies on any unit.\\n\\n"
135               "By default, everything is enabled.\\n\\n"
136               "'all' as suite name apply to all suites.\\n\\n"
137               "Example 1: \\"-toto,+toto:tutu\\"\\n"
138               "  disables the whole toto testsuite (any unit in it),\\n"
139               "  then reenables the tutu unit of the toto test suite.\\n\\n"
140               "Example 2: \\"-all,+toto\\"\\n"
141               "  Run nothing but the toto suite.\\n");
142           return 0;
143       } else {
144         printf("testall: Unknown option: %s\\n",argv[i]);
145         return 1;
146       }
147     }
148   /* Got all my tests to do */
149       
150   res = xbt_test_run(selection);
151   xbt_exit();
152   return res;
153 }
154 EOF
155   print OUT $GENERATED;
156   close OUT || die "$progname: Cannot close main file 'simgrid_units_main.c': $!\n";
157 }
158
159 print "  Suite $suite_name: $suite_title (".(scalar @tests)." tests)\n";
160 map {
161   my ($name,$func,$title) = @{$_};
162   print "    unit $name: func=$func; title=$title\n";
163 } @tests;
164
165 #while (my $t = shift @tests) {
166
167 # add this suite to the main
168 my $newmain="";
169 open IN,"simgrid_units_main.c" || die "$progname: Cannot open main file 'simgrid_units_main.c': $!\n";
170   # search prototypes
171   while (<IN>) {
172     $newmain .= $_;
173 #    print "Look for proto: $_";
174     last if /SGU: BEGIN PROTOTYPES/;
175   }
176
177   # search my prototype
178   while (<IN>) {
179 #    print "Seek protos: $_";
180     last if  (/SGU: END PROTOTYPES/ || /SGU: BEGIN FILE $infile/);
181     $newmain .= $_;
182   }
183   if (/SGU: BEGIN FILE $infile/) { # found an old section for this file. Kill it    
184     while (<IN>) {
185       last if /SGU: END FILE/;
186     }
187     $_ = <IN>; # pass extra blank line
188     chomp;
189     die "this line should be blank ($_). Did you edit the file?" if /\W/;
190   }
191   my ($old_)=($_);
192   # add my section
193   $newmain .= "  /* SGU: BEGIN FILE $infile */\n";
194   map {
195     my ($name,$func,$title) = @{$_};
196     $newmain .=  "    void $func(void);\n"
197   } @tests;
198
199   $newmain .= "  /* SGU: END FILE */\n\n";
200   if ($old_ =~ /SGU: BEGIN FILE/ || $old_ =~ /SGU: END PROTOTYPES/) {
201     $newmain .= $old_;
202   }
203
204   # pass remaining prototypes, search declarations
205   while (<IN>) {
206     $newmain .= $_ unless /SGU: END PROTOTYPES/;
207     last if /SGU: BEGIN SUITES DECLARATION/;
208   }
209
210   ###┬áDone with prototypes. And now, the actual code
211   
212   # search my prototype
213   while (<IN>) {
214     last if  (/SGU: END SUITES DECLARATION/ || /SGU: BEGIN FILE $infile/);
215     $newmain .= $_;
216   }
217   if (/SGU: BEGIN FILE $infile/) { # found an old section for this file. Kill it    
218     while (<IN>) {
219       last if /SGU: END FILE/;
220     }
221     $_ = <IN>; # pass extra blank line
222     chomp;
223     die "this line should be blank ($_). Did you edit the file?" if /\W/;
224   }
225   my ($old_)=($_);
226   # add my section
227   $newmain .= "    /* SGU: BEGIN FILE $infile */\n";
228   $newmain .= "      suite = xbt_test_suite_by_name(\"$suite_name\",$suite_title);\n";
229   map {
230     my ($name,$func,$title) = @{$_};
231     $newmain .=  "      xbt_test_suite_push(suite, \"$name\", $func, $title);\n";
232   } @tests;
233
234   $newmain .= "    /* SGU: END FILE */\n\n";
235   if ($old_ =~ /SGU: BEGIN FILE/ || $old_ =~ /SGU: END SUITES DECLARATION/) {
236     $newmain .= $old_;
237   }
238
239   # pass the remaining 
240   while (<IN>) {
241     $newmain .= $_;
242   }
243 close IN || die "$progname: Cannot close main file 'simgrid_units_main.c': $!\n";
244
245 # write it back to main
246 open OUT,">simgrid_units_main.c" || die "$progname: Cannot open main file 'simgrid_units_main.c': $!\n";
247 print OUT $newmain;
248 close OUT || die "$progname: Cannot close main file 'simgrid_units_main.c': $!\n";
249
250 0;