Merge pull request #1161 from bjones1/more-tests

Improved testing 3

Author: bnmnetp

runestone/conftest.py

@@ -12,8 +12,9 @@
 #
 # Standard library
 # ----------------
-# None.
-#
+import subprocess
+
+
 # Third-party imports
 # -------------------
 import pytest
@@ -23,20 +24,40 @@
 # -------------
 # This is necessary to bring in the shared pytest fixture.
 from runestone.shared_conftest import _SeleniumUtils, selenium_driver  # noqa: F401
-from runestone.unittest_base import ModuleFixture, HOST_URL, run_webpack  # noqa: F401
+from runestone.unittest_base import ModuleFixture, HOST_URL, IS_WINDOWS
 
 
 # Fixtures
 # ========
+# Run this once, before all tests, to update the webpacked JS.
+@pytest.fixture(scope="session", autouse=True)
+def run_webpack():
+    # Note that Windows requires ``shell=True``, since the command to execute is ``npm.cmd``.
+    p = subprocess.run(["npm", "run", "build"], text=True, shell=IS_WINDOWS, capture_output=True)
+    print(p.stderr + p.stdout)
+    assert not p.returncode
+
+
+# Provide access to the module fixture, for tests with specific needs.
 @pytest.fixture(scope="module")
-def selenium_driver_session(request):
-    mf = ModuleFixture(request.fspath, True)
+def selenium_module_fixture(request):
+    # Allow tests to specify the ``exit_status_success`` parameter passed to the ModuleFixture constructor by adding the ``@pytest.mark.exit_status_success(False)`` decorator to a test. (Marking it True instead is equivalent to the unmarked, default value.) See the `example <https://docs.pytest.org/en/stable/fixture.html#using-markers-to-pass-data-to-fixtures>`_ and the API docs <https://docs.pytest.org/en/stable/reference.html#pytest.nodes.Node.get_closest_marker>`_.
+    exit_status_success_mark = request.node.get_closest_marker("exit_status_success")
+    exit_status_success = True if exit_status_success_mark is None else exit_status_success_mark.args[0]
+
+    mf = ModuleFixture(request.fspath, exit_status_success)
     mf.setUpModule()
-    yield mf.driver
+    yield mf
     mf.tearDownModule()
 
 
-# Present ``_SeleniumUser`` as a fixture. To use, provide it with a ``_TestUser`` instance.
+# Provide access to the Selenium driver.
+@pytest.fixture(scope="module")
+def selenium_driver_session(selenium_module_fixture):
+    return selenium_module_fixture.driver
+
+
+# Present ``_SeleniumUser`` as a fixture.
 @pytest.fixture
 def selenium_utils(selenium_driver):  # noqa: F811
     return _SeleniumUtils(selenium_driver, HOST_URL)

runestone/lp/js/lp.js

@@ -26,6 +26,12 @@
 import RunestoneBase from "../../common/js/runestonebase";
 import CodeMirror from "codemirror";
 import "codemirror/mode/gas/gas.js";
+import "codemirror/mode/python/python.js";
+import "codemirror/mode/javascript/javascript.js";
+import "codemirror/mode/sql/sql.js";
+import "codemirror/mode/clike/clike.js";
+import "codemirror/mode/octave/octave.js";
+import "codemirror/lib/codemirror.css";
 
 // Constructor
 // ===========
@@ -39,6 +45,7 @@ class LP extends RunestoneBase {
         this.useRunestoneServices = opts.useRunestoneServices;
         // Store the DOM element (the input) for the "Test" button.
         this.element = opts.orig;
+        this.containerDiv = this.element;
         this.divid = this.element.id;
         // Store the DOM element (the textarea) where compile results will be displayed.
         this.resultElement = $(this.element).siblings("textarea");
@@ -66,9 +73,9 @@ class LP extends RunestoneBase {
             // Keep track of it.
             that.textAreas.push(editor);
         });
-        this.checkServer("lp_build");
         // Handle clicks to the "Save and run" button.
         $(this.element).click((eventObject) => that.onSaveAndRun(eventObject).then(null));
