Completed refactor of old integration tests to new Python tests.

pyscript · ntoll · Sep 25, 2024 · Sep 10, 2024 · Sep 13, 2024 · Sep 17, 2024
commit 762ae191ad2af8c3e031c4600678c744a2b053bf
diff --git a/pyscript.core/tests/integration/python/helper.js b/pyscript.core/tests/integration/python/helper.js
@@ -9,10 +9,14 @@ const config = qs.has('config') ? qs.get('config') : './settings.json';
 // terminal=0 to NOT have a terminal
 const terminal = qs.get('terminal') !== '0';
 
+// worker=1 to have a worker
+const worker = qs.get('worker') == '1';
+
 const script = document.createElement('script');
 script.type = qs.get('type') || 'mpy';
 if (src) script.src = src;
 if (config) script.setAttribute('config', config);
 script.toggleAttribute('terminal', terminal);
+script.toggleAttribute('worker', worker);
 
 document.write(script.outerHTML);
diff --git a/pyscript.core/tests/integration/python/main.py b/pyscript.core/tests/integration/python/main.py
@@ -1,7 +1,7 @@
-from pyscript import window
-from pyscript.ffi import to_js
-
+from pyscript import web
 import upytest
+import json
 
 result = await upytest.run("./tests")
-window.console.log(to_js(result))
+output = web.div(json.dumps(result), id="result")
+web.page.append(output)
diff --git a/pyscript.core/tests/integration/python/settings.json b/pyscript.core/tests/integration/python/settings.json
@@ -1,6 +1,6 @@
 {
     "files": {
-        "https://raw.githubusercontent.com/ntoll/upytest/1.0.4/upytest.py": "",
+        "https://raw.githubusercontent.com/ntoll/upytest/1.0.5/upytest.py": "",
         "./tests/test_web.py": "tests/test_web.py",
         "./tests/test_display.py": "tests/test_display.py",
         "./tests/test_when.py": "tests/test_when.py"

diff --git a/pyscript.core/tests/integration/python/tests/test_display.py b/pyscript.core/tests/integration/python/tests/test_display.py
@@ -1,8 +1,10 @@
 """
 Tests for the display function in PyScript.
 """
+
 import re
 import upytest
+import asyncio
 
 
 from pyscript import display, web, HTML, RUNNING_IN_WORKER, py_import
@@ -21,46 +23,60 @@ def get_display_container():
     return None
 
 
-def setup():
+async def setup():
     """
     Setup function for the test_display.py module. Remove all references to the
     display output in the DOM so we always start from a clean state.
     """
     container = get_display_container()
-    container.replaceChildren()
+    if container:
+        container.replaceChildren()
     target_container = web.page.find("#test-element-container")[0]
     target_container.innerHTML = ""
+    await asyncio.sleep(0.01)
+
 
-def teardown():
+async def teardown():
     """
     Like setup.
     """
     container = get_display_container()
-    container.replaceChildren()
+    if container:
+        container.replaceChildren()
     target_container = web.page.find("#test-element-container")[0]
     target_container.innerHTML = ""
+    await asyncio.sleep(0.01)
+
 
 def test_simple_display():
     """
     Test the display function with a simple string.
     """
     display("Hello, world")
     container = get_display_container()
-    assert len(container.children) == 1, "Expected one child in the display container."
-    assert container.children[0].tagName == "DIV", "Expected a div element in the display container."
+    assert (
+        len(container.children) == 1
+    ), "Expected one child in the display container."
+    assert (
+        container.children[0].tagName == "DIV"
+    ), "Expected a div element in the display container."
     assert container.children[0].innerHTML == "Hello, world"
 
+
 def test_consecutive_display():
     """
     Display order should be preserved.
     """
     display("hello 1")
     display("hello 2")
     container = get_display_container()
-    assert len(container.children) == 2, "Expected two children in the display container."
+    assert (
+        len(container.children) == 2
+    ), "Expected two children in the display container."
     assert container.children[0].innerHTML == "hello 1"
     assert container.children[1].innerHTML == "hello 2"
 
+
 def test_target_parameter():
     ""&qu
F438
ot;
     The output from display is placed in the target element.
@@ -69,6 +85,7 @@ def test_target_parameter():
     target = web.page.find("#test-element-container")[0]
     assert target.innerText == "hello world"
 
+
 def test_target_parameter_with_hash():
     """
     The target parameter can have a hash in front of it.
@@ -77,13 +94,15 @@ def test_target_parameter_with_hash():
     target = web.page.find("#test-element-container")[0]
     assert target.innerText == "hello world"
 
+
 def test_non_existing_id_target_raises_value_error():
     """
     If the target parameter is set to a non-existing element, a ValueError should be raised.
     """
     with upytest.raises(ValueError):
         display("hello world", target="non-existing")
 
+
 def test_empty_string_target_raises_value_error():
     """
     If the target parameter is an empty string, a ValueError should be raised.
@@ -92,17 +111,19 @@ def test_empty_string_target_raises_value_error():
         display("hello world", target="")
     assert str(exc.exception) == "Cannot have an empty target"
 
+
 def test_non_string_target_values_raise_typerror():
     """
     The target parameter must be a string.
     """
     with upytest.raises(TypeError) as exc:
         display("hello world", target=True)
     assert str(exc.exception) == "target must be str or None, not bool"
-    
+
     with upytest.raises(TypeError) as exc:
         display("hello world", target=123)
-    assert str(exc.exception) == "target must be str or None, not int" 
+    assert str(exc.exception) == "target must be str or None, not int"
+
 
 def test_tag_target_attribute():
     """
@@ -112,12 +133,15 @@ def test_tag_target_attribute():
     display("item 2", target="test-element-container")
     display("item 3")
     container = get_display_container()
-    assert len(container.children) == 2, "Expected two children in the display container."
+    assert (
+        len(container.children) == 2
+    ), "Expected two children in the display container."
     assert container.children[0].innerHTML == "item 1"
     assert container.children[1].innerHTML == "item 3"
     target = web.page.find("#test-element-container")[0]
     assert target.innerText == "item 2"
 
+
 @upytest.skip("CHECK: test consecutive script tags with display in JS")
 def test_consecutive_display_target():
     self.pyscript_run(
@@ -140,7 +164,13 @@ def test_consecutive_display_target():
     inner_text = self.page.inner_text("body")
     lines = inner_text.splitlines()
     lines = [line for line in filter_page_content(lines)]  # remove empty lines
-    assert lines == ["hello 1", "hello in between 1 and 2", "hello 2", "hello 3"]
+    assert lines == [
+        "hello 1",
+        "hello in between 1 and 2",
+        "hello 2",
+        "hello 3",
+    ]
+
 
 def test_multiple_display_calls_same_tag():
     """
@@ -149,31 +179,12 @@ def test_multiple_display_calls_same_tag():
     display("item 1")
     display("item 2")
     container = get_display_container()
-    assert len(container.children) == 2, "Expected two children in the display container."
+    assert (
+        len(container.children) == 2
+    ), "Expected two children in the display container."
     assert container.children[0].innerHTML == "item 1"
     assert container.children[1].innerHTML == "item 2"
 
-@upytest.skip("CHECK: test implicit target from a different tag, both main and in worker in JS?")
-def test_implicit_target_from_a_different_tag():
-    self.pyscript_run(
-        """
-            <script type="py">
-                from pyscript import display
-                def say_hello():
-                    display('hello')
-            </script>
-
-            <script type="py">
-                from pyscript import display
-                say_hello()
-            </script>
-        """
-    )
-    elems = self.page.locator("script-py")
-    py0 = elems.nth(0)
-    py1 = elems.nth(1)
-    assert py0.inner_text() == ""
-    assert py1.inner_text() == "hello"
 
 def test_append_true():
     """
@@ -182,10 +193,13 @@ def test_append_true():
     display("item 1", append=True)
     display("item 2", append=True)
     container = get_display_container()
-    assert len(container.children) == 2, "Expected two children in the display container."
+    assert (
+        len(container.children) == 2
+    ), "Expected two children in the display container."
     assert container.children[0].innerHTML == "item 1"
     assert container.children[1].innerHTML == "item 2"
 
+
 def test_append_false():
     """
     Explicit append flag as false should replace the expected container element.
@@ -195,94 +209,115 @@ def test_append_false():
     container = get_display_container()
     assert container.innerText == "item 2"
 
-def test_display_multiple_values():
+
+async def test_display_multiple_values():
     """
     Display multiple values in the same call.
     """
     display("hello", "world")
+    await asyncio.sleep(0.01)
     container = get_display_container()
-    assert container.innerText == "hello\nworld"
+    assert container.innerText == "hello\nworld", container.innerText
+
 
 def test_display_multiple_append_false():
     display("hello", "world", append=False)
     container = get_display_container()
     assert container.innerText == "world"
 
-# TODO: this is a display.py issue to fix when append=False is used
-#       do not use the first element, just clean up and then append
-#       remove the # display comment once that's done
+
 def test_display_multiple_append_false_with_target():
     """
-
+    TODO: this is a display.py issue to fix when append=False is used
+          do not use the first element, just clean up and then append
+          remove the # display comment once that's done
     """
+
     class Circle:
         r = 0
+
         def _repr_svg_(self):
             return (
                 f'<svg height="{self.r*2}" width="{self.r*2}">'
                 f'<circle cx="{self.r}" cy="{self.r}" r="{self.r}" fill="red"></circle></svg>'
             )
-    
+
     circle = Circle()
     circle.r += 5
     display(circle, circle, target="test-element-container", append=False)
     target = web.page.find("#test-element-container")[0]
     assert target.innerHTML == circle._repr_svg_()
 
-def test_display_list_dict_tuple():
+
+async def test_display_list_dict_tuple():
     """
     Display a list, dictionary, and tuple with the expected __repr__.
 
     NOTE: MicroPython doesn't (yet) have ordered dicts. Hence the rather odd
     check that the dictionary is displayed as a string.
     """
-    l = ['A', 1, '!']
-    d = {'B': 2, 'List': l}
-    t = ('C', 3, '!')
+    l = ["A", 1, "!"]
+    d = {"B": 2, "List": l}
+    t = ("C", 3, "!")
     display(l, d, t)
+    await asyncio.sleep(0.01)
     container = get_display_container()
-    l2, d2, t2 = container.innerText.split('\n')
+    l2, d2, t2 = container.innerText.split("\n")
     assert l == eval(l2)
     assert d == eval(d2)
     assert t == eval(t2)
 
+
 def test_display_should_escape():
     display("<p>hello world</p>")
     container = get_display_container()
     assert container[0].innerHTML == "&lt;p&gt;hello world&lt;/p&gt;"
     assert container.innerText == "<p>hello world</p>"
 
+
 def test_display_HTML():
     display(HTML("<p>hello world</p>"))
     container = get_display_container()
     assert container[0].innerHTML == "<p>hello world</p>"
     assert container.innerText == "hello world"
 
-@upytest.skip("Pyodide main thread only", skip_when=upytest.is_micropython or RUNNING_IN_WORKER) 
+
+@upytest.skip(
+    "Pyodide main thread only",
+    skip_when=upytest.is_micropython or RUNNING_IN_WORKER,
+)
 async def test_image_display():
     """
     Check an image is displayed correctly.
     """
     mpl = await py_import("matplotlib")
     import matplotlib.pyplot as plt
+
     xpoints = [3, 6, 9]
     ypoints = [1, 2, 3]
     plt.plot(xpoints, ypoints)
     display(plt)
     container = get_display_container()
     img = container.find("img")[0]
-    img_src = img.getAttribute("src").replace("data:image/png;charset=utf-8;base64,", "")
+    img_src = img.getAttribute("src").replace(
+        "data:image/png;charset=utf-8;base64,", ""
+    )
     assert len(img_src) > 0
 
-@upytest.skip("Pyodide main thread only", skip_when=upytest.is_micropython or RUNNING_IN_WORKER) 
+
+@upytest.skip(
+    "Pyodide main thread only",
+    skip_when=upytest.is_micropython or RUNNING_IN_WORKER,
+)
 async def test_image_renders_correctly():
     """
     This is just a sanity check to make sure that images are rendered
     in a reasonable way.
     """
     from PIL import Image
+
     img = Image.new("RGB", (4, 4), color=(0, 0, 0))
     display(img, target="test-element-container", append=False)
     target = web.page.find("#test-element-container")[0]
     img = target.find("img")[0]
-    assert img.src.startswith("data:image/png;charset=utf-8;base64")
+    assert img.src.startswith("data:image/png;charset=utf-8;base64")