From ada647df79fd6d30c8e8311729d3f72ab16665ea Mon Sep 17 00:00:00 2001
From: Frank Longford <50372949+flongford@users.noreply.github.com>
Date: Mon, 30 May 2022 12:26:54 +0100
Subject: [PATCH] Update `jupyterhub` to 0.9.x series (#604)

* MAINT: update jupyterhub to 0.9.0

* MAINT: add sqlalchemy version constraint to fix deprecated package bug

* TST: update expected cookie name for spawner login

* TST: remove expected log message

* Revert "TST: remove expected log message"

This reverts commit 1f5a2f0d5551a326dc5376346ac8c04fbb776b67.

* TST: fix selenium tests for admin logins

* ENH: minor change to spawner options form html

* TST: fix to mocking in BaseHandler tests

* MAINT: bump jupyterhub to latest patch in 0.9.x series

* FIX: ensure spawner stop_single_user is waited for when logging admin out

* TST: potential fix to flakey selenium test

* TST: wait for modal to disappear from flakey selenium test
---
 remoteappmanager/handlers/tests/test_base_handler.py          | 4 +++-
 .../jupyterhub/auth/simphony_remote_auth_mixin.py             | 2 +-
 remoteappmanager/jupyterhub/spawners.py                       | 2 +-
 remoteappmanager/jupyterhub/tests/test_spawners.py            | 4 ++--
 requirements.txt                                              | 4 +++-
 selenium_tests/AdminDriverTest.py                             | 1 -
 selenium_tests/UserDriverTest.py                              | 3 +++
 selenium_tests/test_spawner_options_form.py                   | 2 --
 setup.py                                                      | 2 +-
 9 files changed, 14 insertions(+), 10 deletions(-)

diff --git a/remoteappmanager/handlers/tests/test_base_handler.py b/remoteappmanager/handlers/tests/test_base_handler.py
index e62c92381..7ad0568bc 100644
--- a/remoteappmanager/handlers/tests/test_base_handler.py
+++ b/remoteappmanager/handlers/tests/test_base_handler.py
@@ -27,13 +27,15 @@ def get_app(self):
         return app
 
 
+@mock.patch.dict('os.environ', {"JUPYTERHUB_CLIENT_ID": 'client-id'})
+@mock.patch('jupyterhub.services.auth.HubOAuth.get_user')
 class TestBaseHandlerInvalidAccounting(TestBaseHandler):
     def get_file_config(self):
         file_config = super().get_file_config()
         file_config.database_class = 'this_should_fail'
         return file_config
 
-    def test_home_internal_error(self):
+    def test_home_internal_error(self, mock_get_user):
         with ExpectLog('tornado.application', ''), \
                 ExpectLog('tornado.access', ''):
             res = self.fetch("/user/johndoe/",
diff --git a/remoteappmanager/jupyterhub/auth/simphony_remote_auth_mixin.py b/remoteappmanager/jupyterhub/auth/simphony_remote_auth_mixin.py
index 866258eac..2d82881cc 100644
--- a/remoteappmanager/jupyterhub/auth/simphony_remote_auth_mixin.py
+++ b/remoteappmanager/jupyterhub/auth/simphony_remote_auth_mixin.py
@@ -21,7 +21,7 @@ def get(self):
             if user.admin and user.spawner is not None:
                 self.log.info(f"Shutting down {user.name}'s server")
                 try:
-                    yield gen.maybe_future(self.stop_single_user(user))
+                    yield self.stop_single_user(user)
                 except HTTPClientError:
                     self.log.warning("Failed to shut down server")
             self.log.info("User logged out: %s", user.name)
diff --git a/remoteappmanager/jupyterhub/spawners.py b/remoteappmanager/jupyterhub/spawners.py
index b28e8a8a9..f08a54ab4 100644
--- a/remoteappmanager/jupyterhub/spawners.py
+++ b/remoteappmanager/jupyterhub/spawners.py
@@ -43,7 +43,7 @@ def _options_form_default(self):
         if self.user.admin:
             return """
             <div>
-                <label for="session">Choose RemoteAppManager Session:</label>
+                <legend>Choose RemoteAppManager Session:</legend>
                 <select id="session_form" name="session" size="2">
                     <option value="admin" selected>Admin</option>
                     <option value="user">User</option>
diff --git a/remoteappmanager/jupyterhub/tests/test_spawners.py b/remoteappmanager/jupyterhub/tests/test_spawners.py
index e7baac745..910a768c2 100644
--- a/remoteappmanager/jupyterhub/tests/test_spawners.py
+++ b/remoteappmanager/jupyterhub/tests/test_spawners.py
@@ -99,7 +99,7 @@ def test_args(self):
         self.spawner.config_file_path = path
         args = self.spawner.get_args()
         self.assertIn("--ip=\"127.0.0.1\"", args)
-        self.assertIn("--cookie-name=jupyter-hub-token", args)
+        self.assertIn("--cookie-name=jupyterhub-hub-login", args)
         self.assertIn("--proxy-api-url=http://127.0.0.1:12345/foo/bar/", args)
         self.assertIn("--config-file={}".format(path), args)
         self.assertIn("--base-urlpath=\"/\"", args)
@@ -107,7 +107,7 @@ def test_args(self):
     def test_args_without_config_file_path(self):
         args = self.spawner.get_args()
         self.assertIn("--ip=\"127.0.0.1\"", args)
-        self.assertIn("--cookie-name=jupyter-hub-token", args)
+        self.assertIn("--cookie-name=jupyterhub-hub-login", args)
         self.assertIn("--proxy-api-url=http://127.0.0.1:12345/foo/bar/", args)
         self.assertFalse(any("--config-file=" in arg for arg in args))
         self.assertIn("--base-urlpath=\"/\"", args)
diff --git a/requirements.txt b/requirements.txt
index a51ad5acc..5a74c9bb2 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -5,10 +5,12 @@ tornado==5.1.1
 requests==2.11.1
 docker==2.2
 escapism==0.0.1
-jupyterhub==0.8.1
+jupyterhub==0.9.6
 jupyter_client>=4.3.0
 click==6.6
 tabulate==0.7.5
 tornadowebapi @ git+http://github.com/simphony/tornado-webapi.git@8b6846faae23657a04cf97ca5229ce8ea083d000#egg=tornadowebapi
 oauthenticator==0.11.0
 jinja2>=2.8
+# Workaround for following bug in older versions of jupyterhub: https://github.com/jupyterhub/jupyterhub/pull/3383
+sqlalchemy<1.4
diff --git a/selenium_tests/AdminDriverTest.py b/selenium_tests/AdminDriverTest.py
index 0175f9ac1..55a7b6891 100644
--- a/selenium_tests/AdminDriverTest.py
+++ b/selenium_tests/AdminDriverTest.py
@@ -12,7 +12,6 @@ def admin_login(self):
         """
         self.login("admin")
 
-        self.click_first_element_located(By.ID, "start")
         self.click_first_element_located(By.CSS_SELECTOR, "input.btn")
 
     def setUp(self):
diff --git a/selenium_tests/UserDriverTest.py b/selenium_tests/UserDriverTest.py
index a2a594d3c..8c4b72c90 100644
--- a/selenium_tests/UserDriverTest.py
+++ b/selenium_tests/UserDriverTest.py
@@ -56,6 +56,8 @@ def wait_until_application_list_loaded(self):
         """ Wait until the application list is completely loaded and displayed
         """
         self.wait_until_invisibility_of_element_located(By.ID, "loading-spinner")
+        self.wait_until_invisibility_of_element_located(
+            By.CSS_SELECTOR, ".modal-fade-leave-to")
 
     @contextlib.contextmanager
     def running_container(self, index=0):
@@ -69,6 +71,7 @@ def running_container(self, index=0):
         try:
             yield
         finally:
+            self.wait_until_application_list_loaded()
             self.select_application(index)
             self.wait_until_application_running()
             self.open_application_settings()
diff --git a/selenium_tests/test_spawner_options_form.py b/selenium_tests/test_spawner_options_form.py
index bfaf8ad8e..c070b8a9e 100644
--- a/selenium_tests/test_spawner_options_form.py
+++ b/selenium_tests/test_spawner_options_form.py
@@ -8,7 +8,6 @@ class TestSpawnerOptionsForm(RemoteAppDriverTest):
     def test_admin_login_default_session(self):
         self.login("admin")
 
-        self.click_first_element_located(By.ID, "start")
         self.click_first_element_located(By.CSS_SELECTOR, "input.btn")
 
         self.wait_until_text_inside_element_located(
@@ -17,7 +16,6 @@ def test_admin_login_default_session(self):
     def test_admin_login_user_session(self):
         self.login("admin")
 
-        self.click_first_element_located(By.ID, "start")
         self.click_first_element_located(
             By.CSS_SELECTOR, "#session_form > option:nth-child(2)")
         self.click_first_element_located(By.CSS_SELECTOR, "input.btn")
diff --git a/setup.py b/setup.py
index 03dbf88c8..7dab481ab 100644
--- a/setup.py
+++ b/setup.py
@@ -41,7 +41,7 @@ def write_version_py():
         "click>=6.6",
         "tabulate>=0.7.5",
         "oauthenticator>=0.5",
-        "sqlalchemy>=1.0",
+        "sqlalchemy<1.4",
         # Pinning jinja2 requirements when building on RTD due to
         # regression when using old versions of sphinx<2
         # https://github.com/readthedocs/readthedocs.org/issues/9037