From e2bdab3c17f415868cedc20bd11e2823fe4e1f84 Mon Sep 17 00:00:00 2001 From: Stefano Borini Date: Fri, 26 Aug 2016 11:12:29 +0100 Subject: [PATCH 1/3] Renamed modules and spawner. --- doc/source/api/remoteappmanager.rst | 6 +++--- doc/source/configuration.rst | 8 ++++---- jupyterhub/jupyterhub_config.py | 4 ++-- remoteappmanager/{spawner.py => spawners.py} | 2 +- remoteappmanager/tests/test_spawner.py | 4 ++-- 5 files changed, 12 insertions(+), 12 deletions(-) rename remoteappmanager/{spawner.py => spawners.py} (99%) diff --git a/doc/source/api/remoteappmanager.rst b/doc/source/api/remoteappmanager.rst index 8db8b7de2..4fc61bd24 100644 --- a/doc/source/api/remoteappmanager.rst +++ b/doc/source/api/remoteappmanager.rst @@ -74,10 +74,10 @@ remoteappmanager.paths module :undoc-members: :show-inheritance: -remoteappmanager.spawner module -------------------------------- +remoteappmanager.spawners module +-------------------------------- -.. automodule:: remoteappmanager.spawner +.. automodule:: remoteappmanager.spawners :members: :undoc-members: :show-inheritance: diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index e0bb8889d..93eeeb2db 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -10,13 +10,13 @@ The jupyterhub configuration is documented in the `jupyterhub documentation `_. The important difference is the spawner to use, which is configured as:: - c.JupyterHub.spawner_class = 'remoteappmanager.spawner.Spawner' + c.JupyterHub.spawner_class = 'remoteappmanager.spawners.SystemUserSpawner' # or - # c.JupyterHub.spawner_class = 'remoteappmanager.spawner.VirtualUserSpawner' + # c.JupyterHub.spawner_class = 'remoteappmanager.spawners.VirtualUserSpawner' in the `jupyterhub_config.py` file. -Please refer to :py:mod:`remoteappmanager.spawner` for the available spawners +Please refer to :py:mod:`remoteappmanager.spawners` for the available spawners in this project. @@ -51,7 +51,7 @@ docker setup. config file. The path of the config file should be specified in the spawner in `jupyterhub_config.py`:: - c.Spawner.config_file_path = "/path/to/config.py" + c.SystemUserSpawner.config_file_path = "/path/to/config.py" Please refer to :py:class:`remoteappmanager.file_config.FileConfig` for the configurable parameters. Note that this config file will be used diff --git a/jupyterhub/jupyterhub_config.py b/jupyterhub/jupyterhub_config.py index 13b686986..afe9ecb72 100644 --- a/jupyterhub/jupyterhub_config.py +++ b/jupyterhub/jupyterhub_config.py @@ -12,7 +12,7 @@ setting_mode = ('system_user', 'virtual_user')[1] if setting_mode == 'virtual_user': - c.JupyterHub.spawner_class = 'remoteappmanager.spawner.VirtualUserSpawner' + c.JupyterHub.spawner_class = 'remoteappmanager.spawners.VirtualUserSpawner' # Parent directory in which temporary directory is created for # each virtual user @@ -25,4 +25,4 @@ 'remoteappmanager.auth.WorldAuthenticator') elif setting_mode == 'system_user': - c.JupyterHub.spawner_class = 'remoteappmanager.spawner.Spawner' + c.JupyterHub.spawner_class = 'remoteappmanager.spawners.Spawner' diff --git a/remoteappmanager/spawner.py b/remoteappmanager/spawners.py similarity index 99% rename from remoteappmanager/spawner.py rename to remoteappmanager/spawners.py index bdd149131..85e0bf6d7 100644 --- a/remoteappmanager/spawner.py +++ b/remoteappmanager/spawners.py @@ -14,7 +14,7 @@ # of not updating one of them. -class Spawner(LocalProcessSpawner): +class SystemUserSpawner(LocalProcessSpawner): ''' Start remoteappmanager as a local process for a system user. The user identifier of the process is set to be the system user. diff --git a/remoteappmanager/tests/test_spawner.py b/remoteappmanager/tests/test_spawner.py index ec682415a..8d5a15a93 100644 --- a/remoteappmanager/tests/test_spawner.py +++ b/remoteappmanager/tests/test_spawner.py @@ -9,7 +9,7 @@ from tornado import testing from jupyterhub import orm -from remoteappmanager.spawner import Spawner, VirtualUserSpawner +from remoteappmanager.spawners import SystemUserSpawner, VirtualUserSpawner from remoteappmanager.tests import fixtures from remoteappmanager.tests.temp_mixin import TempMixin @@ -75,7 +75,7 @@ def new_spawner(spawner_class): class TestSpawner(TempMixin, testing.AsyncTestCase): def setUp(self): super().setUp() - self.spawner = new_spawner(Spawner) + self.spawner = new_spawner(SystemUserSpawner) def test_args(self): path = fixtures.get("remoteappmanager_config.py") From 841954145bcb49dd5f1eb89a0e84846788e388f3 Mon Sep 17 00:00:00 2001 From: Stefano Borini Date: Fri, 26 Aug 2016 11:33:29 +0100 Subject: [PATCH 2/3] Renamed tests --- remoteappmanager/tests/{test_spawner.py => test_spawners.py} | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename remoteappmanager/tests/{test_spawner.py => test_spawners.py} (98%) diff --git a/remoteappmanager/tests/test_spawner.py b/remoteappmanager/tests/test_spawners.py similarity index 98% rename from remoteappmanager/tests/test_spawner.py rename to remoteappmanager/tests/test_spawners.py index 8d5a15a93..b19b413f4 100644 --- a/remoteappmanager/tests/test_spawner.py +++ b/remoteappmanager/tests/test_spawners.py @@ -72,7 +72,7 @@ def new_spawner(spawner_class): return spawner_class(db=db, user=user, hub=hub) -class TestSpawner(TempMixin, testing.AsyncTestCase): +class TestSystemUserSpawner(TempMixin, testing.AsyncTestCase): def setUp(self): super().setUp() self.spawner = new_spawner(SystemUserSpawner) @@ -149,7 +149,7 @@ def test_spawner_start_and_stop_without_config_file(self): self.assertEqual(status, 1) -class TestVirtualUserSpawner(TestSpawner): +class TestVirtualUserSpawner(TestSystemUserSpawner): def setUp(self): super().setUp() self.spawner = new_spawner(VirtualUserSpawner) From 8d98fe5570ce37512128d46853000dc860f798b2 Mon Sep 17 00:00:00 2001 From: Stefano Borini Date: Fri, 26 Aug 2016 11:34:49 +0100 Subject: [PATCH 3/3] Update jupyterhub_config.py --- jupyterhub/jupyterhub_config.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/jupyterhub/jupyterhub_config.py b/jupyterhub/jupyterhub_config.py index afe9ecb72..d65831e51 100644 --- a/jupyterhub/jupyterhub_config.py +++ b/jupyterhub/jupyterhub_config.py @@ -25,4 +25,4 @@ 'remoteappmanager.auth.WorldAuthenticator') elif setting_mode == 'system_user': - c.JupyterHub.spawner_class = 'remoteappmanager.spawners.Spawner' + c.JupyterHub.spawner_class = 'remoteappmanager.spawners.SystemUserSpawner'