Subversion Repositories DevTools

Rev

Rev 7096 | 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
                    //
952
                    mLogger.error("PLAN STATS: Estimated time to complete current plan (ETC): {}", basicPlan.planTime);
953
                    mLogger.error("PLAN STATS: Estimated time to full plan (PBT): {}", fullPlan.planTime);
954
                    mLogger.error("PLAN STATS: Build Impact (BI): {}", (fullPlan.planTime - basicPlan.planTime) / (float)basicPlan.planTime);
955
                    mLogger.error("PLAN STATS: Build Efficency (BE): {}", (float)fullPlan.planTime  / (fullPlan.planTime / basicPlan.planTime));
956
 
957
 
7079 dpurdie 958
                    if ( (basicPlan.planTime * 12) <= (fullPlan.planTime * 10) )
959
                    {
960
                        //  Use the basic plan FOLLOWED by a plan that does not include
961
                        //      Ripples done by the basic plan
962
                        //      WIPs/RIPPLES done in the course of doing the basic plan
7093 dpurdie 963
                        mLogger.error("Use basic plan, then modified full plan");
7079 dpurdie 964
                        mBuildOrder.addAll(basicPlan.planCollection);
965
                        fullPlan = postRipplePlan("Full-Ripples", basicPlan, false);
966
                        mBuildOrder.addAll(fullPlan.planCollection);
967
 
968
                    } else {
969
                        //  Use the full plan
7093 dpurdie 970
                        mLogger.error("Use full plan");
7079 dpurdie 971
                        mBuildOrder.addAll(fullPlan.planCollection);
972
                    }
973
                } else if (!basicPlan.planCollection.isEmpty() ) {
974
                    // Use the basic plan
7093 dpurdie 975
                    mLogger.error("Use basic plan");
7079 dpurdie 976
                    mBuildOrder.addAll(basicPlan.planCollection);
977
 
7080 dpurdie 978
                } else if ( !fullPlan.planCollection.isEmpty() ) {
979
                    // Use the full plan
7093 dpurdie 980
                    mLogger.error("Use full plan");
7081 dpurdie 981
                    mBuildOrder.addAll(fullPlan.planCollection);
7079 dpurdie 982
 
983
                } else {
984
                    // Do not have a plan
985
                    // May have tests requests
7093 dpurdie 986
                    mLogger.error("Use NO plan");
7079 dpurdie 987
                }
988
 
7096 dpurdie 989
                //
990
                //  Now have a build order
991
                //  Allocate new version numbers
992
                //      Examine packages with a buidLevel of zero
993
                //  If we fail all of them then we can't build anything
994
                //
995
                mLogger.error("Determine new version numbers");
996
                Package build = ReleaseManager.NULL_PACKAGE;
997
                for (Iterator<PlannedPackage> it = mBuildOrder.iterator(); it.hasNext(); )
998
                {
999
                    PlannedPackage pkg = it.next();
1000
                    if (pkg.mBuildLevel != 0)
1001
                    {
1002
                        continue;
1003
                    }
1004
 
1005
                    //
1006
                    //  Attempt to allocate a new version number
1007
                    //  If we can't generate a new version number, then this is considered to be a build failure
1008
                    //  The package will be excluded and the user will be emailed
1009
                    //
1010
 
1011
 
1012
                    Package p = pkg.mPkg;
1013
 
1014
                    int pvApplied = p.applyPV(mReleaseManager);
1015
 
1016
                    if ( pvApplied == 0)
1017
                    {
1018
                        build = p;
1019
                        break;
1020
                    }
1021
                    else if ( pvApplied == 1 )
1022
                    {
1023
                        // max 50 chars
1024
                        rippleBuildExclude(p, p.mId, "Package has non standard versioning", -12);
1025
                    }
1026
                    else if ( pvApplied == 2 )
1027
                    {
1028
                        // max 50 chars
1029
                        rippleBuildExclude(p, p.mId, "Package has reached ripple field limitations", -12);
1030
                    }
1031
                    else if ( pvApplied == 3 )
1032
                    {
1033
                        // max 50 chars
1034
                        rippleBuildExclude(p, p.mId, "Package has invalid change type", -12);
1035
                    }
1036
                    else
1037
                    {
1038
                        // max 50 chars
1039
                        // Bad programming - should not get here
1040
                        rippleBuildExclude(p, p.mId, "Unable to calculate next version", -12);
1041
                    }
1042
                }
1043
 
1044
 
7079 dpurdie 1045
                //  Now have an mBuildOrder
7096 dpurdie 1046
                //  Mark the selected package in the build order as the one to be built
1047
                //  May need to process its it a bit more
7094 dpurdie 1048
                //  
7079 dpurdie 1049
                if (!mBuildOrder.isEmpty()) {
1050
                    build.mBuildFile = 1;
1051
 
1052
                    if ( build.mForcedRippleInstruction > 0 )
1053
                    {
1054
                        mReleaseManager.markDaemonInstCompleted( build.mForcedRippleInstruction );
1055
                    }
1056
 
1057
                    if ( build.mTestBuildInstruction > 0 )
1058
                    {
1059
                        mReleaseManager.markDaemonInstInProgress( build.mTestBuildInstruction );
1060
                    }
1061
 
1062
                    //  Now that we know which package we are building
1063
                    //      Set the previously calculated nextVersion as the packages version number
1064
                    //      Claim the version number to prevent other builds from using it. Even if doing a test build
1065
                    //
7093 dpurdie 1066
                    mLogger.error("Update mVersion: {}", build);
7079 dpurdie 1067
                    if (build.mNextVersion != null)
1068
                    {
1069
                        mReleaseManager.claimVersion(build.mPid, build.mNextVersion + build.mExtension, mBaseline);
1070
                        build.mVersion = build.mNextVersion;
7093 dpurdie 1071
                        mLogger.error("Update mVersion: {} to {}", build, build.mVersion);
7079 dpurdie 1072
                    }
1073
                }
1074
 
1075
                //
1076
                //  Massage the package collection
1077
                //      Replace WIP/TEST/RIPPLE so that the mPackageCollection is a collection of packages we would like in the release
1078
                //      Don't replace those that we can't build due to errors
1079
                //  
6914 dpurdie 1080
 
7079 dpurdie 1081
                //         Update packages in the basicPlan
1082
                //         Update / Add packages to the fullPlan
1083
                //
1084
                ArrayList<Package> buildCandidates = new ArrayList<Package>();
1085
                buildCandidates.addAll(mPackageCollectionTest);
1086
                buildCandidates.addAll(mPackageCollectionWip);
1087
                buildCandidates.addAll(mPackageCollectionRipple);
1088
 
1089
                for (Iterator<Package> it = buildCandidates.iterator(); it.hasNext(); )
1090
                {
1091
                    Package p = it.next();
1092
                    if ( p.mBuildFile >= 0 )
1093
                    {
1094
                        Package pReleased = findPackage(p.mAlias);
1095
                        if ( pReleased != ReleaseManager.NULL_PACKAGE)
1096
                        {
1097
                            int index = mReleaseManager.findPackageLastIndex;
1098
                            mPackageCollection.set(index, p);
1099
                            p.mIsNotReleased = false;
1100
                        }
1101
                        else
1102
                        {
1103
                            mPackageCollection.add(p);
1104
                            p.mIsNotReleased = false;
1105
                        }
1106
                    }
1107
                }
1108
 
1109
                //
1110
                //  Report packages that are indirectly excluded
7081 dpurdie 1111
                //  ie: They will not be built because one, or more, of there dependents is not buildable
7079 dpurdie 1112
                //
1113
                mLogger.debug("planBuildOrder process packages which are not ripple buildable");
1114
 
1115
                 for (ListIterator<BuildExclusion> it = mBuildExclusionCollection.listIterator(); it.hasNext(); )
1116
                 {
1117
                     BuildExclusion be = it.next();
1118
 
1119
                     for (Iterator<Package> it1 = mPackageCollection.iterator(); it1.hasNext(); )
1120
                     {
1121
                         Package p = it1.next();
1122
 
1123
                         // ensure only root cause, non test build, build exclusions are excluded
1124
                         // mBuildExclusionCollection is at this point based on
1125
                         // relevant (direct and indirect) excluded pv's in the database
7081 dpurdie 1126
 
7079 dpurdie 1127
                         if ( be.compare(p.mId) && be.isARootCause() && p.mTestBuildInstruction == 0 && p.mForcedRippleInstruction == 0 )
1128
                         {
1129
                             // package is not reproducible, discard it and its consumers
1130
                             //
7081 dpurdie 1131
                             mLogger.info("Excluded Package {}, {}", p.mAlias, be );                                     
7079 dpurdie 1132
 
1133
                             ArrayList<Package> toExclude = new ArrayList<Package>();
1134
                             toExclude.addAll(usedByAnyPackages(p, mPackageCollection ));
1135
 
1136
                             //  Process packages that we need to exclude indirectly
1137
                             //
1138
                             while ( ! toExclude.isEmpty())
1139
                             {
1140
                                 Package pkg = toExclude.remove(0);
1141
 
7081 dpurdie 1142
                                 // If this package has not been excluded (for whatever reason), than add it
7079 dpurdie 1143
                                 boolean found = false;
1144
                                 for (Iterator<BuildExclusion> it2 = mBuildExclusionCollection.iterator(); it2.hasNext(); )
1145
                                 {
1146
                                     BuildExclusion buildExclusion = it2.next();
1147
                                     if (buildExclusion.compare(pkg.mId) )
1148
                                     {
1149
                                         found = true;
7081 dpurdie 1150
                                         if  ( buildExclusion.isImported() )
1151
                                         {
1152
                                             // An exclusion for this package already exists
1153
                                             // If it was 'imported' from the database then 
1154
                                             // mark it as processed so that it will be persisted
1155
                                             //
1156
                                             // Otherwise it will be a new one
1157
                                             //
1158
                                             buildExclusion.setProcessed();
1159
                                         }
7079 dpurdie 1160
                                         break;
1161
                                     }
1162
                                 }
1163
 
1164
                                 if (!found)
1165
                                 {
1166
                                     BuildExclusion buildExclusion = new BuildExclusion(pkg.mId, p.mId, null, p.mTestBuildInstruction);
1167
                                     it.add(buildExclusion);
7096 dpurdie 1168
                                     mLogger.info("Indirectly Excluded Package {}", pkg.mAlias);
1169
                                     pkg.mBuildFile = -5; 
7079 dpurdie 1170
 
7094 dpurdie 1171
                                     ArrayList<Package> usedBy = usedByAnyPackages(pkg, mPackageCollectionAll );
7079 dpurdie 1172
                                     toExclude.addAll(usedBy);
1173
                                 }
1174
                             }
1175
                         }
1176
                     }
1177
                 }
7096 dpurdie 1178
 
1179
                 //
1180
                 //  Examine the build order and 'delete' entries with a -ve mBuildFile
1181
                 //  These will be the product of pvApply errors and the packages that depend on them
1182
 
1183
                 for (Iterator<PlannedPackage> it = mBuildOrder.iterator(); it.hasNext(); )
