contract 0.18.0: one name per display role, the kiosk's own

Core called the roles dashboard / lobby / partskiosk. The kiosks call them
Dashboard / Lobby / 3DPrintRoom, which are the literal contents of
C:\Enrollment\display-type.txt, read by the GE-Enforce dispatcher to pick a
target. Two vocabularies for three kiosks, each with its own copy of the same
route map.

That is not cosmetic. A display reporting its own type sends what its file
says, so it could report a role core would not accept, and core could store
'partskiosk', a value no dispatcher would ever match. The enforcement report
column would have shown one vocabulary from the device and the other from the
DashboardDefault fallback, in the same column.

The machine's file wins, because that is what a person edits. DISPLAY_ROLE_PATHS
takes the kiosk spelling and the display scope now uses that dict rather than
holding a second one, so the two cannot drift again. normalize_display_role
resolves any casing and the retired 'partskiosk' forward; the dispatcher already
matched its map case-insensitively and the server now agrees with it.

Nothing is turned away over a capital: the API accepts any spelling and stores
the canonical one, displaypath resolves through the normalizer so rows written
before this keep working, and the settings dropdown canonicalises on open so an
old value does not render as a blank select.

A reported subtype is normalised on the way in, but an UNRECOGNISED one is kept
verbatim. That is a kiosk with a typo in its file or a role nobody declared, and
both are worth seeing in the fleet table rather than blanked or guessed at.

Contract bumped for the added names. DashboardDefault is finally listed in
__all__ too - 0.17.0 put it on the surface and never exported it.
This commit is contained in:
cproudlock
2026-08-13 09:28:26 -04:00
parent 9336577abe
commit 20a95013ad
12 changed files with 307 additions and 45 deletions

View File

