Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[JENKINS-49054] Work around XStream bug by looking up list type before trying to unmarshal elements #3248

Merged
merged 1 commit into from
Jan 21, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions core/src/main/java/hudson/util/DescribableList.java
Original file line number Diff line number Diff line change
Expand Up @@ -270,10 +270,9 @@ public void marshal(Object source, HierarchicalStreamWriter writer, MarshallingC
}

public Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) {
CopyOnWriteList core = copyOnWriteListConverter.unmarshal(reader, context);

try {
DescribableList r = (DescribableList)context.getRequiredType().newInstance();
DescribableList r = (DescribableList) context.getRequiredType().asSubclass(DescribableList.class).newInstance();
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

asSubclass ensures that even if the problem occurs, we will get a ClassCastException, which is easier to diagnose than a NoSuchMethodException.

CopyOnWriteList core = copyOnWriteListConverter.unmarshal(reader, context);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The workaround consists of moving the unmarshal call after the getRequiredType call, so even if unmarshal corrupts this aspect of the context, we can still produce a meaningful error.

r.data.replaceBy(core);
return r;
} catch (InstantiationException e) {
Expand Down
99 changes: 99 additions & 0 deletions core/src/test/java/hudson/util/DescribableListTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
/*
* The MIT License
*
* Copyright 2018 CloudBees, Inc.
*
* 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.util;

import com.thoughtworks.xstream.converters.basic.AbstractSingleValueConverter;
import hudson.model.Describable;
import hudson.model.Descriptor;
import org.junit.Test;
import static org.junit.Assert.*;
import org.jvnet.hudson.test.Issue;

public class DescribableListTest {

@Issue("JENKINS-49054")
@Test
public void exceptionDuringUnmarshalling() throws Exception {
Data data = new Data();
data.list.add(new Datum(1));
data.list.add(new Datum(2));
data.list.add(new Datum(3));
XStream2 xs = new XStream2();
xs.addCriticalField(Data.class, "list");
String xml = xs.toXML(data);
data = (Data) xs.fromXML(xml);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without the fix, we get something like

java.lang.InstantiationError
	at hudson.util.DescribableList$ConverterImpl.unmarshal(DescribableList.java:280)
	at com.thoughtworks.xstream.core.TreeUnmarshaller.convert(TreeUnmarshaller.java:72)
	at com.thoughtworks.xstream.core.AbstractReferenceUnmarshaller.convert(AbstractReferenceUnmarshaller.java:65)
	at com.thoughtworks.xstream.core.TreeUnmarshaller.convertAnother(TreeUnmarshaller.java:66)
	at hudson.util.RobustReflectionConverter.unmarshalField(RobustReflectionConverter.java:393)
	at hudson.util.RobustReflectionConverter.doUnmarshal(RobustReflectionConverter.java:331)
	at hudson.util.RobustReflectionConverter.unmarshal(RobustReflectionConverter.java:270)
	at com.thoughtworks.xstream.core.TreeUnmarshaller.convert(TreeUnmarshaller.java:72)
	at com.thoughtworks.xstream.core.AbstractReferenceUnmarshaller.convert(AbstractReferenceUnmarshaller.java:65)
	at com.thoughtworks.xstream.core.TreeUnmarshaller.convertAnother(TreeUnmarshaller.java:66)
	at com.thoughtworks.xstream.core.TreeUnmarshaller.convertAnother(TreeUnmarshaller.java:50)
	at com.thoughtworks.xstream.core.TreeUnmarshaller.start(TreeUnmarshaller.java:134)
	at com.thoughtworks.xstream.core.AbstractTreeMarshallingStrategy.unmarshal(AbstractTreeMarshallingStrategy.java:32)
	at com.thoughtworks.xstream.XStream.unmarshal(XStream.java:1189)
	at hudson.util.XStream2.unmarshal(XStream2.java:147)
	at hudson.util.XStream2.unmarshal(XStream2.java:118)
	at com.thoughtworks.xstream.XStream.unmarshal(XStream.java:1173)
	at com.thoughtworks.xstream.XStream.fromXML(XStream.java:1044)
	at com.thoughtworks.xstream.XStream.fromXML(XStream.java:1035)
	at hudson.util.DescribableListTest.unmarshalling(DescribableListTest.java:44)
	at …
Caused by: java.lang.InstantiationException: hudson.util.DescribableListTest$Datum
	at java.lang.Class.newInstance(Class.java:427)
	at hudson.util.DescribableList$ConverterImpl.unmarshal(DescribableList.java:276)
	... 43 more
Caused by: java.lang.NoSuchMethodException: hudson.util.DescribableListTest$Datum.<init>()
	at java.lang.Class.getConstructor0(Class.java:3082)
	at java.lang.Class.newInstance(Class.java:412)
	... 44 more

assertEquals("[1, 3]", data.toString());
}

private static final class Data {

final DescribableList<Datum,Descriptor<Datum>> list = new DescribableList<>();

@Override
public String toString() {
return list.toString();
}

}

private static final class Datum implements Describable<Datum> {

final int val;

Datum(int val) {
this.val = val;
}

@Override
public Descriptor<Datum> getDescriptor() {
return new Descriptor<Datum>(Datum.class) {};
}

@Override
public String toString() {
return Integer.toString(val);
}

public static final class ConverterImpl extends AbstractSingleValueConverter {

@Override
public boolean canConvert(Class type) {
return type == Datum.class;
}

@Override
public Object fromString(String str) {
int val = Integer.parseInt(str);
if (val == 2) {
throw new IllegalStateException("oops");
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just here to make for an artificial error in some element. Normally RobustReflectionConverter in Jenkins will handle these cases differently; I am not exactly sure how this happens in the field—because the original error is being masked by the NoSuchMethodException! Observed deserializing a FolderCredentialsProperty element of Folder.properties.

}
return new Datum(val);
}

}

}

}