Skip to content

Commit

Permalink
CLI: fix json2c subcommand and add/fix tests (qmk#9206)
Browse files Browse the repository at this point in the history
Co-authored-by: Zach White <[email protected]>
  • Loading branch information
Erovia and skullydazed authored May 26, 2020
1 parent af2ca13 commit 6501377
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 8 deletions.
9 changes: 9 additions & 0 deletions keyboards/handwired/onekey/keymaps/default_json/keymap.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"keyboard":"handwired/onekey/pytest",
"keymap":"default_json",
"layout":"LAYOUT",
"layers":[["KC_A"]],
"author":"qmk",
"notes":"This file is a keymap.json file for handwired/onekey/pytest",
"version":1
}
1 change: 1 addition & 0 deletions keyboards/handwired/onekey/pytest/templates/keymap.c
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
#include QMK_KEYBOARD_H
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {__KEYMAP_GOES_HERE__};
12 changes: 6 additions & 6 deletions lib/python/qmk/cli/json2c.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@ def json2c(cli):
This command uses the `qmk.keymap` module to generate a keymap.c from a configurator export. The generated keymap is written to stdout, or to a file if -o is provided.
"""
# Error checking
if not cli.args.filename.exists():
cli.log.error('JSON file does not exist!')
if cli.args.filename and cli.args.filename.name == '-':
# TODO(skullydazed/anyone): Read file contents from STDIN
cli.log.error('Reading from STDIN is not (yet) supported.')
cli.print_usage()
exit(1)

if cli.args.filename.name == '-':
# TODO(skullydazed/anyone): Read file contents from STDIN
cli.log.error('Reading from STDIN is not (yet) supported.')
if not cli.args.filename.exists():
cli.log.error('JSON file does not exist!')
cli.print_usage()
exit(1)

# Environment processing
if cli.args.output.name == ('-'):
if cli.args.output and cli.args.output.name == '-':
cli.args.output = None

# Parse the configurator json
Expand Down
6 changes: 6 additions & 0 deletions lib/python/qmk/tests/test_cli_commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,9 @@ def test_list_keymaps_no_keyboard_found():
result = check_subcommand('list-keymaps', '-kb', 'asdfghjkl')
assert result.returncode == 0
assert 'does not exist' in result.stdout


def test_json2c():
result = check_subcommand('json2c', 'keyboards/handwired/onekey/keymaps/default_json/keymap.json')
assert result.returncode == 0
assert result.stdout == '#include QMK_KEYBOARD_H\nconst uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {\t[0] = LAYOUT(KC_A)};\n\n'
4 changes: 2 additions & 2 deletions lib/python/qmk/tests/test_qmk_keymap.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ def test_template_onekey_proton_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'
assert templ == '#include QMK_KEYBOARD_H\nconst 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'
assert templ == '#include QMK_KEYBOARD_H\nconst uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {\t[0] = LAYOUT(KC_A)};\n'


# FIXME(skullydazed): Add a test for qmk.keymap.write that mocks up an FD.

0 comments on commit 6501377

Please sign in to comment.