Rename url to urlpath where it is possible and appropriate

remoteappmanager/application.py

@@ -52,7 +52,7 @@ def __init__(self,
         settings.update(as_dict(command_line_config))
         settings.update(as_dict(file_config))
         settings["static_url_prefix"] = (
-            self._command_line_config.base_url + "static/")
+            self._command_line_config.base_urlpath + "static/")
 
         self._jinja_init(settings)
 
@@ -99,7 +99,7 @@ def _reverse_proxy_default(self):
         return ReverseProxy(
             endpoint_url=self.command_line_config.proxy_api_url,
             auth_token=auth_token,
-            base_urlpath=self.command_line_config.base_url
+            base_urlpath=self.command_line_config.base_urlpath
         )
 
     @default("hub")
@@ -149,11 +149,11 @@ def start(self):
     def _get_handlers(self):
         """Returns the registered handlers"""
 
-        base_url = self.command_line_config.base_url
+        base_urlpath = self.command_line_config.base_urlpath
         return [
-            (base_url, HomeHandler),
-            (base_url.rstrip('/'),
-             web.RedirectHandler, {"url": base_url}),
+            (base_urlpath, HomeHandler),
+            (base_urlpath.rstrip('/'),
+             web.RedirectHandler, {"url": base_urlpath}),
         ]
 
     def _jinja_init(self, settings):

remoteappmanager/command_line_config.py

@@ -22,7 +22,7 @@ class CommandLineConfig(HasTraits):
 
     # This is the url path that the user sees and which leads to this server.
     # typically, it's /user/username
-    base_url = Unicode(help="The base url where the server resides")
+    base_urlpath = Unicode(help="The base url where the server resides")
 
     # This is the host of the hub. It's always empty (jupyterhub decision)
     hub_host = Unicode(help="The url of the jupyterhub server")
@@ -64,5 +64,5 @@ def parse_config(self):
 
         set_traits_from_dict(self, options)
 
-        # Normalize the base_url to end with a slash
-        self.base_url = with_end_slash(self.base_url)
+        # Normalize the base_urlpath to end with a slash
+        self.base_urlpath = with_end_slash(self.base_urlpath)

remoteappmanager/handlers/base_handler.py

@@ -32,7 +32,7 @@ def render(self, template_name, **kwargs):
         """
         args = dict(
             user=self.current_user,
-            base_url=self.application.command_line_config.base_url,
+            base_url=self.application.command_line_config.base_urlpath,
             logout_url=urljoin(
                 self.application.command_line_config.hub_prefix,
                 "logout")

remoteappmanager/handlers/home_handler.py

@@ -112,11 +112,11 @@ def _actionhandler_start(self, options):
 
         # The server is up and running. Now contact the proxy and add
         # the container url to it.
-        url = yield self.application.reverse_proxy.add_container(container)
+        urlpath = yield self.application.reverse_proxy.add_container(container)
 
         # Redirect the user
-        self.log.info('Redirecting to {}'.format(url))
-        self.redirect(url)
+        self.log.info('Redirecting to {}'.format(urlpath))
+        self.redirect(urlpath)
 
     @gen.coroutine
     def _actionhandler_view(self, options):
@@ -136,10 +136,10 @@ def _actionhandler_view(self, options):
         yield self._wait_for_container_ready(container)
 
         # in case the reverse proxy is not already set up
-        url = yield self.application.reverse_proxy.add_container(container)
+        urlpath = yield self.application.reverse_proxy.add_container(container)
 
-        self.log.info('Redirecting to {}'.format(url))
-        self.redirect(url)
+        self.log.info('Redirecting to {}'.format(urlpath))
+        self.redirect(urlpath)
 
     @gen.coroutine
     def _actionhandler_stop(self, options):
@@ -166,7 +166,7 @@ def _actionhandler_stop(self, options):
 
         # We don't have fancy stuff at the moment to change the button, so
         # we just reload the page.
-        self.redirect(self.application.command_line_config.base_url)
+        self.redirect(self.application.command_line_config.base_urlpath)
 
     # private
 
@@ -302,7 +302,7 @@ def _wait_for_container_ready(self, container):
         server_url = "http://{}:{}{}/".format(
             container.ip,
             container.port,
-            url_path_join(self.application.command_line_config.base_url,
+            url_path_join(self.application.command_line_config.base_urlpath,
                           container.urlpath))
 
         yield _wait_for_http_server_2xx(

remoteappmanager/spawner.py

@@ -33,6 +33,10 @@ def __init__(self, **kwargs):
 
     def get_args(self):
         args = super().get_args()
+
+        for iarg, arg in enumerate(args):
+            args[iarg] = arg.replace('--base-url=', '--base-urlpath=')
+
         args.append("--proxy-api-url={}".format(self.proxy.api_server.url))
         args.append("--config-file={}".format(self.config_file_path))
         return args
@@ -103,6 +107,10 @@ def clear_state(self):
 
     def get_args(self):
         args = super().get_args()
+
+        for iarg, arg in enumerate(args):
+            args[iarg] = arg.replace('--base-url=', '--base-urlpath=')
+
         args.append("--proxy-api-url={}".format(self.proxy.api_server.url))
         args.append("--config-file={}".format(self.config_file_path))
         return args

remoteappmanager/utils.py

@@ -1,7 +1,9 @@
 def url_path_join(*pieces):
-    """Join components of url into a relative url
+    """Join components of url into a relative url path
     Use to prevent double slash when joining subpath. This will leave the
     initial and final / in place
+
+    Assume pieces do not contain protocol (e.g. http://)
     """
     stripped = [s.strip('/') for s in pieces]
     result = '/'.join(s for s in stripped if s)

tests/handlers/test_home_handler.py

@@ -59,7 +59,7 @@ def get_app(self):
             'pending': None,
             'name': command_line_config.user,
             'admin': False,
-            'server': command_line_config.base_url})
+            'server': command_line_config.base_urlpath})
         app.db = mock.Mock(spec=ABCAccounting)
         app.container_manager = mock.Mock(spec=ContainerManager)
         app.container_manager.start_container = mock_coro_factory(Container())

tests/spawner/test_spawner.py

@@ -83,6 +83,7 @@ def test_args(self):
         args = self.spawner.get_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)
 
     def test_cmd(self):
         self.assertEqual(self.spawner.cmd, ['remoteappmanager'])

tests/test_command_line_config.py

@@ -18,7 +18,7 @@ def setUp(self):
 
     def test_initialization(self):
         for key, value in arguments.items():
-            if key == "base-url":
+            if key == "base-urlpath":
                 value = with_end_slash(value)
 
             self.assertEqual(getattr(self.config, key.replace("-", "_")),

tests/utils.py

@@ -251,7 +251,7 @@ def containers_dict():
     "user": "username",
     "port": 57022,
     "cookie-name": "jupyter-hub-token-username",
-    "base-url": "/user/username/",
+    "base-urlpath": "/user/username/",
     "hub-host": "",
     "hub-prefix": "/hub/",
     "hub-api-url": "http://172.17.5.167:8081/hub/api",