Gitiles
Code Review Sign In
gerrit-public.fairphone.software / vendor / fairphone / tools / e237bc8ff784dff2074a64f9be9e0b7ce9e4d6eb
commite237bc8ff784dff2074a64f9be9e0b7ce9e4d6eb[log] [tgz]
authorKarsten Tausche <karsten@fairphone.com>Fri Feb 01 12:15:15 2019 +0100
committerKarsten Tausche <karsten@fairphone.com>Fri Feb 01 12:15:15 2019 +0100
treeda4e5d5c72c713e7a8cdb71dee3787494d0cec4b
parentf4142727ddb340b1c01e7e708b8764f7e7cdf832 [diff]
bullseye: Don't fail for non-existent projects

We don't necessarily have all projects in our tree that we get patches
for, so gracefully handle non-existent projects. An example is
bootable/recovery: We use TWRP instead of AOSP recovery.

Change-Id: I6ff630c4159095622e99ab2f6bd3dd5e2294be40
1 file changed
tree: da4e5d5c72c713e7a8cdb71dee3787494d0cec4b
  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.
  • 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.