Add NETWORKLESS_TEST_SCRIPT type to NetworkManager.

This is a slightly hacky way to make ScriptManager work without any
networking, and minimize the number of dependencies needed to run
a test.

libraries/script-engine/src/ScriptManager.cpp

@@ -269,6 +269,9 @@ ScriptManager::ScriptManager(Context context, const QString& scriptContents, con
         case Context::AGENT_SCRIPT:
             _type = Type::AGENT;
             break;
+        case Context::NETWORKLESS_TEST_SCRIPT:
+            _type = Type::NETWORKLESS_TEST;
+            break;
     }
 
     _scriptingInterface = std::make_shared<ScriptManagerScriptingInterface>(this);
@@ -321,6 +324,8 @@ QString ScriptManager::getContext() const {
             return "entity_server";
         case AGENT_SCRIPT:
             return "agent";
+        case NETWORKLESS_TEST_SCRIPT:
+            return "networkless_test";
         default:
             return "unknown";
     }
@@ -664,15 +669,25 @@ void ScriptManager::init() {
     }
 
     _isInitialized = true;
-    runStaticInitializers(this);
+
+    if (_context != NETWORKLESS_TEST_SCRIPT) {
+        // This initializes a bunch of systems that want network access. We
+        // want to avoid it in test script mode.
+        runStaticInitializers(this);
+    }
 
     auto scriptEngine = _engine.get();
 
