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

 my $opt_info;
 my $opt_tarmode;
 my $opt_testArchive;
 my $opt_noBuild;
 my $opt_keepTemp;
+my $opt_tarzip;
+#
 #   Structure to translate -archive=xxx option to archive variable
 #   These are the various dpkg_archives known to JATS
+#
 #       This sub-routine is used to generate a consistent informational log
 #------------------------------------------------------------------------------
+{
     my ($opr, $file) = @_;
+    # Shorten the display by using symbolic pathnames where possible
     $file =~ s/\Q$DPKG_DIR\E/PKGDIR/;
     $file =~ s/\Q$DPKG_ROOT\E/DPKG/;
     $file =~ s/\Q$SRC_ROOT\E/PKG/;
     $file =~ s/\Q$CWD_DIR\E/CWD/;
                 'info!'         => \$opt_info,              # [no]flag
                 'tarmode!'      => \$opt_tarmode,           # [no]flag
                 'testArchive'   => \$opt_testArchive,       # [no]flag
                 'nobuild'       => \$opt_noBuild,           # flag
                 'keepTemp'      => \$opt_keepTemp,          # flag
+                'tarzip'        => \$opt_tarzip,            # flag
                 );
+    #
     #   Process help and manual options
+    {
        Verbose ("Program: $PROGNAME");
        Verbose ("Version: $VERSION");
+    }
+    Error ("-tarmode and -tarzip are mutually exclusive") if ($opt_tarmode && $opt_tarzip);
+    Error ("-test and -tarzip are mutually exclusive") if ($opt_test && $opt_tarzip);
+    #
     #   Needed EnvVars
+    #
     EnvImport ('GBE_MACHTYPE');
     EnvImport ('GBE_HOSTNAME');
     unless ( $opt_archive )
+    {
         $opt_archive = 'main';
         $opt_archive = 'escrow' if ($::GBE_DPKG_ESCROW);
+    }
     my $archive_tag = $Archive2Var{$opt_archive};
     Error("Unknown archive specified: $opt_archive")
         unless ( $archive_tag );
     $DPKG_ROOT = $ENV{$archive_tag} || '';
     Verbose ("Archive Variable: $archive_tag" );
     Information ("Dpkg archive creation tool...");
     Information ("Version: $VERSION");
     Information ("");
     Information ("Information:");
     Information ("Escrow Build") if ($opt_archive eq 'escrow');
-    Information ("Working dir   = [$CWD_DIR]");
+    Information ("Working dir      = [$CWD_DIR]");
-    Information ("Package Root  = [$SRC_ROOT]");
+    Information ("Package Root     = [$SRC_ROOT]");
-    Information ("Repository    = [$DPKG_ROOT]");
+    Information ("Repository       = [$DPKG_ROOT]") unless ($opt_tarzip);
-    Information ("                *Non Standard archive") unless ($opt_archive eq 'main' || $opt_archive eq 'escrow');
+    Information ("                   *Non Standard archive") unless ($opt_archive eq 'main' || $opt_archive eq 'escrow' || $opt_tarzip);
-    Information ("Target dir    = [$DPKG_DIR]");
+    Information ("Target dir       = [$DPKG_DIR]") unless ($opt_tarzip);
+    Information ("Target dir       = [$CWD_DIR]") if ($opt_tarzip);
-    Information1("DPKG_NAME     = [$DPKG_NAME]");
+    Information1("DPKG_NAME        = [$DPKG_NAME]");
-    Information1("DPKG_VERSION  = [$DPKG_VERSION]");
+    Information1("DPKG_VERSION     = [$DPKG_VERSION]");
-    Information1("DPKG_PRJ      = [$DPKG_PRJ]");
+    Information1("DPKG_PRJ         = [$DPKG_PRJ]");
-    Information1("GBE_MACHTYPE  = [$GBE_MACHTYPE]");
+    Information1("GBE_MACHTYPE     = [$GBE_MACHTYPE]");
-    Information1("GBE_HOSTNAME  = [$GBE_HOSTNAME]");
+    Information1("GBE_HOSTNAME     = [$GBE_HOSTNAME]");
-    Information1("GBE_ABT       = [$GBE_ABT]");
+    Information1("GBE_ABT          = [$GBE_ABT]");
-    Information1("USER          = [$USER]");
+    Information1("USER             = [$USER]");
-    Information ("")                                if ( $opt_merge || $opt_delete || $opt_info || $opt_tarmode || $opt_testArchive || $opt_noBuild);
+    Information ("")                               if ( $opt_merge || $opt_delete || $opt_info || $opt_tarmode || $opt_testArchive || $opt_noBuild || $opt_tarzip);
-    Information ("Opt:NoBuild       = Enabled")     if ( $opt_noBuild );
+    Information ("Opt:NoBuild      = Enabled")     if ( $opt_noBuild );
-    Information ("Opt:TarMode       = Enabled")     if ( $opt_tarmode );
+    Information ("Opt:TarMode      = Enabled")     if ( $opt_tarmode );
-    Information ("Opt:Delete        = Enabled")     if ( $opt_delete );
+    Information ("Opt:Delete       = Enabled")     if ( $opt_delete );
-    Information ("Opt:Merge         = Enabled")     if ( $opt_merge );
+    Information ("Opt:Merge        = Enabled")     if ( $opt_merge );
-    Information ("Opt:testArchive   = Enabled")     if ( $opt_testArchive );
+    Information ("Opt:testArchive  = Enabled")     if ( $opt_testArchive );
+    Information ("Opt:TarZip       = Enabled")     if ( $opt_tarzip );
-    Information ("Opt:TestMode      = Enabled. No Package Transferred") if ( $opt_test );
+    Information ("Opt:TestMode     = Enabled. No Package Transferred") if ( $opt_test );
-    Information ("Opt:Info          = Enabled. No Package Transferred") if ( $opt_info );
+    Information ("Opt:Info         = Enabled. No Package Transferred") if ( $opt_info );
-    Warning     ("Sandbox Build     = Yes") if ($ENV{GBE_DPKG_SBOX}) ;
+    Warning     ("Sandbox Build    = Yes") if ($ENV{GBE_DPKG_SBOX}) ;
     Information ("---------------------------------------------------------------");
