Changeset 331 in ProjectBuilder for devel/pb/bin/pb

Timestamp:

Mar 2, 2008, 12:25:28 AM (16 years ago)

Author:

Bruno Cornec

Message:

• Improvements for CMS support in 0.9.x serie (lots on CVS)
• Use pod for pb documentation (modules to be done)
• Use Getopt::Long and support now long options
• pb_syntax now uses pod2usage

File:

• devel/pb/bin/pb (modified) (9 diffs)

devel/pb/bin/pb

@@ -11 +11 @@
 
 use strict 'vars';
-use Getopt::Std;
+use Getopt::Long qw(:config auto_abbrev no_ignore_case);
+use Pod::Usage;
 use Data::Dumper;
 use English;
@@ -40 +41 @@
 my $pbport;                 # Port to use to connect to the VM
 my $newver;                 # New version to create
-my $iso;                    # ISO iage for the VM to create
+my $iso;                    # ISO image for the VM to create
 
 my @date = pb_get_date();
 my $pbdate = strftime("%Y-%m-%d", @date);
 
-getopts('a:fhi:l:m:P:p:qr:s:tvV:',\%opts);
+# ---------------------------------------------------------------------------
+
+=pod
+
+=head1 NAME
+
+pb, aka project-builder.org - builds packages for your projects
+
+=head1 DESCRIPTION
+
+pb helps you build various packages directly from your project sources. 
+Those sources could be handled by a CMS (Configuration Management System)
+such as Subversion, CVS, ... or being a simple reference to a compressed tar file.
+It's based on a set of configuration files, a set of provided macros to help 
+you keeping build files as generic as possible. For example, a single .spec
+file should be required to generate for all rpm based distributions, even 
+if you could also have multiple .spec files if required.
+
+=head1 SYNOPSIS
+
+pb [-vhq][-r pbroot][-p project][[-s script -a account -P port] -m \"mach-1[,...]\"][-i iso] <action> [<pkg1> ...]
+
+pb [--verbose][--help][--man][--quiet][--revision pbroot][--project project][[--script script --account account --port port] --machine \"mach-1[,...]\"][--iso iso] <action> [<pkg1> ...]
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-v|--verbose>
+
+Print a brief help message and exits.
+
+=item B<-q|--quiet>
+
+Do not print any output.
+
+=item B<-h|--help>
+
+Print a brief help message and exits.
+
+=item B<--man>
+
+Prints the manual page and exits.
+
+=item B<-m|--machine machine1[,machine2,...]>
+
+Name of the Virtual Machines (VM) or Virtual Environments (VE) you want to build on (coma separated). 
+All if none precised (or use the env variable PBV).
+
+=item B<-s|--script script>
+
+Name of the script you want to execute on the related VMs or VEs.
+
+=item B<-i|--iso iso_image>
+
+Name of the ISO image of the distribution you want to install on the related VMs.
+
+=item B<-a|--account account>
+
+Name of the account to use to connect on the related VMs.
+
+=item B<-P|--port port_number>
+
+Port number to use to connect on the related VMs.\n";
+
+=item B<-p|--project project_name>
+
+Name of the project you're working on (or use the env variable PBPROJ)
+
+=item B<-r|--revision revision>
+
+Path Name of the project revision under the CMS (or use the env variable PBROOT)
+
+=item B<-V|--version new_version>
+
+New version of the project to create based on the current one.
+
+=back 
+
+=head1 ARGUMENTS
+
+<action> can be:
+
+=over 4
+
+=item B<cms2build>
+
+Create tar files for the project under your CMS. 
+CMS supported are SVN and CVS
+parameters are packages to build
+if not using default list
+
+=item B<build2pkg>
+
+Create packages for your running distribution
+
+=item B<cms2pkg>
+
+cms2build + build2pkg
+
+=item B<build2ssh>
+
+Send the tar files to a SSH host
+
+=item B<cms2ssh>
+
+cms2build + build2ssh
+
+=item B<pkg2ssh>
+
+Send the packages built to a SSH host
+
+=item B<build2vm>
+
+Create packages in VMs, launching them if needed
+and send those packages to a SSH host once built
+VM type supported are QEMU
+
+=item B<build2ve>
+
+Create packages in VEs, creating it if needed
+and send those packages to a SSH host once built
+
+=item B<cms2vm>
+
+cms2build + build2vm
+
+=item B<cms2ve>
+
+cms2build + build2ve
+
+=item B<launchvm>
+
+Launch one virtual machine
+
+=item B<launchve>
+
+Launch one virtual environment
+
+=item B<script2vm>
+
+Launch one virtual machine if needed
+and executes a script on it
+
+=item B<script2ve>
+
+Execute a script in a virtual environment
+
+=item B<newvm>
+
+Create a new virtual machine
+
+=item B<newve>
+
+Create a new virtual environment
+
+=item B<newver>
+
+Create a new version of the project derived
+from the current one
+
+=item B<newproj>
+
+Create a new project and a template set of
+configuration files under pbconf
+
+=back 
+
+<pkgs> can be a list of packages, the keyword 'all' or nothing, in which case the default list of packages is taken (corresponding to the defpkgdir list of arguments in the configuration file).
+
+=head1 WEB SITES
+
+The main Web site of the project is available at L<http://www.project-builder.org/>. Bug reports should be filled using the trac instance of the project at L<http://trac.project-builder.org/>.
+
+=head1 USER MAILING LIST
+
+None exists for the moment.
+
+=head1 CONFIGURATION FILES
+
+Each pb user may have a configuration in F<$HOME/.pbrc>. The values in this file may overwrite any other configuration file value. 
+
+Here is an example of such a configuration file:
+
+ #
+ # Define for each project the URL of its pbconf repository
+ # No default option allowed here as they need to be all different
+ #
+ # URL of the pbconf content
+ # This is the format of a classical URL with the extension of additional schema such as 
+ # svn+ssh, cvs+ssh, ...
+ #
+ pbconfurl linuxcoe = cvs+ssh://:ext:bcornec@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe/pbconf
+
+ # This is normaly defined in the project's configuration file
+ # Url of the project
+ #
+ pburl linuxcoe = cvs+ssh://:ext:bcornec@linuxcoe.cvs.sourceforge.net:/cvsroot/linuxcoe
+ 
+ # All these URLs needs to be defined here as the are the entry point 
+ # for how to build packages for the project
+ #
+ pbconfurl pb = svn+ssh://svn.project-builder.org/mondo/svn/pb/pbconf
+ pbconfurl mondorescue = svn+ssh://svn.project-builder.org/mondo/svn/project-builder/mondorescue/pbconf
+ pbconfurl collectl = svn+ssh://bruno@svn.mondorescue.org/mondo/svn/project-builder/collectl/pbconf
+ pbconfurl netperf = svn+ssh://svn.mondorescue.org/mondo/svn/project-builder/netperf/pbconf
+ 
+ # Under that dir will take place everything related to pb
+ # If you want to use VMs/chroot/..., then use $ENV{'HOME'} to make it portable
+ # to your VMs/chroot/...
+ # if not defined then /var/cache
+ pbdefdir default = $ENV{'HOME'}/project-builder
+ pbdefdir pb = $ENV{'HOME'}
+ pbdefdir linuxcoe = $ENV{'HOME'}/LinuxCOE/cvs
+ pbdefdir mondorescue = $ENV{'HOME'}/mondo/svn
+ 
+ # pbconfdir points to the directory where the CMS content of the pbconfurl is checked out
+ # If not defined, pbconfdir is under pbdefdir/pbproj/pbconf
+ pbconfdir linuxcoe = $ENV{'HOME'}/LinuxCOE/cvs/pbconf
+ pbconfdir mondorescue = $ENV{'HOME'}/mondo/svn/pbconf
+ 
+ # pbdir points to the directory where the CMS content of the pburl is checked out
+ # If not defined, pbdir is under pbdefdir/pbproj
+ # Only defined if we have access to the dev of the project
+ pbdir linuxcoe = $ENV{'HOME'}/LinuxCOE/cvs
+ pbdir mondorescue = $ENV{'HOME'}/mondo/svn
+ 
+ # -daemonize doesn't work with qemu 0.8.2
+ vmopt default = -m 384
+
+=head1 AUTHORS
+
+The Project-Builder.org team L<http://trac.project-builder.org/> lead by Bruno Cornec L<mailto:bruno@project-builder.org>.
+
+=head1 COPYRIGHT
+
+Project-Builder.org is distributed under the GPL v2.0 license
+described in the file C<COPYING> included with the distribution.
+
+=cut
+
+# ---------------------------------------------------------------------------
+
+# Old syntax
+#getopts('a:fhi:l:m:P:p:qr:s:vV:',\%opts);
 
 my ($projectbuilderver,$projectbuilderrev) = pb_version_init();
+
+GetOptions("help|?|h" => \$opts{'h'}, 
+        "man" => \$opts{'man'},
+        "verbose|v+" => \$opts{'v'},
+        "quiet|q" => \$opts{'q'},
+        "log-files|l=s" => \$opts{'l'},
+        "force|f" => \$opts{'f'},
+        "account|a=s" => \$opts{'a'},
+        "revision|r=s" => \$opts{'r'},
+        "script|s=s" => \$opts{'s'},
+        "machines|mock|m=s" => \$opts{'m'},
+        "port|P=i" => \$opts{'P'},
+        "project|p=s" => \$opts{'p'},
+        "iso|i=s" => \$opts{'i'},
+        "version|V=s" => \$opts{'V'},
+) || pb_syntax(-1,0);
+
 if (defined $opts{'h'}) {
-    pb_syntax();
-    exit(0);
+    pb_syntax(0,1);
+}
+if (defined $opts{'man'}) {
+    pb_syntax(0,2);
 }
 if (defined $opts{'v'}) {
-    $debug = 2;
-    #$debug = $opts{'v'};
+    $debug = $opts{'v'};
     pb_log(0,"Debug value: $debug\n");
 }
@@ -70 +333 @@
 pb_log_init($debug, $LOG);
 
-# Handles test option
-if (defined $opts{'t'}) {
-    $test = "TRUE";
-    # Works only for SVN
-    $option = "-r BASE";
-}
-
 # Handle root of the project if defined
 if (defined $opts{'r'}) {
@@ -103 +359 @@
 # Get Action
 $action = shift @ARGV;
-die pb_syntax() if (not defined $action);
+die pb_syntax(-1,1) if (not defined $action);
 
 my ($filteredfiles, $supfiles, $defpkgdir, $extpkgdir);
@@ -170 +426 @@
 } else {
     pb_log(0,"\'$action\' is not available\n");
-    pb_syntax();
+    pb_syntax(-2,1);
 }
 
@@ -177 +433 @@
     my $ptr = pb_get_pkg($defpkgdir,$extpkgdir);
     @pkgs = @$ptr;
-    my ($scheme,$uri)=pb_cms_init($ENV{'PBPROJ'});
+    my ($uri) = pb_conf_get("pburl");
+    my ($scheme, $account, $host, $port, $path) = pb_get_uri($uri->{$ENV{'PBPROJ'}});
 
     #
     # Check project cms compliance
     #
-    pb_cms_compliant("pbdir",'PBDIR',"$ENV{'PBDEFDIR'}/$ENV{'PBPROJ'}",$uri,$pbinit);
+    pb_cms_compliant("pbdir",'PBDIR',"$ENV{'PBDEFDIR'}/$ENV{'PBPROJ'}",$uri->{$ENV{'PBPROJ'}},$pbinit);
+
+    # Some variable initialization depending on CMS type
+    pb_cms_init($scheme);
 
     my ($pkgv, $pkgt) = pb_conf_get_if("pkgver","pkgtag");
@@ -225 +485 @@
 
         # If it isn't a flat CMS, then we have the choice to export subdir
-        #$dir = "$uri/$dir" if ($ENV{'PBREVISION'} ne "flat");
-        pb_cms_export($uri,"$ENV{'PBDIR'}/$pbprojver/$dir",$dest);
+        pb_cms_export($uri->{$ENV{'PBPROJ'}},"$ENV{'PBDIR'}/$pbprojver/$dir",$dest);
 
         # Get project info on authors and log file
@@ -905 +1164 @@
     my $res = pb_cms_isdiff($scheme);
     die "You need to have no differences before creating a new version" if ($res != 0);
-    my $cmsurl = pb_cms_getinfo($scheme,$ENV{'PBROOT'},"URL:");
+    my $cmsurl = pb_cms_get_uri($scheme,$ENV{'PBROOT'});
     my $newurl = dirname($cmsurl)."/$newver";
     pb_cms_copy($scheme,$cmsurl,$newurl);
@@ -1141 +1400 @@
 }
 
+
 sub pb_syntax {
 
-    print "pb (aka project-builder) Version $projectbuilderver-$projectbuilderrev\n";
-    print "\n";
-    print "Syntax: pb [-vhqt][-r pbroot][-p project][[-s script -a account -P port] -m \"mach-1[,...]\"][-i iso] <action> [<pkg1> ...]\n";
-    print "\n";
-    print "-h: This help file\n";
-    print "-q: Quiet mode\n";
-    print "-t: Test mode (not done yet)\n";
-    print "-v: Verbose mode\n";
-    print "\n";
-    print "-m machine: Name of the Virtual Machines (VM) you want\n";
-    print "            to build on (coma separated). All if none precised\n";
-    print "            (or use the env variable PBV)       \n";
-    print "\n";
-    print "-s script:  Name of the script you want\n";
-    print "            to execute on the related VMs.\n";
-    print "\n";
-    print "-i iso:     Name of the ISO image of the distribution you want\n";
-    print "            to install on the related VMs.\n";
-    print "\n";
-    print "-a account: Name of the account to use\n";
-    print "            to connect on the related VMs.\n";
-    print "\n";
-    print "-P port:    Port number to use\n";
-    print "            to connect on the related VMs.\n";
-    print "\n";
-    print "-p project: Name of the project you're working on\n";
-    print "            (or use the env variable PBPROJ)     \n";
-    print "\n";
-    print "-r pbroot:  Path Name of project under the CMS \n";
-    print "            (or use the env variable PBROOT)   \n";
-    print "\n";
-    print "-V newver:  New version of the project to create\n";
-    print "            from the current one.              \n";
-    print "\n";
-    print "<action> can be:\n";
-    print "\n";
-    print "\tcms2build:    Create tar files for the project under your CMS\n";
-    print "\t              CMS supported are SVN and CVS\n";
-    print "\t              parameters are packages to build\n";
-    print "\t              if not using default list\n";
-    print "\n";
-    print "\tbuild2pkg:    Create packages for your running distribution  \n";
-    print "\n";
-    print "\tcms2pkg:      cms2build + build2pkg\n";
-    print "\n";
-    print "\tbuild2ssh:    Send the tar files to a SSH host               \n";
-    print "\n";
-    print "\tcms2ssh:      cms2build + build2ssh\n";
-    print "\n";
-    print "\tpkg2ssh:      Send the packages built to a SSH host          \n";
-    print "\n";
-    print "\tbuild2vm:     Create packages in VMs, launching them if needed\n";
-    print "\t              and send those packages to a SSH host once built\n";
-    print "\t              VM type supported are QEMU            \n";
-    print "\n";
-    print "\tbuild2ve:     Create packages in VEs, creating it if needed\n";
-    print "\t              and send those packages to a SSH host once built\n";
-    print "\n";
-    print "\tcms2vm:       cms2build + build2vm\n";
-    print "\n";
-    print "\tcms2ve:       cms2build + build2ve\n";
-    print "\n";
-    print "\tlaunchvm:     Launch one virtual machine\n";
-    print "\n";
-    print "\tlaunchve:     Launch one virtual environment\n";
-    print "\n";
-    print "\tscript2vm:    Launch one virtual machine if needed        \n";
-    print "\t              and executes a script on it                 \n";
-    print "\n";
-    print "\tscript2ve:    Execute a script in a virtual environment       \n";
-    print "\n";
-    print "\tnewvm:        Create a new virtual machine\n";
-    print "\n";
-    print "\tnewve:        Create a new virtual environment\n";
-    print "\n";
-    print "\tnewver:       Create a new version of the project derived \n";
-    print "\t              from the current one                        \n";
-    print "\n";
-    print "\tnewproj:      Create a new project and a template set of  \n";
-    print "\t              configuration files under pbconf            \n";
-    print "\n";
-}
+my $exit_status = shift || -1;
+my $verbose_level = shift || 0;
+
+my $filehandle = \*STDERR;
+
+$filehandle = \*STDOUT if ($exit_status == 0);
+
+pod2usage( { -message => "pb (aka project-builder.org) Version $projectbuilderver-$projectbuilderrev\n",
+             -exitval => $exit_status  ,
+             -verbose => $verbose_level,
+             -output  => $filehandle } );
+}
+
+