1184
                 {
1185
                     PlannedPackage pkg = it.next();
1186
                     if (pkg.mPkg.mBuildFile < 0)
1187
                     {
1188
                         it.remove();
1189
                         mLogger.error("Purge mBuildOrder {}", pkg.mPkg);
1190
                     }
1191
                 }
1192
 
1193
 
7079 dpurdie 1194
 
1195
                //
1196
                //  To fit in with the old algorithm ( ie: could be improved )
1197
                //  Insert marks into all packages
1198
                //  Not sure exactly why - Its used in the generation of the ant build file
1199
                //                     Want to set mNoBuildReason, mBuildFile
1200
                //
1201
                //      Package we have selected to build: 0     , 1
1202
                //      Package we could have built      : 0     , 2
1203
                //      Packages we can't build          : reason, 3
1204
                //      Packages that are OK             : 3     , 3
1205
                //      ????                             : 0     , 3
1206
 
1207
                for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
1208
                {
1209
                    Package p = it.next();
1210
                    if (p == build ) {
1211
                        p.mNoBuildReason = 0;
1212
                        p.mBuildFile = 1;
1213
                    } 
1214
                    else if ( p.mBuildFile < 0 )
1215
                    {
1216
                        p.mNoBuildReason = p.mBuildFile;
1217
                        p.mBuildFile = 3;
1218
                    }
1219
                    else if (p.mBuildReason != null)
1220
                    {
1221
                        p.mNoBuildReason = 0;
1222
                        p.mBuildFile = 2;
1223
                    }
1224
                    else
1225
                    {
1226
                        p.mNoBuildReason = 0;
1227
                        p.mBuildFile = 3;
1228
                    }
1229
                }
1230
 
1231
            }
1232
            else
1233
            {
1234
                //  Escrow
1235
                //  The basic plan is the escrow build order
1236
                mBuildOrder = basicPlan.planCollection;
1237
            }
1238
 
1239
            mLogger.error("Final Plan");
1240
            for (Iterator<PlannedPackage> it = mBuildOrder.iterator(); it.hasNext(); )
1241
            {
1242
                PlannedPackage p = it.next();
7080 dpurdie 1243
                mLogger.error("Plan: {} {} {}", p.mBuildLevel, p.mPkg.mAlias, p.mPkg.mId);
7079 dpurdie 1244
            }
1245
 
1246
 
1247
        }
1248
 
7078 dpurdie 1249
    /** Internal class to contain intermediate results
6914 dpurdie 1250
     */
7078 dpurdie 1251
    class PlanResults {
1252
        int planTime = 0;
7079 dpurdie 1253
        ArrayList<PlannedPackage> planCollection = new ArrayList<PlannedPackage>(); 
7078 dpurdie 1254
    }
1255
 
1256
    /**
1257
     * Process a collection of packages and generate a collection of package plans
1258
     * A package plan is a collection of packages that can be built
1259
     *      The first item in the list is a package that can be built right now
1260
     *      Other items in the list will be packages that can be built now or will need to be built as the result
1261
     *      of a ripple
1262
     *      
1263
     * The method will be called multiple times so that we can evaluate different plans
1264
     * The underling packages will have data and flags that will need to be rested before a calculation      
1265
     *
1266
     * @param name - Name of the plan
1267
     * @param packageCollection - Base collection of packages to plan
1268
     * @param mode - true: Include 'Ripples'
1269
     * 
1270
     * @return
1271
     */
1272
    private PlanResults planCollection(String name, ArrayList<Package> packageCollection, boolean mode)
