Subversion Repositories DevTools

use FileUtils;

InitFileUtils();

SvnMerge()                             if ( $cmd =~ m/^merge/ );

SvnReintegrate()                       if ( $cmd =~ m/^reintegrate/ );

# Function        : SvnMerge 

#

# Description     : Perform an svn merge 

#                       - with sanity checking

#                       - auto deterine the correct 'head' to merge from

#                  

#

# Inputs          : None

#

# Returns         : 

#

sub SvnMerge

{

    my $opt_path = '.';

    my $opt_info;

    my @mergeOpts;

    my $opt_dryRun;

    #

    #   Parse more options

    #

    Getopt::Long::Configure('pass_through');

    GetOptions (

                "help:+"        => \$opt_help,

                "manual:3"      => \$opt_help,

                "path:s"        => \$opt_path,

                'info'          => \$opt_info,

                'dry-run'       => \$opt_dryRun,

                ) || Error ("Invalid command line" );

    #

    #   Subcommand specific help

    #

    SubCommandHelp( $opt_help, "Sync Merge") if ($opt_help);

    #

    #   Save merge options

    #   Error if a non-option is present

    #

    foreach (@ARGV) {

        if (m~^-~) {

            push @mergeOpts, $_;

        } else {

            Error ("Only options must be passed to Merge: $_");

        }

    }

    #

    #   We intercepted the dry-run option

    #   Put the option back into the stream.

    if ($opt_dryRun) {

        push @mergeOpts, '--dry-run';

    }

    #   Check we are in a workspace

    #   Create an SVN session

    #   

    my $uref = NewSessionByWS($opt_path, 0, 1);

#    DebugDumpData("uref", $uref);

    #

    #   Warn user if the command is being executed from within a subdirectory of the workspace

    #   It might work, but if the directory is deleted it will go badly

    #

    my $ws_root = mustBeWsRoot($uref);

    #

    #   Determine the source of the merge

    #   Get some more workspace information

    # 

    $uref->getWsExtraInfo();

    my $logInfo = $uref->{InfoWsExtra};

#DebugDumpData("getWsExtraInfo", $logInfo);

    # A bit of sanity testing

    Error("Workspace does not appear to be a branch") unless (exists $logInfo->{'copyfrom-path'}); 

    Error("Workspace does not appear to be a branch") unless (exists $logInfo->{'target'}); 

    Error("Workspace is a trunk") if ($logInfo->{'target'} =~ m~/trunk$~);

    Error("Workspace is a raw branch") if ($logInfo->{'target'} =~ m~/branches$~);

    Error("Workspace is a raw tag") if ($logInfo->{'target'} =~ m~/tags$~);

    Error("Workspace is a within a tag") if ($logInfo->{'target'} =~ m~/tags/~);

    #   Ensure the source is a branch and not a trunk

    #   Ensure this workspace is not on the same bit (trunk or branch) 

    #   

    Message ("Merge Info - No merge performed") if $opt_info;

    Message ("RepoRoot: " . $uref->{InfoWs}{'Repository Root'});

    Message ("Parent: " . $logInfo->{'copyfrom-path'});

    Message ("Workspace: " . $logInfo->{'target'});

    unless ($opt_info) {

        #

        #   $logInfo->{'copyfrom-path'} is the parent of the branch in the workspace

        #   use merge ^/<copyfrom-path> to merge the data into this workspace

        #

        #   Perform an interactive command so that the user can accept conflicts - if they want

        my $rv = SvnUserCmd( 'merge',

                @mergeOpts,

                '^' . $logInfo->{'copyfrom-path'},

                $opt_path,

                { 'credentials' => 1 });

        exit $rv;

    }

    $opr_done = 1;

}

#-------------------------------------------------------------------------------

# Function        : SvnReintegrate

#

# Description     : Perform an svn merge --reintegrate

#                       - with much sanity checking

#                       - auto deterine the correct 'head' to merge from

#                       - will delete the branch

#                  

#

# Inputs          : None

#

# Returns         : 

#

sub SvnReintegrate