-    ScriptValue xmlHttpRequestConstructorValue = scriptEngine->newFunction(XMLHttpRequestClass::constructor);
-    scriptEngine->globalObject().setProperty("XMLHttpRequest", xmlHttpRequestConstructorValue);
+    if (_context != NETWORKLESS_TEST_SCRIPT) {
+        // For test scripts we want to minimize the amount of functionality available, for the least
+        // amount of dependencies and faster test system startup.
 
-    ScriptValue webSocketConstructorValue = scriptEngine->newFunction(WebSocketClass::constructor);
-    scriptEngine->globalObject().setProperty("WebSocket", webSocketConstructorValue);
+        ScriptValue xmlHttpRequestConstructorValue = scriptEngine->newFunction(XMLHttpRequestClass::constructor);
+        scriptEngine->globalObject().setProperty("XMLHttpRequest", xmlHttpRequestConstructorValue);
+
+        ScriptValue webSocketConstructorValue = scriptEngine->newFunction(WebSocketClass::constructor);
+        scriptEngine->globalObject().setProperty("WebSocket", webSocketConstructorValue);
+    }
 
     /*@jsdoc
      * Prints a message to the program log and emits {@link Script.printedMessage}.
@@ -703,7 +718,12 @@ void ScriptManager::init() {
     scriptEngine->registerGlobalObject("Vec3", &_vec3Library);
     scriptEngine->registerGlobalObject("Mat4", &_mat4Library);
     scriptEngine->registerGlobalObject("Uuid", &_uuidLibrary);
-    scriptEngine->registerGlobalObject("Messages", DependencyManager::get<MessagesClient>().data());
+
+    if (_context != NETWORKLESS_TEST_SCRIPT) {
+        // This requires networking, we want to avoid the need for it in test scripts
+        scriptEngine->registerGlobalObject("Messages", DependencyManager::get<MessagesClient>().data());
+    }
+
     scriptEngine->registerGlobalObject("File", new FileScriptingInterface(this));
     scriptEngine->registerGlobalObject("console", &_consoleScriptingInterface);
     scriptEngine->registerFunction("console", "info", ConsoleScriptingInterface::info, scriptEngine->currentContext()->argumentCount());
@@ -717,25 +737,28 @@ void ScriptManager::init() {
     scriptEngine->registerFunction("console", "groupCollapsed", ConsoleScriptingInterface::groupCollapsed, 1);
     scriptEngine->registerFunction("console", "groupEnd", ConsoleScriptingInterface::groupEnd, 0);
 
-    // Scriptable cache access
-    auto resourcePrototype = createScriptableResourcePrototype(shared_from_this());
-    scriptEngine->globalObject().setProperty("Resource", resourcePrototype);
-    scriptEngine->setDefaultPrototype(qMetaTypeId<ScriptableResource*>(), resourcePrototype);
-
     // constants
     scriptEngine->globalObject().setProperty("TREE_SCALE", scriptEngine->newValue(TREE_SCALE));
 
-    scriptEngine->registerGlobalObject("Assets", _assetScriptingInterface);
-    scriptEngine->registerGlobalObject("Resources", DependencyManager::get<ResourceScriptingInterface>().data());
+    if (_context != NETWORKLESS_TEST_SCRIPT) {
+        // Scriptable cache access
+        auto resourcePrototype = createScriptableResourcePrototype(shared_from_this());
+        scriptEngine->globalObject().setProperty("Resource", resourcePrototype);
+        scriptEngine->setDefaultPrototype(qMetaTypeId<ScriptableResource*>(), resourcePrototype);
 
-    scriptEngine->registerGlobalObject("DebugDraw", &DebugDraw::getInstance());
+        scriptEngine->registerGlobalObject("Assets", _assetScriptingInterface);
+        scriptEngine->registerGlobalObject("Resources", DependencyManager::get<ResourceScriptingInterface>().data());
 
-    scriptEngine->registerGlobalObject("UserActivityLogger", DependencyManager::get<UserActivityLoggerScriptingInterface>().data());
+        scriptEngine->registerGlobalObject("DebugDraw", &DebugDraw::getInstance());
+
+        scriptEngine->registerGlobalObject("UserActivityLogger", DependencyManager::get<UserActivityLoggerScriptingInterface>().data());
+    }
 
 #if DEV_BUILD || PR_BUILD
     scriptEngine->registerGlobalObject("StackTest", new StackTestScriptingInterface(this));
 #endif
 
+    qCDebug(scriptengine) << "Engine initialized";
 }
 
 // registers a global object by name
@@ -820,6 +843,10 @@ void ScriptManager::addEventHandler(const EntityItemID& entityID, const QString&
 }
 
 bool ScriptManager::isStopped() const {
+    if (_context == NETWORKLESS_TEST_SCRIPT) {
+        return false;
+    }
+
     QSharedPointer<ScriptEngines> scriptEngines(_scriptEngines);
     return !scriptEngines || scriptEngines->isStopped();
 }
@@ -841,6 +868,7 @@ void ScriptManager::run() {
     PROFILE_SET_THREAD_NAME("Script: " + name);
 
     if (isStopped()) {
+        qCCritical(scriptengine) << "ScriptManager is stopped or ScriptEngines is not available, refusing to run script";
         return; // bail early - avoid setting state in init(), as evaluate() will bail too
     }
 
@@ -873,8 +901,12 @@ void ScriptManager::run() {
 
     std::chrono::microseconds totalUpdates(0);
 
+    qCDebug(scriptengine) << "Waiting for finish";
+
     // TODO: Integrate this with signals/slots instead of reimplementing throttling for ScriptManager
     while (!_isFinished) {
+        qCDebug(scriptengine) << "In script event loop";
+
         auto beforeSleep = clock::now();
 
         // Throttle to SCRIPT_FPS

libraries/script-engine/src/ScriptManager.h

@@ -243,6 +243,29 @@ public:
  * * Web access: XMLHttpRequest, WebSocket
  * * Other miscellaneous functionality.
  *
+ * Example:
+ *
+ * @code {.cpp}
+ * #include "ScriptManager.h"
+ *
+ * // Scripts only stop running when Script.stop() is called.
+ * // In the normal environment this isn't needed, but for things like unit tests we need
+ * // to use it to make the ScriptManager return from run().
+ *
+ * QString scriptSource = "print(\"Hello, world!\"); Script.stop(true);";
+ * QString scriptFilename = "test.js";
+ *
+ * ScriptManagerPointer sm = newScriptManager(ScriptManager::NETWORKLESS_TEST_SCRIPT, scriptSource, scriptFilename);
+ * connect(sm.get(), &ScriptManager::printedMessage, [](const QString& message, const QString& engineName){
+ *     qDebug() << "Printed message from engine" << engineName << ": " << message;
+ * });
+ *
+ * qInfo() << "Running script!";
+ * sm->run();
+ * qInfo() << "Done!"
+ * @endcode
+ *
+ *
  * @note
  * Technically, the ScriptManager isn't generic enough -- it implements things that imitate
  * Node.js for examine in the module loading code, which makes it JS specific. This code
@@ -291,7 +314,20 @@ public:
          * @brief Agent script
          *
          */
