WebSVN – DevTools – Diff – /core_devl/trunk/TOOLS/jats_sandbox.pl

 my @opt_ignorePackage;                      # Control recursion
 my $opt_allSandbox;                         # Extend scope to entire sandbox
 my $opt_processUsedBy;                      # Process dependants(consumers) not dependents(children)
 my $opt_keepgoing;                          # Ignore errors
 my $opt_reScan;                             # Rescan for buildfiles
+my $opt_multiBuilders = 0;                  # How handle packages with multiple bulders: 0:Error, 1:Report, 2:Ignore
+#
 #   Globals - Provided by the JATS environment
+#
 my $USER            = $ENV{'USER'};
 my @build_order = ();                           # Build Ordered list of entries
 my %extern_deps;                                # Hash of external dependencies
 my %packages;                                   # Hash of packages
 my $currentPkgTag;                              # Tag of the current package - if any
 my $scanDepth;                                  # Depth for build file scan
+my $maxDname = 0;                               # Pretty display
+#
 #   Known files
+#
 my $cacheFile  = $GBE_DPKG_SBOX . '/location_cache';
 my $depthFile  = $GBE_DPKG_SBOX . '/scanDepth';
-my $filterFile = $GBE_SANDBOX   . '/buildfilter';
+my $filterFile = $GBE_DPKG_SBOX . '/buildfilter';
 #-------------------------------------------------------------------------------
 # Function        : Mainline Entry Point
+#
 # Description     :
     my $show = 0;
     my $showUsage = 0;
     my $showFingerPrint = 0;
     my $showDependencies = 1;
     my $showOrder = 1;
