Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 121 lines (83 sloc) 4.204 kb
df44529 Bob Clary Bug 1037067 - Improve initial setup and docs, r=gbrown, r=mcote.
bclary authored
1 # Installation Instructions
e3377ce Mark Côté README and installation instructions.
markrcote authored
2
3 There are three separate components in a complete autophone system:
4
5 - one or more servers running the autophone app
035f6af gbrownmozilla Bug 1037067: Update install instructions; r=mcote
gbrownmozilla authored
6 - mobile devices with root access
e3377ce Mark Côté README and installation instructions.
markrcote authored
7 - a server running phonedash to collect, serve, and present the results
8
df44529 Bob Clary Bug 1037067 - Improve initial setup and docs, r=gbrown, r=mcote.
bclary authored
9 Multiple autophone servers can run on the same machine. Until mozpool
10 support is added, each server runs independently with no knowledge of
11 the others and should be configured with individual device pools. If
12 running two or more instances from the same installation, you will
13 need to use the --port, --cache-dir, and --build-cache-port options on
14 all but the primary to avoid port and cache contentions.
e3377ce Mark Côté README and installation instructions.
markrcote authored
15
16 The phonedash server is optional, e.g. for development environments. It can
17 be found at https://github.com/markrcote/phonedash/. It is customized for
df44529 Bob Clary Bug 1037067 - Improve initial setup and docs, r=gbrown, r=mcote.
bclary authored
18 the s1s2 test and will be eventually deprecated in favour of Treeherder.
e3377ce Mark Côté README and installation instructions.
markrcote authored
19
20
df44529 Bob Clary Bug 1037067 - Improve initial setup and docs, r=gbrown, r=mcote.
bclary authored
21 ## Setting up autophone
e3377ce Mark Côté README and installation instructions.
markrcote authored
22
035f6af gbrownmozilla Bug 1037067: Update install instructions; r=mcote
gbrownmozilla authored
23 "pip install -r requirements.txt" will install all required packages.
e3377ce Mark Côté README and installation instructions.
markrcote authored
24
df44529 Bob Clary Bug 1037067 - Improve initial setup and docs, r=gbrown, r=mcote.
bclary authored
25 Autophone is packaged with four tests: smoketest, S1S2Test,
26 WebappStartupTest and unittests.
5d632fe Bob Clary Bug 785129 - Create Autophone tests to run unit tests, r=mcote.
bclary authored
27
df44529 Bob Clary Bug 1037067 - Improve initial setup and docs, r=gbrown, r=mcote.
bclary authored
28 ## Smoketest
29
30 Smoketest is used to test if Fennec is able to run on devices and report
31 its Throbber values to logcat.
32
33 ## S1S2Test
34
35 S1S2Test measures fennec load times for web pages,
5d632fe Bob Clary Bug 785129 - Create Autophone tests to run unit tests, r=mcote.
bclary authored
36 served both remotely and from a local file.
e3377ce Mark Côté README and installation instructions.
markrcote authored
37
73b6a9e Bob Clary Bug 1074454 - Autophone - check test files into git repos, r=mcote.
bclary authored
38 The pages to be served are located in autophone/files/base/ and
39 autophone/files/s1s2/. The twitter test pages are retrieved from
40 https://git.mozilla.org/?p=automation/ep1.git;a=summary and placed in
41 autophone/files/ep1/twitter.com via
42
df44529 Bob Clary Bug 1037067 - Improve initial setup and docs, r=gbrown, r=mcote.
bclary authored
43 git submodule update --init --remote
73b6a9e Bob Clary Bug 1074454 - Autophone - check test files into git repos, r=mcote.
bclary authored
44
45 You will need a way to serve them (FIXME: autophone should do
46 this). If you're using phonedash, it can serve the files by just
47 dropping them into phonedash/html/.
e3377ce Mark Côté README and installation instructions.
markrcote authored
48
035f6af gbrownmozilla Bug 1037067: Update install instructions; r=mcote
gbrownmozilla authored
49 The s1s2 test is configured in the file configs/s1s2_settings.ini -- copy
50 configs/s1s2_settings.ini.example and customize as needed.
e3377ce Mark Côté README and installation instructions.
markrcote authored
51
df44529 Bob Clary Bug 1037067 - Improve initial setup and docs, r=gbrown, r=mcote.
bclary authored
52 ## Unittests
5d632fe Bob Clary Bug 785129 - Create Autophone tests to run unit tests, r=mcote.
bclary authored
53
df44529 Bob Clary Bug 1037067 - Improve initial setup and docs, r=gbrown, r=mcote.
bclary authored
54 To be updated as part of
55 [Bug 1079923 - Autophone - update unittests to fix bitrot](https://bugzilla.mozilla.org/show_bug.cgi?id=1079923).
56
5d632fe Bob Clary Bug 785129 - Create Autophone tests to run unit tests, r=mcote.
bclary authored
57 The unittests also require a local installation of the XRE and the utility
58 programs such as xpcshell. A local build of Firefox can be used.
59
60 In order to process crash minidumps, you will also need a local
61 installation of breakpad's minidump_stackwalk. You can build
62 minidump_stack via:
63
df44529 Bob Clary Bug 1037067 - Improve initial setup and docs, r=gbrown, r=mcote.
bclary authored
64 svn checkout http://google-breakpad.googlecode.com/svn/trunk/ google-breakpad-read-only
65 cd google-breakpad-read-only
66 if [[ $(uname) == "Darwin" ]]; then
67 CC=clang CXX=clang++ ./configure
68 else
69 CXXFLAGS="-g -O1" ./configure
70 fi
71 make
72 sudo make install
5d632fe Bob Clary Bug 785129 - Create Autophone tests to run unit tests, r=mcote.
bclary authored
73
74 Once you have the XRE, utility programs and minidump_stack installed, change
75 configs/unittest_default.ini to point to your local environment.
c66279b Mark Côté Usage instructions, documented email settings.
markrcote authored
76
47d8f3d William Lachance Bug 780268 - Convert INSTALL and USAGE to proper markdown;r=mcote
wlach authored
77 ### Setting up devices ###
e3377ce Mark Côté README and installation instructions.
markrcote authored
78
df44529 Bob Clary Bug 1037067 - Improve initial setup and docs, r=gbrown, r=mcote.
bclary authored
79 Each device must be rooted and reachable by adb. At a minimum, each
80 device should have USB Debugging and Unknown sources enabled.
81
82 Check that "adb devices" shows each desired device.
e3377ce Mark Côté README and installation instructions.
markrcote authored
83
c038c1b gbrownmozilla Bug 1078645: Update docs for using an emulator; r=bc
gbrownmozilla authored
84 ### Using an emulator ###
85
86 If desired, the Android emulator can be used in place of a physical device.
87
88 Set up an emulator AVD and verify that Firefox for Android can be run in
89 the resulting emulator instance.
90
91 These emulator device settings are recommended:
92 - Target: API Level 15 or greater
93 - RAM: 2048
94 - Internal Storage: 200 MiB
95 - SD Card: Size: 200 MiB
96 - Use Host GPU
97
98 Be sure to select "Use Host GPU". A modern host computer and graphics card
99 may be required.
100
101 Also verify that the emulator can be reached by adb. Check the output of
102 "adb devices" and enter the emulator name as the serialno in devices.ini:
103
104 [test-emulator]
105 serialno=emulator-5554
106
107 The Android emulator normally reports a battery charge of 50%. With default
108 settings, autophone will wait indefinitely for the battery to charge. To
109 avoid this, edit autophone.ini and change device_battery_min to be less
110 than the emulator battery charge (eg. device_battery_min=40).
111
112 Also be aware that instead of rebooting the device, autophone will kill
113 and restart the emulator.
114
47d8f3d William Lachance Bug 780268 - Convert INSTALL and USAGE to proper markdown;r=mcote
wlach authored
115 ### Setting up phonedash ###
e3377ce Mark Côté README and installation instructions.
markrcote authored
116
035f6af gbrownmozilla Bug 1037067: Update install instructions; r=mcote
gbrownmozilla authored
117 Set up Phonedash following the instructions at
118 https://github.com/markrcote/phonedash.
e3377ce Mark Côté README and installation instructions.
markrcote authored
119
df44529 Bob Clary Bug 1037067 - Improve initial setup and docs, r=gbrown, r=mcote.
bclary authored
120 Now you are ready to use autophone -- see [USAGE.md](USAGE.md) to get started.
Something went wrong with that request. Please try again.