-        AGENT_SCRIPT
+        AGENT_SCRIPT,
+
+        /**
+         * @brief Network-less test system context.
+         * This is used for the QTest self-tests, and minimizes the API that is made available to
+         * the running script. It removes the need for network access, which makes for much faster
+         * test execution.
+         *
+         *
+         * @warning This is a development-targeted bit of functionality.
+         *
+         * @warning This is going to break functionality like loadURL and require
+         */
+        NETWORKLESS_TEST_SCRIPT
     };
 
     /**
@@ -328,7 +364,18 @@ public:
          * @brief Avatar script
          *
          */
-        AVATAR
+        AVATAR,
+
+        /**
+         * @brief Test system script
+         *
+         * This is used for the QTest self-tests, and minimizes the API that is made available to
+         * the running script. It removes the need for network access, which makes for much faster
+         * test execution.
+         *
+         * @warning This is a development-targeted bit of functionality.
+         */
+        NETWORKLESS_TEST
     };
     Q_ENUM(Type);
 
@@ -368,8 +415,9 @@ public:
     void runInThread();
 
     /**
-     * @brief Run the script in the caller's thread, exit when stop() is called.
+     * @brief Run the script in the caller's thread, exit when Script.stop() is called.
      *
+     * Most scripts never stop running, so this function will never return for them.
      */
     void run();
 

tests/script-engine/src/ScriptEngineTests.cpp

@@ -1,5 +1,8 @@
 #include <QSignalSpy>
 #include <QDebug>
+#include <QFile>
+#include <QTextStream>
+
 
 #include "ScriptEngineTests.h"
 #include "DependencyManager.h"
@@ -7,6 +10,8 @@
 #include "ScriptEngines.h"
 #include "ScriptEngine.h"
 #include "ScriptCache.h"
+#include "ScriptManager.h"
+
 #include "ResourceManager.h"
 #include "ResourceRequestObserver.h"
 #include "StatTracker.h"
@@ -18,34 +23,21 @@
 QTEST_MAIN(ScriptEngineTests)
 
 
