Rename robot_stream -> robot_out_stream.

Author: fabioz

.github/workflows/tests-robot-stream.yml …hub/workflows/tests-robot-out-stream.yml.github/workflows/tests-robot-stream.yml renamed to .github/workflows/tests-robot-out-stream.yml .github/workflows/tests-robot-stream.yml renamed to .github/workflows/tests-robot-out-stream.yml

@@ -1,4 +1,4 @@
-name: Tests - Robot Stream (robotframework-output-stream)
+name: Tests - Robot Output Stream (robotframework-output-stream)
 
 on:
   push:

robotframework-ls/dev.py

@@ -227,15 +227,15 @@ def vendor_robotframework_interactive(self):
         assert os.path.exists(bundle_js), f"{bundle_js} does not exist."
         print("=== Finished vendoring.")
 
-    def remove_robot_stream(self):
+    def remove_robot_out_stream(self):
         import time
         import shutil
 
         vendored_dir = os.path.join(
             os.path.dirname(__file__), "src", "robotframework_ls", "vendored"
         )
         found = []
-        for path in ("robot_stream", "output-webview"):
+        for path in ("robot_out_stream", "output-webview"):
             target = os.path.join(vendored_dir, path)
             try:
                 shutil.rmtree(target)
@@ -250,19 +250,19 @@ def remove_robot_stream(self):
 
     def vendor_robotframework_output_stream(self):
         """
-        Vendors robot_stream into robotframework_ls/vendored.
+        Vendors robot_out_stream into robotframework_ls/vendored.
         """
         import shutil
         import subprocess
 
-        vendored_src, vendored_webview = self.remove_robot_stream()
+        vendored_src, vendored_webview = self.remove_robot_out_stream()
 
         src_core = os.path.join(
             os.path.dirname(__file__),
             "..",
             "robotframework-output-stream",
             "src",
-            "robot_stream",
+            "robot_out_stream",
         )
         print("=== Copying from: %s to %s" % (src_core, vendored_src))
 

robotframework-ls/src/robotframework_debug_adapter/listeners.py

@@ -84,13 +84,13 @@ def message(self, message):
 
 def install_rf_stream_connection(write_message):
     try:
-        from robot_stream import RFStream
+        from robot_out_stream import RFStream
     except ImportError:
-        from robotframework_ls import import_robot_stream
+        from robotframework_ls import import_robot_out_stream
 
-        import_robot_stream()
+        import_robot_out_stream()
 
-        from robot_stream import RFStream
+        from robot_out_stream import RFStream
 
     def write_str(s):
         write_message({"type": "event", "event": "rfStream", "body": {"msg": s}})

robotframework-ls/src/robotframework_ls/__init__.py

@@ -112,13 +112,13 @@ def import_callback():
     _import_helper(import_callback, "robotframework-interactive")
 
 
-def import_robot_stream():
+def import_robot_out_stream():
     """
-    Helper function to make sure that robot_stream is imported properly
+    Helper function to make sure that robot_out_stream is imported properly
     (either in dev or in release mode).
     """
 
     def import_callback():
-        import robot_stream
+        import robot_out_stream
 
     _import_helper(import_callback, "robotframework-output-stream")

robotframework-ls/src/robotframework_ls/robotframework_ls_impl.py

