WebSVN – DevTools – Diff – /generate_release_notes/trunk/src/tools/jats_gen_releasenote.pl

 my $opt_pvid;
 my $opt_outname;
 my $opt_outputXml;
 my $opt_updateRmFiles;
 my $opt_workingDir;
+my $opt_noRM;
 #   Global vars
 our $GBE_HOSTNAME;
 my $DPKG_ROOT;
 my $DPKG_DOC;
                     "verbose:+"     => \$opt_verbose,           # flag, increment
                     "archive=s"     => \$opt_archive,           # string
                     "releasenote=s" => \$opt_release_note,      # string
                     "UpdateRmFiles" => \$opt_updateRmFiles,     # flag
                     "WorkDir=s"     => \$opt_workingDir,        # String
+                    "noRM"          => \$opt_noRM,              # Flag
                     );
+    #
     #   Process help and manual options
+    #
     #   Locate the release note data file
     #   This was created as a prerequisite to the build
     #   Note: windows requires '/' in the file list
+    #
     my @filesList;
+    my $appendGenFiles = 1;
     foreach my $item ( glob(catdir($DPKG_ROOT, 'built.files.*.xml'))) {
         $item =~ s~\\~/~g;
         push @filesList, $item;
+    }
     unless (scalar @filesList > 0)
+    {
         Warning("No file list found within the package: $opt_pname/$opt_pversion");
+        $appendGenFiles = 0;
+        #
         #   No filelist found in the package
         #   This may occur for packages that did not go though the build system
         #   Create a package-list
+        #
     #   Create output directory within the package
+    #
     mkpath($DPKG_DOC, 0, 0775);
+    #
+    #   Generate name of temp file
+    #
+    my $builtFiles = 'built.files.releasenote.xml';
+    if (defined $opt_workingDir) {
+        $builtFiles = join('/', $opt_workingDir, $builtFiles);
+    }
+    Verbose("TempFile: $builtFiles");
+    #
     #   Merge the Release Note and the various file lists into a single
     #   XML file. Keep the file local
+    #
     System('--NoShell', '--Exit', 'java', '-jar',
            catdir($JATS_RN, 'saxon9he.jar'),
            '-xsl:' . catdir($JATS_RN, 'merge.xslt'),
            "-s:$opt_release_note",
            'fileList=' . join(',', @filesList),
-           '-o:' . 'built.files.releasenote.xml'
+           '-o:' . $builtFiles
             );
+    #
     #   Generate the HTML Release Note
     #   Output directly to the body of the package
+    #
     System('--NoShell', '--Exit', 'java', '-jar',
            catdir($JATS_RN, 'saxon9he.jar'),
            '-xsl:' . catdir($JATS_RN, 'releaseNote2html.xslt'),
-           '-s:' . 'built.files.releasenote.xml',
+           '-s:' . $builtFiles,
            "-o:" . catdir($DPKG_DOC, $opt_outname)
             );
+    #
     #   Transfer the XML database directly into the package
+    #
-    unless( File::Copy::copy('built.files.releasenote.xml', $opt_outputXml) )
+    unless( File::Copy::copy($builtFiles, $opt_outputXml) ) {
-    {
         Error("Cannot transfer XML release note", $!, $opt_outputXml);
+    }
+    unlink $builtFiles;
+    #
     #   Delete the built.files.xxx.xml that may be present in the root of the package
     #   These are no longer needed - they have been incorporated into the release_note.xml file
+    #
+    #
     #   Update the Release Manager entry - File Data
+    #
     if ($opt_updateRmFiles)
+    {
+        my $genFileData;
+        $genFileData = genFileData($opt_outname, 'release_note.xml') if ($appendGenFiles);
-        updateRmFiles();
+        updateRmFiles($genFileData);
         updateRmNoteInfo();
+    }
+    #
     #   All done
     Verbose("Package Version: $opt_pversion") ;
     Verbose("Package Pvid: $opt_pvid") ;
+}
 #-------------------------------------------------------------------------------
+# Function        : genFileData
+#
+# Description     : Generate File Data for some locally generated files so that they
+#                   will appear in the Release Manager database
+#
+# Inputs          : List of files to process
+#                   Assumed they are in the $DPKG_DOC directory
+#
+# Returns         : An array of data items
+#                   Need:
+#                       {path}
+#                       {name}
+#                       {size}
+#                       {md5sum}
+#                       {fullname}
+#                       {type}
+#                       {machtype}
+#                       {host}
+#
+sub genFileData
+{
+    my (@fileList) = @_;
+    my $retData;
+    Verbose('genFileData');
+    #
+    #   Create entry for the 'doc' folder
+    #
+    {
+        my %data;
+        $data{fullname} = 'doc';
+        $data{path} = 'doc';
+        $data{type} = 'dir';
+        $data{machtype} = 'unknown';
+        $data{host} = $GBE_HOSTNAME;
+        push @{$retData},\%data;
+    }
+    #
+    #   Process each file
+    #
+    foreach my $file ( @fileList) {
+        my %data;
+        my $source = catfile($DPKG_DOC, $file);
+        $data{md5sum} = genMd5Sum($source);
+        $data{size} = (stat($source))[7];
+        $data{name} = $file;
+        $data{fullname} = 'doc/' . $file;
+        $data{path} = 'doc/';
+        $data{type} = 'file';
+        $data{machtype} = 'unknown';
+        $data{host} = $GBE_HOSTNAME;
+        push @{$retData},\%data;
+    }
+    return $retData;
+}
+#-------------------------------------------------------------------------------
 # Function        : generateFileList
 #                   generateFileListProc
+#
 # Description     : A fileList has not been found in the target package
 #                   Perhaps the package was not created by the build system
         $type = 'link';
+    }
     elsif ( -f $source)
