diff options
Diffstat (limited to 'lib/python/qmk')
-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 |
8 files changed, 91 insertions, 8 deletions
diff --git a/lib/python/qmk/cli/doctor.py b/lib/python/qmk/cli/doctor.py index 9ce765a4b..c5a144363 100755 --- a/lib/python/qmk/cli/doctor.py +++ b/lib/python/qmk/cli/doctor.py | |||
@@ -2,9 +2,11 @@ | |||
2 | 2 | ||
3 | Check up for QMK environment. | 3 | Check up for QMK environment. |
4 | """ | 4 | """ |
5 | import shutil | ||
6 | import platform | ||
7 | import os | 5 | import os |
6 | import platform | ||
7 | import shutil | ||
8 | import subprocess | ||
9 | from glob import glob | ||
8 | 10 | ||
9 | from milc import cli | 11 | from milc import cli |
10 | 12 | ||
@@ -16,32 +18,44 @@ def main(cli): | |||
16 | This is currently very simple, it just checks that all the expected binaries are on your system. | 18 | This is currently very simple, it just checks that all the expected binaries are on your system. |
17 | 19 | ||
18 | TODO(unclaimed): | 20 | TODO(unclaimed): |
19 | * [ ] Run the binaries to make sure they work | ||
20 | * [ ] Compile a trivial program with each compiler | 21 | * [ ] Compile a trivial program with each compiler |
21 | * [ ] Check for udev entries on linux | 22 | * [ ] Check for udev entries on linux |
22 | """ | 23 | """ |
23 | 24 | ||
24 | binaries = ['dfu-programmer', 'avrdude', 'dfu-util', 'avr-gcc', 'arm-none-eabi-gcc'] | 25 | binaries = ['dfu-programmer', 'avrdude', 'dfu-util', 'avr-gcc', 'arm-none-eabi-gcc'] |
26 | binaries += glob('bin/qmk-*') | ||
25 | 27 | ||
26 | cli.log.info('QMK Doctor is Checking your environment') | 28 | cli.log.info('QMK Doctor is checking your environment') |
27 | 29 | ||
28 | ok = True | 30 | ok = True |
29 | for binary in binaries: | 31 | for binary in binaries: |
30 | res = shutil.which(binary) | 32 | res = shutil.which(binary) |
31 | if res is None: | 33 | if res is None: |
32 | cli.log.error('{fg_red}QMK can\'t find ' + binary + ' in your path') | 34 | cli.log.error("{fg_red}QMK can't find %s in your path", binary) |
33 | ok = False | 35 | ok = False |
36 | else: | ||
37 | try: | ||
38 | subprocess.run([binary, '--version'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, timeout=5, check=True) | ||
39 | except subprocess.CalledProcessError: | ||
40 | cli.log.error("{fg_red}Can't run `%s --version`", binary) | ||
41 | ok = False | ||
34 | 42 | ||
35 | OS = platform.system() | 43 | OS = platform.system() |
36 | if OS == "Darwin": | 44 | if OS == "Darwin": |
37 | cli.log.info("Detected {fg_cyan}macOS") | 45 | cli.log.info("Detected {fg_cyan}macOS") |
38 | elif OS == "Linux": | 46 | elif OS == "Linux": |
39 | cli.log.info("Detected {fg_cyan}linux") | 47 | cli.log.info("Detected {fg_cyan}linux") |
40 | test = 'systemctl list-unit-files | grep enabled | grep -i ModemManager' | 48 | if shutil.which('systemctl'): |
41 | if os.system(test) == 0: | 49 | test = 'systemctl list-unit-files | grep enabled | grep -i ModemManager' |
42 | cli.log.warn("{bg_yellow}Detected modem manager. Please disable it if you are using Pro Micros") | 50 | if os.system(test) == 0: |
51 | cli.log.warn("{bg_yellow}Detected modem manager. Please disable it if you are using Pro Micros") | ||
52 | else: | ||
53 | cli.log.warn("Can't find systemctl to check for ModemManager.") | ||
43 | else: | 54 | else: |
44 | cli.log.info("Assuming {fg_cyan}Windows") | 55 | cli.log.info("Assuming {fg_cyan}Windows") |
45 | 56 | ||
46 | if ok: | 57 | if ok: |
47 | cli.log.info('{fg_green}QMK is ready to go') | 58 | cli.log.info('{fg_green}QMK is ready to go') |
59 | else: | ||
60 | cli.log.info('{fg_yellow}Problems detected, please fix these problems before proceeding.') | ||
61 | # 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 000000000..c6c9c67b3 --- /dev/null +++ b/lib/python/qmk/cli/nose2.py | |||
@@ -0,0 +1,18 @@ | |||
1 | """QMK Python Unit Tests | ||
2 | |||
3 | QMK script to run unit and integration tests against our python code. | ||
4 | """ | ||
5 | from milc import cli | ||
6 | |||
7 | |||
8 | @cli.entrypoint('QMK Python Unit Tests') | ||
9 | def main(cli): | ||
10 | """Use nose2 to run unittests | ||
11 | """ | ||
12 | try: | ||
13 | import nose2 | ||
14 | except ImportError: | ||
15 | cli.log.error('Could not import nose2! Please install it with {fg_cyan}pip3 install nose2') | ||
16 | return False | ||
17 | |||
18 | nose2.discover() | ||
diff --git a/lib/python/qmk/tests/__init__.py b/lib/python/qmk/tests/__init__.py new file mode 100644 index 000000000..e69de29bb --- /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 000000000..a2584b923 --- /dev/null +++ b/lib/python/qmk/tests/attrdict.py | |||
@@ -0,0 +1,8 @@ | |||
1 | class AttrDict(dict): | ||
2 | """A dictionary that can be accessed by attributes. | ||
3 | |||
4 | This should only be used to mock objects for unit testing. Please do not use this outside of qmk.tests. | ||
5 | """ | ||
6 | def __init__(self, *args, **kwargs): | ||
7 | super(AttrDict, self).__init__(*args, **kwargs) | ||
8 | 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 000000000..95f0a980f --- /dev/null +++ b/lib/python/qmk/tests/onekey_export.json | |||
@@ -0,0 +1,6 @@ | |||
1 | { | ||
2 | "keyboard":"handwired/onekey/pytest", | ||
3 | "keymap":"pytest_unittest", | ||
4 | "layout":"LAYOUT", | ||
5 | "layers":[["KC_A"]] | ||
6 | } | ||
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 000000000..3f6b56713 --- /dev/null +++ b/lib/python/qmk/tests/test_qmk_errors.py | |||
@@ -0,0 +1,7 @@ | |||
1 | from qmk.errors import NoSuchKeyboardError | ||
2 | |||
3 | def test_NoSuchKeyboardError(): | ||
4 | try: | ||
5 | raise(NoSuchKeyboardError("test message")) | ||
6 | except NoSuchKeyboardError as e: | ||
7 | 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 000000000..6a565ee90 --- /dev/null +++ b/lib/python/qmk/tests/test_qmk_keymap.py | |||
@@ -0,0 +1,18 @@ | |||
1 | import qmk.keymap | ||
2 | |||
3 | def test_template_onekey_proton_c(): | ||
4 | templ = qmk.keymap.template('handwired/onekey/proton_c') | ||
5 | assert templ == qmk.keymap.DEFAULT_KEYMAP_C | ||
6 | |||
7 | |||
8 | def test_template_onekey_pytest(): | ||
9 | templ = qmk.keymap.template('handwired/onekey/pytest') | ||
10 | assert templ == 'const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {__KEYMAP_GOES_HERE__};\n' | ||
11 | |||
12 | |||
13 | def test_generate_onekey_pytest(): | ||
14 | templ = qmk.keymap.generate('handwired/onekey/pytest', 'LAYOUT', [['KC_A']]) | ||
15 | assert templ == 'const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { [0] = LAYOUT(KC_A)};\n' | ||
16 | |||
17 | |||
18 | # 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 000000000..23816be7e --- /dev/null +++ b/lib/python/qmk/tests/test_qmk_path.py | |||
@@ -0,0 +1,12 @@ | |||
1 | import os | ||
2 | |||
3 | import qmk.path | ||
4 | |||
5 | def test_keymap_onekey_pytest(): | ||
6 | path = qmk.path.keymap('handwired/onekey/pytest') | ||
7 | assert path == 'keyboards/handwired/onekey/keymaps' | ||
8 | |||
9 | |||
10 | def test_normpath(): | ||
11 | path = qmk.path.normpath('lib/python') | ||
12 | assert path == os.environ['ORIG_CWD'] + '/lib/python' | ||