+    #
     #   If the environment variable GBE_DPKG_SBOX is defined then the package
     #   is being built within a development sandbox. In such a sandbox the
     #       bsdtar - crashed under server 2003
     #       cygwin - design decision. JATS will not include cygwin
+    #
     my $tarTarget = join('_', $DPKG_NAME, $DPKG_VERSION, $GBE_HOSTNAME) . '.tar.gz';
     my $tarPath = catfile($DPKG_DIR, $tarTarget);
-    $FileUtils::isUnix ? createUnixTar($tarPath) : createWindowsTar($tarPath);
+    createTar($tarPath);
+}
 #-------------------------------------------------------------------------------
-# Function        : createUnixTar
+# Function        : createTar
+#
-# Description     : Create a tar.gz file under unix
+# Description     : Create a tar.gz file under unix and windows
+#
 # Inputs          : $tarPath    - Place tarfile here
 #                   $SRC_ROOT   - Directory to tar
+#
 # Returns         : Will not return on error
+#
-sub createUnixTar
+sub createTar
+{
     my ($tarPath) = @_;
+    #
     #   Locate the tar utility
+    #
     #   Tar and gzip file directly into the final location
     LogFileOp ('TarZip', $tarPath);
     my @tarArgs;
     push @tarArgs, '-v' if IsVerbose(1);
-    my $rv = System ('--NoShell', '--NoExit',$tarProg, @tarArgs, '-czf', $tarPath, '-C', $SRC_ROOT, '.' );
+    my $rv = System ('--NoShell', '--NoExit',$tarProg, @tarArgs, '--force-local', '-czf', $tarPath, '-C', $SRC_ROOT, '.' );
     if ($rv)
+    {
         push @tmpFiles, $tarPath;
         Error ('Cannot create tarball', "Path:$tarPath");
+    }
+}
 #-------------------------------------------------------------------------------
