Skip to content
Permalink
Browse files

Merge pull request #18 from ikedam/feature/JENKINS-34488_Unserializab…

…leException

[JENKINS-34488] Use ProxyException for exceptions rejected by XStream
  • Loading branch information
jglick committed Oct 19, 2016
2 parents ca8f6dd + b80a3a6 commit 18481659fcc4ee9f62fdbf07cd44aed373664832
@@ -25,6 +25,7 @@
package org.jenkinsci.plugins.workflow.actions;

import groovy.lang.MissingMethodException;
import hudson.remoting.ClassFilter;
import hudson.remoting.ProxyException;
import org.codehaus.groovy.control.MultipleCompilationErrorsException;
import org.jenkinsci.plugins.workflow.graph.AtomNode;
@@ -53,6 +54,19 @@ public ErrorAction(Throwable error) {
* an equivalent that captures the same details but serializes nicely.
*/
private boolean isUnserializableException(Throwable error) {
if (error == null) {
// This shouldn't happen.
return false;
}
try {
// Some exceptions are refused to be serialized for security reasons.
// (E.g. PowerAssertionError thrown by "assert false")
// See also hudson.util.XStream2
ClassFilter.DEFAULT.check(error.getClass());
ClassFilter.DEFAULT.check(error.getClass().getName());
} catch (SecurityException x) {
return true;
}
return error instanceof MultipleCompilationErrorsException ||
error instanceof MissingMethodException;
}
@@ -0,0 +1,113 @@
/*
* The MIT License
*
* Copyright (c) 2016 IKEDA Yasuyuki
*
* 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 org.jenkinsci.plugins.workflow.actions;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertThat;

import java.util.ArrayList;
import java.util.List;

import org.hamcrest.Matchers;
import org.jenkinsci.plugins.workflow.cps.CpsFlowDefinition;
import org.jenkinsci.plugins.workflow.flow.FlowExecution;
import org.jenkinsci.plugins.workflow.graph.FlowGraphWalker;
import org.jenkinsci.plugins.workflow.graph.FlowNode;
import org.jenkinsci.plugins.workflow.job.WorkflowJob;
import org.jenkinsci.plugins.workflow.job.WorkflowRun;
import org.junit.ClassRule;
import org.junit.Rule;
import org.junit.Test;
import org.jvnet.hudson.test.BuildWatcher;
import org.jvnet.hudson.test.Issue;
import org.jvnet.hudson.test.JenkinsRule;

import hudson.model.Result;
import hudson.remoting.ProxyException;

/**
* Tests for {@link ErrorAction}
*/
public class ErrorActionTest {
@ClassRule
public static BuildWatcher buildWatcher = new BuildWatcher();

@Rule
public JenkinsRule r = new JenkinsRule();

private List<ErrorAction> extractErrorActions(FlowExecution exec) {
List<ErrorAction> ret = new ArrayList<ErrorAction>();

FlowGraphWalker walker = new FlowGraphWalker(exec);
for (FlowNode n : walker) {
ErrorAction e = n.getAction(ErrorAction.class);
if (e != null) {
ret.add(e);
}
}
return ret;
}

@Test
public void simpleException() throws Exception {
final String EXPECTED = "For testing purpose";
WorkflowJob job = r.jenkins.createProject(WorkflowJob.class, "p");
job.setDefinition(new CpsFlowDefinition(String.format(
"node {\n"
+ "throw new Exception('%s');\n"
+ "}"
, EXPECTED
)));
WorkflowRun b = r.assertBuildStatus(Result.FAILURE, job.scheduleBuild2(0).get());
List<ErrorAction> errorActionList = extractErrorActions(b.asFlowExecutionOwner().get());
assertThat(errorActionList, Matchers.not(Matchers.empty()));
for (ErrorAction e : errorActionList) {
assertEquals(Exception.class, e.getError().getClass());
assertEquals(EXPECTED, e.getError().getMessage());
}
}

@Issue("JENKINS-34488")
@Test
public void unserializableForSecurityReason() throws Exception {
final String FAILING_EXPRESSION = "(2 + 2) == 5";
WorkflowJob job = r.jenkins.createProject(WorkflowJob.class, "p");
// "assert false" throws org.codehaus.groovy.runtime.powerassert.PowerAssertionError,
// which is rejected by remoting.
job.setDefinition(new CpsFlowDefinition(String.format(
"node {\n"
+ "assert %s;\n"
+ "}",
FAILING_EXPRESSION
)));
WorkflowRun b = r.assertBuildStatus(Result.FAILURE, job.scheduleBuild2(0).get());
r.assertLogContains(FAILING_EXPRESSION, b); // ensure that failed with the assertion.
List<ErrorAction> errorActionList = extractErrorActions(b.asFlowExecutionOwner().get());
assertThat(errorActionList, Matchers.not(Matchers.empty()));
for (ErrorAction e : errorActionList) {
assertEquals(ProxyException.class, e.getError().getClass());
}
}
}

0 comments on commit 1848165

Please sign in to comment.
You can’t perform that action at this time.