Skip to content

Commit

Permalink
Crash in tests if anybody tries to log remotely. Remote logging usual…
Browse files Browse the repository at this point in the history
…ly indicates an error, and tests shouldn't normally have such errors.

--
MOS_MIGRATED_REVID=99789434
  • Loading branch information
janakdr authored and damienmg committed Aug 4, 2015
1 parent e927532 commit ae9b95f
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import com.google.common.eventbus.EventBus;
import com.google.common.eventbus.SubscriberExceptionContext;
import com.google.common.eventbus.SubscriberExceptionHandler;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.Uninterruptibles;
import com.google.devtools.build.lib.actions.PackageRootResolver;
import com.google.devtools.build.lib.actions.cache.ActionCache;
Expand Down Expand Up @@ -138,9 +139,12 @@
import java.util.Set;
import java.util.TreeMap;
import java.util.UUID;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.LogRecord;
import java.util.logging.Logger;
import java.util.regex.Pattern;

Expand Down Expand Up @@ -1489,6 +1493,11 @@ private static BlazeRuntime newRuntime(
? new BlazeRuntime.BugReportingExceptionHandler()
: new BlazeRuntime.RemoteExceptionHandler());

if (System.getenv("TEST_TMPDIR") != null
&& System.getenv("NO_CRASH_ON_LOGGING_IN_TEST") == null) {
LoggingUtil.installRemoteLogger(getTestCrashLogger());
}

for (BlazeModule blazeModule : blazeModules) {
runtimeBuilder.addBlazeModule(blazeModule);
}
Expand All @@ -1498,6 +1507,40 @@ private static BlazeRuntime newRuntime(
return runtime;
}

/**
* Returns a logger that crashes as soon as it's written to, since tests should not cause events
* that would be logged.
*/
@VisibleForTesting
public static Future<Logger> getTestCrashLogger() {
Logger crashLogger = Logger.getAnonymousLogger();
crashLogger.addHandler(
new Handler() {
@Override
public void publish(LogRecord record) {
throw new IllegalStateException(
record.getSourceClassName()
+ "#"
+ record.getSourceMethodName()
+ ": "
+ record.getMessage()
+ "\n"
+ record.getThrown());
}

@Override
public void flush() {
throw new IllegalStateException();
}

@Override
public void close() {
throw new IllegalStateException();
}
});
return Futures.immediateFuture(crashLogger);
}

/**
* Make sure async threads cannot be orphaned. This method makes sure bugs are reported to
* telemetry and the proper exit code is reported.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,14 @@ public static synchronized void installRemoteLogger(Future<Logger> logger) {
remoteLogger = logger;
}

/**
* Installs the remote logger. Same as {@link #installRemoteLogger}, but since multiple tests will
* run in the same JVM, does not assert that this is the first time the logger is being installed.
*/
public static synchronized void installRemoteLoggerForTesting(Future<Logger> logger) {
remoteLogger = logger;
}

/** Returns the installed logger, or null if none is installed. */
public static synchronized Logger getRemoteLogger() {
try {
Expand Down

0 comments on commit ae9b95f

Please sign in to comment.