-# Function        : createWindowsTar
-#
-# Description     : Create a tar.gz file under Windows
-#                   Use 7zip (part of JATS)
-#                   7zip cannot do this in one step
-#                       Create tar file
-#                       Create zip file
-#
-# Inputs          : $tarPath    - Place tarfile here
-#                   $SRC_ROOT   - Directory to tar
-#
-# Returns         : Will not return on error
-#
-sub createWindowsTar
-{
-    my ($tarPath) = @_;
-    my @verboseArgs = qw(-bb1);
-    my $verboseCopyArg = '9';
-    #
-    #   Ensure that the target file does not exist
-    #   7z cannot ovewrite it
-    #
-    LogFileOp ('Delete', $tarPath);
-    RmDirTree($tarPath) && Error ("Target file cannot be deleted", "Target: $tarPath");
-    #
-    #   Setup NON-verbose arguments for 7zip
-    #
-    unless (IsVerbose(1)) {
-        @verboseArgs = qw(-bb0 -bso0 -bsp0);
-        $verboseCopyArg = '0';
-    }
-    #
-    #   Create a tar file of the required output
-    #   Create the tar file into a temp file that will be deleted on exit
-    #
-    my $tmpTarFile = catfile($CWD_DIR, join('_', $DPKG_NAME, $DPKG_VERSION) . '.tar' );
-    Verbose("TempTar: $tmpTarFile");
-    RmDirTree($tmpTarFile) && Error ("Target file cannot be deleted", "Target: $tmpTarFile");
-    push @tmpFiles, $tmpTarFile;
-    LogFileOp ('TempTar', $tmpTarFile);
-    chdir ($SRC_ROOT) || Error ("Cannot change directory: $?", "Dir: $SRC_ROOT");
-    my $rv = System ('--NoShell', '--NoExit','7z.exe', 'a', '-r','-y', @verboseArgs, '-ttar', $tmpTarFile, '.' );
-    if ($rv)
-    {
-        Error ('Cannot create tar file');
-    }
-    chdir ($CWD_DIR) || Error ("Cannot change directory: $?", "Dir: $CWD_DIR");
-    #
-    #   gzip the tar file to a temp (local) location
-    #
-    my $tmpTarGzFile = catfile($CWD_DIR, join('_', $DPKG_NAME, $DPKG_VERSION) . '.tar.gz' );
-    Verbose("TempTarGz: $tmpTarGzFile");
-    RmDirTree($tmpTarGzFile) && Error ("Target file cannot be deleted", "Target: $tmpTarFile");
-    push @tmpFiles, $tmpTarGzFile;
-    LogFileOp ('TempTarGz', $tmpTarGzFile);
-    $rv = System ('--NoShell', '--NoExit','7z.exe', 'a', '-y', @verboseArgs, '-tgzip', $tmpTarGzFile, $tmpTarFile );
-    if ($rv)
-    {
-        Error ('Cannot gzip tar file');
-    }
-    #
-    #   Copy the file to the target
-    #   Note: Jats internal copy
-    #         Args are strange as it was designed to work with makefile stuff
-    #
-    LogFileOp ('CopyTarZip', $tarPath);
-    $rv = System ('--NoShell', '--NoExit','JatsFileUtil.exe', 'c' . $verboseCopyArg, 'copyFile', $tarPath, $tmpTarGzFile, '+w' );
-    if ($rv)
-    {
-        push @tmpFiles, $tarPath;
-        Error ('Cannot transfer tarball', "Path:$tarPath");
-    }
-}
-#-------------------------------------------------------------------------------
 # Function        : pkgFindTarBall
+#
 # Description     : Used by CreateDpkgArchiveTarBall
 #                   File::Find processing function
