Improve test invocation, fix Retro Shift bugs, and add Auto+Retro Shift test cases (#15889)
This commit is contained in:
		
							parent
							
								
									1fb02d5ad8
								
							
						
					
					
						commit
						dd94877ec6
					
				
					 48 changed files with 2584 additions and 89 deletions
				
			
		
							
								
								
									
										21
									
								
								tests/caps_word/auto_shift/config.h
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										21
									
								
								tests/caps_word/auto_shift/config.h
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,21 @@
 | 
			
		|||
// Copyright 2022 Google LLC
 | 
			
		||||
//
 | 
			
		||||
// This program is free software: you can redistribute it and/or modify
 | 
			
		||||
// it under the terms of the GNU General Public License as published by
 | 
			
		||||
// the Free Software Foundation, either version 2 of the License, or
 | 
			
		||||
// (at your option) any later version.
 | 
			
		||||
//
 | 
			
		||||
// This program is distributed in the hope that it will be useful,
 | 
			
		||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
// GNU General Public License for more details.
 | 
			
		||||
//
 | 
			
		||||
// You should have received a copy of the GNU General Public License
 | 
			
		||||
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "test_common.h"
 | 
			
		||||
 | 
			
		||||
#define TAPPING_TERM 200
 | 
			
		||||
#define AUTO_SHIFT_TIMEOUT 150
 | 
			
		||||
							
								
								
									
										22
									
								
								tests/caps_word/auto_shift/retro_shift/config.h
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										22
									
								
								tests/caps_word/auto_shift/retro_shift/config.h
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,22 @@
 | 
			
		|||
// Copyright 2022 Google LLC
 | 
			
		||||
//
 | 
			
		||||
// This program is free software: you can redistribute it and/or modify
 | 
			
		||||
// it under the terms of the GNU General Public License as published by
 | 
			
		||||
// the Free Software Foundation, either version 2 of the License, or
 | 
			
		||||
// (at your option) any later version.
 | 
			
		||||
//
 | 
			
		||||
// This program is distributed in the hope that it will be useful,
 | 
			
		||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
// GNU General Public License for more details.
 | 
			
		||||
//
 | 
			
		||||
// You should have received a copy of the GNU General Public License
 | 
			
		||||
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include "test_common.h"
 | 
			
		||||
 | 
			
		||||
#define TAPPING_TERM 200
 | 
			
		||||
#define AUTO_SHIFT_TIMEOUT 150
 | 
			
		||||
#define RETRO_SHIFT 500
 | 
			
		||||
							
								
								
									
										18
									
								
								tests/caps_word/auto_shift/retro_shift/test.mk
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								tests/caps_word/auto_shift/retro_shift/test.mk
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,18 @@
 | 
			
		|||
# Copyright 2022 Google LLC
 | 
			
		||||
#
 | 
			
		||||
# This program is free software: you can redistribute it and/or modify
 | 
			
		||||
# it under the terms of the GNU General Public License as published by
 | 
			
		||||
# the Free Software Foundation, either version 2 of the License, or
 | 
			
		||||
# (at your option) any later version.
 | 
			
		||||
#
 | 
			
		||||
# This program is distributed in the hope that it will be useful,
 | 
			
		||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
# GNU General Public License for more details.
 | 
			
		||||
#
 | 
			
		||||
# You should have received a copy of the GNU General Public License
 | 
			
		||||
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 | 
			
		||||
CAPS_WORD_ENABLE = yes
 | 
			
		||||
AUTO_SHIFT_ENABLE = yes
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -0,0 +1,141 @@
 | 
			
		|||
// Copyright 2022 Google LLC
 | 
			
		||||
//
 | 
			
		||||
// This program is free software: you can redistribute it and/or modify
 | 
			
		||||
// it under the terms of the GNU General Public License as published by
 | 
			
		||||
// the Free Software Foundation, either version 2 of the License, or
 | 
			
		||||
// (at your option) any later version.
 | 
			
		||||
//
 | 
			
		||||
// This program is distributed in the hope that it will be useful,
 | 
			
		||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
// GNU General Public License for more details.
 | 
			
		||||
//
 | 
			
		||||
// You should have received a copy of the GNU General Public License
 | 
			
		||||
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 | 
			
		||||
#include "keyboard_report_util.hpp"
 | 
			
		||||
#include "keycode.h"
 | 
			
		||||
#include "test_common.hpp"
 | 
			
		||||
#include "test_fixture.hpp"
 | 
			
		||||
#include "test_keymap_key.hpp"
 | 
			
		||||
 | 
			
		||||
// Allow reports with no keys or only KC_LSFT.
 | 
			
		||||
// clang-format off
 | 
			
		||||
#define EXPECT_EMPTY_OR_LSFT(driver)              \
 | 
			
		||||
    EXPECT_CALL(driver, send_keyboard_mock(AnyOf( \
 | 
			
		||||
            KeyboardReport(),                     \
 | 
			
		||||
            KeyboardReport(KC_LSFT))))
 | 
			
		||||
// clang-format on
 | 
			
		||||
 | 
			
		||||
bool get_auto_shifted_key(uint16_t keycode, keyrecord_t *record) {
 | 
			
		||||
    return true;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
using ::testing::_;
 | 
			
		||||
using ::testing::AnyNumber;
 | 
			
		||||
using ::testing::AnyOf;
 | 
			
		||||
using ::testing::InSequence;
 | 
			
		||||
 | 
			
		||||
class CapsWord : public TestFixture {
 | 
			
		||||
   public:
 | 
			
		||||
    void SetUp() override {
 | 
			
		||||
        caps_word_off();
 | 
			
		||||
    }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
// Tests that with Auto Shift, letter keys are shifted by Caps Word
 | 
			
		||||
// regardless of whether they are released before AUTO_SHIFT_TIMEOUT.
 | 
			
		||||
TEST_F(CapsWord, AutoShiftKeys) {
 | 
			
		||||
    TestDriver driver;
 | 
			
		||||
    KeymapKey  key_a(0, 0, 0, KC_A);
 | 
			
		||||
    KeymapKey  key_spc(0, 1, 0, KC_SPC);
 | 
			
		||||
    set_keymap({key_a, key_spc});
 | 
			
		||||
 | 
			
		||||
    EXPECT_EMPTY_OR_LSFT(driver).Times(AnyNumber());
 | 
			
		||||
    { // Expect: "A, A, space, a".
 | 
			
		||||
        InSequence s;
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_LSFT, KC_A));
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_LSFT, KC_A));
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_SPC));
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_A));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Turn on Caps Word and type "A (quick tap), A (long press), space, A".
 | 
			
		||||
    caps_word_on();
 | 
			
		||||
 | 
			
		||||
    tap_key(key_a);                         // Tap A quickly.
 | 
			
		||||
    tap_key(key_a, AUTO_SHIFT_TIMEOUT + 1); // Long press A.
 | 
			
		||||
    tap_key(key_spc);
 | 
			
		||||
    tap_key(key_a);
 | 
			
		||||
 | 
			
		||||
    VERIFY_AND_CLEAR(driver);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Test Caps Word + Auto Shift where keys A and B are rolled.
 | 
			
		||||