-// script factory generates scriptmanager -- singleton
-//
-// default scripts -- all in one thread, but chat spawns a separate thread
-// // https://apidocs.overte.org/Script.html#.executeOnScriptThread
-//
-// scriptmanager
-// every thread has a manager, and its own engine
-// provides non-qt interface?
-//
-// special threads for entity scripts -- 12 (fixed? dynamic?)
-
-
-
 
 void ScriptEngineTests::initTestCase() {
     // AudioClient starts networking, but for the purposes of the tests here we don't care,
     // so just got to use some port.
-    int listenPort = 10000;
+    //int listenPort = 10000;
 
-    DependencyManager::registerInheritance<LimitedNodeList, NodeList>();
-    DependencyManager::set<NodeList>(NodeType::Agent, listenPort);
-    DependencyManager::set<ScriptEngines>(ScriptManager::CLIENT_SCRIPT, QUrl(""));
+    //DependencyManager::registerInheritance<LimitedNodeList, NodeList>();
+    //DependencyManager::set<NodeList>(NodeType::Agent, listenPort);
+    DependencyManager::set<ScriptEngines>(ScriptManager::NETWORKLESS_TEST_SCRIPT, QUrl(""));
     DependencyManager::set<ScriptCache>();
-    DependencyManager::set<ResourceManager>();
-    DependencyManager::set<ResourceRequestObserver>();
+   // DependencyManager::set<ResourceManager>();
+   // DependencyManager::set<ResourceRequestObserver>();
     DependencyManager::set<StatTracker>();
     DependencyManager::set<ScriptInitializers>();
-    DependencyManager::set<EntityScriptingInterface>(true);
+   // DependencyManager::set<EntityScriptingInterface>(true);
 
     QSharedPointer<ScriptEngines> ac = DependencyManager::get<ScriptEngines>();
     QVERIFY(!ac.isNull());
@@ -77,31 +69,71 @@ void ScriptEngineTests::scriptTest() {
     QSharedPointer<ScriptEngines> ac = DependencyManager::get<ScriptEngines>();
     QVERIFY(!ac.isNull());
 
-    // TODO: can we execute test scripts in serial way rather than parallel
-    /*QDir testScriptsDir("tests");
+
+    QDir testScriptsDir("tests");
     QStringList testScripts = testScriptsDir.entryList(QStringList() << "*.js", QDir::Files);
     testScripts.sort();
 
-    for(QString script : testScripts) {
-        script = "tests/" + script;
-        qInfo() << "Running test script: " << script;
-        ac->loadOneScript(script);
-    }*/
-    //ac->loadOneScript("tests/003_vector_math.js");
-    ac->loadOneScript("tests/005_include.js");
+    for(QString scriptFilename : testScripts) {
+        scriptFilename = "tests/" + scriptFilename;
+        qInfo() << "Running test script: " << scriptFilename;
 
-    qDebug() << ac->getRunning();
+        QString scriptSource;
 
-    // TODO: if I don't have infinite loop here, it exits before scripts finish. It also reports: QSignalSpy: No such signal: 'scriptCountChanged'
-    for (int n = 0; n > -1; n++) {
-        QSignalSpy spy(ac.get(), SIGNAL(scriptCountChanged));
-        spy.wait(100000);
-        qDebug() << "Signal happened";
+        {
+            QFile scriptFile(scriptFilename);
+            scriptFile.open(QIODevice::ReadOnly);
+            QTextStream scriptStream(&scriptFile);
+            scriptSource.append(scriptStream.readAll());
+
+            // Scripts keep on running until Script.stop() is called. For our tests here,
+            // that's not desirable, so we append an automatic stop at the end of every
+            // script.
+            scriptSource.append("\nScript.stop(true);\n");
+        }
+
+
+        //qDebug() << "Source: " << scriptSource;
+
+        ScriptManagerPointer sm = newScriptManager(ScriptManager::NETWORKLESS_TEST_SCRIPT, scriptSource, scriptFilename);
+
+
+        connect(sm.get(), &ScriptManager::scriptLoaded, [](const QString& filename){
+            qWarning() << "Loaded script" << filename;
+        });
+
+
+        connect(sm.get(), &ScriptManager::errorLoadingScript, [](const QString& filename){
+            qWarning() << "Failed to load script" << filename;
+        });
+
+        connect(sm.get(), &ScriptManager::printedMessage, [](const QString& message, const QString& engineName){
+            qDebug() << "Printed message from engine" << engineName << ": " << message;
+        });
+
+        connect(sm.get(), &ScriptManager::infoMessage, [](const QString& message, const QString& engineName){
+            qInfo() << "Info message from engine" << engineName << ": " << message;
+        });
+
+        connect(sm.get(), &ScriptManager::warningMessage, [](const QString& message, const QString& engineName){
+            qWarning() << "Warning from engine" << engineName << ": " << message;
+        });
+
+        connect(sm.get(), &ScriptManager::errorMessage, [](const QString& message, const QString& engineName){
+            qCritical() << "Error from engine" << engineName << ": " << message;
+        });
+
+        connect(sm.get(), &ScriptManager::finished, [](const QString& fileNameString, ScriptManagerPointer smp){
+            qInfo() << "Finished running script" << fileNameString;
+        });
+
+        connect(sm.get(), &ScriptManager::runningStateChanged, [sm](){
+            qInfo() << "Running state changed. Running = " << sm->isRunning() << "; Stopped = " << sm->isStopped() << "; Finished = " << sm->isFinished();
+        });
+
+
+        sm->run();
     }
-    //spy.wait(5000);
-    //ac->shutdownScripting();
-
-
 
     //TODO: Add a test for Script.require(JSON)
 }