Gitiles
Code Review Sign In
gerrit-public.fairphone.software / vendor / fairphone / tools / 9aab239ed3196e1ebf7d3eb3a38610742fa89c4c
commit9aab239ed3196e1ebf7d3eb3a38610742fa89c4c[log] [tgz]
authorAndrew Appleby <andrewa@fairphone.com>Thu Dec 20 15:46:05 2018 +0100
committerBorjan Tchakaloff <borjan@fairphone.com>Fri Dec 28 10:52:39 2018 +0000
treeae0f788dab6edbb7fc952d0c3a99a08c34553b2b
parent507bfa699b8559954eebbc5f8308263239e083b3 [diff]
find-issues: Update help to include setting up environment

Issue: ST-1369
Change-Id: I27603841f4cff2da92c1a197a171f2a2a392dd51
1 file changed
tree: ae0f788dab6edbb7fc952d0c3a99a08c34553b2b
  1. android-maestro/
  2. bin/
  3. bullseye/
  4. jira/
  5. lava/
  6. python-libs/
  7. shell-libs/
  8. .gitignore
  9. LICENSE
  10. NOTICE
  11. pylintrc
  12. pyproject.toml
  13. README.md
  14. requirements-dev.txt
  15. tox.ini
  16. vendorsetup.sh
README.md

Fairphone Android tools

A collection of tools developed at Fairphone related to Android development:

  • Standalone scripts live in bin:
    • fetch-and-push-partner: a script to fetch the AOSP partner security branches in the Android tree and push them to our own repositories.
    • fetch-and-push-remote: a script to fetch remote branches and tags in the Android tree and push them to our own repositories.
    • find-issues: a script to grep through the logs of external projects to find references for Android Bug IDs, Qcom Create Point issues, CVE numbers etc.
    • merge-partner-on-aosp: a script to merge the AOSP partner security branches in the Android tree.
    • ota_install: a script to push an OTA to a device and initiate the update process with the Fairphone Updater.
    • store-android-build-keys-in-keystore: a script to store PKCS8 keys in a JKS keystore suitable for signing apps with gradle.
  • Installable libraries live in their own directory within <language>-libs:
    • python-libs/android-tools: A support library to work with Android devices and apps in Python 3.
    • shell-libs: A collection of shell scripts for handling common shell commands and operations.
  • Installable tools live in their own directory:
    • bullseye: Script to check and apply security patches from Android Security Bulletins.
    • lava: tools to interact with LAVA, the automated testing system.
    • jira: Script to import CSV defined configuration into the Fairphone JIRA instance. The script can create users, groups and components. Run ./import_csv_to_jira.py --help for details.

See the individual tools help (--help) or projects README for installation and usage.

TODO: Migrate the LAVA tools in lava to an installable Python package.

Developing

Code style, linters, and formatters must be used before submitting any new tool or patchset. Maximal line lengths are fixed to 80 characters.

Install the selected toolset within a Python 3.6 (virtual) environment:

$ pip3 install -r requirements-dev.txt

We detail below the recommendations (read: requirements) per language and how to run the tools in a standalone fashion.

Bash/Shell (.sh)

Note: Portable shell scripts are favoured over Bash scripts.

Follow what the Bashate style checker recommends.

$ bashate --verbose <file>

Python (.py)

Note: Python 3.6 is the current development choice.

Let Black format Python files for you.

$ black <file>

Trust that the linting tools (flake8 and pylint) know better and follow their advice.

$ flake8 <file>
$ pylint <file>

License

The project is made available under the terms of the Apache 2.0 license. See LICENSE for details.