summaryrefslogtreecommitdiffstats
path: root/testing/tools/websocketprocessbridge
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /testing/tools/websocketprocessbridge
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'testing/tools/websocketprocessbridge')
-rw-r--r--testing/tools/websocketprocessbridge/websocketprocessbridge.py123
-rw-r--r--testing/tools/websocketprocessbridge/websocketprocessbridge_requirements_3.txt17
2 files changed, 140 insertions, 0 deletions
diff --git a/testing/tools/websocketprocessbridge/websocketprocessbridge.py b/testing/tools/websocketprocessbridge/websocketprocessbridge.py
new file mode 100644
index 0000000000..f922194466
--- /dev/null
+++ b/testing/tools/websocketprocessbridge/websocketprocessbridge.py
@@ -0,0 +1,123 @@
+# vim: set ts=4 et sw=4 tw=80
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from twisted.internet import protocol, reactor
+from twisted.internet.task import LoopingCall
+from autobahn.twisted.websocket import WebSocketServerProtocol, WebSocketServerFactory
+
+import psutil
+
+import argparse
+import six
+import sys
+import os
+
+# maps a command issued via websocket to running an executable with args
+commands = {
+ "iceserver": [sys.executable, "-u", os.path.join("iceserver", "iceserver.py")]
+}
+
+
+class ProcessSide(protocol.ProcessProtocol):
+ """Handles the spawned process (I/O, process termination)"""
+
+ def __init__(self, socketSide):
+ self.socketSide = socketSide
+
+ def outReceived(self, data):
+ data = six.ensure_str(data)
+ if self.socketSide:
+ lines = data.splitlines()
+ for line in lines:
+ self.socketSide.sendMessage(line.encode("utf8"), False)
+
+ def errReceived(self, data):
+ self.outReceived(data)
+
+ def processEnded(self, reason):
+ if self.socketSide:
+ self.outReceived(reason.getTraceback())
+ self.socketSide.processGone()
+
+ def socketGone(self):
+ self.socketSide = None
+ self.transport.loseConnection()
+ self.transport.signalProcess("KILL")
+
+
+class SocketSide(WebSocketServerProtocol):
+ """
+ Handles the websocket (I/O, closed connection), and spawning the process
+ """
+
+ def __init__(self):
+ super(SocketSide, self).__init__()
+ self.processSide = None
+
+ def onConnect(self, request):
+ return None
+
+ def onOpen(self):
+ return None
+
+ def onMessage(self, payload, isBinary):
+ # We only expect a single message, which tells us what kind of process
+ # we're supposed to launch. ProcessSide pipes output to us for sending
+ # back to the websocket client.
+ if not self.processSide:
+ self.processSide = ProcessSide(self)
+ # We deliberately crash if |data| isn't on the "menu",
+ # or there is some problem spawning.
+ data = six.ensure_str(payload)
+ try:
+ reactor.spawnProcess(
+ self.processSide, commands[data][0], commands[data], env=os.environ
+ )
+ except BaseException as e:
+ print(e.str())
+ self.sendMessage(e.str())
+ self.processGone()
+
+ def onClose(self, wasClean, code, reason):
+ if self.processSide:
+ self.processSide.socketGone()
+
+ def processGone(self):
+ self.processSide = None
+ self.transport.loseConnection()
+
+
+# Parent process could have already exited, so this is slightly racy. Only
+# alternative is to set up a pipe between parent and child, but that requires
+# special cooperation from the parent.
+parent_process = psutil.Process(os.getpid()).parent()
+
+
+def check_parent():
+ """Checks if parent process is still alive, and exits if not"""
+ if not parent_process.is_running():
+ print("websocket/process bridge exiting because parent process is gone")
+ reactor.stop()
+
+
+if __name__ == "__main__":
+ parser = argparse.ArgumentParser(description="Starts websocket/process bridge.")
+ parser.add_argument(
+ "--port",
+ type=str,
+ dest="port",
+ default="8191",
+ help="Port for websocket/process bridge. Default 8191.",
+ )
+ args = parser.parse_args()
+
+ parent_checker = LoopingCall(check_parent)
+ parent_checker.start(1)
+
+ bridgeFactory = WebSocketServerFactory()
+ bridgeFactory.protocol = SocketSide
+ reactor.listenTCP(int(args.port), bridgeFactory)
+ print("websocket/process bridge listening on port %s" % args.port)
+ reactor.run()
diff --git a/testing/tools/websocketprocessbridge/websocketprocessbridge_requirements_3.txt b/testing/tools/websocketprocessbridge/websocketprocessbridge_requirements_3.txt
new file mode 100644
index 0000000000..9283087d5c
--- /dev/null
+++ b/testing/tools/websocketprocessbridge/websocketprocessbridge_requirements_3.txt
@@ -0,0 +1,17 @@
+# This file is the websocketprocess requirements.txt used with python 3.
+
+six
+vcversioner==2.16.0.0
+twisted==21.2.0
+
+# websocket adapter for twisted, might be built into twisted someday
+autobahn==21.2.1
+
+psutil>=5.9.0
+
+# Needed by iceserver
+ipaddr>=2.2.0
+passlib==1.7.4
+
+pyOpenSSL
+service_identity