blob: bd0e5654beabb0032fd3c836029da10bb4c6bf3d [file] [log] [blame]
// Copyright (c) 2011 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.
#include "net/test/python_utils.h"
#include "base/base_paths.h"
#include "base/command_line.h"
#include "base/environment.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/lazy_instance.h"
#include "base/logging.h"
#include "base/memory/scoped_ptr.h"
#include "base/path_service.h"
#include "base/process/launch.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
const char kPythonPathEnv[] = "PYTHONPATH";
void AppendToPythonPath(const base::FilePath& dir) {
scoped_ptr<base::Environment> env(base::Environment::Create());
std::string old_path;
std::string dir_path;
#if defined(OS_WIN)
dir_path = base::WideToUTF8(dir.value());
#elif defined(OS_POSIX)
dir_path = dir.value();
if (!env->GetVar(kPythonPathEnv, &old_path)) {
env->SetVar(kPythonPathEnv, dir_path.c_str());
} else if (old_path.find(dir_path) == std::string::npos) {
std::string new_path(old_path);
#if defined(OS_WIN)
#elif defined(OS_POSIX)
env->SetVar(kPythonPathEnv, new_path);
namespace {
#if defined(OS_MACOSX) || defined(OS_CHROMEOS)
// Search for |to_try|, rolling up the directory tree from
// |start_dir|. If found, return true and put the path to |to_try| in
// |out_dir|. If not, return false and leave |out_dir| untouched.
bool TryRelativeToDir(const base::FilePath& start_dir,
const base::FilePath& to_try,
base::FilePath* out_dir) {
base::FilePath dir(start_dir);
while (!base::DirectoryExists(dir.Append(to_try))) {
base::FilePath parent = dir.DirName();
if (parent == dir) {
// We hit the root directory.
return false;
dir = parent;
*out_dir = dir;
return true;
#endif // defined(OS_MACOSX) || defined(OS_CHROMEOS)
} // namespace
bool GetPyProtoPath(base::FilePath* dir) {
// Locate the Python code generated by the protocol buffers compiler.
base::FilePath generated_code_dir;
if (!PathService::Get(base::DIR_EXE, &generated_code_dir)) {
LOG(ERROR) << "Can't find " << generated_code_dir.value();
return false;
const base::FilePath kPyProto(FILE_PATH_LITERAL("pyproto"));
#if defined(OS_MACOSX) || defined(OS_CHROMEOS)
base::FilePath source_dir;
if (!PathService::Get(base::DIR_SOURCE_ROOT, &source_dir)) {
LOG(ERROR) << "Can't find " << source_dir.value();
return false;
// On Mac, and possibly Chrome OS, DIR_EXE might be pointing deep
// into the Release/ (or Debug/) directory and we can't depend on
// how far down it goes. So we walk upwards from DIR_EXE until we
// find a likely looking spot.
if (!TryRelativeToDir(generated_code_dir, kPyProto, dir)) {
LOG(WARNING) << "Can't find " << kPyProto.value()
<< " next to " << generated_code_dir.value();
// On Chrome OS, we may have installed the test binaries and support tools
// in a wholly separate location, relative to DIR_SOURCE_ROOT. We'll want
// to do a similar investigation from that point as well.
generated_code_dir = source_dir
if (!TryRelativeToDir(generated_code_dir, kPyProto, dir)) {
LOG(WARNING) << "Can't find " << kPyProto.value()
<< " next to " << generated_code_dir.value();
return false;
generated_code_dir = *dir;
*dir = generated_code_dir.Append(kPyProto);
VLOG(2) << "Found " << kPyProto.value() << " in " << dir->value();
return true;
#if defined(OS_WIN)
struct PythonExePath {
PythonExePath() {
// This is test-only code, so CHECK with a subprocess invocation is ok.
base::CommandLine command(base::FilePath(FILE_PATH_LITERAL("cmd")));
command.AppendArg("import sys; print sys.executable");
std::string output;
CHECK(GetAppOutput(command, &output));
// This does only work if cmd.exe doesn't use a non-US codepage.
path_ = base::ASCIIToUTF16(output);
TrimWhitespace(path_, base::TRIM_ALL, &path_);
base::string16 path_;
static base::LazyInstance<PythonExePath>::Leaky g_python_path;
bool GetPythonCommand(base::CommandLine* python_cmd) {
#if defined(OS_WIN)
// Most developers have depot_tools in their path, which only has a
// python.bat, not a python.exe. Go through cmd to find the path to
// the python executable.
// (Don't just return a a "cmd /c python" command line, because then tests
// that try to kill the python process will kill the cmd process instead,
// which can cause flakiness.)
// Launch python in unbuffered mode, so that python output doesn't mix with
// gtest output in buildbot log files. See
return true;