node-firefox-install-app

Install an app on a runtime.

This is part of the node-firefox project.

NOTE

This is a work in progress. Things will probably be missing and broken while we move from fxos-deploy to node-firefox-install-app. Please have a look at the existing issues, and/or file more if you find any! :-)

Installation

From git

git clone https://github.com/mozilla/node-firefox-install-app.git
cd node-firefox-install-app
npm install

If you want to update later on:

cd node-firefox-install-app
git pull origin master
npm install

npm

This module is not on npm yet.

Usage

installApp(options) // returns a Promise

where options is a plain Object which must contain the following:

• appPath: path to the app folder
• client: the remote client where we want to install this app

If no options are provided, or if options is an empty Object ({}), then installApp will fail (how can you install you don't know what app exactly in you don't know where?)

Installing a packaged app on a simulator

This is done by passing the path to the app folder:

var startSimulator = require('node-firefox-start-simulator');
var connect = require('node-firefox-connect');
var installApp = require('node-firefox-install-app');

startSimulator().then(function(simulator) {
  connect(simulator.port).then(function(client) {
    installApp({
      appPath: appPath,
      client: client
    }).then(function(appId) {
      console.log('App was installed with appId = ', appId);
    }, function(error) {
      console.error('App could not be installed: ', error);
    });
  });
});

You can have a look at the examples folder for a complete example.

Running the tests

After installing, you can simply run the following from the module folder:

npm test

To add a new unit test file, create a new file in the tests/unit folder. Any file that matches test.*.js will be run as a test by the appropriate test runner, based on the folder location.

We use gulp behind the scenes to run the test; if you don't have it installed globally you can use npm gulp from inside the project's root folder to run gulp.

Code quality and style

Because we have multiple contributors working on our projects, we value consistent code styles. It makes it easier to read code written by many people! :-)

Our tests include unit tests as well as code quality ("linting") tests that make sure our test pass a style guide and JSHint. Instead of submitting code with the wrong indentation or a different style, run the tests and you will be told where your code quality/style differs from ours and instructions on how to fix it.

History

This is based on initial work on fxos-deploy by Nicola Greco.

License

This program is free software; it is distributed under an Apache License.

Copyright

Copyright (c) 2015 Mozilla (Contributors).