/* * The MIT License * * Copyright (c) 2004-2011, Sun Microsystems, Inc., Kohsuke Kawaguchi, * Jorg Heymans, Red Hat, Inc., id:cactusman * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ package hudson.matrix; import hudson.CopyOnWrite; import hudson.Extension; import hudson.Util; import hudson.XmlFile; import hudson.model.AbstractProject; import hudson.model.Action; import hudson.model.BuildableItemWithBuildWrappers; import hudson.model.DependencyGraph; import hudson.model.Descriptor; import hudson.model.Descriptor.FormException; import hudson.model.Node; import hudson.slaves.WorkspaceList; import jenkins.model.Jenkins; import hudson.model.Item; import hudson.model.ItemGroup; import hudson.model.Items; import hudson.model.JDK; import hudson.model.Job; import hudson.model.Label; import hudson.model.Queue.FlyweightTask; import hudson.model.Result; import hudson.model.SCMedItem; import hudson.model.Saveable; import hudson.model.TopLevelItem; import hudson.tasks.BuildStep; import hudson.tasks.BuildWrapper; import hudson.tasks.BuildWrappers; import hudson.tasks.Builder; import hudson.tasks.Publisher; import hudson.triggers.Trigger; import hudson.util.CopyOnWriteMap; import hudson.util.DescribableList; import hudson.util.FormValidation; import hudson.util.FormValidation.Kind; import net.sf.json.JSONObject; import org.kohsuke.stapler.HttpResponse; import org.kohsuke.stapler.StaplerRequest; import org.kohsuke.stapler.StaplerResponse; import org.kohsuke.stapler.TokenList; import org.kohsuke.stapler.export.Exported; import javax.servlet.ServletException; import java.io.File; import java.io.FileFilter; import java.io.IOException; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.HashMap; import java.util.HashSet; import java.util.LinkedHashSet; import java.util.List; import java.util.Map; import java.util.Map.Entry; import java.util.Set; import java.util.logging.Level; import java.util.logging.Logger; /** * {@link Job} that allows you to run multiple different configurations * from a single setting. * * @author Kohsuke Kawaguchi */ public class MatrixProject extends AbstractProject implements TopLevelItem, SCMedItem, ItemGroup, Saveable, FlyweightTask, BuildableItemWithBuildWrappers { /** * Configuration axes. */ private volatile AxisList axes = new AxisList(); /** * The filter that is applied to combinations. It is a Groovy if condition. * This can be null, which means "true". * * @see #getCombinationFilter() */ private volatile String combinationFilter; /** * List of active {@link Builder}s configured for this project. */ private DescribableList> builders = new DescribableList>(this); /** * List of active {@link Publisher}s configured for this project. */ private DescribableList> publishers = new DescribableList>(this); /** * List of active {@link BuildWrapper}s configured for this project. */ private DescribableList> buildWrappers = new DescribableList>(this); /** * All {@link MatrixConfiguration}s, keyed by their {@link MatrixConfiguration#getName() names}. */ private transient /*final*/ Map configurations = new CopyOnWriteMap.Tree(); /** * @see #getActiveConfigurations() */ @CopyOnWrite private transient /*final*/ Set activeConfigurations = new LinkedHashSet(); /** * @deprecated as of 1.456 * Moved to {@link DefaultMatrixExecutionStrategyImpl} */ private transient Boolean runSequentially; /** * Filter to select a number of combinations to build first * @deprecated as of 1.456 * Moved to {@link DefaultMatrixExecutionStrategyImpl} */ private transient String touchStoneCombinationFilter; /** * Required result on the touchstone combinations, in order to * continue with the rest * @deprecated as of 1.456 * Moved to {@link DefaultMatrixExecutionStrategyImpl} */ private transient Result touchStoneResultCondition; /** * @deprecated as of 1.456 * Moved to {@link DefaultMatrixExecutionStrategyImpl} */ private transient MatrixConfigurationSorter sorter; private MatrixExecutionStrategy executionStrategy; private MatrixRunCheckoutStrategy matrixRunCheckoutStrategy; /** * Custom workspace location for {@link MatrixConfiguration}s. * *

* (Historically, we used {@link AbstractProject#customWorkspace} + some unique suffix (see {@link MatrixConfiguration#useShortWorkspaceName}) * for custom workspace, but we now separated that so that the user has more control. * *

* If null, the historical semantics is assumed. * * @since 1.466 */ private String childCustomWorkspace; public MatrixProject(String name) { this(Jenkins.getInstance(), name); } public MatrixProject(ItemGroup parent, String name) { super(parent, name); } /** * Gets the workspace location that {@link MatrixConfiguration} uses. * * @see MatrixRun.RunnerImpl#decideWorkspace(Node, WorkspaceList) * * @return never null * even when {@link MatrixProject} uses no custom workspace, this method still * returns something like "${PARENT_WORKSPACE}/${COMBINATION}" that controls * how the workspace should be laid out. * * The return value can be absolute or relative. If relative, it is resolved * against the working directory of the overarching {@link MatrixBuild}. */ public String getChildCustomWorkspace() { String ws = childCustomWorkspace; if (ws==null) { ws = MatrixConfiguration.useShortWorkspaceName?"${SHORT_COMBINATION}":"${COMBINATION}"; } return ws; } /** * Do we have an explicit child custom workspace setting (true)? Or just using the default value (false)? */ public boolean hasChildCustomWorkspace() { return childCustomWorkspace!=null; } public void setChildCustomWorkspace(String childCustomWorkspace) throws IOException { this.childCustomWorkspace = Util.fixEmptyAndTrim(childCustomWorkspace); save(); } /** * {@link MatrixProject} is relevant with all the labels its configurations are relevant. */ @Override public Set

* By default, a {@link MatrixConfiguration} is created for every possible combination of axes exhaustively. * But by specifying a Groovy expression as a combination filter, one can trim down the # of combinations built. * *

* Namely, this expression is evaluated for each axis value combination, and only when it evaluates to true, * a corresponding {@link MatrixConfiguration} will be created and built. * * @return can be null. * @since 1.279 */ public String getCombinationFilter() { return combinationFilter; } /** * @return can be null (to indicate that the configurations should be left to their natural order.) * @deprecated as of 1.456 * Use {@link DefaultMatrixExecutionStrategyImpl#getTouchStoneCombinationFilter()}. * This method tries to emulate the previous behavior the best it can, but will return null * if the current {@link MatrixExecutionStrategy} is not the default one. */ public String getTouchStoneCombinationFilter() { MatrixExecutionStrategy e = executionStrategy; if (e instanceof DefaultMatrixExecutionStrategyImpl) { DefaultMatrixExecutionStrategyImpl dm = (DefaultMatrixExecutionStrategyImpl) e; return dm.getTouchStoneCombinationFilter(); } return null; } /** * @deprecated as of 1.456 * Use {@link DefaultMatrixExecutionStrategyImpl#setTouchStoneCombinationFilter(String)}. * This method tries to emulate the previous behavior the best it can, but will fall back * to no-op if the current {@link MatrixExecutionStrategy} is not the default one. */ public void setTouchStoneCombinationFilter(String touchStoneCombinationFilter) throws IOException { MatrixExecutionStrategy e = executionStrategy; if (e instanceof DefaultMatrixExecutionStrategyImpl) { DefaultMatrixExecutionStrategyImpl dm = (DefaultMatrixExecutionStrategyImpl) e; dm.setTouchStoneCombinationFilter(touchStoneCombinationFilter); save(); } } /** * @return can be null (to indicate that the configurations should be left to their natural order.) * @deprecated as of 1.456 * Use {@link DefaultMatrixExecutionStrategyImpl#getTouchStoneResultCondition()}. * This method tries to emulate the previous behavior the best it can, but will return null * if the current {@link MatrixExecutionStrategy} is not the default one. */ public Result getTouchStoneResultCondition() { MatrixExecutionStrategy e = executionStrategy; if (e instanceof DefaultMatrixExecutionStrategyImpl) { DefaultMatrixExecutionStrategyImpl dm = (DefaultMatrixExecutionStrategyImpl) e; return dm.getTouchStoneResultCondition(); } return null; } /** * @deprecated as of 1.456 * Use {@link DefaultMatrixExecutionStrategyImpl#setTouchStoneResultCondition(Result)}. * This method tries to emulate the previous behavior the best it can, but will fall back * to no-op if the current {@link MatrixExecutionStrategy} is not the default one. */ public void setTouchStoneResultCondition(Result touchStoneResultCondition) throws IOException { MatrixExecutionStrategy e = executionStrategy; if (e instanceof DefaultMatrixExecutionStrategyImpl) { DefaultMatrixExecutionStrategyImpl dm = (DefaultMatrixExecutionStrategyImpl) e; dm.setTouchStoneResultCondition(touchStoneResultCondition); save(); } } @Override protected List createTransientActions() { List r = super.createTransientActions(); for (BuildStep step : builders) r.addAll(step.getProjectActions(this)); for (BuildStep step : publishers) r.addAll(step.getProjectActions(this)); for (BuildWrapper step : buildWrappers) r.addAll(step.getProjectActions(this)); for (Trigger trigger : triggers) r.addAll(trigger.getProjectActions()); return r; } /** * Gets the subset of {@link AxisList} that are not system axes. * * @deprecated as of 1.373 * System vs user difference are generalized into extension point. */ public List getUserAxes() { List r = new ArrayList(); for (Axis a : axes) if(!a.isSystem()) r.add(a); return r; } public Layouter getLayouter() { return new Layouter(axes) { protected MatrixConfiguration getT(Combination c) { return getItem(c); } }; } @Override public void onCreatedFromScratch() { executionStrategy = new DefaultMatrixExecutionStrategyImpl(); super.onCreatedFromScratch(); } @Override public void onLoad(ItemGroup parent, String name) throws IOException { super.onLoad(parent,name); Collections.sort(axes); // perhaps the file was edited on disk and the sort order might have been broken builders.setOwner(this); publishers.setOwner(this); buildWrappers.setOwner(this); if (executionStrategy ==null) executionStrategy = new DefaultMatrixExecutionStrategyImpl(runSequentially,touchStoneCombinationFilter,touchStoneResultCondition,sorter); rebuildConfigurations(); } @Override public void logRotate() throws IOException, InterruptedException { super.logRotate(); // perform the log rotation of inactive configurations to make sure // their logs get eventually discarded for (MatrixConfiguration config : configurations.values()) { if(!config.isActiveConfiguration()) config.logRotate(); } } /** * Recursively search for configuration and put them to the map * *

* The directory structure would be axis-a/b/axis-c/d/axis-e/f for * combination [a=b,c=d,e=f]. Note that two combinations [a=b,c=d] and [a=b,c=d,e=f] * can both co-exist (where one is an archived record and the other is live, for example) * so search needs to be thorough. * * @param dir * Directory to be searched. * @param result * Receives the loaded {@link MatrixConfiguration}s. * @param combination * Combination of key/values discovered so far while traversing the directories. * Read-only. */ private void loadConfigurations( File dir, CopyOnWriteMap.Tree result, Map combination ) { File[] axisDirs = dir.listFiles(new FileFilter() { public boolean accept(File child) { return child.isDirectory() && child.getName().startsWith("axis-"); } }); if(axisDirs==null) return; for (File subdir : axisDirs) { String axis = subdir.getName().substring(5); // axis name File[] valuesDir = subdir.listFiles(new FileFilter() { public boolean accept(File child) { return child.isDirectory(); } }); if(valuesDir==null) continue; // no values here for (File v : valuesDir) { Map c = new HashMap(combination); c.put(axis,TokenList.decode(v.getName())); try { XmlFile config = Items.getConfigFile(v); if(config.exists()) { Combination comb = new Combination(c); // if we already have this in memory, just use it. // otherwise load it MatrixConfiguration item=null; if(this.configurations!=null) item = this.configurations.get(comb); if(item==null) { item = (MatrixConfiguration) config.read(); item.setCombination(comb); item.onLoad(this, v.getName()); } result.put(item.getCombination(), item); } } catch (IOException e) { LOGGER.log(Level.WARNING, "Failed to load matrix configuration "+v,e); } loadConfigurations(v,result,c); } } } /** * Rebuilds the {@link #configurations} list and {@link #activeConfigurations}. */ private void rebuildConfigurations() throws IOException { { // backward compatibility check to see if there's any data in the old structure // if so, bring them to the newer structure. File[] oldDirs = getConfigurationsDir().listFiles(new FileFilter() { public boolean accept(File child) { return child.isDirectory() && !child.getName().startsWith("axis-"); } }); if(oldDirs!=null) { // rename the old directory to the new one for (File dir : oldDirs) { try { Combination c = Combination.fromString(dir.getName()); dir.renameTo(getRootDirFor(c)); } catch (IllegalArgumentException e) { // it's not a configuration dir. Just ignore. } } } } CopyOnWriteMap.Tree configurations = new CopyOnWriteMap.Tree(); loadConfigurations(getConfigurationsDir(),configurations,Collections.emptyMap()); this.configurations = configurations; // find all active configurations Set active = new LinkedHashSet(); for (Combination c : axes.list()) { if(c.evalGroovyExpression(axes,combinationFilter)) { LOGGER.fine("Adding configuration: " + c); MatrixConfiguration config = configurations.get(c); if(config==null) { config = new MatrixConfiguration(this,c); config.save(); configurations.put(config.getCombination(), config); } active.add(config); } } this.activeConfigurations = active; } private File getConfigurationsDir() { return new File(getRootDir(),"configurations"); } /** * Gets all active configurations. *

* In contract, inactive configurations are those that are left for archival purpose * and no longer built when a new {@link MatrixBuild} is executed. */ @Exported public Collection getActiveConfigurations() { return activeConfigurations; } public Collection getItems() { return configurations.values(); } @Override public Collection getAllJobs() { Set jobs = new HashSet(getItems()); jobs.add(this); return jobs; } public String getUrlChildPrefix() { return "."; } public MatrixConfiguration getItem(String name) { try { return getItem(Combination.fromString(name)); } catch (IllegalArgumentException e) { return null; } } public MatrixConfiguration getItem(Combination c) { return configurations.get(c); } public File getRootDirFor(MatrixConfiguration child) { return getRootDirFor(child.getCombination()); } public void onRenamed(MatrixConfiguration item, String oldName, String newName) throws IOException { throw new UnsupportedOperationException(); } public void onDeleted(MatrixConfiguration item) throws IOException { // noop } public File getRootDirFor(Combination combination) { File f = getConfigurationsDir(); for (Entry e : combination.entrySet()) f = new File(f,"axis-"+e.getKey()+'/'+Util.rawEncode(e.getValue())); f.getParentFile().mkdirs(); return f; } /** * @see #getJDKs() */ @Override @Deprecated public JDK getJDK() { return super.getJDK(); } /** * Gets the {@link JDK}s where the builds will be run. * @return never null but can be empty */ public Set getJDKs() { Axis a = axes.find("jdk"); if(a==null) return Collections.emptySet(); Set r = new HashSet(); for (String j : a) { JDK jdk = Jenkins.getInstance().getJDK(j); if(jdk!=null) r.add(jdk); } return r; } /** * Gets the {@link Label}s where the builds will be run. * @return never null */ public Set