+    {
         $type = 'file';
-        Verbose2("Calculate MD5 Digest: $source");
+        $md5sum = genMd5Sum($source);
-        open(my $fh , $source) or Error ("Can't open '$source': $!");
-        binmode $fh, ':crlf';
-        $md5sum = Digest::MD5->new->addfile($fh)->hexdigest;
-        close $fh;
+    }
+    #
     #   Convert from iso-8859-1 into utf-8
+    #
     $data{fullname} = $target;
     $data{type} = $type;
     $data{machtype} = 'unknown';
     $data{host} = $GBE_HOSTNAME;
-    # Put a nice '/' on the end of the patch elements
+    # Put a nice '/' on the end of the path elements
     $data{path} .= '/'
         if ( exists ($data{path}) && length($data{path}) > 0);
     push @generateFileListData, \%data;
+}
 #-------------------------------------------------------------------------------
+# Function        : genMd5Sum
+#
+# Description     : Generate the MD5SUM of a specified file
+#
+# Inputs          : $source - Full path to file
+#
+# Returns         : md5sum of the file
+#                   Will not return on error
+#
+sub genMd5Sum
+{
+    my ($source) = @_;
+    my $md5sum;
+    Verbose2("Calculate MD5 Digest: $source");
+    open(my $fh , $source) or Error ("Can't open '$source': $!");
+    binmode $fh, ':crlf';
+    $md5sum = Digest::MD5->new->addfile($fh)->hexdigest;
+    close $fh;
+    return $md5sum;
+}
+#-------------------------------------------------------------------------------
 # Function        : updateRmFiles
+#
 # Description     :
+#
-# Inputs          :
+# Inputs          : $genFileData            - Data for generated files [Optional]
+#
 # Returns         :
+#
 my $RM_DB;
 my  $updateRmFilesData;
 sub updateRmFiles
+{
+    my ($genFileData) = @_;
     my $eCount = 0;
+    #
     #   If in use the the autobuilder - which it should be, then
     #   modify the user name to access RM with a proxy user. This is the
     #   same method used in the 'buildtool'
     Error("Sanity Check Failure. Name") unless($opt_pname eq $xml->{package}{name});
     Error("Sanity Check Failure. Version") unless($opt_pversion eq $xml->{package}{version});
     Error("Sanity Check Failure. File Section") unless(exists $xml->{file});
+    #
+    #   Append any additional file data
+    #       This will be the doc/ doc/release_note.xml and doc/RELEASE_NOTES.....html
+    #
+    if ($genFileData) {
+        foreach ( @{$genFileData}) {
+            push @{$xml->{file}}, $_;
+        }
+    }
+    #
     #   Delete any existing entry(s)
+    #
     updateRmFilesDelete();
+    #
 sub executeRmQuery
+{
     my ($fname, $m_sqlstr) = @_;
+    #
+    #   Testing only
+    #   Display the Database access commands - don't execute them
+    #
+    if ($opt_noRM) {
+        Debug0("$fname", $m_sqlstr);
+        return;
+    }
+    #
     #   Connect to the Database - once
+    #
     connectRM(\$RM_DB, 0) unless $RM_DB;
     Verbose2('ExecuteQuery:', $fname);
     -verbose           - Display additional progress messages
     -outfile=name      - [Optional] Name of the output XML file
     -archive=name      - [Optional] Name package archive
     -releasenote=path  - Path to the Release Note Data
     -UpdateRmFiles     - Update the Files list in Release Manager
+    -WorkDir=path      - [Test] Path to work area
+    -NoRM              - [Test] No RM present
 =head1 OPTIONS
 =over 8
 The existing file list will be replaced by the one within the package.
 Note: Write Access to Release Manager is required.
+=item B<-WorkDir=Path>
+This option is provided to aid in testing of this tool.
+If provided the tool will use the specified path when creating files.
+=item B<-NoRM>
+This option is provided to aid in testing of this tool.
+When provided, this option will supress access to the Release Manager database. Instead the
+SQL commands will be displayed.
 =back
 =head1 DESCRIPTION
 This utility program is used to extract sufficient information from Release Manager and other

Subversion Repositories DevTools

(root)/generate_release_notes/trunk/src/tools/jats_gen_releasenote.pl – Rev 6383 → 6391