Subversion Repositories DevTools

Rev

Rev 7098 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
6914 dpurdie 1
package com.erggroup.buildtool.ripple;
2
 
3
import java.sql.SQLException;
4
import java.util.ArrayList;
5
import java.util.Collections;
6
import java.util.Iterator;
7
import java.util.List;
8
import java.util.ListIterator;
9
 
7033 dpurdie 10
import org.slf4j.Logger;
11
import org.slf4j.LoggerFactory;
6914 dpurdie 12
 
13
import com.erggroup.buildtool.ripple.BuildFile.BuildFileState;
14
import com.erggroup.buildtool.ripple.ReleaseManager.BuildReason;
15
import com.erggroup.buildtool.smtp.CreateUrls;
16
import com.erggroup.buildtool.smtp.Smtpsend;
17
import com.erggroup.buildtool.utilities.StringAppender;
18
import com.erggroup.buildtool.utilities.XmlBuilder;
19
 
20
/**Plans release impact by generating a set of Strings containing build file content.
21
 */
22
public class RippleEngine
23
{
24
 
25
    /**configured mail server
26
     * @attribute
27
     */
28
    private String mMailServer = "";
29
 
30
    /**configured mail sender user
31
     * @attribute
32
     */
33
    private String mMailSender = "";
34
 
35
    /**configured global email target
36
     * @attribute
37
     */
38
    private String mMailGlobalTarget = "";
39
 
40
    /** Vector of email addresses for global and project wide use
41
     *  Most emails will be sent to this list of email recipients
42
     */
43
    public List<String> mMailGlobalCollection = new ArrayList<String>();
44
 
45
    /**name associated with the baseline
46
     * @attribute
47
     */
48
    public String mBaselineName = "";
49
 
50
    /**Collection of build exceptions associated with the baseline
51
     * Used to determine (and report) what change in build exceptions happens as part of planRelease
52
     * Daemon centric
53
     * @aggregation shared
54
     * @attribute
55
     */
56
    ArrayList<BuildExclusion> mBuildExclusionCollection = new ArrayList<BuildExclusion>();
57
 
58
    /**Logger
59
     * @attribute
60
     */
7033 dpurdie 61
    private static final Logger mLogger = LoggerFactory.getLogger(RippleEngine.class);
6914 dpurdie 62
 
63
    /** Escrow information - commands to set up escrow
64
     * @attribute
65
     */
66
    private String mEscrowSetup;
67
 
68
    /** Escrow information - Raw data (May not be used)
69
     * @attribute
70
     */
71
    private String mEscrowRawData;
72
 
7048 dpurdie 73
    /** Collections of packages
6914 dpurdie 74
     */
75
    private ArrayList<Package> mPackageCollection = new ArrayList<Package>();
7048 dpurdie 76
    private ArrayList<Package> mPackageCollectionWip = new ArrayList<Package>();
77
    private ArrayList<Package> mPackageCollectionTest = new ArrayList<Package>();
78
    private ArrayList<Package> mPackageCollectionRipple = new ArrayList<Package>();
79
    private ArrayList<Package> mPackageCollectionAll = new ArrayList<Package>();
80
 
6914 dpurdie 81
 
82
    /**index to current String item
83
     * @attribute
84
     */
85
    private int mBuildIndex;
86
 
87
    /**Database abstraction
88
     * @attribute
89
     */
90
    ReleaseManager mReleaseManager;
91
 
92
    /**Baseline identifier (rtag_id for a release manager baseline, bom_id for deployment manager baseline)
93
     * @attribute
94
     */
95
    private int mBaseline;
96
 
97
    /** Escrow Only: SBOM_ID
98
     */
99
    private int mSbomId;
100
 
101
    /** RTAG_ID
102
     *  Set from mBaseline
103
     */
104
    private int mRtagId;
105
 
106
    /**When true, mBuildCollection contains one item based on a release manager rtag_id and contains a daemon property
107
     * When false, mBuildCollection contains at least one item based on a deployment manager bom_id
108
     * Will be accessed by the Package class to calculate its mAlias
109
     * @attribute
110
     */
111
    public boolean mDaemon;
112
 
113
    /**collection of build file content in String form
114
     * @attribute
115
     */
116
    private ArrayList<BuildFile> mBuildCollection = new ArrayList<BuildFile>();
117
 
118
    /** List of packages that we plan to build
119
     * Used to provide feedback into RM
120
     * Only the first entry is about to be built as we re-plan every cycle
121
     */
7079 dpurdie 122
    private ArrayList<PlannedPackage> mBuildOrder = new ArrayList  <PlannedPackage>();
6914 dpurdie 123
    /**Warning message
124
     * @attribute
125
     */
126
    private static final String mAnyBuildPlatforms = "Warning. The following package versions are not reproducible on any build platform: ";
127
 
128
    /**Flag to control output to standard out
129
     * @attribute
130
     */
131
    private boolean mAnyBuildPlatformsFlag = true;
132
 
133
    /**Warning message
134
     * @attribute
135
     */
136
    private static final String mAssocBuildPlatforms = "Warning. The following package versions are not reproducible on the build platforms associated with this baseline: ";
137
 
138
    /**Flag to control output to standard out
139
     * @attribute
140
     */
141
    private boolean mAssocBuildPlatformsFlag = true;
142
 
143
    /**Warning message
144
     * @attribute
145
     */
146
    private static final String mNotInBaseline = "Warning. The following package versions are not reproducible as they are directly dependent upon package versions not in the baseline: ";
147
 
148
    /**Flag to control output to standard out
149
     * @attribute
150
     */
151
    private boolean mNotInBaselineFlag = true;
152
 
153
    /**Warning message
154
     * @attribute
155
     */
156
    private static final String mDependent = "Warning. The following package versions are not reproducible as they are directly/indirectly dependent upon not reproducible package versions: ";
157
 
158
    /**Flag to control output to standard out
159
     * @attribute
160
     */
161
    private boolean mDependentFlag = true;
162
 
163
    /**Warning message
164
     * @attribute
165
     */
166
    private static final String mCircularDependency = "Warning. The following package versions are not reproducible as they have circular dependencies: ";
167
 
168
    /**Flag to control output to standard out
169
     * @attribute
170
     */
171
    private boolean mCircularDependencyFlag = true;
172
 
173
    /** String used to terminate lines
174
     * @attribute
175
     */
176
    private static final  String mlf = System.getProperty("line.separator");
177
 
178
    /** XML File Prefix
179
     */
180
    private static final String mXmlHeader = "<?xml version=\"1.0\" encoding=\"ISO-8859-1\" ?>" + mlf;
181
 
182
    /**RippleEngine constructor
183
     * @param releaseManager  - Associated releaseManager instance
184
     * @param rtagId         - Release Identifier
185
     * @param isDaemon        - Mode of operation. False: Escrow, True: Daemon
186
     */
187
    public RippleEngine(ReleaseManager releaseManager, int rtagId, boolean isDaemon)
188
    {
7048 dpurdie 189
        mLogger.debug("RippleEngine rtag_id {} isDaemon {}", rtagId, isDaemon);
6914 dpurdie 190
        mReleaseManager = releaseManager;
191
        mBaseline = rtagId;
192
        mRtagId = rtagId;
193
        mDaemon = isDaemon;
194
        mReleaseManager.setDaemonMode(mDaemon);
195
    }
196
 
197
    /**
198
     * getRtagId
7048 dpurdie 199
     * @return The rtagId of the Release attached to this instance of the RippleEngine
6914 dpurdie 200
     */
201
    public int getRtagId()
202
    {
203
        return mRtagId;
204
    }
205
 
206
    /**Plan what is to be built
207
     * 	<br>Discards all build file content
208
     * 	<br>Generates new build file content
209
     * 
210
     * @param lastBuildActive 		- False. Daemon Mode. The last build was a dummy. 
211
     *                                This planning session may not result in a build
212
     *                              - True. Daemon Mode. The last build was not a dummy.
213
     *                                There is a very good chance that this planning session
214
     *                                will result in a build, so it is given priority to connect 
215
     *                                to the database.	
216
     */
217
    public void planRelease(final boolean lastBuildActive) throws SQLException, Exception
218
    {
7048 dpurdie 219
        mLogger.warn("planRelease mDaemon {}", mDaemon);
6914 dpurdie 220
 
221
        mBuildCollection.clear();
222
        mPackageCollection.clear();
7048 dpurdie 223
        mPackageCollectionRipple.clear();
224
        mPackageCollectionTest.clear();
225
        mPackageCollectionWip.clear();
6914 dpurdie 226
        mBuildOrder.clear();
227
        mEscrowRawData = "";
228
        mEscrowSetup = "";
229
        Phase phase = new Phase("Plan");
230
 
231
        // use finally block in planRelease to ensure the connection is released
232
        try
233
        {
234
            phase.setPhase("connectForPlanning");
235
            mReleaseManager.connectForPlanning(lastBuildActive);
236
 
237
            if ( mDaemon )
238
            {
239
                // claim the mutex
240
                mLogger.warn("planRelease claimMutex");
241
                phase.setPhase("claimMutex");
242
                mReleaseManager.claimMutex();
243
 
244
                // Populate the mBuildExclusionCollection
245
                //
246
                // Builds are either 'Directly excluded' or 'Indirectly excluded'
247
                // Direct excludes result from:
248
                //      User request
249
                //      Build failure
250
                //      Inability to build package
251
                // Indirectly excluded packages result from have a build dependency on a package
252
                // that is directly excluded.
253
                //  
254
                // In the following code we will extract from the Database all build exclusions
255
                // We will then add 'Relevant' entries to mBuildExclusionCollection
256
                // and delete, from the database those that are no longer relevant - ie indirectly excluded
257
                // items where the root cause is no longer in the set.
258
                phase.setPhase("mBuildExclusionCollection");
259
                mBuildExclusionCollection.clear();
260
                ArrayList<BuildExclusion> tempBuildExclusionCollection = new ArrayList<BuildExclusion>();
261
 
262
                mLogger.debug("planRelease queryBuildExclusions");
263
                mReleaseManager.queryBuildExclusions(tempBuildExclusionCollection, mBaseline);
264
 
265
                // only populate mBuildExclusionCollection with tempBuildExclusionCollection entries which have a relevant root_pv_id
266
                // The entry is relevant if:
267
                //     It is for a directly excluded package,other than a RippleStop
268
                //     It is for an indirectly excluded package AND the reason for exclusion still exists
269
                //
270
 
271
                for (Iterator<BuildExclusion> it = tempBuildExclusionCollection.iterator(); it.hasNext(); )
272
                {
273
                    BuildExclusion buildExclusion = it.next();
274
 
275
                    if ( buildExclusion.isRelevant(tempBuildExclusionCollection) )
276
                    {
277
                        mBuildExclusionCollection.add(buildExclusion);
278
                    }
279
                    else
280
                    {
281
                        // Remove the indirectly excluded entry as its root cause
282
                        // is no longer present.
283
                        buildExclusion.includeToBuild(mReleaseManager, mBaseline);
284
                    }
285
                }
286
            }
287
 
288
            //-----------------------------------------------------------------------
289
            //	Query package versions
290
            //
291
            phase.setPhase("queryPackageVersions");
292
            mLogger.debug("planRelease queryPackageVersions");
293
            mReleaseManager.queryPackageVersions(this, mPackageCollection, mBaseline);
7048 dpurdie 294
            mReleaseManager.queryWips(this, mPackageCollectionWip, mBaseline);
295
            mReleaseManager.queryTest(this, mPackageCollectionTest, mBaseline);
296
            mReleaseManager.queryRipples(this, mPackageCollectionRipple, mBaseline);
297
            mPackageCollectionAll.addAll(mPackageCollection);
298
            mPackageCollectionAll.addAll(mPackageCollectionWip);
299
            mPackageCollectionAll.addAll(mPackageCollectionTest);
300
            mPackageCollectionAll.addAll(mPackageCollectionRipple);
301
 
302
            // Sort the collection by PVID
303
            //      Unit Test output order is known
304
            //      May assist in creating repeatable build orders
305
            //
306
            Collections.sort(mPackageCollectionAll, Package.SeqComparator);
6914 dpurdie 307
 
308
            //------------------------------------------------------------------------
309
            //    Process packages collected
310
            //    Determine and tag those we can't build
311
            phase.setPhase("processPackages");
312
            processPackages();
313
 
314
            //-----------------------------------------------------------------------
315
            //    At this point we have tagged all the packages that we cannot build
316
            //    Now we can determine what we are building
317
            phase.setPhase("planBuildOrder");
318
            mLogger.debug("planRelease process Remaining");
319
            planBuildOrder();
320
 
321
            //  Report excluded packages and the build plan
322
            //  This is being done with the MUTEX being held, but the 
323
            //  trade off is the cost of getting a connection.
324
            //
325
            if ( mDaemon )
326
            {
327
                phase.setPhase("Report Change");
328
                reportChange();
329
                phase.setPhase("Report Plan");            
330
                reportPlan();
331
            }
332
 
333
            //
334
            //	Generate the build Files
335
            //
336
            phase.setPhase("generateBuildFiles");
337
            generateBuildFiles();
338
        }
339
        finally
340
        {
341
            mLogger.debug("planRelease finally");
342
            // this block is executed regardless of what happens in the try block
343
            // even if an exception is thrown
344
            // ensure the SELECT FOR UPDATE is released
345
            try
346
            {
347
                if ( mDaemon )
348
                {
349
                    // attempt to release the SELECT FOR UPDATE through a commit
350
                    // a commit must be done in the normal case
351
                    // a commit may as well be done in the Exception case
352
                    // in the case of a SQLException indicating database connectivity has been lost
353
                    // having a go at the commit is superfluous
354
                    // as the SELECT FOR UPDATE will have been released upon disconnection
355
                    phase.setPhase("releaseMutex");
356
                    mReleaseManager.releaseMutex();
357
                }
358
            }
359
            finally
360
            {
361
                // ensure disconnect under all error conditions
362
                phase.setPhase("disconnectForPlanning");
363
                mReleaseManager.disconnectForPlanning(lastBuildActive);
364
            }
365
        }
366
 
7048 dpurdie 367
        mLogger.warn("planRelease mDaemon {} returned", mDaemon);
6914 dpurdie 368
        phase.setPhase("EndPlan");
369
    }
370
 
371
    /** Process packages that have been collected as a part of the plan
372
     * @param phase
373
     * @throws SQLException
374
     * @throws Exception
375
     */
376
    private void processPackages() throws SQLException, Exception {
377
 
378
        // Deal with test builds here as they may impact upon package attributes
7048 dpurdie 379
        //    eg: dependency collection and build standard differences
6914 dpurdie 380
        //    Note: Done before mPackageDependencyCollection is setup
381
        //
382
        if ( mDaemon )
383
        {
7048 dpurdie 384
            // Process test builds - they are in their own collection
385
            for (Iterator<Package> it = mPackageCollectionTest.iterator(); it.hasNext(); )
6914 dpurdie 386
            {
387
                Package p = it.next();
7048 dpurdie 388
                mLogger.info("planRelease package test build {}", p.mAlias);
6914 dpurdie 389
 
7048 dpurdie 390
                //
391
                //    Cannot test build an SDK based package or a Pegged Package
392
                //        Remove the test build request from the database
393
                //        Send a warning email
394
                //
395
                if(p.mIsPegged || p.mIsSdk)
6914 dpurdie 396
                {
7048 dpurdie 397
                    String reason;
398
                    reason = (p.mIsPegged) ? "Pegged" : "SDK Based";
6914 dpurdie 399
 
7048 dpurdie 400
                    mLogger.error("planRelease Daemon Instruction (testBuild) of {} package deleted: {}", reason, p.mAlias);
401
                    mReleaseManager.markDaemonInstCompleted( p.mTestBuildInstruction );
402
                    emailRejectedDaemonInstruction("Cannot 'Test Build' a " + reason + " package",p);
403
                }
6914 dpurdie 404
 
7048 dpurdie 405
                // force patch for test build numbering
406
                p.mDirectlyPlanned = true;
407
                p.mChangeType.setPatch();
408
                p.mRequiresSourceControlInteraction = false;
409
                p.mBuildReason = BuildReason.Test;
410
                p.mIndirectlyPlanned = true;
6914 dpurdie 411
            }
412
        }
413
 
414
        // Set up mPackageDependencyCollection on each package
415
        //    Examine the dependencies by alias and convert this to a 'package' selected from the released package set
7048 dpurdie 416
        mLogger.debug("planRelease setup setPackageDependencyCollection");
417
        for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 418
        {
419
            Package p = it.next();
420
 
421
            for (Iterator<String> it2 = p.mDependencyCollection.iterator(); it2.hasNext(); )
422
            {
423
                String alias = it2.next();
424
                Package dependency = findPackage(alias);
425
                p.mPackageDependencyCollection.add(dependency);
426
            }
7048 dpurdie 427
        }    
6914 dpurdie 428
 
7048 dpurdie 429
        // Detect and deal with circular dependencies
430
        // Examine all packages under consideration
431
        //
6914 dpurdie 432
        mLogger.debug("planRelease deal with circular dependencies");
7048 dpurdie 433
        for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 434
        {
435
            Package p = it.next();
436
 
7078 dpurdie 437
            if ( p.hasCircularDependency( mPackageCollectionAll ) )
6914 dpurdie 438
            {
7048 dpurdie 439
                mLogger.info("planRelease circular dependency detected {}", p.mAlias);
6914 dpurdie 440
 
441
                //  Force this package to be marked as having a circular dependency - even if its been excluded
442
                p.mBuildFile = 0;
443
 
7079 dpurdie 444
                // Exclude the package
6914 dpurdie 445
                // max 50 chars
7079 dpurdie 446
                rippleBuildExclude(p, p.mId, "Package has circular dependency", -6);
6914 dpurdie 447
 
448
                // take the package out of the build
449
                standardOut(mCircularDependency, p.mAlias, mCircularDependencyFlag);
450
                mCircularDependencyFlag = false;
451
            }
452
        }
453
 
454
        // Scan for packages with missing dependencies
455
        //    ie: The dependent package is not in the package Collection
456
        mLogger.debug("planRelease use the fully built mPackageDependencyCollection");
7048 dpurdie 457
        for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 458
        {
459
            Package p = it.next();
460
 
461
            if ( mDaemon )
462
            {
463
                //  Daemon Mode Only
464
                //  Not interested in the dependencies of a pegged package or a package provided from an SDK.
465
                //  Such packages will be deemed to not have missing dependencies
466
                if (p.mIsPegged || p.mIsSdk)
467
                {
468
                    continue;
469
                }
470
            }
471
 
472
            for (Iterator<String> it2 = p.mDependencyCollection.iterator(); it2.hasNext(); )
473
            {
474
                String alias = it2.next();
475
                Package dependency = findPackage(alias);
476
 
477
                if (dependency == ReleaseManager.NULL_PACKAGE)
478
                {
7048 dpurdie 479
                    mLogger.info("planRelease dependency is not in the baseline {}", alias);
7079 dpurdie 480
                    // Exclude the package
6914 dpurdie 481
                    // max 50 chars
7079 dpurdie 482
                    rippleBuildExclude(p, p.mId, "Package build dependency not in the release", -4);
6914 dpurdie 483
 
484
                    // take the package out of the build
485
                    standardOut(mNotInBaseline, p.mAlias, mNotInBaselineFlag);
486
                    mNotInBaselineFlag = false;
487
                    break;
488
                }
489
            }
490
        }
491
 
7048 dpurdie 492
        // Detect packages with no build standard and exclude them from the build
6914 dpurdie 493
        mLogger.debug("planRelease process packages which are not reproducible");
7048 dpurdie 494
        for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 495
        {
496
            Package p = it.next();
497
 
498
            if (p.mBuildFile == 0)
499
            {
500
                if ( mDaemon )
501
                {
502
                    //  Daemon Mode Only
503
                    //  Not interested in the reproducibility of a pegged package or a package provided from an SDK.
504
                    //  Such packages will be deemed to be reproducible - but out side of this release
505
                    if (p.mIsPegged || p.mIsSdk)
506
                    {
507
                        continue;
508
                    }
509
                }
510
 
7048 dpurdie 511
                // Does the package have a build standard. If not then we can't reproduce it.
512
                // Escrow - Assume the package is provided
513
                // Daemon - Exclude this package, but not its consumers. If the package is available then we can use it.
6914 dpurdie 514
                if (!p.isReproducible())
515
                {
7048 dpurdie 516
                    mLogger.info("planRelease package not reproducible {}" ,p.mName);
7079 dpurdie 517
 
518
                    // Exclude the package
6914 dpurdie 519
                    // max 50 chars
7079 dpurdie 520
                    rippleBuildExclude(p, p.mId, "Package has no build environment", -1);
6914 dpurdie 521
 
522
                    // package is not reproducible, discard
523
                    standardOut(mAnyBuildPlatforms, p.mAlias, mAnyBuildPlatformsFlag);
524
                    mAnyBuildPlatformsFlag = false;
525
                }
526
            }
527
        }
528
 
7048 dpurdie 529
        //    Process packages which are not reproducible on the configured set of build machines.
6914 dpurdie 530
        //
531
        //    Test each package and determine if the package contains a buildStandard that
532
        //    can be processed by one of the machines in the build set
533
        //
534
        //    ie: Package: Win32:Production and we have a BM with a class of 'Win32'
535
        //
536
        //    Only exclude the failing package and not its dependents
537
        //    May be legitimate in the release
538
        //
539
        mLogger.debug("planRelease process packages which are not reproducible2");
7048 dpurdie 540
        for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 541
        {
542
            Package p = it.next();
543
 
544
            if (p.mBuildFile == 0)
545
            {
546
                if ( mDaemon )
547
                {
548
                    //  Daemon Mode Only
549
                    //  Not interested in the reproducibility of a pegged package or a package provided from an SDK.
550
                    //  Such packages will be deemed to be reproducible - but out side of this release
551
                    if (p.mIsPegged || p.mIsSdk)
552
                    {
553
                        continue;
554
                    }
555
                }
556
 
557
                // package has yet to be processed
558
                // assume it does not need to be reproduced for this baseline
559
                //
560
                //    For each machineClass in the buildset
561
                boolean reproduce = false;
562
 
563
                for (Iterator<String> it2 = mReleaseManager.mReleaseConfigCollection.mMachineClasses.iterator(); it2.hasNext(); )
564
                {
565
                    String machineClass = it2.next();
566
 
567
                    if ( p.canBeBuildby(machineClass))
568
                    {
569
                        reproduce = true;
7048 dpurdie 570
                        mLogger.info("planRelease package built on {} {}", machineClass, p.mAlias );
6914 dpurdie 571
                        break;
572
                    }
573
                }
574
 
575
                if ( !reproduce )
576
                {
7048 dpurdie 577
                    mLogger.info("planRelease package not reproducible on the build platforms configured for this baseline {}", p.mName);
6914 dpurdie 578
 
7079 dpurdie 579
                    // Exclude the package
7048 dpurdie 580
                    // max 50 chars
7079 dpurdie 581
                    rippleBuildExclude(p, p.mId, "Package not built for configured platforms", -2);
6914 dpurdie 582
 
583
                    // package is not reproducible on the build platforms configured for this baseline, discard
584
                    standardOut(mAssocBuildPlatforms, p.mAlias, mAssocBuildPlatformsFlag);
585
                    mAssocBuildPlatformsFlag = false;
586
                }
587
            }
588
        }      
589
 
7079 dpurdie 590
        if (mDaemon )
6914 dpurdie 591
        {
592
 
593
            //  Daemon Mode Only
594
            //  Process packages which need to be ripple built
595
            mLogger.debug("planRelease process packages which need to be ripple built");
596
            for (Iterator<Package> it = mPackageCollection.iterator(); it.hasNext(); )
597
            {
598
                Package p = it.next();
599
 
600
                if (p.mBuildFile == 0)
601
                {
602
                    //  Not interested in a pegged package or a package provided from an SDK.
603
                    //  Such packages are not rippled
604
                    if (p.mIsPegged || p.mIsSdk)
605
                    {
606
                        continue;
607
                    }
608
 
7048 dpurdie 609
                    //    Examine this packages dependencies
610
                    //    If one of them does not exist in the 'official release' set then
611
                    //    the package needs to be built against the official release set
612
                    //    and we can't build any of its dependent packages
613
                    Iterator<Integer> it2 = p.mDependencyIDCollection.iterator();
614
                    Iterator<Package> it3 = p.mPackageDependencyCollection.iterator();
615
                    while ( it2.hasNext() && it3.hasNext() )
6914 dpurdie 616
                    {
7048 dpurdie 617
                        Integer dpvId = it2.next();
618
                        Package dependency = it3.next();
619
 
620
                        if ( !dependency.mAdvisoryRipple )
6914 dpurdie 621
                        {
7048 dpurdie 622
                            // not advisory, ie: has ripple build impact
623
                            if ( !isInRelease(dpvId) )
6914 dpurdie 624
                            {
7048 dpurdie 625
                                // the package is out of date
626
                                // exclude all dependent package versions
627
                                mLogger.info("planRelease package out of date {}", p.mName);
628
                                p.mBuildReason = BuildReason.Ripple;
629
                                rippleIndirectlyPlanned(p);
630
 
631
                                //  This package needs to be rippled
632
                                //  If this package has a rippleStop marker of 's', then we cannot
633
                                //  build this package at the moment.
634
                                //  Packages that depend on this package have been excluded
635
                                //  We need to exclude this one too
636
                                //
637
                                if (p.mRippleStop == 's' || p.mRippleStop == 'w') 
6914 dpurdie 638
                                {
7048 dpurdie 639
                                    // Package marked as a rippleStop
640
                                    // max 50 chars
7079 dpurdie 641
                                    rippleBuildExclude(p, -2, "Ripple Required." + " Waiting for user", -11);
7048 dpurdie 642
 
643
                                    if (p.mRippleStop == 's' ) {
644
                                        // Need to flag to users that the package build is waiting user action
645
                                        mLogger.info("planRelease Ripple Required. Stopped by flag {}", p.mName);
646
                                        mReleaseManager.setRippleStopWait(mRtagId,p);
6914 dpurdie 647
                                    }
648
                                }
7048 dpurdie 649
 
650
                                break;
6914 dpurdie 651
                            }
652
                        }
653
                    }
654
                }
655
            }
656
 
657
            //  Daemon Mode Only
658
            //  Process packages which do not exist in the archive
659
            //  For unit test purposes, assume all packages exist in the archive if released
660
            mLogger.debug("planRelease process packages which do not exist in the archive");
7048 dpurdie 661
            if ( mReleaseManager.mUseDatabase )
6914 dpurdie 662
            {
663
                for (Iterator<Package> it = mPackageCollection.iterator(); it.hasNext(); )
664
                {
665
                    Package p = it.next();
666
 
667
                    if (p.mBuildFile == 0)
668
                    {
669
                        // package has yet to be processed
670
                        if (!p.mDirectlyPlanned && !p.mIndirectlyPlanned && p.mForcedRippleInstruction == 0)
671
                        {
672
                            // check package version archive existence
673
                            if (!p.existsInDpkgArchive())
674
                            {
675
                                if (! p.mIsBuildable)
676
                                {
677
                                    //  Package does not exist in dpkg_archive and it has been flagged as unbuildable
678
                                    //  This may be because is Unbuildable or Manually built
7048 dpurdie 679
                                    mLogger.info("planRelease Unbuildable package not found in archive {}", p.mName);
7079 dpurdie 680
                                    // Exclude the package
6914 dpurdie 681
                                    // max 50 chars
7079 dpurdie 682
                                    rippleBuildExclude(p, p.mId, "Unbuildable" + " package not found in archive", -10);
6914 dpurdie 683
 
684
                                }
685
                                //  Not interested in a pegged package or a package provided from an SDK.
686
                                //  Such packages are not rippled
687
                                else if (p.mIsPegged || p.mIsSdk)
688
                                {
689
                                    String reason;
690
                                    reason = (p.mIsPegged) ? "Pegged" : "SDK";
691
 
692
                                    //  Pegged packages or packages provided from an SDK MUST exist in dpkg_archive
693
                                    //  They will not be built within the context of this release. It is the responsibility
694
                                    //  of another release to build them.
7048 dpurdie 695
                                    mLogger.info("planRelease {} package not found in archive {}", reason, p.mName);
7079 dpurdie 696
                                    // Exclude the package
6914 dpurdie 697
                                    // max 50 chars
7079 dpurdie 698
                                    rippleBuildExclude(p, p.mId, reason + " package not found in archive", -7);
6914 dpurdie 699
                                }
700
                                else if (p.mForcedRippleInstruction == 0)
701
                                {
702
                                    //  [JATS-331] Unable to rebuild package with Advisory Ripple dependencies
703
                                    //    Examine this packages dependencies
704
                                    //    If one of them does not exist in the 'official release' set then
705
                                    //    the package cannot be rebuilt in this release.
706
                                    for (Iterator<Integer> it2 = p.mDependencyIDCollection.iterator() ; it2.hasNext() ;)
707
                                    {
708
                                        Integer dpvId = it2.next();
709
                                        if ( !isInRelease(dpvId) )
710
                                        {
711
                                            // This package cannot be rebuilt as one of its dependents is NOT in this release
712
                                            // exclude all dependent package versions
713
 
7048 dpurdie 714
                                            mLogger.info("planRelease package not found in archive. Cannot be rebuilt due to {}", p.mName);
7079 dpurdie 715
                                            // Exclude the package
6914 dpurdie 716
                                            // max 50 chars
7079 dpurdie 717
                                            rippleBuildExclude(p, p.mId, "Package cannot be rebuilt in this release", -4);
6914 dpurdie 718
                                            break;
719
                                        }
720
                                    }
721
 
722
                                    //  The package has not been excluded from the build
723
                                    if (p.mBuildFile == 0)
724
                                    {
7048 dpurdie 725
                                        mLogger.info("planRelease package not found in archive {}", p.mName);
6914 dpurdie 726
                                        // DEVI 47395 the cause of this build is not WIP or ripple induced,
727
                                        // it simply does not exist in the archive (has been removed)
728
                                        // prevent source control interaction
729
                                        p.mRequiresSourceControlInteraction = false;
730
                                        p.mBuildReason = BuildReason.Restore;
731
                                        rippleIndirectlyPlanned(p);
732
                                    }
733
                                }
734
                            }
735
                        }
736
                    }
737
                }
738
            }
739
 
740
            //  Daemon Mode Only
7048 dpurdie 741
            //  Detect bad forced ripples requests and reject them
6914 dpurdie 742
            mLogger.debug("planRelease process forced ripples");
7048 dpurdie 743
            for (Iterator<Package> it = mPackageCollectionRipple.iterator(); it.hasNext(); )
6914 dpurdie 744
            {
745
                Package p = it.next();
746
 
747
                if (p.mBuildFile == 0)
748
                {
7048 dpurdie 749
                    //
750
                    //    Cannot force a ripple on an SDK based package or a Pegged Package
751
                    //        Remove the daemon instruction from the database
752
                    //        Send a warning email
753
                    //
754
                    if(p.mIsPegged || p.mIsSdk)
6914 dpurdie 755
                    {
7048 dpurdie 756
                        String reason;
757
                        reason = (p.mIsPegged) ? "Pegged" : "SDK Based";
6914 dpurdie 758
 
7048 dpurdie 759
                        mLogger.error("planRelease Daemon Instruction of {} package deleted: {}", reason, p.mName);
760
                        mReleaseManager.markDaemonInstCompleted( p.mForcedRippleInstruction );
761
                        emailRejectedDaemonInstruction("Cannot 'Ripple' a " + reason + " package",p);
6914 dpurdie 762
 
7048 dpurdie 763
                        p.mBuildFile = -8; 
6914 dpurdie 764
                    }
765
                }
766
            }
767
 
768
            //  Daemon Mode Only
769
            //  Mark Pegged and SDK packages as not to be built
7078 dpurdie 770
            //  Mark RippleStoped packages as not to be build
6914 dpurdie 771
            //  Have previously detected conflicts between pegged/sdk packages and daemon instructions
772
            //
773
            mLogger.debug("planRelease remove pegged and SDK packages from the build set");
774
            for (Iterator<Package> it = mPackageCollection.iterator(); it.hasNext(); )
775
            {
776
                Package p = it.next();
777
 
778
                if (p.mBuildFile == 0)
779
                {
7078 dpurdie 780
                    String reason = null;
781
 
782
                    //  Not interested in a pegged package or a package provided from an SDK or packages with an active RippleStop
6914 dpurdie 783
                    //  Such packages are not built
7078 dpurdie 784
                    if (p.mIsPegged ) {
785
                        reason = "Pegged";
786
                        p.mBuildFile = -8;
787
                    } else if (p.mIsSdk) {
788
                        reason = "SDK";
789
                        p.mBuildFile = -8;
790
                    } else if (p.mRippleStop == 's' || p.mRippleStop == 'w') {
791
                        reason = "RippleStop";
792
                        p.mBuildFile = -11;
793
                    }
794
 
795
                    if (reason != null)
6914 dpurdie 796
                    {
7048 dpurdie 797
                        mLogger.info("planRelease {} not built in this release {}", reason, p.mName);
6914 dpurdie 798
                    }
799
                }
800
            }
801
 
802
            //  Daemon Mode Only
803
            //  Locate Test Build Requests that cannot be satisfied - will not be built due to
804
            //  errors in dependent packages. Report the error to the user and remove the request
805
            //
7048 dpurdie 806
            for (Iterator<Package> it = mPackageCollectionTest.iterator(); it.hasNext(); )
6914 dpurdie 807
            {
808
                Package p = it.next();
809
 
7048 dpurdie 810
                if (p.mBuildFile < 0)
6914 dpurdie 811
                {
7048 dpurdie 812
                    String reason;
813
                    switch (p.mBuildFile)
6914 dpurdie 814
                    {
7048 dpurdie 815
                    case -1:  reason = "Not reproducible"; break;
816
                    case -2:  reason = "Not reproducible on configured build platforms"; break;
817
                    case -3:  reason = "Marked as 'Do not ripple'"; break;
818
                    case -4:  reason = "Dependent on a package not in the release"; break;
819
                    case -5:  reason = "Indirectly dependent on a package not reproducible in the release"; break;
820
                    case -6:  reason = "Has a circular dependency"; break;
821
                    case -7:  reason = "Pegged or SDK package not in dpkg_archive"; break;
822
                    case -8:  reason = "Is a Pegged or SDK package"; break;
823
                    case -9:  reason = "Rejected Daemon Instruction"; break;
824
                    case -10: reason = "Unbuildable package not in dpkg_archive"; break;
825
                    case -11: reason = "Marked as 'RippleStop'"; break;
826
                    default:  reason = "Unknown reason. Code:" + p.mBuildFile; break;
6914 dpurdie 827
                    }
7048 dpurdie 828
                    mLogger.error("planRelease Test Build of an unbuildable of package deleted: {}", p.mName);
829
                    mReleaseManager.markDaemonInstCompleted( p.mTestBuildInstruction );
830
                    emailRejectedDaemonInstruction(reason,p);
6914 dpurdie 831
                }
832
            }
833
        }
834
        else
835
        {
836
            // escrow reporting only
837
            // Report packages that are not reproducible
838
            //
839
            //  Note: I don't believe this code can be executed
840
            //        The -3 is only set in daemon mode
841
            for (Iterator<Package> it = mPackageCollection.iterator(); it.hasNext(); )
842
            {
843
                Package p = it.next();
844
 
845
                if (p.mBuildFile == -3)
846
                {
847
                    standardOut(mDependent, p.mAlias, mDependentFlag);
848
                    mDependentFlag = false;
849
                }
850
            }
851
        }
852
    }
7079 dpurdie 853
 
854
    /** Plan the build order.
855
         *  Assumes that a great deal of work has been done.
856
         *  This is a stand alone method to contain the work
857
         *  
858
         * @throws Exception
859
         * @throws SQLException
860
         */
861
        private void planBuildOrder() throws Exception, SQLException 
862
        {
863
 
864
    /**
865
     * Current status
7097 dpurdie 866
     *  basicPlan - time to complete current ripple
867
     *  FullPlan - Include all WIPS/RIPPLES into the release set
868
     *  
869
     *  If the full Plan does NOT extend the time of the basicPLan by 20% then use the full plan
870
     *  otherwise complete the current ripple and the include WIPs/RIPPLEs\
871
     *  
872
     *  TEST requests will be done first.
873
     *
7079 dpurdie 874
     */
875
 
876
            // Process remaining packages which are need to be reproduced for this baseline.
877
            //    Determine the build file for each package
878
            //    For daemon builds:
879
            //      Determine the next package that can be built now
880
            //          Sounds simple - doesn't it
881
            //      Set its mBuildNumber to 1, all remaining reproducible packages to 2
882
            //    For escrow builds:
883
            //      Determine the package versions that can be built in the build iteration
884
            //      Set their mBuildNumber to the build iteration
885
            //      Increment the build iteration and repeat until all package versions 
886
            //      that need to be reproduced have been assigned a build iteration        
887
 
888
            //
889
            //  Generate a plan for the packages that are in the current release
890
            //  These may be the result of a ripple going through the system 
891
            //  or a rebuild of a missing package or the result of a merge.
892
            //
893
            //  This will provide our basic plan, before we consider adding new packages to the
894
            //  mix, such as those from user WIPS and RIPPLE requests.
895
            //  
896
            PlanResults basicPlan = planCollection("Basic", mPackageCollection, true);
897
 
898
            //  Have not considered any of the WIP or RIPPLE packages
899
            //  If any of them are in the basic plan, then we can ignore them as we will build them
900
            //  when we build the basic plan
901
            //
902
            //  Determine a set of packages that will not be included if we build the basic plan
903
            //
904
            //  At the moment - lets assume there are none
905
            //  What do we do ?
906
            //      Select the first request
907
            //      Replace the package in the released collection
908
            //      Run the plan algorithm
909
            //      Restore the release collection
910
            //
911
            if ( mDaemon )
912
            {
913
                //
914
                //  Need to consider the TEST requests
915
                //      - Valid requests will be placed first on the build order
916
                //
917
                mBuildOrder.clear();
918
                for (Iterator<Package> it = mPackageCollectionTest.iterator(); it.hasNext(); )
919
                {
920
                    Package p = it.next();
921
                    if (p.mBuildFile >= 0)
922
                    {
923
                        mBuildOrder.add( new PlannedPackage(p,0 ) );
924
                    }
925
                }
926
 
927
                //  First attempt
928
                //  Insert all the WIPs and RIPPLES into the buildset. 
929
                //  Generate a plan and see how much the time is extended.
930
                //
931
                //  Don't modify mPackageCollection, although data in the 'Package' in the underlying packages may change
932
 
7080 dpurdie 933
                PlanResults fullPlan = postRipplePlan("Full", basicPlan, true);
7079 dpurdie 934
 
935
                //  Decide with plan to use
936
                //  At the moment we have, at most two.
937
                //      - (basic) Current Release ripples
938
                //      - (full) Current Release + All WIPS and RIPPLES
939
                //
940
                //  If we have both then if the full plan is < 20% longer than the basic plan, use the full plan
941
                //  Otherwise we use basic plan FOLLOWED by the a MODIFIED full plan (one without the natural ripples)
942
                //  Add the planned packages into the buildOrder
943
 
7080 dpurdie 944
                if( !basicPlan.planCollection.isEmpty() && !fullPlan.planCollection.isEmpty() )
7079 dpurdie 945
                {
7093 dpurdie 946
                    mLogger.error("Two plan selection: {} {}, {} <= {}", basicPlan.planTime,fullPlan.planTime, basicPlan.planTime * 12, fullPlan.planTime * 10);
7097 dpurdie 947
 
948
                    //
949
                    //  Report numbers for Bryan - can be removed after Aug-2019
950
                    //  See PX-14283
951
                    //
7098 dpurdie 952
                    {
7106 dpurdie 953
                        String bi = "--";
954
                        String be = "--";
7098 dpurdie 955
                        if (fullPlan.planTime != basicPlan.planTime &&  basicPlan.planTime  != 0) {
7106 dpurdie 956
                            bi = Float.toString( (fullPlan.planTime - basicPlan.planTime) / (float)basicPlan.planTime);
957
                            be = Float.toString( (float)fullPlan.planTime  / (fullPlan.planTime - basicPlan.planTime));
7098 dpurdie 958
                        }
959
                        mLogger.error("PLAN STATS: Estimated time to complete current plan (ETC): {}", basicPlan.planTime);
960
                        mLogger.error("PLAN STATS: Estimated time to full plan (PBT): {}", fullPlan.planTime);
7106 dpurdie 961
                        mLogger.error("PLAN STATS: Build Impact (BI): {}", bi);
962
                        mLogger.error("PLAN STATS: Build Efficiency (BE): {}", be);
7098 dpurdie 963
                    }
7097 dpurdie 964
 
965
 
7079 dpurdie 966
                    if ( (basicPlan.planTime * 12) <= (fullPlan.planTime * 10) )
967
                    {
968
                        //  Use the basic plan FOLLOWED by a plan that does not include
969
                        //      Ripples done by the basic plan
970
                        //      WIPs/RIPPLES done in the course of doing the basic plan
7093 dpurdie 971
                        mLogger.error("Use basic plan, then modified full plan");
7079 dpurdie 972
                        mBuildOrder.addAll(basicPlan.planCollection);
973
                        fullPlan = postRipplePlan("Full-Ripples", basicPlan, false);
974
                        mBuildOrder.addAll(fullPlan.planCollection);
975
 
976
                    } else {
977
                        //  Use the full plan
7093 dpurdie 978
                        mLogger.error("Use full plan");
7079 dpurdie 979
                        mBuildOrder.addAll(fullPlan.planCollection);
980
                    }
981
                } else if (!basicPlan.planCollection.isEmpty() ) {
982
                    // Use the basic plan
7093 dpurdie 983
                    mLogger.error("Use basic plan");
7079 dpurdie 984
                    mBuildOrder.addAll(basicPlan.planCollection);
985
 
7080 dpurdie 986
                } else if ( !fullPlan.planCollection.isEmpty() ) {
987
                    // Use the full plan
7093 dpurdie 988
                    mLogger.error("Use full plan");
7081 dpurdie 989
                    mBuildOrder.addAll(fullPlan.planCollection);
7079 dpurdie 990
 
991
                } else {
992
                    // Do not have a plan
993
                    // May have tests requests
7093 dpurdie 994
                    mLogger.error("Use NO plan");
7079 dpurdie 995
                }
996
 
7096 dpurdie 997
                //
998
                //  Now have a build order
999
                //  Allocate new version numbers
1000
                //      Examine packages with a buidLevel of zero
1001
                //  If we fail all of them then we can't build anything
1002
                //
1003
                mLogger.error("Determine new version numbers");
1004
                Package build = ReleaseManager.NULL_PACKAGE;
1005
                for (Iterator<PlannedPackage> it = mBuildOrder.iterator(); it.hasNext(); )
1006
                {
1007
                    PlannedPackage pkg = it.next();
1008
                    if (pkg.mBuildLevel != 0)
1009
                    {
1010
                        continue;
1011
                    }
1012
 
1013
                    //
1014
                    //  Attempt to allocate a new version number
1015
                    //  If we can't generate a new version number, then this is considered to be a build failure
1016
                    //  The package will be excluded and the user will be emailed
1017
                    //
1018
                    Package p = pkg.mPkg;
1019
 
1020
                    int pvApplied = p.applyPV(mReleaseManager);
1021
 
1022
                    if ( pvApplied == 0)
1023
                    {
1024
                        build = p;
1025
                        break;
1026
                    }
1027
                    else if ( pvApplied == 1 )
1028
                    {
1029
                        // max 50 chars
1030
                        rippleBuildExclude(p, p.mId, "Package has non standard versioning", -12);
1031
                    }
1032
                    else if ( pvApplied == 2 )
1033
                    {
1034
                        // max 50 chars
1035
                        rippleBuildExclude(p, p.mId, "Package has reached ripple field limitations", -12);
1036
                    }
1037
                    else if ( pvApplied == 3 )
1038
                    {
1039
                        // max 50 chars
1040
                        rippleBuildExclude(p, p.mId, "Package has invalid change type", -12);
1041
                    }
1042
                    else
1043
                    {
1044
                        // max 50 chars
1045
                        // Bad programming - should not get here
1046
                        rippleBuildExclude(p, p.mId, "Unable to calculate next version", -12);
1047
                    }
1048
                }
1049
 
1050
 
7079 dpurdie 1051
                //  Now have an mBuildOrder
7096 dpurdie 1052
                //  Mark the selected package in the build order as the one to be built
1053
                //  May need to process its it a bit more
7094 dpurdie 1054
                //  
7106 dpurdie 1055
                if ( build != ReleaseManager.NULL_PACKAGE)
1056
                {
7079 dpurdie 1057
                    build.mBuildFile = 1;
1058
 
1059
                    if ( build.mForcedRippleInstruction > 0 )
1060
                    {
1061
                        mReleaseManager.markDaemonInstCompleted( build.mForcedRippleInstruction );
1062
                    }
1063
 
1064
                    if ( build.mTestBuildInstruction > 0 )
1065
                    {
1066
                        mReleaseManager.markDaemonInstInProgress( build.mTestBuildInstruction );
1067
                    }
1068
 
1069
                    //  Now that we know which package we are building
1070
                    //      Set the previously calculated nextVersion as the packages version number
1071
                    //      Claim the version number to prevent other builds from using it. Even if doing a test build
1072
                    //
7093 dpurdie 1073
                    mLogger.error("Update mVersion: {}", build);
7079 dpurdie 1074
                    if (build.mNextVersion != null)
1075
                    {
1076
                        mReleaseManager.claimVersion(build.mPid, build.mNextVersion + build.mExtension, mBaseline);
1077
                        build.mVersion = build.mNextVersion;
7093 dpurdie 1078
                        mLogger.error("Update mVersion: {} to {}", build, build.mVersion);
7079 dpurdie 1079
                    }
1080
 
7106 dpurdie 1081
                    //
1082
                    //  Ensure that the package we are about to build is present in the mPackageCollection as its
1083
                    //  this list that is used to generate the build.xml file - that may be a bad way to do it , but ...
1084
                    //
1085
                    //  Note: Can't really modify others as they will be used as dependencies
1086
                    //
1087
                    Package pEntry = findPackage(build.mAlias);
1088
                    if ( pEntry != ReleaseManager.NULL_PACKAGE)
7079 dpurdie 1089
                    {
7106 dpurdie 1090
                        mPackageCollection.set(mReleaseManager.findPackageLastIndex, build);
1091
                        build.mIsNotReleased = false;
1092
                    } else {
1093
                        mPackageCollection.add(build);
1094
                        build.mIsNotReleased = false;
7079 dpurdie 1095
                    }
1096
                }
7106 dpurdie 1097
 
7079 dpurdie 1098
                //
1099
                //  Report packages that are indirectly excluded
7081 dpurdie 1100
                //  ie: They will not be built because one, or more, of there dependents is not buildable
7079 dpurdie 1101
                //
1102
                mLogger.debug("planBuildOrder process packages which are not ripple buildable");
1103
 
1104
                 for (ListIterator<BuildExclusion> it = mBuildExclusionCollection.listIterator(); it.hasNext(); )
1105
                 {
1106
                     BuildExclusion be = it.next();
1107
 
1108
                     for (Iterator<Package> it1 = mPackageCollection.iterator(); it1.hasNext(); )
1109
                     {
1110
                         Package p = it1.next();
1111
 
1112
                         // ensure only root cause, non test build, build exclusions are excluded
1113
                         // mBuildExclusionCollection is at this point based on
1114
                         // relevant (direct and indirect) excluded pv's in the database
7081 dpurdie 1115
 
7079 dpurdie 1116
                         if ( be.compare(p.mId) && be.isARootCause() && p.mTestBuildInstruction == 0 && p.mForcedRippleInstruction == 0 )
1117
                         {
1118
                             // package is not reproducible, discard it and its consumers
1119
                             //
7081 dpurdie 1120
                             mLogger.info("Excluded Package {}, {}", p.mAlias, be );                                     
7079 dpurdie 1121
 
1122
                             ArrayList<Package> toExclude = new ArrayList<Package>();
1123
                             toExclude.addAll(usedByAnyPackages(p, mPackageCollection ));
1124
 
1125
                             //  Process packages that we need to exclude indirectly
1126
                             //
1127
                             while ( ! toExclude.isEmpty())
1128
                             {
1129
                                 Package pkg = toExclude.remove(0);
1130
 
7081 dpurdie 1131
                                 // If this package has not been excluded (for whatever reason), than add it
7079 dpurdie 1132
                                 boolean found = false;
1133
                                 for (Iterator<BuildExclusion> it2 = mBuildExclusionCollection.iterator(); it2.hasNext(); )
1134
                                 {
1135
                                     BuildExclusion buildExclusion = it2.next();
1136
                                     if (buildExclusion.compare(pkg.mId) )
1137
                                     {
1138
                                         found = true;
7081 dpurdie 1139
                                         if  ( buildExclusion.isImported() )
1140
                                         {
1141
                                             // An exclusion for this package already exists
1142
                                             // If it was 'imported' from the database then 
1143
                                             // mark it as processed so that it will be persisted
1144
                                             //
1145
                                             // Otherwise it will be a new one
1146
                                             //
1147
                                             buildExclusion.setProcessed();
1148
                                         }
7079 dpurdie 1149
                                         break;
1150
                                     }
1151
                                 }
1152
 
1153
                                 if (!found)
1154
                                 {
1155
                                     BuildExclusion buildExclusion = new BuildExclusion(pkg.mId, p.mId, null, p.mTestBuildInstruction);
1156
                                     it.add(buildExclusion);
7096 dpurdie 1157
                                     mLogger.info("Indirectly Excluded Package {}", pkg.mAlias);
1158
                                     pkg.mBuildFile = -5; 
7079 dpurdie 1159
 
7094 dpurdie 1160
                                     ArrayList<Package> usedBy = usedByAnyPackages(pkg, mPackageCollectionAll );
7079 dpurdie 1161
                                     toExclude.addAll(usedBy);
1162
                                 }
1163
                             }
1164
                         }
1165
                     }
1166
                 }
7096 dpurdie 1167
 
1168
                 //
1169
                 //  Examine the build order and 'delete' entries with a -ve mBuildFile
1170
                 //  These will be the product of pvApply errors and the packages that depend on them
1171
 
1172
                 for (Iterator<PlannedPackage> it = mBuildOrder.iterator(); it.hasNext(); )
1173
                 {
1174
                     PlannedPackage pkg = it.next();
1175
                     if (pkg.mPkg.mBuildFile < 0)
1176
                     {
1177
                         it.remove();
1178
                         mLogger.error("Purge mBuildOrder {}", pkg.mPkg);
1179
                     }
1180
                 }
1181
 
1182
 
7079 dpurdie 1183
 
1184
                //
1185
                //  To fit in with the old algorithm ( ie: could be improved )
1186
                //  Insert marks into all packages
1187
                //  Not sure exactly why - Its used in the generation of the ant build file
1188
                //                     Want to set mNoBuildReason, mBuildFile
1189
                //
1190
                //      Package we have selected to build: 0     , 1
1191
                //      Package we could have built      : 0     , 2
1192
                //      Packages we can't build          : reason, 3
1193
                //      Packages that are OK             : 3     , 3
1194
                //      ????                             : 0     , 3
1195
 
1196
                for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
1197
                {
1198
                    Package p = it.next();
1199
                    if (p == build ) {
1200
                        p.mNoBuildReason = 0;
1201
                        p.mBuildFile = 1;
1202
                    } 
1203
                    else if ( p.mBuildFile < 0 )
1204
                    {
1205
                        p.mNoBuildReason = p.mBuildFile;
1206
                        p.mBuildFile = 3;
1207
                    }
1208
                    else if (p.mBuildReason != null)
1209
                    {
1210
                        p.mNoBuildReason = 0;
1211
                        p.mBuildFile = 2;
1212
                    }
1213
                    else
1214
                    {
1215
                        p.mNoBuildReason = 0;
1216
                        p.mBuildFile = 3;
1217
                    }
1218
                }
1219
 
1220
            }
1221
            else
1222
            {
1223
                //  Escrow
1224
                //  The basic plan is the escrow build order
1225
                mBuildOrder = basicPlan.planCollection;
1226
            }
1227
 
1228
            mLogger.error("Final Plan");
1229
            for (Iterator<PlannedPackage> it = mBuildOrder.iterator(); it.hasNext(); )
1230
            {
1231
                PlannedPackage p = it.next();
7080 dpurdie 1232
                mLogger.error("Plan: {} {} {}", p.mBuildLevel, p.mPkg.mAlias, p.mPkg.mId);
7079 dpurdie 1233
            }
1234
 
1235
 
1236
        }
1237
 
7078 dpurdie 1238
    /** Internal class to contain intermediate results
6914 dpurdie 1239
     */
7078 dpurdie 1240
    class PlanResults {
1241
        int planTime = 0;
7079 dpurdie 1242
        ArrayList<PlannedPackage> planCollection = new ArrayList<PlannedPackage>(); 
7078 dpurdie 1243
    }
1244
 
1245
    /**
1246
     * Process a collection of packages and generate a collection of package plans
1247
     * A package plan is a collection of packages that can be built
1248
     *      The first item in the list is a package that can be built right now
1249
     *      Other items in the list will be packages that can be built now or will need to be built as the result
1250
     *      of a ripple
1251
     *      
1252
     * The method will be called multiple times so that we can evaluate different plans
1253
     * The underling packages will have data and flags that will need to be rested before a calculation      
1254
     *
1255
     * @param name - Name of the plan
1256
     * @param packageCollection - Base collection of packages to plan
1257
     * @param mode - true: Include 'Ripples'
1258
     * 
1259
     * @return
1260
     */
1261
    private PlanResults planCollection(String name, ArrayList<Package> packageCollection, boolean mode)
7070 dpurdie 1262
    {
7094 dpurdie 1263
        Phase phase = new Phase("PlanCollection"); 
7079 dpurdie 1264
        ArrayList<PlannedPackage> ripplePlan = new ArrayList<PlannedPackage>();
7078 dpurdie 1265
        PlanResults results = new PlanResults();
6914 dpurdie 1266
 
7078 dpurdie 1267
        //  Reset flags used in the calculations
1268
        Package.resetProcessed(packageCollection);
6914 dpurdie 1269
 
7078 dpurdie 1270
        //  Exclude all packages that cannot be built and all packages that depend on them
1271
        //      First find packages to be directly excluded
1272
        ArrayList<Package>exclude = new ArrayList<Package>();
7094 dpurdie 1273
        phase.setPhase("Exclude Unbuildable");
7078 dpurdie 1274
        for (Iterator<Package> it = packageCollection.iterator(); it.hasNext(); )
1275
        {
1276
            Package p = it.next();
7081 dpurdie 1277
            if ( p.mBuildFile == -8 ) {
1278
 
1279
                //  Mark SDK or Pegged so that we don't build them, but can build their dependents
1280
                p.mProcessed = true;
1281
                p.mIsProcessed = true;
1282
                mLogger.error("SDK/Peg Exclude: {}", p);
1283
 
1284
            } else if (p.mBuildFile < 0 ) {
7078 dpurdie 1285
                exclude.add(p);
7081 dpurdie 1286
                mLogger.error("Direct Exclude: {}", p);
1287
 
7078 dpurdie 1288
            }
1289
        }
1290
 
7080 dpurdie 1291
        //  Exclude packages that have failed to be built
1292
        //      These are recorded in mBuildExclusionCollection
7094 dpurdie 1293
        phase.setPhase("Exclude Build Failures");
7080 dpurdie 1294
        for (ListIterator<BuildExclusion> it = mBuildExclusionCollection.listIterator(); it.hasNext(); )
1295
        {
1296
            BuildExclusion be = it.next();
7094 dpurdie 1297
            mLogger.error("BE: {}", be);
1298
            if ( !be.isAIndirectError() )
7080 dpurdie 1299
            {
1300
                for (Iterator<Package> it1 = packageCollection.iterator(); it1.hasNext(); )
1301
                {
1302
                    Package p = it1.next();
7081 dpurdie 1303
                    if (p.mBuildFile >= 0 && p.mId == be.mId) {
7080 dpurdie 1304
                        p.mBuildFile  = -3;
7094 dpurdie 1305
                        mLogger.error("AddExclude {}",p);
7080 dpurdie 1306
                        exclude.add(p);
1307
                        break;
1308
                    }
1309
                }
1310
            }
1311
        }
1312
 
1313
 
7078 dpurdie 1314
        //  Process the list of packages to be excluded
1315
        //  Add to the list packages that depend on the excluded package that have not already been excluded
7094 dpurdie 1316
        phase.setPhase("ExcludeAllUsed");
7078 dpurdie 1317
        while( !exclude.isEmpty() )
1318
        {
1319
            Package p = exclude.remove(0);
1320
            p.mProcessed = true;
1321
            p.mIsProcessed = true;
7081 dpurdie 1322
            mLogger.error("planCollection package not buildable {}", p.mName);
7078 dpurdie 1323
 
1324
            for (Iterator<Package> it1 = packageCollection.iterator(); it1.hasNext(); )
1325
            {
1326
                Package pkg = it1.next();
1327
                if (pkg.mProcessed) {
1328
                    continue;
1329
                }
1330
 
7080 dpurdie 1331
                for (Iterator<String> it = pkg.mDependencyCollection.iterator(); it.hasNext(); )
7078 dpurdie 1332
                {
1333
                    String alias = it.next();
1334
                    if ( p.mAlias.compareTo( alias ) == 0 ) {
1335
                        exclude.add(pkg);
1336
                    }
1337
                }
1338
            }
1339
        }
1340
 
1341
        //  Now have a collection of packages with those that we cannot build have been marked
1342
        //  Process the list and determine packages that we can build right now
1343
        //      ie: they have not been excluded, have not already been discovered and do not depend on any package in the collection
1344
        //      Continue to do this until all packages have been extracted
1345
        //      Allocate build levels as we go
1346
        //
7094 dpurdie 1347
        phase.setPhase("Determine Build Order");
6914 dpurdie 1348
        boolean allProcessed = false;
7078 dpurdie 1349
        int buildLevel = 1;
6914 dpurdie 1350
 
1351
        do
1352
        {
7048 dpurdie 1353
            //
1354
            //  Create the mBuildOrder collection
1355
            //      Same for both Daemon and Escrow modes
1356
            //      Will have package build order and build level
6914 dpurdie 1357
            boolean allDependenciesProcessed = true;
1358
            do
1359
            {
1360
                allDependenciesProcessed = true;
7078 dpurdie 1361
                for (Iterator<Package> it = packageCollection.iterator(); it.hasNext(); )
6914 dpurdie 1362
                {
1363
                    Package p = it.next();
7078 dpurdie 1364
 
1365
                    //  Skip packages that have been processed - have determined build order, or cannot build
1366
                    if (p.mIsProcessed) {
1367
                        continue;
1368
                    }
6914 dpurdie 1369
 
7078 dpurdie 1370
                    // Package yet to be processed and
1371
                    //      Daemon mode: Could be built
1372
                    //      Escrow mode: Can be reproduced
1373
                    boolean canBeBuiltNow = true;
1374
                    boolean allDependenciesForThisPackageProcessed = true;
1375
 
1376
                    //  Scan the packages dependencies
1377
                    for ( Iterator<Package> it2 = p.mPackageDependencyCollection.iterator(); it2.hasNext(); )
6914 dpurdie 1378
                    {
7078 dpurdie 1379
                        Package dependency = it2.next();
6914 dpurdie 1380
 
7078 dpurdie 1381
                        if ( !dependency.mProcessed )
6914 dpurdie 1382
                        {
7078 dpurdie 1383
                            //  If all the dependencies have been processed, then we can potentially build this package
1384
                            //  If any of them have not been processed, then cannot calculate canBeBuiltNow until this 
1385
                            //  dependency has been processed
1386
                            allDependenciesForThisPackageProcessed = false;
1387
                            allDependenciesProcessed = false;
6914 dpurdie 1388
                        }
7078 dpurdie 1389
                        else if (  (  mDaemon && (   dependency.mBuildFile == 0 ) ||  (dependency.mBuildFile == buildLevel)) 
1390
                                || ( !mDaemon && ( ( dependency.mBuildFile == 0 ) ||
1391
                                                       ( dependency.mBuildFile == buildLevel &&
1392
                                                       ( !p.haveSameBuildStandards(dependency)  ) ) ) ) )
1393
                        {
1394
                            // Can be built - yet
1395
                            // Daemon mode:
1396
                            //    This processed dependency has not been assigned to a build iteration
1397
                            //    This processed dependency has been assigned to this build iteration
1398
                            // Escrow mode: This package cannot be built now if
1399
                            //    This processed dependency has not been assigned to a build iteration or
1400
                            //    This processed dependency has been assigned to this build iteration, but the 
1401
                            //    build standards of the package and this dependency prevent the package being
1402
                            //    built in this iteration.   
1403
                            canBeBuiltNow = false;
1404
                            mLogger.info("planRelease package cannot be built in this iteration {}", p.mName);
1405
                            break;
1406
                        }
1407
                    }
6914 dpurdie 1408
 
7078 dpurdie 1409
                    //  All dependencies have been processed. May be able to build this package
1410
                    //      Add the package to the build order list
1411
                    //
1412
                    if (allDependenciesForThisPackageProcessed)
1413
                    {
1414
                        p.mProcessed = true;
1415
                        if ( canBeBuiltNow )
6914 dpurdie 1416
                        {
7079 dpurdie 1417
                            results.planCollection.add( new PlannedPackage(p, buildLevel));
7078 dpurdie 1418
                            p.mBuildFile = buildLevel;
1419
                            p.mIsProcessed = true;
1420
                            mLogger.info("planRelease set mBuildFile to {} for package {}",buildLevel, p.mAlias );
6914 dpurdie 1421
                        }
1422
                    }
1423
                }
1424
            } while( !allDependenciesProcessed );
7048 dpurdie 1425
 
7095 dpurdie 1426
            //  Have process all the packages that we can build at the moment
7048 dpurdie 1427
            //      Examine all the packages in the collection to see if there are more that need to be extracted
1428
            //      These will be done at a different build-level
1429
            //  
1430
            allProcessed = true;
7078 dpurdie 1431
            for (Iterator<Package> it = packageCollection.iterator(); it.hasNext(); )
7048 dpurdie 1432
            {
1433
                Package p = it.next();
7078 dpurdie 1434
                if ( !  p.mIsProcessed )
7048 dpurdie 1435
                {
1436
                    // more build files are required
1437
                    allProcessed = false;
1438
                    mLogger.info("planRelease more build files are required for {}", p.mName);
1439
                    break;
1440
                }
1441
            }
6914 dpurdie 1442
 
7078 dpurdie 1443
            buildLevel++;
1444
            if (buildLevel % 500 == 0 ) {
1445
                mLogger.error("planRelease. Too many build levels {}", buildLevel);
7048 dpurdie 1446
            }
1447
        } while( !allProcessed );
7078 dpurdie 1448
 
1449
        //  Now we have a collection packages that we can build right now
1450
        //      The packages currently have a build level set into mBuildFile
1451
        //
1452
        if (mDaemon)
7048 dpurdie 1453
        {
7094 dpurdie 1454
            phase.setPhase("Calc Build Order");
1455
            //
7078 dpurdie 1456
            //  Determine if we have a reason to build anything in this collection of buildable packages
7095 dpurdie 1457
            //      Reset the calculated buildLevel - It will be calculated again
1458
            //      Reset the mProcessed - it will be used to detect  that we have processed a package
1459
 
7079 dpurdie 1460
            ArrayList<PlannedPackage> toBuild = new ArrayList<PlannedPackage>();
1461
            for (Iterator<PlannedPackage> it = results.planCollection.iterator(); it.hasNext(); )
6914 dpurdie 1462
            {
7079 dpurdie 1463
                PlannedPackage p = it.next();
1464
                p.mBuildLevel = 0;
7095 dpurdie 1465
                p.mPkg.mCheckedCircularDependency = false;
7079 dpurdie 1466
 
1467
                if (p.mPkg.mBuildReason != null) {
1468
                    if (mode || ( !mode && p.mPkg.mBuildReason != BuildReason.Ripple ))
7048 dpurdie 1469
                    {
7078 dpurdie 1470
                        toBuild.add(p);
7048 dpurdie 1471
                    }
1472
                }
1473
            }
1474
 
7078 dpurdie 1475
            //  Need (would like to) build stuff
1476
            //  Determine the packages that we need to build and the time that it will take
7070 dpurdie 1477
            //
7078 dpurdie 1478
            if ( !toBuild.isEmpty() )
7048 dpurdie 1479
            {
7096 dpurdie 1480
                //  Locate the packages that we need to build
1481
                //  The build order cannot be correctly determined at this time
1482
                //      Need to add elements to the end of the list while processing
1483
                //      Sum the buildTimes of the packages that we add to the list
7078 dpurdie 1484
                while ( ! toBuild.isEmpty())
7048 dpurdie 1485
                {
7079 dpurdie 1486
                    PlannedPackage pkg = toBuild.remove(0);
7078 dpurdie 1487
 
7095 dpurdie 1488
                    if (pkg.mBuildLevel > 400 ) {
7078 dpurdie 1489
                        mLogger.error("Circular dependency detected - not handled well");
1490
                        break;
7048 dpurdie 1491
                    }
1492
 
7095 dpurdie 1493
                    if ( ! pkg.mPkg.mCheckedCircularDependency )
7048 dpurdie 1494
                    {
7078 dpurdie 1495
                        ripplePlan.add(pkg);
7079 dpurdie 1496
                        results.planTime += pkg.mPkg.mBuildTime;
7095 dpurdie 1497
                        pkg.mPkg.mCheckedCircularDependency = true;
1498
 
1499
                        ArrayList<PlannedPackage> usedBy = usedByPackages(pkg, results.planCollection);
1500
                        toBuild.addAll(usedBy);
7048 dpurdie 1501
                    }
6914 dpurdie 1502
                }
7079 dpurdie 1503
 
7095 dpurdie 1504
                //
7096 dpurdie 1505
                //  Now we have a collection of packages to build ( and only the packages to build)
7095 dpurdie 1506
                //  Need to determine the order in which it can be done and assign build levels
7096 dpurdie 1507
                //  Basically:
1508
                //      Scan the collection looking for any package whose dependencies do not exist in the collection
1509
                //      or they have been allocated a build level.
7095 dpurdie 1510
                //
7096 dpurdie 1511
                //      Need to do this in waves so that we can correctly determine the build level.
1512
                //  
1513
                //
7095 dpurdie 1514
                for (Iterator<PlannedPackage> it = ripplePlan.iterator(); it.hasNext(); )
1515
                {
1516
                    PlannedPackage p = it.next();
1517
                    p.mPkg.mCheckedCircularDependency = true;
1518
                    p.mBuildLevel = 0;
1519
                }
1520
 
1521
                buildLevel = 0;
1522
                boolean more = true;
1523
                do  {
1524
                    ArrayList<PlannedPackage> thisLevel = new ArrayList<PlannedPackage>();
1525
                    for (Iterator<PlannedPackage> it = ripplePlan.iterator(); it.hasNext(); )
1526
                    {
1527
                        PlannedPackage p = it.next();
1528
                        if ( p.mPkg.mCheckedCircularDependency )
1529
                        {
1530
                            boolean found = false;
1531
                            for (Iterator<String> it2 = p.mPkg.mDependencyCollection.iterator(); !found && it2.hasNext(); )
1532
                            {
1533
                                String alias = it2.next();
1534
                                for (Iterator<PlannedPackage> it3 = ripplePlan.iterator(); !found && it3.hasNext(); )
1535
                                {
1536
                                    PlannedPackage pkg = it3.next();
1537
                                    if (pkg.mPkg.mAlias.compareTo( alias ) == 0)
1538
                                    {
1539
                                        found = pkg.mPkg.mCheckedCircularDependency ;
1540
                                        break;
1541
                                    }
1542
                                }
1543
                            }
1544
 
1545
                            if (!found)
1546
                            {
1547
                                //  None of this packages dependencies can be found in the collection of packages to build
1548
                                //  Thus we can build it - at the current level
1549
                                p.mBuildLevel = buildLevel;
1550
                                thisLevel.add(p);
1551
                            }
1552
                        }
1553
                    }
1554
 
1555
                    //  Mark all the packages at this level as have been processed
1556
                    //  Cannot do this while we are determining the packages in the level 
1557
                    for (Iterator<PlannedPackage> it = thisLevel.iterator(); it.hasNext(); )
1558
                    {
1559
                        PlannedPackage p = it.next();
1560
                        p.mPkg.mCheckedCircularDependency = false;
1561
                    }
1562
 
1563
                    more = !thisLevel.isEmpty(); 
1564
                    buildLevel++;
1565
 
1566
                } while (more);
1567
 
7078 dpurdie 1568
                //  Sort the packages by buildOrder and buildTime
7095 dpurdie 1569
                phase.setPhase("Sort Plan");
7079 dpurdie 1570
                Collections.sort(ripplePlan, PlannedPackage.BuildOrderComparitor);
7078 dpurdie 1571
 
7094 dpurdie 1572
                phase.setPhase("Display Build Order");
7093 dpurdie 1573
                mLogger.error("Plan Build {} Time: {}", name, results.planTime);
7079 dpurdie 1574
                for (Iterator<PlannedPackage> it = ripplePlan.iterator(); it.hasNext(); )
7078 dpurdie 1575
                {
7079 dpurdie 1576
                    PlannedPackage p = it.next();
7093 dpurdie 1577
                    mLogger.error("Plan: {} {} t:{}", p.mBuildLevel, p.mPkg.mAlias, p.mPkg.mBuildTime);
7078 dpurdie 1578
                }
6914 dpurdie 1579
            }
7048 dpurdie 1580
 
7078 dpurdie 1581
            //  Daemon mode: Returning calculated plan
1582
            results.planCollection = ripplePlan;
1583
        }
7094 dpurdie 1584
 
1585
        phase.setPhase("EndPlanCollection");
7078 dpurdie 1586
        return results;
1587
    }
6914 dpurdie 1588
 
7078 dpurdie 1589
    /** Generate a plan based on a modified set of packages
1590
     * 
1591
     * @param name      - Name of the plan
1592
     * @param basicPlan - basicPlan
1593
     * @param mode      - True: Include natural ripples and WIPS/RIPPLES that would have been done
1594
     *                          as a part of the basic plan
1595
     * @return
1596
     */
1597
    private PlanResults postRipplePlan(String name, PlanResults basicPlan, boolean mode) {
1598
 
1599
        ArrayList<Package> fullPlanCollection = new ArrayList<Package>(mPackageCollection);
1600
        ArrayList<Package> buildCandidates = new ArrayList<Package>();
1601
        buildCandidates.addAll(mPackageCollectionWip);
1602
        buildCandidates.addAll(mPackageCollectionRipple);
1603
 
1604
        if ( !buildCandidates.isEmpty() )
1605
        {
7048 dpurdie 1606
            for (Iterator<Package> it = buildCandidates.iterator(); it.hasNext(); )
1607
            {
1608
                Package p = it.next();
7078 dpurdie 1609
                if (p.mBuildFile >= 0)
6914 dpurdie 1610
                {
7078 dpurdie 1611
                    if (!mode)
6914 dpurdie 1612
                    {
7078 dpurdie 1613
                        //  Exclude packages that would have been processed in the basicPlan
7079 dpurdie 1614
                        for (Iterator<PlannedPackage> it1 = basicPlan.planCollection.iterator(); it1.hasNext(); )
7048 dpurdie 1615
                        {
7079 dpurdie 1616
                            PlannedPackage pkg = it1.next();
1617
                            if (pkg.mPkg == p)
7078 dpurdie 1618
                            {
7093 dpurdie 1619
                                mLogger.error("Test Plan without {}", p.mAlias);
7078 dpurdie 1620
                                continue;
1621
                            }
7048 dpurdie 1622
                        }
6914 dpurdie 1623
                    }
7078 dpurdie 1624
 
7093 dpurdie 1625
                    mLogger.error("Test Plan with {}", p.mAlias);
7078 dpurdie 1626
                    Package foundInRelease = mReleaseManager.findPackage(p.mAlias, fullPlanCollection);
1627
                    int foundIndex = mReleaseManager.findPackageLastIndex;
1628
                    if (foundInRelease == ReleaseManager.NULL_PACKAGE)
1629
                    {
1630
                        fullPlanCollection.add(p);
1631
                    }
1632
                    else
1633
                    {
1634
                        fullPlanCollection.set(foundIndex, p);
1635
                    }
1636
 
1637
                    Package.resetCircularDependency (fullPlanCollection);
1638
                    if ( p.hasCircularDependency( fullPlanCollection ) )
1639
                    {
1640
                        mLogger.info("planRelease circular dependency detected {}", p.mAlias);
1641
 
1642
                        //  Force this package to be marked as having a circular dependency - even if its been excluded
1643
                        p.mBuildFile = 0;
1644
 
7079 dpurdie 1645
                        // Exclude the package
7078 dpurdie 1646
                        // max 50 chars
7079 dpurdie 1647
                        rippleBuildExclude(p, p.mId, "Package has circular dependency", -6);
7078 dpurdie 1648
                    }
6914 dpurdie 1649
                }
1650
            }
7048 dpurdie 1651
 
7078 dpurdie 1652
        }
1653
        return planCollection(name, fullPlanCollection, mode);
1654
    }
1655
 
7079 dpurdie 1656
    /** 
1657
     *  Calculate a collection of packages that actively use the named package
1658
     *  A consumer package does NOT use the named package,
1659
     *      If the consumer is an SDK or is Pegged
1660
     *      If the consumer is marked as advisoryRipple
1661
     *      If the consumer cannot be built
1662
     *   
1663
     * @param pkg - Package to process
1664
     * @param planCollection - collection of packages to scan
1665
     *
1666
     * @return A collection of packages that actively 'use' the specified package
1667
 
7078 dpurdie 1668
     */
7095 dpurdie 1669
    private ArrayList<PlannedPackage> usedByPackages(PlannedPackage pkg, ArrayList<PlannedPackage> planCollection) {
7078 dpurdie 1670
 
7079 dpurdie 1671
        ArrayList<PlannedPackage> usedBy = new ArrayList<PlannedPackage>();
7078 dpurdie 1672
 
7079 dpurdie 1673
        for (Iterator<PlannedPackage> it = planCollection.iterator(); it.hasNext(); )
7078 dpurdie 1674
        {
7079 dpurdie 1675
            PlannedPackage p = it.next();
7070 dpurdie 1676
 
7079 dpurdie 1677
            //  Is this package 'actively used' in the current build
1678
            if (p.mPkg.mBuildFile >= 0)
7070 dpurdie 1679
            {
7079 dpurdie 1680
                for (Iterator<String> it2 = p.mPkg.mDependencyCollection.iterator(); it2.hasNext(); )
7070 dpurdie 1681
                {
7079 dpurdie 1682
                    String alias = it2.next();
1683
                    if (  pkg.mPkg.mAlias.compareTo( alias ) == 0  ) {
1684
                        //  Have found a consumer of 'pkg'
1685
                        usedBy.add(p);
1686
                        break;
7070 dpurdie 1687
                    }
1688
                }
1689
            }
7048 dpurdie 1690
        }
7079 dpurdie 1691
 
1692
        return usedBy;
7048 dpurdie 1693
    }
7079 dpurdie 1694
 
7048 dpurdie 1695
    /** 
7079 dpurdie 1696
     *  Calculate a collection of packages that use the named package
7048 dpurdie 1697
     *   
1698
     * @param pkg - Package to process
7070 dpurdie 1699
     * @param pkgCollection - collection of packages to scan
7078 dpurdie 1700
     *
7048 dpurdie 1701
     * @return A collection of packages that actively 'use' the specified package
1702
 
1703
     */
7079 dpurdie 1704
    private ArrayList<Package> usedByAnyPackages(Package pkg, ArrayList<Package> pkgCollection) {
7048 dpurdie 1705
 
1706
        ArrayList<Package> usedBy = new ArrayList<Package>();
1707
 
7070 dpurdie 1708
        for (Iterator<Package> it = pkgCollection.iterator(); it.hasNext(); )
7048 dpurdie 1709
        {
1710
            Package p = it.next();
1711
 
7079 dpurdie 1712
            for (Iterator<String> it2 = p.mDependencyCollection.iterator(); it2.hasNext(); )
7048 dpurdie 1713
            {
7079 dpurdie 1714
                String alias = it2.next();
1715
                if (  pkg.mAlias.compareTo( alias ) == 0  ) {
1716
                    usedBy.add(p);
1717
                    break;
6914 dpurdie 1718
                }
1719
            }
7048 dpurdie 1720
        }
1721
 
1722
        return usedBy;
6914 dpurdie 1723
    }
1724
 
1725
    /** Determine if a given PVID is a member of the current release.
1726
     *  Used to determine if a package dependency is out of date
1727
     * 
1728
     * @param dpvId
1729
     * @return true - specified pvid is a full member of the Release
1730
     */
1731
    private boolean isInRelease(Integer dpvId) {
1732
 
7048 dpurdie 1733
        boolean inRelease = false;
6914 dpurdie 1734
 
7048 dpurdie 1735
        for ( Iterator<Package> it = mPackageCollection.iterator(); it.hasNext(); )
6914 dpurdie 1736
        {
7048 dpurdie 1737
            Package p = it.next();
6914 dpurdie 1738
 
7048 dpurdie 1739
            if ( p.mId == dpvId )
6914 dpurdie 1740
            {
7048 dpurdie 1741
                inRelease = ! p.mIsNotReleased;
6914 dpurdie 1742
                break;
1743
            }
1744
        }
7048 dpurdie 1745
        return inRelease;
6914 dpurdie 1746
    }
1747
 
1748
 
7081 dpurdie 1749
    /** Reports what change in build exceptions happens as part of planRelease
1750
     * 
1751
     *  There are three types of exceptions
1752
     *      PlanError - These may be removed, if the error was not seen in the last plan
1753
     *      BuildErrors - These we persist
1754
     *      IndirectErrors - Packages that depend on a Plan or Build errors
6914 dpurdie 1755
     */
1756
    public void reportChange() throws SQLException, Exception
1757
    {
1758
        int counter = 0;
1759
        for (Iterator<BuildExclusion> it = mBuildExclusionCollection.iterator(); it.hasNext(); )
1760
        {
1761
            BuildExclusion buildExclusion = it.next();
1762
 
7081 dpurdie 1763
            //  Skip 'Processed' entries
1764
            //  These will be the result of a PlanError that we have seen again
1765
            //
1766
            //  PlanErrors - Add/Remove as detected
1767
            //  BuildErrors - Persist. 
1768
            //  IndirectErrors - Add/Remove as detected
1769
            //  
1770
 
1771
            if ( !buildExclusion.isABuildError() )
6914 dpurdie 1772
            {
7081 dpurdie 1773
                if ( !buildExclusion.isProcessed() )
1774
                {
1775
                    if (buildExclusion.isImported() && !buildExclusion.isARootCause() ) {
1776
                        // Remove from the exclusion list
1777
                        buildExclusion.includeToBuild(mReleaseManager, mBaseline);
1778
                        mLogger.error("reportChange remove unused exclusion: {}", buildExclusion );
1779
                    } else {
1780
                        // Exclude and notify
1781
                        buildExclusion.excludeFromBuild(mReleaseManager, mBaseline);
1782
                        buildExclusion.email(this, mPackageCollectionAll);
1783
                        counter++;
1784
                    }
7032 dpurdie 1785
                }
6914 dpurdie 1786
            }
1787
        }
7048 dpurdie 1788
        mLogger.error("reportChange exclusion count: {}", counter);
6914 dpurdie 1789
    }
1790
 
1791
    /**reports the build plan
1792
     */
1793
    public void reportPlan() throws SQLException, Exception
1794
    {
1795
        mReleaseManager.reportPlan(mRtagId, mBuildOrder);
1796
    }
1797
 
1798
    /**Returns the first build file from the collection
1799
     * The build file will be flagged as empty if none exists
1800
     */
1801
    public BuildFile getFirstBuildFileContent()
1802
    {
1803
        mLogger.debug("getFirstBuildFileContent");
1804
 
1805
        mBuildIndex = -1;
1806
        return getNextBuildFileContent();
1807
    }
1808
 
1809
    /**Returns next build file from the collection
1810
     * The build file will be flagged as empty if none exists
1811
     */
1812
    public BuildFile getNextBuildFileContent()
1813
    {
1814
        mLogger.debug("getNextBuildFileContent");
1815
        BuildFile retVal = null;
1816
 
1817
        try
1818
        {
1819
            mBuildIndex++;
1820
            retVal = mBuildCollection.get( mBuildIndex );
1821
        }
1822
        catch( IndexOutOfBoundsException e )
1823
        {
1824
            // Ignore exception. retVal is still null.
1825
        }
1826
 
1827
        if (retVal == null)
1828
        {
1829
            retVal = new BuildFile();
1830
        }
1831
 
7048 dpurdie 1832
        mLogger.debug("getNextBuildFileContent returned {}", retVal.state.name() );
6914 dpurdie 1833
        return retVal;
1834
    }
1835
 
1836
 
1837
    /**collects meta data associated with the baseline
1838
     * this is sufficient to send an indefinite pause email notification 
1839
     *  
1840
     * Escrow: Used once to collect information about the SBOM and associated Release 
1841
     *         mBaseline is an SBOMID 
1842
     * Daemon: Used each build cycle to refresh the information 
1843
     *          mBaseline is an RTAGID
1844
     */
1845
    public void collectMetaData() throws SQLException, Exception
1846
    {
1847
        Phase phase = new Phase("cmd");
7048 dpurdie 1848
        mLogger.debug("collectMetaData mDaemon {}", mDaemon);
6914 dpurdie 1849
 
1850
        try
1851
        {
1852
            phase.setPhase("connect");
1853
            mReleaseManager.connect();
1854
 
1855
            if (! mDaemon)
1856
            {
1857
                mSbomId = mBaseline;
1858
                phase.setPhase("queryRtagIdForSbom");
1859
                mRtagId = mReleaseManager.queryRtagIdForSbom(mBaseline);
1860
                if (mRtagId == 0)
1861
                {
7033 dpurdie 1862
                    mLogger.error("SBOM does not have a matching Release. Cannot be used as a base for an Escrow"); 
6914 dpurdie 1863
                    throw new Exception("rtagIdForSbom show stopper. SBOM does not have an associated Release");
1864
                }
1865
            }
1866
 
1867
            phase.setPhase("queryReleaseConfig");
1868
            mReleaseManager.queryReleaseConfig(mRtagId);
1869
 
1870
            if (mDaemon)
1871
            {
1872
                phase.setPhase("queryMailServer");
1873
                setMailServer(mReleaseManager.queryMailServer());
1874
                phase.setPhase("queryMailSender");
1875
                setMailSender(mReleaseManager.queryMailSender());
1876
                phase.setPhase("queryGlobalAddresses");
1877
                setMailGlobalTarget(mReleaseManager.queryGlobalAddresses());
1878
                phase.setPhase("queryProjectEmail");
1879
                mMailGlobalCollection = mReleaseManager.queryProjectEmail(mBaseline);
1880
                phase.setPhase("mMailGlobalTarget");
1881
                mMailGlobalCollection.add(0,getMailGlobalTarget());
1882
            }
1883
            phase.setPhase("queryBaselineName");
1884
            mBaselineName = mReleaseManager.queryBaselineName(mBaseline);
1885
            phase.setPhase("Done");
1886
        }
1887
        finally
1888
        {
1889
            // this block is executed regardless of what happens in the try block
1890
            // even if an exception is thrown
1891
            // ensure disconnect
1892
            mReleaseManager.disconnect();
1893
        }
1894
    }
1895
 
1896
    /**
1897
     * Find Package by package alias
7070 dpurdie 1898
     * Searches the released package collection
6914 dpurdie 1899
     * @param   alias               - alias of package to locate
1900
     * @return  Package with the matching mAlias or NULL_PACKAGE if no package has the mAlias
1901
     */
1902
    public Package findPackage(String alias)
1903
    {
1904
        mLogger.debug("findPackage");
1905
 
1906
        Package retVal = mReleaseManager.findPackage(alias, mPackageCollection);
1907
 
7048 dpurdie 1908
        mLogger.info("findPackage returned {}", retVal.mName);
6914 dpurdie 1909
        return retVal;
1910
    }
7070 dpurdie 1911
 
6914 dpurdie 1912
    /**
7079 dpurdie 1913
     * Sets the mBuildFile to the specified value for the package
1914
     * Does not handle dependent packages - this will be done later  
7048 dpurdie 1915
     *  
7032 dpurdie 1916
     * @param p             The package being excluded 
1917
     * @param rootPvId      The PVID of the package that is causing the exclusion. Null or -ve values are special
1918
     *                      This package is the root cause, -2: Excluded by Ripple Stop 
1919
     * @param rootCause     Text message. Max 50 characters imposed by RM database 
7079 dpurdie 1920
     * @param reason        New value for mBuildFile
6914 dpurdie 1921
     */
7079 dpurdie 1922
    private void rippleBuildExclude(Package p, int rootPvId, String rootCause, int reason )
6914 dpurdie 1923
    {
1924
        mLogger.debug("rippleBuildExclude");
7048 dpurdie 1925
 
7096 dpurdie 1926
        if ( p.mBuildFile >= 0 )
6914 dpurdie 1927
        {
7079 dpurdie 1928
            p.mBuildFile = reason;
7096 dpurdie 1929
            mLogger.info("rippleBuildExclude set mBuildFile to {} for package {}", reason, p.mAlias );
7079 dpurdie 1930
 
1931
            //  Scan the complete collection looking for a matching item
7081 dpurdie 1932
            //  If found then assume that this error is a a PlanError that is still present
1933
            //      Mark it as Processed to indicate that its still present
7079 dpurdie 1934
            //  If found, process it, else add it (unprocessed)
1935
            boolean found = false;
1936
            for (Iterator<BuildExclusion> it = mBuildExclusionCollection.iterator(); it.hasNext(); )
1937
            {
1938
                BuildExclusion buildExclusion = it.next();
6914 dpurdie 1939
 
7079 dpurdie 1940
                if ( buildExclusion.compare(p.mId, rootPvId, rootCause))
1941
                {
1942
                    buildExclusion.setProcessed();
1943
                    found = true;
1944
                    break;
1945
                }
6914 dpurdie 1946
            }
7079 dpurdie 1947
 
1948
            if (!found)
6914 dpurdie 1949
            {
7081 dpurdie 1950
                // Entry not found in the mBuildExclusionCollection. Its a new error
1951
                // 
7079 dpurdie 1952
                // Mark all occurrences for this package as processed
1953
                // These will be superseded by a new build exclusion entry
6914 dpurdie 1954
                for (Iterator<BuildExclusion> it = mBuildExclusionCollection.iterator(); it.hasNext(); )
1955
                {
1956
                    BuildExclusion buildExclusion = it.next();
1957
 
7079 dpurdie 1958
                    if ( buildExclusion.compare(p.mId))
6914 dpurdie 1959
                    {
7032 dpurdie 1960
                        buildExclusion.setProcessed();
6914 dpurdie 1961
                    }
1962
                }
1963
 
7081 dpurdie 1964
                //  Add the new build exclusion to a list
7079 dpurdie 1965
                BuildExclusion buildExclusion = new BuildExclusion(p.mId, rootPvId, rootCause, p.mTestBuildInstruction);
1966
                mBuildExclusionCollection.add(buildExclusion);
6914 dpurdie 1967
            }
7079 dpurdie 1968
        }
6914 dpurdie 1969
 
7079 dpurdie 1970
        mLogger.info("rippleBuildExclude set {} {}", p.mAlias, p.mBuildFile);
6914 dpurdie 1971
    }
1972
 
1973
    /**Simple XML string escaping
1974
     * 
1975
     * @param xml		- String to escape
1976
     * @return		- A copy of the string with XML-unfriendly characters escaped 
1977
     */
1978
    public static String escapeXml( String xml )
1979
    {
1980
        xml = xml.replaceAll("&", "&amp;");
1981
        xml = xml.replaceAll("<", "&lt;");
1982
        xml = xml.replaceAll(">", "&gt;");
1983
        xml = xml.replaceAll("\"","&quot;");
1984
        xml = xml.replaceAll("'", "&apos;");
1985
        xml = xml.replaceAll("\\$", "\\$\\$");
1986
 
1987
        return xml;
1988
    }
1989
 
1990
    /** Quote a string or a string pair
1991
     *  If two strings are provided, then they will be joined with a comma.
1992
     *   
1993
     * @param text		- First string to quote
1994
     * @param text2		- Optional, second string
1995
     * @return A string of the form 'text','text2'
1996
     */
1997
    public static String quoteString(String text, String text2)
1998
    {
1999
        String result;
2000
        result =  "\'" + text + "\'";
2001
        if (text2 != null )
2002
        {
2003
            result +=  ",\'" + text2 + "\'";  
2004
        }
2005
        return result;
2006
    }
2007
 
2008
    /** Generate build file information
2009
     * 
2010
     */
2011
    private void generateBuildFiles() 
2012
    {
2013
 
2014
        // persist the build files
2015
        boolean allProcessed = false;
2016
        int buildFile = 1;
2017
        StringBuilder rawData = new StringBuilder();
2018
        StringBuilder setUp = new StringBuilder();
2019
 
2020
        mLogger.debug("generateBuildFiles");
2021
 
2022
        if ( mDaemon )
2023
        {
2024
            // all interesting packages in daemon mode match the following filter
2025
            buildFile = 3;
2026
        }
2027
 
2028
        //-----------------------------------------------------------------------
2029
        //    Generate the build file
2030
        do
2031
        {
2032
            BuildFile buildEntry = new  BuildFile();
2033
            buildEntry.state = BuildFileState.Dummy;
2034
            XmlBuilder xml = generateBuildFileHeader();
2035
 
2036
 
2037
            //	Generate properties for each package in this build level or lower build levels
2038
            //	The properties link the packageAlias to the PackageName and PackageVersion
2039
            //
2040
            //	[DEVI 54816] In escrow mode all unreproducible packages are included 
7070 dpurdie 2041
            for (Iterator<Package> it = mPackageCollection.iterator(); it.hasNext(); )
6914 dpurdie 2042
            {
2043
                Package p = it.next();
2044
 
2045
                if ( ( ( p.mBuildFile > 0 ) && ( p.mBuildFile <= buildFile ) ) || ( !mDaemon && p.mBuildFile == -2 ) )
2046
                {
2047
                    xml.addProperty(p.mAlias, p.mName + " " + p.mVersion + p.mExtension);
2048
                }
2049
            }
2050
 
2051
            //	UTF Support
2052
            //	Insert additional info into the build file to provide extra checking
2053
            //
7048 dpurdie 2054
            if ( ! mReleaseManager.mUseDatabase )
6914 dpurdie 2055
            {
2056
                // UTF Support
2057
                // Insert per-package planning information
2058
                //
7070 dpurdie 2059
                xml.addComment("mPackageCollection");
2060
                for (Iterator<Package> it = mPackageCollection.iterator(); it.hasNext(); )
6914 dpurdie 2061
                {
2062
                    Package p = it.next();
2063
                    generatePackageInfo(xml, p);
2064
                }
2065
 
7070 dpurdie 2066
                xml.addComment("mPackageCollectionWip");
2067
                for (Iterator<Package> it = mPackageCollectionWip.iterator(); it.hasNext(); )
2068
                {
2069
                    Package p = it.next();
2070
                    if (p.mIsNotReleased )
2071
                        generatePackageInfo(xml, p);
2072
                }
2073
 
2074
                xml.addComment("mPackageCollectionTest");
2075
                for (Iterator<Package> it = mPackageCollectionTest.iterator(); it.hasNext(); )
2076
                {
2077
                    Package p = it.next();
2078
                    if (p.mIsNotReleased )
2079
                        generatePackageInfo(xml, p);
2080
                }
2081
 
2082
                xml.addComment("mPackageCollectionTestRipple");
2083
                for (Iterator<Package> it = mPackageCollectionRipple.iterator(); it.hasNext(); )
2084
                {
2085
                    Package p = it.next();
2086
                    if (p.mIsNotReleased )
2087
                        generatePackageInfo(xml, p);
2088
                }
2089
 
6914 dpurdie 2090
                // UTF Support
2091
                // Insert build exclusion information
2092
                xml.addComment("mBuildExclusionCollection");
2093
                for (Iterator<BuildExclusion> it = mBuildExclusionCollection.iterator(); it.hasNext(); )
2094
                {
2095
                    BuildExclusion buildExclusion = it.next();
2096
                    {
7081 dpurdie 2097
                        xml.addComment(buildExclusion.toString());
6914 dpurdie 2098
                    }
2099
                }
7080 dpurdie 2100
            }
2101
 
2102
            // UTF Support (Also while trailing the changes)
2103
            // Insert build Plan
2104
            if (mDaemon)
2105
            {
2106
                xml.addComment("mBuildOrder");
2107
                for (Iterator<PlannedPackage> it = mBuildOrder.iterator(); it.hasNext(); )
6914 dpurdie 2108
                {
7080 dpurdie 2109
                    PlannedPackage p = it.next();
2110
                    String comment =
2111
                            "pvid="+ p.mPkg.mId +
2112
                            " order=" + p.mBuildLevel +
2113
                            " time=" + p.mPkg.mBuildTime +
2114
                            " name=\"" + p.mPkg.mAlias + "\"";
2115
                    xml.addComment(comment);
6914 dpurdie 2116
                }
2117
            }
2118
 
2119
            //  Generate Taskdef information
2120
            generateTaskdef(xml);
2121
 
2122
            //
2123
            //  Insert known Machine Information
2124
            //  Escrow usage: 
2125
            //      Map machType to machClass
2126
            //  Also serves as a snapshot of the required build configuration
2127
            //  ie: machine types and buildfilters
2128
            //
2129
            if (!mDaemon)
2130
            {
2131
                generateMachineInfo(xml, null);
2132
            }
2133
 
2134
            //
2135
            //	Generate target rules for each package to be built within the current build file
2136
            //
2137
            boolean daemonHasTarget = false;
2138
 
7048 dpurdie 2139
            for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 2140
            {
2141
                Package p = it.next();
2142
 
2143
                if ( p.mBuildFile > 0 && p.mBuildFile <= buildFile )
2144
                {
2145
                    generateTarget(xml, buildEntry, p, buildFile);
2146
 
2147
                    if ( p.mBuildFile == 1 )
2148
                    {
2149
                        daemonHasTarget = true;
2150
 
2151
                        // Retain information about the target package
2152
                        buildEntry.mPkgId = p.mPid;
2153
                        buildEntry.mPvId = p.mId;
2154
                    }
2155
                }
2156
 
2157
                //	Generate escrow extraction commands
2158
                //	Only done on the first pass though the packages
2159
                //
2160
                if ( !mDaemon && buildFile == 1 )
2161
                {
2162
                    setUp.append("jats jats_vcsrelease -extractfiles"
2163
                                + " \"-label=" + p.mVcsTag + "\""
2164
                                + " \"-view=" + p.mAlias + "\""
2165
                                + " -root=. -noprefix"
2166
                                + mlf );
2167
                }
2168
 
2169
                //	Generate escrow raw CSV data
2170
                //	Note: I don't think this data is used at all
2171
 
2172
                if ( !mDaemon && ( p.mBuildFile == buildFile))
2173
                {
2174
                    StringAppender machines = new StringAppender(",");
2175
                    for (Iterator<BuildStandard> it1 = p.mBuildStandardCollection.iterator(); it1.hasNext();)
2176
                    {
2177
                        BuildStandard bs = it1.next();
2178
                        machines.append(bs.mMachClass);
2179
                    }
2180
 
2181
                    rawData.append(p.mAlias + "," +
2182
                                    buildFile + "," +
2183
                                    machines +
2184
                                    mlf);
2185
                }
2186
            }
2187
 
2188
            if ( mDaemon && !daemonHasTarget )
2189
            {
2190
                // must have AbtTestPath, AbtSetUp, AbtTearDown, and AbtPublish targets
2191
                XmlBuilder target = xml.addNewElement("target");
2192
                target.addAttribute("name", "AbtTestPath");
2193
 
2194
                target = xml.addNewElement("target");
2195
                target.addAttribute("name", "AbtSetUp");
2196
 
2197
                target = xml.addNewElement("target");
2198
                target.addAttribute("name", "AbtTearDown");
2199
 
2200
                target = xml.addNewElement("target");
2201
                target.addAttribute("name", "AbtPublish");
2202
            }
2203
 
2204
            generateDefaultTarget( xml, buildFile);
2205
 
2206
            //	Convert the Xml structure into text and save it in the build file
2207
            //	Add this build file to the mBuildCollection
2208
            buildEntry.content = mXmlHeader + xml.toString();
2209
            mBuildCollection.add(buildEntry);
2210
 
2211
            // are more build files required
2212
            allProcessed = true;
2213
 
2214
            if (!mDaemon)
2215
            {
2216
                // this is escrow mode centric
7048 dpurdie 2217
                for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 2218
                {
2219
                    Package p = it.next();
2220
 
2221
                    if ( p.mBuildFile > buildFile )
2222
                    {
2223
                        // more build files are required
2224
                        allProcessed = false;
7048 dpurdie 2225
                        mLogger.info("planRelease reiterating package has no build requirement {} {} {}",p.mName, p.mBuildFile,  buildFile);
6914 dpurdie 2226
                        break;
2227
                    }
2228
                } 
2229
 
2230
                buildFile++;
2231
            }
2232
 
2233
        } while( !allProcessed );
2234
 
2235
        //	Save additional escrow data
2236
        if ( !mDaemon )
2237
        {
2238
            mEscrowSetup = setUp.toString();
2239
            mEscrowRawData = rawData.toString();
2240
        }
2241
    }
2242
 
2243
    /**returns a build file header for the mBaseline
2244
     */
2245
    private XmlBuilder generateBuildFileHeader()
2246
    {
2247
        mLogger.debug("generateBuildFileHeader");
2248
        XmlBuilder element = new XmlBuilder("project");
2249
 
2250
        element.addAttribute("name", "mass");
2251
        element.addAttribute("default", "full");
2252
        element.addAttribute("basedir", ".");
2253
 
2254
        if ( mDaemon )
2255
        {
2256
            element.addProperty("abt_mail_server", getMailServer());
2257
            element.addProperty("abt_mail_sender", getMailSender()); 
2258
            element.addProperty("abt_rtag_id", mBaseline);
2259
            element.addProperty("abt_daemon", mReleaseManager.currentTimeMillis());
2260
            element.makePropertyTag("abt_packagetarball", true);
2261
            element.makePropertyTag("abt_usetestarchive", !ReleaseManager.getUseMutex());
2262
 
7048 dpurdie 2263
            for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 2264
            {
2265
                Package p = it.next();
2266
 
2267
                if ( p.mBuildFile == 1 )
2268
                {
2269
                    element.addProperty("abt_package_name", p.mName);
2270
                    element.addProperty("abt_package_version", p.mVersion + p.mExtension);
2271
                    element.addProperty("abt_package_extension", p.mExtension);
2272
                    element.addProperty("abt_package_location", getBuildLocation(p));
2273
                    element.addProperty("abt_package_ownerlist", p.emailInfoNonAntTask(this));
2274
                    element.addProperty("abt_package_build_info", buildInfoText(p));
2275
 
2276
                    // depends in the form 'cs','25.1.0000.cr';'Dinkumware_STL','1.0.0.cots'
2277
                    StringAppender depends = new StringAppender(";");
2278
 
2279
                    for (Iterator<Package> it3 = p.mPackageDependencyCollection.iterator(); it3.hasNext(); )
2280
                    {
2281
                        Package depend = it3.next();
2282
                        depends.append( quoteString(depend.mName, depend.mVersion + depend.mExtension) );
2283
                    }
2284
 
2285
                    element.addProperty("abt_package_depends", depends.toString());
2286
                    element.addProperty("abt_is_ripple", p.mDirectlyPlanned ? "0" : "1");
2287
                    element.addProperty("abt_build_reason", p.mBuildReason.toString());
2288
                    element.addProperty("abt_package_version_id", p.mId);
2289
                    element.addProperty("abt_does_not_require_source_control_interaction", ! p.mRequiresSourceControlInteraction ? "true" : "false" );
2290
                    element.addProperty("abt_test_build_instruction", p.mTestBuildInstruction);
2291
                }
2292
            }
2293
        }
2294
        else
2295
        {
2296
            //    Escrow Mode
2297
            element.addProperty("abt_rtag_id", mRtagId);
2298
            element.addProperty("abt_sbom_id", mSbomId);
2299
        }
2300
 
2301
        element.addProperty("abt_release", escapeXml(mBaselineName));
2302
        element.addProperty("abt_buildtool_version", mReleaseManager.getMajorVersionNumber() );
2303
 
2304
        element.addNewElement("condition")
2305
        .addAttribute("property", "abt_family")
2306
        .addAttribute("value", "windows")
2307
        .addNewElement("os")
2308
        .addAttribute("family", "windows");
2309
        element.addProperty("abt_family", "unix");
2310
 
2311
        return element;
2312
    }
2313
 
2314
    /** Add task def XML items taskdef for the abt ant task
2315
     * @param xml 	- xml item to extend
2316
     */
2317
    private void generateTaskdef(XmlBuilder xml)
2318
    {
2319
        mLogger.debug("generateTaskdef");
2320
        xml.addNewElement("taskdef")
2321
        .addAttribute("name", "abt")
2322
        .addAttribute("classname", "com.erggroup.buildtool.abt.ABT");
2323
 
2324
        xml.addNewElement("taskdef")
2325
        .addAttribute("name", "abtdata")
2326
        .addAttribute("classname", "com.erggroup.buildtool.abt.ABTData");
2327
    }
2328
 
2329
    /** returns the command abtdata items
2330
     *  <br>Common machine information
2331
     *  <br>Common email address
2332
     *  
2333
     *  
2334
     *  @param	xml - Xml element to extend   
2335
     *  @param    p - Package (May be null)
2336
     */
2337
    private void generateMachineInfo(XmlBuilder xml, Package p)
2338
    {
2339
        XmlBuilder element = xml.addNewElement("abtdata");
2340
        element.addAttribute("id", "global-abt-data");
2341
 
2342
        //
2343
        //  Iterate over all the machines and create a nice entry
2344
        //
2345
        for (Iterator<ReleaseConfig> it = mReleaseManager.mReleaseConfigCollection.mReleaseConfig.iterator(); it.hasNext(); )
2346
        {
2347
            ReleaseConfig rc = it.next();
2348
            element.addElement(rc.getMachineEntry());
2349
        }
2350
 
2351
        //
2352
        //  Now the email information
2353
        //
2354
        if ( p != null)
2355
        {
2356
            p.emailInfo(this, element);
2357
        }
2358
    }
2359
 
2360
    /** Generate package information
2361
     *  Only when running unit tests
2362
     *  
2363
     * @param xml	- An xml element to append data to
2364
     * @param p	- Package to process
2365
     */
2366
    private void generatePackageInfo (XmlBuilder xml, Package p)
2367
    {
7071 dpurdie 2368
        StringBuilder comment = new StringBuilder();
2369
        StringBuilder deps = new StringBuilder();
2370
 
7051 dpurdie 2371
        String joiner = "";
2372
        for (Iterator<String> it2 = p.mDependencyCollection.iterator(); it2.hasNext(); )
2373
        {
2374
            String alias = it2.next();
7071 dpurdie 2375
            deps.append(joiner).append(alias); 
7051 dpurdie 2376
            joiner = ",";
2377
        }
2378
 
7071 dpurdie 2379
        comment.append("pvid=").append(p.mId);
2380
        comment.append(" name=").append('"').append(p.mAlias).append('"');
2381
        comment.append(" reason=").append(p.mNoBuildReason);
2382
        comment.append(" buildFile=").append(p.mBuildFile);
2383
        comment.append(" directlyPlanned=").append(p.mDirectlyPlanned);
2384
        comment.append(" indirectlyPlanned=").append(p.mIndirectlyPlanned);
2385
        comment.append(" depends=[").append(deps).append("]");
6914 dpurdie 2386
 
7071 dpurdie 2387
        xml.addComment(comment.toString());            
6914 dpurdie 2388
    }
2389
 
2390
    /**returns an ant target for the passed Package
2391
     * in daemon mode:
2392
     *  packages are categorized with one of three mBuildFile values:
2393
     *   1 the package to be built by this buildfile
2394
     *   2 the packages with a future build requirement
2395
     *   3 the packages with no build requirement
2396
     *  the returned target depends on this categorization and will have
2397
     *   1 full abt info
2398
     *   2 full dependency info to determine future build ordering but no abt info (will not build this package)
2399
     *   3 only a name attribute (will not build this package)
2400
     * in escrow mode:
2401
     *  if the passed Package's mBuildFile is different (less than) the passed build file,
2402
     *  the returned target have only a name attribute (will not build this package)
2403
     *   
2404
     * @param xml - Xml element to extend
2405
     * @param buildEntry - Record build type (dummy/generic/not generic)
2406
     * @param p - Package to process
2407
     * @param buildFile - buildfile level being processed
2408
     */
2409
    private void generateTarget(XmlBuilder xml, BuildFile buildEntry, Package p, int buildFile)
2410
    {
2411
        mLogger.debug("generateTarget");
2412
 
2413
        //---------------------------------------------------------------------
2414
        //  Generate the AbtData - common machine and email information
2415
        //  Only used by the daemon builds
2416
        //
2417
        if ( mDaemon && p.mBuildFile == 1 )
2418
        {
2419
            generateMachineInfo(xml, p );
2420
        }
2421
 
2422
        //-------------------------------------------------------------------------
2423
        //  Generate the <target name=... /> construct
2424
        //  There are two types
2425
        //      1) Simple dummy place holder. Just has the PackageName.PackageExt
2426
        //      2) Full target. Has all information to build the package including
2427
        //              AbtSetUp, AbtTearDown and AbtPublish targets
2428
        //
2429
 
2430
        if ( !mDaemon && ( p.mBuildFile < buildFile ) )
2431
        {
2432
            XmlBuilder target = xml.addNewElement("target");
2433
            target.addAttribute("name", p.mAlias);
2434
        }
2435
        else
2436
        {
2437
            if (!mDaemon) 
2438
            {
2439
                //  Escrow Only:
2440
                //  Generate the 'wrapper' target
2441
                //  This is used to ensure that the required dependencies have been built - I think
2442
                //
2443
                StringAppender dependList = new StringAppender(",");
2444
                if ( !p.mPackageDependencyCollection.isEmpty() )
2445
                {
2446
                    for (Iterator<Package> it = p.mPackageDependencyCollection.iterator(); it.hasNext(); )
2447
                    {
2448
                        Package dependency = it.next();
2449
                        if ( !mDaemon && dependency.mBuildFile == -2 )
2450
                        {
2451
                            // ignore targets which build in foreign environments in escrow mode
2452
                            continue;
2453
                        }
2454
                        dependList.append(dependency.mAlias);
2455
                    }
2456
                }
2457
 
2458
                XmlBuilder target = xml.addNewElement("target").isExpanded();
2459
                target.addAttribute("name", p.mAlias + ".wrap");
2460
 
2461
                if (dependList.length() > 0)
2462
                {
2463
                    target.addAttribute("depends", dependList.toString() );
2464
                }
2465
 
2466
                if ( !mDaemon )
2467
                {
2468
                    boolean hasDependenciesBuiltInThisIteration = false;
2469
                    if ( ( !p.mPackageDependencyCollection.isEmpty()) )
2470
                    {
2471
                        for (Iterator<Package> it = p.mPackageDependencyCollection.iterator(); it.hasNext(); )
2472
                        {
2473
                            Package dependency = it.next();
2474
 
2475
                            if ( dependency.mBuildFile == buildFile )
2476
                            {
2477
                                hasDependenciesBuiltInThisIteration = true;
2478
                                break;
2479
                            }
2480
                        }
2481
                    }
2482
 
2483
                    if ( hasDependenciesBuiltInThisIteration )
2484
                    {
2485
                        XmlBuilder condition = target.addNewElement("condition");
2486
                        condition.addAttribute("property",  p.mAlias + ".build");
2487
 
2488
                        XmlBuilder and = condition.addNewElement("and");
2489
 
2490
                        for (Iterator<Package> it = p.mPackageDependencyCollection.iterator(); it.hasNext(); )
2491
                        {
2492
                            Package dependency = it.next();
2493
 
2494
                            if ( dependency.mBuildFile == buildFile )
2495
                            {
2496
                                XmlBuilder or = and.addNewElement("or");
2497
 
2498
                                XmlBuilder equal1 = or.addNewElement("equals");
2499
                                equal1.addAttribute("arg1", "${" + dependency.mAlias + ".res}");
2500
                                equal1.addAttribute("arg2", "0");
2501
 
2502
                                XmlBuilder equal2 = or.addNewElement("equals");
2503
                                equal2.addAttribute("arg1", "${" + dependency.mAlias + ".res}");
2504
                                equal2.addAttribute("arg2", "257");
2505
                            }
2506
                        }
2507
                    }
2508
                    else
2509
                    {
2510
                        target.addProperty(p.mAlias + ".build", "");
2511
                    }
2512
                }
2513
            }
2514
 
2515
 
2516
            //
2517
            //  Generate the 'body' of the target package
2518
            //  Escrow Mode: Always
2519
            //  Daemon Mode: Only for the one target we are building
2520
            //                  Simplifies the XML
2521
            //                  Reduces noise in the logs
2522
            //              Don't add target dependencies. 
2523
            //                  We are only building one target and the 
2524
            //                  dependency management has been done way before now.
2525
            //                  All it does is makes the logs noisy.
2526
            //
2527
            if ( ( mDaemon && p.mBuildFile == 1 ) || !mDaemon )
2528
            {
2529
                XmlBuilder target = xml.addNewElement("target").isExpanded();
2530
                target.addAttribute("name", p.mAlias);
2531
 
2532
                if ( !mDaemon )
2533
                {
2534
                    target.addAttribute("depends",  p.mAlias + ".wrap");
2535
                    target.addAttribute("if",p.mAlias + ".build");
2536
                }
2537
 
2538
                if ( mDaemon && p.mBuildFile == 1 )
2539
                {
2540
                    target.addProperty(p.mAlias + "pkg_id",p.mPid);
2541
                    target.addProperty(p.mAlias + "pv_id",p.mId);
2542
                }
2543
 
2544
                target.addProperty(p.mAlias + "packagename",p.mName);        		
2545
                target.addProperty(p.mAlias + "packageversion",p.mVersion);
2546
                target.addProperty(p.mAlias + "packageextension",p.mExtension);
2547
                target.addProperty(p.mAlias + "packagevcstag",p.mVcsTag);
2548
 
2549
                target.makePropertyTag(p.mAlias + "directchange", p.mDirectlyPlanned); 
2550
                target.makePropertyTag(p.mAlias + "doesnotrequiresourcecontrolinteraction", ! p.mRequiresSourceControlInteraction);
2551
 
2552
                buildEntry.state = BuildFile.BuildFileState.NonGeneric;
2553
                if ( p.isGeneric() )
2554
                {
2555
                    buildEntry.state = BuildFile.BuildFileState.Generic;
2556
                    target.makePropertyTag(p.mAlias + "generic", true); 
2557
                }
2558
 
2559
                target.addProperty(p.mAlias + "loc", getBuildLocation(p));
2560
                target.makePropertyTag(p.mAlias + "unittests", p.mHasAutomatedUnitTests && mDaemon);
2561
 
2562
                //    Add our own task and associated information
2563
                //
2564
                XmlBuilder abt = target.addNewElement("abt").isExpanded();
2565
 
2566
                for (Iterator<Package> it = p.mPackageDependencyCollection.iterator(); it.hasNext(); )
2567
                {
2568
                    Package dependency = it.next();
2569
                    XmlBuilder depend = abt.addNewElement("depend");
2570
                    depend.addAttribute("package_alias", "${" + dependency.mAlias + "}");
2571
                }
2572
 
2573
                buildInfo(abt,p);
2574
 
2575
                if ( mDaemon && p.mBuildFile == 1 )
2576
                {
2577
                    //    AbtTestPath
2578
                    target = xml.addNewElement("target").isExpanded();
2579
                    target.addAttribute("name", "AbtTestPath");
2580
                    target.addProperty("AbtTestPathpackagevcstag", p.mVcsTag);
2581
                    target.addProperty("AbtTestPathpackagename", p.mName);
2582
                    abt = target.addNewElement("abt").isExpanded();
2583
                    buildInfo(abt, p);
2584
 
2585
 
2586
                    //    AbtSetUp
2587
                    target = xml.addNewElement("target").isExpanded();
2588
                    target.addAttribute("name", "AbtSetUp");
2589
                    target.addProperty("AbtSetUppackagevcstag", p.mVcsTag);
2590
                    target.addProperty("AbtSetUppackagename", p.mName);
2591
 
2592
                    abt = target.addNewElement("abt").isExpanded();
2593
                    buildInfo(abt, p);
2594
 
2595
                    //    AbtTearDown
2596
                    target = xml.addNewElement("target").isExpanded();
2597
                    target.addAttribute("name", "AbtTearDown");
2598
                    target.addProperty("AbtTearDownpackagevcstag", p.mVcsTag);
2599
                    target.addProperty("AbtTearDownpackagename", p.mName);
2600
                    target.addProperty("AbtTearDownpackageversion", p.mVersion);
2601
                    target.addProperty("AbtTearDownpackageextension", p.mExtension);
2602
                    target.makePropertyTag(p.mAlias + "generic", p.isGeneric());
2603
 
2604
                    abt = target.addNewElement("abt").isExpanded();
2605
                    buildInfo(abt, p);
2606
 
2607
 
2608
                    //  AbtPublish
2609
                    target = xml.addNewElement("target").isExpanded();
2610
                    target.addAttribute("name", "AbtPublish");
2611
 
2612
                    target.addProperty("AbtPublishpackagevcstag", p.mVcsTag);
2613
                    target.addProperty("AbtPublishpackagename", p.mName);
2614
                    target.addProperty("AbtPublishpackageversion", p.mVersion);
2615
                    target.addProperty("AbtPublishpackageextension", p.mExtension);
2616
                    target.makePropertyTag("AbtPublishdirectchange", p.mDirectlyPlanned);
2617
                    target.makePropertyTag("AbtPublishdoesnotrequiresourcecontrolinteraction", ! p.mRequiresSourceControlInteraction);
2618
                    target.makePropertyTag("AbtPublishgeneric", p.isGeneric());
2619
                    target.addProperty("AbtPublishloc", getBuildLocation(p));
2620
 
2621
                    abt = target.addNewElement("abt").isExpanded();
2622
                    buildInfo(abt, p);
2623
 
2624
                }
2625
            }
2626
        }
2627
    }
2628
 
2629
    /** Extends the xml object. Adds ant default target for the current build iteration
2630
     * @param xml - The XmlBuilder Object to extend
2631
     * @param buildFile - The current build file level. This differs for Daemon and Escrow mode. In Daemon mode it will not be a '1' 
2632
     */
2633
    private void generateDefaultTarget(XmlBuilder xml, int buildFile)
2634
    {
2635
        mLogger.debug("generateDefaultTarget");
2636
 
2637
        XmlBuilder target = xml.addNewElement("target").isExpanded();
2638
        target.addAttribute("name", "fullstart");
2639
 
2640
        if (buildFile == 1)
2641
        {
2642
            antEcho(target, "${line.separator}" + mAnyBuildPlatforms + "${line.separator}${line.separator}");
7048 dpurdie 2643
            for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 2644
            {
2645
                Package p = it.next();
2646
 
2647
                if ( p.mBuildFile == -1 )
2648
                {
2649
                    antEcho(target, "${line.separator}" + p.mAlias + "${line.separator}");
2650
                }
2651
            }
2652
 
2653
            antEcho(target, "${line.separator}" + mAssocBuildPlatforms + "${line.separator}${line.separator}");
7048 dpurdie 2654
            for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 2655
            {
2656
                Package p = it.next();
2657
 
2658
                if ( p.mBuildFile == -2 )
2659
                {
2660
                    antEcho(target, "${line.separator}" + p.mAlias + "${line.separator}");
2661
                }
2662
            }
2663
 
2664
            antEcho(target, "${line.separator}" + mNotInBaseline + "${line.separator}${line.separator}");
7048 dpurdie 2665
            for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 2666
            {
2667
                Package p = it.next();
2668
 
2669
                if ( p.mBuildFile == -4 )
2670
                {
2671
                    antEcho(target, "${line.separator}" + p.mAlias + "${line.separator}");
2672
                }
2673
            }
2674
 
2675
            antEcho(target, "${line.separator}" + mDependent + "${line.separator}${line.separator}");
7048 dpurdie 2676
            for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 2677
            {
2678
                Package p = it.next();
2679
 
2680
                if ( p.mBuildFile == -5 )
2681
                {
2682
                    antEcho(target, "${line.separator}" + p.mAlias + "${line.separator}");
2683
                }
2684
            }
2685
        }
2686
 
2687
        if ( !mDaemon )
2688
        {
2689
            antEcho(target, "${line.separator}Build Started:${line.separator}${line.separator}");
2690
        }
2691
 
2692
        //
2693
        //	Create a comma separated list of all the required targets
2694
        //      Escrow : All packages
2695
        //      Daemon : Just the package being built
2696
        //
2697
        StringAppender dependList = new StringAppender(",");
2698
        dependList.append("fullstart");
7048 dpurdie 2699
        for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 2700
        {
2701
            Package p = it.next();
2702
 
2703
            if ( ( p.mBuildFile > 0 ) && ( p.mBuildFile <= buildFile ) )
2704
            {
2705
                if ((mDaemon && p.mBuildFile == 1) || !mDaemon)
2706
                {
2707
                    dependList.append(p.mAlias);                    
2708
                }
2709
            }
2710
        }
2711
 
2712
        target = xml.addNewElement("target").isExpanded();
2713
        target.addAttribute("name", "full");
2714
        target.addAttribute("depends", dependList.toString());
2715
 
2716
        if ( !mDaemon )
2717
        {
2718
            antEcho(target, "${line.separator}Build Finished${line.separator}");
2719
        }
2720
    }
2721
 
2722
    /** Internal helper function to create an ant 'echo statement
2723
     *  Many of the parameters are fixed
2724
     */
2725
    private void antEcho( XmlBuilder xml, String message)
2726
    {
2727
        XmlBuilder msg = xml.addNewElement("echo");
2728
        msg.addAttribute("message", message);
2729
        msg.addAttribute("file", "publish.log");
2730
        msg.addAttribute("append", "true");
2731
    }
2732
 
2733
    /**sets the mIndirectlyPlanned true for the package and all dependent packages
2734
     */
2735
    private void rippleIndirectlyPlanned(Package p)
2736
    {
2737
        mLogger.debug("rippleIndirectlyPlanned");
2738
        if ( !p.mIndirectlyPlanned && p.mBuildFile == 0 )
2739
        {
2740
            p.mIndirectlyPlanned = true;
2741
 
7048 dpurdie 2742
            for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 2743
            {
2744
                Package pkg = it.next();
2745
 
2746
                if ( pkg != p )
2747
                {
2748
                    for (Iterator<Package> it2 = pkg.mPackageDependencyCollection.iterator(); it2.hasNext(); )
2749
                    {
2750
                        Package dependency = it2.next();
2751
 
2752
                        if ( dependency == p )
2753
                        {
2754
                            rippleIndirectlyPlanned( pkg );
2755
                            break;
2756
                        }
2757
                    }
2758
                }
2759
            }
2760
        }
7048 dpurdie 2761
        mLogger.info("rippleIndirectlyPlanned set {} {}", p.mName, p.mIndirectlyPlanned);    
6914 dpurdie 2762
    }
2763
 
2764
    /**accessor method
2765
     */
2766
    public String getEscrowSetUp()
2767
    {
2768
        mLogger.debug("getEscrowSetUp");
2769
        String retVal = mEscrowSetup;
2770
 
7048 dpurdie 2771
        mLogger.debug("getEscrowSetUp returned {}", retVal);
6914 dpurdie 2772
        return retVal;
2773
    }
2774
 
2775
    /**accessor method
2776
     */
2777
    public String getRawData()
2778
    {
2779
        mLogger.debug("getRawData");
2780
        String retVal = mEscrowRawData;
2781
 
7048 dpurdie 2782
        mLogger.debug("getRawData returned {}", retVal);
6914 dpurdie 2783
        return retVal;
2784
    }
2785
 
2786
    /**Get the build loc (location)
2787
     * This is package specific and will depend on the build mode (Escrow/Daemon)
2788
     * 
2789
     * @param	p - Package being built
2790
     * @return A string that describes the build location
2791
     */
2792
    private String getBuildLocation(Package p)
2793
    {
2794
        mLogger.debug("locationProperty");
2795
        String location = "";
2796
 
2797
        if (mDaemon)
2798
        {
2799
            // Daemon: Start in root of view/workspace
2800
            location += mBaseline;
2801
        }
2802
        else
2803
        {
2804
            // Escrow: mAlias used with jats -extractfiles -view
2805
            location += p.mAlias;
2806
        }
2807
 
2808
        //
2809
        //  Always use '/' as a path separator - even if user has specified '\'
2810
        //  Ant can handle it.
2811
        //
2812
        location = location.replace('\\', '/');
2813
        return location;
2814
    }
2815
 
2816
    /**Adds package build into as XML elements 
2817
     * @param	  xml 	- Xml element to extend
2818
     * @param   p       - Package to process
2819
     */
2820
    private void buildInfo(XmlBuilder xml, Package p)
2821
    {
2822
        mLogger.debug("buildInfo");
2823
 
2824
        //
2825
        // Create the xml build information
2826
        // <platform gbe_machtype="linux_i386" type="jats" arg="all"/>
2827
        //
2828
        for (Iterator<BuildStandard> it = p.mBuildStandardCollection.iterator(); it.hasNext();)
2829
        {
2830
            BuildStandard bs = it.next();
2831
            bs.getBuildStandardXml(xml);
2832
        }
2833
    }
2834
 
2835
    /**returns the buildInfo as a single line of text
2836
     * Used for reporting purposes only
2837
     * @param   p       - Package to process
2838
     * 
2839
     */
2840
    public String buildInfoText(Package p)
2841
    {
2842
        mLogger.debug("buildInfoText");
2843
 
2844
        StringAppender result = new StringAppender (";");
2845
 
2846
        //
2847
        //  Create platform:standards
2848
        //      
2849
        for (Iterator<BuildStandard> it = p.mBuildStandardCollection.iterator(); it.hasNext(); )
2850
        {
2851
            BuildStandard bs = it.next();
2852
 
2853
            if ( bs.isActive() )
2854
            {
2855
                String info = bs.getBuildStandardText();
2856
                result.append(info);
2857
            }
2858
        }
2859
 
7048 dpurdie 2860
        mLogger.info("buildInfoText returned {}", result);
6914 dpurdie 2861
        return result.toString();
2862
    }
2863
 
2864
    /**prints to standard out in escrow mode only
2865
     * <br>Prints a title and information. The title is only printed once.
2866
     * 
2867
     * @param header - The message title to display, if printMessage is true
2868
     * @param text - A package name. Really just the 2nd line of the message
2869
     * @param printHeader -  Controls the printing of the message argument
2870
     */
2871
    private void standardOut(final String header, final String text, boolean printHeader)
2872
    {
2873
        mLogger.debug("standardOut");
2874
        if (!mDaemon)
2875
        {
2876
            if ( printHeader )
2877
            {
2878
                System.out.println(header);
2879
            }
2880
 
2881
            System.out.println(text);
2882
        }
2883
    }
2884
 
2885
 
2886
    /**
2887
     *  Email users about a rejected daemon instruction
2888
     *  @param  reason  - Reason for the rejection
2889
     *  @param  pkg     - Package to be affected by the instruction
2890
     *  
2891
     */
2892
    public void emailRejectedDaemonInstruction(String reason, Package p)
2893
    {
2894
        mLogger.debug("emailRejectedDaemonInstruction");
2895
 
2896
        //  Email Subject
2897
        String subject = "BUILD FAILURE of Daemon Instruction on package " + p.mAlias;
2898
 
2899
        // Email Body
2900
        String mailBody = "The build system reject the the Daemon Instruction";
2901
        mailBody += "<br>Reason: " + reason; 
2902
 
2903
        mailBody += "<p>Release: " + mBaselineName 
2904
                +  "<br>Package: " + p.mAlias 
2905
                +  "<br>Rm Ref: " + CreateUrls.generateRmUrl(getRtagId(), p.mId); 
2906
 
2907
        mailBody += "<p><hr>";
2908
 
2909
        String target = p.emailInfoNonAntTask(this);
2910
 
7048 dpurdie 2911
        mLogger.error("emailRejectedDaemonInstruction Server: {}", getMailServer());
2912
        mLogger.error("emailRejectedDaemonInstruction Sender: {}", getMailSender());
2913
        mLogger.error("emailRejectedDaemonInstruction Target: {}", target);
6914 dpurdie 2914
 
2915
        try
2916
        {
2917
            //    
7048 dpurdie 2918
            Smtpsend.send(getMailServer(),  // mailServer
2919
                    getMailSender(),        // source
2920
                    target,                 // target
2921
                    getMailSender(),        // cc
2922
                    null,                   // bcc
2923
                    subject,                // subject
2924
                    mailBody,               // body
2925
                    null                    // attachment
6914 dpurdie 2926
                    );
2927
        } catch (Exception e)
2928
        {
7048 dpurdie 2929
            mLogger.warn("Email Failure: emailRejectedDaemonInstruction:{}", e.getMessage());
6914 dpurdie 2930
        }
2931
    }
2932
 
2933
    /**
2934
     * @return the mMailServer
2935
     */
2936
    public String getMailServer() {
2937
        return mMailServer;
2938
    }
2939
 
2940
    /**
2941
     * @param mMailServer the mMailServer to set
2942
     */
2943
    public void setMailServer(String mMailServer) {
2944
        this.mMailServer = mMailServer;
2945
    }
2946
 
2947
    /**
2948
     * @return the mMailSender
2949
     */
2950
    public String getMailSender() {
2951
        return mMailSender;
2952
    }
2953
 
2954
    /**
2955
     * @param mMailSender the mMailSender to set
2956
     */
2957
    public void setMailSender(String mMailSender) {
2958
        this.mMailSender = mMailSender;
2959
    }
2960
 
2961
    /**
2962
     * @return the mMailGlobalTarget
2963
     */
2964
    public String getMailGlobalTarget() {
2965
        return mMailGlobalTarget;
2966
    }
2967
 
2968
    /**
2969
     * @param mMailGlobalTarget the mMailGlobalTarget to set
2970
     */
2971
    public void setMailGlobalTarget(String mMailGlobalTarget) {
2972
        this.mMailGlobalTarget = mMailGlobalTarget;
2973
    }
2974
 
2975
}