Merge branch 'save_book_filter_state' into develop

Author: jzohrab

lute/templates/book/tablelisting.html

@@ -15,9 +15,12 @@
 </form>
 
 <script>
-  
+
+  /* The book listing. */
+  var book_listing_table;
+
   let setup_text_datatable = function(initial_search) {
-    var table = $('#booktable').DataTable({
+    book_listing_table = $('#booktable').DataTable({
       {% if status != 'Archived' %}
       "language": {
             "emptyTable": "No books available. <a href='/book/new'>Create one?</a>"
@@ -32,6 +35,7 @@
       searching: true,
       processing: true,
       serverSide: true,
+      stateSave: true,
       search: { search: initial_search },
       columnDefs: [
         {
@@ -156,4 +160,16 @@
     do_action_post('delete', bookid);
   }
 
+  /**
+   * Clearing the state is required for acceptance tests,
+   * because otherwise state is accidentally applied to
+   * following tests, messing up test results.
+   * I tried various things such as setting and clearing
+   * the filter input box, but this was the only method
+   * that worked reliably.
+   * This is called from the lute_test_client.py.
+   */
+  function clear_datatable_state() {
+    book_listing_table.state.clear();
+  }
 </script>

tasks.py

@@ -206,7 +206,15 @@ def black(c):
     c.run("python -m black .")
 
 
-@task(pre=[test, accept, playwright, black, lint])
+@task(pre=[test, accept, playwright])
+def fulltest(c):  # pylint: disable=unused-argument
+    """
+    Run full tests check.
+    """
+    print("Done.")
+
+
+@task(pre=[fulltest, black, lint])
 def full(c):  # pylint: disable=unused-argument
     """
     Run full check and lint.
@@ -215,6 +223,7 @@ def full(c):  # pylint: disable=unused-argument
 
 
 ns = Collection()
+ns.add_task(fulltest)
 ns.add_task(full)
 ns.add_task(lint)
 ns.add_task(test)

tests/acceptance/conftest.py

@@ -139,6 +139,7 @@ def given_running_site(luteclient):
     resp = requests.get(luteclient.home, timeout=5)
     assert resp.status_code == 200, f"{luteclient.home} is up"
     luteclient.visit("/")
+    luteclient.clear_book_filter()
     assert luteclient.browser.is_text_present("Lute")
 
 
@@ -188,7 +189,17 @@ def given_demo_langs_loaded(luteclient):
 
 @given("the demo stories are loaded")
 def given_demo_stories_loaded(luteclient):
+    "Load the demo stories."
     luteclient.load_demo_stories()
+    luteclient.visit("/")
+    luteclient.clear_book_filter()
+
+
+@given("I clear the book filter")
+def given_clear_book_filter(luteclient):
+    "clear filter."
+    luteclient.visit("/")
+    luteclient.clear_book_filter()
 
 
 @given(parsers.parse("I update the {lang} language:\n{content}"))

tests/acceptance/lute_test_client.py

@@ -44,6 +44,8 @@ def __init__(self, b, home):
     def load_demo_stories(self):
         "Load the demo stories."
         self.visit("dev_api/load_demo_stories")
+        self.visit("/")
+        self.clear_book_filter()
 
     def change_parser_registry_key(self, key, replacement):
         """
@@ -67,6 +69,11 @@ def index(self):
         "Go to home page."
         self.browser.visit("")
 
+    def clear_book_filter(self):
+        "Clear all state.  Normally state is saved."
+        self.browser.execute_script("clear_datatable_state()")
+        time.sleep(0.1)
+
     def click_link(self, linktext):
         self.browser.links.find_by_text(linktext).click()
 

tests/acceptance/reading.feature

@@ -105,6 +105,7 @@ Feature: User can actually read and stuff.
         When I click the "Tutorial" link
         And I click the footer next page
         Given I visit "/"
+        And I clear the book filter
         And the book table loads "Tutorial"
         Then the page contains "Tutorial (2/"
 

tests/acceptance/test_smoke.py

@@ -6,6 +6,7 @@
 def test_smoke_test(chromebrowser, luteclient):
     "Hit the main page, create a book, update a term."
     luteclient.visit("/")
+    luteclient.clear_book_filter()
     assert chromebrowser.is_text_present("Lute"), "have main page."
     luteclient.make_book("Hola", "Hola. Adios amigo.", "Spanish")
     assert chromebrowser.title == 'Reading "Hola"', "title"
@@ -26,6 +27,7 @@ def test_unsupported_language_not_shown(luteclient, _restore_jp_parser):
 
     luteclient.change_parser_registry_key("japanese", "disabled_japanese")
     luteclient.visit("/")
+    luteclient.clear_book_filter()
     assert not luteclient.browser.is_text_present("Japanese"), "no Japanese demo book."
     assert luteclient.browser.is_text_present(
         "Tutorial"