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
Latest commit e3eccb4 May 25, 2016 @danhuang1202 danhuang1202 Merge pull request #34337 from danhuang1202/bug1267159_spatial_naviga…
…tion_in_browser

Bug 1267159 - Add spatial navagation support in browser . r=lchang
Failed to load latest commit information.
apps Bug 1267134 - Corresponding changes to align the new architecture of … Apr 28, 2016
bin Bug 1222215 - Relanding disabling the retry logic since reverting thi… Jan 8, 2016
build Bug 1274457 - Change Syncto server URL to production one. May 24, 2016
customization Bug 1184342 - Part II, Remove keyboard_layouts.json generation from t… Feb 1, 2016
dev_apps Bug 1257905 - Use standalone mozIntl Apr 4, 2016
distros Bug 1227980 - Merge the callscreen into the dialer r=thills,etienne,r… Feb 1, 2016
hosted_apps Bug 1196992 - Bump remotely hosted apps Oct 28, 2015
locales Bug 1222204 - Add Persian (fa) to master and 2.5 builds, r=stas Nov 12, 2015
shared Bug 1254039 - [TV][Home] Move rename, rearrange, and delete from edit… Apr 27, 2016
test_media Bug 1214222 - Fix the dialer reference workloads. r=jhylands Nov 10, 2015
tests NOBUG - Do not install radicale. Calendar tests for CalDAV not suppor… Mar 18, 2016
tools Bug 1131503 - Running csslint.js on node.js Feb 22, 2016
tv_apps Bug 1267159 - Add spatial navagation support in browser . r=lchang May 25, 2016
.editorconfig Bug 1155979 - Ensure Makefile can be indent with tabs Apr 18, 2015
.eslintrc Bug 1218725 - Add no-wildcard-postmessage plugin to eslint r=julienw Nov 27, 2015
.gitignore Bug 1184342 - Part II, Remove keyboard_layouts.json generation from t… Feb 1, 2016
.jsdocrc Bug 1015013 - JSDoc 3 parse error getter/setter with the same name in… May 23, 2014
.jshintignore Bug 1240740 - Running all app's build.js on node.js Jan 27, 2016
.jshintrc Bug 987282 - JSHint allow getter without setter globally r=julienw Mar 24, 2014
Android.mk Revert "Bug 832165 - Fix using GAIA_PATH to build r=me" Mar 21, 2016
CONTRIBUTING.md Bug 1055914 - Fix/update three links in contributing guide R=julien Mar 26, 2015
LICENSE XXX - Update license to 2015 r=self Jun 7, 2015
Makefile NOBUG - Do not install radicale. Calendar tests for CalDAV not suppor… Mar 18, 2016
README.md Bug 1229635 - use make test-integration command for integration test,… Dec 24, 2015
autolander.json Bug 1189176 - [Autolander] Update tasks for recent changes r=kgrandon Jul 29, 2015
gaia.mk Revert "Revert "Bug 1059051 - Convert Keyboard-Symbols.woff to Keyboa… Aug 27, 2014
gaia_node_modules.revision bug 1159667 - add eslint to tests r=julienw Jun 4, 2015
gulpfile.js Bug 1223651 - jsdoc with better es6 support, r=ricky Nov 11, 2015
package.json Merge pull request #34073 from rickychien/bug-955989 Feb 22, 2016
taskgraph.json Bug 1270625 - Add extend task graph scope to decision task May 5, 2016

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.