AutomatedTesting.h

Go to the documentation of this file.

#pragma once
#include <NDEVR/RibbonSubGroup.h>
#include <NDEVR/QTWindowManager.h>
#include <NDEVR/File.h>
#include <QWidget>
namespace NDEVR
{
    class AutomatedTestingDialog;
    class WindowManager;
 
    /**--------------------------------------------------------------------------------------------------
    \brief base class for performing a test for easily testing certain software functionality
 
    **/
    class AutomatedTest
    {
    public:
        String icon;
        TranslatedString name;
        virtual bool performTest(AutomatedTestingDialog*) = 0;
        virtual void stopTest() = 0;
        std::function<void()> on_test_completed;
        bool is_looped_test = false;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A type of AutomatedTest that repeatedly loops until stopped by the user.
 
    **/
    class NDEVR_API LoopedAutomatedTest : public AutomatedTest
    {
    public:
        LoopedAutomatedTest(const std::function<void(uint04 step_index, AutomatedTestingDialog* dialog)>& test_step);
        bool performTest(AutomatedTestingDialog* dialog);
        void stopTest();
        uint04 testStepIndex() const { return m_step_index; }
    protected:
        std::function<void(uint04 step_index, AutomatedTestingDialog* dialog)> m_on_test;
        QTimer* m_test_timer;
        AutomatedTestingDialog* m_dialog = nullptr;
        uint04 m_step_index = 0;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Provides an AutomatedTest for repeatedly creating and destroying Projects
 
    **/
    class NDEVR_API NewProjectTest : public LoopedAutomatedTest
    {
    public:
        NewProjectTest(WindowManager* manager);
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Provides an AutomatedTest for repeatedly opening and closing a Project
 
    **/
    class NDEVR_API OpenCloseTest : public LoopedAutomatedTest
    {
    public:
        OpenCloseTest(WindowManager* manager);
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Provides an AutomatedTest for grabbing network information.
 
    **/
    class NDEVR_API GrabNetworkInfo : public AutomatedTest
    {
    public:
        GrabNetworkInfo(WindowManager* manager);
        bool performTest(AutomatedTestingDialog* dialog);
        void stopTest();
    };
    class Connection;
    /**--------------------------------------------------------------------------------------------------
    \brief Gives user information and allows execution for all registered automated testing.
 
    **/
    class NDEVR_API AutomatedTestingDialog : public RibbonSubGroup
    {
    public:
        AutomatedTestingDialog(QWidget* parent = nullptr);
        void chooseTestFolder();
        void addTest(AutomatedTest* test);
        static void AddTest(AutomatedTest* test);
        File testFolder() const;
    protected:
        File m_test_folder;
        Buffer<AutomatedTest*> m_automated_tests;
    protected:
        static Buffer<AutomatedTest*> s_application_tests;
    };
}