7070 dpurdie 1273
    {
7094 dpurdie 1274
        Phase phase = new Phase("PlanCollection"); 
7079 dpurdie 1275
        ArrayList<PlannedPackage> ripplePlan = new ArrayList<PlannedPackage>();
7078 dpurdie 1276
        PlanResults results = new PlanResults();
6914 dpurdie 1277
 
7078 dpurdie 1278
        //  Reset flags used in the calculations
1279
        Package.resetProcessed(packageCollection);
6914 dpurdie 1280
 
7078 dpurdie 1281
        //  Exclude all packages that cannot be built and all packages that depend on them
1282
        //      First find packages to be directly excluded
1283
        ArrayList<Package>exclude = new ArrayList<Package>();
7094 dpurdie 1284
        phase.setPhase("Exclude Unbuildable");
7078 dpurdie 1285
        for (Iterator<Package> it = packageCollection.iterator(); it.hasNext(); )
1286
        {
1287
            Package p = it.next();
7081 dpurdie 1288
            if ( p.mBuildFile == -8 ) {
1289
 
1290
                //  Mark SDK or Pegged so that we don't build them, but can build their dependents
1291
                p.mProcessed = true;
1292
                p.mIsProcessed = true;
1293
                mLogger.error("SDK/Peg Exclude: {}", p);
1294
 
1295
            } else if (p.mBuildFile < 0 ) {
7078 dpurdie 1296
                exclude.add(p);
7081 dpurdie 1297
                mLogger.error("Direct Exclude: {}", p);
1298
 
7078 dpurdie 1299
            }
1300
        }
1301
 
7080 dpurdie 1302
        //  Exclude packages that have failed to be built
1303
        //      These are recorded in mBuildExclusionCollection
7094 dpurdie 1304
        phase.setPhase("Exclude Build Failures");
7080 dpurdie 1305
        for (ListIterator<BuildExclusion> it = mBuildExclusionCollection.listIterator(); it.hasNext(); )
1306
        {
1307
            BuildExclusion be = it.next();
7094 dpurdie 1308
            mLogger.error("BE: {}", be);
1309
            if ( !be.isAIndirectError() )
7080 dpurdie 1310
            {
1311
                for (Iterator<Package> it1 = packageCollection.iterator(); it1.hasNext(); )
1312
                {
1313
                    Package p = it1.next();
7081 dpurdie 1314
                    if (p.mBuildFile >= 0 && p.mId == be.mId) {
7080 dpurdie 1315
                        p.mBuildFile  = -3;
7094 dpurdie 1316
                        mLogger.error("AddExclude {}",p);
7080 dpurdie 1317
                        exclude.add(p);
1318
                        break;
1319
                    }
1320
                }
1321
            }
1322
        }
1323
 
1324
 
7078 dpurdie 1325
        //  Process the list of packages to be excluded
1326
        //  Add to the list packages that depend on the excluded package that have not already been excluded
7094 dpurdie 1327
        phase.setPhase("ExcludeAllUsed");
7078 dpurdie 1328
        while( !exclude.isEmpty() )
1329
        {
1330
            Package p = exclude.remove(0);
1331
            p.mProcessed = true;
1332
            p.mIsProcessed = true;
7081 dpurdie 1333
            mLogger.error("planCollection package not buildable {}", p.mName);
7078 dpurdie 1334
 
1335
            for (Iterator<Package> it1 = packageCollection.iterator(); it1.hasNext(); )
1336
            {
1337
                Package pkg = it1.next();
1338
                if (pkg.mProcessed) {
1339
                    continue;
1340
                }
1341
 
7080 dpurdie 1342
                for (Iterator<String> it = pkg.mDependencyCollection.iterator(); it.hasNext(); )
7078 dpurdie 1343
                {
1344
                    String alias = it.next();
1345
                    if ( p.mAlias.compareTo( alias ) == 0 ) {
1346
                        exclude.add(pkg);
1347
                    }
1348
                }
1349
            }
1350
        }
1351
 
1352
        //  Now have a collection of packages with those that we cannot build have been marked
1353
        //  Process the list and determine packages that we can build right now
1354
        //      ie: they have not been excluded, have not already been discovered and do not depend on any package in the collection
1355
        //      Continue to do this until all packages have been extracted
1356
        //      Allocate build levels as we go
1357
        //
7094 dpurdie 1358
        phase.setPhase("Determine Build Order");
6914 dpurdie 1359
        boolean allProcessed = false;
7078 dpurdie 1360
        int buildLevel = 1;
6914 dpurdie 1361
 
1362
        do
1363
        {
7048 dpurdie 1364
            //
1365
            //  Create the mBuildOrder collection
1366
            //      Same for both Daemon and Escrow modes
1367
            //      Will have package build order and build level
6914 dpurdie 1368
            boolean allDependenciesProcessed = true;
1369
            do
1370
            {
1371
                allDependenciesProcessed = true;
7078 dpurdie 1372
                for (Iterator<Package> it = packageCollection.iterator(); it.hasNext(); )
6914 dpurdie 1373
                {
1374
                    Package p = it.next();
7078 dpurdie 1375
 
1376
                    //  Skip packages that have been processed - have determined build order, or cannot build
1377
                    if (p.mIsProcessed) {
1378
                        continue;
1379
                    }
6914 dpurdie 1380
 
7078 dpurdie 1381
                    // Package yet to be processed and
1382
                    //      Daemon mode: Could be built
1383
                    //      Escrow mode: Can be reproduced
1384
                    boolean canBeBuiltNow = true;
1385
                    boolean allDependenciesForThisPackageProcessed = true;
1386
 
1387
                    //  Scan the packages dependencies
1388
                    for ( Iterator<Package> it2 = p.mPackageDependencyCollection.iterator(); it2.hasNext(); )
6914 dpurdie 1389
                    {
7078 dpurdie 1390
                        Package dependency = it2.next();
6914 dpurdie 1391
 
7078 dpurdie 1392
                        if ( !dependency.mProcessed )
6914 dpurdie 1393
                        {
7078 dpurdie 1394
                            //  If all the dependencies have been processed, then we can potentially build this package
1395
                            //  If any of them have not been processed, then cannot calculate canBeBuiltNow until this 
1396
                            //  dependency has been processed
1397
                            allDependenciesForThisPackageProcessed = false;
1398
                            allDependenciesProcessed = false;
6914 dpurdie 1399
                        }
7078 dpurdie 1400
                        else if (  (  mDaemon && (   dependency.mBuildFile == 0 ) ||  (dependency.mBuildFile == buildLevel)) 
1401
                                || ( !mDaemon && ( ( dependency.mBuildFile == 0 ) ||
1402
                                                       ( dependency.mBuildFile == buildLevel &&
1403
                                                       ( !p.haveSameBuildStandards(dependency)  ) ) ) ) )
1404
                        {
1405
                            // Can be built - yet
1406
                            // Daemon mode:
1407
                            //    This processed dependency has not been assigned to a build iteration
1408
                            //    This processed dependency has been assigned to this build iteration
1409
                            // Escrow mode: This package cannot be built now if
1410
                            //    This processed dependency has not been assigned to a build iteration or
1411
                            //    This processed dependency has been assigned to this build iteration, but the 
1412
                            //    build standards of the package and this dependency prevent the package being
1413
                            //    built in this iteration.   
1414
                            canBeBuiltNow = false;
1415
                            mLogger.info("planRelease package cannot be built in this iteration {}", p.mName);
1416
                            break;
1417
                        }
1418
                    }
6914 dpurdie 1419
 
7078 dpurdie 1420
                    //  All dependencies have been processed. May be able to build this package
1421
                    //      Add the package to the build order list
1422
                    //
1423
                    if (allDependenciesForThisPackageProcessed)
1424
                    {
1425
                        p.mProcessed = true;
1426
                        if ( canBeBuiltNow )
6914 dpurdie 1427
                        {
7079 dpurdie 1428
                            results.planCollection.add( new PlannedPackage(p, buildLevel));
7078 dpurdie 1429
                            p.mBuildFile = buildLevel;
1430
                            p.mIsProcessed = true;
1431
                            mLogger.info("planRelease set mBuildFile to {} for package {}",buildLevel, p.mAlias );
6914 dpurdie 1432
                        }
1433
                    }
1434
                }
1435
            } while( !allDependenciesProcessed );
7048 dpurdie 1436
 
7095 dpurdie 1437
            //  Have process all the packages that we can build at the moment
7048 dpurdie 1438
            //      Examine all the packages in the collection to see if there are more that need to be extracted
1439
            //      These will be done at a different build-level
1440
            //  
1441
            allProcessed = true;
7078 dpurdie 1442
            for (Iterator<Package> it = packageCollection.iterator(); it.hasNext(); )
7048 dpurdie 1443
            {
1444
                Package p = it.next();
7078 dpurdie 1445
                if ( !  p.mIsProcessed )
7048 dpurdie 1446
                {
1447
                    // more build files are required
1448
                    allProcessed = false;
1449
                    mLogger.info("planRelease more build files are required for {}", p.mName);
1450
                    break;
1451
                }
1452
            }
6914 dpurdie 1453
 
7078 dpurdie 1454
            buildLevel++;
1455
            if (buildLevel % 500 == 0 ) {
1456
                mLogger.error("planRelease. Too many build levels {}", buildLevel);
7048 dpurdie 1457
            }
1458
        } while( !allProcessed );
7078 dpurdie 1459
 
1460
        //  Now we have a collection packages that we can build right now
1461
        //      The packages currently have a build level set into mBuildFile
1462
        //
1463
        if (mDaemon)
7048 dpurdie 1464
        {
7094 dpurdie 1465
            phase.setPhase("Calc Build Order");
1466
            //
7078 dpurdie 1467
            //  Determine if we have a reason to build anything in this collection of buildable packages
7095 dpurdie 1468
            //      Reset the calculated buildLevel - It will be calculated again
1469
            //      Reset the mProcessed - it will be used to detect  that we have processed a package
1470
 
7079 dpurdie 1471
            ArrayList<PlannedPackage> toBuild = new ArrayList<PlannedPackage>();
1472
            for (Iterator<PlannedPackage> it = results.planCollection.iterator(); it.hasNext(); )
6914 dpurdie 1473
            {
7079 dpurdie 1474
                PlannedPackage p = it.next();
1475
                p.mBuildLevel = 0;
7095 dpurdie 1476
                p.mPkg.mCheckedCircularDependency = false;
7079 dpurdie 1477
 
1478
                if (p.mPkg.mBuildReason != null) {
1479
                    if (mode || ( !mode && p.mPkg.mBuildReason != BuildReason.Ripple ))
7048 dpurdie 1480
                    {
7078 dpurdie 1481
                        toBuild.add(p);
7048 dpurdie 1482
                    }
1483
                }
1484
            }
1485
 
7078 dpurdie 1486
            //  Need (would like to) build stuff
1487
            //  Determine the packages that we need to build and the time that it will take
7070 dpurdie 1488
            //
7078 dpurdie 1489
            if ( !toBuild.isEmpty() )
7048 dpurdie 1490
            {
7096 dpurdie 1491
                //  Locate the packages that we need to build
1492
                //  The build order cannot be correctly determined at this time
1493
                //      Need to add elements to the end of the list while processing
1494
                //      Sum the buildTimes of the packages that we add to the list
7078 dpurdie 1495
                while ( ! toBuild.isEmpty())
7048 dpurdie 1496
                {
7079 dpurdie 1497
                    PlannedPackage pkg = toBuild.remove(0);
7078 dpurdie 1498
 
7095 dpurdie 1499
                    if (pkg.mBuildLevel > 400 ) {
7078 dpurdie 1500
                        mLogger.error("Circular dependency detected - not handled well");
1501
                        break;
7048 dpurdie 1502
                    }
1503
 
7095 dpurdie 1504
                    if ( ! pkg.mPkg.mCheckedCircularDependency )
7048 dpurdie 1505
                    {
7078 dpurdie 1506
                        ripplePlan.add(pkg);
7079 dpurdie 1507
                        results.planTime += pkg.mPkg.mBuildTime;
7095 dpurdie 1508
                        pkg.mPkg.mCheckedCircularDependency = true;
1509
 
1510
                        ArrayList<PlannedPackage> usedBy = usedByPackages(pkg, results.planCollection);
1511
                        toBuild.addAll(usedBy);
7048 dpurdie 1512
                    }
6914 dpurdie 1513
                }
7079 dpurdie 1514
 
7095 dpurdie 1515
                //
7096 dpurdie 1516
                //  Now we have a collection of packages to build ( and only the packages to build)
7095 dpurdie 1517
                //  Need to determine the order in which it can be done and assign build levels
7096 dpurdie 1518
                //  Basically:
1519
                //      Scan the collection looking for any package whose dependencies do not exist in the collection
1520
                //      or they have been allocated a build level.
7095 dpurdie 1521
                //
7096 dpurdie 1522
                //      Need to do this in waves so that we can correctly determine the build level.
1523
                //  
1524
                //
7095 dpurdie 1525
                for (Iterator<PlannedPackage> it = ripplePlan.iterator(); it.hasNext(); )
1526
                {
1527
                    PlannedPackage p = it.next();
1528
                    p.mPkg.mCheckedCircularDependency = true;
1529
                    p.mBuildLevel = 0;
1530
                }
1531
 
1532
                buildLevel = 0;
1533
                boolean more = true;
1534
                do  {
1535
                    ArrayList<PlannedPackage> thisLevel = new ArrayList<PlannedPackage>();
1536
                    for (Iterator<PlannedPackage> it = ripplePlan.iterator(); it.hasNext(); )
1537
                    {
1538
                        PlannedPackage p = it.next();
1539
                        if ( p.mPkg.mCheckedCircularDependency )
1540
                        {
1541
                            boolean found = false;
1542
                            for (Iterator<String> it2 = p.mPkg.mDependencyCollection.iterator(); !found && it2.hasNext(); )
1543
                            {
1544
                                String alias = it2.next();
1545
                                for (Iterator<PlannedPackage> it3 = ripplePlan.iterator(); !found && it3.hasNext(); )
1546
                                {
1547
                                    PlannedPackage pkg = it3.next();
1548
                                    if (pkg.mPkg.mAlias.compareTo( alias ) == 0)
1549
                                    {
1550
                                        found = pkg.mPkg.mCheckedCircularDependency ;
1551
                                        break;
1552
                                    }
1553
                                }
1554
                            }
1555
 
1556
                            if (!found)
1557
                            {
1558
                                //  None of this packages dependencies can be found in the collection of packages to build
1559
                                //  Thus we can build it - at the current level
1560
                                p.mBuildLevel = buildLevel;
1561
                                thisLevel.add(p);
1562
                            }
1563
                        }
1564
                    }
1565
 
1566
                    //  Mark all the packages at this level as have been processed
1567
                    //  Cannot do this while we are determining the packages in the level 
1568
                    for (Iterator<PlannedPackage> it = thisLevel.iterator(); it.hasNext(); )
1569
                    {
1570
                        PlannedPackage p = it.next();
1571
                        p.mPkg.mCheckedCircularDependency = false;
1572
                    }
1573
 
1574
                    more = !thisLevel.isEmpty(); 
1575
                    buildLevel++;
1576
 
1577
                } while (more);
1578
 
7078 dpurdie 1579
                //  Sort the packages by buildOrder and buildTime
7095 dpurdie 1580
                phase.setPhase("Sort Plan");
7079 dpurdie 1581
                Collections.sort(ripplePlan, PlannedPackage.BuildOrderComparitor);
7078 dpurdie 1582
 
7094 dpurdie 1583
                phase.setPhase("Display Build Order");
7093 dpurdie 1584
                mLogger.error("Plan Build {} Time: {}", name, results.planTime);
7079 dpurdie 1585
                for (Iterator<PlannedPackage> it = ripplePlan.iterator(); it.hasNext(); )
7078 dpurdie 1586
                {
7079 dpurdie 1587
                    PlannedPackage p = it.next();
7093 dpurdie 1588
                    mLogger.error("Plan: {} {} t:{}", p.mBuildLevel, p.mPkg.mAlias, p.mPkg.mBuildTime);
7078 dpurdie 1589
                }
6914 dpurdie 1590
            }
7048 dpurdie 1591
 
7078 dpurdie 1592
            //  Daemon mode: Returning calculated plan
1593
            results.planCollection = ripplePlan;
1594
        }
7094 dpurdie 1595
 
1596
        phase.setPhase("EndPlanCollection");
7078 dpurdie 1597
        return results;
1598
    }
6914 dpurdie 1599
 
7078 dpurdie 1600
    /** Generate a plan based on a modified set of packages
1601
     * 
1602
     * @param name      - Name of the plan
1603
     * @param basicPlan - basicPlan
1604
     * @param mode      - True: Include natural ripples and WIPS/RIPPLES that would have been done
1605
     *                          as a part of the basic plan
1606
     * @return
1607
     */
1608
    private PlanResults postRipplePlan(String name, PlanResults basicPlan, boolean mode) {
1609
 
1610
        ArrayList<Package> fullPlanCollection = new ArrayList<Package>(mPackageCollection);
1611
        ArrayList<Package> buildCandidates = new ArrayList<Package>();
1612
        buildCandidates.addAll(mPackageCollectionWip);
1613
        buildCandidates.addAll(mPackageCollectionRipple);
1614
 
1615
        if ( !buildCandidates.isEmpty() )
1616
        {
7048 dpurdie 1617
            for (Iterator<Package> it = buildCandidates.iterator(); it.hasNext(); )
1618
            {
1619
                Package p = it.next();
7078 dpurdie 1620
                if (p.mBuildFile >= 0)
6914 dpurdie 1621
                {
7078 dpurdie 1622
                    if (!mode)
6914 dpurdie 1623
                    {
7078 dpurdie 1624
                        //  Exclude packages that would have been processed in the basicPlan
7079 dpurdie 1625
                        for (Iterator<PlannedPackage> it1 = basicPlan.planCollection.iterator(); it1.hasNext(); )
7048 dpurdie 1626
                        {
7079 dpurdie 1627
                            PlannedPackage pkg = it1.next();
1628
                            if (pkg.mPkg == p)
7078 dpurdie 1629
                            {
7093 dpurdie 1630
                                mLogger.error("Test Plan without {}", p.mAlias);
7078 dpurdie 1631
                                continue;
1632
                            }
7048 dpurdie 1633
                        }
6914 dpurdie 1634
                    }
7078 dpurdie 1635
 
7093 dpurdie 1636
                    mLogger.error("Test Plan with {}", p.mAlias);
7078 dpurdie 1637
                    Package foundInRelease = mReleaseManager.findPackage(p.mAlias, fullPlanCollection);
1638
                    int foundIndex = mReleaseManager.findPackageLastIndex;
1639
                    if (foundInRelease == ReleaseManager.NULL_PACKAGE)
1640
                    {
1641
                        fullPlanCollection.add(p);
1642
                    }
1643
                    else
1644
                    {
1645
                        fullPlanCollection.set(foundIndex, p);
1646
                    }
1647
 
1648
                    Package.resetCircularDependency (fullPlanCollection);
1649
                    if ( p.hasCircularDependency( fullPlanCollection ) )
1650
                    {
1651
                        mLogger.info("planRelease circular dependency detected {}", p.mAlias);
1652
 
1653
                        //  Force this package to be marked as having a circular dependency - even if its been excluded
1654
                        p.mBuildFile = 0;
1655
 
7079 dpurdie 1656
                        // Exclude the package
7078 dpurdie 1657
                        // max 50 chars
7079 dpurdie 1658
                        rippleBuildExclude(p, p.mId, "Package has circular dependency", -6);
7078 dpurdie 1659
                    }
6914 dpurdie 1660
                }
1661
            }
7048 dpurdie 1662
 
7078 dpurdie 1663
        }
1664
        return planCollection(name, fullPlanCollection, mode);
1665
    }
