Subversion Repositories DevTools

Rev

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

Rev Author Line No. Line
267 dpurdie 1
########################################################################
1403 dpurdie 2
# Copyright (C) 1998-2012 Vix Technology, 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,
680
                        'comment' => 'Created by Jats SvnRelease branch request',
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
    #
267 dpurdie 691
    #   Create a local package archive
692
    #   May be needed for multipackage builds and it will prevent JATS from
693
    #   finding any outside the view
694
    #
695
    mkdir ( $VIEWDIR . '/local_dpkg_archive')
696
        unless ($GBE_SANDBOX);
1403 dpurdie 697
 
698
    #
699
    #   Display messages AFTER the extraction text
700
    #   Will ensure that the user has a chance to see them
701
    #
702
    Warning(@messageText );
703
 
267 dpurdie 704
}
705
 
285 dpurdie 706
#   Place a tag-file in the user-specified source path
707
#   This will be used by the build-tool to locate the 'source-path' of the
708
#   view, primarily for determining metrics.
267 dpurdie 709
#
1403 dpurdie 710
#   Calculate where the dynamic view will be
285 dpurdie 711
#   This differ between UNIX/WINDOWS
712
#
351 dpurdie 713
if ( $GBE_ABT)
285 dpurdie 714
{
1403 dpurdie 715
    Message("Create Build tagfile");
716
    TouchFile ( "$workSpace/.jats.packageroot" )
717
        if ( -d $workSpace )
285 dpurdie 718
}
719
 
720
#
267 dpurdie 721
#   Locate the JATS build files within the populated view
722
#
1403 dpurdie 723
chdir ($VIEWDIR) or Error("Cannot chdir to $VIEWDIR");
267 dpurdie 724
Message( "Locating build files");
725
 
726
my $bscanner = BuildFileScanner( $VIEWDIR, 'build.pl', '--LocateAll' );
727
$bscanner->scan();
728
my @build_list = $bscanner->getInfo();
729
foreach my $be ( @build_list )
730
{
1403 dpurdie 731
    Message(DisplayPath ("Build file: $be->{dir} Name: $be->{file}"));
267 dpurdie 732
}
733
 
