/*
* The MIT License
*
* Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
*
* 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.DescriptorExtensionList;
import hudson.ExtensionPoint;
import hudson.RestrictedSince;
import hudson.Util;
import hudson.matrix.MatrixBuild.MatrixBuildExecution;
import hudson.model.AbstractDescribableImpl;
import jenkins.model.Jenkins;
import hudson.util.QuotedStringTokenizer;
import org.kohsuke.accmod.Restricted;
import org.kohsuke.accmod.restrictions.NoExternalUse;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.DataBoundConstructor;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.List;
import java.util.Arrays;
import java.util.Map;
/**
* Configuration axis.
*
* <p>
* This class represents a single dimension of the configuration matrix.
* For example, the JAX-WS RI test configuration might include
* one axis "container={glassfish,tomcat,jetty}" and another axis
* "stax={sjsxp,woodstox}", and so on.
*
* @author Kohsuke Kawaguchi
*/
public class Axis extends AbstractDescribableImpl<Axis> implements Comparable<Axis>, Iterable<String>, ExtensionPoint {
/**
* Name of this axis.
* Used as a variable name.
*
* @deprecated as of 1.373
* Use {@link #getName()}
*/
@Restricted(NoExternalUse.class)
public final String name;
/**
* Possible values for this axis.
*
* @deprecated as of 1.373
* Use {@link #getValues()}
*/
@Restricted(NoExternalUse.class)
@RestrictedSince("1.463")
public final List<String> values;
public Axis(String name, List<String> values) {
if (values == null || values.isEmpty()) {
values = Collections.emptyList();
}
this.name = name;
this.values = new ArrayList<String>(values);
}
public Axis(String name, String... values) {
this(name,Arrays.asList(values));
}
/**
* Used to build {@link Axis} from form.
*
* Axis with empty values need to be removed later.
*/
@DataBoundConstructor
public Axis(String name, String valueString) {
this.name = name;
this.values = new ArrayList<String>(Arrays.asList(Util.tokenize(valueString)));
}
/**
* Returns true if this axis is a system-reserved axis
* that used to have special treatment.
*
* @deprecated as of 1.373
* System vs user difference are generalized into extension point.
*/
public boolean isSystem() {
return false;
}
public Iterator<String> iterator() {
return getValues().iterator();
}
public int size() {
return getValues().size();
}
public String value(int index) {
return getValues().get(index);
}
/**
* The inverse of {@link #value(int)}.
*/
public int indexOf(String value) {
return values.indexOf(value);
}
/**
* Axis is fully ordered so that we can convert between a list of axis
* and a string unambiguously.
*/
public int compareTo(Axis that) {
return this.name.compareTo(that.name);
}
@Override
public int hashCode() {
int hash = 7;
hash = 41 * hash + (this.name != null ? this.name.hashCode() : 0);
hash = 41 * hash + (this.values != null ? this.values.hashCode() : 0);
return hash;
}
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final Axis other = (Axis) obj;
if ((this.name == null) ? (other.name != null) : !this.name.equals(other.name)) {
return false;
}
if (this.values != other.values && (this.values == null || !this.values.equals(other.values))) {
return false;
}
return true;
}
/**
* Name of this axis.
* Used as a variable name.
*/
public String getName() {
return name;
}
/**
* Possible values for this axis.
*/
public List<String> getValues() {
return Collections.unmodifiableList(values);
}
/**
* Called right at the beginning of {@link MatrixBuild} execution to allow {@link Axis} to update {@link #values}
* based on the current build.
*
* <p>
* Historically, axes values are considered static. They were assumed to reflect what the user has typed in,
* and their values are changed only when the project is reconfigured. So abstractions are built around this
* notion, and so for example {@link MatrixProject} has the current axes and their values, which it uses
* to render its UI.
*
* <p>
* So when the need was identified to change the values of axes per build, we decided that this be represented
* as a kind of project configuration update (where a project gets reconfigured every time a build runs), and
* this call back was added to allow {@link Axis} to update the next return value from the {@link #getValues()}
* (which is typically done by updating {@link #values}.)
*
* <p>
* While it is not strictly required, because of these historical reasons, UI will look better if
* Future calls to {@link Axis#getValues()} return the same values as what this method returns (until
* the next rebuild call).
*
* @param context
* The ongoing build. Never null.
* @return
* Never null. Returns the updated set of values.
* @since 1.471
*/
public List<String> rebuild(MatrixBuildExecution context) {
return getValues();
}
@Override
public AxisDescriptor getDescriptor() {
return (AxisDescriptor)super.getDescriptor();
}
@Override
public String toString() {
return new StringBuilder().append(name).append("={").append(Util.join(values,",")).append('}').toString();
}
/**
* Used for generating the config UI.
* If the axis is big and occupies a lot of space, use newline for separator
* to display multi-line text.
*/
public String getValueString() {
int len=0;
for (String value : values)
len += value.length();
char delim = len>30 ? '\n' : ' ';
// Build string connected with delimiter, quoting as needed
StringBuilder buf = new StringBuilder(len+values.size()*3);
for (String value : values) {
if (buf.length() != 0) buf.append(delim);
buf.append(QuotedStringTokenizer.quote(value, ""));
}
return buf.toString();
}
/**
* Parses the submitted form (where possible values are
* presented as a list of checkboxes) and creates an axis
*/
public static Axis parsePrefixed(StaplerRequest req, String name) {
List<String> values = new ArrayList<String>();
String prefix = name+'.';
Enumeration e = req.getParameterNames();
while (e.hasMoreElements()) {
String paramName = (String) e.nextElement();
if(paramName.startsWith(prefix))
values.add(paramName.substring(prefix.length()));
}
if(values.isEmpty())
return null;
return new Axis(name,values);
}
/**
* Previously we used to persist {@link Axis}, but now those are divided into subtypes.
* So upon deserialization, resolve to the proper type.
*/
public Object readResolve() {
if (getClass()!=Axis.class) return this;
/*
This method is necessary only because earlier versions of Jenkins treated
axis names "label" and "jdk" differently,
plus Axis was a concrete class, and we need to be able to read that back.
So this measure is not needed for newly added Axes.
*/
if (getName().equals("jdk"))
return new JDKAxis(getValues());
if (getName().equals("label"))
return new LabelAxis(getName(),getValues());
return new TextAxis(getName(),getValues());
}
/**
* Returns all the registered {@link AxisDescriptor}s.
*/
public static DescriptorExtensionList<Axis,AxisDescriptor> all() {
final Jenkins jenkins = Jenkins.getInstance();
if (jenkins != null) {
return jenkins.<Axis,AxisDescriptor>getDescriptorList(Axis.class);
} else {
return DescriptorExtensionList.createDescriptorList((Jenkins)null, Axis.class);
}
}
/**
* Converts the selected value (which is among {@link #values}) and adds that to the given map,
* which serves as the build variables.
*/
public void addBuildVariable(String value, Map<String,String> map) {
map.put(name,value);
}
}