mirror of
				https://github.com/mfulz/qmk_firmware.git
				synced 2025-10-31 05:12:33 +01:00 
			
		
		
		
	 95d20e6d8b
			
		
	
	
		95d20e6d8b
		
			
		
	
	
	
	
		
			
			* Fix Caps Word and Unicode Map
* Tests for Caps Word + Auto Shift and Unicode Map.
* Fix formatting
* Add additional keyboard report expectation macros
This commit defines five test utilities, EXPECT_REPORT, EXPECT_UNICODE,
EXPECT_EMPTY_REPORT, EXPECT_ANY_REPORT and EXPECT_NO_REPORT for use with
TestDriver.
EXPECT_REPORT sets a gmock expectation that a given keyboard report will
be sent. For instance,
  EXPECT_REPORT(driver, (KC_LSFT, KC_A));
is shorthand for
  EXPECT_CALL(driver,
      send_keyboard_mock(KeyboardReport(KC_LSFT, KC_A)));
EXPECT_UNICODE sets a gmock expectation that a given Unicode code point
will be sent using UC_LNX input mode. For instance for U+2013,
  EXPECT_UNICODE(driver, 0x2013);
expects the sequence of keys:
  "Ctrl+Shift+U, 2, 0, 1, 3, space".
EXPECT_EMPTY_REPORT sets a gmock expectation that a given keyboard
report will be sent. For instance
  EXPECT_EMPTY_REPORT(driver);
expects a single report without keypresses or modifiers.
EXPECT_ANY_REPORT sets a gmock expectation that a arbitrary keyboard
report will be sent, without matching its contents. For instance
  EXPECT_ANY_REPORT(driver).Times(1);
expects a single arbitrary keyboard report will be sent.
EXPECT_NO_REPORT sets a gmock expectation that no keyboard report will
be sent at all.
* Add tap_key() and tap_keys() to TestFixture.
This commit adds a `tap_key(key)` method to TestFixture that taps a
given KeymapKey, optionally with a specified delay between press and
release.
Similarly, the method `tap_keys(key_a, key_b, key_c)` taps a sequence of
KeymapKeys.
* Use EXPECT_REPORT, tap_keys, etc. in most tests.
This commit uses EXPECT_REPORT, EXPECT_UNICODE, EXPECT_EMPTY_REPORT,
EXPECT_NO_REPORT, tap_key() and tap_keys() test utilities from the
previous two commits in most tests. Particularly the EXPECT_REPORT
macro is frequently useful and makes a nice reduction in boilerplate
needed to express many tests.
Co-authored-by: David Kosorin <david@kosorin.net>
		
	
			
		
			
				
	
	
		
			85 lines
		
	
	
		
			2.4 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
			
		
		
	
	
			85 lines
		
	
	
		
			2.4 KiB
		
	
	
	
		
			C++
		
	
	
	
	
	
| /* Copyright 2017 Fred Sundvik
 | |
|  *
 | |
|  * 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 "test_driver.hpp"
 | |
| 
 | |
| TestDriver* TestDriver::m_this = nullptr;
 | |
| 
 | |
| namespace {
 | |
| // Given a hex digit between 0 and 15, returns the corresponding keycode.
 | |
| uint8_t hex_digit_to_keycode(uint8_t digit) {
 | |
|     // clang-format off
 | |
|     static const uint8_t hex_keycodes[] = {
 | |
|         KC_0, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7,
 | |
|         KC_8, KC_9, KC_A, KC_B, KC_C, KC_D, KC_E, KC_F
 | |
|     };
 | |
|     // clang-format on
 | |
|     return hex_keycodes[digit];
 | |
| }
 | |
| } // namespace
 | |
| 
 | |
| TestDriver::TestDriver() : m_driver{&TestDriver::keyboard_leds, &TestDriver::send_keyboard, &TestDriver::send_mouse, &TestDriver::send_system, &TestDriver::send_consumer} {
 | |
|     host_set_driver(&m_driver);
 | |
|     m_this = this;
 | |
| }
 | |
| 
 | |
| TestDriver::~TestDriver() {
 | |
|     m_this = nullptr;
 | |
| }
 | |
| 
 | |
| uint8_t TestDriver::keyboard_leds(void) {
 | |
|     return m_this->m_leds;
 | |
| }
 | |
| 
 | |
| void TestDriver::send_keyboard(report_keyboard_t* report) {
 | |
|     test_logger.trace() << *report;
 | |
|     m_this->send_keyboard_mock(*report);
 | |
| }
 | |
| 
 | |
| void TestDriver::send_mouse(report_mouse_t* report) {
 | |
|     m_this->send_mouse_mock(*report);
 | |
| }
 | |
| 
 | |
| void TestDriver::send_system(uint16_t data) {
 | |
|     m_this->send_system_mock(data);
 | |
| }
 | |
| 
 | |
| void TestDriver::send_consumer(uint16_t data) {
 | |
|     m_this->send_consumer(data);
 | |
| }
 | |
| 
 | |
| namespace internal {
 | |
| void expect_unicode_code_point(TestDriver& driver, uint32_t code_point) {
 | |
|     testing::InSequence seq;
 | |
|     EXPECT_REPORT(driver, (KC_LCTL, KC_LSFT, KC_U));
 | |
| 
 | |
|     bool print_zero = false;
 | |
|     for (int i = 7; i >= 0; --i) {
 | |
|         if (i <= 3) {
 | |
|             print_zero = true;
 | |
|         }
 | |
| 
 | |
|         const uint8_t digit = (code_point >> (i * 4)) & 0xf;
 | |
|         if (digit || print_zero) {
 | |
|             EXPECT_REPORT(driver, (hex_digit_to_keycode(digit)));
 | |
|             print_zero = true;
 | |
|         }
 | |
|     }
 | |
| 
 | |
|     EXPECT_REPORT(driver, (KC_SPC));
 | |
| }
 | |
| } // namespace internal
 |