1666
 
7079 dpurdie 1667
    /** 
1668
     *  Calculate a collection of packages that actively use the named package
1669
     *  A consumer package does NOT use the named package,
1670
     *      If the consumer is an SDK or is Pegged
1671
     *      If the consumer is marked as advisoryRipple
1672
     *      If the consumer cannot be built
1673
     *   
1674
     * @param pkg - Package to process
1675
     * @param planCollection - collection of packages to scan
1676
     *
1677
     * @return A collection of packages that actively 'use' the specified package
1678
 
7078 dpurdie 1679
     */
7095 dpurdie 1680
    private ArrayList<PlannedPackage> usedByPackages(PlannedPackage pkg, ArrayList<PlannedPackage> planCollection) {
7078 dpurdie 1681
 
7079 dpurdie 1682
        ArrayList<PlannedPackage> usedBy = new ArrayList<PlannedPackage>();
7078 dpurdie 1683
 
7079 dpurdie 1684
        for (Iterator<PlannedPackage> it = planCollection.iterator(); it.hasNext(); )
7078 dpurdie 1685
        {
7079 dpurdie 1686
            PlannedPackage p = it.next();
7070 dpurdie 1687
 
7079 dpurdie 1688
            //  Is this package 'actively used' in the current build
1689
            if (p.mPkg.mBuildFile >= 0)
7070 dpurdie 1690
            {
7079 dpurdie 1691
                for (Iterator<String> it2 = p.mPkg.mDependencyCollection.iterator(); it2.hasNext(); )
7070 dpurdie 1692
                {
7079 dpurdie 1693
                    String alias = it2.next();
1694
                    if (  pkg.mPkg.mAlias.compareTo( alias ) == 0  ) {
1695
                        //  Have found a consumer of 'pkg'
1696
                        usedBy.add(p);
1697
                        break;
7070 dpurdie 1698
                    }
1699
                }
1700
            }
7048 dpurdie 1701
        }
7079 dpurdie 1702
 
1703
        return usedBy;
7048 dpurdie 1704
    }
7079 dpurdie 1705
 
7048 dpurdie 1706
    /** 
7079 dpurdie 1707
     *  Calculate a collection of packages that use the named package
7048 dpurdie 1708
     *   
1709
     * @param pkg - Package to process
7070 dpurdie 1710
     * @param pkgCollection - collection of packages to scan
7078 dpurdie 1711
     *
7048 dpurdie 1712
     * @return A collection of packages that actively 'use' the specified package
1713
 
1714
     */
7079 dpurdie 1715
    private ArrayList<Package> usedByAnyPackages(Package pkg, ArrayList<Package> pkgCollection) {
7048 dpurdie 1716
 
1717
        ArrayList<Package> usedBy = new ArrayList<Package>();
1718
 
7070 dpurdie 1719
        for (Iterator<Package> it = pkgCollection.iterator(); it.hasNext(); )
7048 dpurdie 1720
        {
1721
            Package p = it.next();
1722
 
7079 dpurdie 1723
            for (Iterator<String> it2 = p.mDependencyCollection.iterator(); it2.hasNext(); )
7048 dpurdie 1724
            {
7079 dpurdie 1725
                String alias = it2.next();
1726
                if (  pkg.mAlias.compareTo( alias ) == 0  ) {
1727
                    usedBy.add(p);
1728
                    break;
6914 dpurdie 1729
                }
1730
            }
7048 dpurdie 1731
        }
1732
 
1733
        return usedBy;
6914 dpurdie 1734
    }
1735
 
1736
    /** Determine if a given PVID is a member of the current release.
1737
     *  Used to determine if a package dependency is out of date
1738
     * 
1739
     * @param dpvId
1740
     * @return true - specified pvid is a full member of the Release
1741
     */
1742
    private boolean isInRelease(Integer dpvId) {
1743
 
7048 dpurdie 1744
        boolean inRelease = false;
6914 dpurdie 1745
 
7048 dpurdie 1746
        for ( Iterator<Package> it = mPackageCollection.iterator(); it.hasNext(); )
6914 dpurdie 1747
        {
7048 dpurdie 1748
            Package p = it.next();
6914 dpurdie 1749
 
7048 dpurdie 1750
            if ( p.mId == dpvId )
6914 dpurdie 1751
            {
7048 dpurdie 1752
                inRelease = ! p.mIsNotReleased;
6914 dpurdie 1753
                break;
1754
            }
1755
        }
7048 dpurdie 1756
        return inRelease;
6914 dpurdie 1757
    }
1758
 
1759
 
7081 dpurdie 1760
    /** Reports what change in build exceptions happens as part of planRelease
1761
     * 
1762
     *  There are three types of exceptions
1763
     *      PlanError - These may be removed, if the error was not seen in the last plan
1764
     *      BuildErrors - These we persist
1765
     *      IndirectErrors - Packages that depend on a Plan or Build errors
6914 dpurdie 1766
     */
1767
    public void reportChange() throws SQLException, Exception
1768
    {
1769
        int counter = 0;
1770
        for (Iterator<BuildExclusion> it = mBuildExclusionCollection.iterator(); it.hasNext(); )
1771
        {
1772
            BuildExclusion buildExclusion = it.next();
1773
 
7081 dpurdie 1774
            //  Skip 'Processed' entries
1775
            //  These will be the result of a PlanError that we have seen again
1776
            //
1777
            //  PlanErrors - Add/Remove as detected
1778
            //  BuildErrors - Persist. 
1779
            //  IndirectErrors - Add/Remove as detected
1780
            //  
1781
 
1782
            if ( !buildExclusion.isABuildError() )
6914 dpurdie 1783
            {
7081 dpurdie 1784
                if ( !buildExclusion.isProcessed() )
1785
                {
1786
                    if (buildExclusion.isImported() && !buildExclusion.isARootCause() ) {
1787
                        // Remove from the exclusion list
1788
                        buildExclusion.includeToBuild(mReleaseManager, mBaseline);
1789
                        mLogger.error("reportChange remove unused exclusion: {}", buildExclusion );
1790
                    } else {
1791
                        // Exclude and notify
1792
                        buildExclusion.excludeFromBuild(mReleaseManager, mBaseline);
1793
                        buildExclusion.email(this, mPackageCollectionAll);
1794
                        counter++;
1795
                    }
7032 dpurdie 1796
                }
6914 dpurdie 1797
            }
1798
        }
7048 dpurdie 1799
        mLogger.error("reportChange exclusion count: {}", counter);
6914 dpurdie 1800
    }
1801
 
1802
    /**reports the build plan
1803
     */
1804
    public void reportPlan() throws SQLException, Exception
1805
    {
1806
        mReleaseManager.reportPlan(mRtagId, mBuildOrder);
1807
    }
1808
 
1809
    /**Returns the first build file from the collection
1810
     * The build file will be flagged as empty if none exists
1811
     */
1812
    public BuildFile getFirstBuildFileContent()
1813
    {
1814
        mLogger.debug("getFirstBuildFileContent");
1815
 
1816
        mBuildIndex = -1;
1817
        return getNextBuildFileContent();
1818
    }
1819
 
1820
    /**Returns next build file from the collection
1821
     * The build file will be flagged as empty if none exists
1822
     */
1823
    public BuildFile getNextBuildFileContent()
1824
    {
1825
        mLogger.debug("getNextBuildFileContent");
1826
        BuildFile retVal = null;
1827
 
1828
        try
1829
        {
1830
            mBuildIndex++;
1831
            retVal = mBuildCollection.get( mBuildIndex );
1832
        }
1833
        catch( IndexOutOfBoundsException e )
1834
        {
1835
            // Ignore exception. retVal is still null.
1836
        }
1837
 
1838
        if (retVal == null)
1839
        {
1840
            retVal = new BuildFile();
1841
        }
1842
 
7048 dpurdie 1843
        mLogger.debug("getNextBuildFileContent returned {}", retVal.state.name() );
6914 dpurdie 1844
        return retVal;
1845
    }
1846
 
1847
 
1848
    /**collects meta data associated with the baseline
1849
     * this is sufficient to send an indefinite pause email notification 
1850
     *  
1851
     * Escrow: Used once to collect information about the SBOM and associated Release 
1852
     *         mBaseline is an SBOMID 
1853
     * Daemon: Used each build cycle to refresh the information 
1854
     *          mBaseline is an RTAGID
1855
     */
1856
    public void collectMetaData() throws SQLException, Exception
1857
    {
1858
        Phase phase = new Phase("cmd");
7048 dpurdie 1859
        mLogger.debug("collectMetaData mDaemon {}", mDaemon);
6914 dpurdie 1860
 
1861
        try
1862
        {
1863
            phase.setPhase("connect");
1864
            mReleaseManager.connect();
1865
 
1866
            if (! mDaemon)
1867
            {
1868
                mSbomId = mBaseline;
1869
                phase.setPhase("queryRtagIdForSbom");
1870
                mRtagId = mReleaseManager.queryRtagIdForSbom(mBaseline);
1871
                if (mRtagId == 0)
1872
                {
7033 dpurdie 1873
                    mLogger.error("SBOM does not have a matching Release. Cannot be used as a base for an Escrow"); 
6914 dpurdie 1874
                    throw new Exception("rtagIdForSbom show stopper. SBOM does not have an associated Release");
1875
                }
1876
            }
1877
 
1878
            phase.setPhase("queryReleaseConfig");
1879
            mReleaseManager.queryReleaseConfig(mRtagId);
1880
 
1881
            if (mDaemon)
1882
            {
1883
                phase.setPhase("queryMailServer");
1884
                setMailServer(mReleaseManager.queryMailServer());
1885
                phase.setPhase("queryMailSender");
1886
                setMailSender(mReleaseManager.queryMailSender());
1887
                phase.setPhase("queryGlobalAddresses");
1888
                setMailGlobalTarget(mReleaseManager.queryGlobalAddresses());
1889
                phase.setPhase("queryProjectEmail");
1890
                mMailGlobalCollection = mReleaseManager.queryProjectEmail(mBaseline);
1891
                phase.setPhase("mMailGlobalTarget");
1892
                mMailGlobalCollection.add(0,getMailGlobalTarget());
1893
            }
1894
            phase.setPhase("queryBaselineName");
1895
            mBaselineName = mReleaseManager.queryBaselineName(mBaseline);
1896
            phase.setPhase("Done");
1897
        }
1898
        finally
1899
        {
1900
            // this block is executed regardless of what happens in the try block
1901
            // even if an exception is thrown
1902
            // ensure disconnect
1903
            mReleaseManager.disconnect();
1904
        }
1905
    }
