WebSVN – DevTools – Diff – /core_devl/branches/dpurdie_devl/TOOLS/jats_svn.pl

 use warnings;
 use JatsError;
 use JatsSvn qw(:All);
 use JatsLocateFiles;
 use JatsProperties;
 use Pod::Usage;                                 # required for help support
 use Getopt::Long qw(:config require_order);     # Stop on non-option
 use Cwd;
 use File::Path;
 use File::Copy;
 #   Process command
 #   First command line argument is a subversion command
+#
 my $cmd = shift @ARGV || "help";
 CreatePackage()                        if ( $cmd =~ m/^create/ );
+CreateBranch()                         if ( $cmd =~ m/^branch/ );
+SwitchBranch()                         if ( $cmd =~ m/^switch/ );
 DeleteBranch()                         if ( $cmd =~ m/^delete-branch/ );
 DeletePackage()                        if ( $cmd =~ m/^delete-package/ );
 ImportPackage()                        if ( $cmd =~ m/^import/ );
 SvnRepoCmd($cmd, @ARGV)                if ( $cmd eq 'ls' );
 TestSvn()                              if ($cmd eq 'test');
 #-------------------------------------------------------------------------------
 # Function        : ShowPaths
+#
 # Description     : Show PATHS
+#
 # Inputs          :
+#
 # Returns         :
+#
 sub ShowPaths
+{
+    #
     #   Parse more options
         $uref->CalcRmReference($uref->FullWs());
+    }
     Message ("Tag is  : " . $uref->RmRef() );
     Message ("Vcs Tag : " . $uref->SvnTag  );
     $opr_done = 1;
+}
 #-------------------------------------------------------------------------------
 # Function        : ShowUrl
+#
     SubCommandHelp( $opt_help, "Test Subversion") if ($opt_help || $#ARGV >= 0);
     SvnUserCmd( '--version');
     $opr_done = 1;
+}
 #-------------------------------------------------------------------------------
 # Function        : SvnRepoCmd
+#
 # Description     : Execute a SVN command, where the first argument
 #                   is a repository specifier
+#
 # Inputs          : $cmd
 #                   $repo_url
 #                   @opts
+#
 # Returns         :
+#
 sub SvnRepoCmd
+{
     my ( $cmd, $repo_url, @opts ) = @_;
     my $uref = NewSessionByUrl ( $repo_url );
     SvnUserCmd( $cmd,
             $uref->Full,
             @opts,
             { 'credentials' => 1 });
     $opr_done = 1;
+}
 #-------------------------------------------------------------------------------
 # Function        : DeletePackage
 # Description     : Delete a Package structure within a Repository
 #                   Intended for test usage
+#
 # Inputs          : URL                 - Url to Repo + Package Base
+#
 # Returns         :
+#
 sub DeletePackage
