blob: 42183987c56dc7c4347005579eea6dcfcc1fec20 [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// This class sets up the environment for running the native tests inside an
// android application. It outputs (to logcat) markers identifying the
// START/END/CRASH of the test suite, FAILURE/SUCCESS of individual tests etc.
// These markers are read by the test runner script to generate test results.
// It injects an event listener in gtest to detect various test stages and
// installs signal handlers to detect crashes.
#include <android/log.h>
#include <signal.h>
#include <stdio.h>
#include "base/android/base_jni_registrar.h"
#include "base/android/jni_android.h"
#include "base/android/jni_string.h"
#include "base/android/locale_utils.h"
#include "base/android/path_utils.h"
#include "base/android/scoped_java_ref.h"
#include "base/at_exit.h"
#include "base/base_switches.h"
#include "base/command_line.h"
#include "base/file_path.h"
#include "base/file_util.h"
#include "base/logging.h"
#include "base/stringprintf.h"
#include "base/string_tokenizer.h"
#include "base/string_util.h"
#include "gtest/gtest.h"
#include "testing/jni/ChromeNativeTestActivity_jni.h"
// The main function of the program to be wrapped as a test apk.
extern int main(int argc, char** argv);
namespace {
void log_write(int level, const char* msg) {
__android_log_write(level, "chromium", msg);
// The list of signals which are considered to be crashes.
const int kExceptionSignals[] = {
struct sigaction g_old_sa[NSIG];
// This function runs in a compromised context. It should not allocate memory.
void SignalHandler(int sig, siginfo_t *info, void *reserved)
// Output the crash marker.
log_write(ANDROID_LOG_ERROR, "[ CRASHED ]");
g_old_sa[sig].sa_sigaction(sig, info, reserved);
void InstallHandlers() {
struct sigaction sa;
memset(&sa, 0, sizeof(sa));
sa.sa_sigaction = SignalHandler;
sa.sa_flags = SA_SIGINFO;
for (unsigned int i = 0; kExceptionSignals[i] != -1; ++i) {
sigaction(kExceptionSignals[i], &sa, &g_old_sa[kExceptionSignals[i]]);
void ParseArgsFromString(const std::string& command_line,
std::vector<std::string>* args) {
StringTokenizer tokenizer(command_line, kWhitespaceASCII);
while (tokenizer.GetNext()) {
std::string token;
RemoveChars(tokenizer.token(), "\"", &token);
void ParseArgsFromCommandLineFile(std::vector<std::string>* args) {
// The test runner script writes the command line file in
// "/data/local/tmp".
static const char kCommandLineFilePath[] =
FilePath command_line(kCommandLineFilePath);
std::string command_line_string;
if (file_util::ReadFileToString(command_line, &command_line_string)) {
ParseArgsFromString(command_line_string, args);
int ArgsToArgv(const std::vector<std::string>& args,
std::vector<char*>* argv) {
// We need to pass in a non-const char**.
int argc = args.size();
argv->resize(argc + 1);
for (int i = 0; i < argc; ++i)
(*argv)[i] = const_cast<char*>(args[i].c_str());
(*argv)[argc] = NULL; // argv must be NULL terminated.
return argc;
// As we are the native side of an Android app, we don't have any 'console', so
// gtest's standard output goes nowhere.
// Instead, we inject an "EventListener" in gtest and then we print the results
// using LOG, which goes to adb logcat.
class AndroidLogPrinter : public ::testing::EmptyTestEventListener {
void Init(int* argc, char** argv);
// EmptyTestEventListener
virtual void OnTestProgramStart(
const ::testing::UnitTest& unit_test) OVERRIDE;
virtual void OnTestStart(const ::testing::TestInfo& test_info) OVERRIDE;
virtual void OnTestPartResult(
const ::testing::TestPartResult& test_part_result) OVERRIDE;
virtual void OnTestEnd(const ::testing::TestInfo& test_info) OVERRIDE;
virtual void OnTestProgramEnd(const ::testing::UnitTest& unit_test) OVERRIDE;
void AndroidLogPrinter::Init(int* argc, char** argv) {
// InitGoogleTest must be called befure we add ourselves as a listener.
::testing::InitGoogleTest(argc, argv);
::testing::TestEventListeners& listeners =
// Adds a listener to the end. Google Test takes the ownership.
void AndroidLogPrinter::OnTestProgramStart(
const ::testing::UnitTest& unit_test) {
std::string msg = StringPrintf("[ START ] %d",
log_write(ANDROID_LOG_ERROR, msg.c_str());
void AndroidLogPrinter::OnTestStart(const ::testing::TestInfo& test_info) {
std::string msg = StringPrintf("[ RUN ] %s.%s",
log_write(ANDROID_LOG_ERROR, msg.c_str());
void AndroidLogPrinter::OnTestPartResult(
const ::testing::TestPartResult& test_part_result) {
std::string msg = StringPrintf(
"%s in %s:%d\n%s\n",
test_part_result.failed() ? "*** Failure" : "Success",
log_write(ANDROID_LOG_ERROR, msg.c_str());
void AndroidLogPrinter::OnTestEnd(const ::testing::TestInfo& test_info) {
std::string msg = StringPrintf("%s %s.%s",
test_info.result()->Failed() ? "[ FAILED ]" : "[ OK ]",
log_write(ANDROID_LOG_ERROR, msg.c_str());
void AndroidLogPrinter::OnTestProgramEnd(
const ::testing::UnitTest& unit_test) {
std::string msg = StringPrintf("[ END ] %d",
log_write(ANDROID_LOG_ERROR, msg.c_str());
} // namespace
// This method is called on a separate java thread so that we won't trigger
// an ANR.
static void RunTests(JNIEnv* env,
jobject obj,
jstring jfiles_dir,
jobject app_context) {
#if !defined(__LB_ANDROID__)
// Our MainHook creates this.
base::AtExitManager exit_manager;
// Command line initialized basically, will be fully initialized later.
static const char* const kInitialArgv[] = { "ChromeTestActivity" };
CommandLine::Init(arraysize(kInitialArgv), kInitialArgv);
// Set the application context in base.
base::android::ScopedJavaLocalRef<jobject> scoped_context(
env, env->NewLocalRef(app_context));
FilePath files_dir(base::android::ConvertJavaStringToUTF8(env, jfiles_dir));
// A few options, such "--gtest_list_tests", will just use printf directly
// and won't use the "AndroidLogPrinter". Redirect stdout to a known file.
FilePath stdout_path(files_dir.Append(FilePath("stdout.txt")));
freopen(stdout_path.value().c_str(), "w", stdout);
std::vector<std::string> args;
// We need to pass in a non-const char**.
std::vector<char*> argv;
int argc = ArgsToArgv(args, &argv);
// This object is owned by gtest.
AndroidLogPrinter* log = new AndroidLogPrinter();
log->Init(&argc, &argv[0]);
// Fully initialize command line with arguments.
CommandLine(argc, &argv[0]), false);
const CommandLine& command_line = *CommandLine::ForCurrentProcess();
if (command_line.HasSwitch(switches::kWaitForDebugger)) {
std::string msg = StringPrintf("Native test waiting for GDB because "
"flag %s was supplied",
log_write(ANDROID_LOG_VERBOSE, msg.c_str());
base::debug::WaitForDebugger(24 * 60 * 60, false);
main(argc, &argv[0]);
// This is called by the VM when the shared library is first loaded.
JNI_EXPORT jint JNI_OnLoad(JavaVM* vm, void* reserved) {
// Install signal handlers to detect crashes.
JNIEnv* env = base::android::AttachCurrentThread();
if (!RegisterNativesImpl(env)) {
return -1;
return JNI_VERSION_1_4;