1906
 
1907
    /**
1908
     * Find Package by package alias
7070 dpurdie 1909
     * Searches the released package collection
6914 dpurdie 1910
     * @param   alias               - alias of package to locate
1911
     * @return  Package with the matching mAlias or NULL_PACKAGE if no package has the mAlias
1912
     */
1913
    public Package findPackage(String alias)
1914
    {
1915
        mLogger.debug("findPackage");
1916
 
1917
        Package retVal = mReleaseManager.findPackage(alias, mPackageCollection);
1918
 
7048 dpurdie 1919
        mLogger.info("findPackage returned {}", retVal.mName);
6914 dpurdie 1920
        return retVal;
1921
    }
7070 dpurdie 1922
 
6914 dpurdie 1923
    /**
7079 dpurdie 1924
     * Sets the mBuildFile to the specified value for the package
1925
     * Does not handle dependent packages - this will be done later  
7048 dpurdie 1926
     *  
7032 dpurdie 1927
     * @param p             The package being excluded 
1928
     * @param rootPvId      The PVID of the package that is causing the exclusion. Null or -ve values are special
1929
     *                      This package is the root cause, -2: Excluded by Ripple Stop 
1930
     * @param rootCause     Text message. Max 50 characters imposed by RM database 
7079 dpurdie 1931
     * @param reason        New value for mBuildFile
6914 dpurdie 1932
     */
7079 dpurdie 1933
    private void rippleBuildExclude(Package p, int rootPvId, String rootCause, int reason )
6914 dpurdie 1934
    {
1935
        mLogger.debug("rippleBuildExclude");
7048 dpurdie 1936
 
7096 dpurdie 1937
        if ( p.mBuildFile >= 0 )
6914 dpurdie 1938
        {
7079 dpurdie 1939
            p.mBuildFile = reason;
7096 dpurdie 1940
            mLogger.info("rippleBuildExclude set mBuildFile to {} for package {}", reason, p.mAlias );
7079 dpurdie 1941
 
1942
            //  Scan the complete collection looking for a matching item
7081 dpurdie 1943
            //  If found then assume that this error is a a PlanError that is still present
1944
            //      Mark it as Processed to indicate that its still present
7079 dpurdie 1945
            //  If found, process it, else add it (unprocessed)
1946
            boolean found = false;
1947
            for (Iterator<BuildExclusion> it = mBuildExclusionCollection.iterator(); it.hasNext(); )
1948
            {
1949
                BuildExclusion buildExclusion = it.next();
6914 dpurdie 1950
 
7079 dpurdie 1951
                if ( buildExclusion.compare(p.mId, rootPvId, rootCause))
1952
                {
1953
                    buildExclusion.setProcessed();
1954
                    found = true;
1955
                    break;
1956
                }
6914 dpurdie 1957
            }
7079 dpurdie 1958
 
1959
            if (!found)
6914 dpurdie 1960
            {
7081 dpurdie 1961
                // Entry not found in the mBuildExclusionCollection. Its a new error
1962
                // 
7079 dpurdie 1963
                // Mark all occurrences for this package as processed
1964
                // These will be superseded by a new build exclusion entry
6914 dpurdie 1965
                for (Iterator<BuildExclusion> it = mBuildExclusionCollection.iterator(); it.hasNext(); )
1966
                {
1967
                    BuildExclusion buildExclusion = it.next();
1968
 
7079 dpurdie 1969
                    if ( buildExclusion.compare(p.mId))
6914 dpurdie 1970
                    {
7032 dpurdie 1971
                        buildExclusion.setProcessed();
6914 dpurdie 1972
                    }
1973
                }
1974
 
7081 dpurdie 1975
                //  Add the new build exclusion to a list
7079 dpurdie 1976
                BuildExclusion buildExclusion = new BuildExclusion(p.mId, rootPvId, rootCause, p.mTestBuildInstruction);
1977
                mBuildExclusionCollection.add(buildExclusion);
6914 dpurdie 1978
            }
7079 dpurdie 1979
        }
6914 dpurdie 1980
 
7079 dpurdie 1981
        mLogger.info("rippleBuildExclude set {} {}", p.mAlias, p.mBuildFile);
6914 dpurdie 1982
    }
1983
 
1984
    /**Simple XML string escaping
1985
     * 
1986
     * @param xml		- String to escape
1987
     * @return		- A copy of the string with XML-unfriendly characters escaped 
1988
     */
1989
    public static String escapeXml( String xml )
1990
    {
1991
        xml = xml.replaceAll("&", "&amp;");
1992
        xml = xml.replaceAll("<", "&lt;");
1993
        xml = xml.replaceAll(">", "&gt;");
1994
        xml = xml.replaceAll("\"","&quot;");
1995
        xml = xml.replaceAll("'", "&apos;");
1996
        xml = xml.replaceAll("\\$", "\\$\\$");
1997
 
1998
        return xml;
1999
    }
2000
 
2001
    /** Quote a string or a string pair
2002
     *  If two strings are provided, then they will be joined with a comma.
2003
     *   
2004
     * @param text		- First string to quote
2005
     * @param text2		- Optional, second string
2006
     * @return A string of the form 'text','text2'
2007
     */
2008
    public static String quoteString(String text, String text2)
2009
    {
2010
        String result;
2011
        result =  "\'" + text + "\'";
2012
        if (text2 != null )
2013
        {
2014
            result +=  ",\'" + text2 + "\'";  
2015
        }
2016
        return result;
2017
    }
2018
 
2019
    /** Generate build file information
2020
     * 
2021
     */
2022
    private void generateBuildFiles() 
2023
    {
2024
 
2025
        // persist the build files
2026
        boolean allProcessed = false;
2027
        int buildFile = 1;
2028
        StringBuilder rawData = new StringBuilder();
2029
        StringBuilder setUp = new StringBuilder();
2030
 
2031
        mLogger.debug("generateBuildFiles");
2032
 
2033
        if ( mDaemon )
2034
        {
2035
            // all interesting packages in daemon mode match the following filter
2036
            buildFile = 3;
2037
        }
2038
 
2039
        //-----------------------------------------------------------------------
2040
        //    Generate the build file
2041
        do
2042
        {
2043
            BuildFile buildEntry = new  BuildFile();
2044
            buildEntry.state = BuildFileState.Dummy;
2045
            XmlBuilder xml = generateBuildFileHeader();
2046
 
2047
 
2048
            //	Generate properties for each package in this build level or lower build levels
2049
            //	The properties link the packageAlias to the PackageName and PackageVersion
2050
            //
2051
            //	[DEVI 54816] In escrow mode all unreproducible packages are included 
7070 dpurdie 2052
            for (Iterator<Package> it = mPackageCollection.iterator(); it.hasNext(); )
6914 dpurdie 2053
            {
2054
                Package p = it.next();
2055
 
2056
                if ( ( ( p.mBuildFile > 0 ) && ( p.mBuildFile <= buildFile ) ) || ( !mDaemon && p.mBuildFile == -2 ) )
2057
                {
2058
                    xml.addProperty(p.mAlias, p.mName + " " + p.mVersion + p.mExtension);
2059
                }
2060
            }
2061
 
2062
            //	UTF Support
2063
            //	Insert additional info into the build file to provide extra checking
2064
            //
7048 dpurdie 2065
            if ( ! mReleaseManager.mUseDatabase )
6914 dpurdie 2066
            {
2067
                // UTF Support
2068
                // Insert per-package planning information
2069
                //
7070 dpurdie 2070
                xml.addComment("mPackageCollection");
2071
                for (Iterator<Package> it = mPackageCollection.iterator(); it.hasNext(); )
6914 dpurdie 2072
                {
2073
                    Package p = it.next();
2074
                    generatePackageInfo(xml, p);
2075
                }
2076
 
7070 dpurdie 2077
                xml.addComment("mPackageCollectionWip");
2078
                for (Iterator<Package> it = mPackageCollectionWip.iterator(); it.hasNext(); )
2079
                {
2080
                    Package p = it.next();
2081
                    if (p.mIsNotReleased )
2082
                        generatePackageInfo(xml, p);
2083
                }
2084
 
2085
                xml.addComment("mPackageCollectionTest");
2086
                for (Iterator<Package> it = mPackageCollectionTest.iterator(); it.hasNext(); )
2087
                {
2088
                    Package p = it.next();
2089
                    if (p.mIsNotReleased )
2090
                        generatePackageInfo(xml, p);
2091
                }
2092
 
2093
                xml.addComment("mPackageCollectionTestRipple");
2094
                for (Iterator<Package> it = mPackageCollectionRipple.iterator(); it.hasNext(); )
2095
                {
2096
                    Package p = it.next();
2097
                    if (p.mIsNotReleased )
2098
                        generatePackageInfo(xml, p);
2099
                }
2100
 
6914 dpurdie 2101
                // UTF Support
2102
                // Insert build exclusion information
2103
                xml.addComment("mBuildExclusionCollection");
2104
                for (Iterator<BuildExclusion> it = mBuildExclusionCollection.iterator(); it.hasNext(); )
2105
                {
2106
                    BuildExclusion buildExclusion = it.next();
2107
                    {
7081 dpurdie 2108
                        xml.addComment(buildExclusion.toString());
6914 dpurdie 2109
                    }
2110
                }
7080 dpurdie 2111
            }
2112
 
2113
            // UTF Support (Also while trailing the changes)
2114
            // Insert build Plan
2115
            if (mDaemon)
2116
            {
2117
                xml.addComment("mBuildOrder");
2118
                for (Iterator<PlannedPackage> it = mBuildOrder.iterator(); it.hasNext(); )
6914 dpurdie 2119
                {
7080 dpurdie 2120
                    PlannedPackage p = it.next();
2121
                    String comment =
2122
                            "pvid="+ p.mPkg.mId +
2123
                            " order=" + p.mBuildLevel +
2124
                            " time=" + p.mPkg.mBuildTime +
2125
                            " name=\"" + p.mPkg.mAlias + "\"";
2126
                    xml.addComment(comment);
6914 dpurdie 2127
                }
2128
            }
2129
 
2130
            //  Generate Taskdef information
2131
            generateTaskdef(xml);
2132
 
2133
            //
2134
            //  Insert known Machine Information
2135
            //  Escrow usage: 
2136
            //      Map machType to machClass
2137
            //  Also serves as a snapshot of the required build configuration
2138
            //  ie: machine types and buildfilters
2139
            //
2140
            if (!mDaemon)
2141
            {
2142
                generateMachineInfo(xml, null);
2143
            }
2144
 
2145
            //
2146
            //	Generate target rules for each package to be built within the current build file
2147
            //
2148
            boolean daemonHasTarget = false;
2149
 
7048 dpurdie 2150
            for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 2151
            {
2152
                Package p = it.next();
2153
 
2154
                if ( p.mBuildFile > 0 && p.mBuildFile <= buildFile )
2155
                {
2156
                    generateTarget(xml, buildEntry, p, buildFile);
2157
 
2158
                    if ( p.mBuildFile == 1 )
2159
                    {
2160
                        daemonHasTarget = true;
2161
 
2162
                        // Retain information about the target package
2163
                        buildEntry.mPkgId = p.mPid;
2164
                        buildEntry.mPvId = p.mId;
2165
                    }
2166
                }
2167
 
2168
                //	Generate escrow extraction commands
2169
                //	Only done on the first pass though the packages
2170
                //
2171
                if ( !mDaemon && buildFile == 1 )
2172
                {
2173
                    setUp.append("jats jats_vcsrelease -extractfiles"
2174
                                + " \"-label=" + p.mVcsTag + "\""
2175
                                + " \"-view=" + p.mAlias + "\""
2176
                                + " -root=. -noprefix"
2177
                                + mlf );
2178
                }
2179
 
2180
                //	Generate escrow raw CSV data
2181
                //	Note: I don't think this data is used at all
2182
 
2183
                if ( !mDaemon && ( p.mBuildFile == buildFile))
2184
                {
2185
                    StringAppender machines = new StringAppender(",");
2186
                    for (Iterator<BuildStandard> it1 = p.mBuildStandardCollection.iterator(); it1.hasNext();)
2187
                    {
2188
                        BuildStandard bs = it1.next();
2189
                        machines.append(bs.mMachClass);
2190
                    }
2191
 
2192
                    rawData.append(p.mAlias + "," +
2193
                                    buildFile + "," +
2194
                                    machines +
2195
                                    mlf);
2196
                }
2197
            }
2198
 
2199
            if ( mDaemon && !daemonHasTarget )
2200
            {
2201
                // must have AbtTestPath, AbtSetUp, AbtTearDown, and AbtPublish targets
2202
                XmlBuilder target = xml.addNewElement("target");
2203
                target.addAttribute("name", "AbtTestPath");
2204
 
2205
                target = xml.addNewElement("target");
2206
                target.addAttribute("name", "AbtSetUp");
2207
 
2208
                target = xml.addNewElement("target");
2209
                target.addAttribute("name", "AbtTearDown");
2210
 
2211
                target = xml.addNewElement("target");
2212
                target.addAttribute("name", "AbtPublish");
2213
            }
2214
 
2215
            generateDefaultTarget( xml, buildFile);
2216
 
2217
            //	Convert the Xml structure into text and save it in the build file
2218
            //	Add this build file to the mBuildCollection
2219
            buildEntry.content = mXmlHeader + xml.toString();
2220
            mBuildCollection.add(buildEntry);
2221
 
2222
            // are more build files required
2223
            allProcessed = true;
2224
 
2225
            if (!mDaemon)
2226
            {
2227
                // this is escrow mode centric
7048 dpurdie 2228
                for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 2229
                {
2230
                    Package p = it.next();
2231
 
2232
                    if ( p.mBuildFile > buildFile )
2233
                    {
2234
                        // more build files are required
2235
                        allProcessed = false;
7048 dpurdie 2236
                        mLogger.info("planRelease reiterating package has no build requirement {} {} {}",p.mName, p.mBuildFile,  buildFile);
6914 dpurdie 2237
                        break;
2238
                    }
2239
                } 
2240
 
2241
                buildFile++;
2242
            }
2243
 
2244
        } while( !allProcessed );
2245
 
2246
        //	Save additional escrow data
2247
        if ( !mDaemon )
2248
        {
2249
            mEscrowSetup = setUp.toString();
2250
            mEscrowRawData = rawData.toString();
2251
        }
2252
    }
