Gitiles
Code Review Sign In
gerrit-public.fairphone.software / vendor / fairphone / tools / refs/heads/rel/10/fp2/22.06.0-rel
commit620602a3dfc52343e90e356cafa2ed040fe6b640[log] [tgz]
authorKarsten Tausche <karsten@fairphone.com>Thu Apr 07 10:18:35 2022 +0200
committerKarsten Tausche <karsten@fairphone.com>Thu Apr 07 11:53:04 2022 +0200
tree5bb991844a1a4930729eb03014035742a022c4bd
parent84e95cff9dc0f0e57cce210dbad3cd7530a37838 [diff]
fetch-and-push-remote: Allow pushing current 'upstream'

Release manifests may have a 'upstream' revision defined per project,
which is supposed to be the branch the current 'revision' sha1 is on.
This allows using Qualcomm release manifests (not the "default_*.xml")
variant with fixed revisions to work on the actual release revisions
while at the same time also importing upstream branches.

Change-Id: Ibe0ef438858f14535b237530856fa96ca6941b25
2 files changed
tree: 5bb991844a1a4930729eb03014035742a022c4bd
  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>

Additionally, run mypy for validating type hinting. However, this does not fit in all contexts and mypy has limitations in specific situations. Consider using type hints unless it is too hard of a burden. If using type hints, also consider using mypy's strict mode. It provides extra checks, including calls from typed contexts to untyped ones etc.

$ mypy [--strict] <file>

License

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