@@ -100,7 +100,11 @@ def test_non_admin_cannot_update_or_delete(client, db, auth_headers,
def test_lobby_role_needs_no_businessunit_and_resolves_path(client, db, auth_headers):
"""A lobby-role mapping needs no business unit; display-role returns its path."""
"""A Lobby mapping needs no business unit; display-role returns its path.
Posts the RETIRED lowercase spelling on purpose: an existing caller must not
start failing over a capital, and what comes back is the canonical name.
"""
created = client.post('/api/dashboarddefaults', json={
'ipaddress': '10.20.30.99', 'displayrole': 'lobby',
'description': 'Front lobby TV',
@@ -110,17 +114,19 @@ def test_lobby_role_needs_no_businessunit_and_resolves_path(client, db, auth_hea
resolved = client.get('/api/dashboarddefaults/display-role?ipaddress=10.20.30.99')
data = resolved.get_json()['data']
assert data['role'] == 'lobby'
assert data['role'] == 'Lobby'
assert data['path'] == '/tv'
assert data['businessunitid'] is None
def test_partskiosk_role_resolves_path(client, db, auth_headers):
def test_retired_partskiosk_spelling_maps_to_3dprintroom(client, db, auth_headers):
# 'partskiosk' was core's name for the room the kiosks call '3DPrintRoom'.
# It still posts, and stores as the name the kiosk itself would report.
client.post('/api/dashboarddefaults', json={
'ipaddress': '10.20.30.77', 'displayrole': 'partskiosk',
}, headers=auth_headers)
data = client.get('/api/dashboarddefaults/display-role?ipaddress=10.20.30.77').get_json()['data']
assert data['role'] == 'partskiosk'
assert data['role'] == '3DPrintRoom'
assert data['path'] == '/parts-kiosk'
@@ -143,7 +149,7 @@ def test_fqdn_mapping_create_and_resolve(client, db, auth_headers):
# resolve by FQDN (case-insensitive)
r = client.get('/api/dashboarddefaults/display-role?fqdn=fabc123.device.geaerospace.net')
body = r.get_json()['data']
assert body['role'] == 'lobby'
assert body['role'] == 'Lobby'
assert body['path'] == '/tv'
@@ -164,3 +170,63 @@ def test_invalid_role_rejected(client, db, auth_headers):
def test_unmapped_ip_display_role_null(client, db):
data = client.get('/api/dashboarddefaults/display-role?ipaddress=9.9.9.9').get_json()['data']
assert data['role'] is None and data['path'] is None
# --- role vocabulary -------------------------------------------------------
#
# The role names are not ours to choose: they are the literal values a person
# types into C:\Enrollment\display-type.txt on the kiosk, which the GE-Enforce
# dispatcher reads. These tests exist because core and the kiosks each used to
# hold their own map, and a display could report a role core could not store.
def test_display_roles_are_the_kiosk_vocabulary():
from shopdb.core.models.dashboarddefault import DISPLAY_ROLE_PATHS
assert DISPLAY_ROLE_PATHS == {
'Dashboard': '/shopfloor',
'Lobby': '/tv',
'3DPrintRoom': '/parts-kiosk',
}
def test_geenforce_display_targets_are_core_roles():
"""The display scope must not carry a second copy of the map."""
from shopdb.core.models.dashboarddefault import DISPLAY_ROLE_PATHS
from plugins.geenforce.seed_display_scope import DISPLAY_TYPE_TARGETS
assert DISPLAY_TYPE_TARGETS is DISPLAY_ROLE_PATHS
def test_normalize_display_role_accepts_any_casing():
from shopdb.core.models.dashboarddefault import normalize_display_role
for value in ('Lobby', 'lobby', 'LOBBY', ' Lobby '):
assert normalize_display_role(value) == 'Lobby'
assert normalize_display_role('3dprintroom') == '3DPrintRoom'
assert normalize_display_role('DASHBOARD') == 'Dashboard'
def test_normalize_display_role_maps_retired_spelling():
from shopdb.core.models.dashboarddefault import normalize_display_role
assert normalize_display_role('partskiosk') == '3DPrintRoom'
assert normalize_display_role('PartsKiosk') == '3DPrintRoom'
def test_normalize_display_role_refuses_to_guess():
from shopdb.core.models.dashboarddefault import normalize_display_role
for value in (None, '', ' ', 'bogus', '3d', 'lobbyy'):
assert normalize_display_role(value) is None
def test_mixed_case_role_stores_canonically(client, db, auth_headers):
resp = client.post('/api/dashboarddefaults', json={
'ipaddress': '10.20.30.31', 'displayrole': 'LOBBY',
}, headers=auth_headers)
assert resp.status_code == 201, resp.get_json()
assert resp.get_json()['data']['displayrole'] == 'Lobby'
def test_legacy_stored_value_still_resolves_a_path(db):
"""A row written before the merge keeps working without being rewritten."""
from shopdb.core.models.dashboarddefault import DashboardDefault
row = DashboardDefault(ipaddress='10.20.30.32', displayrole='partskiosk')
db.session.add(row)
db.session.flush()
assert row.displaypath == '/parts-kiosk'

View File

@@ -227,3 +227,39 @@ def test_report_without_a_subtype_stores_none(db):
stored = ManifestEnforcementReport.query.filter_by(
hostname='WJPC77', iscurrent=True).one()
assert stored.subtype is None
def test_reported_subtype_is_normalised_to_the_role_vocabulary(db):
"""display-type.txt is hand-edited, so its casing drifts across the fleet.
Normalising on the way in keeps the fleet table reading one vocabulary
instead of whatever each kiosk happened to be typed as.
"""
from plugins.geenforce.service import record_enforcement_report
for index, reported in enumerate(('lobby', 'LOBBY', ' Lobby ')):
host = f'WJKIOSKCASE{index}'
record_enforcement_report({'hostname': host,
'scopename': 'gea-shopfloor-display',
'subtype': reported, 'counts': {}})
db.session.flush()
stored = ManifestEnforcementReport.query.filter_by(
hostname=host, iscurrent=True).one()
assert stored.subtype == 'Lobby', reported
def test_reported_subtype_keeps_an_unknown_value_verbatim(db):
"""An unrecognised subtype is a typo on a kiosk or a role nobody declared.
Both are worth SEEING in the fleet table, so the value is stored as sent
rather than blanked or guessed at.
"""
from plugins.geenforce.service import record_enforcement_report
record_enforcement_report({'hostname': 'WJKIOSKODD', 'scopename': 'gea-shopfloor-display',
'subtype': 'Lobbby', 'counts': {}})
db.session.flush()
stored = ManifestEnforcementReport.query.filter_by(
hostname='WJKIOSKODD', iscurrent=True).one()
assert stored.subtype == 'Lobbby'