Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Gaia is a HTML5-based Phone UI for the Boot 2 Gecko Project. NOTE: For details of what branches are used for what releases, see
JavaScript CSS Python Shell Frege C
Branch: master
Pull request Compare This branch is 10353 commits behind mozilla-b2g:master.

Merge pull request #24308 from nullaus/bug1062136

bug 1062136 - getScreenshot should check for frontWindow. r=alive
latest commit ec32f3e5f2
@nullaus nullaus authored
Failed to load latest commit information.
apps Merge pull request #24308 from nullaus/bug1062136
bin Bug 1045330 - Go to virtual environment with correct path
build Merge pull request #24051 from gmarty/Bug-1057977-Status-Bar-Remove-A…
customization Bug 1067639 - Single variant keyboard customization fails to set the …
dev_apps Bug 1035133 - [TestAgent] Check that the TestAgent object is here and…
locales Bug 1048411 - Remove GAIA_INLINE_LOCALES optimization. r=stas
shared Bug 1037868 - Create gaia-sim-picker component. r=kgrandon, r=Rik
test_media Bug 1038261 - Fix to handle both sdcard and sdcard0
tools Bug 1069415 - Since bug 1002545 landed, we can't commit CSS files und…
.gitignore Bug 1002545 - Switching to b2g desktop builds
.jsdocrc Bug 1015013 - JSDoc 3 parse error getter/setter with the same name in…
.jshintignore Merge pull request #24268 from sudheesh001/Patch_1061516
.jshintrc Bug 987282 - JSHint allow getter without setter globally r=julienw
.travis.yml Stop messaging #gaia Bug 1022728 - Create a pref only build target Bug 876601 - update and
Gruntfile.js Bug 956634 - [jsdoc] Enable generate all apps/ jsdoc
LICENSE Bug 929926 - LICENCE is mis-spelled
Makefile Merge pull request #24159 from RickyChien/bug-1050709 Bug 1038439 - Remove web components preference from Gaia. r=vingtetun Revert "Revert "Bug 1059051 - Convert Keyboard-Symbols.woff to Keyboa…
gaia_node_modules.revision Bug 1043408 - Use marionette-apps version 0.3.9
package.json Bug 1043408 - Use marionette-apps version 0.3.9
taskgraph.json NO BUG - taskgraph image update r=me
travisaction.opts Bug 917044 - Run gjslint, unit tests and integration tests in parallel

Gaia Build Status

Gaia is Mozilla's Phone UX for the Boot to Gecko (B2G) project.

Boot to Gecko aims to create a complete, standalone operating system for the open web.

You can read more about B2G here:

follow us on twitter: @Boot2Gecko

join the Gaia mailing list:

and talk to us on IRC:

#gaia on

Hacking Gaia

The Gaia/Hacking page on MDN has all the information that you need to start working on Gaia, including building and running Gaia on a compatible device or desktop computer.

Shepherd (bot)

Opt-into new features by adding +shepherd to your first commit.

Features available:

  • automatic github -> bugzilla linking


Unit Tests

Unit tests for an app go in apps/<APP>/test/unit/.

To run all the unit tests with B2G Desktop:

  1. Run DEBUG=1 make
  2. Run make test-agent-server &
  3. Run B2G Desktop and open the Test Agent app
  4. Run make test-agent-test

    or make test-agent-test APP=<APP> to run unit tests for a specific app

More importantly, you can use test-agent-server to watch the files on the filesystem and execute relevant tests when they change:

  1. Run DEBUG=1 make
  2. Run make test-agent-server &
  3. Run B2G Desktop and open the Test Agent app
  4. Edit files and when you save them, glance at the console with test-agent-server running

Note: If you add new files, you will need to restart test-agent-server.

As a convenience, you can also use the gaia-test script to launch the test-agent-server and open the Test Agent app in firefox:

  1. Add firefox to your $PATH or set $FIREFOX to your preferred firefox/aurora/nightly binary.
  2. Run ./bin/gaia-test to run the test-agent-server and launch firefox.
  3. Run make test-agent-test or modify files as described above.

For more details on writing tests, see:

Integration Tests

Gaia uses marionette-js-runner to run the tests with a custom builder for gaia. Tests should live with the rest of your apps code (in apps/my_app/test/marionette) and test files should end in _test.js.

All integration tests run under a node environment. You need node >= 0.10 for this to work predictably.

Shared code for tests lives under shared/test/integration.

Running integration tests

NOTE: unless your tests end in _test.js they will not be automatically picked up by make test-integration.

make test-integration

Invoking a test file

make test-integration TEST_FILES=<test>

For example, we could run the day_view_test.js test in calendar app with the below command.

make test-integration TEST_FILES=apps/calendar/test/marionette/day_view_test.js

If you would like to run more than one test, we could do the below command.

make test-integration TEST_FILES="apps/calendar/test/marionette/day_view_test.js apps/calendar/test/marionette/today_test.js"

Invoking tests for a specific app

make test-integration APP=<APP>

For example, we could run all tests for the calendar app with make test-integration APP=calendar.

Skipping a test file

make test-integration SKIP_TEST_FILES=<test>

For example, we could skip the day_view_test.js test in calendar app with the below command.

make test-integration SKIP_TEST_FILES=apps/calendar/test/marionette/day_view_test.js

If you would like to skip more than one test, we could do the below command.

make test-integration SKIP_TEST_FILES="apps/calendar/test/marionette/day_view_test.js apps/calendar/test/marionette/today_test.js"

Notice that we could not use the TEST_FILES and SKIP_TEST_FILES parameters at the same time.

Running tests while working

If you wish to run many tests in background you might not want to be disturbed by the b2g-desktop window popping everytime, or the sound. One solution for the first issue is to use Xvfb:

xvfb-run make test-integration

If you are using PulseAudio and want to keep the tests quied, then just force an invalid server:

PULSE_SERVER=":" make test-integration

You can of course combine both:

PULSE_SERVER=":" xvfb-run make test-integration

Running tests without building profile

if you would like to run tests without building profile, use make test-integration-test:

PROFILE_FOLDER=profile-test make # generate profile directory in first time
make test-integration-test

Debugging Tests

To view log out from a test

make test-integration VERBOSE=1

Running tests in OOP mode

To run tests in OOP mode

make test-integration OOP=1

Where to find documentation


  • For performance reasons we don't run make profile for each test run this means you need to manually remove the profile-test folder when you make changes to your apps.

  • If you don't have a b2g folder one will be downloaded for you. This can be problematic if you're offline. You can symlink a b2g-desktop directory to b2g/ in gaia to avoid the download.

  • If you have some weird node errors, try removing node_modules since things may be stale.

  • To get debug information from the b2g desktop client, run this: DEBUG=b2g-desktop TEST_FILES=name/of/test.js ./bin/gaia-marionette

  • To get debug information from b2g desktop and all of the marionette plugins, run this: DEBUG=* TEST_FILES=name/of/test.js ./bin/gaia-marionette

UI Tests


See Gaia functional tests README


See how to run the Gaia endurance tests

Generate jsdoc

To generate API reference locally, you have to install grunt with following command:

$ npm -g grunt-cli

then run make docs command to generate docs. The generated API docs will be located in docs folder.

You could generate single app doc with this:

$ grunt jsdoc:system
Something went wrong with that request. Please try again.