summaryrefslogtreecommitdiffstats
path: root/quantum/encoder/tests/encoder_tests_split.cpp
blob: 25e52c83f9d6aa83ebb0c5c342175d77bf6fc333 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/* 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 uidx = 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[uidx % 32] = {index, clockwise};
    uidx++;
    return true;
}

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

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

TEST_F(EncoderTest, TestInitLeft) {
    isLeftHand = true;
    encoder_init();
    EXPECT_EQ(pinIsInputHigh[0], true);
    EXPECT_EQ(pinIsInputHigh[1], true);
    EXPECT_EQ(pinIsInputHigh[2], false);
    EXPECT_EQ(pinIsInputHigh[3], false);
    EXPECT_EQ(uidx, 0);
}

TEST_F(EncoderTest, TestInitRight) {
    isLeftHand = false;
    encoder_init();
    EXPECT_EQ(pinIsInputHigh[0], false);
    EXPECT_EQ(pinIsInputHigh[1], false);
    EXPECT_EQ(pinIsInputHigh[2], true);
    EXPECT_EQ(pinIsInputHigh[3], true);
    EXPECT_EQ(uidx, 0);
}

TEST_F(EncoderTest, 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(uidx, 1);
    EXPECT_EQ(updates[0].index, 0);
    EXPECT_EQ(updates[0].clockwise, true);
}

TEST_F(EncoderTest, 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[2] = {0};
    encoder_state_raw(slave_state);

    EXPECT_EQ((int8_t)slave_state[0], -1);
}

/* this test will not work after the previous test.
 * this is due to encoder_value[1] already being set to -1 when simulating the right half.
 * When we now receive this update acting as the left half, there is no change.
 * This is hard to mock, as the static values inside encoder.c normally exist twice, once on each half,
 * but here, they only exist once.
 */

// TEST_F(EncoderTest, TestOneClockwiseRightReceived) {
//     isLeftHand = true;
//     encoder_init();

//     uint8_t slave_state[2] = {255, 0};
//     encoder_update_raw(slave_state);

//     EXPECT_EQ(uidx, 1);
//     EXPECT_EQ(updates[0].index, 1);
//     EXPECT_EQ(updates[0].clockwise, true);
// }

TEST_F(EncoderTest, TestOneCounterClockwiseRightReceived) {
    isLeftHand = true;
    encoder_init();

    uint8_t slave_state[2] = {0, 0};
    encoder_update_raw(slave_state);

    EXPECT_EQ(uidx, 1);
    EXPECT_EQ(updates[0].index, 1);
    EXPECT_EQ(updates[0].clockwise, false);
}