Subversion Repositories DevTools

Rev

Rev 6276 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
267 dpurdie 1
########################################################################
6177 dpurdie 2
# COPYRIGHT - VIX IP PTY LTD ("VIX"). ALL RIGHTS RESERVED.
267 dpurdie 3
#
4
# Module name   : jats_svnrelease.pl
5
# Module type   : Jats Utility
6
# Compiler(s)   : Perl
7
# Environment(s): Jats
8
#
9
# Description   : A script to build a package from a SubVersion
10
#                 The script will:
11
#                   Create a workspace
12
#                   Checkout the files
13
#                   Locate the build file
14
#                   Build the packages
15
#                   Install packages
16
#                   Remove the view
17
#
18
#               The script can do a lot of other things too.
19
#
2764 dpurdie 20
#               Defined exit code for automation
21
#                   10 - No files in extracted view
22
#                        Root directory not found
23
#                   11 - Label not found
24
#                   1  - Everything else
25
#
267 dpurdie 26
# Notes         : A lot of this code is common to jats_ccrelease.pl
27
#                 Will need to refactor if both are to be used
28
#
29
#......................................................................#
30
 
31
require 5.006_001;
32
use strict;
33
use warnings;
34
use JatsError;
35
use JatsSystem;
36
use FileUtils;
37
use JatsBuildFiles;
38
use ArrayHashUtils;
39
use JatsSvn;
40
 
41
use Pod::Usage;                             # required for help support
42
use Getopt::Long;
43
use File::Find;
44
use File::Copy;
45
use File::Path;
46
use Cwd;
47
 
48
my $VERSION = "1.0.0";                      # Update this
49
 
50
#
51
#   Options
52
#
53
my $opt_debug   = $ENV{'GBE_DEBUG'};        # Allow global debug
54
my $opt_verbose = $ENV{'GBE_VERBOSE'};      # Allow global verbose
55
my $opt_help = 0;                           # User help level
56
my @opt_spec;                               # Labels used as a base for the view
57
my $opt_dpkg = 1;                           # Transfer built package to dpkg_archive
58
my $opt_copy = 0;                           # Copy built package to user
59
my $opt_reuse = 0;                          # Re-user view if it exists
60
my $opt_viewname;                           # View Name
1403 dpurdie 61
my $opt_extract = 0;                        # Just create a static view
267 dpurdie 62
my $opt_extract_files;                      # Just extract files to user - no view
1403 dpurdie 63
my $opt_devModeStr;                         # Development mode string
64
my $opt_devMode = '';                       # Development mode (cleaned up)
267 dpurdie 65
my $opt_delete = 0;                         # Just delete the view. 2 to force
66
my @opt_build;                              # build files to use (kludge)
67
my $opt_test;                               # Test the build process - no copy
68
my $opt_cache;                              # Cache external packages
69
my $opt_keep = 0;                           # Keep view if successful
70
my $opt_beta;                               # Create beta release
71
my $opt_merge;                              # Merge release
72
my $opt_path;                               # Path for view spec
73
my $opt_runtests = 1;                       # Run unit tests after build
74
my $opt_branch;                             # Create config spec with branch
2040 dpurdie 75
my $opt_mkbranch;                           # Create branch
267 dpurdie 76
my $opt_debug_build = 0;                    # Build Debug Only
77
my $opt_prod_build = 0;                     # Build ion Only
78
my $opt_view_root = $ENV{'GBE_VIEWBASE'};   # Root of the view
79
my $opt_prefix = 1;                         # Prefix the view tag with user-name
351 dpurdie 80
my $opt_tag;                                # View tag insert (build or export or user)
341 dpurdie 81
my $bad_label_name = 0;                     # Badly formed label
2429 dpurdie 82
my $opt_escrow = 0;                         # Escrow Mode
267 dpurdie 83
 
84
#
85
#   Globals - Provided by the JATS environment
86
#
87
my $USER            = $ENV{'USER'};
88
my $UNIX            = $ENV{'GBE_UNIX'};
89
my $GBE_SANDBOX     = $ENV{'GBE_SANDBOX'};
90
my $GBE_ABT         = $ENV{'GBE_ABT'} || '0';
279 dpurdie 91
my $MACHINENAME     = $ENV{'GBE_HOSTNAME'};
343 dpurdie 92
my $GBE_VIEWBASE    = $ENV{'GBE_VIEWBASE'};   # Root of the view
267 dpurdie 93
 
94
#
95
#   Globals
96
#
343 dpurdie 97
my $VIEWDIR_ROOT;                           # Root of the static view
267 dpurdie 98
my $VIEWDIR;                                # Absolute path to the view
99
my $VIEWPATH;                               # Path relative to clearcase
1403 dpurdie 100
my $view_prefix     = "${USER}_";           # Default WorkSpace prefix
101
my $user_cwd;                               # Initial User Directory
102
my $error = 0;                              # Build Error Flag/Counter
267 dpurdie 103
my $label_count = 0;                        # Number of labels to create the view
104
my @label_not_pegged;                       # List of unpegged labels
1403 dpurdie 105
my @messageText;                            # Messages to be displayed AFTER extraction
106
my $workSpace;                              # Path to created workspace (or extact)
107
my $svnSession;                             # Primary Subversion Session
108
my $noReleaseWs = 0;                        # Do not officially release from this
109
my $checkDelta = 1;                         # Check Diffs between Tag and Head
110
                                            #   0 - Don't do anything
111
                                            #   1 - Warn about diffs
112
                                            #   2 - Error if diffs
113
my $traceBack = 2;                          # Trace Back error control. As above
2764 dpurdie 114
my $needDevBranch = 1;                      # DevBranch error control. As above
267 dpurdie 115
 
1403 dpurdie 116
#
117
#   Data about the package-version
118
#
119
my $srcPathPkg;                             # Root of the package
120
my $devBranch;                              # Development Branch - within the package
121
my $devBranchPeg;                           # May be pegged
122
my $devBranchHead;                          # Revision of the HEAD of the development branch
123
my $tagLabel;                               # Label in 'tags'
124
my $tagPeg;                                 # May be pegged
125
my $tagLabelBranch;                         # Tagged from this branch: Discovered
126
my $tagLabelBranchPeg;                      # Tagged from this branch at this peg: Discovered
127
my $ttbType;                                # trunk, tags or branches
128
my $urlType;                                # 'jats' or 'url'
129
my $initialUrl;                             # Initial URL of target
267 dpurdie 130
 
131
#-------------------------------------------------------------------------------
132
# Function        : Mainline Entry Point
133
#
1403 dpurdie 134
# Description     : Main entry point
267 dpurdie 135
#
1403 dpurdie 136
# Inputs          : ARGV[]      - See documentation below
267 dpurdie 137
#
138
 
139
#
140
#   Alter some option defaults if we are creating a view within a sandbox
141
#
142
if ( $GBE_SANDBOX )
143
{
343 dpurdie 144
   $GBE_VIEWBASE = $GBE_SANDBOX;
267 dpurdie 145
   $opt_prefix = 0;
146
}
147
 
148
#
149
#   Parse the user options
150
#
151
my $result = GetOptions (
1403 dpurdie 152
                'help:+'        => \$opt_help,                  # flag, multiple use allowed
153
                'manual:3'      => \$opt_help,                  # flag
154
                'v|verbose:+'   => \$opt_verbose,               # flag, multiple use allowed
155
                'label=s'       => \@opt_spec,                  # Array of build specs
156
                'view=s'        => \$opt_viewname,              # String
157
                'dpkg!'         => \$opt_dpkg,                  # [no]flag
158
                'copy!'         => \$opt_copy,                  # [no]flag
159
                'reuse!'        => \$opt_reuse,                 # [no]flag
160
                'extract:+'     => \$opt_extract,               # flag
161
                'extractfiles'  => \$opt_extract_files,         # flag
162
                'delete:+'      => \$opt_delete,                # flag
163
                'build=s'       => \@opt_build,                 # An array of build
164
                'test!'         => \$opt_test,                  # [no]flag
165
                'cache'         => \$opt_cache,                 # flag
166
                'keep!'         => \$opt_keep,                  # [no]flag
167
                'beta!'         => \$opt_beta,                  # [no]flag
168
                'merge'         => \$opt_merge,                 # [no]flag
169
                'path=s'        => \$opt_path,                  # string
170
                'runtests!'     => \$opt_runtests,              # [no]flag
171
                'branch=s'      => \$opt_branch,                # String
2040 dpurdie 172
                'mkbranch=s'    => \$opt_mkbranch,              # String
1403 dpurdie 173
                'prodOnly'      => \$opt_prod_build,            # flag
174
                'debugOnly'     => \$opt_debug_build,           # flag
175
                'root=s'        => \$GBE_VIEWBASE,              # string
176
                'prefix!'       => \$opt_prefix,                # flag
177
                'tag=s'         => \$opt_tag,                   # string
178
                'devMode=s'     => \$opt_devModeStr,            # string
267 dpurdie 179
                );
180
 
181
                #
182
                #   UPDATE THE DOCUMENTATION AT THE END OF THIS FILE !!!
183
                #
184
 
185
#
186
#   Process help and manual options
187
#
188
pod2usage(-verbose => 0, -message => "Version: $VERSION")  if ($opt_help == 1  || ! $result);
189
pod2usage(-verbose => 1)  if ($opt_help == 2 );
190
pod2usage(-verbose => 2)  if ($opt_help > 2 );
191
 
192
InitFileUtils();
193
#
194
#   Configure the error reporting process now that we have the user options
195
#
196
ErrorConfig( 'name'    => 'SVNRELEASE',
197
             'verbose' => $opt_verbose );
198
 
199
#
200
#   Validate user options
201
#   Use either -label or one command line argument
202
#
1403 dpurdie 203
Error ("Cannot mix -extractfiles and -branch")
204
    if ( $opt_branch && $opt_extract_files );