2253
 
2254
    /**returns a build file header for the mBaseline
2255
     */
2256
    private XmlBuilder generateBuildFileHeader()
2257
    {
2258
        mLogger.debug("generateBuildFileHeader");
2259
        XmlBuilder element = new XmlBuilder("project");
2260
 
2261
        element.addAttribute("name", "mass");
2262
        element.addAttribute("default", "full");
2263
        element.addAttribute("basedir", ".");
2264
 
2265
        if ( mDaemon )
2266
        {
2267
            element.addProperty("abt_mail_server", getMailServer());
2268
            element.addProperty("abt_mail_sender", getMailSender()); 
2269
            element.addProperty("abt_rtag_id", mBaseline);
2270
            element.addProperty("abt_daemon", mReleaseManager.currentTimeMillis());
2271
            element.makePropertyTag("abt_packagetarball", true);
2272
            element.makePropertyTag("abt_usetestarchive", !ReleaseManager.getUseMutex());
2273
 
7048 dpurdie 2274
            for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 2275
            {
2276
                Package p = it.next();
2277
 
2278
                if ( p.mBuildFile == 1 )
2279
                {
2280
                    element.addProperty("abt_package_name", p.mName);
2281
                    element.addProperty("abt_package_version", p.mVersion + p.mExtension);
2282
                    element.addProperty("abt_package_extension", p.mExtension);
2283
                    element.addProperty("abt_package_location", getBuildLocation(p));
2284
                    element.addProperty("abt_package_ownerlist", p.emailInfoNonAntTask(this));
2285
                    element.addProperty("abt_package_build_info", buildInfoText(p));
2286
 
2287
                    // depends in the form 'cs','25.1.0000.cr';'Dinkumware_STL','1.0.0.cots'
2288
                    StringAppender depends = new StringAppender(";");
2289
 
2290
                    for (Iterator<Package> it3 = p.mPackageDependencyCollection.iterator(); it3.hasNext(); )
2291
                    {
2292
                        Package depend = it3.next();
2293
                        depends.append( quoteString(depend.mName, depend.mVersion + depend.mExtension) );
2294
                    }
2295
 
2296
                    element.addProperty("abt_package_depends", depends.toString());
2297
                    element.addProperty("abt_is_ripple", p.mDirectlyPlanned ? "0" : "1");
2298
                    element.addProperty("abt_build_reason", p.mBuildReason.toString());
2299
                    element.addProperty("abt_package_version_id", p.mId);
2300
                    element.addProperty("abt_does_not_require_source_control_interaction", ! p.mRequiresSourceControlInteraction ? "true" : "false" );
2301
                    element.addProperty("abt_test_build_instruction", p.mTestBuildInstruction);
2302
                }
2303
            }
2304
        }
2305
        else
2306
        {
2307
            //    Escrow Mode
2308
            element.addProperty("abt_rtag_id", mRtagId);
2309
            element.addProperty("abt_sbom_id", mSbomId);
2310
        }
2311
 
2312
        element.addProperty("abt_release", escapeXml(mBaselineName));
2313
        element.addProperty("abt_buildtool_version", mReleaseManager.getMajorVersionNumber() );
2314
 
2315
        element.addNewElement("condition")
2316
        .addAttribute("property", "abt_family")
2317
        .addAttribute("value", "windows")
2318
        .addNewElement("os")
2319
        .addAttribute("family", "windows");
2320
        element.addProperty("abt_family", "unix");
2321
 
2322
        return element;
2323
    }
2324
 
2325
    /** Add task def XML items taskdef for the abt ant task
2326
     * @param xml 	- xml item to extend
2327
     */
2328
    private void generateTaskdef(XmlBuilder xml)
2329
    {
2330
        mLogger.debug("generateTaskdef");
2331
        xml.addNewElement("taskdef")
2332
        .addAttribute("name", "abt")
2333
        .addAttribute("classname", "com.erggroup.buildtool.abt.ABT");
2334
 
2335
        xml.addNewElement("taskdef")
2336
        .addAttribute("name", "abtdata")
2337
        .addAttribute("classname", "com.erggroup.buildtool.abt.ABTData");
2338
    }
2339
 
2340
    /** returns the command abtdata items
2341
     *  <br>Common machine information
2342
     *  <br>Common email address
2343
     *  
2344
     *  
2345
     *  @param	xml - Xml element to extend   
2346
     *  @param    p - Package (May be null)
2347
     */
2348
    private void generateMachineInfo(XmlBuilder xml, Package p)
2349
    {
2350
        XmlBuilder element = xml.addNewElement("abtdata");
2351
        element.addAttribute("id", "global-abt-data");
2352
 
2353
        //
2354
        //  Iterate over all the machines and create a nice entry
2355
        //
2356
        for (Iterator<ReleaseConfig> it = mReleaseManager.mReleaseConfigCollection.mReleaseConfig.iterator(); it.hasNext(); )
2357
        {
2358
            ReleaseConfig rc = it.next();
2359
            element.addElement(rc.getMachineEntry());
2360
        }
2361
 
2362
        //
2363
        //  Now the email information
2364
        //
2365
        if ( p != null)
2366
        {
2367
            p.emailInfo(this, element);
2368
        }
2369
    }
2370
 
2371
    /** Generate package information
2372
     *  Only when running unit tests
2373
     *  
2374
     * @param xml	- An xml element to append data to
2375
     * @param p	- Package to process
2376
     */
2377
    private void generatePackageInfo (XmlBuilder xml, Package p)
2378
    {
7071 dpurdie 2379
        StringBuilder comment = new StringBuilder();
2380
        StringBuilder deps = new StringBuilder();
2381
 
7051 dpurdie 2382
        String joiner = "";
2383
        for (Iterator<String> it2 = p.mDependencyCollection.iterator(); it2.hasNext(); )
2384
        {
2385
            String alias = it2.next();
7071 dpurdie 2386
            deps.append(joiner).append(alias); 
7051 dpurdie 2387
            joiner = ",";
2388
        }
2389
 
7071 dpurdie 2390
        comment.append("pvid=").append(p.mId);
2391
        comment.append(" name=").append('"').append(p.mAlias).append('"');
2392
        comment.append(" reason=").append(p.mNoBuildReason);
2393
        comment.append(" buildFile=").append(p.mBuildFile);
2394
        comment.append(" directlyPlanned=").append(p.mDirectlyPlanned);
2395
        comment.append(" indirectlyPlanned=").append(p.mIndirectlyPlanned);
2396
        comment.append(" depends=[").append(deps).append("]");
6914 dpurdie 2397
 
7071 dpurdie 2398
        xml.addComment(comment.toString());            
6914 dpurdie 2399
    }
2400
 
2401
    /**returns an ant target for the passed Package
2402
     * in daemon mode:
2403
     *  packages are categorized with one of three mBuildFile values:
2404
     *   1 the package to be built by this buildfile
2405
     *   2 the packages with a future build requirement
2406
     *   3 the packages with no build requirement
2407
     *  the returned target depends on this categorization and will have
2408
     *   1 full abt info
2409
     *   2 full dependency info to determine future build ordering but no abt info (will not build this package)
2410
     *   3 only a name attribute (will not build this package)
2411
     * in escrow mode:
2412
     *  if the passed Package's mBuildFile is different (less than) the passed build file,
2413
     *  the returned target have only a name attribute (will not build this package)
2414
     *   
2415
     * @param xml - Xml element to extend
2416
     * @param buildEntry - Record build type (dummy/generic/not generic)
2417
     * @param p - Package to process
2418
     * @param buildFile - buildfile level being processed
2419
     */
