From c273895d8232528bbde7d66692b88f6f2309a7fc Mon Sep 17 00:00:00 2001 From: Robert Muir Date: Wed, 9 Sep 2015 18:00:46 -0400 Subject: [PATCH] Remove noise when IDE test runners try to System.exit --- .../bootstrap/BootstrapForTesting.java | 2 +- .../bootstrap/XTestSecurityManager.java | 95 +++++++++++++++++++ 2 files changed, 96 insertions(+), 1 deletion(-) create mode 100644 core/src/test/java/org/elasticsearch/bootstrap/XTestSecurityManager.java diff --git a/core/src/test/java/org/elasticsearch/bootstrap/BootstrapForTesting.java b/core/src/test/java/org/elasticsearch/bootstrap/BootstrapForTesting.java index 58f4406ae7e..a779db2326b 100644 --- a/core/src/test/java/org/elasticsearch/bootstrap/BootstrapForTesting.java +++ b/core/src/test/java/org/elasticsearch/bootstrap/BootstrapForTesting.java @@ -114,7 +114,7 @@ public class BootstrapForTesting { perms.add(new FilePermission(coverageDir.resolve("jacoco-it.exec").toString(), "read,write")); } Policy.setPolicy(new ESPolicy(perms)); - System.setSecurityManager(new TestSecurityManager()); + System.setSecurityManager(new XTestSecurityManager()); Security.selfTest(); } catch (Exception e) { throw new RuntimeException("unable to install test security manager", e); diff --git a/core/src/test/java/org/elasticsearch/bootstrap/XTestSecurityManager.java b/core/src/test/java/org/elasticsearch/bootstrap/XTestSecurityManager.java new file mode 100644 index 00000000000..3c25c0aa05b --- /dev/null +++ b/core/src/test/java/org/elasticsearch/bootstrap/XTestSecurityManager.java @@ -0,0 +1,95 @@ +package org.elasticsearch.bootstrap; + +import java.security.AccessController; +import java.security.PrivilegedAction; + +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * A {@link SecurityManager} that prevents tests calling {@link System#exit(int)}. + * Only the test runner itself is allowed to exit the JVM. + * All other security checks are handled by the default security policy. + *

+ * Use this with {@code -Djava.security.manager=org.apache.lucene.util.TestSecurityManager}. + */ +// TODO: remove me when https://issues.apache.org/jira/browse/LUCENE-6794 is committed +public final class XTestSecurityManager extends SecurityManager { + + static final String JUNIT4_TEST_RUNNER_PACKAGE = "com.carrotsearch.ant.tasks.junit4."; + static final String ECLIPSE_TEST_RUNNER_PACKAGE = "org.eclipse.jdt.internal.junit.runner."; + static final String IDEA_TEST_RUNNER_PACKAGE = "com.intellij.rt.execution.junit.JUnitStarter."; + + /** + * Creates a new TestSecurityManager. This ctor is called on JVM startup, + * when {@code -Djava.security.manager=org.apache.lucene.util.TestSecurityManager} + * is passed to JVM. + */ + public XTestSecurityManager() { + super(); + } + + /** + * {@inheritDoc} + *

This method inspects the stack trace and checks who is calling + * {@link System#exit(int)} and similar methods + * @throws SecurityException if the caller of this method is not the test runner itself. + */ + @Override + public void checkExit(final int status) { + AccessController.doPrivileged(new PrivilegedAction() { + @Override + public Void run() { + final String systemClassName = System.class.getName(), + runtimeClassName = Runtime.class.getName(); + String exitMethodHit = null; + for (final StackTraceElement se : Thread.currentThread().getStackTrace()) { + final String className = se.getClassName(), methodName = se.getMethodName(); + if ( + ("exit".equals(methodName) || "halt".equals(methodName)) && + (systemClassName.equals(className) || runtimeClassName.equals(className)) + ) { + exitMethodHit = className + '#' + methodName + '(' + status + ')'; + continue; + } + + if (exitMethodHit != null) { + if (className.startsWith(JUNIT4_TEST_RUNNER_PACKAGE) || + className.startsWith(ECLIPSE_TEST_RUNNER_PACKAGE) || + className.startsWith(IDEA_TEST_RUNNER_PACKAGE)) { + // this exit point is allowed, we return normally from closure: + return /*void*/ null; + } else { + // anything else in stack trace is not allowed, break and throw SecurityException below: + break; + } + } + } + + if (exitMethodHit == null) { + // should never happen, only if JVM hides stack trace - replace by generic: + exitMethodHit = "JVM exit method"; + } + throw new SecurityException(exitMethodHit + " calls are not allowed because they terminate the test runner's JVM."); + } + }); + + // we passed the stack check, delegate to super, so default policy can still deny permission: + super.checkExit(status); + } + +}