WebSVN – DevTools – Diff – /core_devl/branches/gitBuilder/TOOLS/jats_sandbox.pl

 use FileUtils;
 use JatsBuildFiles;
 use JatsVersionUtils;
 use ArrayHashUtils;
 use ToolsetFiles;
+use ReadBuildConfig;
 use Pod::Usage;                             # required for help support
 use Getopt::Long qw(:config require_order); # Stop on non-option
 use Digest;
 use JSON;
 #   Globals - Provided by the JATS environment
+#
 my $USER            = $ENV{'USER'};
 my $UNIX            = $ENV{'GBE_UNIX'};
 my $HOME            = $ENV{'HOME'};
+my $GBE_ABT         = $ENV{'GBE_ABT'};
 my $GBE_SANDBOX     = $ENV{'GBE_SANDBOX'};
 my $GBE_DPKG_SBOX   = $ENV{'GBE_DPKG_SBOX'};
 my $GBE_MACHTYPE    = $ENV{'GBE_MACHTYPE'};
 my $GBE_BUILDFILTER = $ENV{'GBE_BUILDFILTER'};
+#
 #   Configure the error reporting process now that we have the user options
+#
 ErrorConfig( 'name'    => 'SANDBOX',
              'verbose' => $opt_verbose );
+InitFileUtils();
+#
 #   Reconfigure the options parser to allow subcommands to parse options
+#
 Getopt::Long::Configure('permute');
 errorBuild(1, @ARGV)                    if ( $cmd =~ m/^unerror$/  );
 fingerPrintPkg(@ARGV)                   if ( $cmd =~ m/^finger/i );
 testLinks(@ARGV)                        if ( $cmd =~ m/^testlinks/i );
 setScanDepth(@ARGV)                     if ( $cmd =~ m/^scandepth/i );
 writeBuildData(@ARGV)                   if ( $cmd =~ m/^writeBuildData/i );
+generatepkgSignatures(@ARGV)            if ( $cmd =~ m/^genPkgSigs/i );
+setAbtMarker(@ARGV)                     if ( $cmd =~ m/^setAbtMarker/i );
 Error ("Unknown sandbox command: $cmd");
 exit 1;
+#
 sub errorBuild
