ResInsight/ApplicationLibCode/Application/Tools/RiaRegressionTestRunner.h

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2018-     Equinor ASA
//
//  ResInsight 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 3 of the License, or
//  (at your option) any later version.
//
//  ResInsight 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 at <http://www.gnu.org/licenses/gpl.html>
//  for more details.
//
/////////////////////////////////////////////////////////////////////////////////

#pragma once

#include "RiaRegressionTest.h"

#include <QFileInfo>
#include <QSize>
#include <QStringList>

class QDir;

//==================================================================================================
//
//==================================================================================================
class RiaRegressionTestRunner
{
public:
    static RiaRegressionTestRunner* instance();

    static void createSingleton();
    static void deleteSingleton();

    void executeRegressionTests( const QString& regressionTestPath, const QStringList& testFilter );
    void executeRegressionTests();

    bool isRunningRegressionTests() const;
    bool useOpenMPForGeometryCreation() const;

    RiaRegressionTest::PlotEngine overridePlotEngine() const;

    static void updateRegressionTest( const QString& testRootPath );

    static void setDefaultSnapshotSizeFor3dViews();
    static void setDefaultSnapshotSizeForPlotWindows();

private:
    RiaRegressionTestRunner();

    void runRegressionTest();

    bool findAndExecuteCommandFiles( const QDir&              testCaseFolder,
                                     const RiaRegressionTest& regressionTestConfig,
                                     const QString&           htmlReportFileName );

    QString generateHtmlReport( const QFileInfoList& folderList,
                                const QString&       baseFolderName,
                                const QString&       generatedFolderName,
                                const QString&       diffFolderName,
                                const QDir&          testDir );

    static void    removeDirectoryWithContent( QDir& dirToDelete );
    static QSize   regressionDefaultImageSize();
    static QString diff2htmlHeaderText( const QString& testRootPath );
    QFileInfoList  subDirectoriesForTestExecution( const QDir& directory );

private:
    QString           m_rootPath;
    QStringList       m_testFilter;
    bool              m_appendAllTestsAfterLastItemInFilter;
    bool              m_runningRegressionTests;
    RiaRegressionTest m_regressionTestSettings;

    static RiaRegressionTestRunner* sm_singleton;
};