~ruther/qmk_firmware

6d222b71c6de320097e3dd25ef3f2783da0d638f — leep-frog 11 months ago 8c05254
Add housekeeping execution to unit tests (#22999)

A tests/housekeeping/config.h => tests/housekeeping/config.h +19 -0
@@ 0,0 1,19 @@
/* Copyright 2024 leep-frog
 *
 * 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"

A tests/housekeeping/test.mk => tests/housekeeping/test.mk +18 -0
@@ 0,0 1,18 @@
# Copyright 2024 leep-frog
#
# 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/>.

# --------------------------------------------------------------------------------
# Keep this file, even if it is empty, as a marker that this folder contains tests
# --------------------------------------------------------------------------------

A tests/housekeeping/test_housekeeping.cpp => tests/housekeeping/test_housekeeping.cpp +68 -0
@@ 0,0 1,68 @@
/* Copyright 2024 leep-frog
 *
 * 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 "action_tapping.h"
#include "test_keymap_key.hpp"

using testing::_;

class HousekeepingMock {
   public:
    virtual ~HousekeepingMock() {}

    // mock methods
    MOCK_METHOD0(housekeeping_task_kb, void(void));
    MOCK_METHOD0(housekeeping_task_user, void(void));
};

class Housekeeping : public TestFixture {
   public:
    Housekeeping() {
        _housekeepingMock.reset(new ::testing::NiceMock<HousekeepingMock>());
    }
    virtual ~Housekeeping() {
        _housekeepingMock.reset();
    }

    static std::unique_ptr<HousekeepingMock> _housekeepingMock;
};

std::unique_ptr<HousekeepingMock> Housekeeping::_housekeepingMock;

extern "C" {
void housekeeping_task_kb(void) {
    if (Housekeeping::_housekeepingMock) {
        Housekeeping::_housekeepingMock->housekeeping_task_kb();
    }
}

void housekeeping_task_user(void) {
    if (Housekeeping::_housekeepingMock) {
        Housekeeping::_housekeepingMock->housekeeping_task_user();
    }
}
}

TEST_F(Housekeeping, Works) {
    TestDriver driver;

    EXPECT_CALL(*_housekeepingMock, housekeeping_task_kb()).Times(1);
    EXPECT_CALL(*_housekeepingMock, housekeeping_task_user()).Times(1);
    run_one_scan_loop();
}

M tests/test_common/test_fixture.cpp => tests/test_common/test_fixture.cpp +3 -1
@@ 58,7 58,8 @@ void TestFixture::TearDownTestCase() {}
TestFixture::TestFixture() {
    m_this = this;
    timer_clear();
    test_logger.info() << "tapping term is " << +GET_TAPPING_TERM(KC_TRANSPARENT, &(keyrecord_t){}) << "ms" << std::endl;
    keyrecord_t empty_keyrecord = {0};
    test_logger.info() << "tapping term is " << +GET_TAPPING_TERM(KC_TRANSPARENT, &empty_keyrecord) << "ms" << std::endl;
}

TestFixture::~TestFixture() {


@@ 175,6 176,7 @@ void TestFixture::idle_for(unsigned time) {
    test_logger.trace() << +time << " keyboard task " << (time > 1 ? "loops" : "loop") << std::endl;
    for (unsigned i = 0; i < time; i++) {
        keyboard_task();
        housekeeping_task();
        advance_time(1);
    }
}

Do not follow this link