+        this.checkServer("lp_build", true);
     }
 
     async onSaveAndRun(_eventObject) {

runestone/lp/lp.py

@@ -17,7 +17,7 @@
 from pathlib import Path
 import json
 
-#
+
 # Third-party imports
 # -------------------
 import pygments
@@ -30,7 +30,7 @@
 from CodeChat.CodeToRestSphinx import is_source_code
 from CodeChat.CodeToRest import get_lexer
 
-#
+
 # Local imports
 # -------------
 from ..common.runestonedirective import (

runestone/lp/test/test_lp.py

@@ -1,8 +1,6 @@
 # ***********************
 # test_lp.py - Unit tests
 # ***********************
-# Require Python 3 to run tests.
-
 #
 # Imports
 # =======
@@ -12,17 +10,11 @@
 # Standard library
 # ----------------
 from pathlib import Path
-from time import sleep
-from unittest import TestCase
-
 
 # Third-party imports
 # -------------------
-from selenium.webdriver.common.by import By
-from selenium.webdriver.support.ui import WebDriverWait
-from selenium.webdriver.support import expected_conditions as EC
-
-
+# None.
+#
 # Local imports
 # -------------
 from runestone.lp.lp import (
@@ -36,9 +28,6 @@
     STUDENT_SOURCE_PATH,
     read_sphinx_config,
 )
-from runestone.unittest_base import module_fixture_maker, RunestoneTestCase
-
-mf, setUpModule, tearDownModule = module_fixture_maker(__file__, True)
 
 
 # Mock classes
@@ -76,93 +65,98 @@ def sphinx_setup():
 
 # Tests
 # =====
+#
 # Test the code solution removal.
-class Unit_Test_Lp(TestCase):
-    # Make sure there were no unexpected warnings in the build.
-    def test_1(self):
-        self.assertEqual(mf.build_stderr_data.count("WARNING"), 1)
-
-    # Make sure that the student source files were generated.
-    def test_1a(self):
-        sphinx_config = read_sphinx_config()
-        sphinx_source_path = sphinx_config["SPHINX_SOURCE_PATH"]
-        sphinx_out_path = sphinx_config["SPHINX_OUT_PATH"]
-        self.assertTrue(sphinx_source_path)
-
-        # Check that a HTML version of the source was produced.
-        self.assertTrue((Path(sphinx_out_path) / "lp_tester.s-source.html").exists())
-
-        # Check that the student source has answers removed.
-        with open(
-            str(Path(sphinx_out_path) / STUDENT_SOURCE_PATH / "lp_tester.s"),
-            encoding="utf-8",
-        ) as f:
-            student_source = f.read()
-        self.assertNotIn("_u16_b: .space 2", student_source)
-        self.assertNotIn("mov #0xA15F, W0", student_source)
-
-    # Test _remove_code_solutions.
-    def test_2(self):
-        # Note: to avoid the tags being recognized when this file is parsed by Sphinx, they're broken apart in the strings below.
-        self.assertEqual(
-            _remove_code_solutions(
-                "foo.s",
-                """# line 1
+
+# Make sure there were no unexpected warnings in the build.
+def test_1(selenium_module_fixture):
+    assert selenium_module_fixture.build_stderr_data.count("WARNING") == 1
+
+
+# Make sure that the student source files were generated.
+def test_1a(selenium_module_fixture):
+    sphinx_config = read_sphinx_config()
+    sphinx_source_path = sphinx_config["SPHINX_SOURCE_PATH"]
+    sphinx_out_path = sphinx_config["SPHINX_OUT_PATH"]
+    assert sphinx_source_path
+
+    # Check that a HTML version of the source was produced.
+    assert (Path(sphinx_out_path) / "lp_tester.s-source.html").exists()
+
+    # Check that the student source has answers removed.
+    with open(
+        str(Path(sphinx_out_path) / STUDENT_SOURCE_PATH / "lp_tester.s"),
+        encoding="utf-8",
+    ) as f:
+        student_source = f.read()
+    assert "_u16_b: .space 2" not in student_source
+    assert "mov #0xA15F, W0" not in student_source
+
+
+# Test _remove_code_solutions.
+def test_2():
+    # Note: to avoid the tags being recognized when this file is parsed by Sphinx, they're broken apart in the strings below.
+    assert (
+        _remove_code_solutions(
+            "foo.s",
+            """# line 1
 # line 2
 # line 3
 # SOLUTION_"""
-                """BEGIN
+            """BEGIN
 Answer here.
 And here.
 Even more.
 # SOLUTION_"""
-                """END
+            """END
 # line 9
 # line 10
 # line 11
 #  SOLUTION_"""
-                """BEGIN
+            """BEGIN
 More answer stuff.
 # SOLUTION_"""
-                """END
+            """END
 # line 15""",
-                lambda start_line, end_line, file_name: "# Snip "
-                + str(end_line)
-                + "\n",
-            ),
-            """# line 1
+            lambda start_line, end_line, file_name: "# Snip "
+            + str(end_line)
+            + "\n",
+        ) == """# line 1
 # line 2
 # line 3
 # Snip 8
 # line 9
 # line 10
 # line 11
 # Snip 14
-# line 15""",
-        )
-
-    # Test the addition of comments to a string.
-    def test_3(self):
-        self.assertEqual(_add_line_comment_delimiter("1\n2", "foo.py"), "# 1\n# 2")
-        self.assertEqual(_add_line_comment_delimiter("1\n2", "foo.c"), "// 1\n// 2")
-
-    # Test ``_textarea_replacement``.
-    def test_4(self):
-        # Check a mimimum-length replacement.
-        self.assertEqual(
-            _textarea_replacement(3, 4, "foo.py"), TEXTAREA_REPLACEMENT_STRING.format(4)
-        )
-
-        # Check a replcement with added lines.
-        self.assertEqual(_textarea_replacement(3, 22, "foo.py").count("\n"), 20)
-
-    # Test the source-read event callback.
-    def test_5(self):
-        src = [
-            """Line 1
+# line 15"""
+    )
+
+
+# Test the addition of comments to a string.
+def test_3():
+    assert _add_line_comment_delimiter("1\n2", "foo.py") == "# 1\n# 2"
+    assert _add_line_comment_delimiter("1\n2", "foo.c") == "// 1\n// 2"
+
+
+# Test ``_textarea_replacement``.
+def test_4():
+    # Check a mimimum-length replacement.
+    assert (
+        _textarea_replacement(3, 4, "foo.py") == TEXTAREA_REPLACEMENT_STRING.format(4)
+    )
+
+    # Check a replacement with added lines.
+    assert _textarea_replacement(3, 22, "foo.py").count("\n") == 20
+
+
+# Test the source-read event callback.
+def test_5():
+    src = [
+        """Line 1
 Line 2
 SOLUTION_"""
-            """BEGIN
+        """BEGIN
 Line 4
 Line 5
 Line 6
@@ -171,15 +165,14 @@ def test_5(self):
 Line 9
 Line 10
 SOLUTION_"""
-            """END
+        """END
 Line 12"""
-        ]
-        app, env = sphinx_setup()
-        _source_read(app, env.docname, src)
-        self.assertEqual(
-            src,
-            [
-                """Line 1
+    ]
+    app, env = sphinx_setup()
+    _source_read(app, env.docname, src)
+    assert (
+        src == [
+            """Line 1
 Line 2
 
 .. raw::
@@ -191,46 +184,5 @@ def test_5(self):
 
 
 Line 12"""
-            ],
-        )
-
-
-class Functional_Test_Lp(RunestoneTestCase):
-    def test_1(self):
-        self.driver.get(self.host + "/lp_tester.s.html")
-        wait = WebDriverWait(self.driver, 10)
-        try:
-            wait.until(EC.presence_of_element_located((By.TAG_NAME, "body")))
-        except:
-            text = self.driver.page_source
-            print(text[:300])
-
-        snippets = self.driver.find_elements_by_class_name("code_snippet")
-        self.assertEqual(len(snippets), 2)
-        check_button = self.driver.find_element_by_id("e1")
-        result_area = self.driver.find_element_by_id("lp-result")
-
-        # Set snippets.
-        self.driver.execute_script(
-            'LPList["e1"].textAreas[0].setValue("xxx"); LPList["e1"].textAreas[1].setValue("yyy");'
-        )
-        self.assertFalse(result_area.text)
-
-        # Click the test button.
-        check_button.click()
-        WebDriverWait(self.driver, 10).until(
-            EC.text_to_be_present_in_element_value((By.ID, "lp-result"), "Building...")
-        )
-
-        # Refresh the page. See if saved snippets are restored.
-        self.driver.get(self.host + "/lp_tester.s.html")
-        # Wait for script to run. I don't see a wait condition what would work, unfortunately.
-        sleep(0.5)
-        self.assertEqual(
-            self.driver.execute_script('return LPList["e1"].textAreas[0].getValue();'),
-            "xxx",
-        )
-        self.assertEqual(
-            self.driver.execute_script('return LPList["e1"].textAreas[1].getValue();'),
-            "yyy",
-        )
+        ]
+    )