Add a test procedure to the bottom of the matrix

For consistency and so a reader knows what "tested" means.
This commit is contained in:
Dan Smith 2022-12-04 10:51:06 -08:00 committed by Dan Smith
parent 66e1a9a70a
commit 27f183cd0d
2 changed files with 37 additions and 0 deletions

View File

@ -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.

View File

@ -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)