{

    my $opt_path = '.';

    my $opt_info;

    my @mergeOpts;

    my $opt_reintegrate;

    my $opt_dryRun;

    #

    #   Parse more options

    #

    Getopt::Long::Configure('pass_through');

    GetOptions (

                "help:+"        => \$opt_help,

                "manual:3"      => \$opt_help,

                "path:s"        => \$opt_path,

                'info'          => \$opt_info,

                'reintegrate!'  => \$opt_reintegrate,

                'dry-run'       => \$opt_dryRun,

                ) || Error ("Invalid command line" );

    #

    #   Subcommand specific help

    #

    SubCommandHelp( $opt_help, "Reintegrate Merge") if ($opt_help);

    #

    #   Save merge options

    #   Error if a non-option is present

    #

    foreach (@ARGV) {

        if (m~^-~) {

            push @mergeOpts, $_;

        } else {

            Error ("Only options must be passed to Reintegrate: $_");

        }

    }

    #

    #   We intercepted the dry-run option, so that we know not to delete the Branch

    #   Put the option back into the stream.

    if ($opt_dryRun) {

        push @mergeOpts, '--dry-run';

        $opt_reintegrate = 1;

    }

    #   Check we are in a workspace

    #   Create an SVN session

    #   

    my $uref = NewSessionByWS($opt_path, 0, 1);

#    DebugDumpData("uref", $uref);

    #

    #   Warn user if the command is being executed from within a subdirectory of the workspace

    #   It might work, but if the directory is deleted it will go badly

    #

    my $ws_root = mustBeWsRoot($uref);

    #

    #   Determine the source of the merge

    #   Get some more workspace information

    # 

    $uref->getWsExtraInfo();

    my $logInfo = $uref->{InfoWsExtra};

#DebugDumpData("getWsExtraInfo", $logInfo);

    # A bit of sanity testing

    Error("Workspace does not appear to be a branch") unless (exists $logInfo->{'copyfrom-path'}); 

    Error("Workspace does not appear to be a branch") unless (exists $logInfo->{'target'}); 

    Error("Workspace is a trunk") if ($logInfo->{'target'} =~ m~/trunk$~);

    Error("Workspace is a raw branch") if ($logInfo->{'target'} =~ m~/branches$~);

    Error("Workspace is a raw tag") if ($logInfo->{'target'} =~ m~/tags$~);

    Error("Workspace is a within a tag") if ($logInfo->{'target'} =~ m~/tags/~);

    #   Ensure the source is a branch and not a trunk

    #   Ensure this workspace is not on the same bit (trunk or branch) 

    #   

    Message ("Reintegrate Info - No merge performed") if ($opt_info || !$opt_reintegrate);

    Message ("RepoRoot: " . $uref->{InfoWs}{'Repository Root'});

    Message ("Parent Branch: " . $logInfo->{'copyfrom-path'});

    Message ("Workspace Branch: " . $logInfo->{'target'} . " <<-- WILL BE DELETED");

    Message ("No merge performed.","Use '-reintegrate' to acknolowedge the operation, or '-dry-run'") if (!$opt_info && !$opt_reintegrate);

    #

    #   Examine the workspace and ensure that there are no modified

    #   files - unless they are expected

    #   

    #   Prevent the user from merging into a WS that has not been committed

    #

    $uref->SvnWsModified ( 'cmd' => 'Reintegrate' );

    unless ($opt_info || !$opt_reintegrate) {

        #

        #   Switch the workspace to the parent

        #       Must Change directory before we switch

        #       Otherwise we will import changes into the wrong place

        #

        Message ("Switching workspace to : " . $logInfo->{'copyfrom-path'} );

        chdir ($ws_root) || Error ("Cannot cd to: " . $ws_root);

        $uref->SvnSwitch ( '^' . $logInfo->{'copyfrom-path'}, '.', '--Print', '--KeepWs' );

        #

        #   $logInfo->{'target'} is the branch the workspace was on - before the switch

        #   use merge --reintegrate ^/<target> to merge the data into this workspace

        #

        #   Perform an interactive command so that the user can accept conflicts - if they want

        #

        Message ("Reintegrate Merge from " . $logInfo->{'target'} . " to " .  $logInfo->{'copyfrom-path'} );

        my $rv = SvnUserCmd( 'merge', '--reintegrate',

                @mergeOpts,

                '^' . $logInfo->{'target'},

                '.',

                { 'credentials' => 1 });

        Error ("Merge error", "Workspace has been switched to $logInfo->{'copyfrom-path'}", "Its state is unknown.") if $rv;

        unless ($opt_dryRun) {

            #

            #   The merge appears to be good

            #   Delete the branch we merged from. Svn Red Book says that it can't be reused ( without a bit more work )

            #

            Message("Deleting feature branch: $logInfo->{'target'}");

            $rv = $uref->SvnDelete (

                              'target'      => '^' . $logInfo->{'target'},

                              'comment'   => [$uref->Path().": Delete Branch",'Deleted by user command: jats svn reintegrate as the branch is no longer usable'],

                              'noerror'   => 1,

                              );

            if ($rv) {

                Error ('SvnReintegrate: Branch not deleted');

            }

            Message("Reintegration Merge complete",

                     "The branch has been deleted: svn $logInfo->{'target'}",

                     "The workspace has been switched to: $logInfo->{'copyfrom-path'}",

                     "The workspace needs to be verified and committed."

                     );

            }

        else

        {

            Message("Dry Run of the integration merge is complete",

                   "Quietly switching back to $logInfo->{'target'}");

            $uref->SvnSwitch ( '^' . $logInfo->{'target'}, '.', '--NoPrint', '--KeepWs' );

        }

        exit 0;

    }

    $opr_done = 1;

}

#-------------------------------------------------------------------------------