TEST_F(CapsWord, AutoShiftRolledShiftedKeys) {
 | 
			
		||||
    TestDriver driver;
 | 
			
		||||
    KeymapKey  key_a(0, 0, 0, KC_A);
 | 
			
		||||
    KeymapKey  key_b(0, 0, 1, KC_B);
 | 
			
		||||
    set_keymap({key_a, key_b});
 | 
			
		||||
 | 
			
		||||
    EXPECT_EMPTY_OR_LSFT(driver).Times(AnyNumber());
 | 
			
		||||
    { // Expect: "A, B, A, B".
 | 
			
		||||
        InSequence s;
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_LSFT, KC_A));
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_LSFT, KC_B));
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_LSFT, KC_A));
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_LSFT, KC_B));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    caps_word_on();
 | 
			
		||||
 | 
			
		||||
    key_a.press(); // Overlapping taps: A down, B down, A up, B up.
 | 
			
		||||
    run_one_scan_loop();
 | 
			
		||||
    key_b.press();
 | 
			
		||||
    run_one_scan_loop();
 | 
			
		||||
    key_a.release();
 | 
			
		||||
    run_one_scan_loop();
 | 
			
		||||
    key_b.release();
 | 
			
		||||
    run_one_scan_loop();
 | 
			
		||||
 | 
			
		||||
    key_a.press(); // Nested taps: A down, B down, B up, A up.
 | 
			
		||||
    run_one_scan_loop();
 | 
			
		||||
    key_b.press();
 | 
			
		||||
    run_one_scan_loop();
 | 
			
		||||
    key_b.release();
 | 
			
		||||
    run_one_scan_loop();
 | 
			
		||||
    key_a.release();
 | 
			
		||||
    run_one_scan_loop();
 | 
			
		||||
 | 
			
		||||
    caps_word_off();
 | 
			
		||||
    VERIFY_AND_CLEAR(driver);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Tests that with tap-hold keys with Retro Shift, letter keys are shifted by
 | 
			
		||||
// Caps Word regardless of whether they are retroshifted.
 | 
			
		||||
TEST_F(CapsWord, RetroShiftKeys) {
 | 
			
		||||
    TestDriver driver;
 | 
			
		||||
    KeymapKey  key_modtap_a(0, 0, 0, LCTL_T(KC_A));
 | 
			
		||||
    KeymapKey  key_layertap_b(0, 1, 0, LT(1, KC_B));
 | 
			
		||||
    set_keymap({key_modtap_a, key_layertap_b});
 | 
			
		||||
 | 
			
		||||
    EXPECT_EMPTY_OR_LSFT(driver).Times(AnyNumber());
 | 
			
		||||
    { // Expect: "B, A, B, A".
 | 
			
		||||
        InSequence s;
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_LSFT, KC_B));
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_LSFT, KC_A));
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_LSFT, KC_B));
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_LSFT, KC_A));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Turn on Caps Word and type "B, A (long press), B (long press), A".
 | 
			
		||||
    caps_word_on();
 | 
			
		||||
 | 
			
		||||
    tap_key(key_layertap_b);                   // Tap B quickly.
 | 
			
		||||
    tap_key(key_modtap_a, TAPPING_TERM + 1);   // Long press A.
 | 
			
		||||
    tap_key(key_layertap_b, TAPPING_TERM + 1); // Long press B.
 | 
			
		||||
    tap_key(key_modtap_a);                     // Tap A quickly.
 | 
			
		||||
 | 
			
		||||
    EXPECT_EQ(is_caps_word_on(), true);
 | 
			
		||||
    VERIFY_AND_CLEAR(driver);
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										18
									
								
								tests/caps_word/auto_shift/test.mk
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										18
									
								
								tests/caps_word/auto_shift/test.mk
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,18 @@
 | 
			
		|||
