hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-15 05:53:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

test and fix deprecated load_groups list

Browse Source
This commit is contained in:
Min RK
2023-01-11 13:51:41 +01:00
parent 126f8d0115
commit 728b4e3dc7
2 changed files with 24 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
jupyterhub/app.py
View File

@@ -298,9 +298,9 @@ class JupyterHub(Application):
return classes return classes
load_groups = Dict( load_groups = Dict(
Dict(), Union([Dict(), List()]),
help=""" help="""
Dict of `{'group': {'users':['usernames'], properties : {}}` to load at startup. Dict of `{'group': {'users':['usernames'], 'properties': {}}` to load at startup.
Example:: Example::
@@ -311,7 +311,8 @@ class JupyterHub(Application):
}, },
} }
This strictly *adds* groups, users and properties to groups. This strictly *adds* groups and users to groups.
Properties, if defined, replace all existing properties.
Loading one set of groups, then starting JupyterHub again with a different Loading one set of groups, then starting JupyterHub again with a different
set will not remove users or groups from previous launches. set will not remove users or groups from previous launches.
@@ -2079,11 +2080,17 @@ class JupyterHub(Application):
for username in contents['users']: for username in contents['users']:
username = self.authenticator.normalize_username(username) username = self.authenticator.normalize_username(username)
user = await self._get_or_create_user(username) user = await self._get_or_create_user(username)
if group not in user.groups:
self.log.debug(f"Adding user {username} to group {name}") self.log.debug(f"Adding user {username} to group {name}")
group.users.append(user) group.users.append(user)
if 'properties' in contents: if 'properties' in contents:
group_properties = contents['properties'] group_properties = contents['properties']
self.log.debug(f"Adding properties {group_properties} to group {name}") if group.properties != group_properties:
# add equality check to avoid no-op db transactions
self.log.debug(
f"Adding properties to group {name}: {group_properties}"
)
group.properties = group_properties group.properties = group_properties
db.commit() db.commit()

13
jupyterhub/tests/test_app.py
View File

@@ -233,15 +233,16 @@ def test_cookie_secret_string_():
async def test_load_groups(tmpdir, request): async def test_load_groups(tmpdir, request):
to_load = { to_load = {
'blue': { 'blue': {
'users': ['cyclops', 'rogue', 'wolverine'], 'users': ['cyclops', 'rogue', 'wolverine'],
'properties': {'setting1': 'one', 'setting2': 'two'},
}, },
'gold': { 'gold': {
'users': ['storm', 'jean-grey', 'colossus'], 'users': ['storm', 'jean-grey', 'colossus'],
'properties': {'setting3': 'three', 'setting4': 'four'}, 'properties': {'setting3': 'three', 'setting4': 'four'},
}, },
'deprecated_list': ['jubilee', 'magik'],
} }
kwargs = {'load_groups': to_load} kwargs = {'load_groups': to_load}
ssl_enabled = getattr(request.module, "ssl_enabled", False) ssl_enabled = getattr(request.module, "ssl_enabled", False)
@@ -258,11 +259,17 @@ async def test_load_groups(tmpdir, request):
blue = orm.Group.find(db, name='blue') blue = orm.Group.find(db, name='blue')
assert blue is not None assert blue is not None
assert sorted(u.name for u in blue.users) == sorted(to_load['blue']['users']) assert sorted(u.name for u in blue.users) == sorted(to_load['blue']['users'])
assert sorted(u for u in blue.properties) == sorted(to_load['blue']['properties']) assert blue.properties == {}
gold = orm.Group.find(db, name='gold') gold = orm.Group.find(db, name='gold')
assert gold is not None assert gold is not None
assert sorted(u.name for u in gold.users) == sorted(to_load['gold']['users']) assert sorted(u.name for u in gold.users) == sorted(to_load['gold']['users'])
assert sorted(u for u in gold.properties) == sorted(to_load['gold']['properties']) assert gold.properties == to_load['gold']['properties']
deprecated_list = orm.Group.find(db, name='deprecated_list')
assert deprecated_list is not None
assert deprecated_list.properties == {}
assert sorted(u.name for u in deprecated_list.users) == sorted(
to_load['deprecated_list']
)
async def test_resume_spawners(tmpdir, request): async def test_resume_spawners(tmpdir, request):