diff options
| author | skullY <[email protected]> | 2019-08-21 23:40:24 -0700 | 
|---|---|---|
| committer | skullydazed <[email protected]> | 2019-09-07 07:58:41 -0700 | 
| commit | 5b7a5b2a7629fbb667d23a55836dce3c6c46a203 (patch) | |
| tree | b153a030844887422464c6c4f4833242b34a9314 /lib/python | |
| parent | 4d339b7b5d1ecc2320080798d7e07e2d43675578 (diff) | |
| download | qmk_firmware-5b7a5b2a7629fbb667d23a55836dce3c6c46a203.tar.gz qmk_firmware-5b7a5b2a7629fbb667d23a55836dce3c6c46a203.zip | |
Setup a python test framework
Diffstat (limited to 'lib/python')
| -rw-r--r-- | lib/python/milc.py | 3 | ||||
| -rwxr-xr-x | lib/python/qmk/cli/doctor.py | 30 | ||||
| -rw-r--r-- | lib/python/qmk/cli/nose2.py | 18 | ||||
| -rw-r--r-- | lib/python/qmk/tests/__init__.py | 0 | ||||
| -rw-r--r-- | lib/python/qmk/tests/attrdict.py | 8 | ||||
| -rw-r--r-- | lib/python/qmk/tests/onekey_export.json | 6 | ||||
| -rw-r--r-- | lib/python/qmk/tests/test_qmk_errors.py | 7 | ||||
| -rw-r--r-- | lib/python/qmk/tests/test_qmk_keymap.py | 18 | ||||
| -rw-r--r-- | lib/python/qmk/tests/test_qmk_path.py | 12 | 
9 files changed, 92 insertions, 10 deletions
| diff --git a/lib/python/milc.py b/lib/python/milc.py index 6e82edf8b1..c62c1b166c 100644 --- a/lib/python/milc.py +++ b/lib/python/milc.py @@ -534,8 +534,7 @@ class MILC(object):          if not self._inside_context_manager:              # If they didn't use the context manager use it ourselves              with self: -                self.__call__() -                return +                return self.__call__()          if not self._entrypoint:              raise RuntimeError('No entrypoint provided!') diff --git a/lib/python/qmk/cli/doctor.py b/lib/python/qmk/cli/doctor.py index 9ce765a4b5..c5a144363c 100755 --- a/lib/python/qmk/cli/doctor.py +++ b/lib/python/qmk/cli/doctor.py @@ -2,9 +2,11 @@  Check up for QMK environment.  """ -import shutil -import platform  import os +import platform +import shutil +import subprocess +from glob import glob  from milc import cli @@ -16,32 +18,44 @@ def main(cli):      This is currently very simple, it just checks that all the expected binaries are on your system.      TODO(unclaimed): -        * [ ] Run the binaries to make sure they work          * [ ] Compile a trivial program with each compiler          * [ ] Check for udev entries on linux      """      binaries = ['dfu-programmer', 'avrdude', 'dfu-util', 'avr-gcc', 'arm-none-eabi-gcc'] +    binaries += glob('bin/qmk-*') -    cli.log.info('QMK Doctor is Checking your environment') +    cli.log.info('QMK Doctor is checking your environment')      ok = True      for binary in binaries:          res = shutil.which(binary)          if res is None: -            cli.log.error('{fg_red}QMK can\'t find ' + binary + ' in your path') +            cli.log.error("{fg_red}QMK can't find %s in your path", binary)              ok = False +        else: +            try: +                subprocess.run([binary, '--version'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, timeout=5, check=True) +            except subprocess.CalledProcessError: +                cli.log.error("{fg_red}Can't run `%s --version`", binary) +                ok = False      OS = platform.system()      if OS == "Darwin":          cli.log.info("Detected {fg_cyan}macOS")      elif OS == "Linux":          cli.log.info("Detected {fg_cyan}linux") -        test = 'systemctl list-unit-files | grep enabled | grep -i ModemManager' -        if os.system(test) == 0: -            cli.log.warn("{bg_yellow}Detected modem manager. Please disable it if you are using Pro Micros") +        if shutil.which('systemctl'): +            test = 'systemctl list-unit-files | grep enabled | grep -i ModemManager' +            if os.system(test) == 0: +                cli.log.warn("{bg_yellow}Detected modem manager. Please disable it if you are using Pro Micros") +        else: +            cli.log.warn("Can't find systemctl to check for ModemManager.")      else:          cli.log.info("Assuming {fg_cyan}Windows")      if ok:          cli.log.info('{fg_green}QMK is ready to go') +    else: +        cli.log.info('{fg_yellow}Problems detected, please fix these problems before proceeding.') +        # FIXME(skullydazed): Link to a document about troubleshooting, or discord or something diff --git a/lib/python/qmk/cli/nose2.py b/lib/python/qmk/cli/nose2.py new file mode 100644 index 0000000000..c6c9c67b30 --- /dev/null +++ b/lib/python/qmk/cli/nose2.py @@ -0,0 +1,18 @@ +"""QMK Python Unit Tests + +QMK script to run unit and integration tests against our python code. +""" +from milc import cli + + [email protected]('QMK Python Unit Tests') +def main(cli): +    """Use nose2 to run unittests +    """ +    try: +        import nose2 +    except ImportError: +        cli.log.error('Could not import nose2! Please install it with {fg_cyan}pip3 install nose2') +        return False + +    nose2.discover() diff --git a/lib/python/qmk/tests/__init__.py b/lib/python/qmk/tests/__init__.py new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/lib/python/qmk/tests/__init__.py diff --git a/lib/python/qmk/tests/attrdict.py b/lib/python/qmk/tests/attrdict.py new file mode 100644 index 0000000000..a2584b9233 --- /dev/null +++ b/lib/python/qmk/tests/attrdict.py @@ -0,0 +1,8 @@ +class AttrDict(dict): +    """A dictionary that can be accessed by attributes. + +    This should only be used to mock objects for unit testing. Please do not use this outside of qmk.tests. +    """ +    def __init__(self, *args, **kwargs): +        super(AttrDict, self).__init__(*args, **kwargs) +        self.__dict__ = self diff --git a/lib/python/qmk/tests/onekey_export.json b/lib/python/qmk/tests/onekey_export.json new file mode 100644 index 0000000000..95f0a980fe --- /dev/null +++ b/lib/python/qmk/tests/onekey_export.json @@ -0,0 +1,6 @@ +{ +    "keyboard":"handwired/onekey/pytest", +    "keymap":"pytest_unittest", +    "layout":"LAYOUT", +    "layers":[["KC_A"]] +} diff --git a/lib/python/qmk/tests/test_qmk_errors.py b/lib/python/qmk/tests/test_qmk_errors.py new file mode 100644 index 0000000000..3f6b567137 --- /dev/null +++ b/lib/python/qmk/tests/test_qmk_errors.py @@ -0,0 +1,7 @@ +from qmk.errors import NoSuchKeyboardError + +def test_NoSuchKeyboardError(): +    try: +        raise(NoSuchKeyboardError("test message")) +    except NoSuchKeyboardError as e: +        assert e.message == 'test message' diff --git a/lib/python/qmk/tests/test_qmk_keymap.py b/lib/python/qmk/tests/test_qmk_keymap.py new file mode 100644 index 0000000000..6a565ee900 --- /dev/null +++ b/lib/python/qmk/tests/test_qmk_keymap.py @@ -0,0 +1,18 @@ +import qmk.keymap + +def test_template_onekey_proton_c(): +    templ = qmk.keymap.template('handwired/onekey/proton_c') +    assert templ == qmk.keymap.DEFAULT_KEYMAP_C + + +def test_template_onekey_pytest(): +    templ = qmk.keymap.template('handwired/onekey/pytest') +    assert templ == 'const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {__KEYMAP_GOES_HERE__};\n' + + +def test_generate_onekey_pytest(): +    templ = qmk.keymap.generate('handwired/onekey/pytest', 'LAYOUT', [['KC_A']]) +    assert templ == 'const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {	[0] = LAYOUT(KC_A)};\n' + + +# FIXME(skullydazed): Add a test for qmk.keymap.write that mocks up an FD. diff --git a/lib/python/qmk/tests/test_qmk_path.py b/lib/python/qmk/tests/test_qmk_path.py new file mode 100644 index 0000000000..23816be7ed --- /dev/null +++ b/lib/python/qmk/tests/test_qmk_path.py @@ -0,0 +1,12 @@ +import os + +import qmk.path + +def test_keymap_onekey_pytest(): +    path = qmk.path.keymap('handwired/onekey/pytest') +    assert path == 'keyboards/handwired/onekey/keymaps' + + +def test_normpath(): +    path = qmk.path.normpath('lib/python') +    assert path == os.environ['ORIG_CWD'] + '/lib/python' | 
