improved Editor capabilities

Author: Snooz82

public/pyworker/runRobot.py

@@ -10,22 +10,30 @@
 from importlib import import_module, reload
 from io import StringIO
 
+
+def log(message):
+    js.postMessage(json.dumps({"std_output": message}))
+
+
+requirements_list = json.loads(requirements)
+
 try:
     import robot
     from robot.libdocpkg import LibraryDocumentation
 except ImportError:
-    js.postMessage(json.dumps({"std_output": f"Install Robot Framework"}))
+    log(f"Install Robot Framework")
     rf_version = f"=={version}" if version else ""
     try:
-        await micropip.install(f"robotframework{rf_version}")
+        await micropip.install(requirements_list or f"robotframework{rf_version}")
         time.sleep(1)
         import robot
         from robot.libdocpkg import LibraryDocumentation
     except Exception as e:
         js.console.log(f"Robot Run Exception: {e}")
         js.console.log(traceback.format_exc())
-    js.postMessage(json.dumps({"std_output": f" = version {robot.__version__}\n"}))
-
+    log(f" = version {robot.__version__}\n")
+    if requirements_list:
+        log(f"Installed Requirements: {requirements_list}\n")
 
 os.chdir("/")
 dirname = "robot_files"
@@ -43,7 +51,7 @@ class Listener:
     ROBOT_LISTENER_API_VERSION = 2
 
     def _post_message(self):
-        js.postMessage(json.dumps({"std_output": sys.stdout.getvalue()}))
+        log(sys.stdout.getvalue())
         sys.__stdout__.truncate(0)
 
     def library_import(self, name, attrs):
@@ -90,6 +98,7 @@ def write_file(file):
             f.writelines(file["content"])
 
     file_list = json.loads(file_catalog)
+    robot_arguments = json.loads(robot_args)
 
     for file in file_list:
         write_file(file)
@@ -104,14 +113,13 @@ def write_file(file):
             kwargs = {}
             testcli = ""
 
-        js.postMessage(
-            json.dumps(
-                {
-                    "std_output": f"> robot --loglevel TRACE:INFO --exclude EXCL --skip SKIP\n"
-                    f"  --removekeywords tag:REMOVE --flattenkeywords tag:FLAT{testcli} .\n"
-                }
-            )
-        )
+        if robot_arguments:
+            log(f"Robot Run Arguments: {robot_args}\n")
+            log(f"\nRunning Robot Framework:\n")
+        else:
+            log(f"> robot --loglevel TRACE:INFO --exclude EXCL --skip SKIP\n"
+                f"  --removekeywords tag:REMOVE --flattenkeywords tag:FLAT{testcli} .\n")
+
         org_stdout = sys.__stdout__
         org_stderr = sys.__stderr__
         sys.stdout = sys.__stdout__ = StringIO()
@@ -124,19 +132,25 @@ def write_file(file):
                 js.console.log(f'reimporting: {file["fileName"]}')
                 m = import_module(file_name)
                 m = reload(m)
-
-        result = robot.run(
-            ".",
-            consolecolors="ansi",
-            listener=[Listener()],  # "RobotStackTracer",
-            loglevel="TRACE:INFO",
-            # include="INCL",
-            exclude="EXCL",
-            skip="SKIP",
-            removekeywords="tag:REMOVE",
-            flattenkeywords="tag:FLAT",
-            **kwargs,
-        )
+        if robot_arguments:
+            robot_arguments["listener"] = [Listener()] + robot_arguments.get("listener", [])
+            robot_arguments["consolecolors"] = "ansi"
+            result = robot.run(
+                ".",
+                **robot_arguments
+            )
+        else:
+            result = robot.run(
+                ".",
+                consolecolors="ansi",
+                listener=[Listener()],
+                loglevel="TRACE:INFO",
+                exclude="EXCL",
+                skip="SKIP",
+                removekeywords="tag:REMOVE",
+                flattenkeywords="tag:FLAT",
+                **kwargs,
+            )
         js.console.log(f"result: {result}")
     except Exception as e:
         js.console.log(f"Robot Run Exception: {e}")
