/********************************************************************************
* CruiseControl, a Continuous Integration Toolkit
* Copyright (c) 2001-2003, ThoughtWorks, Inc.
* 200 E. Randolph, 25th Floor
* Chicago, IL 60601 USA
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* + Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* + Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* + Neither the name of ThoughtWorks, Inc., CruiseControl, nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
********************************************************************************/
package net.sourceforge.cruisecontrol.sourcecontrols;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Map;
import net.sourceforge.cruisecontrol.CruiseControlException;
import net.sourceforge.cruisecontrol.SourceControl;
import net.sourceforge.cruisecontrol.Modification;
import net.sourceforge.cruisecontrol.util.ValidationHelper;
/**
* This class implements a Compound source control with one triggers
* section and one targets section.
*
* The triggers section contains one or more source controls that act
* as triggers for the modifications, i.e. the modificationset
* returned will be empty unless one or more of the source
* controls in the triggers section returns a non-empty
* modification list.
*
* The targets section contains source controls for targets that will
* be built (if modified) if and only if any of the source controls
* in the triggers section is modified.
*
* It is possible to add the trigger modifications to the list of
* returned modifications if the "includeTriggerChanges"
* attribute is set to true in the {@code <compound...>} tag corresponding
* to this class.
*
* The following is an example of how to use this source control in
* the config.xml file:
*
* <modificationset quietperiod="1" >
* <compound includeTriggerChanges="false">
* <triggers>
* <filesystem folder="./mod_file.txt" />
* </triggers>
* <targets>
* <cvs
* cvsroot=":pserver:user@cvs_repo.com:/cvs"
* />
* </targets>
* </compound>
* </modificationset>
*
* @author <a href="mailto:will.gwaltney@sas.com">Will Gwaltney</a>
*/
public class Compound implements SourceControl {
private final SourceControlProperties properties = new SourceControlProperties();
private Triggers triggers = null;
private Targets targets = null;
private boolean includeTriggerChanges = false;
public void setProperty(String propertyName) {
properties.assignPropertyName(propertyName);
}
public Map<String, String> getProperties() {
return properties.getPropertiesAndReset();
}
/**
* Returns a list of modifications since the last build.
* First check for any modifications from the triggers.
* If there are none, then return an empty list. Otherwise
* return the modifications from the targets, and from the
* triggers also if the includeTriggerChanges member variable
* is true.
*
* @param lastBuild the date and time of the last build
* @param now the current date and time
*
* @return a list of the modifications
*/
public List<Modification> getModifications(final Date lastBuild, final Date now) {
final List<Modification> triggerMods;
List<Modification> targetMods = new ArrayList<Modification>();
triggerMods = triggers.getModifications(lastBuild, now);
if (!triggerMods.isEmpty()) {
targetMods = targets.getModifications(lastBuild, now);
// make sure we also pass the properties from the underlying targets
properties.putAll(targets.getProperties());
}
if (includeTriggerChanges) {
targetMods.addAll(triggerMods);
// make sure we also pass the properties from the underlying triggers
// TODO: do we really only want this when includeTriggerChanges is set?
properties.putAll(triggers.getProperties());
}
if (!targetMods.isEmpty()) {
properties.modificationFound();
}
return targetMods;
}
/**
* Confirms that there is exactly one triggers block and one targets
* block even if the triggers mods are included and the target
* block is empty (otherwise you wouldn't need a compound block
* to begin with).
*
* @throws CruiseControlException if the validation fails
*/
public void validate() throws CruiseControlException {
ValidationHelper.assertTrue(triggers != null,
"Error: there must be exactly one \"triggers\" block in a compound block.");
ValidationHelper.assertTrue(targets != null,
"Error: there must be exactly one \"targets\" block in a compound block.");
}
/**
* Creates an empty Triggers object and returns it to
* the calling routine to be filled.
*
* @return an empty Triggers object
*/
public Triggers createTriggers() {
Triggers tr = new Triggers(this);
this.triggers = tr;
return tr;
}
/**
* Creates an empty Targets object and returns it to
* the calling routine to be filled.
*
* @return an empty Targets object
*/
public Targets createTargets() {
Targets targ = new Targets(this);
this.targets = targ;
return targ;
}
/**
* Sets whether to include modifications from the triggers
* when getModifications() returns the mods list.
*
* @param changes true to include trigger changes, false otherwise
*/
public void setIncludeTriggerChanges(String changes) {
this.includeTriggerChanges = changes.equalsIgnoreCase("true");
}
/**
* Static inner class, used to define a basis for the Targets and Triggers
* classes that are used inside the <compound>-tag.
*/
protected static class Entry implements SourceControl {
private final SourceControlProperties properties = new SourceControlProperties();
private final List<SourceControl> sourceControls = new ArrayList<SourceControl>();
private SourceControl parent;
/**
* Public constructor for reflection purposes.
*
*/
public Entry() {
}
/**
* Constructor that the Compound class uses to create
* an object of this class.
*
* @param parent the parent of this object (an
* object of class Compound)
*/
public Entry(final SourceControl parent) {
this.parent = parent;
}
public Map<String, String> getProperties() {
return properties.getPropertiesAndReset();
}
/**
* Returns a list of modifications since the last build
* by querying the sourceControl that this object contains.
*
* @param lastBuild the date and time of the last build
* @param now the current date and time
*
* @return a list of the modifications
*/
public List<Modification> getModifications(final Date lastBuild, final Date now) {
final List<Modification> retVal = new ArrayList<Modification>();
for (final SourceControl sourceControl : sourceControls) {
retVal.addAll(sourceControl.getModifications(lastBuild, now));
// make sure we also pass the properties from the underlying sourcecontrol
properties.putAll(sourceControl.getProperties());
}
return retVal;
}
/**
* Confirms that the sourceControl that this object wraps
* has been set.
*
* @throws CruiseControlException if the validation fails
*/
public void validate() throws CruiseControlException {
if (sourceControls.isEmpty()) {
throw new CruiseControlException("Error: there must be at least one source control in a "
+ getEntryName() + " block.");
}
if (parent == null) {
throw new CruiseControlException("Error: " + getEntryName()
+ " blocks must be contained within compound blocks.");
}
}
/**
* Adds a sourcecontrol to the list of sourcecontrols that
* this object contains.
*
* @param sc the sourceControl object to add
*/
public void add(final SourceControl sc) {
sourceControls.add(sc);
}
/**
* Used by validate() to create a subclass-specific error-message.
* @return lower-case version of classname without package, e.g. 'triggers'.
*/
private String getEntryName() {
final String classname = getClass().getName();
final int index = classname.lastIndexOf('.');
if (index != -1) {
return classname.substring(index + 1).toLowerCase();
} else {
return classname.toLowerCase();
}
}
}
}