vrfMultiBackendTestRunner.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include <vrfQtProcessControl/vrfQtProcessControlDefines.h>
#include <vrfQtProcessControl/applicationExecutionManager.h>
#include <vlutil/vlTime.h>
#include <set>
#include <vrfLauncherQt/applicationSet.h>
#include <memory>
#include <QEventLoop>

class DtSimulationAddress;
class DtVrfRemoteController;
class DtSimMessage;
class DtConnectionSettings;

class DT_DLL_vrfqtprocesscontrol DtVrfMultiBackendTestRunner 
{
public:

   enum DtTickFailureType { Default, DtPredicateBreak, DtExecutionStateFailure, DtSpecificTimeoutFailure, DtGeneralTimeoutFailure };
   DtVrfMultiBackendTestRunner(std::shared_ptr<DtVrfRemoteController> controller, DtTime ioPeriod, DtTime backendTimeout, DtTime scenarioLoadTimeout, DtTime scenarioRunTimeout, DtTime backendShutdownTimeout, std::ostream& ostream = std::cout);

   void init(const std::set<DtSimulationAddress>& backendAddresses, DtConnectionSettings* connection, const DtApplicationSet& application, const std::string& scenario);
   void reset();
   void run();

   void setTestLog(const std::string& testLog);
   static void saveTestResults(int status, const std::string& testLog, const std::string& scenario);
protected:
   void tick(std::function<bool()> predicate, const std::string& predicateErrorString, const double& specificTimeout);

   bool areBackendsStarted() const;
   bool haveBackendsLoadedScenario() const;
   void setTickState(const std::string& predicateSpecificErrorString);

   static void scenarioLoadedCallback(const DtSimulationAddress& simAddr, void* usr);
   void scenarioLoaded(const DtSimulationAddress& simAddr);

   static void testResultMessageReceivedCallback(DtSimMessage* msg, void* usr);
   void testResultMessageReceived(DtSimMessage* msg);
   std::string testLogFile() const;
   std::string scenarioFilename() const;
protected:
   std::shared_ptr<DtVrfRemoteController> myRemoteController;

   DtTime myOverallTimeout;
   DtTime myBackendStartupTimeout;
   DtTime myScenarioLoadTimeout;
   DtTime myScenarioRunTimeout;
   DtTime myBackendShutdownTimeout;

   DtTime myIoPeriod;
   std::set<DtSimulationAddress> myBackendAddresses;
   DtConnectionSettings* myConnectionSettings;
   DtApplicationSet myApplicationSettings;
   std::string myScenarioFile;

   bool myReceivedTestResult;
   int myTestResultStatus;
   DtString myTestResultReason;
   int myScenarioLoadedCount;
   bool myShouldExit;
   DtTickFailureType myTickState;

   DtClock myTimeoutTimer;
   QEventLoop myEventLoop;
   std::unique_ptr<DtApplicationExecutionManager> myExecutionManager;
   std::ostream& myDefaultOutput;
   std::string myTestLogFile;
   std::set<DtSimulationAddress> myBackendsLoaded;

};