Skip to content
This repository has been archived by the owner on Apr 17, 2021. It is now read-only.

Latest commit

 

History

History
163 lines (124 loc) · 7.33 KB

README.md

File metadata and controls

163 lines (124 loc) · 7.33 KB
Raw

⚠️ Firefox has ended support for Amazon Fire TV. This app may continue to work, but it won’t receive security or other updates effective April 30, 2021. See also https://support.mozilla.org/en-US/kb/end-support-firefox-amazon-devices.

Firefox for Amazon's Fire TV

Task Status codecov

Fast for good, just right for watching video at home. A browser for discovering and watching web video on the big screen TV for users to install on their Amazon Fire TV and Fire TV stick.

Get it on Amazon Fire TV

Getting Involved

Our code is open source and we encourage all positive contributions! We love pull requests, bug reports, ideas, (security) code reviews and other kinds of contributions. Before you contribute, please read the Community Participation Guidelines.

Build instructions

Dependencies:

  • Java 8, not the latest version (for building via the command line)
  1. Clone the repository:
git clone https://github.com/mozilla-mobile/firefox-tv
  1. Import the project into Android Studio or build on the command line:
./gradlew clean app:assembleSystemDebug
  1. Make sure to select the right build variant in Android Studio: systemDebug

Running

It is recommended to test directly on a Fire TV: see the developer guide for more info. You can connect with:

adb connect <IP address>:5555

And then install via Android Studio or adb. Only a single development device can be connected to a Fire TV at a time. Note that while you can install on an Android TV emulator, the behavior (particularly WebView behavior) is different from Fire TV's and should not be relied upon.

If using an emulator, we recommend the Android TV device image: either 720p or 1080p is fine. API 22 (Stick) and 25 (4K) are best. You can press cmd + m to simulate a menu button press.

Unit Testing

To run a reasonable subset of the unit tests, we recommend:

./gradlew testSystemDebug

To generate code coverage reports, run:

./gradlew -Pcoverage jacocoDebugTestReport

Reports can be found at app/build/jacoco/jacoco<buildVariant>TestReport/html/index.html

UI Testing

To run all UI tests, follow these steps

  1. Connect to one device
  • Either use adb connect for a real device, or start an emulator instance using AVD
  • Prefer a real device (emulators will fail some tests)
  • The next step will fail if you are connected to more than one device
  1. Run ./gradlew connectedSystemDebugAndroidTest from the command line
  • Aliasing this command is recommended

Pre-push hooks

To reduce review turn-around time, we'd like all pushes to run tests locally. We'd recommend you use our provided pre-push hook in quality/pre-push-recommended.sh. Using this hook will guarantee your hook gets updated as the repository changes. This hook tries to run as much as possible without taking too much time.

To add it, run this command from the project root:

ln -s ../../quality/pre-push-recommended.sh .git/hooks/pre-push

To push without running the pre-push hook (e.g. doc updates):

git push <remote> --no-verify

Release process

(See this doc for a description of our release process)

Building release builds

Release builds can be built in Android Studio or via the command line:

./gradlew assembleSystemRelease # unsigned build

These builds will run validation checks that the build is ready for a production release. If you do not want to run these checks (e.g. building release builds for local debugging), you can add this argument:

./gradlew assembleSystemRelease -PnoValidate

API keys

Certain services require an API key, so you'll need to build with the key to use them in the apk.

  1. To build with the API key (for services such as Sentry), add a <project-dir>/.<service>_debug file with your key, for example, <project-dir>/.sentry_dsn_debug

    1. To enable Sentry on Debug builds, additionally replace the isEnabled value check in SentryIntegration value with true (upload is disabled by default in dev builds).

  2. Verify the key add was successful. The gradle output is the only way to verify this (although it won't indicate if the key is valid). You will see a message in the gradle output indicating the key was added:

Sentry DSN (debug): Added from /Users/mcomella/dev/moz/firefox-tv/.sentry_dsn_debug

As opposed to:

Sentry DSN (debug): X_X

API services currently supported are:

  • sentry_dsn
  • pocket_key
Amazon Device Messaging (ADM) API key

We suspect ADM access is only available in local builds for core team members because testing ADM requires access to a private API key that is connected to our app on the Amazon store dashboard.

To use ADM in debug builds, there must be a <project-dir>/app/src/main/assets/api_key.txt file that contains the api key. It is necessary that it is in the project's assets folder. Amazon will automatically provide an API key for production builds. See ADM integration doc for more details. If you're on the core team, we share debug keys: ask another developer for access.

License

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/