python_test_helper.h

Go to the documentation of this file.

//=============================================================================================================
 
#ifndef PYTHON_TEST_HELPER_H
#define PYTHON_TEST_HELPER_H
 
//=============================================================================================================
// INCLUDES
//=============================================================================================================
 
#include "utils_global.h"
#include "python_runner.h"
 
//=============================================================================================================
// EIGEN INCLUDES
//=============================================================================================================
 
#include <Eigen/Core>
 
//=============================================================================================================
// QT INCLUDES
//=============================================================================================================
 
#include <QObject>
#include <QString>
#include <QStringList>
#include <QVariantMap>
 
//=============================================================================================================
// DEFINE NAMESPACE UTILSLIB
//=============================================================================================================
 
namespace UTILSLIB
{
 
//=============================================================================================================
 
//=============================================================================================================
#define GUARD_PYTHON(available, reason) \
    do { \
        if (!(available)) { \
            if (UTILSLIB::PythonTestHelper::isPythonRequired()) \
                QFAIL(qPrintable(QString("HARD FAIL (MNE_REQUIRE_PYTHON=true): %1").arg(reason))); \
            QSKIP(qPrintable(QString("SKIP: %1").arg(reason))); \
        } \
    } while (0)

#define GUARD_PYTHON_PACKAGE(helper, packageName) \
    GUARD_PYTHON((helper).hasPackage(packageName), \
                 QString("Python package '%1' not available").arg(packageName))
 
class UTILSSHARED_EXPORT PythonTestHelper
{
public:
    //=========================================================================================================
    PythonTestHelper();
 
    //=========================================================================================================
    bool isAvailable() const;
 
    //=========================================================================================================
    bool isPythonAvailable() const;
 
    //=========================================================================================================
    bool hasPackage(const QString& packageName) const;
 
    //=========================================================================================================
    PythonRunnerResult eval(const QString& code, int timeoutMs = 30000) const;
 
    //=========================================================================================================
    double evalDouble(const QString& code, bool* ok = nullptr, int timeoutMs = 30000) const;
 
    //=========================================================================================================
    Eigen::VectorXd evalVector(const QString& code, bool* ok = nullptr, int timeoutMs = 60000) const;
 
    //=========================================================================================================
    Eigen::MatrixXd evalMatrix(const QString& code, bool* ok = nullptr, int timeoutMs = 60000) const;
 
    //=========================================================================================================
    PythonRunnerResult runScript(const QString& scriptPath,
                                 const QStringList& args = {},
                                 int timeoutMs = 120000) const;
 
    //=========================================================================================================
    static QString testDataPath();
 
    //=========================================================================================================
    static bool isPythonRequired();
 
    //=========================================================================================================
    static bool writeMatrix(const QString& filePath, const Eigen::MatrixXd& mat);
 
    //=========================================================================================================
    static Eigen::MatrixXd readMatrix(const QString& filePath, bool* ok = nullptr);
 
    //=========================================================================================================
    Eigen::MatrixXd evalMatrixViaFile(const QString& code,
                                       const QString& outputFilePath,
                                       bool* ok = nullptr,
                                       int timeoutMs = 120000) const;
 
private:
    mutable PythonRunner m_runner;  
};
 
} // namespace UTILSLIB
 
#endif // PYTHON_TEST_HELPER_H