@@ -672,11 +672,11 @@ def m_robot__provide_evaluatable_expression(
     @command_dispatcher(ROBOT_CONVERT_OUTPUT_XML_TO_ROBOSTREAM)
     def _convert_output_xml_to_rfstream(self, opts: Dict[str, Any]):
         def convert_in_thread():
-            from robotframework_ls import import_robot_stream
+            from robotframework_ls import import_robot_out_stream
 
-            import_robot_stream()
+            import_robot_out_stream()
 
-            from robot_stream import xml_to_rfstream
+            from robot_out_stream import xml_to_rfstream
 
             source = opts.get("xml_path")
             if source:

robotframework-output-stream/README.md

@@ -7,7 +7,7 @@ install to use it in any Robot Framework run.
 
 ## Usage
 
-  `python -m robot -l NONE -r NONE -o NONE --listener robot_stream.RFStream:--dir=<dir_to_output>:--port:<port>`
+  `python -m robot -l NONE -r NONE -o NONE --listener robot_out_stream.RFStream:--dir=<dir_to_output>:--port:<port>`
 
   Note: the `-l NONE and -r NONE -o NONE` are recommended to disable the standard Robot Framework output (since
   the RFStream should cover all its use-cases).
@@ -83,12 +83,12 @@ Given the requisites above, the idea is generating the following files while run
     Files in the same format pointing to where an error happened (it should
     be possible to derive a traceback from that information).
 
-    - `robot_stream.error.0.rfstream`
-    - `robot_stream.error.1.rfstream`
+    - `robot_out_stream.error.0.rfstream`
+    - `robot_out_stream.error.1.rfstream`
 
     After the processing finished a file is written with all the errors.
 
-    - `robot_stream.errors.summary.rfstream`
+    - `robot_out_stream.errors.summary.rfstream`
 
     Note: for most users just the errors log should be enough, but if something
     isn't identified as an error, the "Basic log" should provide insight on

robotframework-output-stream/output-webview/src/sample.ts

@@ -1,5 +1,5 @@
 export function getSampleContents() {
     return JSON.parse(
-        '"V 1\\nI \\"sys.platform=win32\\"\\nI \\"python=3.7.6 (default, Jan  8 2020, 20:23:39) [MSC v.1916 64 bit (AMD64)]\\"\\nI \\"robot=5.1a3.dev1\\"\\nT 2022-10-19T09:48:34.018\\nM a:\\"Robot1\\"\\nM b:\\"s1\\"\\nM c:\\"C:\\\\\\\\Users\\\\\\\\fabio\\\\\\\\AppData\\\\\\\\Local\\\\\\\\Temp\\\\\\\\pytest-of-fabio\\\\\\\\pytest-421\\\\\\\\test_robot_stream0\\\\\\\\test_robot_stream\\\\\\\\robot1.robot\\"\\nSS a|b|c|0.035\\nM d:\\"Simple Task\\"\\nM e:\\"s1-t1\\"\\nST d|e|16|0.036\\nM f:\\"First keyword\\"\\nM g:\\"\\"\\nM h:\\"KEYWORD\\"\\nSK f|g|h|g|c|17|0.036\\nM i:\\"No Operation\\"\\nM j:\\"BuiltIn\\"\\nM k:\\"Does absolutely nothing.\\"\\nSK i|j|h|k|c|8|0.037\\nM l:\\"PASS\\"\\nEK l|0.037\\nM m:\\"Log\\"\\nM n:\\"Logs the given message with the given level.\\"\\nSK m|j|h|n|c|10|0.037\\nM o:\\"Some warning message\\"\\nKA o\\nM p:\\"level=WARN\\"\\nKA p\\nEK l|0.046\\nM q:\\"Another keyword\\"\\nM r:\\"another\\"\\nSK q|r|h|g|c|11|0.047\\nM s:\\"C:\\\\\\\\Users\\\\\\\\fabio\\\\\\\\AppData\\\\\\\\Local\\\\\\\\Temp\\\\\\\\pytest-of-fabio\\\\\\\\pytest-421\\\\\\\\test_robot_stream0\\\\\\\\test_robot_stream\\\\\\\\another.robot\\"\\nSK i|j|h|k|s|3|0.047\\nEK l|0.047\\nEK l|0.047\\nM t:\\"Another in sub keyword\\"\\nM u:\\"another_sub\\"\\nSK t|u|h|g|c|12|0.047\\nM v:\\"C:\\\\\\\\Users\\\\\\\\fabio\\\\\\\\AppData\\\\\\\\Local\\\\\\\\Temp\\\\\\\\pytest-of-fabio\\\\\\\\pytest-421\\\\\\\\test_robot_stream0\\\\\\\\test_robot_stream\\\\\\\\sub\\\\\\\\another_sub.robot\\"\\nSK i|j|h|k|v|6|0.048\\nEK l|0.048\\nSK m|j|h|n|v|7|0.048\\nM w:\\"Some error message\\"\\nKA w\\nM x:\\"level=ERROR\\"\\nKA x\\nEK l|0.049\\nEK l|0.049\\nEK l|0.049\\nSK m|j|h|n|c|18|0.049\\nM y:\\"Some <data &encode </script>\\"\\nKA y\\nEK l|0.049\\nM z:\\"Create Dictionary\\"\\nM A:\\"Creates and returns a dictionary based on the given ``items``.\\"\\nSK z|j|h|A|c|19|0.049\\nM B:\\"a=1\\"\\nKA B\\nM C:\\"b=1\\"\\nKA C\\nEK l|0.05\\nSK m|j|h|n|c|20|0.05\\nM D:\\"${dct}\\"\\nKA D\\nEK l|0.051\\nET l|g|0.051\\nM E:\\"Check 1\\"\\nM F:\\"s1-t2\\"\\nST E|F|22|0.051\\nSK f|g|h|g|c|23|0.051\\nSK i|j|h|k|c|8|0.052\\nEK l|0.052\\nSK m|j|h|n|c|10|0.052\\nKA o\\nKA p\\nEK l|0.052\\nSK q|r|h|g|c|11|0.053\\nSK i|j|h|k|s|3|0.053\\nEK l|0.053\\nEK l|0.053\\nSK t|u|h|g|c|12|0.053\\nSK i|j|h|k|v|6|0.054\\nEK l|0.054\\nSK m|j|h|n|v|7|0.054\\nKA w\\nKA x\\nEK l|0.054\\nEK l|0.055\\nEK l|0.055\\nM G:\\"${counter} IN RANGE [ 0 | 3 ]\\"\\nM H:\\"FOR\\"\\nSK G|g|H|g|c|25|0.055\\nM I:\\"${counter} = 0\\"\\nM J:\\"ITERATION\\"\\nSK I|g|J|g|c|25|0.055\\nM K:\\"${counter} == 2\\"\\nM L:\\"IF\\"\\nSK K|g|L|g|c|26|0.055\\nM M:\\"Fail\\"\\nM N:\\"Fails the test with the given message and optionally alters its tags.\\"\\nSK M|j|h|N|c|27|0.056\\nM O:\\"Failed execution for some reason...\\"\\nKA O\\nM P:\\"NOT RUN\\"\\nEK P|0.056\\nEK P|0.056\\nSK m|j|h|n|c|29|0.056\\nM Q:\\"${counter}\\"\\nKA Q\\nEK l|0.056\\nEK l|0.057\\nM R:\\"${counter} = 1\\"\\nSK R|g|J|g|c|25|0.057\\nSK K|g|L|g|c|26|0.057\\nSK M|j|h|N|c|27|0.057\\nKA O\\nEK P|0.057\\nEK P|0.057\\nSK m|j|h|n|c|29|0.058\\nKA Q\\nEK l|0.058\\nEK l|0.058\\nM S:\\"${counter} = 2\\"\\nSK S|g|J|g|c|25|0.058\\nSK K|g|L|g|c|26|0.058\\nSK M|j|h|N|c|27|0.059\\nKA O\\nM T:\\"FAIL\\"\\nEK T|0.059\\nEK T|0.059\\nSK m|j|h|n|c|29|0.059\\nKA Q\\nEK P|0.059\\nEK T|0.06\\nEK T|0.06\\nET T|O|0.06\\nM U:\\"Check 2\\"\\nM V:\\"s1-t3\\"\\nST U|V|32|0.06\\nM W:\\"Set Variable\\"\\nM X:\\"Returns the given values which can then be assigned to a variables.\\"\\nSK W|j|h|X|c|33|0.061\\nM Y:\\"3\\"\\nKA Y\\nEK l|0.061\\nM Z:\\"${counter} <= 2\\"\\nM 0:\\"WHILE\\"\\nSK Z|g|0|g|c|34|0.061\\nSK g|g|J|g|c|34|0.062\\nM 1:\\"Evaluate\\"\\nM 2:\\"Evaluates the given expression in Python and returns the result.\\"\\nSK 1|j|h|2|c|35|0.062\\nM 4:\\"$counter-1\\"\\nKA 4\\nEK P|0.062\\nSK m|j|h|n|c|36|0.062\\nM 5:\\"Current counter: ${counter}\\"\\nKA 5\\nKA p\\nEK P|0.062\\nEK P|0.062\\nEK P|0.063\\nET l|g|0.063\\nM 6:\\"Check 3\\"\\nM 7:\\"s1-t4\\"\\nST 6|7|39|0.064\\nM 8:\\"TRY\\"\\nSK g|g|8|g|c|40|0.064\\nSK i|j|h|k|c|41|0.064\\nEK l|0.064\\nEK l|0.064\\nM 9:\\"message\\"\\nM aa:\\"EXCEPT\\"\\nSK 9|g|aa|g|c|42|0.064\\nSK i|j|h|k|c|43|0.065\\nEK P|0.065\\nEK P|0.065\\nM ab:\\"FINALLY\\"\\nSK g|g|ab|g|c|44|0.065\\nSK i|j|h|k|c|45|0.065\\nEK l|0.065\\nEK l|0.065\\nET l|g|0.066\\nES T|0.067\\n"'
+        '"V 1\\nI \\"sys.platform=win32\\"\\nI \\"python=3.7.6 (default, Jan  8 2020, 20:23:39) [MSC v.1916 64 bit (AMD64)]\\"\\nI \\"robot=5.1a3.dev1\\"\\nT 2022-10-19T09:48:34.018\\nM a:\\"Robot1\\"\\nM b:\\"s1\\"\\nM c:\\"C:\\\\\\\\Users\\\\\\\\fabio\\\\\\\\AppData\\\\\\\\Local\\\\\\\\Temp\\\\\\\\pytest-of-fabio\\\\\\\\pytest-421\\\\\\\\test_robot_out_stream0\\\\\\\\test_robot_out_stream\\\\\\\\robot1.robot\\"\\nSS a|b|c|0.035\\nM d:\\"Simple Task\\"\\nM e:\\"s1-t1\\"\\nST d|e|16|0.036\\nM f:\\"First keyword\\"\\nM g:\\"\\"\\nM h:\\"KEYWORD\\"\\nSK f|g|h|g|c|17|0.036\\nM i:\\"No Operation\\"\\nM j:\\"BuiltIn\\"\\nM k:\\"Does absolutely nothing.\\"\\nSK i|j|h|k|c|8|0.037\\nM l:\\"PASS\\"\\nEK l|0.037\\nM m:\\"Log\\"\\nM n:\\"Logs the given message with the given level.\\"\\nSK m|j|h|n|c|10|0.037\\nM o:\\"Some warning message\\"\\nKA o\\nM p:\\"level=WARN\\"\\nKA p\\nEK l|0.046\\nM q:\\"Another keyword\\"\\nM r:\\"another\\"\\nSK q|r|h|g|c|11|0.047\\nM s:\\"C:\\\\\\\\Users\\\\\\\\fabio\\\\\\\\AppData\\\\\\\\Local\\\\\\\\Temp\\\\\\\\pytest-of-fabio\\\\\\\\pytest-421\\\\\\\\test_robot_out_stream0\\\\\\\\test_robot_out_stream\\\\\\\\another.robot\\"\\nSK i|j|h|k|s|3|0.047\\nEK l|0.047\\nEK l|0.047\\nM t:\\"Another in sub keyword\\"\\nM u:\\"another_sub\\"\\nSK t|u|h|g|c|12|0.047\\nM v:\\"C:\\\\\\\\Users\\\\\\\\fabio\\\\\\\\AppData\\\\\\\\Local\\\\\\\\Temp\\\\\\\\pytest-of-fabio\\\\\\\\pytest-421\\\\\\\\test_robot_out_stream0\\\\\\\\test_robot_out_stream\\\\\\\\sub\\\\\\\\another_sub.robot\\"\\nSK i|j|h|k|v|6|0.048\\nEK l|0.048\\nSK m|j|h|n|v|7|0.048\\nM w:\\"Some error message\\"\\nKA w\\nM x:\\"level=ERROR\\"\\nKA x\\nEK l|0.049\\nEK l|0.049\\nEK l|0.049\\nSK m|j|h|n|c|18|0.049\\nM y:\\"Some <data &encode </script>\\"\\nKA y\\nEK l|0.049\\nM z:\\"Create Dictionary\\"\\nM A:\\"Creates and returns a dictionary based on the given ``items``.\\"\\nSK z|j|h|A|c|19|0.049\\nM B:\\"a=1\\"\\nKA B\\nM C:\\"b=1\\"\\nKA C\\nEK l|0.05\\nSK m|j|h|n|c|20|0.05\\nM D:\\"${dct}\\"\\nKA D\\nEK l|0.051\\nET l|g|0.051\\nM E:\\"Check 1\\"\\nM F:\\"s1-t2\\"\\nST E|F|22|0.051\\nSK f|g|h|g|c|23|0.051\\nSK i|j|h|k|c|8|0.052\\nEK l|0.052\\nSK m|j|h|n|c|10|0.052\\nKA o\\nKA p\\nEK l|0.052\\nSK q|r|h|g|c|11|0.053\\nSK i|j|h|k|s|3|0.053\\nEK l|0.053\\nEK l|0.053\\nSK t|u|h|g|c|12|0.053\\nSK i|j|h|k|v|6|0.054\\nEK l|0.054\\nSK m|j|h|n|v|7|0.054\\nKA w\\nKA x\\nEK l|0.054\\nEK l|0.055\\nEK l|0.055\\nM G:\\"${counter} IN RANGE [ 0 | 3 ]\\"\\nM H:\\"FOR\\"\\nSK G|g|H|g|c|25|0.055\\nM I:\\"${counter} = 0\\"\\nM J:\\"ITERATION\\"\\nSK I|g|J|g|c|25|0.055\\nM K:\\"${counter} == 2\\"\\nM L:\\"IF\\"\\nSK K|g|L|g|c|26|0.055\\nM M:\\"Fail\\"\\nM N:\\"Fails the test with the given message and optionally alters its tags.\\"\\nSK M|j|h|N|c|27|0.056\\nM O:\\"Failed execution for some reason...\\"\\nKA O\\nM P:\\"NOT RUN\\"\\nEK P|0.056\\nEK P|0.056\\nSK m|j|h|n|c|29|0.056\\nM Q:\\"${counter}\\"\\nKA Q\\nEK l|0.056\\nEK l|0.057\\nM R:\\"${counter} = 1\\"\\nSK R|g|J|g|c|25|0.057\\nSK K|g|L|g|c|26|0.057\\nSK M|j|h|N|c|27|0.057\\nKA O\\nEK P|0.057\\nEK P|0.057\\nSK m|j|h|n|c|29|0.058\\nKA Q\\nEK l|0.058\\nEK l|0.058\\nM S:\\"${counter} = 2\\"\\nSK S|g|J|g|c|25|0.058\\nSK K|g|L|g|c|26|0.058\\nSK M|j|h|N|c|27|0.059\\nKA O\\nM T:\\"FAIL\\"\\nEK T|0.059\\nEK T|0.059\\nSK m|j|h|n|c|29|0.059\\nKA Q\\nEK P|0.059\\nEK T|0.06\\nEK T|0.06\\nET T|O|0.06\\nM U:\\"Check 2\\"\\nM V:\\"s1-t3\\"\\nST U|V|32|0.06\\nM W:\\"Set Variable\\"\\nM X:\\"Returns the given values which can then be assigned to a variables.\\"\\nSK W|j|h|X|c|33|0.061\\nM Y:\\"3\\"\\nKA Y\\nEK l|0.061\\nM Z:\\"${counter} <= 2\\"\\nM 0:\\"WHILE\\"\\nSK Z|g|0|g|c|34|0.061\\nSK g|g|J|g|c|34|0.062\\nM 1:\\"Evaluate\\"\\nM 2:\\"Evaluates the given expression in Python and returns the result.\\"\\nSK 1|j|h|2|c|35|0.062\\nM 4:\\"$counter-1\\"\\nKA 4\\nEK P|0.062\\nSK m|j|h|n|c|36|0.062\\nM 5:\\"Current counter: ${counter}\\"\\nKA 5\\nKA p\\nEK P|0.062\\nEK P|0.062\\nEK P|0.063\\nET l|g|0.063\\nM 6:\\"Check 3\\"\\nM 7:\\"s1-t4\\"\\nST 6|7|39|0.064\\nM 8:\\"TRY\\"\\nSK g|g|8|g|c|40|0.064\\nSK i|j|h|k|c|41|0.064\\nEK l|0.064\\nEK l|0.064\\nM 9:\\"message\\"\\nM aa:\\"EXCEPT\\"\\nSK 9|g|aa|g|c|42|0.064\\nSK i|j|h|k|c|43|0.065\\nEK P|0.065\\nEK P|0.065\\nM ab:\\"FINALLY\\"\\nSK g|g|ab|g|c|44|0.065\\nSK i|j|h|k|c|45|0.065\\nEK l|0.065\\nEK l|0.065\\nET l|g|0.066\\nES T|0.067\\n"'
     );
 }

…tput-stream/src/robot_stream/__init__.py …-stream/src/robot_out_stream/__init__.pyrobotframework-output-stream/src/robot_stream/__init__.py renamed to robotframework-output-stream/src/robot_out_stream/__init__.py robotframework-output-stream/src/robot_stream/__init__.py renamed to robotframework-output-stream/src/robot_out_stream/__init__.py

@@ -37,7 +37,7 @@ class RFStream:
     ROBOT_LISTENER_API_VERSION = 2
 
     def __init__(self, *args, **kwargs):
-        from robot_stream._impl import _RobotOutputImpl, _Config
+        from robot_out_stream._impl import _RobotOutputImpl, _Config
 
         config = _Config()
 
@@ -121,7 +121,7 @@ def end_suite(self, name, attributes):
         #     "tests": ["First task", "Second task"],
         #     "suites": [],
         #     "totaltests": 2,
-        #     "source": "C:\\Users\\fabio\\AppData\\Local\\Temp\\pytest-of-fabio\\pytest-184\\test_robot_stream0\\test_robot_stream\\robot1.robot",
+        #     "source": "C:\\Users\\fabio\\AppData\\Local\\Temp\\pytest-of-fabio\\pytest-184\\test_robot_out_stream0\\test_robot_out_stream\\robot1.robot",
         #     "statistics": "2 tasks, 1 passed, 1 failed",
         # }
         return self._robot_output_impl.end_suite(
@@ -166,7 +166,7 @@ def end_test(self, name, attributes):
         #     "doc": "",
         #     "tags": [],
         #     "lineno": 15,
-        #     "source": "C:\\Users\\fabio\\AppData\\Local\\Temp\\pytest-of-fabio\\pytest-187\\test_robot_stream0\\test_robot_stream\\robot1.robot",
+        #     "source": "C:\\Users\\fabio\\AppData\\Local\\Temp\\pytest-of-fabio\\pytest-187\\test_robot_out_stream0\\test_robot_out_stream\\robot1.robot",
         #     "starttime": "20221004 16:23:10.403",
         #     "endtime": "20221004 16:23:10.412",
         #     "elapsedtime": 9,
@@ -191,7 +191,7 @@ def start_keyword(self, name, attributes):
         #     "assign": [],
         #     "tags": [],
         #     "lineno": 7,
-        #     "source": "C:\\Users\\fabio\\AppData\\Local\\Temp\\pytest-of-fabio\\pytest-170\\test_robot_stream0\\test_robot_stream\\robot1.robot",
+        #     "source": "C:\\Users\\fabio\\AppData\\Local\\Temp\\pytest-of-fabio\\pytest-170\\test_robot_out_stream0\\test_robot_out_stream\\robot1.robot",
         #     "type": "KEYWORD",
         #     "status": "NOT SET",
         #     "starttime": "20221003 16:20:21.234",
@@ -241,7 +241,7 @@ def end_keyword(self, name, attributes):
         #     "assign": [],
         #     "tags": [],
         #     "lineno": 7,
-        #     "source": "C:\\Users\\fabio\\AppData\\Local\\Temp\\pytest-of-fabio\\pytest-191\\test_robot_stream0\\test_robot_stream\\robot1.robot",
+        #     "source": "C:\\Users\\fabio\\AppData\\Local\\Temp\\pytest-of-fabio\\pytest-191\\test_robot_out_stream0\\test_robot_out_stream\\robot1.robot",
         #     "type": "KEYWORD",
         #     "status": "PASS",
         #     "starttime": "20221004 16:27:46.959",