Skip to content

Commit

Permalink
Start working out no-encoder testcases.
Browse files Browse the repository at this point in the history
  • Loading branch information
tzarc committed Feb 4, 2022
1 parent a064241 commit d804133
Show file tree
Hide file tree
Showing 9 changed files with 320 additions and 7 deletions.
26 changes: 26 additions & 0 deletions quantum/encoder/tests/config_mock_split_no_left.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Copyright 2022 Nick Brassel (@tzarc)
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once

#define MATRIX_ROWS 1
#define MATRIX_COLS 1

/* Here, "pins" from 0 to 31 are allowed. */
#define ENCODERS_PAD_A \
{ }
#define ENCODERS_PAD_B \
{ }
#define ENCODERS_PAD_A_RIGHT \
{ 0, 2 }
#define ENCODERS_PAD_B_RIGHT \
{ 1, 3 }

#ifdef __cplusplus
extern "C" {
#endif

#include "mock_split.h"

#ifdef __cplusplus
};
#endif
26 changes: 26 additions & 0 deletions quantum/encoder/tests/config_mock_split_no_right.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Copyright 2022 Nick Brassel (@tzarc)
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once

#define MATRIX_ROWS 1
#define MATRIX_COLS 1

/* Here, "pins" from 0 to 31 are allowed. */
#define ENCODERS_PAD_A \
{ 0, 2 }
#define ENCODERS_PAD_B \
{ 1, 3 }
#define ENCODERS_PAD_A_RIGHT \
{ }
#define ENCODERS_PAD_B_RIGHT \
{ }

