Firefox for Amazon's Fire TV
Clone or download
mcomella Closes #1280 - review: Move getAssembleReleaseTasks to TaskContainer …
…ext fn.

It isn't the Task's responsibility to figure out what a release task is.
Latest commit a9e9261 Oct 19, 2018
Permalink
Failed to load latest commit information.
.github Closes #1291: Add Pull Request template. Oct 15, 2018
app Issue #1280: Add license header to gradle files. Oct 19, 2018
buildSrc Closes #1280 - review: Move getAssembleReleaseTasks to TaskContainer … Oct 19, 2018
docs Closes #1289: Add telemetry docs in-tree. Oct 12, 2018
gradle/wrapper Issue #1260: Update gradle to latest version. Oct 9, 2018
quality Closes #1260: update detekt to latest version. Oct 9, 2018
shavar-prod-lists Import raw tracking-protection lists Dec 20, 2016
tools Issue #883: Update Android SDK and support libraries to version 27. Jul 12, 2018
.android2po Fixes #445 - Updates tooling to point to Firefox TV l10n repo Feb 15, 2018
.gitignore Closes #764: Add Pocket keys to build. Apr 13, 2018
.taskcluster.yml Closes #1280: Add -PisPullRequest flag to disable certain checks for … Oct 19, 2018
.travis.yml Issue #1280: Only assembleDebug on travis. Oct 19, 2018
CHANGELOG.md Closes #1224: Fixes bug when backing from fullscreen Oct 18, 2018
CONTRIBUTING.md No issue: point CONTRIBUTING at shared docs. Jul 31, 2018
LICENSE Initial commit Dec 9, 2016
README.md Issue #1280: Change no-validate arg to noValidate. Oct 19, 2018
Screengrabfile UITest fixes and test cleanup Sep 20, 2018
Screengrabfile.template Closes #425: Update hard-coded build dir paths. Mar 15, 2018
build.gradle Issue #1280: Add license header to gradle files. Oct 19, 2018
codecov.yml Issue #1008: Enable patch check in codecov. Sep 17, 2018
download-build-run-locale-screenshots.sh Adds a download/fetch/build/screenshot bash script Apr 20, 2018
gradle.properties Setting up Fastlane Screenshots with initial test Feb 28, 2018
gradlew Issue #1260: Update gradle to latest version. Oct 9, 2018
gradlew.bat Issue #1260: Update gradle to latest version. Oct 9, 2018
settings.gradle Let's do this. #mozAloha Dec 9, 2016

README.md

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

  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:assembledebug
  1. Make sure to select the right build variant in Android Studio: debug

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>

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 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.

Testing

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

./gradlew testDebug

To generate code coverage reports, run:

./gradlew -Pcoverage jacocoDebugTestReport

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

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

Building release builds

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

./gradlew assembleRelease # 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 assembleRelease -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 DataUploadPreference.isEnabled 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

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/