diff --git a/tests/Python3_Driver_Testing.md b/tests/Python3_Driver_Testing.md index e56c7acc..de2eb591 100644 --- a/tests/Python3_Driver_Testing.md +++ b/tests/Python3_Driver_Testing.md @@ -363,3 +363,20 @@ **Tested:** 38% (138/217) **Byte clean:** 58% (209/146) + +## Minimal test prodecure +For the purposes of the Python 3 effort, a "tested" radio means +at least the following procedure was followed: +1. Download from the radio +1. Make some change to a memory +1. If the radio has settings support, make sure settings load and tweak one setting +1. Upload to the radio +1. Confirm that the changes stick and look correct, or at least are not a + regression from the master py2 branch. + +The drivers are all passing the automated tests, but tests with real hardware +and serial ports is important, especially around bytes-vs-string safety. + +To update this document, add/edit entries in `tests/py3_driver_testers.txt` and +then run `tox -e makesupported`. Commit the result (including the changes to this `.md` +file) and submit a PR. diff --git a/tools/py3_driver_progress.py b/tools/py3_driver_progress.py index 80132685..86fa310b 100644 --- a/tools/py3_driver_progress.py +++ b/tools/py3_driver_progress.py @@ -3,6 +3,7 @@ import argparse import csv import sys +import textwrap from chirp import directory @@ -85,6 +86,25 @@ def main(): len(drivers) - byteclean), file=output) + print(textwrap.dedent(""" + ## Minimal test prodecure + For the purposes of the Python 3 effort, a "tested" radio means + at least the following procedure was followed: + 1. Download from the radio + 1. Make some change to a memory + 1. If the radio has settings support, make sure settings load and tweak one setting + 1. Upload to the radio + 1. Confirm that the changes stick and look correct, or at least are not a + regression from the master py2 branch. + + The drivers are all passing the automated tests, but tests with real hardware + and serial ports is important, especially around bytes-vs-string safety. + + To update this document, add/edit entries in `tests/py3_driver_testers.txt` and + then run `tox -e makesupported`. Commit the result (including the changes to this `.md` + file) and submit a PR."""), + file=output) + for driver, (tester, tested) in testers.items(): print('Error in testers file; driver %s by %s on %s unknown' % ( driver, tester, tested), file=sys.stderr)