+#
         $type = 'dir';
     } else {
         Error("Unknown file type. Cannot be packaged");
+    }
+    unless ($opt_tarzip) {
+        #
+        #   Calculate the target directory name
+        #
+        my $target = $item;
+        $target = $DPKG_DIR . substr ( $item, length ($SRC_ROOT) );
+        addFile($type, $item, $target);
+        LogFileOp('Process',$item);
+    }
+}
+#-------------------------------------------------------------------------------
+# Function        : CreateLocalTarZip
+#
+# Description     : Similar to CreateDpkgArchive, but it will create a tarzip file of the package
+#                   in the current directory.
+#
+#                   Can be used by developers to tar-zip a package for cross platform development
+#
+# Inputs          :
+#
+# Returns         :
+#
+sub CreateLocalTarZip
+{
+    Information("");
+    InitFileUtils();
+    #
+    #   If a 'noBuild' then create a dummy package directory simply
-    #   Calculate the target directory name
+    #   to contain the metadata.
+    #   Delete any existing dir of the same name to ensure its clean.
+    #
+    if ( $SRC_ROOT eq '' )
+    {
+        $SRC_ROOT = catdir(AbsPath('pkg/noBuild'));
+        RmDirTree ($SRC_ROOT);
+        mkpath($SRC_ROOT, 0, 0775);
+    }
+    #
+    #   Mark the archive with the build machine to indicate which parts of
+    #   a multi-machine build have been performed
+    #
+    createBuiltFile($SRC_ROOT);
+    #   Process the source directory
+    #   A NoBuild will contain one metafile
+    #
+    if ( -d $SRC_ROOT )
+    {
+        File::Find::find( \&pkgFindTarBall, $SRC_ROOT );
+        if (@bad_symlinks)
+        {
+            my $msg = "Bad Symlinks: " . scalar @bad_symlinks;
+            $opt_test ? ReportError($msg, @bad_symlinks) : Warning($msg, @bad_symlinks);
+        }
-    my $target = $item;
+        ErrorDoExit();
+    }
+    else
+    {
+        Error("Failed to find dir [$SRC_ROOT]",
+              "Check JATS config.");
+    }
+    #
+    #   Create a tar.gz file an transfer to the final location
+    #
+    #   Have failed to find a nice windows utility to create a tar.gz
+    #       bsdtar - crashed under server 2003
+    #       cygwin - design decision. JATS will not include cygwin
+    #
-    $target = $DPKG_DIR . substr ( $item, length ($SRC_ROOT) );
+    my $tarTarget = $DPKG_NAME . '__' . $DPKG_VERSION . '.tgz';
+    createTarZip($tarTarget);
+}
+#-------------------------------------------------------------------------------
+# Function        : createTarZip
+#
+# Description     : Create a .tgz file with correct package formatting
+#
+# Inputs          : $tarPath    - Place tarfile here
+#                   $SRC_ROOT   - Directory to tar
+#
+# Returns         : Will not return on error
+#
+sub createTarZip
+{
+    my ($tarPath) = @_;
+    #
-    addFile($type, $item, $target);
+    #   Locate the tar utility
+    #   Use gtar if its available otherwise use tar
+    #
+    my $tarProg = LocateProgInPath('gtar', '--All');
+    $tarProg = LocateProgInPath('tar', '--All') unless $tarProg;
+    Error ("Tar utility not found in path") unless $tarProg;
+    #
+    #   Tar and gzip file directly into the final location
-    LogFileOp('Process',$item);
+    LogFileOp ('TarZip', $tarPath);
+    my @tarArgs;
+    push @tarArgs, '-v' if IsVerbose(1);
+    my $rv = System ('--NoShell', '--NoExit',$tarProg, @tarArgs, '-czf', $tarPath, '-C', $SRC_ROOT, '.' , '--transform', "s~^./~$DPKG_NAME/$DPKG_VERSION/~");
+    if ($rv) {
+        push @tmpFiles, $tarPath;
+        Error ('Cannot create tarball', "Path:$tarPath");
+    }
+}
 #-------------------------------------------------------------------------------
 # Function        : TestDpkgArchive
+#
 ShowInfo();
 unless ($opt_info)
+{
     unless ( $opt_test )
+    {
-        if ($opt_tarmode)
+        if ($opt_tarzip) {
+            LogFileOp("Creating package tarZip:", $DPKG_DIR);
+            CreateLocalTarZip();
-        {
+        } elsif ($opt_tarmode) {
             LogFileOp("Creating dpkg_archive tarball:", $DPKG_DIR);
             CreateDpkgArchiveTarBall();
+        }
         else
+        {
     -pversion=version  - Ensure package version is correct
     -generic           - Create a built.generic file
     -noBuild           - Create dummy build files
     -[no]tarmode       - Transfer package as tarball
     -[no]md5           - Use MD5 comparison of merged files(enabled)
+    -tarzip            - Create a tarzip of the package.
   Debug and Testing:
     -[no]test          - Test package. Do not transfer.
     -[no]info          - Display packaging info. Do not transfer.
-    -[no]testArchive   - Perform operations within a test archive
+    -[no]testArchive   - Perform operations within a test/dev archive
     -keepTemp          - Do not delete temp files
 =head1 OPTIONS
 =over 8
 the currently configured dpkg_archive. The test area is a subdirectory
 called C<.dpkg_archive/test_dpkg>
 This option is intended for testing use only.
+This option allows a package created with a developers sandbox to be packaged for testing purposes.
 =item B<-keepTemp>
 This option will prevent temp files, created by this utilty, from being deleted when the utilty
 exists.
 This option is intended for testing use only.
+=item B<-tarzip>
+This option will cause the utility to generate a zipped tarfile of the current package.
+It is intended to allow developers to transfer package artifacts from one machine to another,
+perhaps during development in a multi platform environment.
+This option does not create a package in dpkg_archive. It will create the resultant file in the current
+directory. The name of the file will be <packageName>__<version>.tgz
+Several other options have no effect when used with this option.
 =back
 =head1 DESCRIPTION
 This utility program is used to transfer a package that has been built into

Subversion Repositories DevTools

(root)/core_devl/trunk/TOOLS/create_dpkg.pl – Rev 7388 → 7547