267 dpurdie 205
Error ("Unexpected command line arguments present.","Cannot mix -label and command line label" )
206
    if ( $#opt_spec >= 0 && $#ARGV >= 0);
2040 dpurdie 207
Error ("Cannot specify both '-mkbranch' and '-branch'")
208
    if ( $opt_mkbranch && $opt_branch );
267 dpurdie 209
 
210
push @opt_spec, @ARGV;
211
 
212
unless(  @opt_spec  )
213
{
1403 dpurdie 214
    Error ("Need a workspace or a label. -help for options") if ( $opt_delete  && ! $opt_viewname );
215
    Error ("Need a Subversion Reference or URL. -help for options") unless $opt_delete;
267 dpurdie 216
}
217
 
2040 dpurdie 218
#
219
#   Set up branching values
3045 dpurdie 220
#       mkbranch    - Create if not exists. Error if it exists
2040 dpurdie 221
#       branch      - Error if not exists
222
#
223
if ( $opt_mkbranch ) {
224
    $opt_branch = $opt_mkbranch;
225
    $opt_mkbranch = 1;
226
}
227
$opt_branch = SvnIsaSimpleLabel($opt_branch) if ( $opt_branch );
228
 
1403 dpurdie 229
#   Determine extraction mode
230
#       Working- Default
231
#               Extract point on development branch were tag was taken
232
#               Update build files
233
#               Warn about files that have changed
267 dpurdie 234
#
1403 dpurdie 235
#       Tag   - Extract point on development branch were tag was taken
236
#               Update build files
237
#               Error if tag is not the tip
267 dpurdie 238
#
1403 dpurdie 239
#       Tip   - Extact tip of the development branch
240
#               Warn about files that have changed between head and tagPoint
241
#
242
#       Exact - What the user specified
243
#               May be a tag and thus not usable
244
#
245
if ( $opt_devModeStr )
267 dpurdie 246
{
1403 dpurdie 247
    if ( $opt_devModeStr =~ m/^(Tip)|(BranchTip)$/i) {
248
        $opt_devMode = 'tip';
249
        $checkDelta = 1;
250
        $noReleaseWs = 1;
2764 dpurdie 251
        $needDevBranch = 2;
1403 dpurdie 252
    } elsif ( $opt_devModeStr =~ m/^(Tag)|(TagPoint)$/i) {
253
        $opt_devMode = 'tag';
254
        $checkDelta = 2;
255
        $checkDelta = 1 if ( $opt_branch );
256
        $noReleaseWs = 0;
2764 dpurdie 257
        $needDevBranch = 2 unless ( $opt_branch );;
1403 dpurdie 258
    } elsif ( $opt_devModeStr =~ m/^(Work)|(Working)$/i) {
259
        $opt_devMode = '';
260
        $checkDelta = 1;
261
        $noReleaseWs = 0;
262
    } elsif ( $opt_devModeStr =~ m/^Exact$/i) {
263
        $opt_devMode = 'exact';
264
        $checkDelta = 1;
265
        $noReleaseWs = 0;
2040 dpurdie 266
        Error ('Cannot mix -[mk]branch and -devMode=' . $opt_devModeStr ) if ( $opt_branch );
1403 dpurdie 267
    } elsif ( $opt_devModeStr =~ m/^escrow$/i) {
268
        # JATS internal use only. Not advertised
269
        $opt_devMode = 'exact';
2429 dpurdie 270
        $opt_escrow = 1;
1403 dpurdie 271
        $checkDelta = 0;
272
        $noReleaseWs = 0;
273
        $traceBack = 1;
2040 dpurdie 274
        Error ('Cannot mix -[mk]branch and -devMode=' . $opt_devModeStr ) if ( $opt_branch );
1403 dpurdie 275
    } else {
276
        Error ("Unknown development mode: $opt_devModeStr");
277
    }
267 dpurdie 278
}
279
 
280
#
1403 dpurdie 281
#   The buildtool works in a known environment
282
#
283
if ( $GBE_ABT )
284
{
285
    $noReleaseWs = 0;       # Can always release
286
    $checkDelta = 0;        # Do not care. Often expected to have changes.
287
    $traceBack = 2;         # Must check traceback. Validate RM data
288
}
289
 
290
#
267 dpurdie 291
#   Limit the user to ONE label/tag/
292
#   Reason: Under Subversion its not possible to 'pinch' files from another
293
#           package. Don't need to create a workspace with multiple labels
294
#
295
#           It was a bad practice under clearcase
296
#
297
if ( $#opt_spec >= 1 )
298
{
299
    Error ("Multiple labels not supported",
300
           "Use one label to describe a package" );
301
}
1403 dpurdie 302
parseSubversionRef($opt_spec[0]);
303
Error ("INTERNAL: initialUrl not set") unless ( $initialUrl );
304
Error ("Cannot interprete the URL or Subversion Reference: $opt_spec[0]") unless ( $srcPathPkg  );
267 dpurdie 305
 
306
#
307
#   User has specified both debug and production
308
#   Then set both to 0 : ie default
309
#
310
if ( $opt_debug_build + $opt_prod_build > 1 )
311
{
312
    $opt_debug_build = 0;
313
    $opt_prod_build = 0;
314
}
315
 
316
#
317
#   User has requested test mode
318
#       - Don't copy
1403 dpurdie 319
#       - Don't package
267 dpurdie 320
#
321
if ( $opt_test )
322
{
323
    $opt_dpkg = 0;
324
    $opt_copy = 0;
325
}
326
 
327
#
328
#   Determine the machine type
329
#
330
Verbose ("Machine Type: UNIX=$UNIX");
331
 
332
Error ("Machine Name not determined")
333
    unless ( $MACHINENAME );
334
$user_cwd = getcwd;
335
 
336
Error ("USER name not determined" )
337
    unless ( $USER );
338
 
339
#
343 dpurdie 340
#   Clean up the view root directory
267 dpurdie 341
#
343 dpurdie 342
$VIEWDIR_ROOT = Realpath($GBE_VIEWBASE) || $GBE_VIEWBASE;
267 dpurdie 343
 
344
Verbose ("Viewpath: $VIEWDIR_ROOT");
345
Error ("Cannot locate view root directory: $VIEWDIR_ROOT" ) unless (-d $VIEWDIR_ROOT);
346
 
347
#
348
#   Remove any user name from the front of the view name
349
#   Simplifies the deletion process as the user can provide
350
#   the directory name
351
#
1403 dpurdie 352
$view_prefix = '' unless ( $opt_prefix );
267 dpurdie 353
 
354
#
355
#   Create a class to describe the complete SVN label
1403 dpurdie 356
#   This will parse the label and create a number of nice elements that will
357
#   be used in determing the name of the workspace
267 dpurdie 358
#
1403 dpurdie 359
$svnSession = NewSessionByUrl ( $initialUrl, 1 );
360
#DebugDumpData("New Session", $svnSession );
267 dpurdie 361
 
362
#
1403 dpurdie 363
#   Test for a pegged label
364
#
365
push @label_not_pegged, $svnSession->Full
366
    unless ( $svnSession->Peg );
367
 
368
#
267 dpurdie 369
#   Setup user specified workspace
370
#   Include the user name to ensure that the view name is unique-ish
371
#   Keep the name as short as possible as some compilers display a fixed
372
#   length filename in error messages and this name is part of the path
373
#
374
#   Base the viewname on the view label. This will simplify the creation
375
#   of multiple views and reduce the risk of unexpected deletion
376
#
1456 dpurdie 377
$opt_viewname = calcViewName();
267 dpurdie 378
$opt_viewname =~ s~^$view_prefix~~ if (defined($opt_viewname) && $view_prefix && $opt_delete );
379
 
380
#
381
#   Create a clearcase view to be used for the view
382
#
383
$VIEWPATH = "$view_prefix$opt_viewname";
384
$VIEWDIR = "$VIEWDIR_ROOT/$VIEWPATH";
299 dpurdie 385
$VIEWDIR =~ tr~\\/~/~s;
267 dpurdie 386
Verbose( "Hostname: $MACHINENAME" );
387
Verbose( "Viewpath: $VIEWPATH" );
388
Verbose( "Viewdir : $VIEWDIR" );
389
 
390
#
391
#   If the user has specified a "source path", then we must ensure that it is
392
#   valid. It will be used to create the WorkSpace
393
#
394
#   Ensure that the path is a defined variable. If used prepend a / to simplify
395
#   concatenation.
396
#
397
Verbose("Validate Source Path");
398
if ( $opt_path )
399
{
400
    $opt_path =~ tr~\\/~/~s;
401
    $opt_path =~ s~/$~~;
402
    $opt_path =~ s~^/~~;
403
 
404
    Error( "Source Path has drive specifier" ) if ( $opt_path =~ m~^[A-Za-z]\:~ );
405
    $opt_path = '/'.$opt_path ;
406
}
407
else
408
{
409
    $opt_path = '';
410
}
1403 dpurdie 411
$workSpace = $VIEWDIR . $opt_path;
412
Verbose( "workSpace : $workSpace" );
267 dpurdie 413
 
414
#
2040 dpurdie 415
#   Operation
416
#   If all we are doing is deleting the view then do it now
417
#   If we are going to extract stuff, then we will delay the deletion
418
#   as long as possible - incase we decide we can't
267 dpurdie 419
#
2040 dpurdie 420
if ( $opt_delete )
421
{
422
    delete_view()
423
        unless ( $opt_reuse );
424
    exit 0;
425
}
267 dpurdie 426
 
427
#
1403 dpurdie 428
#   Ensure that the label is present within the specified Repository
267 dpurdie 429
#
430
Verbose("Ensure Labels can be found in a Repository");
1403 dpurdie 431
Verbose ("Testing label: ". $svnSession->Full );
267 dpurdie 432
$label_count++;
433
 
2764 dpurdie 434
unless ( $svnSession->SvnValidateTarget (
267 dpurdie 435
                    'cmd'    => 'SvnRelease',
1403 dpurdie 436
                    'target' => $svnSession->Full,
2764 dpurdie 437
                    'test' => 1,
438
                    )
439
        )
440
{
441
    Error ('ExitCode=11', "SvnRelease: Tag/Reference not found in repository", "Reference: " . $svnSession->Full)
442
}
1403 dpurdie 443
 
267 dpurdie 444
#
1403 dpurdie 445
#   If the user did not provide a peg then examine
446
#   the 'tag' in the repo and determine when it was created
447
#   This will not work to well if the user is allowed to move the tag
267 dpurdie 448
#
1403 dpurdie 449
unless ( $svnSession->Peg() )
450
{
451
    $svnSession->SvnInfo( $svnSession->Full, 'InfoRepo' );
452
    my $peg = $svnSession->{'InfoRepo'}{'Last Changed Rev'};
267 dpurdie 453
 
1403 dpurdie 454
    $svnSession->{'PEG'} = '@' . $peg;
455
    if ( $tagLabel ) {
456
        $tagPeg = $peg;
457
    } elsif ( $devBranch ) {
458
        $devBranchPeg = $peg;
459
    }
460
}
461
#debugDumpRefInfo('Get Peg');
462
 
267 dpurdie 463
#
1403 dpurdie 464
#   Trace back from the tag to the point at which it was copied
465
#   This should be the same as the user provided development branch
466
#   but it may not be the same if the user is changing the branch
467
#
468
if ( $tagLabel && $traceBack )
469
{
470
    my $btData;
471
    my $labelBranch = $svnSession->backTrackSvnLabel(
472
                            join ('@', $tagLabel, $tagPeg)
473
                          , 'data' => \$btData
474
                          , 'onlysimple' => 0,
475
                          , 'printdata' => 0 );
476
    $svnSession->{SavedBackTrack} = $btData;
477
    unless ( $btData->{isaBranch} )
478
    {
2764 dpurdie 479
        my $text = "Cannot trace package label back to a development branch";
480
        Error ($text) if ( $needDevBranch == 2 );
481
        Warning ($text);
1403 dpurdie 482
    }
483
    else
484
    {
485
        Error ("INTERNAL: Cannot parse result of backTrackSvnLabel: $labelBranch")
486
            unless ($btData->{devBranch} =~ m~^(.*)@(\d+)$~);
487
        $tagLabelBranch = $1;
488
        $tagLabelBranchPeg = $2;
489
 
490
        #
491
        #   Verify that the Development Branch matches that provided by the user
492
        #
493
        if ( $devBranch && ($devBranch ne $tagLabelBranch) )
494
        {
495
            # If the user is creating a branch, then allow this mismatch
496
            #
497
            unless ( $opt_branch && ($devBranch =~ m~/$opt_branch$~) )
498
            {
499
                my @msgText;
500
                push ( @msgText,
501
                        "The package Tag was not taken from the development branch",
502
                        "Development Branch: $devBranch\@$tagPeg",
503
                        "Tag traced back to: $tagLabelBranch\@$tagLabelBranchPeg" );
504
                if ( $traceBack == 1) {
505
                    push @messageText, @msgText;
506
                } else {
507
                    Error ( @msgText );
508
                }
509
            }
510
        }
511
        $devBranchPeg = $tagLabelBranchPeg unless ( $devBranchPeg );
512
 
513
        #   Ensure that the TAG has not been modified since it was taken
514
        #   The extraction algorithm assumes that the tag directory is
515
        #   immutable.
516
        #
517
        #   The build daemon will actually modify the build file during
518
        #   a ripple - this is catered for.
519
        #
520
        #   If other files have been modifed then it should be an error
521
        #
522
        if ( $btData->{changeSets} > 1 )
523
        {
524
            Error ("Tag has been modified since created") if ( $GBE_ABT );
525
            Warning ("Tag has been modified since created");
526
            $noReleaseWs = 1;
527
        }
528
    }
529
}
530
#debugDumpRefInfo('BackTrack Label');
531
 
532
#
533
#   Examine the HEAD of the development branch and determine if there
534
#   have been any changes since the tag was taken
535
#
536
determineChangedFiles();
537
 
538
################################################################################
539
#   Create a workspace based on the tag
540
#   It will be back tracked to the branch that was tagged:
541
#       - Ripple build tags look better in version tree
542
#       - User can develop in the workspace as its not linked to an immutable 'tags'
543
#
544
#   So far we have:
545
#       $initialUrl         - Url to the version that the user specified
546
#       $initialUrlBranch   - Url to the branch from which the initialUrl was taken
547
#                             Iff based on a Tag
548
#       $urlDevBranchHead   - Head of the Development Branch
549
#
550
 
551
$initialUrl = substr( $initialUrl, 1 + length($srcPathPkg));
552
 
553
my $initialUrlBranch;
554
if ( $tagLabelBranch )
555
{
556
    $initialUrlBranch  = $tagLabelBranch;
557
    $initialUrlBranch .= '@' . $tagLabelBranchPeg;
558
}
559
 
560
my $urlDevBranchHead;
561
if ( $devBranch )
562
{
563
    $urlDevBranchHead  = $devBranch;
564
}
565
else
566
{
567
    $urlDevBranchHead  = $tagLabelBranch;
568
}
569
 
570
#
571
#   Debug information
572
#
573
if ( IsVerbose(1) ) {
574
    debugDumpRefInfo('Creating workspaces');
575
    Verbose ('------------');
576
    Verbose ("initialUrl       :", $initialUrl);
577
    Verbose ("initialUrlBranch :", $initialUrlBranch );
578
    Verbose ("urlDevBranchHead :", $urlDevBranchHead );
579
    Verbose ("opt_viewname     :", $opt_viewname );
580
#    DebugDumpData("svn_label", $svnSession );
581
}
582
 
583
#
267 dpurdie 584
#   If we are only extracting files then ...
585
#
586
if ( $opt_extract_files )
587
{
1403 dpurdie 588
    Warning(@messageText );
267 dpurdie 589
    extract_files_from_view();
590
    exit (0);
591
}
592
 
593
#
594
#   Create a new workspace
1403 dpurdie 595
#       This is not done if the user is reusing an existing workspace
596
#       AND the existing workspace exists.
267 dpurdie 597
#
598
if (! -d $VIEWDIR || ! $opt_reuse )
599
{
1403 dpurdie 600
    Message( "Create the workspace" . ($GBE_SANDBOX ? " in a SANDBOX" : ''));
267 dpurdie 601
 
1403 dpurdie 602
    my $branch;
603
    my $view_tag;
604
    my $update_tagsChanges;
605
    if ( $opt_devMode eq 'tip' ) {
606
        $view_tag =  $urlDevBranchHead;
607
    } elsif ( $opt_devMode eq 'exact' ) {
608
        $view_tag =  $initialUrl;
609
    } else {
610
        $view_tag = $initialUrlBranch || $initialUrl;
611
        $update_tagsChanges = 1;
612
    }
613
    Message ("Creating Workspace based on: $view_tag");
614
    $view_tag = $svnSession->FullPath() . '/' .$view_tag;
615
    Verbose("Creating Workspace:", $view_tag);
616
 
267 dpurdie 617
    #
1329 dpurdie 618
    #   If a branch is required ...
2040 dpurdie 619
    #   Two modes:
620
    #       mkbranch    - Ensure that the branch does not exist
621
    #                     Make a new one
622
    #       branch      - Ensure that the branch does exist
623
    #                     Use existing branch
1403 dpurdie 624
    #   Ensure that the branch is NOT in the Repository
267 dpurdie 625
    #
626
    if ( $opt_branch )
627
    {
1403 dpurdie 628
        $branch = $svnSession->BranchName($opt_branch, 'branches' );
629
        $svnSession->SvnValidateTarget (
630
                        'cmd'    => 'SvnRelease: Validate Branch',
1329 dpurdie 631
                        'target' => $branch,
2040 dpurdie 632
                        'require' =>   (! $opt_mkbranch),
633
                        'available' => (  $opt_mkbranch),
1329 dpurdie 634
                        );
2040 dpurdie 635
 
636
        #
3045 dpurdie 637
        #   If using an existing branch, then:
638
        #       Set up the name of the source
639
        #       Do NOT import tag changes - we will be extracting the HEAD of the branch
2040 dpurdie 640
        #
3045 dpurdie 641
        if ( ! $opt_mkbranch )
642
        {
643
            $view_tag = $branch;
644
            $update_tagsChanges = 0;
645
        }
267 dpurdie 646
    }
2040 dpurdie 647
 
1329 dpurdie 648
    #
2040 dpurdie 649
    #   Perform delayed delete of any existign view
3045 dpurdie 650
    #   The process has been delayed as much as possible - in case other tests fail
2040 dpurdie 651
    #
652
    delete_view();
653
 
654
    #
1329 dpurdie 655
    #   Create the workspace
656
    #
2429 dpurdie 657
    $svnSession->SvnCo ( $view_tag, $workSpace , 'escrow' => $opt_escrow );
267 dpurdie 658
    Error ("Cannot locate the created Workspace")
1403 dpurdie 659
        unless ( -d $workSpace);
660
    importTagChanges()
661
        if ($update_tagsChanges);
267 dpurdie 662
 
663
    #
1403 dpurdie 664
    #   If we need to create a branch then
665
    #       Copy the WS to URL
666
    #       Switch to new URL
667
    #   The bulk of the copy will be done on the server-side
668
    #   and not over the network. This is  good.
669
    #
2040 dpurdie 670
    if ( $opt_mkbranch )
1403 dpurdie 671
    {
672
        #
673
        #   Branch does not exist
674
        #   Create it be copying the base view
675
        #
676
        Message ("Creating branch: $opt_branch");
677
        my $branch_tag = $svnSession->SvnCopy (
678
                        'old' => $workSpace,
679
                        'new' => $branch,
5073 dpurdie 680
                        'comment' => 'Created by Jats SvnRelease branch request:' . $opt_mkbranch,
1403 dpurdie 681
                        'replace' => 0 );
682
 
683
        Verbose ("Switching to new branch: $opt_branch");
684
        $branch_tag = SvnPath2Url($branch_tag);
685
        $svnSession->SvnSwitch ($branch_tag,
686
                               $workSpace,
687
                               '--NoPrint' );
688
    }
689
 
690
    #
691
    #   Display messages AFTER the extraction text
692
    #   Will ensure that the user has a chance to see them
693
    #
694
    Warning(@messageText );
695
 
267 dpurdie 696
}
697
 
285 dpurdie 698
#   Place a tag-file in the user-specified source path
699
#   This will be used by the build-tool to locate the 'source-path' of the
700
#   view, primarily for determining metrics.
267 dpurdie 701
#
1403 dpurdie 702
#   Calculate where the dynamic view will be
285 dpurdie 703
#   This differ between UNIX/WINDOWS
704
#
351 dpurdie 705
if ( $GBE_ABT)
285 dpurdie 706
{
1403 dpurdie 707
    Message("Create Build tagfile");
708
    TouchFile ( "$workSpace/.jats.packageroot" )
709
        if ( -d $workSpace )
285 dpurdie 710
}
711
 
712
#
267 dpurdie 713
#   Locate the JATS build files within the populated view
714
#
1403 dpurdie 715
chdir ($VIEWDIR) or Error("Cannot chdir to $VIEWDIR");
267 dpurdie 716
Message( "Locating build files");
717
 
718
my $bscanner = BuildFileScanner( $VIEWDIR, 'build.pl', '--LocateAll' );
719
$bscanner->scan();
720
my @build_list = $bscanner->getInfo();
721
foreach my $be ( @build_list )
722
{
1403 dpurdie 723
    Message(DisplayPath ("Build file: $be->{dir} Name: $be->{file}"));
267 dpurdie 724
}
725
 
726
#
727
#   If we are extracting the view then we are done
728
#   Display useful information for the user
729
#
730
if ( $opt_extract )
731
{
732
    Message  DisplayPath "View in: $VIEWDIR";
733
    Warning ("No build files found" )   if ( $#build_list < 0 );
734
    Warning( "Multiple build files found" )if ( $#build_list > 0 );
735
    Message ("Not all labels are pegged") if ( @label_not_pegged  );
736
    Message ("All labels are pegged") unless ( @label_not_pegged  );
737
    Message ("Badly formed label name" ) if ( $bad_label_name );
1403 dpurdie 738
    Message ("Development Mode: $opt_devModeStr") if ( $opt_devModeStr );
267 dpurdie 739
    Message ("Development Sandbox") if ( $GBE_SANDBOX );
1403 dpurdie 740
    Message ("Cannot release from this workspace") if ($noReleaseWs);
267 dpurdie 741
 
742
    exit 0;
743
}
744
 
745
Error ("No build files found")  if ( $#build_list < 0 );
746
 
747
#
748
#   Determine the list of builds to perform
749
#   Ensure that the user-requested build files are present
750
#
751
#   The user specifies the build file, via the mangled package name
752
#   This is package_name . project extension (daf_utils.cr)
753
#
754
if ( $#opt_build  >= 0)
755
{
756
    Verbose( "Check and locate the build files");
757
    @build_list = ();
758
    foreach my $bentry ( @opt_build )
759
    {
760
        if ($bscanner->match( $bentry) )
761
        {
762
            UniquePush (\@build_list, $bscanner->getMatchList() );
763
            Verbose ("Found: $bentry");
764
        }
765
        else
766
        {
767
            Error ("Cannot locate requested build files for: $bentry")
768
        }
769
    }
770
}
771
 
772
#
773
#   Sanity test if we will transfer the generated package to dpkg_archive
774
#   There are some limits
775
#       1) Must have built from one label
776
#       2) That label must be locked
777
#       3) Only one build file
778
#       4) The view must not have been reused
779
#       5) The view has a branch rule
780
#       6) Cannot release from a sandbox
781
#
782
my @elist;
783
push @elist, "Package built from multiple labels" unless ( $label_count == 1 );
784
push @elist, "Package built from an unpegged label" if ( @label_not_pegged  );
785
push @elist, "Package built with multiple build files" if ( scalar @build_list > 1 );
786
push @elist, "Package from a reused view" if ( $opt_reuse && ! $opt_beta );
787
push @elist, "Package from a development sandbox" if ( $GBE_SANDBOX );
1403 dpurdie 788
push @elist, "Package from a development workspace" if ($noReleaseWs);
267 dpurdie 789
push @elist, "View contains a branch" if ( $opt_branch );
790
push @elist, "User has specified build files" if ( $#opt_build > 0 );
791
push @elist, "Badly formed label name" if ( $bad_label_name );
792
 
793
if ( @elist )
794
{
795
    Warning ("Cannot officially release the package.", @elist);
796
    Error ("Build terminated as it cannot be released") if ($opt_dpkg && ! $opt_beta);
797
}
798
Warning ("Beta Release") if $opt_beta;
799
 
800
#
801
#   Process each of the build files in the specified order
802
#
803
foreach my $be (@build_list)
804
{
805
 
806
    #
807
    #   We need to change to the build directory
808
    #   Moreover we need the local name of the build directory.
809
    #   Windows does not handle a UNC pathname to well (at all)
810
    #
811
    my $build_dir = $be->{dir};
812
    chdir ("$build_dir") or Error( "Cannot chdir to build directory: $build_dir");
813
 
814
    if ( $be->{file} =~ m/^build.pl$/ )
815
    {
816
        Message ("Using JATS: $build_dir");
817
        #
818
        #   Invoke JATS to build the package and make the package
819
        #
820
        my @build_args = qw(--expert --cache);
821
        push @build_args, '--cache' if $opt_cache;
822
 
823
        my $make_type = 'all';
824
        $make_type = 'all_prod'  if ( $opt_prod_build );
825
        $make_type = 'all_debug' if ( $opt_debug_build );
826
 
827
 
828
        JatsCmd('build', @build_args)               and Error("Package did not build");
829
        JatsCmd('make', $make_type, 'NODEPEND=1')   and Error("Package did not make");
830
        JatsCmd('install');
831
 
832
        if ( $opt_runtests )
833
        {
321 dpurdie 834
            JatsCmd('make', 'run_unit_tests')      and Error("Tests did not run correctly");
267 dpurdie 835
        }
836
    }
837
    else
838
    {
839
        #
840
        #   Ant build files
841
        #
842
        my $pname =  $be->{file};
843
        Message ("Using ANT: $build_dir, $pname");
844
        $pname =~ s~depends.xml$~.xml~;
845
        copy($be->{file}, "auto.xml");
846
        JatsCmd('-buildfile', $pname, 'ant', 'build')        and Error("Package did not build");
847
        JatsCmd('-buildfile', $pname, 'ant', 'make_package') and Error("Package did not make_package");
848
    }
849
}
850
 
851
#
852
#   Copy the generated packages
853
#       1) dpkg_archive
854
#       2) Users local directory
855
#
856
foreach my $be (@build_list)
857
{
858
    my $build_dir = $be->{dir};
859
    chdir ("$build_dir") or Error( "Cannot chdir to build directory: $build_dir");
860
    if ( $opt_dpkg )
861
    {
862
        Message ("Using: $build_dir");
279 dpurdie 863
        my @create_opts = "-o";
864
        push @create_opts ,"-m" if ( $opt_merge );
865
        JatsCmd('-here', 'create_dpkg', @create_opts, '-pname', $be->{name}, '-pversion', $be->{version}) and $error++;
267 dpurdie 866
    }
867
 
868
    if ( $opt_copy )
869
    {
870
        Message ("Copy package to $user_cwd");
871
        copy_directory( 'pkg', $user_cwd, '' );
872
    }
873
 
874
    #
875
    #   Test structure of the package
876
    #   Ensure that it has a descpkg file
877
    #   Validate the package name and version
878
    #   More important for ANT projects than JATS as JATS has a sanity test
879
    #
880
    if ( $opt_test )
881
    {
882
        JatsCmd('-here', 'create_dpkg', '-test', '-pname', $be->{name}, '-pversion', $be->{version}) and $error++;
883
    }
884
 
885
}
886
Error ("Package not transferred")
887
    if ( $error );
888
 
1403 dpurdie 889
chdir ($user_cwd) or Error( "Cannot chdir to $user_cwd");
267 dpurdie 890
 
891
#
892
#   Delete the view
893
#
894
if ( ! $opt_reuse && ! $error && ! $opt_keep )
895
{
896
    delete_view();
897
}
898
else
899
{
900
    Message( "View left in: $VIEWDIR" );
901
}
902
 
903
Message ("End program");
904
exit 0;
905
 
906
#-------------------------------------------------------------------------------
907
# Function        : delete_view
908
#
909
# Description     : Delete a view
910
#
911
# Inputs          : None
912
#                   $VIEWDIR - path of the view
913
#
914
# Returns         :
915
#
916
sub delete_view
917
{
918
    #
299 dpurdie 919
    #   Simple delete
267 dpurdie 920
    #
299 dpurdie 921
    if ( $opt_extract_files )
267 dpurdie 922
    {
299 dpurdie 923
        if ( -d $VIEWDIR )
924
        {
925
            Message("Remove extracted files: $VIEWDIR");
361 dpurdie 926
            RmDirTree( $VIEWDIR );
299 dpurdie 927
        }
928
    }
929
    else
930
    {
267 dpurdie 931
        #
1403 dpurdie 932
        #   If the view physically exists then attempt to physically remove it
267 dpurdie 933
        #
299 dpurdie 934
        if ( -d $VIEWDIR )
935
        {
936
            #
937
            #   Determine if there are any checked out files in the view
938
            #
939
            Message("Remove the view: $VIEWDIR");
940
            Verbose("Look for checked out files");
267 dpurdie 941
 
942
 
1403 dpurdie 943
            SvnRmView ('path'     => $workSpace,
944
                       'force'    => ($opt_delete > 1) || ($opt_extract > 1),
299 dpurdie 945
                       'modified' => [ 'local_dpkg_archive' ] );
946
        }
2040 dpurdie 947
        Warning ("View was not deleted. Will Delete view directory")
1403 dpurdie 948
            if ( -d $workSpace );
361 dpurdie 949
        RmDirTree( $VIEWDIR ) if $opt_path;
267 dpurdie 950
    }
299 dpurdie 951
 
267 dpurdie 952
    Error ("View was not deleted")
299 dpurdie 953
        if ( -d $VIEWDIR );
267 dpurdie 954
}
955
 
956
#-------------------------------------------------------------------------------
957
# Function        : copy_directory
958
#
959
# Description     : Copy a directory tree
960
#
961
# Inputs          : Source directory
962
#                   Target directory
963
#                   Strip
964
#
965
#                   Should be full pathnames
966
#
967
# Returns         :
968
#
969
my $copy_error;
970
my $copy_count;
971
sub copy_directory
972
{
973
    our ($src_dir, $dest_dir, $strip) = @_;
974
    our $slength = length ($strip);
975
 
976
    #
977
    #   Prevent File::Find from generating warnings
978
    #
979
    no warnings 'File::Find';
980
 
981
 
982
    #
983
    #   Helper routine to copy files
984
    #
985
    sub copy_file_wanted
986
    {
987
        #
988
        #   Do not copy directories
989
        #   Just make the directory entry. May result in empty directories
990
        #
991
        if ( -d $_ )
992
        {
993
            my $tdir = "$dest_dir/" . substr( $File::Find::dir, $slength);
994
            $tdir .= "/$_";
995
            File::Path::mkpath( $tdir )
996
                unless ( -d $tdir);
997
            return;
998
        }
999
 
1000
        #
1001
        #   When used to copy file from within a clearcase dynamic view the
1002
        #   files may not actually exist. This will generate an error later
1403 dpurdie 1003
        #   so check for existence of file file now.
267 dpurdie 1004
        #
1005
        return unless ( -e $_ );
1006
 
1007
        #
1008
        #   Have been chdir'ed to the source directory
1009
        #   when invoked
1010
        #
1011
        my $tdir = "$dest_dir/" . substr( $File::Find::dir, $slength);
1012
        my $tfile = "$tdir/$_";
1013
        my $sfile = "$File::Find::dir/$_";
1014
        Verbose ("Copy: $sfile -> $tfile");
1015
 
1016
        File::Path::mkpath( $tdir )
1017
            unless ( -d $tdir);
1018
 
1019
        unlink ( $tfile )
1020
            if ( -f $tfile );
1021
 
1022
        if( ! File::Copy::copy ( $_ , $tfile ) )
1023
        {
1024
            $copy_error++;
1025
            Message "Error copying $sfile";
1026
        }
1027
        else
1028
        {
1029
            my $perm = (stat $_)[2] & 07777;
1030
            chmod($perm, $tfile);
1031
 
1032
            $copy_count++;
1033
        }
1034
    }
1035
 
1036
    #
1037
    #   Locate all files to copy
1038
    #
1039
    $copy_error = 0;
1040
    $copy_count = 0;
1041
    File::Find::find ( \&copy_file_wanted, $src_dir );
1042
    return $copy_error;
1043
}
1044
 
1045
#-------------------------------------------------------------------------------
1046
# Function        : count_files
1047
#
1048
# Description     : Count files in a workspace
1049
#                   Ignore .svn stuff
1050
#
1051
# Inputs          : Source directory
1052
#
1053
# Returns         :
1054
#
1055
sub count_files
1056
{
1057
    my ($src_dir) = @_;
1058
 
1059
    #
1060
    #   Prevent File::Find from generating warnings
1061
    #
1062
    no warnings 'File::Find';
1063
 
1064
 
1065
    #
1066
    #   Helper routine to copy files
1067
    #
1068
    sub count_file_wanted
1069
    {
1070
        #
1071
        #   Do not count dirs, only files
1072
        #
1073
        return if ( -d $_ );
1074
        $copy_count++;
1075
    }
1076
 
1077
    #
1078
    #   Locate all files
1079
    #
1080
    $copy_count = 0;
1081
    File::Find::find ( \&count_file_wanted, $src_dir );
1082
}
1083
 
1084
 
1085
#-------------------------------------------------------------------------------
1086
# Function        : extract_files_from_view
1087
#
1088
# Description     : This function will
1403 dpurdie 1089
#                       Extract the files from the required source
1090
#                       This is a simple operation under subversion
267 dpurdie 1091
#
1092
#                   Its used in the creation of escrow directories
1093
#
1094
# Inputs          : None
1095
#                   All done via globals
1096
#
1097
# Returns         : 
1098
#
1099
sub extract_files_from_view
1100
{
1101
    #
1102
    #   Determine the target directory for the extracted files
1103
    #       Delete the output subdir
1104
    #       Create the config spec in that directory
1105
    #
1106
    Verbose("Extracting files into $VIEWDIR");
1107
    if ( -d $VIEWDIR )
1108
    {
1109
        Verbose "Delete Directory: $VIEWDIR\n";
361 dpurdie 1110
        RmDirTree( $VIEWDIR );
267 dpurdie 1111
    }
1112
 
1403 dpurdie 1113
    #
1114
    #   Determine URL to extract
1115
    #       work : Same as exact
1116
    #       exact: Use user provided tag
1117
    #              No need to backtrack to the branch and then
1118
    #              Update files
1119
    #
1120
    #       tag:   Don't update build files
1121
    #              This is different normal mode
1122
    #              Perhaps should change to be the same as exact - just extract
1123
    #              the user provided tag
1124
    #
1125
    #       tip:   Don't update build files
1126
    #
1127
    my $view_tag;
1128
    if ( $opt_devMode eq 'tip' ) {
1129
        $view_tag =  $urlDevBranchHead;
1130
    } elsif ( $opt_devMode eq 'tag' ) {
1131
        $view_tag = $initialUrlBranch;
1132
    } else {
1133
        $view_tag = $initialUrl;
1134
    }
267 dpurdie 1135
 
1403 dpurdie 1136
    $svnSession->SvnCo ( $svnSession->FullPath() . '/' . $view_tag,
1137
                        $VIEWDIR,
1138
                        'export' => 1,
2429 dpurdie 1139
                        'escrow' => $opt_escrow,
6177 dpurdie 1140
                        'print'  => ($GBE_ABT ? 1 : 0) );
1403 dpurdie 1141
 
267 dpurdie 1142
    #
1143
    #   Count this files in the view
1403 dpurdie 1144
    #   Done so that its clear when we have a empty workspace in escrow extractions
267 dpurdie 1145
    #
1146
    Verbose ("Examine View contents");
1147
    count_files ( $VIEWDIR );
2764 dpurdie 1148
    Error ('ExitCode=10', DisplayPath("View files in: $VIEWDIR, but no files were extracted"))
1149
        unless ($copy_count);
267 dpurdie 1150
    Message ("View files in: $VIEWDIR, Files: $copy_count" );
1403 dpurdie 1151
}
267 dpurdie 1152
 
1403 dpurdie 1153
#-------------------------------------------------------------------------------
1154
# Function        : importTagChanges
1155
#
1156
# Description     : import changes from a 'tag' into the target workspace
1157
#                   Use with a workspace as well as an exported target
1158
#
1159
# Background      :
1160
#   The workspace has been created on the branch from which the tag was taken
1161
#   BUT this may not be the same as the tag because:
1162
#       1) Developer is not respecting the use of tags
1163
#       2) The automated build system will place the rippled build files
1164
#          within the tag.
1165
#   The most effective way that I have found of getting the modified build
1166
#   files into the workspace is to:
1167
#       Parse the log of the tag
1168
#       Determine files that have been modified as a part of the tag
1169
#       export them into the workspace
1170
#
1171
#   If we are creating a workspace that we are about to branch, then
1172
#   we use 'switch' to copy in the new file
1173
#   Otherwise, use a 'co -export'. If we use a switch, then the files
3045 dpurdie 1174
#   that have been switched in cannot be commited if changed as they will
1403 dpurdie 1175
#   be within the 'tags' area.
1176
#
1177
# Inputs          : None
1178
#                   Globals
1179
#
1180
# Returns         : Error code
1181
#
1182
sub importTagChanges
1183
{
1184
    return unless ( $tagLabel );
1185
    my $data = $svnSession->{SavedBackTrack};
1186
    Error ("Internal: importTagChanges expects backtracking to have been performed")
1187
        unless (defined $data);
1188
 
1189
#    DebugDumpData("importTagChanges", $svnSession );
1190
#    DebugDumpData("Data", $data );
1191
 
1192
    #
1193
    #   Process the data from the backtrack log and determine the files
1194
    #   that we need to transfer.
1195
    #       Should only be one - but if the users have been bad
1196
    #       then there may be more.
1197
    #
1198
    if ( $data->{files} )
1199
    {
6177 dpurdie 1200
        foreach my $item ( reverse @{$data->{files}} )
1403 dpurdie 1201
        {
6177 dpurdie 1202
            my ($srcFile, $action) = split( $;, $item);
1203
            Verbose("importTagChanges ($action): $srcFile");
1403 dpurdie 1204
            my $sfile = $svnSession->FullPath() . '/' . $srcFile;
1447 dpurdie 1205
 
1206
            #
2764 dpurdie 1207
            #   Calculate path within the repo of the target file
1447 dpurdie 1208
            #
2764 dpurdie 1209
            unless($srcFile =~ m~tags/.*?(/.*)@\d+~)
1210
            {
1211
                #
1212
                #   Only seen this error under a condition where the user
1213
                #   tagged a parent directory. ie:
1214
                #       aaa/bbbb/tags/badTag was a copy of aaa
1215
                #
1216
                Error ("importTagChanges. Unexpected format of filename: $srcFile",
1217
                       "Possible cause: Incorrect tag placement");
1218
            }
6177 dpurdie 1219
            my $rfile = $1;
1447 dpurdie 1220
            my $tfile = $workSpace . $1;
6177 dpurdie 1221
 
1222
            if ($action eq 'D')
1403 dpurdie 1223
            {
6177 dpurdie 1224
                # File was deleted
1225
                my $mode = '-';
1226
                if (-f $tfile) {
1227
                    unlink ( $tfile );
1228
                    $mode = ' ';
1229
                }
1230
                Information("Deleting  : D$mode   $VIEWPATH$rfile");
1403 dpurdie 1231
            }
1232
            else
1233
            {
6177 dpurdie 1234
                if ( $opt_mkbranch )
1235
                {
1236
                    $svnSession->SvnSwitch ($sfile, $tfile);
1237
                }
1238
                else
1239
                {
1240
                    $svnSession->SvnCo ($sfile, $tfile,
1241
                                            'export' => 1,
1242
                                            'force' => 1,
1243
                                            'escrow' => $opt_escrow,
1244
                                            'pretext' => 'Replacing ' );
1245
                }
1403 dpurdie 1246
            }
1247
        }
1248
    }
267 dpurdie 1249
}
1250
 
1251
#-------------------------------------------------------------------------------
1403 dpurdie 1252
# Function        : determineChangedFiles
1253
#
1254
# Description     : Display a list of files that have been changed between
1255
#                   the tagPoint and the head of the branch
1256
#
1257
# Inputs          : Only Globals
1258
#
1259
# Returns         : Will not return if changes are not allowed
1260
#
1261
sub determineChangedFiles
1262
{
1263
    my @msgText;
2040 dpurdie 1264
    my $onlyWarn = ($checkDelta == 1);
267 dpurdie 1265
 
1403 dpurdie 1266
    #
1267
    #   No checking required
1268
    #   Skip the hard bit if running on a build machine
1269
    #
1270
    return unless ( $checkDelta );
2764 dpurdie 1271
    return if ( $onlyWarn && ! $devBranch && ! $tagLabelBranch );
267 dpurdie 1272
 
1403 dpurdie 1273
    Debug ('determineChangedFiles');
1274
#debugDumpRefInfo('determineChangedFiles');
1275
 
1276
    #
1277
    #   Examine the HEAD of the development branch and determine if there
1278
    #   have been any changes since the tag was taken
1279
    #
1280
    #   Determine the Repo Revision for the HEAD of the devBranch
1281
    #
1282
    Error ("Internal: No devBranch calculated") unless ( $devBranch || $tagLabelBranch );
1283
 
1284
    my $basePeg = $tagLabelBranchPeg || $devBranchPeg;
1285
    my $baseBranch = $tagLabelBranch || $devBranch;
1286
    Error ("Internal logic. Expecting tagLabelBranchPeg or devBranchPeg to be defined") unless ( $basePeg );
1287
    Error ("Internal logic. Expecting tagLabelBranch or devBranch to be defined") unless ( $baseBranch );
1288
 
1289
    my $svn_check = NewSessionByUrl ( join( '/', $srcPathPkg, $baseBranch), 1 );
1290
    my $rv = $svn_check->SvnInfo( $svn_check->Full, 'InfoRepo' );
1291
    if ( $rv )
1292
    {
1293
        push (@msgText, "Cannot read information for the head of the development branch",
1294
                        "Branch may not exist: $baseBranch");
2040 dpurdie 1295
        $onlyWarn = 1;
1403 dpurdie 1296
    }
1297
    else
1298
    {
1299
        $devBranchHead = $svn_check->{'InfoRepo'}{'Last Changed Rev'};
1300
        Verbose2("devBranchHead: $devBranchHead");
1301
    #debugDumpRefInfo('Dev Branch Head');
1302
 
1303
 
1304
        #
1305
        #   If the Rev of the HEAD is greater than the point at which we
1306
        #   are interested then changes may have occured. Otherwise we know
1307
        #   that changes cannot have occured
1308
        #
1309
        if ( $devBranchHead <= $basePeg )
1310
        {
1311
            return;
1312
        }
1313
 
1314
        if ( $tagLabelBranchPeg )
1315
        {
1316
            push @msgText,  "Development Branch has changed since Tag was taken",
1317
                            "Head last changed in Rev: $devBranchHead",
1318
                            "Tag traced back to Rev  : $basePeg";
1319
        } else
1320
        {
1321
            push @msgText,  "Development Branch has changed since specified version",
1322
                            "Head last changed in Rev: $devBranchHead",
1323
                            "Specified branch Rev    : $basePeg";
1324
        }
1325
 
1326
 
1327
        my $diffBase = $svn_check->FullPath() . '/' . $baseBranch;
1328
        $svn_check->{tmp}{path_length} = length($diffBase);
1329
        $svn_check->{tmp}{count}  = 0;
1330
        @{$svn_check->{tmp}{files}}  = ();
1331
 
1332
        $rv = $svn_check->SvnCmd ( 'diff', '--summarize',
1333
                                   $diffBase,
1334
                                   '--revision', $basePeg . ':HEAD',
1335
                                   {
1336
                                        'process' => \&ProcessDiff,
1337
                                        'credentials' => 1,
1338
                                        'nosavedata' => 1,
1339
                                   }
1340
                                );
1341
        #
1342
        #   Prepare message to be displayed
1343
        #   Prepend text to the list of files
1344
        #
1345
 
1346
        $rv = $svn_check->{tmp}{count};
1347
        return unless ( $rv );
1348
        push (@msgText, "No files changed") unless ( $rv );
1349
        push (@msgText, "Changed file count: $rv") if ( $rv );
1350
        push (@msgText, "More than 10 files have changed. First 10 are:") if ( $rv > 10);
1351
        push (@msgText, @{$svn_check->{tmp}{files}} );
1352
    }
1353
 
2040 dpurdie 1354
    if ($onlyWarn) {
1403 dpurdie 1355
        push @messageText, @msgText;
1356
    } else {
1357
        Error ( @msgText );
1358
    }
1359
}
1360
 
1361
sub ProcessDiff
1362
{
1363
    my $self = shift;
1364
    my $data = shift;
1365
 
1366
    #
1367
    #   Extract filename from line
1368
    #       First 8 chars are status
1369
    #       Remove WS path too
1370
    #
1371
    my $path_length = $self->{tmp}{path_length} + 1 + 8;
1372
    if ( length $data >= $path_length )
1373
    {
1374
        my $file = substr ( $data, $path_length );
1375
        push @{$self->{tmp}{files}}, '  Changed: ' .  $file
1376
            if ( $self->{tmp}{count}++ < 10 );
1377
    }
1378
 
1379
    return 0;
1380
}
1381
 
267 dpurdie 1382
#-------------------------------------------------------------------------------
1403 dpurdie 1383
# Function        : parseSubversionRef
1384
#
1385
# Description     : Parse the user-provided Subversion Ref
1386
#
1387
#                   Convert label with embedded VCS information into a 'normal' form.
1388
#                   Form:
1389
#                       SVN::<SourcePath>::<Label>
1390
#                       SVN::<SourcePath>::<Peg>
1391
#                   
1392
#                   Allow optional 'SVN::' prefix
1393
#                   Allow Full or Symbolic URL
1394
#                       [SVN::]<SourcePath>::<Label>
1395
#                       [SVN::]<SourcePath>::<Peg>
1396
#                       [SVN::]<URL>
1397
#
1398
# Inputs          : $opt_spec               - User Provided Ref
1399
#
1400
# Returns         : Will not retirn on gross error
1401
#                   Values return in global variables
1402
#
1403
sub parseSubversionRef
1404
{
1405
    my ($opt_spec) = @_;
1406
 
1407
    $opt_spec =~ s~^SVN::~~;
1408
    if ( $opt_spec =~ m~(.+)::(.+)~ )
1409
    {
1410
        my $sourcePath = $1;
1411
        my $label = $2;
1412
        $urlType = 'jats';
1413
 
1414
        #
1415
        #   Sanity test of sourcePath
1416
        #
1417
        Error ("Invalid use of a peg: $opt_spec[0]")
1418
            if ( $sourcePath =~ m~\@\d+$~ );
1419
 
1420
        #
1421
        #   Remove anything after a ttb (truck, tags, branch) element
1422
        #   This will be the root of the package within the repo
1423
        #
1424
        if (  $sourcePath =~ m~(.*)/((tags|branches|trunk)(/|$)(.*))~ )
1425
        {
1426
            Error ("Source Path has insufficient items")
1427
                if ( $1 eq '' );
1428
 
1429
            Error ("SourcePath contains invalid items after '$3': '$5'")
1430
                if ( ($3 eq 'tags' || $3 eq 'trunk') && $5 ne '' );
1431
 
1432
            Error ("SourcePath must contain items after 'branches'")
1433
                if ( $3 eq 'branches' && $5 eq '');
1434
 
1435
            $srcPathPkg = $1;
1436
            $ttbType = $3;
1437
            $devBranch = $3;
1438
            $devBranch .= '/' . $5 if ( $5 ne '' );
1439
        }
1440
        else
1441
        {
1442
            Error ("Source Path does not contain tags or trunk or branches component");
1443
        }
1444
 
1445
        #
1446
        #   Pull apart the 2nd argument
1447
        #   May be a raw peg - on the development branch
1448
        #   May be a tag and a peg
1449
        #
1450
        $initialUrl = $srcPathPkg;
1451
        if ( $label =~ m~^@*(\d+)$~ )
1452
        {
1453
            # Full numeric label - is a peg on the development branch
1454
            $devBranchPeg = $1;
1455
            $initialUrl .= '/' . $devBranch . '@' . $devBranchPeg;
1456
        }
1457
        elsif ( $label =~ m~^([^@]+)@(\d+)$~ )
1458
        {
1459
            $tagLabel = 'tags/' . $1;
1460
            $tagPeg = $2;
1461
            $initialUrl .= '/tags/' . $label;
1462
 
1463
        }
1464
        elsif ( $label !~ m~@~ )
1465
        {
1466
            $tagLabel = 'tags/' . $label;
1467
            $initialUrl .= '/tags/' . $label;
1468
        }
1469
        else
1470
        {
1471
            Error ("Subversion Tag badly formed: $label");
1472
        }
1473
    } elsif ($opt_spec =~ m~::~) {
1474
        Error ("Badly formed Subversion Reference: $opt_spec[0]");
1475
 
1476
    }
1477
    else
1478
    {
1479
        # Have a full URL and not a JATS enhanced spec
1480
        # Cannot determine the development branch and the tag
1481
        #
1482
        $urlType = 'url';
1483
        $initialUrl = $opt_spec;
1484
 
1485
        # Extact any peg
1486
        my $peg;
1487
        if ( $opt_spec =~ m~(.*)@(\d+)$~ )
1488
        {
1489
            $opt_spec = $1;
1490
            $peg = $2;
1491
        }
1492
 
1493
        if (  $opt_spec =~ m~(.*)/((tags|branches|trunk)(/|$)(.*))~ )
1494
        {
1495
            Error ("Subversion URL has insufficient items")
1496
                if ( $1 eq '' );
1497
            $srcPathPkg = $1;
1498
            $ttbType = $3;
1499
 
1500
            if ( $ttbType eq 'trunk' ) {
1501
                Error ("Subversion URL must NOT contain items after '$ttbType'")
1502
                    if ( $5 ne '' );
1503
                $devBranch = $2;
1504
                $devBranchPeg = $peg;
1505
 
1506
            } elsif ( $ttbType eq 'tags' ) {
1507
                Error ("Subversion URL must contain items after '$ttbType'")
1508
                    unless ( $5 ne '' );
1509
                $tagLabel = $2;
1510
                $tagPeg = $peg;
1511
 
1512
            } else {
1513
                Error ("Subversion URL must contain items after '$ttbType'")
1514
                    unless ( $5 ne '' );
1515
                $devBranch = $2;
1516
                $devBranchPeg = $peg;
1517
            }
1518
        }
1519
        else
1520
        {
1521
            Error ("Subversion URL does not contain tags or trunk or branches component");
1522
        }
1523
    }
1524
    #debugDumpRefInfo('First Parse');
1525
}
1526
 
1527
#-------------------------------------------------------------------------------
1456 dpurdie 1528
# Function        : calcViewName
1529
#
1530
# Description     : Calculate a nice name for the view
3859 dpurdie 1531
#                   Try to keep short and informative
1532
#                       Some legacy tools hate long paths.
1533
#                       See Jira issue: JATS-274
1456 dpurdie 1534
#                   Try to base the name on the tag
1535
#
1536
#                   If the URL looks like a TTB then we can make some guesses
1537
#                   as to the package name and version.
1538
#
1539
#                   Add indication for the Dev Mode
1540
#                   Add indication for a branch
1541
 
1542
#
1543
# Inputs          : Nothing
1544
#
3859 dpurdie 1545
# Returns         : A 'nice' ViewName
1546
#                   Will not return on error
1456 dpurdie 1547
#
1548
sub calcViewName
1549
{
1550
    #
1551
    #   Use the user provided view name if its valid
1552
    #
1553
    if ( $opt_viewname )
1554
    {
1555
        Error ("View Name contains invalid characters" )
1556
            unless ( $opt_viewname =~ m~^[0-9a-z]([-.:0-9a-z_]*[0-9a-z])?$~i );
1557
        return $opt_viewname ;
1558
    }
1559
 
1560
    #
1561
    #   Create a view name based on the provide URL or SVN Reference
1562
    #
1563
    my $version;
1564
    my $name = $srcPathPkg;
3859 dpurdie 1565
    my $isaWIP;
1566
 
1456 dpurdie 1567
    $name =~ s~.*/~~;
1568
 
1569
    if ( $tagLabel )
1570
    {
1571
        $version = $tagLabel;
1572
        $version =~ s~.*/~~;
3859 dpurdie 1573
        $isaWIP = $version =~ m~\.WIP$~;
1574
 
1575
        # Remove package name from the tag
1576
        # Allow for WIPs too
1577
        #       XXXX_nnnn.ppp.WIP   WIP: Name is upper case. Join is.
1578
        #       xxxx_nn.nn.nn.ppp   TAG: Name is same case. Join is _
1579
        $version = $1 if ( $version =~ m~^${name}[_.](.*)~i );
1456 dpurdie 1580
    }
1581
    elsif ( $devBranch )
1582
    {
1583
        $version = $devBranch;
4446 dpurdie 1584
        $version =~ s~.*?/~~;
1456 dpurdie 1585
    }
1586
 
1587
    if ( $version && $name )
1588
    {
1589
        $opt_viewname = join( '_', $name, $version);
1590
    }
1591
    elsif ( $svnSession->Type )
1592
    {
1593
        $opt_viewname = $svnSession->Path;
1594
        $opt_viewname .= '_' . ($svnSession->Version || 'trunk') unless $opt_branch;
1595
 
1596
        #
1597
        #   Tags and Branches 'should' include the package name
1598
        #   This will lead to a duplication of the package name
1599
        #   ie: aaaaa/package/tags/package_version
1600
        #   Attempt to remove these
1601
        #
1602
        if ( $opt_viewname =~ s~[_/]([\-.:0-9a-zA-Z]+)_\1_~_$1_~ )
1603
        {
1604
            Verbose ("Removed duplicate package name: $1 from $opt_viewname");
1605
        }
1606
    }
1607
    else
1608
    {
1609
        $opt_viewname = $svnSession->Path;
1610
        $bad_label_name = 1;
1611
    }
1612
 
1613
    #
1614
    #   Append the peg if provided
3859 dpurdie 1615
    #       Not if creating a 'tip' as its a bit meaningless
1616
    #       Not if a WIP as it should have been provided and is not noise
1456 dpurdie 1617
    #
1618
    if ( my $peg = $tagPeg || $devBranchPeg )
1619
    {
3859 dpurdie 1620
        unless( $opt_devMode eq 'tip' || $isaWIP)
1456 dpurdie 1621
        {
1622
            $opt_viewname .= '_' . $peg;
1623
        }
1624
    }
1625
 
1626
    #
1627
    #   Append information to indicate the exact type of the WorkSpace
1628
    #   Normally mutually exclusive
1629
    #
1630
    $opt_viewname .= '_Tip' if ( $opt_devMode eq 'tip' );
1631
    $opt_viewname .= '_Tag' if ( $opt_devMode eq 'tag' );
1632
    $opt_viewname .= '_Exact' if ( $opt_devMode eq 'exact' );
1633
    $opt_viewname .= '_' . $opt_branch if ( $opt_branch );
1634
 
1635
    #
1636
    #   Create a simple dir name
1637
    #       Remove path sep characters and replace with _
1638
    #       Remove Peg marker (@) as this breaks svn
1639
    #       Replace multiple _ with a single _
1640
    #       Remove trailing _ - caused by URL with a trailing /
1641
    #
1642
    $opt_viewname =~ s~[^\-.:0-9a-zA-Z_]~_~g;
1643
    $opt_viewname =~ tr~_~_~s;
1644
    $opt_viewname =~ s~_+$~~;
1645
    return $opt_viewname;
1646
}
1647
 
1648
#-------------------------------------------------------------------------------
1403 dpurdie 1649
# Function        : debugDumpRefInfo
1650
#
1651
# Description     : Dump the current Ref Information
1652
#
1653
# Inputs          : $text
1654
#
1655
# Returns         : 
1656
#
1657
sub debugDumpRefInfo
1658
{
1659
    Verbose0 ('-' x 40);
1660
    Verbose0 ('debugDumpRefInfo:' , @_ );
1661
    Verbose0 ('ttbType           :', $ttbType);
1662
    Verbose0 ('urlType           :', $urlType);
1663
    Verbose0 ('Base              :', $svnSession->FullPath() ) if $svnSession;
1664
    Verbose0 ('initialUrl        :', $initialUrl);
1665
    Verbose0 ('srcPathPkg        :', $srcPathPkg);
1666
    Verbose0 ('devBranch         :', $devBranch);
1667
    Verbose0 ('devBranchPeg      :', $devBranchPeg);
1668
    Verbose0 ('devBranchHead     :', $devBranchHead);
1669
    Verbose0 ('tagLabel          :', $tagLabel);
1670
    Verbose0 ('tagPeg            :', $tagPeg);
1671
    Verbose0 ('tagLabelBranch    :', $tagLabelBranch);
1672
    Verbose0 ('tagLabelBranchPeg :', $tagLabelBranchPeg);
1673
}
1674
 
1675
#-------------------------------------------------------------------------------
1676
 
1677
 
1678
#-------------------------------------------------------------------------------
267 dpurdie 1679
#   Documentation
1680
#
1681
 
1682
=pod
1683
 
361 dpurdie 1684
=for htmltoc    GENERAL::Subversion::
1685
 
267 dpurdie 1686
=head1 NAME
1687
 
1688
jats_svnrelease - Build a package given a SubVersion label
1689
 
1690
=head1 SYNOPSIS
1691
 
1692
  jats svnrelease [options] [-label=]label
1693
 
1694
 Options:
1695
    -help              - brief help message
1696
    -help -help        - Detailed help message
1697
    -man               - Full documentation
1698
    -label=xxx         - Subversion label
1699
    -spec=xxx          - Same as -label=xxx
1700
    -path=xxx          - Source Path
1701
    -view=xxx          - Modify the name of the created view
1702
    -build=xxx         - Package Name to build
1703
    -root=xxx          - Root directory for generated view
2040 dpurdie 1704
    -[mk]branch=xxx    - Will create/use a branch
1403 dpurdie 1705
    -tag=xxx           - Compatibility. Not used
267 dpurdie 1706
    -extract           - Extract the view and exit
1707
    -extractfiles      - Extract files, without a view
1403 dpurdie 1708
    -devMode=xxx       - Create Workspace suitable for development.(Tip,Tag,...)
267 dpurdie 1709
    -cache             - Refresh local dpkg_archive cache
361 dpurdie 1710
    -delete[=n]        - Remove any existing view and exit
267 dpurdie 1711
    -debugOnly         - Make only the debug version
1712
    -prodOnly          - Make only the production version
1713
    -[no]dpkg          - Transfer package into dpkg_archive
1714
    -[no]copy          - Transfer pkg directory to the current user directory
1715
    -[no]reuse         - Reuse the view
1716
    -[no]test          - Test package build. Implies nocopy and nodpkg
1717
    -[no]keep          - Keep the view after the build
1718
    -[no]beta          - Release a beta package
1719
    -[no]merge         - Merge packages into dpkg_archive
1720
    -[no]runtests      - Run units tests. Default is runtests
1403 dpurdie 1721
    -[no]prefix        - Suppress user prefix in view name. Default prefix is USER
267 dpurdie 1722
 
1723
=head1 OPTIONS
1724
 
1725
=over 8
1726
 
1727
=item B<-help>
1728
 
1729
Print a brief help message and exits.
1730
 
1731
=item B<-help -help>
1732
 
1733
Print a detailed help message with an explanation for each option.
1734
 
1735
=item B<-man>
1736
 
1737
Prints the manual page and exits.
1738
 
1739
=item B<-label> or B<-spec>
1740
 
1403 dpurdie 1741
The Subversion label to use as the base for the workspace. The utility will
1742
accept the following forms of label identifier, each with an optional 'SVN::' prefix.
267 dpurdie 1743
 
1403 dpurdie 1744
=over 4
267 dpurdie 1745
 
1403 dpurdie 1746
=item Full URL
1747
 
1748
This form is identified by the complete lack of the '::' subfield delimiter. The
1749
URL is used as provided. It is not modified.
1750
 
1751
 Eg: AUPERASVN01/DPG_SWBASE/daf_utils_math/tags/daf_utils_math_3.2.1@12345
6276 dpurdie 1752
 Eg: https://auawsasvn001.vix.local/svn/DPG_SWBASE/daf_utils_math/tags/daf_utils_math_3.2.1@12345
1403 dpurdie 1753
 
1754
 
1755
=item SourcePath::Tag
1756
 
1757
The SourcePath component is used to calculate the root of the package directory.
1758
The source path is then caclulated assuming that the 'Tag' exists within a
1759
'/tags' subdirectory of the root of the package.
1760
 
1761
This is the form preferred by Release Manager and the VIX build system.
1762
 
1763
 Eg: AUPERASVN01/DPG_SWBASE/daf_utils_math/trunk::daf_utils_math_3.2.1@12345
1764
 
1765
=item SourcePath::Peg
1766
 
1767
A special case of of the 'SourcePath::Tag' form is invoked if the 'Tag' component
1768
is numeric. It will be treated as a peg of the Base Path.
1769
 
1770
 Eg: AUPERASVN01/DPG_SWBASE/daf_utils_math/trunk::12345
1771
 
1772
=back
1773
 
267 dpurdie 1774
=item B<-view name>
1775
 
1776
Specified an alternate view name and tag to be used. This option does not provide the
1777
full name of the view.
1778
 
361 dpurdie 1779
The view path will be: "${USER}_${NAME}"
267 dpurdie 1780
 
1781
The default "NAME" is the first label specified with the repository and tag removed.
1782
 
1783
If the user provides a view "name" that is prefixed with their user name
1784
('${USER}_'), then the username will be stripped of for internal processing.
1785
This allows a user to provide a view path when deleting a view.
1786
 
1787
=item B<-path=xxx>
1788
 
1789
Specifies the source path to the root of the extracted file tree. This option is
1403 dpurdie 1790
not mandatory and is only used to maintain toolset compatibility with other
267 dpurdie 1791
,similar, tools.
1792
 
1793
If provided, then the Workspace will be created within the named subdirectory
1794
tree within the base of the view.
1795
 
1796
=item B<-build=xxx>
1797
 
1798
This option allows the user to specify the packages to be built and the
1799
order in which the packages are to be built.
1800
This is useful if the extracted view contains multiple build files
1801
 
1802
This option may be used multiple times.
1803
 
1804
There are two forms in which the build target can be specified. It can be
1403 dpurdie 1805
specified as a full package name and version, or as a package name and the
267 dpurdie 1806
project suffix.
1807
 
1808
By default the program will assume that there is only one build file in the
1809
view and will not build if multiple files are present, unless the package to be
1810
built can be resolved.
1811
 
1812
The location mechanism operates for both JATS and ANT build files.
1813
 
1814
Example: -build=jats-api.1.0.0000.cr
1815
 
1816
This will locate the build file that builds version 1.0.0000.cr of the jats-api
1817
package. The version numbers must match exactly.
1818
 
1819
Example: -build=jats-api.cr -build=jats-lib.cr
1820
 
1821
This will located the build files that build the jats_api (cr) package and the
1822
jats-lib (cr) package. The version of the packages will not be considered.
1823
 
1824
=item B<-root=xxx>
1825
 
1826
This option allows the location of the generated view to be specified on the
1403 dpurdie 1827
command line. It overrides the value of GBE_VIEWBASE.
267 dpurdie 1828
 
1403 dpurdie 1829
If the command is invoked within a development sandbox, then the default
267 dpurdie 1830
location will be the root directory of the development sandbox.
1831
 
2040 dpurdie 1832
=item B<-mkbranch=xxx>
267 dpurdie 1833
 
1329 dpurdie 1834
This option will create a workspace associated with a branch within the
1835
repository. This is intended to facilitate the maintenance of existing packages
2040 dpurdie 1836
and the creation of project or development branches.
267 dpurdie 1837
 
2040 dpurdie 1838
The named branch must not exist. It is an error for the branch to exist.
267 dpurdie 1839
 
2040 dpurdie 1840
This tool will copy the specified source version to the branch, create a
1841
workspace based on the branch and then switch to the branch.
267 dpurdie 1842
 
2040 dpurdie 1843
This option is intended to create a development thread, for project or private
1844
use.
1845
 
383 dpurdie 1846
A branch name of TIMESTAMP will be treated in special manner. The name will be
1847
replaced with a unique name based on the users name and the current date time.
1848
 
2040 dpurdie 1849
=item B<-branch=xxx>
1850
 
1851
This option will create a workspace associated with a branch within the
1852
repository. This is intended to facilitate the maintenance of existing packages
1853
and the creation of project or development branches in a manner similar to
1854
ClearCase.
1855
 
1856
The named branch must exist. It is an error for the branch to not exist.
1857
 
1858
If the named branch does exist, then this tool will create a workspace based
1859
on the head of the branch.
1860
 
1861
This option is intended to extract the tip of a development thread.
1862
 
351 dpurdie 1863
=item B<-tag=text>
1864
 
1865
This option is not used.
1403 dpurdie 1866
It is present to maintain compatibility with the buildtool interface.
351 dpurdie 1867
 
267 dpurdie 1868
=item B<-extract>
1869
 
1870
With this option the view is created and the left in place. The user may then
1871
access the files within the view. The view should not be used for a
1872
production release.
1873
 
1874
=item B<-extractfiles>
1875
 
1876
With this option the utility will create a dynamic view and transfer files from
1403 dpurdie 1877
the view to the user's target. The dynamic view is then removed.
267 dpurdie 1878
 
1879
This command is intended to simplify the process of creating an escrow.
1880
 
1403 dpurdie 1881
=item B<-devMode=mode>
1882
 
1883
This option controls the exact form of the Workspace create. The svnRelease
1884
command supports the following modes (default is working):
1885
 
1886
=over 4
1887
 
1888
=item   Tag or TagPoint
1889
 
1890
The workspace will contain the point on the packages development branch from
1891
which the specified tag was copied.
1892
 
1893
The extraction process will highlight file differences between the specified tag
1894
and the tip. If any differences are found then these will be treated as an error.
1895
 
1896
The user B<should> resolve this error by selecting, in Release Manager, a
1897
version of the package based on the tip of the Development Branch.
1898
 
1899
This is the preferred Development Mode for working on a package as it provides
1900
checks to ensure that the Meta Data held in Release Manager is consistient.
1901
 
1902
=item   Work or Working
1903
 
1904
The workspace will contain the point on the packages development branch from
1905
which the specified tag was copied.
1906
 
1907
The extraction process will highlight file differences between the specified tag
1908
and the tip of the Development Branch. Unlike the 'Tag' Mode, such differences
1909
are not treated as an error.
1910
 
1911
This mode of WorkSpace has several features and constraints:
1912
 
1913
=over 4
1914
 
1915
=item *
1916
 
1917
The build files from the 'tagged' version will be transferred into the
1918
WorkSpace. These will be seen as modified files.
1919
 
1920
=item *
1921
 
1922
This style of workspace can be converted into a 'Tip' style through the use of the
1923
Subversion 'update' command.
1924
 
1925
=item *
1926
 
1927
If there have been changes to the Development Branch, then it not be possible to
1928
'commit' the workspace. It may need to be branched first.
1929
 
1930
=back
1931
 
1932
=item Tip or BranchTip
1933
 
1934
The workspace will contain the 'tip' of the Packages Development Branch.
1935
 
1936
The extraction process will highlight file differences between the specified tag
1937
and the tip.
1938
 
1939
=item Exact
1940
 
1941
The workspace will be directly based on the Tag or URL provided by the user.
1942
 
1943
The resultant workspace may not be suitable for development.
1944
 
1945
The extraction process will highlight file differences between the specified tag
1946
and the tip of any associated Development Branch.
1947
 
1948
=back
1949
 
1950
The four extraction points are shouwn in the following image:
1951
 
1952
     /branches/...    /tags/...
1953
            v            v
1954
            |
1955
        +---+---+
1956
  [Tag] | Work  |    +-------+
1957
        +---+---+----+ Exact |
1958
            |        +-------+
1959
        +---+---+
1960
        |       |
1961
        +---+---+
1962
            |
1963
        +---+---+
1964
        |  Tip  |
1965
        +---+---+
1966
 
267 dpurdie 1967
=item B<-cache>
1968
 
1969
Forces external packages to be placed in the local dpkg_archive cache.
1970
 
1971
The normal operation is to copy the packages, only if they do not already exist
1972
in the local cache. This option may be used to ensure that the local copy is
1973
correct and up to date.
1974
 
361 dpurdie 1975
=item B<-delete[=level]>
267 dpurdie 1976
 
1977
Delete the view used by the program, if it exists. This option may be used to
1978
cleanup after an error.
1979
 
361 dpurdie 1980
The default 'level' is 1.
267 dpurdie 1981
 
361 dpurdie 1982
If the delete level is 1, then ensure that no files are open in the view and
1983
that the users current working directory is not in the view as these will
1984
prevent the view from being deleted.
1985
 
1986
If the delete level is greater than one, then the view will be deleted, even
1987
if there are checkout out files.
1988
 
267 dpurdie 1989
=item B<-debugOnly>
1990
 
1991
Make only the debug version of the package. The default it to create both the
1992
debug and production version of the package. The type of build may be  further
1993
limited by options within the package.
1994
 
1995
=item B<-prodOnly>
1996
 
1997
Make only the production version of the package. The default it to create both the
1998
debug and production version of the package. The type of build may be  further
1999
limited by options within the package.
2000
 
2001
=item B<-[no]dpkg>
2002
 
2003
Copy the generated package into dpkg_archive. This is the default mode of
2004
operation.
2005
 
2006
=item B<-[no]copy>
2007
 
2008
Copy the built "pkg" directory to the users current directory. The entire
2009
"pkg" subdirectory includes the full package named directory for the package
2010
that has been built.
2011
 
2012
=item B<-[no]reuse>
2013
 
2014
This flag allows the view created by the program to be re-used.
2015
 
2016
=over 8
2017
 
361 dpurdie 2018
=item *
267 dpurdie 2019
 
361 dpurdie 2020
The view is not deleted before being populated.
267 dpurdie 2021
 
361 dpurdie 2022
=item *
267 dpurdie 2023
 
361 dpurdie 2024
The view will not be populated if it does exist.
2025
 
2026
=item *
2027
 
2028
The view will not be deleted at the end the process.
2029
 
267 dpurdie 2030
=back
2031
 
2032
This option is useful for debugging a build process.
2033
 
2034
=item B<-[no]test>
2035
 
2036
Test the building of the package. This option implies "nocopy" and "nodpkg".
2037
 
2038
=item B<-[no]keep>
2039
 
361 dpurdie 2040
Keep the workspace after the build. The default option is "nokeep"
267 dpurdie 2041
 
2042
This option is different to the "reuse" in that the view will be deleted, if
2043
it exists, before the build, but will be retained at the completion of the
2044
process. The user may then manually extract the created package.
2045
 
2046
The view may be deleted with the the "delete" option; taking care to ensure that
2047
no files are open in the view and that the users current working directory is
2048
not in the view.
2049
 
2050
=item B<-[no]beta>
2051
 
2052
This option overrides many of the package release tests to allow a beta package
2053
to be released.
2054
 
2055
=item B<-[no]merge>
2056
 
2057
This option will merge packages being built on multiple machines into
2058
dpkg_archive. By default, if a package already exists in the archive it will be
2059
deleted and replaced. With this option the package will be merged. The merge
2060
process does not over write files found in the archive.
2061
 
2062
=item B<-[no]runtests>
2063
 
2064
This option will allow the suppression of the running of the unit tests included
2065
with the component. By default the tests are run. This can be suppressed
2066
without affecting the release process.
2067
 
2068
=back
2069
 
2070
=head1 DESCRIPTION
2071
 
2072
This program is the primary tool for the creation, recreation and release of
1329 dpurdie 2073
packages within the B<VIX> build environment, although the program can perform a
267 dpurdie 2074
number of very useful operations required during normal development and
2075
maintenance.
2076
 
2077
This program will build a system containing one or more inter-related build
2078
files using the JATS build tools.
2079
 
2080
In normal operation the program will:
2081
 
2082
=over 8
2083
 
2084
=item Remove Workspace
2085
 
2086
Remove any existing workspace of the same name. The workspace will not be
2087
removed if it contains checked-out files.
2088
 
2089
The workspace removal may fail if there are any files B<open> within the view or if
2090
any shell has a subdirectory of the view set as a B<current working directory>.
2091
 
2092
=item Create the workspace
2093
 
2094
Create a workspace to contain the files described by the Subversion
2095
label being processed.
2096
 
2097
=item Populate the workspace
2098
 
2099
Loads files into the workspace.
2100
 
2101
I<Note:> If the workspace files are simply being extracted, then this is the end
2102
of the program. The extracted workspace is left in place.
2103
 
2104
=item Sanity Test
2105
 
2106
If the build is being used as a release into dpkg_archive then
2107
various tests are performed to ensure the repeatability of the view and the
2108
build. These tests include:
2109
 
2110
=over 8
2111
 
361 dpurdie 2112
=item   *
267 dpurdie 2113
 
361 dpurdie 2114
The view must be constructed from one label
267 dpurdie 2115
 
361 dpurdie 2116
=item   *
267 dpurdie 2117
 
361 dpurdie 2118
That label must be pegged
267 dpurdie 2119
 
361 dpurdie 2120
=item   *
2121
 
2122
The labelled view must contain exactly one build file
2123
 
2124
=item   *
2125
 
2126
The view cannot have been re-used.
2127
 
267 dpurdie 2128
=back
2129
 
2130
=item Locate build files
2131
 
2132
Locate the build file within the view.
2133
 
2134
It is an error to have multiple build files within the workspace, unless the
2135
B<-build> option is used. By default, only one package will be built.
2136
 
2137
=item Package the results
2138
 
2139
Use JATS to build and make the package.
2140
 
2141
The resultant package may be copied to a numbers of locations. These include
2142
 
2143
=over 8
2144
 
2145
=item 1
2146
 
2147
The master dpkg_archive as an official release. This is the default operation.
2148
 
2149
=item 2
2150
 
2151
The users current directory. The package directory from the built package is
2152
copied locally. The "pkg" directory is copied. This is only performed with the
2153
B<-copy> option.
2154
 
2155
=back
2156
 
2157
=item Delete the workspace
2158
 
2159
Delete the workspace and all related files.
2160
 
2161
The workspace will not be deleted if an error was detected in the build process, or
2162
the "reuse" or "keep" options are present.
2163
 
2164
=back
2165
 
2166
=cut
2167