+{
     my ($mode, @cmd_opts ) = @_;
     my $machine;
+    my $opt_removeAll;
     Getopt::Long::Configure('pass_through');
     getOptionsFromArray ( \@cmd_opts,
-                        'machine!' => \$machine,
+                          'machine!' => \$machine,
+                          'removeAll!' => \$opt_removeAll,
                         ) || Error ("Invalid command line" );
     SubCommandHelp( $opt_help, "Error Build") if ($opt_help );
     Error ("Command must be executed from within a Sandbox") unless ( $GBE_SANDBOX );
+    #
+    #   Remove all - applies to error and unerror
+    #
+    if ($opt_removeAll) {
+        my @deleteList = glob (CatPaths($GBE_SANDBOX, 'sandbox_dpkg_archive', '_error.*'));
+        foreach my $file (@deleteList)
+        {
+            Message ("UnError: $file");
+            unlink $file;
+        }
+    }
+    #
     #   Determine Sandbox information
     #   Populate global variables
+    #
     calc_sandbox_info(1);
+    #
     #   Display only
+    #
-    unless( @cmd_opts)
+    unless( @cmd_opts )
+    {
         foreach my $pkg (keys %packages)
+        {
             my $fe = $packages{$pkg};
             next unless $fe->{buildError};
+    #
     Message ("Scope      : " . ($opt_allSandbox ? 'Entire Sandbox' : $packages{$currentPkgTag}{dname} ));
     Message ("Base       : $GBE_SANDBOX");
     Message ("Archive    : $GBE_DPKG_SBOX");
     Message ("BuildFilter: $GBE_BUILDFILTER" . ( (-f $filterFile)  ? ' - Local to sandbox' : ''));
+    Message ("Type       : Auto Build Tool" ) if (defined $GBE_ABT);
     if ($showOrder)
+    {
         Message ("Build Order");
         foreach my $pname ( @stopped ) {
 #                                 Undef if not found
+#
 sub locatePreBuiltPackage
+{
     my ($fe) = @_;
+    my $inSandbox = 1;
+    #
     #   Get the package signature
+    #
     my $pkgSig = getPackageSignature($fe);
+    #
     #   Look in each package archive directory
+    #
     foreach my $dpkg ( $GBE_DPKG_SBOX,
+                       '--EndSandbox',
                        $GBE_DPKG_LOCAL,
                        $GBE_DPKG_CACHE,
                        $GBE_DPKG_REPLICA,
                        $GBE_DPKG,
                        $GBE_DPLY,
                        $GBE_DPKG_STORE )
+    {
+        if ($dpkg && $dpkg eq '--EndSandbox') {
+            $inSandbox = 0;
+            next;
+        }
+        #
+        #   Don't attempt to locate prebuilt packages in a build system sandbox
+        #   as the packages may be partially formed. The packages MUST be found in
+        #   a regular package store
+        #
+        if ( $inSandbox && defined($GBE_ABT) )
+        {
+            next;
+        }
         my $pkgDir = catdir( $dpkg, $fe->{mname}, $pkgSig);
         if (-d $pkgDir )
+        {
             Debug("Prebuilt Package found: $pkgSig");
             return (1, $pkgSig);
     my (@cmd_opts ) = @_;
     my $opt_outfile;
     Getopt::Long::Configure('pass_through');
     getOptionsFromArray ( \@cmd_opts,
-                           'outfile=s'  => \$opt_outfile,
+                          'outfile=s'   => \$opt_outfile,
                           ) || Error ("Invalid command line" );
     SubCommandHelp( $opt_help, 'Write Build Data') if ($opt_help  );
+    #
     #   Calculate sandbox info
+    #
+    #
     my %BuildData;
     my @BuildPlan = ();
     my @BuildEntry;
+    my @PkgData;
+    foreach my $fe ( @build_order ) {
+        my $data;
+        $data->{name} = $fe->{dname};
+        $data->{signature} = $fe->{signature};
+        $data->{error} = $fe->{buildError} ? 1 : 0;
+        $data->{excluded} = $fe->{buildExclude} ? 1 : 0;
+        $data->{prebuilt} = $fe->{si} eq 1? 1 : 0;
+        push @PkgData, $data;
+    }
     foreach my $fe ( @build_order ) {
         next if $fe->{buildError};
         next if $fe->{buildExclude};
         next if $fe->{buildSkip};
         $pkgData->{dname} = $BuildPkg->{dname};
         $pkgData->{dir} = $BuildPkg->{dir};
         $pkgData->{name} = $BuildPkg->{name};
         $pkgData->{version} = $BuildPkg->{version};
         $pkgData->{prj} = $BuildPkg->{prj};
+        if ($BuildPkg->{si} eq 3)
+        {
+            $pkgData->{error} = 1;
+            $pkgData->{signature} = "MSG: Cannot create";
+            $pkgData->{generic} = 0;
+        }
+        else
+        {
+            $pkgData->{error} = 1;
-        $pkgData->{signature} = $BuildPkg->{signature};
+            $pkgData->{signature} = $BuildPkg->{signature};
+            #
+            #   Determine if the package is 'GENERIC'
+            #   Read in the build.cfg file
+            #
+            my $pkgInterface = getpkgInterface($BuildPkg);
+            ReadBuildConfig( $pkgInterface, '', '--NoError' );
+            $pkgData->{generic} = ReadBuildConfig::isGenericBuild();
+        }
+    }
     $BuildData{BuildPkgData} = $pkgData;
-    $BuildData{BuildPkg} = $BuildPkg->{fname};
+    $BuildData{PkgData} = \@PkgData;
 #DebugDumpData("data", $BuildPkg);
+    if ($opt_outfile) {
+        FileCreate($opt_outfile, to_json( \%BuildData, { ascii => 1, pretty => 1 }));
+    } else {
-    print( to_json( \%BuildData, { ascii => 1, pretty => 1 }) . "\n");
+        print( to_json( \%BuildData, { ascii => 1, pretty => 1 }) . "\n");
+    }
 #    DebugDumpData("BuildData",\%BuildData);
+    #
     #   All done
+    #
     exit(0);
+}
 #-------------------------------------------------------------------------------
+# Function        : setAbtMarker
+#
+# Description     : Set a marker file in the sandbox such that JATS will recognise
+#                   the sandbox as being a special ABT enabled sandbox
+#
+# Inputs          : None
+#
+# Returns         : Does not return
+#
+sub setAbtMarker
+{
+    my (@cmd_opts ) = @_;
+    Getopt::Long::Configure('pass_through');
+    getOptionsFromArray ( \@cmd_opts,
+                          ) || Error ("Invalid command line" );
+    SubCommandHelp( $opt_help, 'Set Abt Marker') if ($opt_help  );
+    Message ("Setting ABT marker file");
+    TouchFile( CatPaths($GBE_DPKG_SBOX, 'abtMarker'));
+    $GBE_ABT = 1;
+    #
+    #   All done
+    #
+    exit(0);
+}
+#-------------------------------------------------------------------------------
+# Function        : generatepkgSignatures
+#
+# Description     : Generate package signatures for dependent packages
+#                   Intended to be used by build systems
+#
+# Inputs          :
+#
+# Returns         :
+#
+sub generatepkgSignatures
+{
+    my (@cmd_opts ) = @_;
+    Getopt::Long::Configure('pass_through');
+    getOptionsFromArray ( \@cmd_opts,
+                          ) || Error ("Invalid command line" );
+    SubCommandHelp( $opt_help, 'Generate Package Signatures') if ($opt_help  );
+    #
+    #   Calculate sandbox info
+    #   All data written will be based on this information
+    #
+    Message ("Generating Package Signatures");
+    calc_sandbox_info();
+    calc_signature_info();
+    #
+    #   All done
+    #
+    exit(0);
+}
+#-------------------------------------------------------------------------------
 # Function        : calc_signature_info
+#
 # Description     : Calculate signature information for all packages in the sandbox
 #                   Used to create build system information
+#
 #                       4 - Excluded - Dependent package has no signature
 #                       5 - Excluded - Packages skipped or not active
+#
 sub calc_signature_info
+{
+    Debug("calc_signature_info");
+    SystemConfig(ExitOnError => 0);
     foreach my $fe ( @build_order )
+    {
-        next if (exists $fe->{si});
+        if (exists $fe->{si}) {
+            Debug("calc_signature_info. Exists $fe->{dname}, $fe->{si}");
+            next;
+        }
         if ( !$fe->{buildActive} || $fe->{buildSkip} ) {
             $fe->{si} = 5;
+            Debug("calc_signature_info. Skip $fe->{dname}");
             next;
+        }
+        #
         #   If this package has a signature file then we don't need to re-create it
         my $result = 0;
         my ($preBuilt, $haveSignature) = locatePreBuiltPackage($fe);
         unless ($haveSignature) {
             my $dir = $fe->{dir};
             $result = JatsCmd( "-cd=$dir", 'build', 'signature');
+            Debug("calc_signature_info. $fe->{dname} Build Signature. $result");
+            }
         unless ($result) {
+            #
             #   Signature generated OK
+            #
             ($preBuilt, $haveSignature) = locatePreBuiltPackage($fe);
+            Debug("calc_signature_info. $fe->{dname} Examine: $preBuilt, $haveSignature");
             if ($preBuilt) {
                 $fe->{si} = 1;
                 $fe->{signature} = $haveSignature;
             } elsif ($haveSignature) {
                 $fe->{si} = 2;
+        #
         #   Error creating the signature
         #   Mark this package and all those that depend on it
+        #
         if ($result) {
+            Debug("calc_signature_info. Error $fe->{dname}");
             $fe->{si} = 3;
             if ( exists($fe->{'usedBy'}))
+            {
                 foreach my $entry (@{$fe->{'usedBy'}}) {
                     my $pe = $packages{$entry};
     if ($preBuilt) {
         $txt .= ' [PreBuilt]';
         $statusP = 'P';
+    }
+    unless ($GBE_ABT) {
-    my $plink = catdir( $GBE_DPKG_SBOX, $fe->{name}, 'sandbox.' . $fe->{prj} . '.lnk' );
+        my $plink = catdir( $GBE_DPKG_SBOX, $fe->{name}, 'sandbox.' . $fe->{prj} . '.lnk' );
-    my $linkTarget = getPackageLink ($plink);
+        my $linkTarget = getPackageLink ($plink);
-    Verbose ("Sandbox link: $plink -> $linkTarget");
+        Verbose ("Sandbox link: $plink -> $linkTarget");
-    if (-d $linkTarget) {
+        if (-d $linkTarget) {
-        $txt .= ' [Local]';
+            $txt .= ' [Local]';
-        if ($preBuilt) {
+            if ($preBuilt) {
-            $statusP = 'M';
+                $statusP = 'M';
-        } else {
+            } else {
-            $statusP = 'L';
+                $statusP = 'L';
+            }
+        }
+    }
     return "$statusS$statusB$statusP$statusF", $txt ;
+}
     make                - Do 'make' in all sandbox components
     clean               - Do 'make clean' in all sandbox components
     clobber             - Do 'build clobber' is all sandbox components
     cache               - Cache external dependent packages
     writeBuildData      - Write out build data
+    genPkgSigs          - Generate package Signatures
+    setAbtMarker        - Set Build System Marker file
  Use the command
     jats sandbox 'command' -h
  for command specific help
  Command Options
     -help[=n]               - Command specific help, [n=1,2,3]
     -man                    - Same as -help=3
     -[no]machine            - Skip on on this type of machine
+    -[no]removeAll          - Remove all error indications
 =head2 ARGUMENTS
 Arguments to the 'error' command are the names of packages to be marked.
 =item -[no]machine
 This option will flag that the package will be skipped only on this type of build machine.
+=item -[no]removeAll
+This option will cause all error indication to be removed. It can be used in conjunction with
+other operations.
 =back
 =head2 DESCRIPTION
 The 'error' command markes the named packages to as having build errors. These packages, and packages that
     jats sandbox writeBuildData -outpath=data.json
 will write a json formatted file that contains data for the build system.
+=for comment ==================================================================
+=head1 Generate Package Signatures
+=head2 NAME
+Generate Package Signatures
+=head2 SYNOPSIS
+jats sandbox genPkgSigs [options]
+ Command Options
+    -help[=n]               - Command specific help, [n=1,2,3]
+    -man                    - Same as -help=3
+=head2 ARGUMENTS
+This command does not take any arguments
+=head2 OPTIONS
+The 'genPkgSigs' command does not have any command specific options.
+=head2 DESCRIPTION
+The genPkgSigs command is used by the automated build system to generate package signatures
+of all dependent packages.
+=head2 EXAMPLES
+The command
+    jats -cd PackagePath sandbox genPkgSigs
+=for comment ==================================================================
+=head1 Set Abt Marker
+=head2 NAME
+Set Abt Marker file
+=head2 SYNOPSIS
+jats sandbox setAbtMarker [options]
+ Command Options
+    -help[=n]               - Command specific help, [n=1,2,3]
+    -man                    - Same as -help=3
+=head2 ARGUMENTS
+This command does not take any arguments
+=head2 OPTIONS
+The 'setAbtMarker' command does not have any command specific options.
+=head2 DESCRIPTION
+The setAbtMarker command is used by the automated build system to place a marker file
+in the sandbox such that JATS will recognise the sandbox as being used by the
+'Auto Build Tool'. This will affect the operation of several Jats commands.
+=head2 EXAMPLES
+The command
+    jats -cd PackagePath sandbox setAbtMarker
 =cut

Subversion Repositories DevTools

(root)/core_devl/branches/gitBuilder/TOOLS/jats_sandbox.pl – Rev 7319 → 7320