qpcpp/examples/qutest/self_test/test_qutest.cpp

/// @file
/// @brief Fixture for QUTEST self-test
/// @ingroup qs
/// @cond
///***************************************************************************
/// Last updated for version 5.9.0
/// Last updated on  2017-05-12
///
///                    Q u a n t u m     L e a P s
///                    ---------------------------
///                    innovating embedded systems
///
/// Copyright (C) 2005-2017 Quantum Leaps, LLC. All rights reserved.
///
/// This program is open source 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 3 of the License, or
/// (at your option) any later version.
///
/// Alternatively, this program may be distributed and modified under the
/// terms of Quantum Leaps commercial licenses, which expressly supersede
/// the GNU General Public License and are specifically designed for
/// licensees interested in retaining the proprietary status of their code.
///
/// 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/>.
///
/// Contact information:
/// https://state-machine.com
/// mailto:info@state-machine.com
///***************************************************************************
/// @endcond

#include "qpcpp.h" // for QUTEST

using namespace QP;

Q_DEFINE_THIS_FILE

//----------------------------------------------------------------------------
static uint8_t buffer[100];
static uint32_t myFun(void);

enum {
    ON_RESET_TESTS = QS_USER,
    ON_TEST_SETUP,
    ON_TEST_TEARDOWN,
    COMMAND_X,
    MY_RECORD,
};

//----------------------------------------------------------------------------
int main(int argc, char *argv[]) {
    QF::init();  // initialize the framework and the underlying RT kernel
    Q_ALLEGE(QS_INIT(argc <= 1 ? (void *)0 : argv[1]));

    // global filter
    QS_FILTER_ON(QS_ALL_RECORDS); // enable all maskable filters

    // dictionaries...
    QS_OBJ_DICTIONARY(buffer);
    QS_FUN_DICTIONARY(&myFun);

    QS_USR_DICTIONARY(ON_TEST_SETUP);
    QS_USR_DICTIONARY(ON_TEST_TEARDOWN);
    QS_USR_DICTIONARY(COMMAND_X);

    return QF::run(); // run the tests
}

//----------------------------------------------------------------------------
void QS::onTestSetup(void) {
    QS_BEGIN(ON_TEST_SETUP, (void *)0)
    QS_END()
}
//............................................................................
void QS::onTestTeardown(void) {
    QS_BEGIN(ON_TEST_TEARDOWN, (void *)0)
    QS_END()
}

//............................................................................
//! callback function to execute user commands
void QS::onCommand(uint8_t cmdId,   uint32_t param1,
                   uint32_t param2, uint32_t param3)
{
    (void)param1;
    (void)param2;
    (void)param3;

    switch (cmdId) {
        case COMMAND_X: {
            uint32_t x = myFun();
            QS_BEGIN(COMMAND_X, (void *)0) // application-specific record
                QS_U32(0, x);
                // ...
            QS_END()
            break;
        }
        default:
            break;
    }
}

//............................................................................
//! callback function to "massage" the injected QP events (not used here)
void QS::onTestEvt(QEvt *e) {
    (void)e;
}

//----------------------------------------------------------------------------
static uint32_t myFun(void) {
    QS_TEST_PROBE_DEF(&myFun)
    QS_TEST_PROBE(
        return qs_tp_;
    )
    return 0;
}