constants.py revision a1401311d1ab56c4ed0a474bd38c108f75cb0cd9 
1# Copyright (c) 2012 The Chromium Authors. All rights reserved.
2# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
5"""Defines a set of constants shared by test runners and other scripts."""
6# pylint: disable=W0212
7
8import collections
9import logging
10import os
11import subprocess
12
13
14DIR_SOURCE_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__),
15                                               os.pardir, os.pardir, os.pardir))
16ISOLATE_DEPS_DIR = os.path.join(DIR_SOURCE_ROOT, 'isolate_deps_dir')
17
18CHROME_SHELL_HOST_DRIVEN_DIR = os.path.join(
19    DIR_SOURCE_ROOT, 'chrome', 'android')
20
21
22PackageInfo = collections.namedtuple('PackageInfo',
23    ['package', 'activity', 'cmdline_file', 'devtools_socket',
24     'test_package'])
25
26PACKAGE_INFO = {
27    'chrome': PackageInfo(
28        'com.google.android.apps.chrome',
29        'com.google.android.apps.chrome.Main',
30        '/data/local/chrome-command-line',
31        'chrome_devtools_remote',
32        'com.google.android.apps.chrome.tests'),
33    'chrome_beta': PackageInfo(
34        'com.chrome.beta',
35        'com.google.android.apps.chrome.Main',
36        '/data/local/chrome-command-line',
37        'chrome_devtools_remote',
38        None),
39    'chrome_stable': PackageInfo(
40        'com.android.chrome',
41        'com.google.android.apps.chrome.Main',
42        '/data/local/chrome-command-line',
43        'chrome_devtools_remote',
44        None),
45    'chrome_dev': PackageInfo(
46        'com.google.android.apps.chrome_dev',
47        'com.google.android.apps.chrome.Main',
48        '/data/local/chrome-command-line',
49        'chrome_devtools_remote',
50        None),
51    'legacy_browser': PackageInfo(
52        'com.google.android.browser',
53        'com.android.browser.BrowserActivity',
54        None,
55        None,
56        None),
57    'content_shell': PackageInfo(
58        'org.chromium.content_shell_apk',
59        'org.chromium.content_shell_apk.ContentShellActivity',
60        '/data/local/tmp/content-shell-command-line',
61        None,
62        'org.chromium.content_shell_apk.tests'),
63    'chrome_shell': PackageInfo(
64        'org.chromium.chrome.shell',
65        'org.chromium.chrome.shell.ChromeShellActivity',
66        '/data/local/tmp/chrome-shell-command-line',
67        'chrome_shell_devtools_remote',
68        'org.chromium.chrome.shell.tests'),
69    'android_webview_shell': PackageInfo(
70        'org.chromium.android_webview.shell',
71        'org.chromium.android_webview.shell.AwShellActivity',
72        None,
73        None,
74        'org.chromium.android_webview.test'),
75    'gtest': PackageInfo(
76        'org.chromium.native_test',
77        'org.chromium.native_test.ChromeNativeTestActivity',
78        '/data/local/tmp/chrome-native-tests-command-line',
79        None,
80        None),
81    'content_browsertests': PackageInfo(
82        'org.chromium.content_browsertests_apk',
83        'org.chromium.content_browsertests_apk.ContentBrowserTestsActivity',
84        '/data/local/tmp/content-browser-tests-command-line',
85        None,
86        None),
87    'chromedriver_webview_shell': PackageInfo(
88        'org.chromium.chromedriver_webview_shell',
89        'org.chromium.chromedriver_webview_shell.Main',
90        None,
91        None,
92        None),
93}
94
95
96# Ports arrangement for various test servers used in Chrome for Android.
97# Lighttpd server will attempt to use 9000 as default port, if unavailable it
98# will find a free port from 8001 - 8999.
99LIGHTTPD_DEFAULT_PORT = 9000
100LIGHTTPD_RANDOM_PORT_FIRST = 8001
101LIGHTTPD_RANDOM_PORT_LAST = 8999
102TEST_SYNC_SERVER_PORT = 9031
103TEST_SEARCH_BY_IMAGE_SERVER_PORT = 9041
104
105# The net test server is started from port 10201.
106# TODO(pliard): http://crbug.com/239014. Remove this dirty workaround once
107# http://crbug.com/239014 is fixed properly.
108TEST_SERVER_PORT_FIRST = 10201
109TEST_SERVER_PORT_LAST = 30000
110# A file to record next valid port of test server.
111TEST_SERVER_PORT_FILE = '/tmp/test_server_port'
112TEST_SERVER_PORT_LOCKFILE = '/tmp/test_server_port.lock'
113
114TEST_EXECUTABLE_DIR = '/data/local/tmp'
115# Directories for common java libraries for SDK build.
116# These constants are defined in build/android/ant/common.xml
117SDK_BUILD_JAVALIB_DIR = 'lib.java'
118SDK_BUILD_TEST_JAVALIB_DIR = 'test.lib.java'
119SDK_BUILD_APKS_DIR = 'apks'
120
121PERF_OUTPUT_DIR = os.path.join(DIR_SOURCE_ROOT, 'out', 'step_results')
122# The directory on the device where perf test output gets saved to.
123DEVICE_PERF_OUTPUT_DIR = (
124    '/data/data/' + PACKAGE_INFO['chrome'].package + '/files')
125
126SCREENSHOTS_DIR = os.path.join(DIR_SOURCE_ROOT, 'out_screenshots')
127
128ANDROID_SDK_VERSION = 19
129ANDROID_SDK_BUILD_TOOLS_VERSION = '19.0.0'
130ANDROID_SDK_ROOT = os.path.join(DIR_SOURCE_ROOT,
131                                'third_party/android_tools/sdk')
132ANDROID_SDK_TOOLS = os.path.join(ANDROID_SDK_ROOT,
133                                 'build-tools', ANDROID_SDK_BUILD_TOOLS_VERSION)
134ANDROID_NDK_ROOT = os.path.join(DIR_SOURCE_ROOT,
135                                'third_party/android_tools/ndk')
136
137EMULATOR_SDK_ROOT = os.environ.get('ANDROID_EMULATOR_SDK_ROOT',
138                                   os.path.join(DIR_SOURCE_ROOT,
139                                                'android_emulator_sdk'))
140
141BAD_DEVICES_JSON = os.path.join(DIR_SOURCE_ROOT,
142                                os.environ.get('CHROMIUM_OUT_DIR', 'out'),
143                                'bad_devices.json')
144
145UPSTREAM_FLAKINESS_SERVER = 'test-results.appspot.com'
146
147
148def GetBuildType():
149  try:
150    return os.environ['BUILDTYPE']
151  except KeyError:
152    raise Exception('The BUILDTYPE environment variable has not been set')
153
154
155def SetBuildType(build_type):
156  os.environ['BUILDTYPE'] = build_type
157
158
159def GetOutDirectory(build_type=None):
160  """Returns the out directory where the output binaries are built.
161
162  Args:
163    build_type: Build type, generally 'Debug' or 'Release'. Defaults to the
164      globally set build type environment variable BUILDTYPE.
165  """
166  return os.path.abspath(os.path.join(
167      DIR_SOURCE_ROOT, os.environ.get('CHROMIUM_OUT_DIR', 'out'),
168      GetBuildType() if build_type is None else build_type))
169
170
171def _Memoize(func):
172  def Wrapper():
173    try:
174      return func._result
175    except AttributeError:
176      func._result = func()
177      return func._result
178  return Wrapper
179
180
181@_Memoize
182def GetAdbPath():
183  if os.environ.get('ANDROID_SDK_ROOT'):
184    return 'adb'
185  # If envsetup.sh hasn't been sourced and there's no adb in the path,
186  # set it here.
187  try:
188    with file(os.devnull, 'w') as devnull:
189      subprocess.call(['adb', 'version'], stdout=devnull, stderr=devnull)
190    return 'adb'
191  except OSError:
192    logging.debug('No adb found in $PATH, fallback to checked in binary.')
193    return os.path.join(ANDROID_SDK_ROOT, 'platform-tools', 'adb')
194
195
196# Exit codes
197ERROR_EXIT_CODE = 1
198WARNING_EXIT_CODE = 88
199