Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fix makedist
[simgrid.git] / tools / sg_unit_extractor.pl
index 4b96fd8..638ba49 100755 (executable)
@@ -1,38 +1,60 @@
-#! /usr/bin/perl
+#! /usr/bin/env perl
+
+# Copyright (c) 2005-2019. The SimGrid Team. All rights reserved.
+
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the license (GNU LGPL) which comes with this package.
 
 use strict;
-use Fcntl ':flock';
+use Getopt::Long qw(GetOptions);
+
+my $progname="sg_unit_extractor";
+# Get the args
 
-open SELF, "< $0" or die "Cannot open the lock file";
-if (!flock SELF, LOCK_EX | LOCK_NB) {
-    print STDERR "sg_unit_extractor already running. Cancelling...\n";
-    exit;
+sub usage($) {
+    my $ret;
+    print "USAGE: $progname [--root=part/to/cut] [--outdir=where/to/generate/files] infile [infile+]\n\n";
+    print "This program is in charge of extracting the unit tests out of the SimGrid source code.\n";
+    print "See http://simgrid.gforge.inria.fr/doc/latest/inside_tests.html for more details.\n";
+    exit $ret;
 }
 
-my $progname="sg_unit_extractor";
-# Get the args 
-die "USAGE: $progname infile [infile+]\n"
-  if (scalar @ARGV == 0);
+my $outdir=undef;
+my $root;
+my $help;
+
+Getopt::Long::config('permute','no_getopt_compat', 'no_auto_abbrev');
+GetOptions(
+        'help|h'                => sub {usage(0)},
+        'root=s' =>\$root,
+        'outdir=s' =>\$outdir) or usage(1);
+
+usage(1) if (scalar @ARGV == 0);
 
 map {process_one($_)} @ARGV;
 
 sub process_one($) {
-    
     my $infile = shift;
     my $outfile;
-    
+
+    $infile =~ s|src/|| unless (-e $infile);
+
     $outfile =  $infile;
     $outfile =~ s/\.c$/_unit.c/;
+    $outfile =~ s/\.cpp$/_unit.cpp/;
     $outfile =~ s|.*/([^/]*)$|$1| if $outfile =~ m|/|;
-    
-    
+    $outfile = "$outdir$outfile";
+
+    print "$progname: processing $infile (generating $outfile)...\n";
+
     # Get the unit data
     my ($unit_source,$suite_name,$suite_title)=("","","");
     my (%tests); # to detect multiple definition
     my (@tests); # actual content
-    
+
     open IN, "$infile" || die "$progname: Cannot open input file '$infile': $!\n";
-    
+    $infile =~ s|$root|| if defined($root);
+
     my $takeit=0;
     my $line=0;
     my $beginline=0;
@@ -58,9 +80,9 @@ sub process_one($) {
            die "$progname: Parse error: This line seem to be a test suite declaration, but failed to parse it\n$_\n";
        }
 
-        if (m/XBT_TEST_UNIT\(\w*"([^"]*)"\w*,([^,]*),(.*?)\)/) { #"{
+        if (m/XBT_TEST_UNIT\(\w*"([^"]*)"\w*, *([^,]*), *(.*?)\)/) { #"{
            die "$progname: multiply defined unit in file $infile: $1\n" if (defined($tests{$1}));
-            
+
            my @t=($1,$2,$3);
            push @tests,\@t;
            $tests{$1} = 1;
@@ -80,7 +102,7 @@ sub process_one($) {
     }
 
     die "$progname: no suite defined in $infile\n" unless (length($suite_name));
-  
+
     # Write the test
 
     my ($GENERATED)=("/*******************************/\n".
@@ -98,46 +120,49 @@ sub process_one($) {
     close OUT || die "$progname: Cannot close output file '$outfile': $!\n";
 
     # write the main skeleton if needed
-    if (! -e "simgrid_units_main.c") {
-       open OUT,">simgrid_units_main.c" || die "$progname: Cannot open main file 'simgrid_units_main.c': $!\n";
+    if (! -e "${outdir}simgrid_units_main.c") {
+       open OUT,">${outdir}simgrid_units_main.c" || die "$progname: Cannot open main file '${outdir}simgrid_units_main.c': $!\n";
        print OUT $GENERATED;
        print OUT "#include <stdio.h>\n\n";
        print OUT "#include \"xbt.h\"\n\n";
        print OUT "extern xbt_test_unit_t _xbt_current_unit;\n\n";
+       print OUT "#define STRLEN 1024\n";
        print OUT "/* SGU: BEGIN PROTOTYPES */\n";
        print OUT "/* SGU: END PROTOTYPES */\n\n";
        print OUT $GENERATED;
        #  print OUT "# 93 \"sg_unit_extractor.pl\"\n";
        print OUT <<EOF;
 int main(int argc, char *argv[]) {
-  xbt_test_suite_t suite; 
-  char selection[1024];
-  int i;\n
-  int res;\n
+  xbt_test_suite_t suite;
+  char selection[STRLEN];
+  int verbosity = 0;
+  int i;
+  int res;
+
   /* SGU: BEGIN SUITES DECLARATION */
   /* SGU: END SUITES DECLARATION */
-      
+
   xbt_init(&argc,argv);
-    
+
   /* Search for the tests to do */
     selection[0]='\\0';
     for (i=1;i<argc;i++) {
       if (!strncmp(argv[i],\"--tests=\",strlen(\"--tests=\"))) {
         char *p=strchr(argv[i],'=')+1;
-        if (selection[0] == '\\0') {
-          strcpy(selection, p);
-        } else {
-          strcat(selection, \",\");
-          strcat(selection, p);
-        }
-      } else if (!strncmp(argv[i],\"--dump-only\",strlen(\"--dump-only\"))||
-                !strncmp(argv[i],\"--dump\",     strlen(\"--dump\"))) {
+        if (selection[0] != '\\0')
+          strncat(selection, \",\", STRLEN - 1 - strlen(selection));
+        strncat(selection, p, STRLEN - 1 - strlen(selection));
+      } else if (!strcmp(argv[i], \"--verbose\")) {
+        verbosity++;
+      } else if (!strcmp(argv[i], \"--dump-only\")||
+                 !strcmp(argv[i], \"--dump\")) {
         xbt_test_dump(selection);
         return 0;
-      } else if (!strncmp(argv[i],\"--help\",strlen(\"--help\"))) {
+      } else if (!strcmp(argv[i], \"--help\")) {
          printf(
              "Usage: testall [--help] [--tests=selection] [--dump-only]\\n\\n"
              "--help: display this help\\n"
+             "--verbose: print the name for each running test\\n"
              "--dump-only: don't run the tests, but display some debuging info about the tests\\n"
              "--tests=selection: Use argument to select which suites/units/tests to run\\n"
              "                   --tests can be used more than once, and selection may be a comma\\n"
@@ -161,14 +186,14 @@ int main(int argc, char *argv[]) {
       }
     }
   /* Got all my tests to do */
-      
-  res = xbt_test_run(selection);
+
+  res = xbt_test_run(selection, verbosity);
   xbt_test_exit();
   return res;
 }
 EOF
        print OUT $GENERATED;
-       close OUT || die "$progname: Cannot close main file 'simgrid_units_main.c': $!\n";
+       close OUT || die "$progname: Cannot close main file '${outdir}simgrid_units_main.c': $!\n";
     }
 
    print "  Suite $suite_name: $suite_title (".(scalar @tests)." tests)\n";
@@ -181,7 +206,7 @@ EOF
 
    # add this suite to the main
    my $newmain="";
-   open IN,"simgrid_units_main.c" || die "$progname: Cannot open main file 'simgrid_units_main.c': $!\n";
+   open IN,"${outdir}simgrid_units_main.c" || die "$progname: Cannot open main file '${outdir}simgrid_units_main.c': $!\n";
     # search prototypes
        while (<IN>) {
           $newmain .= $_;
@@ -195,7 +220,7 @@ EOF
           last if  (/SGU: END PROTOTYPES/ || /SGU: BEGIN FILE $infile/);
           $newmain .= $_;
        }
-       if (/SGU: BEGIN FILE $infile/) { # found an old section for this file. Kill it    
+       if (/SGU: BEGIN FILE $infile/) { # found an old section for this file. Kill it
           while (<IN>) {
               last if /SGU: END FILE/;
           }
@@ -210,26 +235,26 @@ EOF
           my ($name,$func,$title) = @{$_};
           $newmain .=  "    void $func(void);\n"
        } @tests;
-       
+
        $newmain .= "  /* SGU: END FILE */\n\n";
        if ($old_ =~ /SGU: BEGIN FILE/ || $old_ =~ /SGU: END PROTOTYPES/) {
           $newmain .= $old_;
        }
-       
+
        # pass remaining prototypes, search declarations
        while (<IN>) {
           $newmain .= $_ unless /SGU: END PROTOTYPES/;
           last if /SGU: BEGIN SUITES DECLARATION/;
        }
-       
-       ### Done with prototypes. And now, the actual code
-       
+
+       ### Done with prototypes. And now, the actual code
+
        # search my prototype
        while (<IN>) {
           last if  (/SGU: END SUITES DECLARATION/ || /SGU: BEGIN FILE $infile/);
           $newmain .= $_;
        }
-       if (/SGU: BEGIN FILE $infile/) { # found an old section for this file. Kill it    
+       if (/SGU: BEGIN FILE $infile/) { # found an old section for this file. Kill it
           while (<IN>) {
               last if /SGU: END FILE/;
           }
@@ -243,24 +268,24 @@ EOF
        $newmain .= "      suite = xbt_test_suite_by_name(\"$suite_name\",$suite_title);\n";
        map {
           my ($name,$func,$title) = @{$_};
-          $newmain .=  "      xbt_test_suite_push(suite, \"$name\", $func, $title);\n";
+          $newmain .=  "      xbt_test_suite_push(suite, \"$name\", &$func, $title);\n";
        } @tests;
-       
+
        $newmain .= "    /* SGU: END FILE */\n\n";
        if ($old_ =~ /SGU: BEGIN FILE/ || $old_ =~ /SGU: END SUITES DECLARATION/) {
           $newmain .= $old_;
        }
-       
-       # pass the remaining 
+
+       # pass the remaining
        while (<IN>) {
           $newmain .= $_;
        }
-       close IN || die "$progname: Cannot close main file 'simgrid_units_main.c': $!\n";
-       
+       close IN || die "$progname: Cannot close main file '${outdir}simgrid_units_main.c': $!\n";
+
        # write it back to main
-       open OUT,">simgrid_units_main.c" || die "$progname: Cannot open main file 'simgrid_units_main.c': $!\n";
+       open OUT,">${outdir}simgrid_units_main.c" || die "$progname: Cannot open main file '${outdir}simgrid_units_main.c': $!\n";
        print OUT $newmain;
-       close OUT || die "$progname: Cannot close main file 'simgrid_units_main.c': $!\n";
+       close OUT || die "$progname: Cannot close main file '${outdir}simgrid_units_main.c': $!\n";
 } # end if process_one($)
 
 0;