# Copyright 2022 Google LLC
 | 
			
		||||
#
 | 
			
		||||
# This program is free software: you can redistribute it and/or modify
 | 
			
		||||
# it under the terms of the GNU General Public License as published by
 | 
			
		||||
# the Free Software Foundation, either version 2 of the License, or
 | 
			
		||||
# (at your option) any later version.
 | 
			
		||||
#
 | 
			
		||||
# This program is distributed in the hope that it will be useful,
 | 
			
		||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
# GNU General Public License for more details.
 | 
			
		||||
#
 | 
			
		||||
# You should have received a copy of the GNU General Public License
 | 
			
		||||
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 | 
			
		||||
CAPS_WORD_ENABLE = yes
 | 
			
		||||
AUTO_SHIFT_ENABLE = yes
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										66
									
								
								tests/caps_word/auto_shift/test_caps_word_autoshift.cpp
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										66
									
								
								tests/caps_word/auto_shift/test_caps_word_autoshift.cpp
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,66 @@
 | 
			
		|||
// Copyright 2022 Google LLC
 | 
			
		||||
//
 | 
			
		||||
// This program is free software: you can redistribute it and/or modify
 | 
			
		||||
// it under the terms of the GNU General Public License as published by
 | 
			
		||||
// the Free Software Foundation, either version 2 of the License, or
 | 
			
		||||
// (at your option) any later version.
 | 
			
		||||
//
 | 
			
		||||
// This program is distributed in the hope that it will be useful,
 | 
			
		||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
// GNU General Public License for more details.
 | 
			
		||||
//
 | 
			
		||||
// You should have received a copy of the GNU General Public License
 | 
			
		||||
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 | 
			
		||||
#include "keyboard_report_util.hpp"
 | 
			
		||||
#include "keycode.h"
 | 
			
		||||
#include "test_common.hpp"
 | 
			
		||||
#include "test_fixture.hpp"
 | 
			
		||||
#include "test_keymap_key.hpp"
 | 
			
		||||
 | 
			
		||||
using ::testing::_;
 | 
			
		||||
using ::testing::AnyNumber;
 | 
			
		||||
using ::testing::AnyOf;
 | 
			
		||||
using ::testing::InSequence;
 | 
			
		||||
 | 
			
		||||
class CapsWord : public TestFixture {
 | 
			
		||||
   public:
 | 
			
		||||
    void SetUp() override {
 | 
			
		||||
        caps_word_off();
 | 
			
		||||
    }
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
// Tests that with Auto Shift, letter keys are shifted by Caps Word
 | 
			
		||||
// regardless of whether they are released before AUTO_SHIFT_TIMEOUT.
 | 
			
		||||
TEST_F(CapsWord, AutoShiftKeys) {
 | 
			
		||||
    TestDriver driver;
 | 
			
		||||
    KeymapKey  key_a(0, 0, 0, KC_A);
 | 
			
		||||
    KeymapKey  key_spc(0, 1, 0, KC_SPC);
 | 
			
		||||
    set_keymap({key_a, key_spc});
 | 
			
		||||
 | 
			
		||||
    // Allow any number of reports with no keys or only KC_LSFT.
 | 
			
		||||
    // clang-format off
 | 
			
		||||
    EXPECT_CALL(driver, send_keyboard_mock(AnyOf(
 | 
			
		||||
                KeyboardReport(),
 | 
			
		||||
                KeyboardReport(KC_LSFT))))
 | 
			
		||||
        .Times(AnyNumber());
 | 
			
		||||
    // clang-format on
 | 
			
		||||
    { // Expect: "A, A, space, a".
 | 
			
		||||
        InSequence s;
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_LSFT, KC_A));
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_LSFT, KC_A));
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_SPC));
 | 
			
		||||
        EXPECT_REPORT(driver, (KC_A));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Turn on Caps Word and type "A (quick tap), A (long press), space, A".
 | 
			
		||||
    caps_word_on();
 | 
			
		||||
 | 
			
		||||
    tap_key(key_a);                         // Tap A quickly.
 | 
			
		||||
    tap_key(key_a, AUTO_SHIFT_TIMEOUT + 1); // Long press A.
 | 
			
		||||
    tap_key(key_spc);
 | 
			
		||||
    tap_key(key_a);
 | 
			
		||||
 | 
			
		||||
    testing::Mock::VerifyAndClearExpectations(&driver);
 | 
			
		||||
}
 | 
			
		||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue