Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases #15889

IsaacElenbaas · 2022-01-15T14:38:37Z

Description

This PR:

Fixes all of the Retro Shift bugs I have run into or been alerted to in the past couple of months
Includes some small Retro Shift doc additions/fixes
Adds test cases for Auto and Retro Shift
Includes test invocation improvements:
- Running make test:auto_shift will run all Auto Shift tests
- Running make test:auto_shift:retro_shift:permissive_hold (or similar) allows running tests in different directories that have the same name, versus the old behavior of whichever's parent directory was later in the alphabet
- Running make test:permissive_hold will run both Retro Shift's permissive_hold test and the normal one

It also makes RETRO_SHIFT not default to TAPPING_TERM, as the behavior can be confusing (trying out the feature -> holding -> not releasing between AUTO_SHIFT_TIMEOUT and TAPPING_TERM which are probably close for most users). The old behavior also made it impossible to make holds of any length send the shifted value aside from setting RETRO_SHIFT to INT_MAX or something.

Types of Changes

Issues Fixed or Closed by This PR

[Bug] Retro Shift not working on Mod Tap keys #15458
Made Retro Shift respect DYNAMIC_TAPPING_TERM
Miscellaneous Retro Shift issues that do not have issues
Updated out-of-date default function in docs

Checklist

My code follows the code style of this project: C, Python
I have read the PR Checklist document and have made the appropriate changes.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

quantum/process_keycode/process_auto_shift.c

quantum/action_tapping.c

IsaacElenbaas · 2022-03-13T22:58:01Z

get_hold_on_other_key_press isn't exposed, last push added it to action_tapping.h.

IsaacElenbaas · 2022-04-08T15:01:51Z

Last commit made record->event.pressed not false where there was no good reason for it to be. Not sure what I was thinking when I did that one.

tzarc · 2022-04-19T11:10:44Z

Conflicts once base branch swapped to develop.

IsaacElenbaas · 2022-04-21T14:20:02Z

Conflict fixed.

IsaacElenbaas · 2022-05-13T20:20:21Z

Last commit fixed having IGNORE_MOD_TAP_INTERRUPT set and rolling starting from a Retro Shifted key not allowing the Retro Shifted key to be shifted.

IsaacElenbaas · 2022-07-09T21:50:24Z

Since this hasn't been merged yet I'm adding unit tests. Shouldn't be long at all but don't review/merge in the meantime.

IsaacElenbaas · 2022-07-28T02:28:22Z

Conflicts with #15741 now but that's just because I found things that could be deleted so should be easy :)

I had to make some changes to the way tests are run to allow Retro Shift and the Tap Hold configurations to have the same folder names and both be runnable. I think the glob-like behavior is pretty good, if we name things appropriately one can run relevant test cases easily and without doing them all during development. It also sort of mirrors the keyboard commands and generated files.

I need to look into the failing combo tests (E: they didn't add their keys to Retro Shift), give this actual physical board testing (E: looks good so far), and check if I've managed to fix one last bug unintentionally (E: I did) or if it needs a workaround, but there shouldn't be many changes what with the tests passing.

IsaacElenbaas · 2022-07-28T02:35:20Z

quantum/action_tapping.c

+        if (IS_TAPPING_KEY(waiting_buffer[i].event.key) && !waiting_buffer[i].event.pressed && (
+            WITHIN_TAPPING_TERM(waiting_buffer[i].event)
+#    if defined(AUTO_SHIFT_ENABLE) && defined(RETRO_SHIFT)
+            || (


This being missing made so much weird behavior and caused 2-3 months of on-and-off playing with one bug and then getting frustrated and quitting for a while.

IsaacElenbaas · 2023-07-08T20:53:34Z

quantum/action.c

@@ -497,7 +497,7 @@ void process_action(keyrecord_t *record, action_t action) {
                default:
                    if (event.pressed) {
                        if (tap_count > 0) {
-#    ifdef HOLD_ON_OTHER_KEY_PRESS_PER_KEY
+#    ifdef HOLD_ON_OTHER_KEY_PRESS


Life got crazy but I finally got around to looking at this again after stale-bot reminded me. Should be good to go again, other combo tests are failing right now so the action won't run but they're passing. E: combo tests were my fault, fixed.

The issues weren't actually from that PR, they were from a couple of the things I had thrown in in the last PR to make Retro Shift ready for HOLD_ON_OTHER_KEY_PRESS before it happened not being quite correct. I also fixed the above, which I think wasn't noticed in the three months since the switch because an earlier evaluation was also added (which I had to exclude Retro Shift from).

github-actions · 2023-08-24T01:47:15Z

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with bug, awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

Makes multiple tests of the same name work Allows calling all tests under a organizational directory

…ft test cases (qmk#15889)

github-actions bot added core documentation labels Jan 15, 2022

precondition suggested changes Jan 15, 2022

View reviewed changes

quantum/process_keycode/process_auto_shift.c Outdated Show resolved Hide resolved

quantum/action_tapping.c Outdated Show resolved Hide resolved

quantum/action_tapping.c Outdated Show resolved Hide resolved

IsaacElenbaas force-pushed the retro_shift_fixes branch 2 times, most recently from df80a71 to ecee26b Compare January 16, 2022 03:51

IsaacElenbaas force-pushed the retro_shift_fixes branch from ecee26b to 892173e Compare January 27, 2022 02:23

IsaacElenbaas mentioned this pull request Mar 13, 2022

clarified the documentation to fix issue #15458 #16542

Closed

7 tasks

IsaacElenbaas force-pushed the retro_shift_fixes branch from 892173e to 6e018ce Compare March 13, 2022 22:56

drashna requested a review from a team March 18, 2022 00:53

IsaacElenbaas force-pushed the retro_shift_fixes branch from 6e018ce to 95f4b01 Compare April 8, 2022 15:00

drashna approved these changes Apr 13, 2022

View reviewed changes

drashna requested a review from a team April 13, 2022 05:42

tzarc changed the base branch from master to develop April 19, 2022 11:10

IsaacElenbaas force-pushed the retro_shift_fixes branch from 95f4b01 to 2c737d5 Compare April 21, 2022 14:17

IsaacElenbaas force-pushed the retro_shift_fixes branch from 2c737d5 to cd0e9d1 Compare May 13, 2022 20:18

IsaacElenbaas force-pushed the retro_shift_fixes branch from cd0e9d1 to 3e11c13 Compare May 13, 2022 23:47

IsaacElenbaas mentioned this pull request Jul 4, 2022

[Feature Request] Improve retro shift usability #17217

Closed

4 tasks

IsaacElenbaas marked this pull request as draft July 9, 2022 21:49

IsaacElenbaas force-pushed the retro_shift_fixes branch 2 times, most recently from 5663128 to 55c52dc Compare July 28, 2022 02:04

IsaacElenbaas changed the title ~~Close #15458 and make Retro Shift respect DYNAMIC_TAPPING_TERM~~ Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases Jul 28, 2022

IsaacElenbaas marked this pull request as ready for review July 28, 2022 02:19

IsaacElenbaas commented Jul 28, 2022

View reviewed changes

github-actions bot added the stale Issues or pull requests that have become inactive without resolution. label Jul 5, 2023

IsaacElenbaas force-pushed the retro_shift_fixes branch from 6efa940 to 64996de Compare July 8, 2023 20:47

IsaacElenbaas commented Jul 8, 2023

View reviewed changes

IsaacElenbaas force-pushed the retro_shift_fixes branch from 64996de to 7ca9b67 Compare July 8, 2023 21:01

drashna approved these changes Jul 8, 2023

View reviewed changes

IsaacElenbaas force-pushed the retro_shift_fixes branch from 7ca9b67 to 1cc9b49 Compare July 8, 2023 22:26

github-actions bot removed the stale Issues or pull requests that have become inactive without resolution. label Jul 9, 2023

github-actions bot added the stale Issues or pull requests that have become inactive without resolution. label Aug 24, 2023

Improve test invocation

fdb5477

Makes multiple tests of the same name work Allows calling all tests under a organizational directory

IsaacElenbaas force-pushed the retro_shift_fixes branch 2 times, most recently from 535a659 to b3cb29d Compare September 6, 2023 21:08

github-actions bot removed the stale Issues or pull requests that have become inactive without resolution. label Sep 7, 2023

Retro Shift bugfixes, documentation, and test cases

7a6ef6e

IsaacElenbaas force-pushed the retro_shift_fixes branch from b3cb29d to 7a6ef6e Compare September 9, 2023 02:58

tzarc removed the breaking_change_2023q3 label Sep 9, 2023

tzarc approved these changes Sep 25, 2023

View reviewed changes

tzarc merged commit dd94877 into qmk:develop Sep 25, 2023
4 checks passed

mechlovin pushed a commit to mechlovin/qmk_firmware that referenced this pull request Oct 25, 2023

Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shi…

f2dd85b

…ft test cases (qmk#15889)

christrotter pushed a commit to christrotter/qmk_firmware that referenced this pull request Nov 28, 2023

Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shi…

900ca86

…ft test cases (qmk#15889)

zgagnon pushed a commit to zgagnon/qmk_firmware_waterfowl that referenced this pull request Dec 15, 2023

Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shi…

872b247

…ft test cases (qmk#15889)

future-figs pushed a commit to future-figs/qmk_firmware that referenced this pull request Dec 27, 2023

Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shi…

338f9f7

…ft test cases (qmk#15889)

This was referenced Feb 8, 2024

Initial qmk test-c functionality #23038

Merged

Fix unit test execution #23048

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases #15889

Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases #15889

IsaacElenbaas commented Jan 15, 2022 •

edited

Loading

IsaacElenbaas commented Mar 13, 2022

IsaacElenbaas commented Apr 8, 2022

tzarc commented Apr 19, 2022

IsaacElenbaas commented Apr 21, 2022

IsaacElenbaas commented May 13, 2022

IsaacElenbaas commented Jul 9, 2022 •

edited

Loading

IsaacElenbaas commented Jul 28, 2022 •

edited

Loading

IsaacElenbaas Jul 28, 2022

IsaacElenbaas Jul 8, 2023 •

edited

Loading

github-actions bot commented Aug 24, 2023

Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases #15889

Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases #15889

Conversation

IsaacElenbaas commented Jan 15, 2022 • edited Loading

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

IsaacElenbaas commented Mar 13, 2022

IsaacElenbaas commented Apr 8, 2022

tzarc commented Apr 19, 2022

IsaacElenbaas commented Apr 21, 2022

IsaacElenbaas commented May 13, 2022

IsaacElenbaas commented Jul 9, 2022 • edited Loading

IsaacElenbaas commented Jul 28, 2022 • edited Loading

IsaacElenbaas Jul 28, 2022

Choose a reason for hiding this comment

IsaacElenbaas Jul 8, 2023 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Aug 24, 2023

IsaacElenbaas commented Jan 15, 2022 •

edited

Loading

IsaacElenbaas commented Jul 9, 2022 •

edited

Loading

IsaacElenbaas commented Jul 28, 2022 •

edited

Loading

IsaacElenbaas Jul 8, 2023 •

edited

Loading