Skip to content
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 HTML CSS Python Java Makefile Other
Find file
Latest commit 65936e9 @zbraniecki zbraniecki Merge pull request #34058 from zbraniecki/1132219-fix-gu22-gu29
Bug 1132219 - Fix gaia tests bound function name tests. r=fabrice
Failed to load latest commit information.
apps Bug 1132219 - Fix gaia tests bound function name tests
bin Bug 1222215 - Relanding disabling the retry logic since reverting thi…
build Merge pull request #34009 from zbraniecki/1244629-migrate-remaining-m…
customization Bug 1213172 - Remove smart collections r=rickychien
dev_apps Bug 1240740 - Running all app's build.js on node.js
distros Bug 1227980 - Merge the callscreen into the dialer r=thills,etienne,r…
hosted_apps Bug 1196992 - Bump remotely hosted apps
locales Bug 1222204 - Add Persian (fa) to master and 2.5 builds, r=stas
shared Merge pull request #34029 from gabrielesvelto/bug-1218868-contacts-bu…
test_media Bug 1214222 - Fix the dialer reference workloads. r=jhylands
tests Merge pull request #33905 from andrenatal/promises_driver_patch_test
tools Bug 961643 - DEBUG comes from the environment r=ricky
tv_apps Merge pull request #32220 from zbraniecki/1209866-refactor-l10n-in-tv…
.editorconfig Bug 1155979 - Ensure Makefile can be indent with tabs
.eslintrc Bug 1218725 - Add no-wildcard-postmessage plugin to eslint r=julienw
.gitignore Bug 1219176 - Make it possible to dynamically preload external apps t…
.jsdocrc Bug 1015013 - JSDoc 3 parse error getter/setter with the same name in…
.jshintignore Bug 1240740 - Running all app's build.js on node.js
.jshintrc Bug 987282 - JSHint allow getter without setter globally r=julienw
Android.mk Revert "Bug 1146713 - export hardcoded gtk3 path in Android.mk"
CONTRIBUTING.md Bug 1055914 - Fix/update three links in contributing guide R=julien
LICENSE XXX - Update license to 2015 r=self
Makefile Merge pull request #33984 from scottwu/1131497-running-build-test-js-2
README.md Bug 1229635 - use make test-integration command for integration test,…
autolander.json Bug 1189176 - [Autolander] Update tasks for recent changes r=kgrandon
gaia.mk Revert "Revert "Bug 1059051 - Convert Keyboard-Symbols.woff to Keyboa…
gaia_node_modules.revision bug 1159667 - add eslint to tests r=julienw
gulpfile.js Bug 1223651 - jsdoc with better es6 support, r=ricky
package.json Bug 1232680 - Repair and reactivate call_log_test.js
taskgraph.json Bug 1175116 - Update to tester:0.4.5, set's MINIDUMP_STACKWALK env va…

README.md

Gaia

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:

http://mozilla.org/b2g

follow us on twitter: @Boot2Gecko

http://twitter.com/Boot2Gecko

join the Gaia mailing list:

http://groups.google.com/group/mozilla.dev.fxos

and talk to us on IRC:

#fxos on irc.mozilla.org

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.

Autolander (bot)

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

Tests

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: https://developer.mozilla.org/en/Mozilla/Boot_to_Gecko/Gaia_Unit_Tests

Integration Tests

Gaia uses marionette-js-runner for ui testing. Tests need to live in apps/<some app>/test/marionette and 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/plugins or in helpers at shared/test/integration.

For more details on writing integration tests, see: https://developer.mozilla.org/en-US/docs/Mozilla/Firefox_OS/Automated_testing/Gaia_integration_tests

Running integration tests

make test-integration

Invoking tests for a specific app

APP=<APP> make test-integration

Invoking specific test files

TEST_FILES="/abs/path/to/some_test.js /abs/path/to/other_test.js" make test-integration
Running tests on device

You can run tests on device by plugging in your phone and adding the BUILDAPP=device to the make command:

BUILDAPP=device make test-integration

More things

  • VERBOSE=1 pipes gecko logs to your command line process for debugging.

Build System Tests

Build system has its own unit test and integration test. Both are running on Node.js

Build System Unit Tests

To run unit test locally, using following command:

$ make build-test-unit

Build System Integration Tests

To run integration test locally, using following command:

$ make build-test-integration

Invoking specific test files

Both the build unit or integration test can invoke specific test files by TEST_FILES

make build-test-unit TEST_FILES=<test file path>
make build-test-integration TEST_FILES=<test file path>

For example, we could run the keyboard_test.js build 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"

Generate JSDOC

To generate API reference locally, run make docs command to generate docs. The generated per app API docs will be located in docs folder.

You could generate single app doc with this:

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