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
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:
#fxos on irc.mozilla.org
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.
Autolander is a bot which integrates github and bugzilla workflows.
Features available: - Automatic pull request to bugzilla attachment linking. - Automatic landing, on green integration run, with a R+ from a suggested reviewer and the autoland keyword. - Comments in the bug with the landed commit, and marks the bug as fixed. - Validates pull request title and commit message formats. - Currently only runs a subset of the gaia CI tests which are stable on taskcluster. Ensure you have a green gaia-try run before adding the autoland keyword. - See more at: https://github.com/mozilla/autolander The Autolander guide on MDN
Unit tests for an app go in
To run all the unit tests with B2G Desktop:
make test-agent-server &
make test-agent-test 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:
make test-agent-server &
Note: If you add new files, you will need to restart test-agent-server.
As a convenience, you can also use the
gaia-testscript to launch the test-agent-server and open the Test Agent app in firefox:
$FIREFOXto your preferred firefox/aurora/nightly binary.
./bin/gaia-testto run the test-agent-server and launch firefox.
make test-agent-testor modify files as described above.
For more details on writing tests, see: https://developer.mozilla.org/en/Mozilla/BoottoGecko/GaiaUnitTests
Gaia uses marionette-js-runner for ui testing. Tests need to live in
apps//test/marionetteand should be named
*_test.js. Gaia's marionette tests run on nodejs and you'll need nodejs>=v0.12 and npm>=v2.0 installed.
Shared code for tests lives in plugins at
tests/jsmarionette/pluginsor in helpers at
For more details on writing integration tests, see: https://developer.mozilla.org/en-US/docs/Mozilla/FirefoxOS/Automatedtesting/Gaiaintegrationtests
APP= make test-integration
TEST_FILES="/abs/path/to/some_test.js /abs/path/to/other_test.js" make test-integration
You can run tests on device by plugging in your phone and adding the BUILDAPP=device to the make command:
sh BUILDAPP=device make test-integration
VERBOSE=1pipes gecko logs to your command line process for debugging.
Build system has its own unit test and integration test. Both are running on Node.js
To run unit test locally, using following command:
$ make build-test-unit
To run integration test locally, using following command:
$ make build-test-integration
Both the build unit or integration test can invoke specific test files by TEST_FILES
make build-test-unit TEST_FILES=
make build-test-integration TEST_FILES=
For example, we could run the
keyboard_test.jsbuild integration test in keyboard app with the below command.
make build-test-integration TEST_FILES=apps/keyboard/test/build/integration/keyboard_test.js
If you would like to run more than one test, we could do the below command.
make build-test-integration TEST_FILES="apps/keyboard/test/build/integration/keyboard_test.js apps/keyboard/test/build/integration/keyboard_layout_test.js"
To generate API reference locally, run
make docscommand to generate docs. The generated per app API docs will be located in
You could generate single app doc with this:
$ gulp jsdoc:system