+    my $showPath = 0;
     Getopt::Long::Configure('pass_through');
     getOptionsFromArray ( \@cmd_opts,
                           'verbose:+'       => \$show,
                           'usedby'          => \$showUsage,
                           'fingerprint!'    => \$showFingerPrint,
                           'dependencies!'   => \$showDependencies,
                           'buildorder!'     => \$showOrder,
+                          'path!'           => \$showPath,
                         ) || Error ("Invalid command line" );
     SubCommandHelp( $opt_help, "Sandbox Information") if ($opt_help || $#cmd_opts >=0 );
     $showUsage = 1 if ($show >= 2);
+    #
     Message ("BuildFilter: $GBE_BUILDFILTER" . ( (-f $filterFile)  ? ' - Local to sandbox' : ''));
     if ($showOrder)
+    {
         Message ("Build Order");
-        foreach my $pname ( @stopped )
+        foreach my $pname ( @stopped ) {
-        {
             Message( "    Level:" . "--"  . " [---] Name: " . $pname . ' (Stopped)');
+        }
         foreach my $fe ( @build_order )
+        {
-            displayHeader($fe, { indent => '    ', testFingerPrint =>  $showFingerPrint, showIcons => 1});
+            displayHeader($fe, { indent => '    ', testFingerPrint =>  $showFingerPrint, showSimplePath => $showPath });
             if ( $show )
+            {
                 Message( DisplayPath ("        Path: $fe->{dir}" ));
                 foreach my $idep ( sort values %{$fe->{'ideps'}} )
+        {
             my $ifaceDir = getpkgInterface($pe);
             if ($ifaceDir)
+            {
                 Message ("Generate Fingerprint");
+                Verbose ("Fingerprint file: $tagFile");
                 FileCreate( $tagFile, genPkgFingerPrint($pe,'Generation') );
+            }
             else
+            {
                 Warning("Package has not been built. Cannot generate fingerprint: $pkgName");
 #                       @build_order - build ordered array of build entries
+#
 sub calc_sandbox_info
+{
     my ($quiet) = @_;
+    my $buildFileDepth = 0;
     getScanDepth();
+    #
     #   Start from the root of the sandbox
+    #
     unless (@build_list)
+    {
         Message ("Scanning sandbox for build files");
         FileCreate($cacheFile, $currentRootFingerPrint );
-        Message ("Build File scan depth: ". $scanDepth) if ($SCANDEPTH ne $scanDepth);
         my @locationData;
         foreach my $pname ( glob("*") )
+        {
             next if ( $pname =~ m~^\.~ );
                 Warning ("Package does not have build files: $pname") unless ( @blist );
                 Warning ("Package has multiple build files: $pname") if ( $#blist > 0 );
+            }
             push @build_list, @blist;
             push @locationData, $bscanner->getLocation();
+            #
+            #   Determine max build file depth - just to show user
+            #
+            foreach ( @blist)
+            {
+                my $count = () = $_->{dir} =~ m~/~g;
+                $buildFileDepth = $count if ($count > $buildFileDepth)
+            }
+        }
+        Message ("Max Build File Depth : " . ($buildFileDepth + 1));
+        Message ("Build File Scan Depth: ". $scanDepth) if ($SCANDEPTH ne $scanDepth);
+        #
         #   Save (cache) location information
+        #
         FileAppend($cacheFile, @locationData);
         #       Set a suitable tag
+        #
         $be->{dname} = $opt_exact ? $be->{full}    : $be->{mname};
         $be->{tag}   = $opt_exact ? $be->{fullTag} : $be->{package};
         $be->{fname} = join ('_', $be->{name}, $be->{version});
+        if (length ($be->{dname}) > $maxDname ) {
+             $maxDname = length ($be->{dname});
+        }
 #        DebugDumpData ("be", $be );
+        #
         #   Catch multiple builds for the same package
         #   Report later - when we have all
+        #
         next unless ( $be->{dname} );
-        push @{$multi{$be->{dname}}},$be->{dir};
+        push @{$multi{$be->{dname}}},$be;
-        #
-        #   Add into dependency struct
-        #
-        $depends{$be->{tag}} = $be;
+    }
+    #
+    #   Detect, process and report packages that have multiple builders
+    #       An error that can be ignored
+    #
     foreach my $dname ( sort keys %multi )
+    {
-        ReportError ("Multiple builders for : $dname", @{$multi{$dname}} )
+        my $errFn = $opt_multiBuilders ? \&Warning : \&ReportError;
-            if ( scalar @{$multi{$dname}} > 1 );
+        if ( scalar @{$multi{$dname}} > 1 )
+        {
+            my @dirList;
+            foreach my $be (@{$multi{$dname}}) {
+                push @dirList, $be->{dir};
+            }
+            &$errFn("Multiple builders for : $dname", @dirList ) unless $opt_multiBuilders > 1;
+        }
+        else
+        {
+            #
+            #   Add into dependency struct
+            #
+            foreach my $be (@{$multi{$dname}}) {
+                $depends{$be->{tag}} = $be;
+            }
+        }
+    }
+    %multi = ();
     ErrorDoExit();
 #DebugDumpData ("depends", \%depends );
+    #
 # Returns         : Will exit
+#
 sub cmd
+{
     my ($hcmd, @cmd_opts ) = @_;
+    my $opt_reverse;
     Getopt::Long::Configure('pass_through');
+    getOptionsFromArray ( \@cmd_opts,
+                          'reverse!' => \$opt_reverse,
-    getOptionsFromArray ( \@cmd_opts ) || Error ("Invalid command line" );
+                          ) || Error ("Invalid command line" );
     SubCommandHelp( $opt_help, $hcmd) if ($opt_help  );
+    #
     #   Determine Sandbox information
     #   Populate global variables
+    #
     calc_sandbox_info();
+    if ($opt_reverse) {
+        @build_order = reverse @build_order;
+    }
     foreach my $fe ( @build_order )
+    {
         my $active = displayHeader($fe, { showPath => 1 });
         if ($active)
                         if ($opt_keepgoing)
+                        {
                             Warning( "Build Cmd failure - Keep going");
                             next;
+                        }
-                        Error ("Build Cmd failure");
+                        Error ("Build Cmd failure: $dir");
+                    }
+                    #
                     #   Skip make if we have a prebuilt package
+                    #
                             if ($opt_keepgoing)
+                            {
                                 Warning( "Make Cmd failure - Keep going");
                                 next;
+                            }
-                            Error ("Make Cmd failure");
+                            Error ("Make Cmd failure: $dir");
+                        }
+                    }
+                }
+                Verbose ("Save fingerprint: $tagFile");
                 FileCreate( $tagFile, genPkgFingerPrint($fe,'Generation') );
+            }
             else
+            {
                 Message ("No file changes since last build. Skipping")
+    }
     exit 0;
+}
 #-------------------------------------------------------------------------------
 # Function        : clean
+#
 # Description     : Execute a command in all the sandboxes
 #                       Locate the base of the sandbox
 sub getOptionsFromArray
+{
     my ($pArray, %args) = @_;
+    #
+    #   Helper to parse --multiBuilders
+    #
+    my $parseMulti = sub {
+        my ($ref, $value) = @_;
+        $value = 'error' unless length($value);
+        my %valid = (error => 0, report => 1, ignore => 2);
+        unless (exists $valid{lc $value}) {
+            die ("Invalid option for  --$ref->{name}\n");
+        };
+        $opt_multiBuilders = $valid{lc $value};
+    };
+    #
     #   Common arguments
+    #
     my %commonOptions = (
         'help|h:+'          => \$opt_help,
         'manual:3'          => \$opt_help,
         'ignorepackage:s'   => sub{ opts_add2List( \@opt_ignorePackage, @_ )},
         'entireSandBox!'    => \$opt_allSandbox,
         'users!'            => \$opt_processUsedBy,
         'keepgoing!'        => \$opt_keepgoing,
         'rescan!'           => \$opt_reScan,
+        'multiBuilders:s'   => $parseMulti,
         );
+    #
     #   Merge in the user options
+    #
+}
 #-------------------------------------------------------------------------------
 # Function        : displayHeader
+#
-# Description     : Display a build header
+# Description     : Display a build header, if the entry is active
+#                   ie: Between a --From and --To
+#
 # Inputs          : $fe             - Build entry
+#                   Hash of options
-#                   $indent         - Indent text
+#                       indent          => Text       - Indent text
-#                   $showPath       - Boolean
+#                       showPath        => Bool
+#                       showSimplePath  => Bool
+#                       testFingerPrint => Bool
+#
 # Returns         : True if this entry is to be fully process
 #                   False if its being skipped
+#
 sub displayHeader
+{
     my $fe = shift @_;
+    if ($fe->{buildActive} || $fe->{buildSkip})
+    {
-    my $args = pop @_ if (@_ > 0 and UNIVERSAL::isa($_[-1],'HASH'));
+        my $args = pop @_ if (@_ > 0 and UNIVERSAL::isa($_[-1],'HASH'));
-    #    my ($fe, %args) = @_;
+        #    my ($fe, %args) = @_;
-    my $indent = $args->{indent} || '';
-    my $showPath = $args->{showPath};
-    my ($status, $estatus) = addBuildInfo($fe, $args);
+        my $indent = $args->{indent} || '';
+        my $showPath = $args->{showPath};
+        my $showSimplePath = $args->{showSimplePath};
+        my ($status, $estatus) = addBuildInfo($fe, $args);
+        $estatus = '' if $showSimplePath;
-    my $msg1 = $indent . sprintf('Level:%02d [%s] Name: %s', $fe->{level}, $status, $fe->{dname} . $estatus );
+        my $msg1 = $indent . sprintf('Level:%02d [%s] Name: %s', $fe->{level}, $status, $fe->{dname} . $estatus );
+        if ($showSimplePath) {
+            my $msg1Len = length($msg1);
+            $msg1 = sprintf("%-*s Path: %s", 26 + $maxDname ,$msg1, $fe->{dir});
+        }
-    if ( $showPath) {
+        if ( $showPath) {
-        my $msg1Len = length($msg1);
+            my $msg1Len = length($msg1);
-        if ($msg1Len < 80) {
+            if ($msg1Len < 80) {
-            $msg1 .= ' ' . '=' x (79 - $msg1Len);
+                $msg1 .= ' ' . '=' x (79 - $msg1Len);
+            }
+        }
+        Message( $msg1 ,  $showPath ? DisplayPath ("        Path: $fe->{dir}" ) : undef);
+    }
-    Message( $msg1 ,  $showPath ? DisplayPath ("        Path: $fe->{dir}" ) : undef);
    return $fe->{buildActive};
+}
 #-------------------------------------------------------------------------------
     -fromPackage=name          - Start building from package
     -justPackage=name[,name]   - Build named packages
     -ignorePackage=name[,name] - Do not build named packages
     -entireSandbox             - Process the entire sandbox
     -users                     - Process package users, not dependencies
+ Options common to all commands:
     -[no]keepgoing             - Ignore errors
     -[no]reScan                - Recalculate and cache sandbox structure
+    -multiBuilders=mode        - Handle conflicting packages. error|report|ignore
  Commands:
     help                - Same as -help
     create              - Create a sandbox in the current directory
     populate            - Populate the sandbox with packages
 The package names can be specified as a mix of the three forms described under the '-toPackage' option.
 =item B<-[no]entireSandbox>
-This option will override the automatic package localisation that will occur if the user starts the comamnd
+This option will override the automatic package localisation that will occur if the user starts the command
-within a subdirectory of a package within the sandbox and will process the entire sabdbox.
+within a subdirectory of a package within the sandbox and will process the entire sanbbox.
 If the user start the command within a subdirectory of a package then the sandbox commands will be localised
 to the current package and the dependencies of the package.
 =item B<-[no]users>
 If a package is added or removed from the sandbox, then the sandbox will need to be rescanned.
 Jats will detect when a package has been added or removed, but if the internal structure of the
 packages has changed the cached data may be incorrect.
+=item B<-multiBuilders=mode>
+If a package-name can be built by multiple packages then the sandbox processing will
+normally report an error.
+This option allow the error to be reported as a warning or to be ignored altogether. The named package will be
+excluded from the build set.
+Valid values for 'mode' are: error, report and ignore.  The default mode is 'error'.
 =back
 =head1 DESCRIPTION
 This program is the primary tool for the maintenance of Development Sandboxes.
 =head2 SYNOPSIS
 jats sandbox populate [command options] [packageName packageVersion]
- Command Options
+ Common Options:
-    -help[=n]                  - Command specific help, [n=1,2,3]
+    -help[=n], -man            - Command specific help, [n=1,2,3]
     -toPackage=name            - Stop building after package
     -fromPackage=name          - Start building from package
     -justPackage=name[,name]   - Build named packages
     -ignorePackage=name[,name] - Do not build named packages
     -entireSandbox             - Process the entire sandbox
     -users                     - Process package users, not dependencies
+    -multiBuilders=mode        - Handle conflicting packages. error|report|ignore
+    -[no]keepgoing             - Ignore errors
+    -[no]reScan                - Recalculate and cache sandbox structure
+ Command Specific Options
     -excludePackage=name[,name]- Do not extract named package
     -recurse[=n]               - Locate dependencies within packages
     -all                       - Populate with all dependencies
     -missing                   - Locate missing packages
     -show                      - Show packages that would be extracted
 =head2 SYNOPSIS
 jats sandbox info [command options]
- Command Options
+ Common Options:
-    -help[=n]                  - Command specific help, [n=1,2,3]
+    -help[=n], -man            - Command specific help, [n=1,2,3]
-    -verbose[=n]               - Display more information
-    -usedby                    - Display package usage information
     -toPackage=name            - Stop building after package
     -fromPackage=name          - Start building from package
     -justPackage=name[,name]   - Build named packages
     -ignorePackage=name[,name] - Do not build named packages
     -entireSandbox             - Process the entire sandbox
     -users                     - Process package users, not dependencies
+    -multiBuilders=mode        - Handle conflicting packages. error|report|ignore
+    -[no]keepgoing             - Ignore errors
+    -[no]reScan                - Recalculate and cache sandbox structure
+ Command Specific Options
+    -verbose[=n]               - Display more information
+    -usedby                    - Display package usage information
     -fingerprint               - Display fingerprint information
     -[no]dependencies          - Display external dependencies (default)
     -[no]buildorder            - Display build order (default)
+    -[no]path                  - Display path to package
 =head2 OPTIONS
 =over
 =item B<-[no]buildorder>
 This option will cause the information display to include all the build order.
+=item B<-[no]path>
+This option will cause the information display to include all the path to the build file
 =back
 =head2 DESCRIPTION
 The 'info' command will display information about the build order and the
 =head2 SYNOPSIS
 jats sandbox all [command options] [arguments]
- Command Options
+ Common Options:
-    -help[=n]                  - Command specific help, [n=1,2,3]
+    -help[=n], -man            - Command specific help, [n=1,2,3]
     -toPackage=name            - Stop building after package
     -fromPackage=name          - Start building from package
     -justPackage=name[,name]   - Build named packages
     -ignorePackage=name[,name] - Do not build named packages
     -entireSandbox             - Process the entire sandbox
     -users                     - Process package users, not dependencies
+    -multiBuilders=mode        - Handle conflicting packages. error|report|ignore
     -[no]keepgoing             - Ignore errors
+    -[no]reScan                - Recalculate and cache sandbox structure
+ Command Specific Options
     -[no]skip                  - Skip if no source change (default:skip)
 =head2 ARGUMENTS
 =head2 SYNOPSIS
 jats sandbox build [command options] [arguments]
- Command Options
+ Common Options:
-    -help[=n]                  - Command specific help, [n=1,2,3]
+    -help[=n], -man            - Command specific help, [n=1,2,3]
     -toPackage=name            - Stop building after package
     -fromPackage=name          - Start building from package
     -justPackage=name[,name]   - Build named packages
     -ignorePackage=name[,name] - Do not build named packages
     -entireSandbox             - Process the entire sandbox
     -users                     - Process package users, not dependencies
+    -multiBuilders=mode        - Handle conflicting packages. error|report|ignore
     -[no]keepgoing             - Ignore errors
+    -[no]reScan                - Recalculate and cache sandbox structure
+ Command Specific Options
     -[no]skip                  - Skip if no source change (default:skip)
 =head2 ARGUMENTS
 Arguments are passed to the 'make' phase of the process.
 =head2 SYNOPSIS
 jats sandbox clean|clobber [command options]
- Command Options
+ Common Options:
-    -help[=n]                  - Command specific help, [n=1,2,3]
+    -help[=n], -man            - Command specific help, [n=1,2,3]
     -toPackage=name            - Stop building after package
     -fromPackage=name          - Start building from package
     -justPackage=name[,name]   - Build named packages
     -ignorePackage=name[,name] - Do not build named packages
     -entireSandbox             - Process the entire sandbox
     -users                     - Process package users, not dependencies
+    -multiBuilders=mode        - Handle conflicting packages. error|report|ignore
     -[no]keepgoing             - Ignore errors
+    -[no]reScan                - Recalculate and cache sandbox structure
 =head2 ARGUMENTS
 None
 =head2 OPTIONS
-=over
-=item B<-[no]keepgoing>
-This options controls the behaviour of the command when an error is encountered.
-The default operation is to terminate the command on the package with the
-error. This can be modified so that errors are ignored.
+The are no command specific options.
-=back
 =head2 DESCRIPTION
 The 'clean' command will perform a 'jats make clean' in all components in the
 sandbox.
 =head2 SYNOPSIS
 jats sandbox make [command options] [arguments]
- Command Options
+ Common Options:
-    -help[=n]                  - Command specific help, [n=1,2,3]
+    -help[=n], -man            - Command specific help, [n=1,2,3]
     -toPackage=name            - Stop building after package
     -fromPackage=name          - Start building from package
     -justPackage=name[,name]   - Build named packages
     -ignorePackage=name[,name] - Do not build named packages
     -entireSandbox             - Process the entire sandbox
     -users                     - Process package users, not dependencies
+    -multiBuilders=mode        - Handle conflicting packages. error|report|ignore
+    -[no]keepgoing             - Ignore errors
+    -[no]reScan                - Recalculate and cache sandbox structure
 =head2 ARGUMENTS
 Arguments are passed to the 'make' phase of the process.
 =head2 SYNOPSIS
 jats sandbox cmd [command options] [arguments]
- Command Options
+ Common Options:
-    -help[=n]                  - Command specific help, [n=1,2,3]
+    -help[=n], -man            - Command specific help, [n=1,2,3]
-    -[no]keepgoing             - Ignore errors
     -toPackage=name            - Stop building after package
     -fromPackage=name          - Start building from package
     -justPackage=name[,name]   - Build named packages
     -ignorePackage=name[,name] - Do not build named packages
     -entireSandbox             - Process the entire sandbox
     -users                     - Process package users, not dependencies
+    -multiBuilders=mode        - Handle conflicting packages. error|report|ignore
+    -[no]keepgoing             - Ignore errors
+    -[no]reScan                - Recalculate and cache sandbox structure
+ Command Specific Options
+    -[no]reverse               - Reverse the processing order
 =head2 ARGUMENTS
 Arguments are passed to a JATS command.
 =head2 OPTIONS
-=over
+The 'cmd' command takes the following options:
-=item B<-[no]keepgoing>
+=over 8
-This options controls the behaviour of the command when an error is encountered.
+=item -[no]reverse
-The default operation is to terminate the command on the package with the
+This option will controlls the order in which the packages will be processed.
-error. This can be modified so that errors are ignored.
+The default option is 'noreverse'. Packages will be processed in the build order.
 =back
 =head2 DESCRIPTION

Subversion Repositories DevTools

(root)/core_devl/trunk/TOOLS/jats_sandbox.pl – Rev 6192 → 6198