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 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.
Opt-into new features by adding +shepherd to your first commit.
Features available:
- automatic github -> bugzilla linking
Unit tests for an app go in apps/<APP>/test/unit/.
To run all the unit tests with B2G Desktop:
-
Run
DEBUG=1 make -
Run
make test-agent-server & -
Run B2G Desktop and open the Test Agent app
-
Run
make test-agent-testor
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:
- Run
DEBUG=1 make - Run
make test-agent-server & - Run B2G Desktop and open the Test Agent app
- 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:
- Add firefox to your
$PATHor set$FIREFOXto your preferred firefox/aurora/nightly binary. - Run
./bin/gaia-testto run the test-agent-server and launch firefox. - Run
make test-agent-testor modify files as described above.
For more details on writing tests, see: https://developer.mozilla.org/en/Mozilla/Boot_to_Gecko/Gaia_Unit_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.8 for this to work predictably.
Shared code for tests lives under shared/test/integration.
./bin/gaia-marionette <test> [test...]All options are passed to ./node_modules/.bin/marionette-mocha so
you can also use mocha commands like --grep, --timeout see --help
for more options.
make test-integration APP=<APP>For example, we could run all tests for the calendar app with make test-integration APP=calendar.
NOTE: unless you tests end in _test.js they will not be
automatically picked up by make test-integration.
make test-integrationIf 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-integrationIf you are using PulseAudio and want to keep the tests quied, then just force an invalid server:
PULSE_SERVER=":" make test-integrationYou can of course combine both:
PULSE_SERVER=":" xvfb-run make test-integration-
For performance reasons we don't run
make profilefor each test run this means you need to manually remove theprofile-testfolder 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 ./bin/gaia-marionette name/of/test.js -
To get debug information from b2g desktop and all of the marionette plugins, run this:
DEBUG=* ./bin/gaia-marionette name/of/test.js
See Gaia functional tests README
See how to run the Gaia endurance tests
To generate API reference locally:
- run
npm installfirst to install required libraries (may need sudo privilege) - run
grunt docscommand to generate docs indocsfolder