# Function        : mustBeWsRoot 

#

# Description     : Ensure that the user is not in a subdirectory of a workspace 

#

# Inputs          : $uref   - A Svn session handle

#

# Returns         : Will not return on error

#                   Return the workspace root as provided by SvnLocateWsRoot

#

sub mustBeWsRoot

{

    my ($uref) = @_;

    my $ws_root = $uref->SvnLocateWsRoot(0);

    my $pathToRoot = RelPath($ws_root);

    if ( $pathToRoot =~ m~^..~) {

        Error("This command cannot be executed within a subdirectory of the workspace",

                "It can be executed in the root of the workspace: $pathToRoot",

                "It can be executed externally with the -path option");

    }

    return $ws_root;

}

#-------------------------------------------------------------------------------

    merge                  - Merge head into a feature branch

    reintegrate            - Integrate a feature branch to its head

=head1 Sync Merge

=head2 NAME

Perform a Feature Branch Sync Merge

=head2 SYNOPSIS

jats svn merge [options]

 Options:

    -help[=n]              - Help message, [n=1,2,3]

    -man                   - Full documentation [-help=3]

    -verbose[=n]           - Verbose command operation

    -info                  - Displays merge info only

    -dry-run               - Perform a dry run of the merge

    -path=path             - Target workspace

    ...                    - Other options are passed to the merge

=head2 ARGUMENTS

The command takes no arguments, just options.

=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<-info>

This option will display information about the proposed merge, but it will not do the merge.

This is not the same as a '-dry-run' as it shows information that the command has recovered from

the workspace.

=item B<-dry-run>

This option will perform a dry run of the actual merge. It will not modify the workspace.

=item B<...>

Options that are not processed by this command will be passed through to the underlying

'svn merge' command. Available options include:

=over 8

=item * --accept=mf (mine-full)

=item * --accept=mc (mine-conflict)

=back

=back

=head2 DESCRIPTION

This command implements the common operation of merging the release branch 

head (normally trunk) onto a private development branch in the current working copy. 

The main goal of this command is to avoid situations where developers accidentally merge 

from the wrong branch, or end up with (to them) inexplicable merge failures and thus 

lose confidence in Subversion. 

It will fail if the current working copy is actually on the trunk, and not a branch.

=head1 Reintegrate Merge

=head2 NAME

Reintegrate a Feature Branch

=head2 SYNOPSIS

jats svn reintegrate [options]

 Options:

    -help[=n]              - Help message, [n=1,2,3]

    -man                   - Full documentation [-help=3]

    -verbose[=n]           - Verbose command operation

    -path=path             - Target workspace

    -info                  - Displays merge info only

    -dry-run               - Perform a dry run of the merge

    -reintegrate           - Option to ensure user is aware of the action

    ...                    - Other options are passed to the merge

=head2 ARGUMENTS

The command takes no arguments, just options.

=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<-info>

This option will display information about the proposed merge, but it will not do the merge.

This is not the same as a '--dry-run' as it shows information that the command has recovered from

the workspace.

=item B<-dry-run>

This option will perform a dry run of the actual merge. It will NOT deleted the feature branch. It will

switch the workspace and after the dry run of the merge it will switch it back.

This option implies '-reintegrate'.

=item B<-reintegrate>

This option will cause the utility to perform the merge. Without it the utility will provide

some sanity checking, but will not switch the workspace nor delete the feature branch.

By using this option the user acknowledges that the are aware of the changes that will be made.

=item B<...>

Options that are not processed by this command will be passed through to the underlying

'svn merge' command. Available options include:

=over 8

=item * --accept=mf (mine-full)

=item * --accept=mc (mine-conflict)

=back

=head2 DESCRIPTION

This command implements the common operation of merging a private branch back into the main

development branch (normally the trunk).

The main goal of this command is to avoid situations where developers accidentally merge 

from the wrong branch, or end up with (to them) inexplicable merge failures and thus 

lose confidence in Subversion. 

It will fail if the current working copy is actually on the trunk, and not a branch

The command will do the following operations:

=over 8

=item * 

Ensure that the path address a subversion workspace and that the user is not in a sundirectory

of the workspace.

=item * 

Ensure the workspace is a branch. This command assumes that the workspace contains the feature branch.

=item * 

Ensure the workspace contains no modified files

=item * 

Switch to the branches parent, which may not be the trunk.

=item * 

Perform the reintegration merge

=item * 

Delete the branch, in subversion. Once an reintegration merge has been performed the branch 

can no longer be used. It's not able to correctly absorb new trunk changes, nor can it be properly 

reintegrated to trunk again. The user may create another branch with the same name, if required.

=back

At the end of the reintegration merge the workspace will be associated with the parent of the branch, which may be called 'trunk'.

The workspace will contain modified files. It is up to the user to verify that the merge has had the desired result and to commit the

changes. It is not recommended that development occur in the workspace. A new branch should be created for further development.