+{
     my $opt_error = 0;
+    #
 #                       -tag=name       - Import to Tag Only
 #                       -branch=name    - Import to Branch only
 #                       -new            - Must be new package
 #                       -replace        - Replace existing
+#
 # Returns         :
+#
 sub CreatePackage
+{
     my $opt_import;
     my $opt_tag;
     my $opt_replace;
     my $pname;
     my $type;
     my $opt_author;
     my $opt_date;
     Message ("Create New Package Version" );
+    #
     #   Parse more options
+    #
+    #
     #   Subcommand specific help
+    #
     SubCommandHelp( $opt_help, "Create a Package Version") if ($opt_help || $#ARGV < 0);
+    #
     #   Alter the error reporting parameters
+    #
     ErrorConfig( 'verbose' => $opt_verbose );
 #                   the  package
+#
 #                   Intended to allow the importation of multiple
 #                   versions of a package
+#
 # Inputs          :
+#
 # Returns         :
+#
 sub ImportPackage
+{
     Message ("Import Package Version" );
     #   Insert defaults
     #   User can specify base package via -package or a non-options argument
+    #
     $opt_package = $ARGV[0] unless ( $opt_package );
     unlink $opt_datafile if ( defined $opt_datafile );
+    #
     #   Subcommand specific help
+    #
     SubCommandHelp( $opt_help, "Import directory to a Package")
         if ($opt_help || ! $opt_package );
+    }
     else
+    {
         Message ("Reusing Workspace");
+    }
+    #
     #   Determine differences between the two folders
     #       Create structures for each directory
+    #
     Message ("Determine Files in packages");
             my $end = $base + 200;
             $end = $num if ( $end > $num );
             $svn->SvnCmd ( 'delete', map ("$opt_workdir/$_@", @rm_files[$base .. $end] ),
                             { 'error' => 'Deleting files from workspace' } );
             $base = $end + 1;
+        }
+    }
+    #
     #   Add New Files
     #   Won't add empty directories at this point
+    #
     #   Process by sorted list
 #-------------------------------------------------------------------------------
 # Function        : DeleteBranch
+#
 # Description     : Delete the branch that a workspace is based upon
+#
 # Inputs          :
+#
 # Returns         :
+#
 sub DeleteBranch
+{
     my $opt_path;
     my $opt_error = 0;
                       'comment'   => [$uref->Path().": Delete Branch",'Deleted by user command: jats svn delete-branch'],
                       );
     $opr_done = 1;
+}
+#-------------------------------------------------------------------------------
+# Function        : CreateBranch
+#
+# Description     : Branch a workspace and then switch to the new branch
+#
+# Inputs          :
+#
+# Returns         :
+#
+sub CreateBranch
+{
+    my $opt_path;
+    my $opt_comment;
+    my $opt_switch = 1;
+    my $opt_branch;
+    #
+    #   Parse more options
+    #
+    GetOptions (
+                "help:+"        => \$opt_help,
+                "manual:3"      => \$opt_help,
+                "path:s"        => \$opt_path,
+                "switch!"       => \$opt_switch,
+                "comment:s"     => \$opt_comment,
+                ) || Error ("Invalid command line" );
+    #
+    #   Subcommand specific help
+    #
+    SubCommandHelp( $opt_help, "Create Branch") if ($opt_help);
+    #
+    #   Sanity Tests
+    #
+    Message ("Create Workspace Branch" );
+    Error ("Too many arguments: @ARGV") if ( $#ARGV > 0 );
+    Error ("Not enough arguments. No branch name specified") if ( $#ARGV < 0 );
+    #
+    #   Sanity test the label
+    #
+    $opt_branch = SvnIsaSimpleLabel ($ARGV[0] );
+    #
+    #   Do all the hard work
+    #
+    $opt_path = '.' unless ( defined $opt_path );
+    my $uref = NewSessionByWS($opt_path, 0, 1);
+    my $ws_root = $uref->SvnLocateWsRoot(1);
+    my $ws_url = $uref->Full();
+    #
+    #   Use the verion of the branch that has been committed as the base of the
+    #   copy. If the user has modified files, then they won't be commited
+    #
+    #   This operation will be server-side only
+    #
+    Message ("Creating branch: $opt_branch");
+    my $repoLink = $uref->{InfoWs}{URL} . '@' . $uref->{InfoWs}{Revision};
+    $uref->{DEVBRANCH} =  join ('/', 'branches', $opt_branch);
+    my $branch_tag = $uref->SvnCopy (
+                'old' => $repoLink,
+                'new' => join ('/', $ws_url, $uref->{DEVBRANCH} ),
+                'comment' => $opt_comment ? $opt_comment : 'Created by Jats svn branch',
+                'replace' => 0,
+                );
+    if ( $opt_switch )
+    {
+        Verbose ("Switching to new branch: $opt_branch");
+        $branch_tag = SvnPath2Url($branch_tag);
+        $uref->SvnSwitch ($branch_tag,
+                          $opt_path,
+                          '--Print' );
+    }
+    else
+    {
+        Warning ("Using existing workspace, not the created branch");
+    }
+    Message ("Repository Ref: " . $uref->RmRef);
+    Message ("Vcs Tag       : " . $uref->SvnTag);
+#    #
+#    #   The copy operation *should* be a server side operation only
+#    #   If the user has commited changes, but not yet updated the local
+#    #   workspace, then subversion will do a client side copy
+#    #   This is not good.
+#    #
+#    $uref->SvnCopyWs (
+#                   target => join ('/', $ws_url, 'branches', $opt_branch),
+#                   'allowLocalMods' => 1,
+#                   'noupdatecheck' => 1,
+#                   'noswitch' => ! $opt_switch,
+#                   'replace' => 0,
+#                   'comment' => $opt_comment ? $opt_comment : 'Created by Jats svn branch',
+#                   );
+#
+#    Message ("Repository Ref: " . $uref->RmRef);
+#    Message ("Vcs Tag       : " . $uref->SvnTag);
+    $opr_done = 1;
+}
 #-------------------------------------------------------------------------------
+# Function        : SwitchBranch
+#
+# Description     : Switch to a specified branch
+#
+# Inputs          :
+#
+# Returns         :
+#
+sub SwitchBranch
+{
+    my $opt_path = '.';
+    my $opt_branch;
+    #
+    #   Parse more options
+    #
+    GetOptions (
+                "help:+"        => \$opt_help,
+                "manual:3"      => \$opt_help,
+                "path:s"        => \$opt_path,
+                ) || Error ("Invalid command line" );
+    #
+    #   Subcommand specific help
+    #
+    SubCommandHelp( $opt_help, "Switch Branch") if ($opt_help);
+    return ShowBranches($opt_path) if ( $#ARGV < 0 );
+    #
+    #   Sanity Tests
+    #
+    Error ("Too many arguments: @ARGV") if ( $#ARGV > 0 );
+    #
+    #   Calculate the target name
+    #       trunk is special
+    #       tags/... is special
+    $opt_branch = $ARGV[0];
+    if ( $opt_branch eq 'trunk' ) {
+    } elsif ( $opt_branch =~ m~tags/.+~ ) {
+    } else {
+        $opt_branch = join ('/', 'branches', $opt_branch);
+    }
+    Message ("Switching to new branch: $opt_branch");
+    #
+    #   Do all the hard work
+    #
+    my $uref = NewSessionByWS($opt_path, 0, 1);
+    my $ws_url = $uref->Full();
+    my $branch_tag = join ('/', $ws_url, $opt_branch);
+    #
+    #   Validate the branch
+    #
+    $uref->SvnValidateTarget (
+                        'cmd'    => 'svn switch',
+                        'target' => $branch_tag,
+                        'require' => 1,
+                        );
+    $uref->SvnSwitch ($branch_tag, $opt_path, '--Print' );
+    $opr_done = 1;
+}
+#-------------------------------------------------------------------------------
+# Function        : ShowBranches
+#
+# Description     : Show branches in current workspace
+#                   Internal use only
+#
+# Inputs          : $opt_path           - Optional path
+#
+# Returns         :
+#
+sub ShowBranches
+{
+    my ($opt_path) = @_;
+    my $uref = NewSessionByWS($opt_path, 0, 1);
+    my $ws_url = $uref->Full();
+    #
+    #   Display the packages full URL - allow the user to manuallu look at more
+    #   List the bracnhes
+    #
+    Message ("Url: $ws_url", 'Available Branches');
+    SvnUserCmd( 'ls', join ('/', $ws_url, 'branches'), { 'credentials' => 1 });
+    $opr_done = 1;
+}
+#-------------------------------------------------------------------------------
 # Function        : SubCommandHelp
+#
 # Description     : Provide help on a subcommand
+#
 # Inputs          : $help_level             - Help Level 1,2,3
     pod2usage({-verbose => 99,
                -noperldoc => 1,
                -sections => $topic . '/' . join('|', @sections) } );
+}
 #-------------------------------------------------------------------------------
 #   Documentation
 #   NOTE
+#
 #   Each subcommand MUST have
     test                   - Test access to subversion
     paths                  - Display Subversion tag to URL conversions
     ls URL                 - List Repo contents for URL
     tag [URL]              - Convert URL or Path to a Release Manager Tag
     url [TAG]              - Convert TAG or Path to a Subversion URL
+    create-package URL     - Create a new package at URL
     delete-package URL     - Delete Package Subtree
+    branch BRANCH          - Create a Development Branch
+    switch [BRANCH]        - Switch to a Development Branch
     delete-branch          - Delete a Development Branch
-    create URL             - Create a new package at URL
     import URL             - Import files to package at URL
  Use the command
     jats svn command -h
  for command specific help
 =head1 OPTIONS
 =over
 =item B<-help[=n]>
 If a TAG is to be converted, then the resultant value should be used with
 caution. The result is only as good as the provided URL and may not address
 the root of a package.
+=head1 Create a Package Version
+=head2 NAME
+Create a Package Version
+=head2 SYNOPSIS
+jats svn [options] create-package URL [command options]
+ Options:
+    -help[=n]               - Help message, [n=1,2,3]
+    -man                    - Full documentation [-help=3]
+    -verbose[=n]            - Verbose command operation
+ Command Options
+    -help[=n]               - Provide command specific help
+    -new                    - Package must not exist
+    -replace                - Replace any existing versions
+    -import=nnn             - Import directory tree
+    -label=nnn              - Label imported package
+    -trunk                  - Import to trunk (default)
+    -tags=nnn               - Import to tags
+    -branch=nnn             - Import to branches
+=head2 ARGUMENTS
+The command takes one argument: The URL of the desired package.
+This may be be:
+=over
+=item * A full URL
+Complete with protocol and path information.
+=item * A simple URL
+JATS will prepend the site-specific repository location to the user provided URL
+=back
+=head2 OPTIONS
+=over
+=item -help[=n]
+Print a help message and exit. The level of help may be either 1, 2 or 3.
+This option may be specified multiple times to increment the help level, or
+the help level may be directly specified as a number.
+=item -new
+This option specifies that the named package MUST not exist at all.
+=item -replace
+This option allows the program to replace any existing versions of the
+imported source. It will allow the deletion of any existing trunk, tags or
+branches.
+=item -import=nnn
+This option specifies the path of a subdirectory tree to import into the newly
+created package. In not provided, then only a package skeleton will be created.
+=item -label=nnn
+This option specifies a label to place the imported source.
+=item -trunk
+This option specifies that imported source will be placed on the trunk of the
+package. This is the default mode of import.
+The options -trunk, -tags and -branch are mutually exclusive.
+=item -tags=nnn
+This option specifies that imported source will be placed directly on the
+named tag of the package.
+The options -trunk, -tags and -branch are mutually exclusive.
+=item -branch=nnn
+This option specifies that imported source will be placed directly on the
+named branch of the package.
+The options -trunk, -tags and -branch are mutually exclusive.
+=back
+=head2 DESCRIPTION
+This command will create a new package within a repository. It will ensure
+that the package contains the three required subdirectories: trunk, tags and
+branches.
+The command will also ensure that packages are not placed at inappropriate
+locations within the repository. It is not correct to place a package within
+another package.
+The command will, optionally, import a directory tree into the repository and,
+optionally, label the package.
+The package body may be imported to the 'trunk' or to a branch or a tag.
+By default the data will be imported to the trunk and may be labeled (tagged).
+Options allow the targets to be deleted if they exist or to ensure that they
+are not present.
+The command does not attempt to merge file versions within the repository. It
+may result in multiple instances of a file within the repository. Use only for
+simple imports. Use the 'import' command for more sophisticated import requirements.
 =head1 Delete a Package
 =head2 NAME
 Delete a Package
 This command will delete a package from the repository. It will ensure
 that the package is a valid package, before it is deleted.
 The command is intended to be used by test scripts, rather than users.
-=head1 Delete Branch
+=head1 Create Branch
 =head2 NAME
-Delete the Workspace Branch
+Create a Workspace Branch
 =head2 SYNOPSIS
-jats svn delete-branch [options]
+jats svn branch branch-name [options]
  Options:
     -help[=n]              - Help message, [n=1,2,3]
     -man                   - Full documentation [-help=3]
     -verbose[=n]           - Verbose command operation
     -path=path             - Target workspace
+    -[no]switch            - Switch to new branch(default)
+    -comment=text          - Comment to apply to the new branch
 =head2 ARGUMENTS
-The command takes no arguments.
+The command takes one argument. The name of the branch to be created.
 =head2 OPTIONS
 =over
 =item B<-path=path>
 This options specifies the path of the target workspace. If not provided the
 command will use the current directory.
+=item B<-[no]switch>
+If enabled (the default) the workspace will be switched to the new branch at
+the end of the process.
+=item B<-comment=text>
+If present, the specified text will be used as a Subversion comment when the
+branch is created.
+If not provided, then JATS will provide a basic comment.
 =back
 =head2 DESCRIPTION
-This command will delete the branch associated with the workspace in the
+This command will create a named branch associated with the workspace in the
-specified path. It is intended to simplify the deletion of Private or
+specified path. It is intended to simplify the creation of Private or
 Development branches.
-If the workspace is not linked to a 'branch' then the command will fail.
+If the named branch already exists, then the command will fail.
+The command performs a server-side copy. It will not commit any locally
+modified files. Nor will it inform you if there are any.
+By default, the user is 'switched' to the newly created branch.
-=head1 Create a Package Version
+=head1 Switch Branch
 =head2 NAME
-Create a Package Version
+Switch a Workspace Branch
 =head2 SYNOPSIS
-jats svn [options] create URL [command options]
+jats svn switch [branch-name] [options]
  Options:
-    -help[=n]               - Help message, [n=1,2,3]
+    -help[=n]              - Help message, [n=1,2,3]
-    -man                    - Full documentation [-help=3]
+    -man                   - Full documentation [-help=3]
-    -verbose[=n]            - Verbose command operation
+    -verbose[=n]           - Verbose command operation
- Command Options
-    -help[=n]               - Provide command specific help
-    -new                    - Package must not exist
-    -replace                - Replace any existing versions
-    -import=nnn             - Import directory tree
-    -label=nnn              - Label imported package
-    -trunk                  - Import to trunk (default)
-    -tags=nnn               - Import to tags
+    -path=path             - Target workspace
-    -branch=nnn             - Import to branches
 =head2 ARGUMENTS
-The command takes one argument: The URL of the desired package.
+The command takes one optional argument. The name of the target branch.
-This may be be:
+=head2 OPTIONS
 =over
-=item * A full URL
+=item B<-path=path>
+This options specifies the path of the target workspace. If not provided the
-Complete with protocol and path information.
+command will use the current directory.
-=item * A simple URL
+=back
-JATS will prepend the site-specific repository location to the user provided URL
+=head2 DESCRIPTION
-=back
+This command will switch the users workspace to the named branch. This is
+identical to the Subversion switch command, except it is easier to user and
+has several validity checks and other enhancements.
-=head2 OPTIONS
+The command has two modes of operation:
-=over
+=over 4
-=item -help[=n]
+=item   1. Display a list of branched in the current package.
-Print a help message and exit. The level of help may be either 1, 2 or 3.
+If no branch is specified, then the utility will display a list of branches in
+the packages 'branches' directory.
-This option may be specified multiple times to increment the help level, or
-the help level may be directly specified as a number.
+=item   2. Switch to the named branch.
-=item -new
+The named branch must exists otherwise the command will fail.
-This option specifies that the named package MUST not exist at all.
+There are two spcial variants of the branch name:
-=item -replace
+=over 4
-This option allows the program to replace any existing versions of the
-imported source. It will allow the deletion of any existing trunk, tags or
-branches.
+=item trunk
-=item -import=nnn
+If the branch is named 'trunk' then it will refer to the packages truck
-This option specifies the path of a subdirectory tree to import into the newly
+=item tags
-created package. In not provided, then only a package skeleton will be created.
+If the branch name starts with 'tags/', then the command will refer to
-=item -label=nnn
+a tag within the package and not a branch.
-This option specifies a label to place the imported source.
+=back
+The command will add and remove unmodified files from the workspace during this
-=item -trunk
+operation.
-This option specifies that imported source will be placed on the trunk of the
-package. This is the default mode of import.
+=back
-The options -trunk, -tags and -branch are mutually exclusive.
+=head3 Examples
-=item -tags=nnn
+To switch to the packages trunk
-This option specifies that imported source will be placed directly on the
-named tag of the package.
+    jats svn switch trunk
-The options -trunk, -tags and -branch are mutually exclusive.
+To switch to the a branch called MyBranch
-=item -branch=nnn
+    jats svn switch MyBranch
-This option specifies that imported source will be placed directly on the
-named branch of the package.
+To switch to a tagged version of the package
-The options -trunk, -tags and -branch are mutually exclusive.
+    jats svn switch tags/MyPackage_1.0.0000.cr
-=back
+To display a list of available branches (not tags)
-=head2 DESCRIPTION
+    jats svn switch
-This command will create a new package within a repository. It will ensure
-that the package contains the three required subdirectories: trunk, tags and
-branches.
+=head1 Delete Branch
-The command will also ensure that packages are not placed at inappropriate
-locations within the repository. It is not correct to place a package within
-another package.
+=head2 NAME
-The command will, optionally, import a directory tree into the repository and,
-optionally, label the package.
+Delete the Workspace Branch
-The package body may be imported to the 'trunk' or to a branch or a tag.
+=head2 SYNOPSIS
-By default the data will be imported to the trunk and may be labeled (tagged).
-Options allow the targets to be deleted if they exist or to ensure that they
-are not present.
+jats svn delete-branch [options]
+ Options:
+    -help[=n]              - Help message, [n=1,2,3]
+    -man                   - Full documentation [-help=3]
+    -verbose[=n]           - Verbose command operation
+    -path=path             - Target workspace
+=head2 ARGUMENTS
+The command takes no arguments.
+=head2 OPTIONS
+=over
+=item B<-path=path>
+This options specifies the path of the target workspace. If not provided the
+command will use the current directory.
+=back
+=head2 DESCRIPTION
-The command does not attempt to merge file versions within the repository. It
+This command will delete the branch associated with the workspace in the
-may result in multiple instances of a file within the repository. Use only for
+specified path. It is intended to simplify the deletion of Private or
+Development branches.
-simple imports. Use the 'import' command for more sophisticated import requirements.
+If the workspace is not linked to a 'branch' then the command will fail.
 =head1 Import directory to a Package
 =head2 NAME
     -author=name            - Force author of changes
     -date=dateString        - Force date of changes
     -log=text               - Append text to the commit message
     -datafile=path          - Export tag data for automation
 =head2 ARGUMENTS
 The command takes one argument: The URL of the desired package.
 This may be be:
 This option will increase the level of verbosity of the utility.
 If an argument is provided, then it will be used to set the level, otherwise the
 existing level will be incremented. This option may be specified multiple times.
 =item -package=name
 Either this option or a bare URL on the command line must be provided. It
 specifies the repository and package to be used as a basis for the work.

Subversion Repositories DevTools

(root)/core_devl/branches/dpurdie_devl/TOOLS/jats_svn.pl – Rev 1356 → 2048