#ifdef __cplusplus
extern "C" {
#endif

#include "mock_split.h"

#ifdef __cplusplus
};
#endif
4 changes: 2 additions & 2 deletions quantum/encoder/tests/encoder_tests_split_left_eq_right.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ TEST_F(EncoderSplitTestLeftEqRight, TestOneClockwiseRightSent) {
setAndRead(6, true);
setAndRead(7, true);

uint8_t slave_state[NUM_ENCODERS_RIGHT] = {0};
uint8_t slave_state[32] = {0};
encoder_state_raw(slave_state);

EXPECT_EQ(slave_state[0], 0);
Expand All @@ -124,7 +124,7 @@ TEST_F(EncoderSplitTestLeftEqRight, TestMultipleEncodersRightReceived) {
isLeftHand = true;
encoder_init();

uint8_t slave_state[NUM_ENCODERS_RIGHT] = {1, 0xFF}; // First right encoder is CCW, Second right encoder CW
uint8_t slave_state[32] = {1, 0xFF}; // First right encoder is CCW, Second right encoder CW
encoder_update_raw(slave_state);

EXPECT_EQ(updates_array_idx, 2); // two updates received, one for each changed item on the right side
Expand Down
4 changes: 2 additions & 2 deletions quantum/encoder/tests/encoder_tests_split_left_gt_right.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ TEST_F(EncoderSplitTestLeftGreaterThanRight, TestOneClockwiseRightSent) {
setAndRead(6, true);
setAndRead(7, true);

uint8_t slave_state[NUM_ENCODERS_RIGHT] = {0};
uint8_t slave_state[32] = {0};
encoder_state_raw(slave_state);

EXPECT_EQ(slave_state[0], 0xFF);
Expand All @@ -128,7 +128,7 @@ TEST_F(EncoderSplitTestLeftGreaterThanRight, TestMultipleEncodersRightReceived)
isLeftHand = true;
encoder_init();

uint8_t slave_state[NUM_ENCODERS_RIGHT] = {1, 0xFF}; // First right encoder is CCW, Second right encoder no change, third right encoder CW
uint8_t slave_state[32] = {1, 0xFF}; // First right encoder is CCW, Second right encoder no change, third right encoder CW
encoder_update_raw(slave_state);

EXPECT_EQ(updates_array_idx, 2); // two updates received, one for each changed item on the right side
Expand Down
4 changes: 2 additions & 2 deletions quantum/encoder/tests/encoder_tests_split_left_lt_right.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ TEST_F(EncoderSplitTestLeftLessThanRight, TestOneClockwiseRightSent) {
setAndRead(6, true);
setAndRead(7, true);

uint8_t slave_state[NUM_ENCODERS_RIGHT] = {0};
uint8_t slave_state[32] = {0};
encoder_state_raw(slave_state);

EXPECT_EQ(slave_state[0], 0);
Expand All @@ -128,7 +128,7 @@ TEST_F(EncoderSplitTestLeftLessThanRight, TestMultipleEncodersRightReceived) {
isLeftHand = true;
encoder_init();

uint8_t slave_state[NUM_ENCODERS_RIGHT] = {1, 0, 0xFF}; // First right encoder is CCW, Second right encoder no change, third right encoder CW
uint8_t slave_state[32] = {1, 0, 0xFF}; // First right encoder is CCW, Second right encoder no change, third right encoder CW
encoder_update_raw(slave_state);

EXPECT_EQ(updates_array_idx, 2); // two updates received, one for each changed item on the right side
Expand Down
125 changes: 125 additions & 0 deletions quantum/encoder/tests/encoder_tests_split_no_left.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
/* Copyright 2021 Balz Guenat
*
* 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 <vector>
#include <algorithm>
#include <stdio.h>

extern "C" {
#include "encoder.h"
#include "encoder/tests/mock_split.h"
}

struct update {
int8_t index;
bool clockwise;
};

uint8_t updates_array_idx = 0;
update updates[32];

bool isLeftHand;

bool encoder_update_kb(uint8_t index, bool clockwise) {
if (!isLeftHand) {
// this method has no effect on slave half
printf("ignoring update on right hand (%d,%s)\n", index, clockwise ? "CW" : "CC");
return true;
}
updates[updates_array_idx % 32] = {index, clockwise};
updates_array_idx++;
return true;
}

bool setAndRead(pin_t pin, bool val) {
setPin(pin, val);
return encoder_read();
}

class EncoderSplitTestNoLeft : public ::testing::Test {
protected:
void SetUp() override {
updates_array_idx = 0;
for (int i = 0; i < 32; i++) {
pinIsInputHigh[i] = 0;
pins[i] = 0;
}
}
};

TEST_F(EncoderSplitTestNoLeft, TestInitLeft) {
isLeftHand = true;
encoder_init();
EXPECT_EQ(pinIsInputHigh[0], false);
EXPECT_EQ(pinIsInputHigh[1], false);
EXPECT_EQ(pinIsInputHigh[2], false);
EXPECT_EQ(pinIsInputHigh[3], false);
EXPECT_EQ(updates_array_idx, 0); // no updates received
}

TEST_F(EncoderSplitTestNoLeft, TestInitRight) {
isLeftHand = false;
encoder_init();
EXPECT_EQ(pinIsInputHigh[0], true);
EXPECT_EQ(pinIsInputHigh[1], true);
EXPECT_EQ(pinIsInputHigh[2], true);
EXPECT_EQ(pinIsInputHigh[3], true);
EXPECT_EQ(updates_array_idx, 0); // no updates received
}

TEST_F(EncoderSplitTestNoLeft, TestOneClockwiseLeft) {
isLeftHand = true;
encoder_init();
// send 4 pulses. with resolution 4, that's one step and we should get 1 update.
setAndRead(0, false);
setAndRead(1, false);
setAndRead(0, true);
setAndRead(1, true);

EXPECT_EQ(updates_array_idx, 0); // no updates received
}

TEST_F(EncoderSplitTestNoLeft, TestOneClockwiseRightSent) {
isLeftHand = false;
encoder_init();
// send 4 pulses. with resolution 4, that's one step and we should get 1 update.
setAndRead(2, false);
setAndRead(3, false);
setAndRead(2, true);
setAndRead(3, true);

uint8_t slave_state[32] = {0};
encoder_state_raw(slave_state);

EXPECT_EQ(slave_state[0], 0xFF);
EXPECT_EQ(slave_state[1], 0);
}

TEST_F(EncoderSplitTestNoLeft, TestMultipleEncodersRightReceived) {
isLeftHand = true;
encoder_init();

uint8_t slave_state[32] = {1, 0xFF}; // First right encoder is CCW, Second right encoder no change, third right encoder CW
encoder_update_raw(slave_state);

EXPECT_EQ(updates_array_idx, 2); // two updates received, one for each changed item on the right side
EXPECT_EQ(updates[0].index, 3);
EXPECT_EQ(updates[0].clockwise, false);
EXPECT_EQ(updates[1].index, 4);
EXPECT_EQ(updates[1].clockwise, true);
}
116 changes: 116 additions & 0 deletions quantum/encoder/tests/encoder_tests_split_no_right.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
/* Copyright 2021 Balz Guenat
*
* 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 <vector>
#include <algorithm>
#include <stdio.h>

extern "C" {
#include "encoder.h"
#include "encoder/tests/mock_split.h"
}

struct update {
int8_t index;
bool clockwise;
};

uint8_t updates_array_idx = 0;
update updates[32];

bool isLeftHand;

bool encoder_update_kb(uint8_t index, bool clockwise) {
if (!isLeftHand) {
// this method has no effect on slave half
printf("ignoring update on right hand (%d,%s)\n", index, clockwise ? "CW" : "CC");
return true;
}
updates[updates_array_idx % 32] = {index, clockwise};
updates_array_idx++;
return true;
}

bool setAndRead(pin_t pin, bool val) {
setPin(pin, val);
return encoder_read();
}

class EncoderSplitTestNoRight : public ::testing::Test {
protected:
void SetUp() override {
updates_array_idx = 0;
for (int i = 0; i < 32; i++) {
pinIsInputHigh[i] = 0;
pins[i] = 0;
}
}
};

TEST_F(EncoderSplitTestNoRight, TestInitLeft) {
isLeftHand = true;
encoder_init();
EXPECT_EQ(pinIsInputHigh[0], true);
EXPECT_EQ(pinIsInputHigh[1], true);
EXPECT_EQ(pinIsInputHigh[2], true);
EXPECT_EQ(pinIsInputHigh[3], true);
EXPECT_EQ(updates_array_idx, 0); // no updates received
}

TEST_F(EncoderSplitTestNoRight, TestInitRight) {
isLeftHand = false;
encoder_init();
EXPECT_EQ(pinIsInputHigh[0], false);
EXPECT_EQ(pinIsInputHigh[1], false);
EXPECT_EQ(pinIsInputHigh[2], false);
EXPECT_EQ(pinIsInputHigh[3], false);
EXPECT_EQ(updates_array_idx, 0); // no updates received
}

TEST_F(EncoderSplitTestNoRight, TestOneClockwiseLeft) {
isLeftHand = true;
encoder_init();
// send 4 pulses. with resolution 4, that's one step and we should get 1 update.
setAndRead(0, false);
setAndRead(1, false);
setAndRead(0, true);
setAndRead(1, true);

EXPECT_EQ(updates_array_idx, 0); // no updates received
}

TEST_F(EncoderSplitTestNoRight, TestOneClockwiseRightSent) {
isLeftHand = false;
encoder_init();

uint8_t slave_state[32] = {0xAA};
encoder_state_raw(slave_state);

EXPECT_EQ(slave_state[0], 0xAA);
EXPECT_EQ(slave_state[1], 0xAA);
}

TEST_F(EncoderSplitTestNoRight, TestMultipleEncodersRightReceived) {
isLeftHand = true;
encoder_init();

uint8_t slave_state[32] = {1, 0xFF}; // First right encoder is CCW, Second right encoder no change, third right encoder CW
encoder_update_raw(slave_state);

EXPECT_EQ(updates_array_idx, 0); // no updates received -- no right-hand encoders
}
18 changes: 18 additions & 0 deletions quantum/encoder/tests/rules.mk
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,21 @@ encoder_split_left_lt_right_SRC := \
$(QUANTUM_PATH)/encoder/tests/mock_split.c \
$(QUANTUM_PATH)/encoder/tests/encoder_tests_split_left_lt_right.cpp \
$(QUANTUM_PATH)/encoder.c

encoder_split_no_left_DEFS := -DENCODER_TESTS -DENCODER_ENABLE -DENCODER_MOCK_SPLIT
encoder_split_no_left_INC := $(QUANTUM_PATH)/split_common
encoder_split_no_left_CONFIG := $(QUANTUM_PATH)/encoder/tests/config_mock_split_no_left.h

encoder_split_no_left_SRC := \
$(QUANTUM_PATH)/encoder/tests/mock_split.c \
$(QUANTUM_PATH)/encoder/tests/encoder_tests_split_no_left.cpp \
$(QUANTUM_PATH)/encoder.c

encoder_split_no_right_DEFS := -DENCODER_TESTS -DENCODER_ENABLE -DENCODER_MOCK_SPLIT
encoder_split_no_right_INC := $(QUANTUM_PATH)/split_common
encoder_split_no_right_CONFIG := $(QUANTUM_PATH)/encoder/tests/config_mock_split_no_right.h

encoder_split_no_right_SRC := \
$(QUANTUM_PATH)/encoder/tests/mock_split.c \
$(QUANTUM_PATH)/encoder/tests/encoder_tests_split_no_right.cpp \
$(QUANTUM_PATH)/encoder.c
4 changes: 3 additions & 1 deletion quantum/encoder/tests/testlist.mk
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@ TEST_LIST += \
encoder \
encoder_split_left_eq_right \
encoder_split_left_gt_right \
encoder_split_left_lt_right
encoder_split_left_lt_right \
encoder_split_no_left \
encoder_split_no_right

0 comments on commit d804133

Please sign in to comment.