734
#
735
#   If we are extracting the view then we are done
736
#   Display useful information for the user
737
#
738
if ( $opt_extract )
739
{
740
    Message  DisplayPath "View in: $VIEWDIR";
741
    Warning ("No build files found" )   if ( $#build_list < 0 );
742
    Warning( "Multiple build files found" )if ( $#build_list > 0 );
743
    Message ("Not all labels are pegged") if ( @label_not_pegged  );
744
    Message ("All labels are pegged") unless ( @label_not_pegged  );
745
    Message ("Badly formed label name" ) if ( $bad_label_name );
1403 dpurdie 746
    Message ("Development Mode: $opt_devModeStr") if ( $opt_devModeStr );
267 dpurdie 747
    Message ("Development Sandbox") if ( $GBE_SANDBOX );
1403 dpurdie 748
    Message ("Cannot release from this workspace") if ($noReleaseWs);
267 dpurdie 749
 
750
    exit 0;
751
}
752
 
753
Error ("No build files found")  if ( $#build_list < 0 );
754
 
755
#
756
#   Determine the list of builds to perform
757
#   Ensure that the user-requested build files are present
758
#
759
#   The user specifies the build file, via the mangled package name
760
#   This is package_name . project extension (daf_utils.cr)
761
#
762
if ( $#opt_build  >= 0)
763
{
764
    Verbose( "Check and locate the build files");
765
    @build_list = ();
766
    foreach my $bentry ( @opt_build )
767
    {
768
        if ($bscanner->match( $bentry) )
769
        {
770
            UniquePush (\@build_list, $bscanner->getMatchList() );
771
            Verbose ("Found: $bentry");
772
        }
773
        else
774
        {
775
            Error ("Cannot locate requested build files for: $bentry")
776
        }
777
    }
778
}
779
 
780
#
781
#   Sanity test if we will transfer the generated package to dpkg_archive
782
#   There are some limits
783
#       1) Must have built from one label
784
#       2) That label must be locked
785
#       3) Only one build file
786
#       4) The view must not have been reused
787
#       5) The view has a branch rule
788
#       6) Cannot release from a sandbox
789
#
790
my @elist;
791
push @elist, "Package built from multiple labels" unless ( $label_count == 1 );
792
push @elist, "Package built from an unpegged label" if ( @label_not_pegged  );
793
push @elist, "Package built with multiple build files" if ( scalar @build_list > 1 );
794
push @elist, "Package from a reused view" if ( $opt_reuse && ! $opt_beta );
795
push @elist, "Package from a development sandbox" if ( $GBE_SANDBOX );
1403 dpurdie 796
push @elist, "Package from a development workspace" if ($noReleaseWs);
267 dpurdie 797
push @elist, "View contains a branch" if ( $opt_branch );
798
push @elist, "User has specified build files" if ( $#opt_build > 0 );
799
push @elist, "Badly formed label name" if ( $bad_label_name );
800
 
801
if ( @elist )
802
{
803
    Warning ("Cannot officially release the package.", @elist);
804
    Error ("Build terminated as it cannot be released") if ($opt_dpkg && ! $opt_beta);
805
}
806
Warning ("Beta Release") if $opt_beta;
807
 
808
#
809
#   Process each of the build files in the specified order
810
#
811
foreach my $be (@build_list)
812
{
813
 
814
    #
815
    #   We need to change to the build directory
816
    #   Moreover we need the local name of the build directory.
817
    #   Windows does not handle a UNC pathname to well (at all)
818
    #
819
    my $build_dir = $be->{dir};
820
    chdir ("$build_dir") or Error( "Cannot chdir to build directory: $build_dir");
821
 
822
    if ( $be->{file} =~ m/^build.pl$/ )
823
    {
824
        Message ("Using JATS: $build_dir");
825
        #
826
        #   Invoke JATS to build the package and make the package
827
        #
828
        my @build_args = qw(--expert --cache);
829
        push @build_args, '--cache' if $opt_cache;
830
 
831
        my $make_type = 'all';
832
        $make_type = 'all_prod'  if ( $opt_prod_build );
833
        $make_type = 'all_debug' if ( $opt_debug_build );
834
 
835
 
836
        JatsCmd('build', @build_args)               and Error("Package did not build");
837
        JatsCmd('make', $make_type, 'NODEPEND=1')   and Error("Package did not make");
838
        JatsCmd('install');
839
 
840
        if ( $opt_runtests )
841
        {
321 dpurdie 842
            JatsCmd('make', 'run_unit_tests')      and Error("Tests did not run correctly");
267 dpurdie 843
        }
844
    }
845
    else
846
    {
847
        #
848
        #   Ant build files
849
        #
850
        my $pname =  $be->{file};
851
        Message ("Using ANT: $build_dir, $pname");
852
        $pname =~ s~depends.xml$~.xml~;
853
        copy($be->{file}, "auto.xml");
854
        JatsCmd('-buildfile', $pname, 'ant', 'build')        and Error("Package did not build");
855
        JatsCmd('-buildfile', $pname, 'ant', 'make_package') and Error("Package did not make_package");
856
    }
857
}
858
 
859
#
860
#   Copy the generated packages
861
#       1) dpkg_archive
862
#       2) Users local directory
863
#
864
foreach my $be (@build_list)
865
{
866
    my $build_dir = $be->{dir};
867
    chdir ("$build_dir") or Error( "Cannot chdir to build directory: $build_dir");
868
    if ( $opt_dpkg )
869
    {
870
        Message ("Using: $build_dir");
279 dpurdie 871
        my @create_opts = "-o";
872
        push @create_opts ,"-m" if ( $opt_merge );
873
        JatsCmd('-here', 'create_dpkg', @create_opts, '-pname', $be->{name}, '-pversion', $be->{version}) and $error++;
267 dpurdie 874
    }
875
 
876
    if ( $opt_copy )
877
    {
878
        Message ("Copy package to $user_cwd");
879
        copy_directory( 'pkg', $user_cwd, '' );
880
    }
881
 
882
    #
883
    #   Test structure of the package
884
    #   Ensure that it has a descpkg file
885
    #   Validate the package name and version
886
    #   More important for ANT projects than JATS as JATS has a sanity test
887
    #
888
    if ( $opt_test )
889
    {
890
        JatsCmd('-here', 'create_dpkg', '-test', '-pname', $be->{name}, '-pversion', $be->{version}) and $error++;
891
    }
892
 
893
}
894
Error ("Package not transferred")
895
    if ( $error );
896
 
1403 dpurdie 897
chdir ($user_cwd) or Error( "Cannot chdir to $user_cwd");
267 dpurdie 898
 
899
#
900
#   Delete the view
901
#
902
if ( ! $opt_reuse && ! $error && ! $opt_keep )
903
{
904
    delete_view();
905
}
906
else
907
{
908
    Message( "View left in: $VIEWDIR" );
909
}
910
 
911
Message ("End program");
912
exit 0;
913
 
914
#-------------------------------------------------------------------------------
915
# Function        : delete_view
916
#
917
# Description     : Delete a view
918
#
919
# Inputs          : None
920
#                   $VIEWDIR - path of the view
921
#
922
# Returns         :
923
#
924
sub delete_view
925
{
926
    my $cofound = 0;
927
    my $uuid;
928
    #
299 dpurdie 929
    #   Simple delete
267 dpurdie 930
    #
299 dpurdie 931
    if ( $opt_extract_files )
267 dpurdie 932
    {
299 dpurdie 933
        if ( -d $VIEWDIR )
934
        {
935
            Message("Remove extracted files: $VIEWDIR");
361 dpurdie 936
            RmDirTree( $VIEWDIR );
299 dpurdie 937
        }
938
    }
939
    else
940
    {
267 dpurdie 941
        #
1403 dpurdie 942
        #   If the view physically exists then attempt to physically remove it
267 dpurdie 943
        #
299 dpurdie 944
        if ( -d $VIEWDIR )
945
        {
946
            #
947
            #   Determine if there are any checked out files in the view
948
            #
949
            Message("Remove the view: $VIEWDIR");
950
            Verbose("Look for checked out files");
267 dpurdie 951
 
952
 
1403 dpurdie 953
            SvnRmView ('path'     => $workSpace,
954
                       'force'    => ($opt_delete > 1) || ($opt_extract > 1),
299 dpurdie 955
                       'modified' => [ 'local_dpkg_archive' ] );
956
        }
2040 dpurdie 957
        Warning ("View was not deleted. Will Delete view directory")
1403 dpurdie 958
            if ( -d $workSpace );
361 dpurdie 959
        RmDirTree( $VIEWDIR ) if $opt_path;
267 dpurdie 960
    }
299 dpurdie 961
 
267 dpurdie 962
    Error ("View was not deleted")
299 dpurdie 963
        if ( -d $VIEWDIR );
267 dpurdie 964
}
965
 
966
#-------------------------------------------------------------------------------
967
# Function        : copy_directory
968
#
969
# Description     : Copy a directory tree
970
#
971
# Inputs          : Source directory
972
#                   Target directory
973
#                   Strip
974
#
975
#                   Should be full pathnames
976
#
977
# Returns         :
978
#
979
my $copy_error;
980
my $copy_count;
981
sub copy_directory
982
{
983
    our ($src_dir, $dest_dir, $strip) = @_;
984
    our $slength = length ($strip);
985
 
986
    #
987
    #   Prevent File::Find from generating warnings
988
    #
989
    no warnings 'File::Find';
990
 
991
 
992
    #
993
    #   Helper routine to copy files
994
    #
995
    sub copy_file_wanted
996
    {
997
        #
998
        #   Do not copy directories
999
        #   Just make the directory entry. May result in empty directories
1000
        #
1001
        if ( -d $_ )
1002
        {
1003
            my $tdir = "$dest_dir/" . substr( $File::Find::dir, $slength);
1004
            $tdir .= "/$_";
1005
            File::Path::mkpath( $tdir )
1006
                unless ( -d $tdir);
1007
            return;
1008
        }
1009
 
1010
        #
1011
        #   When used to copy file from within a clearcase dynamic view the
1012
        #   files may not actually exist. This will generate an error later
1403 dpurdie 1013
        #   so check for existence of file file now.
267 dpurdie 1014
        #
1015
        return unless ( -e $_ );
1016
 
1017
        #
1018
        #   Have been chdir'ed to the source directory
1019
        #   when invoked
1020
        #
1021
        my $tdir = "$dest_dir/" . substr( $File::Find::dir, $slength);
1022
        my $tfile = "$tdir/$_";
1023
        my $sfile = "$File::Find::dir/$_";
1024
        Verbose ("Copy: $sfile -> $tfile");
1025
 
1026
        File::Path::mkpath( $tdir )
1027
            unless ( -d $tdir);
1028
 
1029
        unlink ( $tfile )
1030
            if ( -f $tfile );
1031
 
1032
        if( ! File::Copy::copy ( $_ , $tfile ) )
1033
        {
1034
            $copy_error++;
1035
            Message "Error copying $sfile";
1036
        }
1037
        else
1038
        {
1039
            my $perm = (stat $_)[2] & 07777;
1040
            chmod($perm, $tfile);
1041
 
1042
            $copy_count++;
1043
        }
1044
    }
1045
 
1046
    #
1047
    #   Locate all files to copy
1048
    #
1049
    $copy_error = 0;
1050
    $copy_count = 0;
1051
    File::Find::find ( \&copy_file_wanted, $src_dir );
1052
    return $copy_error;
1053
}
1054
 
1055
#-------------------------------------------------------------------------------
1056
# Function        : count_files
1057
#
1058
# Description     : Count files in a workspace
1059
#                   Ignore .svn stuff
1060
#
1061
# Inputs          : Source directory
1062
#
1063
# Returns         :
1064
#
1065
sub count_files
1066
{
1067
    my ($src_dir) = @_;
1068
 
1069
    #
1070
    #   Prevent File::Find from generating warnings
1071
    #
1072
    no warnings 'File::Find';
1073
 
1074
 
1075
    #
1076
    #   Helper routine to copy files
1077
    #
1078
    sub count_file_wanted
1079
    {
1080
        #
1081
        #   Do not count dirs, only files
1082
        #
1083
        return if ( -d $_ );
1084
        $copy_count++;
1085
    }
1086
 
1087
    #
1088
    #   Locate all files
1089
    #
1090
    $copy_count = 0;
1091
    File::Find::find ( \&count_file_wanted, $src_dir );
1092
}
1093
 
1094
 
1095
#-------------------------------------------------------------------------------
1096
# Function        : extract_files_from_view
1097
#
1098
# Description     : This function will
1403 dpurdie 1099
#                       Extract the files from the required source
1100
#                       This is a simple operation under subversion
267 dpurdie 1101
#
1102
#                   Its used in the creation of escrow directories
1103
#
1104
# Inputs          : None
1105
#                   All done via globals
1106
#
1107
# Returns         : 
1108
#
1109
sub extract_files_from_view
1110
{
1111
    #
1112
    #   Determine the target directory for the extracted files
1113
    #       Delete the output subdir
1114
    #       Create the config spec in that directory
1115
    #
1116
    Verbose("Extracting files into $VIEWDIR");
1117
    if ( -d $VIEWDIR )
1118
    {
1119
        Verbose "Delete Directory: $VIEWDIR\n";
361 dpurdie 1120
        RmDirTree( $VIEWDIR );
267 dpurdie 1121
    }
1122
 
1403 dpurdie 1123
    #
1124
    #   Determine URL to extract
1125
    #       work : Same as exact
1126
    #       exact: Use user provided tag
1127
    #              No need to backtrack to the branch and then
1128
    #              Update files
1129
    #
1130
    #       tag:   Don't update build files
1131
    #              This is different normal mode
1132
    #              Perhaps should change to be the same as exact - just extract
1133
    #              the user provided tag
1134
    #
1135
    #       tip:   Don't update build files
1136
    #
1137
    my $view_tag;
1138
    if ( $opt_devMode eq 'tip' ) {
1139
        $view_tag =  $urlDevBranchHead;
1140
    } elsif ( $opt_devMode eq 'tag' ) {
1141
        $view_tag = $initialUrlBranch;
1142
    } else {
1143
        $view_tag = $initialUrl;
1144
    }
267 dpurdie 1145
 
1403 dpurdie 1146
    $svnSession->SvnCo ( $svnSession->FullPath() . '/' . $view_tag,
1147
                        $VIEWDIR,
1148
                        'export' => 1,
2429 dpurdie 1149
                        'escrow' => $opt_escrow,
1403 dpurdie 1150
                        'print' => 0 );
1151
 
267 dpurdie 1152
    #
1153
    #   Count this files in the view
1403 dpurdie 1154
    #   Done so that its clear when we have a empty workspace in escrow extractions
267 dpurdie 1155
    #
1156
    Verbose ("Examine View contents");
1157
    count_files ( $VIEWDIR );
2764 dpurdie 1158
    Error ('ExitCode=10', DisplayPath("View files in: $VIEWDIR, but no files were extracted"))
1159
        unless ($copy_count);
267 dpurdie 1160
    Message ("View files in: $VIEWDIR, Files: $copy_count" );
1403 dpurdie 1161
}
267 dpurdie 1162
 
1403 dpurdie 1163
#-------------------------------------------------------------------------------
1164
# Function        : importTagChanges
1165
#
1166
# Description     : import changes from a 'tag' into the target workspace
1167
#                   Use with a workspace as well as an exported target
1168
#
1169
# Background      :
1170
#   The workspace has been created on the branch from which the tag was taken
1171
#   BUT this may not be the same as the tag because:
1172
#       1) Developer is not respecting the use of tags
1173
#       2) The automated build system will place the rippled build files
1174
#          within the tag.
1175
#   The most effective way that I have found of getting the modified build
1176
#   files into the workspace is to:
1177
#       Parse the log of the tag
1178
#       Determine files that have been modified as a part of the tag
1179
#       export them into the workspace
1180
#
1181
#   If we are creating a workspace that we are about to branch, then
1182
#   we use 'switch' to copy in the new file
1183
#   Otherwise, use a 'co -export'. If we use a switch, then the files
3045 dpurdie 1184
#   that have been switched in cannot be commited if changed as they will
1403 dpurdie 1185
#   be within the 'tags' area.
1186
#
1187
# Inputs          : None
1188
#                   Globals
1189
#
1190
# Returns         : Error code
1191
#
1192
sub importTagChanges
1193
{
1194
    return unless ( $tagLabel );
1195
    my $data = $svnSession->{SavedBackTrack};
1196
    Error ("Internal: importTagChanges expects backtracking to have been performed")
1197
        unless (defined $data);
1198
 
1199
#    DebugDumpData("importTagChanges", $svnSession );
1200
#    DebugDumpData("Data", $data );
1201
 
1202
    #
1203
    #   Process the data from the backtrack log and determine the files
1204
    #   that we need to transfer.
1205
    #       Should only be one - but if the users have been bad
1206
    #       then there may be more.
1207
    #
1208
    if ( $data->{files} )
1209
    {
1210
        foreach my $srcFile ( reverse @{$data->{files}} )
1211
        {
1212
            Verbose("importTagChanges: $srcFile");
1213
            my $sfile = $svnSession->FullPath() . '/' . $srcFile;
1447 dpurdie 1214
 
1215
            #
2764 dpurdie 1216
            #   Calculate path within the repo of the target file
1447 dpurdie 1217
            #
2764 dpurdie 1218
            unless($srcFile =~ m~tags/.*?(/.*)@\d+~)
1219
            {
1220
                #
1221
                #   Only seen this error under a condition where the user
1222
                #   tagged a parent directory. ie:
1223
                #       aaa/bbbb/tags/badTag was a copy of aaa
1224
                #
1225
                Error ("importTagChanges. Unexpected format of filename: $srcFile",
1226
                       "Possible cause: Incorrect tag placement");
1227
            }
1447 dpurdie 1228
            my $tfile = $workSpace . $1;
1229
 
3045 dpurdie 1230
            if ( $opt_mkbranch )
1403 dpurdie 1231
            {
1447 dpurdie 1232
                $svnSession->SvnSwitch ($sfile, $tfile);
1403 dpurdie 1233
            }
1234
            else
1235
            {
1447 dpurdie 1236
                $svnSession->SvnCo ($sfile, $tfile,
1403 dpurdie 1237
                                        'export' => 1,
1238
                                        'force' => 1,
2429 dpurdie 1239
                                        'escrow' => $opt_escrow,
1403 dpurdie 1240
                                        'pretext' => 'Replacing ' );
1241
            }
1242
        }
1243
    }
267 dpurdie 1244
}
1245
 
1246
#-------------------------------------------------------------------------------
1403 dpurdie 1247
# Function        : determineChangedFiles
1248
#
1249
# Description     : Display a list of files that have been changed between
1250
#                   the tagPoint and the head of the branch
1251
#
1252
# Inputs          : Only Globals
1253
#
1254
# Returns         : Will not return if changes are not allowed
1255
#
1256
sub determineChangedFiles
1257
{
1258
    my @msgText;
2040 dpurdie 1259
    my $onlyWarn = ($checkDelta == 1);
267 dpurdie 1260
 
1403 dpurdie 1261
    #
1262
    #   No checking required
1263
    #   Skip the hard bit if running on a build machine
1264
    #
1265
    return unless ( $checkDelta );
2764 dpurdie 1266
    return if ( $onlyWarn && ! $devBranch && ! $tagLabelBranch );
267 dpurdie 1267
 
1403 dpurdie 1268
    Debug ('determineChangedFiles');
1269
#debugDumpRefInfo('determineChangedFiles');
1270
 
1271
    #
1272
    #   Examine the HEAD of the development branch and determine if there
1273
    #   have been any changes since the tag was taken
1274
    #
1275
    #   Determine the Repo Revision for the HEAD of the devBranch
1276
    #
1277
    Error ("Internal: No devBranch calculated") unless ( $devBranch || $tagLabelBranch );
1278
 
1279
    my $basePeg = $tagLabelBranchPeg || $devBranchPeg;
1280
    my $baseBranch = $tagLabelBranch || $devBranch;
1281
    Error ("Internal logic. Expecting tagLabelBranchPeg or devBranchPeg to be defined") unless ( $basePeg );
1282
    Error ("Internal logic. Expecting tagLabelBranch or devBranch to be defined") unless ( $baseBranch );
1283
 
1284
    my $svn_check = NewSessionByUrl ( join( '/', $srcPathPkg, $baseBranch), 1 );
1285
    my $rv = $svn_check->SvnInfo( $svn_check->Full, 'InfoRepo' );
1286
    if ( $rv )
1287
    {
1288
        push (@msgText, "Cannot read information for the head of the development branch",
1289
                        "Branch may not exist: $baseBranch");
2040 dpurdie 1290
        $onlyWarn = 1;
1403 dpurdie 1291
    }
1292
    else
1293
    {
1294
        $devBranchHead = $svn_check->{'InfoRepo'}{'Last Changed Rev'};
1295
        Verbose2("devBranchHead: $devBranchHead");
1296
    #debugDumpRefInfo('Dev Branch Head');
1297
 
1298
 
1299
        #
1300
        #   If the Rev of the HEAD is greater than the point at which we
1301
        #   are interested then changes may have occured. Otherwise we know
1302
        #   that changes cannot have occured
1303
        #
1304
        if ( $devBranchHead <= $basePeg )
1305
        {
1306
            return;
1307
        }
1308
 
1309
        if ( $tagLabelBranchPeg )
1310
        {
1311
            push @msgText,  "Development Branch has changed since Tag was taken",
1312
                            "Head last changed in Rev: $devBranchHead",
1313
                            "Tag traced back to Rev  : $basePeg";
1314
        } else
1315
        {
1316
            push @msgText,  "Development Branch has changed since specified version",
1317
                            "Head last changed in Rev: $devBranchHead",
1318
                            "Specified branch Rev    : $basePeg";
1319
        }
1320
 
1321
 
1322
        my $diffBase = $svn_check->FullPath() . '/' . $baseBranch;
1323
        $svn_check->{tmp}{path_length} = length($diffBase);
1324
        $svn_check->{tmp}{count}  = 0;
1325
        @{$svn_check->{tmp}{files}}  = ();
1326
 
1327
        $rv = $svn_check->SvnCmd ( 'diff', '--summarize',
1328
                                   $diffBase,
1329
                                   '--revision', $basePeg . ':HEAD',
1330
                                   {
1331
                                        'process' => \&ProcessDiff,
1332
                                        'credentials' => 1,
1333
                                        'nosavedata' => 1,
1334
                                   }
1335
                                );
1336
        #
1337
        #   Prepare message to be displayed
1338
        #   Prepend text to the list of files
1339
        #
1340
 
1341
        $rv = $svn_check->{tmp}{count};
1342
        return unless ( $rv );
1343
        push (@msgText, "No files changed") unless ( $rv );
1344
        push (@msgText, "Changed file count: $rv") if ( $rv );
1345
        push (@msgText, "More than 10 files have changed. First 10 are:") if ( $rv > 10);
1346
        push (@msgText, @{$svn_check->{tmp}{files}} );
1347
    }
1348
 
2040 dpurdie 1349
    if ($onlyWarn) {
1403 dpurdie 1350
        push @messageText, @msgText;
1351
    } else {
1352
        Error ( @msgText );
1353
    }
1354
}
1355
 
1356
sub ProcessDiff
1357
{
1358
    my $self = shift;
1359
    my $data = shift;
1360
 
1361
    #
1362
    #   Extract filename from line
1363
    #       First 8 chars are status
1364
    #       Remove WS path too
1365
    #
1366
    my $path_length = $self->{tmp}{path_length} + 1 + 8;
1367
    if ( length $data >= $path_length )
1368
    {
1369
        my $file = substr ( $data, $path_length );
1370
        push @{$self->{tmp}{files}}, '  Changed: ' .  $file
1371
            if ( $self->{tmp}{count}++ < 10 );
1372
    }
1373
 
1374
    return 0;
1375
}
1376
 
267 dpurdie 1377
#-------------------------------------------------------------------------------
1403 dpurdie 1378
# Function        : parseSubversionRef
1379
#
1380
# Description     : Parse the user-provided Subversion Ref
1381
#
1382
#                   Convert label with embedded VCS information into a 'normal' form.
1383
#                   Form:
1384
#                       SVN::<SourcePath>::<Label>
1385
#                       SVN::<SourcePath>::<Peg>
1386
#                   
1387
#                   Allow optional 'SVN::' prefix
1388
#                   Allow Full or Symbolic URL
1389
#                       [SVN::]<SourcePath>::<Label>
1390
#                       [SVN::]<SourcePath>::<Peg>
1391
#                       [SVN::]<URL>
1392
#
1393
# Inputs          : $opt_spec               - User Provided Ref
1394
#
1395
# Returns         : Will not retirn on gross error
1396
#                   Values return in global variables
1397
#
1398
sub parseSubversionRef
1399
{
1400
    my ($opt_spec) = @_;
1401
 
1402
    $opt_spec =~ s~^SVN::~~;
1403
    if ( $opt_spec =~ m~(.+)::(.+)~ )
1404
    {
1405
        my $sourcePath = $1;
1406
        my $label = $2;
1407
        $urlType = 'jats';
1408
 
1409
        #
1410
        #   Sanity test of sourcePath
1411
        #
1412
        Error ("Invalid use of a peg: $opt_spec[0]")
1413
            if ( $sourcePath =~ m~\@\d+$~ );
1414
 
1415
        #
1416
        #   Remove anything after a ttb (truck, tags, branch) element
1417
        #   This will be the root of the package within the repo
1418
        #
1419
        if (  $sourcePath =~ m~(.*)/((tags|branches|trunk)(/|$)(.*))~ )
1420
        {
1421
            Error ("Source Path has insufficient items")
1422
                if ( $1 eq '' );
1423
 
1424
            Error ("SourcePath contains invalid items after '$3': '$5'")
1425
                if ( ($3 eq 'tags' || $3 eq 'trunk') && $5 ne '' );
1426
 
1427
            Error ("SourcePath must contain items after 'branches'")
1428
                if ( $3 eq 'branches' && $5 eq '');
1429
 
1430
            $srcPathPkg = $1;
1431
            $ttbType = $3;
1432
            $devBranch = $3;
1433
            $devBranch .= '/' . $5 if ( $5 ne '' );
1434
        }
1435
        else
1436
        {
1437
            Error ("Source Path does not contain tags or trunk or branches component");
1438
        }
1439
 
1440
        #
1441
        #   Pull apart the 2nd argument
1442
        #   May be a raw peg - on the development branch
1443
        #   May be a tag and a peg
1444
        #
1445
        $initialUrl = $srcPathPkg;
1446
        if ( $label =~ m~^@*(\d+)$~ )
1447
        {
1448
            # Full numeric label - is a peg on the development branch
1449
            $devBranchPeg = $1;
1450
            $initialUrl .= '/' . $devBranch . '@' . $devBranchPeg;
1451
        }
1452
        elsif ( $label =~ m~^([^@]+)@(\d+)$~ )
1453
        {
1454
            $tagLabel = 'tags/' . $1;
1455
            $tagPeg = $2;
1456
            $initialUrl .= '/tags/' . $label;
1457
 
1458
        }
1459
        elsif ( $label !~ m~@~ )
1460
        {
1461
            $tagLabel = 'tags/' . $label;
1462
            $initialUrl .= '/tags/' . $label;
1463
        }
1464
        else
1465
        {
1466
            Error ("Subversion Tag badly formed: $label");
1467
        }
1468
    } elsif ($opt_spec =~ m~::~) {
1469
        Error ("Badly formed Subversion Reference: $opt_spec[0]");
1470
 
1471
    }
1472
    else
1473
    {
1474
        # Have a full URL and not a JATS enhanced spec
1475
        # Cannot determine the development branch and the tag
1476
        #
1477
        $urlType = 'url';
1478
        $initialUrl = $opt_spec;
1479
 
1480
        # Extact any peg
1481
        my $peg;
1482
        if ( $opt_spec =~ m~(.*)@(\d+)$~ )
1483
        {
1484
            $opt_spec = $1;
1485
            $peg = $2;
1486
        }
1487
 
1488
        if (  $opt_spec =~ m~(.*)/((tags|branches|trunk)(/|$)(.*))~ )
1489
        {
1490
            Error ("Subversion URL has insufficient items")
1491
                if ( $1 eq '' );
1492
            $srcPathPkg = $1;
1493
            $ttbType = $3;
1494
 
1495
            if ( $ttbType eq 'trunk' ) {
1496
                Error ("Subversion URL must NOT contain items after '$ttbType'")
1497
                    if ( $5 ne '' );
1498
                $devBranch = $2;
1499
                $devBranchPeg = $peg;
1500
 
1501
            } elsif ( $ttbType eq 'tags' ) {
1502
                Error ("Subversion URL must contain items after '$ttbType'")
1503
                    unless ( $5 ne '' );
1504
                $tagLabel = $2;
1505
                $tagPeg = $peg;
1506
 
1507
            } else {
1508
                Error ("Subversion URL must contain items after '$ttbType'")
1509
                    unless ( $5 ne '' );
1510
                $devBranch = $2;
1511
                $devBranchPeg = $peg;
1512
            }
1513
        }
1514
        else
1515
        {
1516
            Error ("Subversion URL does not contain tags or trunk or branches component");
1517
        }
1518
    }
1519
    #debugDumpRefInfo('First Parse');
1520
}
1521
 
1522
#-------------------------------------------------------------------------------
1456 dpurdie 1523
# Function        : calcViewName
1524
#
1525
# Description     : Calculate a nice name for the view
3859 dpurdie 1526
#                   Try to keep short and informative
1527
#                       Some legacy tools hate long paths.
1528
#                       See Jira issue: JATS-274
1456 dpurdie 1529
#                   Try to base the name on the tag
1530
#
1531
#                   If the URL looks like a TTB then we can make some guesses
1532
#                   as to the package name and version.
1533
#
1534
#                   Add indication for the Dev Mode
1535
#                   Add indication for a branch
1536
 
1537
#
1538
# Inputs          : Nothing
1539
#
3859 dpurdie 1540
# Returns         : A 'nice' ViewName
1541
#                   Will not return on error
1456 dpurdie 1542
#
1543
sub calcViewName
1544
{
1545
    #
1546
    #   Use the user provided view name if its valid
1547
    #
1548
    if ( $opt_viewname )
1549
    {
1550
        Error ("View Name contains invalid characters" )
1551
            unless ( $opt_viewname =~ m~^[0-9a-z]([-.:0-9a-z_]*[0-9a-z])?$~i );
1552
        return $opt_viewname ;
1553
    }
1554
 
1555
    #
1556
    #   Create a view name based on the provide URL or SVN Reference
1557
    #
1558
    my $version;
1559
    my $name = $srcPathPkg;
3859 dpurdie 1560
    my $isaWIP;
1561
 
1456 dpurdie 1562
    $name =~ s~.*/~~;
1563
 
1564
    if ( $tagLabel )
1565
    {
1566
        $version = $tagLabel;
1567
        $version =~ s~.*/~~;
3859 dpurdie 1568
        $isaWIP = $version =~ m~\.WIP$~;
1569
 
1570
        # Remove package name from the tag
1571
        # Allow for WIPs too
1572
        #       XXXX_nnnn.ppp.WIP   WIP: Name is upper case. Join is.
1573
        #       xxxx_nn.nn.nn.ppp   TAG: Name is same case. Join is _
1574
        $version = $1 if ( $version =~ m~^${name}[_.](.*)~i );
1456 dpurdie 1575
    }
1576
    elsif ( $devBranch )
1577
    {
1578
        $version = $devBranch;
4446 dpurdie 1579
        $version =~ s~.*?/~~;
1456 dpurdie 1580
    }
1581
 
1582
    if ( $version && $name )
1583
    {
1584
        $opt_viewname = join( '_', $name, $version);
1585
    }
1586
    elsif ( $svnSession->Type )
1587
    {
1588
        $opt_viewname = $svnSession->Path;
1589
        $opt_viewname .= '_' . ($svnSession->Version || 'trunk') unless $opt_branch;
1590
 
1591
        #
1592
        #   Tags and Branches 'should' include the package name
1593
        #   This will lead to a duplication of the package name
1594
        #   ie: aaaaa/package/tags/package_version
1595
        #   Attempt to remove these
1596
        #
1597
        if ( $opt_viewname =~ s~[_/]([\-.:0-9a-zA-Z]+)_\1_~_$1_~ )
1598
        {
1599
            Verbose ("Removed duplicate package name: $1 from $opt_viewname");
1600
        }
1601
    }
1602
    else
1603
    {
1604
        $opt_viewname = $svnSession->Path;
1605
        $bad_label_name = 1;
1606
    }
1607
 
1608
    #
1609
    #   Append the peg if provided
3859 dpurdie 1610
    #       Not if creating a 'tip' as its a bit meaningless
1611
    #       Not if a WIP as it should have been provided and is not noise
1456 dpurdie 1612
    #
1613
    if ( my $peg = $tagPeg || $devBranchPeg )
1614
    {
3859 dpurdie 1615
        unless( $opt_devMode eq 'tip' || $isaWIP)
1456 dpurdie 1616
        {
1617
            $opt_viewname .= '_' . $peg;
1618
        }
1619
    }
1620
 
1621
    #
1622
    #   Append information to indicate the exact type of the WorkSpace
1623
    #   Normally mutually exclusive
1624
    #
1625
    $opt_viewname .= '_Tip' if ( $opt_devMode eq 'tip' );
1626
    $opt_viewname .= '_Tag' if ( $opt_devMode eq 'tag' );
1627
    $opt_viewname .= '_Exact' if ( $opt_devMode eq 'exact' );
1628
    $opt_viewname .= '_' . $opt_branch if ( $opt_branch );
1629
 
1630
    #
1631
    #   Create a simple dir name
1632
    #       Remove path sep characters and replace with _
1633
    #       Remove Peg marker (@) as this breaks svn
1634
    #       Replace multiple _ with a single _
1635
    #       Remove trailing _ - caused by URL with a trailing /
1636
    #
1637
    $opt_viewname =~ s~[^\-.:0-9a-zA-Z_]~_~g;
1638
    $opt_viewname =~ tr~_~_~s;
1639
    $opt_viewname =~ s~_+$~~;
1640
    return $opt_viewname;
1641
}
1642
 
1643
#-------------------------------------------------------------------------------
1403 dpurdie 1644
# Function        : debugDumpRefInfo
1645
#
1646
# Description     : Dump the current Ref Information
1647
#
1648
# Inputs          : $text
1649
#
1650
# Returns         : 
1651
#
1652
sub debugDumpRefInfo
1653
{
1654
    Verbose0 ('-' x 40);
1655
    Verbose0 ('debugDumpRefInfo:' , @_ );
1656
    Verbose0 ('ttbType           :', $ttbType);
1657
    Verbose0 ('urlType           :', $urlType);
1658
    Verbose0 ('Base              :', $svnSession->FullPath() ) if $svnSession;
1659
    Verbose0 ('initialUrl        :', $initialUrl);
1660
    Verbose0 ('srcPathPkg        :', $srcPathPkg);
1661
    Verbose0 ('devBranch         :', $devBranch);
1662
    Verbose0 ('devBranchPeg      :', $devBranchPeg);
1663
    Verbose0 ('devBranchHead     :', $devBranchHead);
1664
    Verbose0 ('tagLabel          :', $tagLabel);
1665
    Verbose0 ('tagPeg            :', $tagPeg);
1666
    Verbose0 ('tagLabelBranch    :', $tagLabelBranch);
1667
    Verbose0 ('tagLabelBranchPeg :', $tagLabelBranchPeg);
1668
}
1669
 
1670
#-------------------------------------------------------------------------------
1671
 
1672
 
1673
#-------------------------------------------------------------------------------
267 dpurdie 1674
#   Documentation
1675
#
1676
 
1677
=pod
1678
 
361 dpurdie 1679
=for htmltoc    GENERAL::Subversion::
1680
 
267 dpurdie 1681
=head1 NAME
1682
 
1683
jats_svnrelease - Build a package given a SubVersion label
1684
 
1685
=head1 SYNOPSIS
1686
 
1687
  jats svnrelease [options] [-label=]label
1688
 
1689
 Options:
1690
    -help              - brief help message
1691
    -help -help        - Detailed help message
1692
    -man               - Full documentation
1693
    -label=xxx         - Subversion label
1694
    -spec=xxx          - Same as -label=xxx
1695
    -path=xxx          - Source Path
1696
    -view=xxx          - Modify the name of the created view
1697
    -build=xxx         - Package Name to build
1698
    -root=xxx          - Root directory for generated view
2040 dpurdie 1699
    -[mk]branch=xxx    - Will create/use a branch
1403 dpurdie 1700
    -tag=xxx           - Compatibility. Not used
267 dpurdie 1701
    -extract           - Extract the view and exit
1702
    -extractfiles      - Extract files, without a view
1403 dpurdie 1703
    -devMode=xxx       - Create Workspace suitable for development.(Tip,Tag,...)
267 dpurdie 1704
    -cache             - Refresh local dpkg_archive cache
361 dpurdie 1705
    -delete[=n]        - Remove any existing view and exit
267 dpurdie 1706
    -debugOnly         - Make only the debug version
1707
    -prodOnly          - Make only the production version
1708
    -[no]dpkg          - Transfer package into dpkg_archive
1709
    -[no]copy          - Transfer pkg directory to the current user directory
1710
    -[no]reuse         - Reuse the view
1711
    -[no]test          - Test package build. Implies nocopy and nodpkg
1712
    -[no]keep          - Keep the view after the build
1713
    -[no]beta          - Release a beta package
1714
    -[no]merge         - Merge packages into dpkg_archive
1715
    -[no]runtests      - Run units tests. Default is runtests
1403 dpurdie 1716
    -[no]prefix        - Suppress user prefix in view name. Default prefix is USER
267 dpurdie 1717
 
1718
=head1 OPTIONS
1719
 
1720
=over 8
1721
 
1722
=item B<-help>
1723
 
1724
Print a brief help message and exits.
1725
 
1726
=item B<-help -help>
1727
 
1728
Print a detailed help message with an explanation for each option.
1729
 
1730
=item B<-man>
1731
 
1732
Prints the manual page and exits.
1733
 
1734
=item B<-label> or B<-spec>
1735
 
1403 dpurdie 1736
The Subversion label to use as the base for the workspace. The utility will
1737
accept the following forms of label identifier, each with an optional 'SVN::' prefix.
267 dpurdie 1738
 
1403 dpurdie 1739
=over 4
267 dpurdie 1740
 
1403 dpurdie 1741
=item Full URL
1742
 
1743
This form is identified by the complete lack of the '::' subfield delimiter. The
1744
URL is used as provided. It is not modified.
1745
 
1746
 Eg: AUPERASVN01/DPG_SWBASE/daf_utils_math/tags/daf_utils_math_3.2.1@12345
1747
 Eg: https://auperasvn01.aupera.erggroup.com/svn/DPG_SWBASE/daf_utils_math/tags/daf_utils_math_3.2.1@12345
1748
 
1749
 
1750
=item SourcePath::Tag
1751
 
1752
The SourcePath component is used to calculate the root of the package directory.
1753
The source path is then caclulated assuming that the 'Tag' exists within a
1754
'/tags' subdirectory of the root of the package.
1755
 
1756
This is the form preferred by Release Manager and the VIX build system.
1757
 
1758
 Eg: AUPERASVN01/DPG_SWBASE/daf_utils_math/trunk::daf_utils_math_3.2.1@12345
1759
 
1760
=item SourcePath::Peg
1761
 
1762
A special case of of the 'SourcePath::Tag' form is invoked if the 'Tag' component
1763
is numeric. It will be treated as a peg of the Base Path.
1764
 
1765
 Eg: AUPERASVN01/DPG_SWBASE/daf_utils_math/trunk::12345
1766
 
1767
=back
1768
 
267 dpurdie 1769
=item B<-view name>
1770
 
1771
Specified an alternate view name and tag to be used. This option does not provide the
1772
full name of the view.
1773
 
361 dpurdie 1774
The view path will be: "${USER}_${NAME}"
267 dpurdie 1775
 
1776
The default "NAME" is the first label specified with the repository and tag removed.
1777
 
1778
If the user provides a view "name" that is prefixed with their user name
1779
('${USER}_'), then the username will be stripped of for internal processing.
1780
This allows a user to provide a view path when deleting a view.
1781
 
1782
=item B<-path=xxx>
1783
 
1784
Specifies the source path to the root of the extracted file tree. This option is
1403 dpurdie 1785
not mandatory and is only used to maintain toolset compatibility with other
267 dpurdie 1786
,similar, tools.
1787
 
1788
If provided, then the Workspace will be created within the named subdirectory
1789
tree within the base of the view.
1790
 
1791
=item B<-build=xxx>
1792
 
1793
This option allows the user to specify the packages to be built and the
1794
order in which the packages are to be built.
1795
This is useful if the extracted view contains multiple build files
1796
 
1797
This option may be used multiple times.
1798
 
1799
There are two forms in which the build target can be specified. It can be
1403 dpurdie 1800
specified as a full package name and version, or as a package name and the
267 dpurdie 1801
project suffix.
1802
 
1803
By default the program will assume that there is only one build file in the
1804
view and will not build if multiple files are present, unless the package to be
1805
built can be resolved.
1806
 
1807
The location mechanism operates for both JATS and ANT build files.
1808
 
1809
Example: -build=jats-api.1.0.0000.cr
1810
 
1811
This will locate the build file that builds version 1.0.0000.cr of the jats-api
1812
package. The version numbers must match exactly.
1813
 
1814
Example: -build=jats-api.cr -build=jats-lib.cr
1815
 
1816
This will located the build files that build the jats_api (cr) package and the
1817
jats-lib (cr) package. The version of the packages will not be considered.
1818
 
1819
=item B<-root=xxx>
1820
 
1821
This option allows the location of the generated view to be specified on the
1403 dpurdie 1822
command line. It overrides the value of GBE_VIEWBASE.
267 dpurdie 1823
 
1403 dpurdie 1824
If the command is invoked within a development sandbox, then the default
267 dpurdie 1825
location will be the root directory of the development sandbox.
1826
 
2040 dpurdie 1827
=item B<-mkbranch=xxx>
267 dpurdie 1828
 
1329 dpurdie 1829
This option will create a workspace associated with a branch within the
1830
repository. This is intended to facilitate the maintenance of existing packages
2040 dpurdie 1831
and the creation of project or development branches.
267 dpurdie 1832
 
2040 dpurdie 1833
The named branch must not exist. It is an error for the branch to exist.
267 dpurdie 1834
 
2040 dpurdie 1835
This tool will copy the specified source version to the branch, create a
1836
workspace based on the branch and then switch to the branch.
267 dpurdie 1837
 
2040 dpurdie 1838
This option is intended to create a development thread, for project or private
1839
use.
1840
 
383 dpurdie 1841
A branch name of TIMESTAMP will be treated in special manner. The name will be
1842
replaced with a unique name based on the users name and the current date time.
1843
 
2040 dpurdie 1844
=item B<-branch=xxx>
1845
 
1846
This option will create a workspace associated with a branch within the
1847
repository. This is intended to facilitate the maintenance of existing packages
1848
and the creation of project or development branches in a manner similar to
1849
ClearCase.
1850
 
1851
The named branch must exist. It is an error for the branch to not exist.
1852
 
1853
If the named branch does exist, then this tool will create a workspace based
1854
on the head of the branch.
1855
 
1856
This option is intended to extract the tip of a development thread.
1857
 
351 dpurdie 1858
=item B<-tag=text>
1859
 
1860
This option is not used.
1403 dpurdie 1861
It is present to maintain compatibility with the buildtool interface.
351 dpurdie 1862
 
267 dpurdie 1863
=item B<-extract>
1864
 
1865
With this option the view is created and the left in place. The user may then
1866
access the files within the view. The view should not be used for a
1867
production release.
1868
 
1869
=item B<-extractfiles>
1870
 
1871
With this option the utility will create a dynamic view and transfer files from
1403 dpurdie 1872
the view to the user's target. The dynamic view is then removed.
267 dpurdie 1873
 
1874
This command is intended to simplify the process of creating an escrow.
1875
 
1403 dpurdie 1876
=item B<-devMode=mode>
1877
 
1878
This option controls the exact form of the Workspace create. The svnRelease
1879
command supports the following modes (default is working):
1880
 
1881
=over 4
1882
 
1883
=item   Tag or TagPoint
1884
 
1885
The workspace will contain the point on the packages development branch from
1886
which the specified tag was copied.
1887
 
1888
The extraction process will highlight file differences between the specified tag
1889
and the tip. If any differences are found then these will be treated as an error.
1890
 
1891
The user B<should> resolve this error by selecting, in Release Manager, a
1892
version of the package based on the tip of the Development Branch.
1893
 
1894
This is the preferred Development Mode for working on a package as it provides
1895
checks to ensure that the Meta Data held in Release Manager is consistient.
1896
 
1897
=item   Work or Working
1898
 
1899
The workspace will contain the point on the packages development branch from
1900
which the specified tag was copied.
1901
 
1902
The extraction process will highlight file differences between the specified tag
1903
and the tip of the Development Branch. Unlike the 'Tag' Mode, such differences
1904
are not treated as an error.
1905
 
1906
This mode of WorkSpace has several features and constraints:
1907
 
1908
=over 4
1909
 
1910
=item *
1911
 
1912
The build files from the 'tagged' version will be transferred into the
1913
WorkSpace. These will be seen as modified files.
1914
 
1915
=item *
1916
 
1917
This style of workspace can be converted into a 'Tip' style through the use of the
1918
Subversion 'update' command.
1919
 
1920
=item *
1921
 
1922
If there have been changes to the Development Branch, then it not be possible to
1923
'commit' the workspace. It may need to be branched first.
1924
 
1925
=back
1926
 
1927
=item Tip or BranchTip
1928
 
1929
The workspace will contain the 'tip' of the Packages Development Branch.
1930
 
1931
The extraction process will highlight file differences between the specified tag
1932
and the tip.
1933
 
1934
=item Exact
1935
 
1936
The workspace will be directly based on the Tag or URL provided by the user.
1937
 
1938
The resultant workspace may not be suitable for development.
1939
 
1940
The extraction process will highlight file differences between the specified tag
1941
and the tip of any associated Development Branch.
1942
 
1943
=back
1944
 
1945
The four extraction points are shouwn in the following image:
1946
 
1947
     /branches/...    /tags/...
1948
            v            v
1949
            |
1950
        +---+---+
1951
  [Tag] | Work  |    +-------+
1952
        +---+---+----+ Exact |
1953
            |        +-------+
1954
        +---+---+
1955
        |       |
1956
        +---+---+
1957
            |
1958
        +---+---+
1959
        |  Tip  |
1960
        +---+---+
1961
 
267 dpurdie 1962
=item B<-cache>
1963
 
1964
Forces external packages to be placed in the local dpkg_archive cache.
1965
 
1966
The normal operation is to copy the packages, only if they do not already exist
1967
in the local cache. This option may be used to ensure that the local copy is
1968
correct and up to date.
1969
 
361 dpurdie 1970
=item B<-delete[=level]>
267 dpurdie 1971
 
1972
Delete the view used by the program, if it exists. This option may be used to
1973
cleanup after an error.
1974
 
361 dpurdie 1975
The default 'level' is 1.
267 dpurdie 1976
 
361 dpurdie 1977
If the delete level is 1, then ensure that no files are open in the view and
1978
that the users current working directory is not in the view as these will
1979
prevent the view from being deleted.
1980
 
1981
If the delete level is greater than one, then the view will be deleted, even
1982
if there are checkout out files.
1983
 
267 dpurdie 1984
=item B<-debugOnly>
1985
 
1986
Make only the debug version of the package. The default it to create both the
1987
debug and production version of the package. The type of build may be  further
1988
limited by options within the package.
1989
 
1990
=item B<-prodOnly>
1991
 
1992
Make only the production version of the package. The default it to create both the
1993
debug and production version of the package. The type of build may be  further
1994
limited by options within the package.
1995
 
1996
=item B<-[no]dpkg>
1997
 
1998
Copy the generated package into dpkg_archive. This is the default mode of
1999
operation.
2000
 
2001
=item B<-[no]copy>
2002
 
2003
Copy the built "pkg" directory to the users current directory. The entire
2004
"pkg" subdirectory includes the full package named directory for the package
2005
that has been built.
2006
 
2007
=item B<-[no]reuse>
2008
 
2009
This flag allows the view created by the program to be re-used.
2010
 
2011
=over 8
2012
 
361 dpurdie 2013
=item *
267 dpurdie 2014
 
361 dpurdie 2015
The view is not deleted before being populated.
267 dpurdie 2016
 
361 dpurdie 2017
=item *
267 dpurdie 2018
 
361 dpurdie 2019
The view will not be populated if it does exist.
2020
 
2021
=item *
2022
 
2023
The view will not be deleted at the end the process.
2024
 
267 dpurdie 2025
=back
2026
 
2027
This option is useful for debugging a build process.
2028
 
2029
=item B<-[no]test>
2030
 
2031
Test the building of the package. This option implies "nocopy" and "nodpkg".
2032
 
2033
=item B<-[no]keep>
2034
 
361 dpurdie 2035
Keep the workspace after the build. The default option is "nokeep"
267 dpurdie 2036
 
2037
This option is different to the "reuse" in that the view will be deleted, if
2038
it exists, before the build, but will be retained at the completion of the
2039
process. The user may then manually extract the created package.
2040
 
2041
The view may be deleted with the the "delete" option; taking care to ensure that
2042
no files are open in the view and that the users current working directory is
2043
not in the view.
2044
 
2045
=item B<-[no]beta>
2046
 
2047
This option overrides many of the package release tests to allow a beta package
2048
to be released.
2049
 
2050
=item B<-[no]merge>
2051
 
2052
This option will merge packages being built on multiple machines into
2053
dpkg_archive. By default, if a package already exists in the archive it will be
2054
deleted and replaced. With this option the package will be merged. The merge
2055
process does not over write files found in the archive.
2056
 
2057
=item B<-[no]runtests>
2058
 
2059
This option will allow the suppression of the running of the unit tests included
2060
with the component. By default the tests are run. This can be suppressed
2061
without affecting the release process.
2062
 
2063
=back
2064
 
2065
=head1 DESCRIPTION
2066
 
2067
This program is the primary tool for the creation, recreation and release of
1329 dpurdie 2068
packages within the B<VIX> build environment, although the program can perform a
267 dpurdie 2069
number of very useful operations required during normal development and
2070
maintenance.
2071
 
2072
This program will build a system containing one or more inter-related build
2073
files using the JATS build tools.
2074
 
2075
In normal operation the program will:
2076
 
2077
=over 8
2078
 
2079
=item Remove Workspace
2080
 
2081
Remove any existing workspace of the same name. The workspace will not be
2082
removed if it contains checked-out files.
2083
 
2084
The workspace removal may fail if there are any files B<open> within the view or if
2085
any shell has a subdirectory of the view set as a B<current working directory>.
2086
 
2087
=item Create the workspace
2088
 
2089
Create a workspace to contain the files described by the Subversion
2090
label being processed.
2091
 
2092
=item Populate the workspace
2093
 
2094
Loads files into the workspace.
2095
 
2096
I<Note:> If the workspace files are simply being extracted, then this is the end
2097
of the program. The extracted workspace is left in place.
2098
 
2099
=item Sanity Test
2100
 
2101
If the build is being used as a release into dpkg_archive then
2102
various tests are performed to ensure the repeatability of the view and the
2103
build. These tests include:
2104
 
2105
=over 8
2106
 
361 dpurdie 2107
=item   *
267 dpurdie 2108
 
361 dpurdie 2109
The view must be constructed from one label
267 dpurdie 2110
 
361 dpurdie 2111
=item   *
267 dpurdie 2112
 
361 dpurdie 2113
That label must be pegged
267 dpurdie 2114
 
361 dpurdie 2115
=item   *
2116
 
2117
The labelled view must contain exactly one build file
2118
 
2119
=item   *
2120
 
2121
The view cannot have been re-used.
2122
 
267 dpurdie 2123
=back
2124
 
2125
=item Locate build files
2126
 
2127
Locate the build file within the view.
2128
 
2129
It is an error to have multiple build files within the workspace, unless the
2130
B<-build> option is used. By default, only one package will be built.
2131
 
2132
=item Package the results
2133
 
2134
Use JATS to build and make the package.
2135
 
2136
The resultant package may be copied to a numbers of locations. These include
2137
 
2138
=over 8
2139
 
2140
=item 1
2141
 
2142
The master dpkg_archive as an official release. This is the default operation.
2143
 
2144
=item 2
2145
 
2146
The users current directory. The package directory from the built package is
2147
copied locally. The "pkg" directory is copied. This is only performed with the
2148
B<-copy> option.
2149
 
2150
=back
2151
 
2152
=item Delete the workspace
2153
 
2154
Delete the workspace and all related files.
2155
 
2156
The workspace will not be deleted if an error was detected in the build process, or
2157
the "reuse" or "keep" options are present.
2158
 
2159
=back
2160
 
2161
=cut
2162