Skip to content
This repository has been archived by the owner on Sep 12, 2019. It is now read-only.

Commit

Permalink
Add basic timing support, and SFT_T tests
Browse files Browse the repository at this point in the history
Also expose some bugs...
  • Loading branch information
fredizzimo authored and jackhumbert committed Jul 9, 2017
1 parent a62f449 commit 4e69a8b
Show file tree
Hide file tree
Showing 9 changed files with 157 additions and 27 deletions.
2 changes: 1 addition & 1 deletion build_full_test.mk
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ $(TEST)_SRC += $(patsubst $(ROOTDIR)/%,%,$(wildcard $(TEST_PATH)/*.cpp))

$(TEST)_DEFS=$(TMK_COMMON_DEFS)
$(TEST)_CONFIG=$(TEST_PATH)/config.h
VPATH+=$(TOP_DIR)/tests/test_common
VPATH+=$(TOP_DIR)/tests/test_common
1 change: 0 additions & 1 deletion tests/basic/config.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,4 @@
#define MATRIX_ROWS 4
#define MATRIX_COLS 10


#endif /* TESTS_BASIC_CONFIG_H_ */
10 changes: 5 additions & 5 deletions tests/basic/keymap.c
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[0] = {
// 0 1 2 3 4 5 6 7 8 9
{KC_A, KC_B, KC_NO, KC_LSFT, KC_RSFT, KC_LCTL, COMBO1, KC_NO, KC_NO, KC_NO},
{KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO},
{KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO},
{KC_C, KC_D, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO},
// 0 1 2 3 4 5 6 7 8 9
{KC_A, KC_B, KC_NO, KC_LSFT, KC_RSFT, KC_LCTL, COMBO1, SFT_T(KC_P), KC_NO, KC_NO},
{KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO},
{KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO},
{KC_C, KC_D, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO},
},
};
9 changes: 1 addition & 8 deletions tests/basic/keypress.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

#include "gtest/gtest.h"
#include "gmock/gmock.h"

#include "quantum.h"
#include "test_driver.h"
#include "test_matrix.h"
#include "keyboard_report_util.h"
#include "test_fixture.h"
#include "test_common.h"

using testing::_;
using testing::Return;
Expand Down
96 changes: 96 additions & 0 deletions tests/basic/tapping.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
/* 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_common.h"
#include "action_tapping.h"

using testing::_;
using testing::InSequence;

class Tapping : public TestFixture {};

TEST_F(Tapping, TapA_SHFT_T_KeyReportsKey) {
TestDriver driver;
InSequence s;

press_key(7, 0);
// Tapping keys does nothing on press
EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
run_one_scan_loop();
release_key(7, 0);
// First we get the key press
EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_P)));
// Then the release
EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
run_one_scan_loop();
}

TEST_F(Tapping, HoldA_SHFT_T_KeyReportsShift) {
TestDriver driver;
InSequence s;

press_key(7, 0);
// Tapping keys does nothing on press
EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
idle_for(TAPPING_TERM);
EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
run_one_scan_loop();
}

TEST_F(Tapping, ANewTapWithinTappingTermIsBuggy) {
TestDriver driver;
InSequence s;

press_key(7, 0);
// Tapping keys does nothing on press
EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
run_one_scan_loop();
release_key(7, 0);
// First we get the key press
EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_P)));
// Then the release
EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
run_one_scan_loop();

// This sends KC_P, even if it should do nothing
press_key(7, 0);
// This test should not succed if everything works correctly
EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_P)));
run_one_scan_loop();
release_key(7, 0);
EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
idle_for(TAPPING_TERM + 1);

// On the other hand, nothing is sent if we are outside the tapping term
press_key(7, 0);
EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
run_one_scan_loop();
release_key(7, 0);

// First we get the key press
EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_P)));
// Then the release
EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
idle_for(TAPPING_TERM + 1);

// Now we are geting into strange territory, as the hold registers too early here
// But the stranges part is:
// If TAPPING_TERM + 1 above is changed to TAPPING_TERM or TAPPING_TERM + 2 it doesn't
press_key(7, 0);
// Shouldn't be called here really
EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT))).Times(1);
idle_for(TAPPING_TERM);
}
24 changes: 24 additions & 0 deletions tests/test_common/test_common.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/* 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 "gtest/gtest.h"
#include "gmock/gmock.h"

#include "quantum.h"
#include "test_driver.h"
#include "test_matrix.h"
#include "keyboard_report_util.h"
#include "test_fixture.h"
23 changes: 19 additions & 4 deletions tests/test_common/test_fixture.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
#include "test_driver.h"
#include "test_matrix.h"
#include "keyboard.h"
#include "action.h"
#include "action_tapping.h"

extern "C" {
void set_time(uint32_t t);
void advance_time(uint32_t ms);
}

using testing::_;
using testing::AnyNumber;
Expand All @@ -25,12 +32,20 @@ TestFixture::~TestFixture() {
TestDriver driver;
clear_all_keys();
// Run for a while to make sure all keys are completely released
// Should probably wait until tapping term etc, has timed out
EXPECT_CALL(driver, send_keyboard_mock(_)).Times(AnyNumber());
for (int i=0; i<100; i++) {
keyboard_task();
}
idle_for(TAPPING_TERM + 10);
testing::Mock::VerifyAndClearExpectations(&driver);
// Verify that the matrix really is cleared
EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(Between(0, 1));
}

void TestFixture::run_one_scan_loop() {
keyboard_task();
advance_time(1);
}

void TestFixture::idle_for(uint time) {
for (uint i=0; i<time; i++) {
run_one_scan_loop();
}
}
2 changes: 2 additions & 0 deletions tests/test_common/test_fixture.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,6 @@ class TestFixture : public testing::Test {
static void SetUpTestCase();
static void TearDownTestCase();

void run_one_scan_loop();
void idle_for(uint ms);
};
17 changes: 9 additions & 8 deletions tmk_core/common/test/timer.c
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,16 @@

#include "timer.h"

// TODO: the timer should work, but at a much faster rate than realtime
// It should also have some kind of integration with the testing system
static uint32_t current_time = 0;

void timer_init(void) {}
void timer_init(void) {current_time = 0;}

void timer_clear(void) {}
void timer_clear(void) {current_time = 0;}

uint16_t timer_read(void) { return 0; }
uint32_t timer_read32(void) { return 0; }
uint16_t timer_elapsed(uint16_t last) { return 0; }
uint32_t timer_elapsed32(uint32_t last) { return 0; }
uint16_t timer_read(void) { return current_time & 0xFFFF; }
uint32_t timer_read32(void) { return current_time; }
uint16_t timer_elapsed(uint16_t last) { return TIMER_DIFF_16(timer_read(), last); }
uint32_t timer_elapsed32(uint32_t last) { return TIMER_DIFF_32(timer_read32(), last); }

void set_time(uint32_t t) { current_time = t; }
void advance_time(uint32_t ms) { current_time += ms; }

0 comments on commit 4e69a8b

Please sign in to comment.