2420
    private void generateTarget(XmlBuilder xml, BuildFile buildEntry, Package p, int buildFile)
2421
    {
2422
        mLogger.debug("generateTarget");
2423
 
2424
        //---------------------------------------------------------------------
2425
        //  Generate the AbtData - common machine and email information
2426
        //  Only used by the daemon builds
2427
        //
2428
        if ( mDaemon && p.mBuildFile == 1 )
2429
        {
2430
            generateMachineInfo(xml, p );
2431
        }
2432
 
2433
        //-------------------------------------------------------------------------
2434
        //  Generate the <target name=... /> construct
2435
        //  There are two types
2436
        //      1) Simple dummy place holder. Just has the PackageName.PackageExt
2437
        //      2) Full target. Has all information to build the package including
2438
        //              AbtSetUp, AbtTearDown and AbtPublish targets
2439
        //
2440
 
2441
        if ( !mDaemon && ( p.mBuildFile < buildFile ) )
2442
        {
2443
            XmlBuilder target = xml.addNewElement("target");
2444
            target.addAttribute("name", p.mAlias);
2445
        }
2446
        else
2447
        {
2448
            if (!mDaemon) 
2449
            {
2450
                //  Escrow Only:
2451
                //  Generate the 'wrapper' target
2452
                //  This is used to ensure that the required dependencies have been built - I think
2453
                //
2454
                StringAppender dependList = new StringAppender(",");
2455
                if ( !p.mPackageDependencyCollection.isEmpty() )
2456
                {
2457
                    for (Iterator<Package> it = p.mPackageDependencyCollection.iterator(); it.hasNext(); )
2458
                    {
2459
                        Package dependency = it.next();
2460
                        if ( !mDaemon && dependency.mBuildFile == -2 )
2461
                        {
2462
                            // ignore targets which build in foreign environments in escrow mode
2463
                            continue;
2464
                        }
2465
                        dependList.append(dependency.mAlias);
2466
                    }
2467
                }
2468
 
2469
                XmlBuilder target = xml.addNewElement("target").isExpanded();
2470
                target.addAttribute("name", p.mAlias + ".wrap");
2471
 
2472
                if (dependList.length() > 0)
2473
                {
2474
                    target.addAttribute("depends", dependList.toString() );
2475
                }
2476
 
2477
                if ( !mDaemon )
2478
                {
2479
                    boolean hasDependenciesBuiltInThisIteration = false;
2480
                    if ( ( !p.mPackageDependencyCollection.isEmpty()) )
2481
                    {
2482
                        for (Iterator<Package> it = p.mPackageDependencyCollection.iterator(); it.hasNext(); )
2483
                        {
2484
                            Package dependency = it.next();
2485
 
2486
                            if ( dependency.mBuildFile == buildFile )
2487
                            {
2488
                                hasDependenciesBuiltInThisIteration = true;
2489
                                break;
2490
                            }
2491
                        }
2492
                    }
2493
 
2494
                    if ( hasDependenciesBuiltInThisIteration )
2495
                    {
2496
                        XmlBuilder condition = target.addNewElement("condition");
2497
                        condition.addAttribute("property",  p.mAlias + ".build");
2498
 
2499
                        XmlBuilder and = condition.addNewElement("and");
2500
 
2501
                        for (Iterator<Package> it = p.mPackageDependencyCollection.iterator(); it.hasNext(); )
2502
                        {
2503
                            Package dependency = it.next();
2504
 
2505
                            if ( dependency.mBuildFile == buildFile )
2506
                            {
2507
                                XmlBuilder or = and.addNewElement("or");
2508
 
2509
                                XmlBuilder equal1 = or.addNewElement("equals");
2510
                                equal1.addAttribute("arg1", "${" + dependency.mAlias + ".res}");
2511
                                equal1.addAttribute("arg2", "0");
2512
 
2513
                                XmlBuilder equal2 = or.addNewElement("equals");
2514
                                equal2.addAttribute("arg1", "${" + dependency.mAlias + ".res}");
2515
                                equal2.addAttribute("arg2", "257");
2516
                            }
2517
                        }
2518
                    }
2519
                    else
2520
                    {
2521
                        target.addProperty(p.mAlias + ".build", "");
2522
                    }
2523
                }
2524
            }
2525
 
2526
 
2527
            //
2528
            //  Generate the 'body' of the target package
2529
            //  Escrow Mode: Always
2530
            //  Daemon Mode: Only for the one target we are building
2531
            //                  Simplifies the XML
2532
            //                  Reduces noise in the logs
2533
            //              Don't add target dependencies. 
2534
            //                  We are only building one target and the 
2535
            //                  dependency management has been done way before now.
2536
            //                  All it does is makes the logs noisy.
2537
            //
2538
            if ( ( mDaemon && p.mBuildFile == 1 ) || !mDaemon )
2539
            {
2540
                XmlBuilder target = xml.addNewElement("target").isExpanded();
2541
                target.addAttribute("name", p.mAlias);
2542
 
2543
                if ( !mDaemon )
2544
                {
2545
                    target.addAttribute("depends",  p.mAlias + ".wrap");
2546
                    target.addAttribute("if",p.mAlias + ".build");
2547
                }
2548
 
2549
                if ( mDaemon && p.mBuildFile == 1 )
2550
                {
2551
                    target.addProperty(p.mAlias + "pkg_id",p.mPid);
2552
                    target.addProperty(p.mAlias + "pv_id",p.mId);
2553
                }
2554
 
2555
                target.addProperty(p.mAlias + "packagename",p.mName);        		
2556
                target.addProperty(p.mAlias + "packageversion",p.mVersion);
2557
                target.addProperty(p.mAlias + "packageextension",p.mExtension);
2558
                target.addProperty(p.mAlias + "packagevcstag",p.mVcsTag);
2559
 
2560
                target.makePropertyTag(p.mAlias + "directchange", p.mDirectlyPlanned); 
2561
                target.makePropertyTag(p.mAlias + "doesnotrequiresourcecontrolinteraction", ! p.mRequiresSourceControlInteraction);
2562
 
2563
                buildEntry.state = BuildFile.BuildFileState.NonGeneric;
2564
                if ( p.isGeneric() )
2565
                {
2566
                    buildEntry.state = BuildFile.BuildFileState.Generic;
2567
                    target.makePropertyTag(p.mAlias + "generic", true); 
2568
                }
2569
 
2570
                target.addProperty(p.mAlias + "loc", getBuildLocation(p));
2571
                target.makePropertyTag(p.mAlias + "unittests", p.mHasAutomatedUnitTests && mDaemon);
2572
 
2573
                //    Add our own task and associated information
2574
                //
2575
                XmlBuilder abt = target.addNewElement("abt").isExpanded();
2576
 
2577
                for (Iterator<Package> it = p.mPackageDependencyCollection.iterator(); it.hasNext(); )
2578
                {
2579
                    Package dependency = it.next();
2580
                    XmlBuilder depend = abt.addNewElement("depend");
2581
                    depend.addAttribute("package_alias", "${" + dependency.mAlias + "}");
2582
                }
2583
 
2584
                buildInfo(abt,p);
2585
 
2586
                if ( mDaemon && p.mBuildFile == 1 )
2587
                {
2588
                    //    AbtTestPath
2589
                    target = xml.addNewElement("target").isExpanded();
2590
                    target.addAttribute("name", "AbtTestPath");
2591
                    target.addProperty("AbtTestPathpackagevcstag", p.mVcsTag);
2592
                    target.addProperty("AbtTestPathpackagename", p.mName);
2593
                    abt = target.addNewElement("abt").isExpanded();
2594
                    buildInfo(abt, p);
2595
 
2596
 
2597
                    //    AbtSetUp
2598
                    target = xml.addNewElement("target").isExpanded();
2599
                    target.addAttribute("name", "AbtSetUp");
2600
                    target.addProperty("AbtSetUppackagevcstag", p.mVcsTag);
2601
                    target.addProperty("AbtSetUppackagename", p.mName);
2602
 
2603
                    abt = target.addNewElement("abt").isExpanded();
2604
                    buildInfo(abt, p);
2605
 
2606
                    //    AbtTearDown
2607
                    target = xml.addNewElement("target").isExpanded();
2608
                    target.addAttribute("name", "AbtTearDown");
2609
                    target.addProperty("AbtTearDownpackagevcstag", p.mVcsTag);
2610
                    target.addProperty("AbtTearDownpackagename", p.mName);
2611
                    target.addProperty("AbtTearDownpackageversion", p.mVersion);
2612
                    target.addProperty("AbtTearDownpackageextension", p.mExtension);
2613
                    target.makePropertyTag(p.mAlias + "generic", p.isGeneric());
2614
 
2615
                    abt = target.addNewElement("abt").isExpanded();
2616
                    buildInfo(abt, p);
2617
 
2618
 
2619
                    //  AbtPublish
2620
                    target = xml.addNewElement("target").isExpanded();
2621
                    target.addAttribute("name", "AbtPublish");
2622
 
2623
                    target.addProperty("AbtPublishpackagevcstag", p.mVcsTag);
2624
                    target.addProperty("AbtPublishpackagename", p.mName);
2625
                    target.addProperty("AbtPublishpackageversion", p.mVersion);
2626
                    target.addProperty("AbtPublishpackageextension", p.mExtension);
2627
                    target.makePropertyTag("AbtPublishdirectchange", p.mDirectlyPlanned);
2628
                    target.makePropertyTag("AbtPublishdoesnotrequiresourcecontrolinteraction", ! p.mRequiresSourceControlInteraction);
2629
                    target.makePropertyTag("AbtPublishgeneric", p.isGeneric());
2630
                    target.addProperty("AbtPublishloc", getBuildLocation(p));
2631
 
2632
                    abt = target.addNewElement("abt").isExpanded();
2633
                    buildInfo(abt, p);
2634
 
2635
                }
2636
            }
2637
        }
2638
    }
2639
 
2640
    /** Extends the xml object. Adds ant default target for the current build iteration
2641
     * @param xml - The XmlBuilder Object to extend
2642
     * @param buildFile - The current build file level. This differs for Daemon and Escrow mode. In Daemon mode it will not be a '1' 
2643
     */
2644
    private void generateDefaultTarget(XmlBuilder xml, int buildFile)
2645
    {
2646
        mLogger.debug("generateDefaultTarget");
2647
 
2648
        XmlBuilder target = xml.addNewElement("target").isExpanded();
2649
        target.addAttribute("name", "fullstart");
2650
 
2651
        if (buildFile == 1)
2652
        {
2653
            antEcho(target, "${line.separator}" + mAnyBuildPlatforms + "${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 == -1 )
2659
                {
2660
                    antEcho(target, "${line.separator}" + p.mAlias + "${line.separator}");
2661
                }
2662
            }
2663
 
2664
            antEcho(target, "${line.separator}" + mAssocBuildPlatforms + "${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 == -2 )
2670
                {
2671
                    antEcho(target, "${line.separator}" + p.mAlias + "${line.separator}");
2672
                }
2673
            }
2674
 
2675
            antEcho(target, "${line.separator}" + mNotInBaseline + "${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 == -4 )
2681
                {
2682
                    antEcho(target, "${line.separator}" + p.mAlias + "${line.separator}");
2683
                }
2684
            }
2685
 
2686
            antEcho(target, "${line.separator}" + mDependent + "${line.separator}${line.separator}");
7048 dpurdie 2687
            for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 2688
            {
2689
                Package p = it.next();
2690
 
2691
                if ( p.mBuildFile == -5 )
2692
                {
2693
                    antEcho(target, "${line.separator}" + p.mAlias + "${line.separator}");
2694
                }
2695
            }
2696
        }
2697
 
2698
        if ( !mDaemon )
2699
        {
2700
            antEcho(target, "${line.separator}Build Started:${line.separator}${line.separator}");
2701
        }
2702
 
2703
        //
2704
        //	Create a comma separated list of all the required targets
2705
        //      Escrow : All packages
2706
        //      Daemon : Just the package being built
2707
        //
2708
        StringAppender dependList = new StringAppender(",");
2709
        dependList.append("fullstart");
7048 dpurdie 2710
        for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 2711
        {
2712
            Package p = it.next();
2713
 
2714
            if ( ( p.mBuildFile > 0 ) && ( p.mBuildFile <= buildFile ) )
2715
            {
2716
                if ((mDaemon && p.mBuildFile == 1) || !mDaemon)
2717
                {
2718
                    dependList.append(p.mAlias);                    
2719
                }
2720
            }
2721
        }
2722
 
2723
        target = xml.addNewElement("target").isExpanded();
2724
        target.addAttribute("name", "full");
2725
        target.addAttribute("depends", dependList.toString());
2726
 
2727
        if ( !mDaemon )
2728
        {
2729
            antEcho(target, "${line.separator}Build Finished${line.separator}");
2730
        }
2731
    }
2732
 
2733
    /** Internal helper function to create an ant 'echo statement
2734
     *  Many of the parameters are fixed
2735
     */
2736
    private void antEcho( XmlBuilder xml, String message)
2737
    {
2738
        XmlBuilder msg = xml.addNewElement("echo");
2739
        msg.addAttribute("message", message);
2740
        msg.addAttribute("file", "publish.log");
2741
        msg.addAttribute("append", "true");
2742
    }
2743
 
2744
    /**sets the mIndirectlyPlanned true for the package and all dependent packages
2745
     */
2746
    private void rippleIndirectlyPlanned(Package p)
2747
    {
2748
        mLogger.debug("rippleIndirectlyPlanned");
2749
        if ( !p.mIndirectlyPlanned && p.mBuildFile == 0 )
2750
        {
2751
            p.mIndirectlyPlanned = true;
2752
 
7048 dpurdie 2753
            for (Iterator<Package> it = mPackageCollectionAll.iterator(); it.hasNext(); )
6914 dpurdie 2754
            {
2755
                Package pkg = it.next();
2756
 
2757
                if ( pkg != p )
2758
                {
2759
                    for (Iterator<Package> it2 = pkg.mPackageDependencyCollection.iterator(); it2.hasNext(); )
2760
                    {
2761
                        Package dependency = it2.next();
2762
 
2763
                        if ( dependency == p )
2764
                        {
2765
                            rippleIndirectlyPlanned( pkg );
2766
                            break;
2767
                        }
2768
                    }
2769
                }
2770
            }
2771
        }
7048 dpurdie 2772
        mLogger.info("rippleIndirectlyPlanned set {} {}", p.mName, p.mIndirectlyPlanned);    
6914 dpurdie 2773
    }
2774
 
2775
    /**accessor method
2776
     */
2777
    public String getEscrowSetUp()
2778
    {
2779
        mLogger.debug("getEscrowSetUp");
2780
        String retVal = mEscrowSetup;
2781
 
7048 dpurdie 2782
        mLogger.debug("getEscrowSetUp returned {}", retVal);
6914 dpurdie 2783
        return retVal;
2784
    }
2785
 
2786
    /**accessor method
2787
     */
2788
    public String getRawData()
2789
    {
2790
        mLogger.debug("getRawData");
2791
        String retVal = mEscrowRawData;
2792
 
7048 dpurdie 2793
        mLogger.debug("getRawData returned {}", retVal);
6914 dpurdie 2794
        return retVal;
2795
    }
2796
 
2797
    /**Get the build loc (location)
2798
     * This is package specific and will depend on the build mode (Escrow/Daemon)
2799
     * 
2800
     * @param	p - Package being built
2801
     * @return A string that describes the build location
2802
     */
2803
    private String getBuildLocation(Package p)
2804
    {
2805
        mLogger.debug("locationProperty");
2806
        String location = "";
2807
 
2808
        if (mDaemon)
2809
        {
2810
            // Daemon: Start in root of view/workspace
2811
            location += mBaseline;
2812
        }
2813
        else
2814
        {
2815
            // Escrow: mAlias used with jats -extractfiles -view
2816
            location += p.mAlias;
2817
        }
2818
 
2819
        //
2820
        //  Always use '/' as a path separator - even if user has specified '\'
2821
        //  Ant can handle it.
2822
        //
2823
        location = location.replace('\\', '/');
2824
        return location;
2825
    }
2826
 
2827
    /**Adds package build into as XML elements 
2828
     * @param	  xml 	- Xml element to extend
2829
     * @param   p       - Package to process
2830
     */
2831
    private void buildInfo(XmlBuilder xml, Package p)
2832
    {
2833
        mLogger.debug("buildInfo");
2834
 
2835
        //
2836
        // Create the xml build information
2837
        // <platform gbe_machtype="linux_i386" type="jats" arg="all"/>
2838
        //
2839
        for (Iterator<BuildStandard> it = p.mBuildStandardCollection.iterator(); it.hasNext();)
2840
        {
2841
            BuildStandard bs = it.next();
2842
            bs.getBuildStandardXml(xml);
2843
        }
2844
    }
2845
 
2846
    /**returns the buildInfo as a single line of text
2847
     * Used for reporting purposes only
2848
     * @param   p       - Package to process
2849
     * 
2850
     */
2851
    public String buildInfoText(Package p)
2852
    {
2853
        mLogger.debug("buildInfoText");
2854
 
2855
        StringAppender result = new StringAppender (";");
2856
 
2857
        //
2858
        //  Create platform:standards
2859
        //      
2860
        for (Iterator<BuildStandard> it = p.mBuildStandardCollection.iterator(); it.hasNext(); )
2861
        {
2862
            BuildStandard bs = it.next();
2863
 
2864
            if ( bs.isActive() )
2865
            {
2866
                String info = bs.getBuildStandardText();
2867
                result.append(info);
2868
            }
2869
        }
2870
 
7048 dpurdie 2871
        mLogger.info("buildInfoText returned {}", result);
6914 dpurdie 2872
        return result.toString();
2873
    }
2874
 
2875
    /**prints to standard out in escrow mode only
2876
     * <br>Prints a title and information. The title is only printed once.
2877
     * 
2878
     * @param header - The message title to display, if printMessage is true
2879
     * @param text - A package name. Really just the 2nd line of the message
2880
     * @param printHeader -  Controls the printing of the message argument
2881
     */
2882
    private void standardOut(final String header, final String text, boolean printHeader)
2883
    {
2884
        mLogger.debug("standardOut");
2885
        if (!mDaemon)
2886
        {
2887
            if ( printHeader )
2888
            {
2889
                System.out.println(header);
2890
            }
2891
 
2892
            System.out.println(text);
2893
        }
2894
    }
2895
 
2896
 
2897
    /**
2898
     *  Email users about a rejected daemon instruction
2899
     *  @param  reason  - Reason for the rejection
2900
     *  @param  pkg     - Package to be affected by the instruction
2901
     *  
2902
     */
2903
    public void emailRejectedDaemonInstruction(String reason, Package p)
2904
    {
2905
        mLogger.debug("emailRejectedDaemonInstruction");
2906
 
2907
        //  Email Subject
2908
        String subject = "BUILD FAILURE of Daemon Instruction on package " + p.mAlias;
2909
 
2910
        // Email Body
2911
        String mailBody = "The build system reject the the Daemon Instruction";
2912
        mailBody += "<br>Reason: " + reason; 
2913
 
2914
        mailBody += "<p>Release: " + mBaselineName 
2915
                +  "<br>Package: " + p.mAlias 
2916
                +  "<br>Rm Ref: " + CreateUrls.generateRmUrl(getRtagId(), p.mId); 
2917
 
2918
        mailBody += "<p><hr>";
2919
 
2920
        String target = p.emailInfoNonAntTask(this);
2921
 
7048 dpurdie 2922
        mLogger.error("emailRejectedDaemonInstruction Server: {}", getMailServer());
2923
        mLogger.error("emailRejectedDaemonInstruction Sender: {}", getMailSender());
2924
        mLogger.error("emailRejectedDaemonInstruction Target: {}", target);
6914 dpurdie 2925
 
2926
        try
2927
        {
2928
            //    
7048 dpurdie 2929
            Smtpsend.send(getMailServer(),  // mailServer
2930
                    getMailSender(),        // source
2931
                    target,                 // target
2932
                    getMailSender(),        // cc
2933
                    null,                   // bcc
2934
                    subject,                // subject
2935
                    mailBody,               // body
2936
                    null                    // attachment
6914 dpurdie 2937
                    );
2938
        } catch (Exception e)
2939
        {
7048 dpurdie 2940
            mLogger.warn("Email Failure: emailRejectedDaemonInstruction:{}", e.getMessage());
6914 dpurdie 2941
        }
2942
    }
2943
 
2944
    /**
2945
     * @return the mMailServer
2946
     */
2947
    public String getMailServer() {
2948
        return mMailServer;
2949
    }
2950
 
2951
    /**
2952
     * @param mMailServer the mMailServer to set
2953
     */
2954
    public void setMailServer(String mMailServer) {
2955
        this.mMailServer = mMailServer;
2956
    }
2957
 
2958
    /**
2959
     * @return the mMailSender
2960
     */
2961
    public String getMailSender() {
2962
        return mMailSender;
2963
    }
2964
 
2965
    /**
2966
     * @param mMailSender the mMailSender to set
2967
     */
2968
    public void setMailSender(String mMailSender) {
2969
        this.mMailSender = mMailSender;
2970
    }
2971
 
2972
    /**
2973
     * @return the mMailGlobalTarget
2974
     */
2975
    public String getMailGlobalTarget() {
2976
        return mMailGlobalTarget;
2977
    }
2978
 
2979
    /**
2980
     * @param mMailGlobalTarget the mMailGlobalTarget to set
2981
     */
2982
    public void setMailGlobalTarget(String mMailGlobalTarget) {
2983
        this.mMailGlobalTarget = mMailGlobalTarget;
2984
    }
2985
 
2986
}