@@ -146,7 +160,7 @@ def write_file(file):
         std_output = sys.__stdout__.getvalue()
         sys.__stdout__ = org_stdout
         sys.stdout = sys.__stdout__
-        js.postMessage(json.dumps({"std_output": std_output}))
+        log(std_output)
 
     with open("/log.html", "r", encoding="UTF-8") as f:
         log_html = str(f.read())

src/components/EmbeddedEditor.vue

@@ -195,6 +195,8 @@ export default {
     copyMessage: null,
     RFVersions: [],
     selectedRFVersion: '',
+    robotArgs: {},
+    requirements: [],
     reinstallRF: false,
     versionDropdownOpen: false
   }),
@@ -264,6 +266,12 @@ export default {
       if (project.robotVersion) {
         this.selectedRFVersion = project.robotVersion
       }
+      if (project.robotArgs) {
+        this.robotArgs = project.robotArgs
+      }
+      if (project.requirements) {
+        this.requirements = project.requirements
+      }
       this.setActiveFile(activeFileName || project.files[0].fileName)
       this.editorStatus.projectModified = false
       this.copyMessage = null
@@ -325,7 +333,7 @@ export default {
         })
         this.editorStatus.running = true
         const init = this.reinstallRF
-        setTimeout(() => { runRobot(files, init, tcName, this.selectedRFVersion) }, 0)
+        setTimeout(() => { runRobot(files, init, tcName, this.selectedRFVersion, this.robotArgs, this.requirements) }, 0)
         this.reinstallRF = false
       })
     }

src/js/code/index.js

@@ -35,6 +35,12 @@ const getProject = async(projectUrl) => {
   if (configFile.robotVersion) {
     project.robotVersion = configFile.robotVersion
   }
+  if (configFile.robotArgs) {
+    project.robotArgs = configFile.robotArgs
+  }
+  if (configFile.requirements) {
+    project.requirements = configFile.requirements
+  }
   const descriptionFileName = configFile.description
   if (descriptionFileName) {
     project.description = await fetch(projectUrl + '/' + descriptionFileName)

src/js/code/pyodide.js

@@ -75,22 +75,30 @@ function asyncRun(script, context, onMessage, initialize) {
   })
 }
 
-export async function runRobot(files, initialize, testCaseName = '', version = '') {
+export async function runRobot(files, initialize, testCaseName = '', version = '', robotArgs = {}, requirements = []) {
   console.log(`init: ${initialize}`)
   clearOutput()
   writeToOutput('Initializing...\n')
-  await asyncRun(pythonProgram, { file_catalog: JSON.stringify(files), test_case_name: testCaseName, version: version }, (data) => {
-    data = JSON.parse(data)
-    writeToOutput(data.std_output)
-    if (Object.prototype.hasOwnProperty.call(data, 'log_html')) {
-      updateLogHtml(data.log_html)
-    }
-    if (Object.prototype.hasOwnProperty.call(data, 'report_html')) {
-      updateReportHtml(data.report_html)
-    }
-    if (Object.prototype.hasOwnProperty.call(data, 'libdocJson')) {
-      addLibraryEvent.libdoc = data.libdocJson
-      window.dispatchEvent(addLibraryEvent)
-    }
-  }, initialize)
+  await asyncRun(
+    pythonProgram, {
+      file_catalog: JSON.stringify(files),
+      test_case_name: testCaseName,
+      version: version,
+      robot_args: JSON.stringify(robotArgs),
+      requirements: JSON.stringify(requirements)
+    }, (data) => {
+      data = JSON.parse(data)
+      writeToOutput(data.std_output)
+      if (Object.prototype.hasOwnProperty.call(data, 'log_html')) {
+        updateLogHtml(data.log_html)
+      }
+      if (Object.prototype.hasOwnProperty.call(data, 'report_html')) {
+        updateReportHtml(data.report_html)
+      }
+      if (Object.prototype.hasOwnProperty.call(data, 'libdocJson')) {
+        addLibraryEvent.libdoc = data.libdocJson
+        window.dispatchEvent(addLibraryEvent)
+      }
+    }, initialize
+  )
 }