Add GitHub actions

.flake8

@@ -2,10 +2,24 @@
 # black, the super-great auto-formatter has decided that 88 is a good number.
 # I'm inclined to agree, or not to dissagree.
 max-line-length = 88
+docstring-convention = google
 exclude =
+    .git,
+    .tox,
+    .venv,
+    __pycache__,
+    dist,
     test/*,
 ignore =
     # W503: line break before binary operator (this is no longer PEP8 compliant)
     W503,
     # E203: whitespace before ':' (this is not PEP8 compliant)
     E203,
+per-file-ignores =
+    # Package level __init__ files improve user experience by short cutting
+    # imports.
+    # F401: imported but unused
+    __init__.py:F401
+    src/htrun/*/__init__.py:F401
+    # We don't care about docstrings in test classes
+    src/htrun/host_tests/*: D

.github/workflows/pr-check.yml

@@ -0,0 +1,60 @@
+name: Test greentea tools
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.9]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install tox
+        run: pip install tox
+
+      - name: Code Formatting and Static Analysis
+        run: tox -e linting
+
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: [3.6, 3.9]
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # Fetch history so setuptools-scm can calculate the version correctly
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install tox
+        run: pip install tox
+
+      - name: Run tests on ${{ matrix.os }} py ${{ matrix.python-version }}
+        run: tox -e py
+
+      - name: Create Coverage Report
+        run: |
+            set -xe
+            python -m pip install coverage[toml]
+            python -m coverage xml
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == 3.9
+
+      - name: Upload Coverage Report
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == 3.9
+        uses: "codecov/codecov-action@v1"
+        with:
+          fail_ci_if_error: true

src/greentea/gtea/greentea_log.py

@@ -82,6 +82,7 @@ def gt_log(self, text, print_text=True):
         Args:
             text: String to be logged.
             print_text: Force log to be printed on screen.
+
         Returns:
             String with message.
         """

src/greentea/gtea/target_info.py

@@ -41,6 +41,7 @@ def _platform_property_from_targets_json(targets, platform, property):
         targets: Data structure from targets.json.
         platform: Name of the platform.
         property: Name of the property.
+
     Returns:
         Property value, None if not found.
 

src/greentea/gtea/tests_spec.py

@@ -119,6 +119,7 @@ def add_binary(self, path, binary_type, compare_log=None):
         Args:
             path: Path to the binary.
             binary_type: Type of binary being added.
+            compare_log: Log to match output from.
         """
         self.__binaries_by_flash_method[binary_type] = TestBinary(
             path, binary_type, compare_log

src/htrun/__init__.py

@@ -3,13 +3,11 @@
 # SPDX-License-Identifier: Apache-2.0
 #
 
+"""The htrun package.
 
-"""! @package htrun
-
-Flash, reset and  perform host supervised tests on Mbed enabled platforms.
-Write your own programs (import this package) or use 'htrun'
-command line tool instead.
-
+Flash, reset and perform host supervised tests on Mbed enabled platforms.
+Write your own programs (import this package) or use 'htrun' command line tool
+instead.
 """
 
 import imp
@@ -29,6 +27,7 @@
 
 
 def get_plugin_caps(methods=None):
+    """Return the capabilities of a plugin."""
     if not methods:
         methods = ["CopyMethod", "ResetMethod"]
     result = {}
@@ -38,9 +37,12 @@ def get_plugin_caps(methods=None):
 
 
 def init_host_test_cli_params():
-    """! Function creates CLI parser object and returns populated options object.
-    @return Function returns 'options' object returned from OptionParser class
-    @details Options object later can be used to populate host test selector script.
+    """Create CLI parser object and return populated options object.
+
+    Options object can be used to populate host test selector script.
+
+    Returns:
+        'options' object returned from OptionParser class.
     """
     parser = OptionParser()
 

src/htrun/host_tests/__init__.py

@@ -2,6 +2,6 @@
 # Copyright (c) 2021 Arm Limited and Contributors. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 #
+"""Base host test class."""
 
-# base host test class
 from .base_host_test import BaseHostTest, event_callback