/*
* The MIT License
*
* Copyright (C) 2010-2011 by Anthony Robinson
*
* 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 lib.form;
import com.gargoylesoftware.htmlunit.html.HtmlElement;
import com.gargoylesoftware.htmlunit.html.HtmlForm;
import com.gargoylesoftware.htmlunit.html.HtmlPage;
import com.gargoylesoftware.htmlunit.html.HtmlTextInput;
import hudson.Extension;
import hudson.model.Describable;
import hudson.model.Descriptor;
import jenkins.model.Jenkins;
import org.jvnet.hudson.test.HudsonTestCase;
import org.kohsuke.stapler.DataBoundConstructor;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
public class RepeatablePropertyTest extends HudsonTestCase implements Describable<RepeatablePropertyTest> {
private static final String VIEW_WITHOUT_DEFAULT = "noDefault";
private static final String VIEW_WITH_DEFAULT = "withDefault";
public ArrayList<ExcitingObject> testRepeatable;
public ArrayList<ExcitingObject> defaults;
public void testSimple() throws Exception {
testRepeatable = createRepeatable();
assertFormContents(VIEW_WITHOUT_DEFAULT, testRepeatable);
}
public void testNullFieldNoDefault() throws Exception {
assertFormContents(VIEW_WITHOUT_DEFAULT, new ArrayList<ExcitingObject>());
}
public void testNullFieldWithDefault() throws Exception {
defaults = createRepeatable();
assertFormContents(VIEW_WITH_DEFAULT, defaults);
}
public void testFieldNotNullWithDefaultIgnoresDefaults() throws Exception {
testRepeatable = createRepeatable();
defaults = new ArrayList<ExcitingObject>(Arrays.asList(
new ExcitingObject("This default should be ignored"),
new ExcitingObject("Ignore me too")
));
assertFormContents(VIEW_WITH_DEFAULT, testRepeatable);
}
private void assertFormContents(final String viewName, final ArrayList<ExcitingObject> expected) throws Exception {
final HtmlForm form = getForm(viewName);
final List<HtmlTextInput> inputs = toTextInputList(form.getElementsByAttribute("input", "type", "text"));
assertEquals("size", expected.size(), inputs.size());
for (int i = 0; i < expected.size(); i++)
assertEquals(expected.get(i).greatProperty, inputs.get(i).getValueAttribute());
}
private List<HtmlTextInput> toTextInputList(final List<HtmlElement> inputs) {
assertNotNull(inputs);
final List<HtmlTextInput> textInputList = new ArrayList<HtmlTextInput>();
for (HtmlElement input : inputs) {
assertTrue(input instanceof HtmlTextInput);
textInputList.add((HtmlTextInput) input);
}
return textInputList;
}
private ArrayList<ExcitingObject> createRepeatable() {
return new ArrayList<ExcitingObject>(Arrays.asList(
new ExcitingObject("A nice thing"),
new ExcitingObject("I'm even better"),
new ExcitingObject("Don't bother, I'm not exciting at all")
));
}
private HtmlForm getForm(final String viewName) throws Exception {
final HtmlPage page = createWebClient().goTo("self/" + viewName);
final HtmlForm form = page.getFormByName("config");
return form;
}
public DescriptorImpl getDescriptor() {
return hudson.getDescriptorByType(DescriptorImpl.class);
}
@Extension
public static final class DescriptorImpl extends Descriptor<RepeatablePropertyTest> {
@Override
public String getDisplayName() {
return "RepeatablePropertyTest";
}
}
public static final class ExcitingObject implements Describable<ExcitingObject> {
private final String greatProperty;
@DataBoundConstructor
public ExcitingObject(final String greatProperty) {
this.greatProperty = greatProperty;
}
public String getGreatProperty() {
return greatProperty;
}
public Descriptor<ExcitingObject> getDescriptor() {
return Jenkins.getInstance().getDescriptor(ExcitingObject.class);
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
ExcitingObject that = (ExcitingObject) o;
if (greatProperty != null ? !greatProperty.equals(that.greatProperty) : that.greatProperty != null)
return false;
return true;
}
@Override
public int hashCode() {
return greatProperty != null ? greatProperty.hashCode() : 0;
}
@Override
public String toString() {
return "ExcitingObject[" + greatProperty + ']';
}
@Extension
public static final class ExcitingDescriptor extends Descriptor<ExcitingObject> {
public ExcitingDescriptor() {
super(ExcitingObject.class);
}
@Override
public String getDisplayName() {
return "This is an awesome thing!";
}
}
}
}