context: use autogenerated name to improve multi-tenancy

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 23.10
+
+* A context now has a read-only auto-generated `name` and a required `label` instead
+  of a user-provided `name` and optional `label`. For compatibility purposes, if a context is
+  created using only a `name`, it will be used as the `label` and auto-generated.
+
 ## 23.04
 
 * PUT on `/users?recursive=true` updated, to provide a way to update lines, switchboards, agent, voicemail and incalls for a specific user.

integration_tests/suite/base/test_agents.py

@@ -1,4 +1,4 @@
-# Copyright 2018-2022 The Wazo Authors  (see the AUTHORS file)
+# Copyright 2018-2023 The Wazo Authors  (see the AUTHORS file)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from hamcrest import (
@@ -81,7 +81,7 @@ def error_checks(url):
     yield s.check_bogus_field_returns_error, url, 'preprocess_subroutine', 123
     yield s.check_bogus_field_returns_error, url, 'preprocess_subroutine', True
     yield s.check_bogus_field_returns_error, url, 'preprocess_subroutine', s.random_string(
-        40
+        80
     )
     yield s.check_bogus_field_returns_error, url, 'preprocess_subroutine', []
     yield s.check_bogus_field_returns_error, url, 'preprocess_subroutine', {}

integration_tests/suite/base/test_conference_extension.py

@@ -1,4 +1,4 @@
-# Copyright 2016-2020 The Wazo Authors  (see the AUTHORS file)
+# Copyright 2016-2023 The Wazo Authors  (see the AUTHORS file)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from hamcrest import assert_that, contains, has_entries
@@ -47,37 +47,40 @@ def test_associate(extension, conference):
 @fixtures.conference(wazo_tenant=SUB_TENANT)
 @fixtures.context(
     wazo_tenant=MAIN_TENANT,
-    name='main-internal',
+    label='main-internal',
     conference_room_ranges=[{'start': '4000', 'end': '4999'}],
 )
 @fixtures.context(
     wazo_tenant=SUB_TENANT,
-    name='sub-internal',
+    label='sub-internal',
     conference_room_ranges=[{'start': '4000', 'end': '4999'}],
 )
-@fixtures.extension(context='main-internal', exten=gen_conference_exten())
-@fixtures.extension(context='sub-internal', exten=gen_conference_exten())
-def test_associate_multi_tenant(main, sub, _, __, main_exten, sub_exten):
-    response = (
-        confd.conferences(sub['id'])
-        .extensions(main_exten['id'])
-        .put(wazo_tenant=SUB_TENANT)
-    )
-    response.assert_match(404, e.not_found('Extension'))
-
-    response = (
-        confd.conferences(main['id'])
-        .extensions(sub_exten['id'])
-        .put(wazo_tenant=SUB_TENANT)
-    )
-    response.assert_match(404, e.not_found('Conference'))
-
-    response = (
-        confd.conferences(main['id'])
-        .extensions(sub_exten['id'])
-        .put(wazo_tenant=MAIN_TENANT)
-    )
-    response.assert_match(400, e.different_tenant())
+def test_associate_multi_tenant(main, sub, main_ctx, sub_ctx):
+    @fixtures.extension(context=main_ctx['name'], exten=gen_conference_exten())
+    @fixtures.extension(context=sub_ctx['name'], exten=gen_conference_exten())
+    def aux(main_exten, sub_exten):
+        response = (
+            confd.conferences(sub['id'])
+            .extensions(main_exten['id'])
+            .put(wazo_tenant=SUB_TENANT)
+        )
+        response.assert_match(404, e.not_found('Extension'))
+
+        response = (
+            confd.conferences(main['id'])
+            .extensions(sub_exten['id'])
+            .put(wazo_tenant=SUB_TENANT)
+        )
+        response.assert_match(404, e.not_found('Conference'))
+
+        response = (
+            confd.conferences(main['id'])
+            .extensions(sub_exten['id'])
+            .put(wazo_tenant=MAIN_TENANT)
+        )
+        response.assert_match(400, e.different_tenant())
+
+    aux()
 
 
 @fixtures.conference()
@@ -159,30 +162,33 @@ def test_dissociate(conference, extension):
 @fixtures.conference(wazo_tenant=SUB_TENANT)
 @fixtures.context(
     wazo_tenant=MAIN_TENANT,
-    name='main-internal',
+    label='main-internal',
     conference_room_ranges=[{'start': '4000', 'end': '4999'}],
 )
 @fixtures.context(
     wazo_tenant=SUB_TENANT,
-    name='sub-internal',
+    label='sub-internal',
     conference_room_ranges=[{'start': '4000', 'end': '4999'}],
 )
-@fixtures.extension(context='main-internal', exten=gen_conference_exten())
-@fixtures.extension(context='sub-internal', exten=gen_conference_exten())
-def test_dissociate_multi_tenant(main, sub, _, __, main_exten, sub_exten):
-    response = (
-        confd.conferences(sub['id'])
-        .extensions(main_exten['id'])
-        .delete(wazo_tenant=SUB_TENANT)
-    )
-    response.assert_match(404, e.not_found('Extension'))
-
-    response = (
-        confd.conferences(main['id'])
-        .extensions(sub_exten['id'])
-        .delete(wazo_tenant=SUB_TENANT)
-    )
-    response.assert_match(404, e.not_found('Conference'))
+def test_dissociate_multi_tenant(main, sub, main_ctx, sub_ctx):
+    @fixtures.extension(context=main_ctx['name'], exten=gen_conference_exten())
+    @fixtures.extension(context=sub_ctx['name'], exten=gen_conference_exten())
+    def aux(main_exten, sub_exten):
+        response = (
+            confd.conferences(sub['id'])
+            .extensions(main_exten['id'])
+            .delete(wazo_tenant=SUB_TENANT)
+        )
+        response.assert_match(404, e.not_found('Extension'))
+
+        response = (
+            confd.conferences(main['id'])
+            .extensions(sub_exten['id'])
+            .delete(wazo_tenant=SUB_TENANT)
+        )
+        response.assert_match(404, e.not_found('Conference'))
+
+    aux()
 
 
 @fixtures.conference()

integration_tests/suite/base/test_conferences.py

@@ -1,4 +1,4 @@
-# Copyright 2016-2022 The Wazo Authors  (see the AUTHORS file)
+# Copyright 2016-2023 The Wazo Authors  (see the AUTHORS file)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from hamcrest import (
@@ -59,7 +59,7 @@ def error_checks(url):
     yield s.check_bogus_field_returns_error, url, 'preprocess_subroutine', True
     yield s.check_bogus_field_returns_error, url, 'preprocess_subroutine', 123
     yield s.check_bogus_field_returns_error, url, 'preprocess_subroutine', s.random_string(
-        40
+        80
     )
     yield s.check_bogus_field_returns_error, url, 'preprocess_subroutine', []
     yield s.check_bogus_field_returns_error, url, 'preprocess_subroutine', {}

integration_tests/suite/base/test_contexts.py

@@ -1,4 +1,4 @@
-# Copyright 2016-2022 The Wazo Authors  (see the AUTHORS file)
+# Copyright 2016-2023 The Wazo Authors  (see the AUTHORS file)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from hamcrest import (
@@ -34,24 +34,23 @@ def test_post_errors():
     for check in error_checks(url):
         yield check
 
-    yield s.check_bogus_field_returns_error, url, 'name', 123
-    yield s.check_bogus_field_returns_error, url, 'name', True
-    yield s.check_bogus_field_returns_error, url, 'name', None
-    yield s.check_bogus_field_returns_error, url, 'name', 'with space'
-    yield s.check_bogus_field_returns_error, url, 'name', ''
-    yield s.check_bogus_field_returns_error, url, 'name', 'authentication'
-    yield s.check_bogus_field_returns_error, url, 'name', 'general'
-    yield s.check_bogus_field_returns_error, url, 'name', 'global'
-    yield s.check_bogus_field_returns_error, url, 'name', 'globals'
-    yield s.check_bogus_field_returns_error, url, 'name', 'parkedcalls'
-    yield s.check_bogus_field_returns_error, url, 'name', 'xivo-features'
-    yield s.check_bogus_field_returns_error, url, 'name', 'zonemessages'
-    yield s.check_bogus_field_returns_error, url, 'name', s.random_string(40)
-    yield s.check_bogus_field_returns_error, url, 'name', []
-    yield s.check_bogus_field_returns_error, url, 'name', {}
-
-    for check in unique_error_checks(url):
-        yield check
+    yield s.check_bogus_field_returns_error, url, 'label', 123
+    yield s.check_bogus_field_returns_error, url, 'label', True
+    yield s.check_bogus_field_returns_error, url, 'label', None
+    yield s.check_bogus_field_returns_error, url, 'label', ''
+    yield s.check_bogus_field_returns_error, url, 'label', s.random_string(129)
+    yield s.check_bogus_field_returns_error, url, 'label', []
+    yield s.check_bogus_field_returns_error, url, 'label', {}
+
+    yield s.check_bogus_field_returns_error, url, 'name', 123, None, 'label'
+    yield s.check_bogus_field_returns_error, url, 'name', True, None, 'label'
+    yield s.check_bogus_field_returns_error, url, 'name', None, None, 'label'
+    yield s.check_bogus_field_returns_error, url, 'name', '', None, 'label'
+    yield s.check_bogus_field_returns_error, url, 'name', s.random_string(
+        129
+    ), None, 'label'
+    yield s.check_bogus_field_returns_error, url, 'name', [], None, 'label'
+    yield s.check_bogus_field_returns_error, url, 'name', {}, None, 'label'
 
 
 @fixtures.context()
@@ -67,6 +66,13 @@ def error_checks(url):
     yield s.check_bogus_field_returns_error, url, 'label', s.random_string(129)
     yield s.check_bogus_field_returns_error, url, 'label', []
     yield s.check_bogus_field_returns_error, url, 'label', {}
+    yield s.check_bogus_field_returns_error, url, 'name', 123, None, 'label'
+    yield s.check_bogus_field_returns_error, url, 'name', True, None, 'label'
+    yield s.check_bogus_field_returns_error, url, 'name', s.random_string(
+        129
+    ), None, 'label'
+    yield s.check_bogus_field_returns_error, url, 'name', [], None, 'label'
+    yield s.check_bogus_field_returns_error, url, 'name', {}, None, 'label'
     yield s.check_bogus_field_returns_error, url, 'type', 123
     yield s.check_bogus_field_returns_error, url, 'type', 'invalid'
     yield s.check_bogus_field_returns_error, url, 'type', True
@@ -168,27 +174,19 @@ def error_checks(url):
     ]
 
 
-@fixtures.context(name='unique')
-def unique_error_checks(url, context):
-    yield s.check_bogus_field_returns_error, url, 'name', context['name']
-
-
 @fixtures.context(
-    name='name_search',
     label='label_search',
     type='internal',
     description='desc_search',
 )
 @fixtures.context(
-    name='hidden',
     label='hidden',
     type='incall',
     description='hidden',
 )
 def test_search(context, hidden):
     url = confd.contexts
     searches = {
-        'name': 'name_search',
         'label': 'label_search',
         'type': 'internal',
         'description': 'desc_search',
@@ -221,15 +219,15 @@ def test_list_multi_tenant(main, sub):
     assert_that(response.items, has_items(main, sub))
 
 
-@fixtures.context(name='sort1', description='sort1')
-@fixtures.context(name='sort2', description='sort2')
+@fixtures.context(label='sort1', description='sort1')
+@fixtures.context(label='sort2', description='sort2')
 def test_sorting_offset_limit(context1, context2):
     url = confd.contexts.get
-    yield s.check_sorting, url, context1, context2, 'name', 'sort'
+    yield s.check_sorting, url, context1, context2, 'label', 'sort'
     yield s.check_sorting, url, context1, context2, 'description', 'sort'
 
-    yield s.check_offset, url, context1, context2, 'name', 'sort'
-    yield s.check_limit, url, context1, context2, 'name', 'sort'
+    yield s.check_offset, url, context1, context2, 'label', 'sort'
+    yield s.check_limit, url, context1, context2, 'label', 'sort'
 
 
 @fixtures.context()
@@ -256,7 +254,7 @@ def test_get(context):
 
 
 def test_create_minimal_parameters():
-    response = confd.contexts.post(name='MyContext')
+    response = confd.contexts.post(label='MyContext')
     response.assert_created('contexts')
 
     assert_that(response.item, has_entries(id=not_(empty()), tenant_uuid=MAIN_TENANT))
@@ -266,21 +264,20 @@ def test_create_minimal_parameters():
 
 def test_create_out_of_tree_tenant():
     response = confd.contexts.post(
-        name='MyContext', wazo_tenant='00000000-0000-0000-0000-000000000000'
+        label='MyContext', wazo_tenant='00000000-0000-0000-0000-000000000000'
     )
     response.assert_status(401)
 
 
 def test_create_in_authorized_tenant():
-    response = confd.contexts.post(name='ZContext', wazo_tenant=SUB_TENANT)
+    response = confd.contexts.post(label='Context', wazo_tenant=SUB_TENANT)
     response.assert_created('context')
 
     assert_that(response.item, has_entries(tenant_uuid=SUB_TENANT))
 
 
 def test_create_all_parameters():
     parameters = {
-        'name': 'MyContext',
         'label': 'Context Power',
         'type': 'outcall',
         'user_ranges': [{'start': '1000', 'end': '1999'}],
@@ -327,15 +324,6 @@ def test_edit_all_parameters(context):
     assert_that(response.item, has_entries(parameters))
 
 
-@fixtures.context(name='OriginalName')
-def test_edit_name_unavailable(context):
-    response = confd.contexts(context['id']).put(name='ModifiedName')
-    response.assert_updated()
-
-    response = confd.contexts(context['id']).get()
-    assert_that(response.item, has_entries(name=context['name']))
-
-
 @fixtures.context()
 def test_delete(context):
     response = confd.contexts(context['id']).delete()
@@ -344,32 +332,32 @@ def test_delete(context):
     response.assert_match(404, e.not_found(resource='Context'))
 
 
-@fixtures.context(name='error')
-@fixtures.extension(context='error')
-def test_delete_when_extension_associated(context, extension):
-    response = confd.contexts(context['id']).delete()
-    response.assert_match(400, e.resource_associated('Context', 'Extension'))
+@fixtures.context(label='error')
+def test_delete_when_extension_associated(context):
+    with fixtures.extension(context=context['name']):
+        response = confd.contexts(context['id']).delete()
+        response.assert_match(400, e.resource_associated('Context', 'Extension'))
 
 
-@fixtures.context(name='error')
-@fixtures.trunk(context='error')
-def test_delete_when_trunk_associated(context, trunk):
-    response = confd.contexts(context['id']).delete()
-    response.assert_match(400, e.resource_associated('Context', 'Trunk'))
+@fixtures.context(label='error')
+def test_delete_when_trunk_associated(context):
+    with fixtures.trunk(context=context['name']):
+        response = confd.contexts(context['id']).delete()
+        response.assert_match(400, e.resource_associated('Context', 'Trunk'))
 
 
-@fixtures.context(name='error')
-@fixtures.voicemail(context='error')
-def test_delete_when_voicemail_associated(context, voicemail):
-    response = confd.contexts(context['id']).delete()
-    response.assert_match(400, e.resource_associated('Context', 'Voicemail'))
+@fixtures.context(label='error')
+def test_delete_when_voicemail_associated(context):
+    with fixtures.voicemail(context=context['name']):
+        response = confd.contexts(context['id']).delete()
+        response.assert_match(400, e.resource_associated('Context', 'Voicemail'))
 
 
-@fixtures.context(name='error')
-@fixtures.agent_login_status(context='error')
-def test_delete_when_agent_is_logged(context, agent_login_status):
-    response = confd.contexts(context['id']).delete()
-    response.assert_match(400, e.resource_associated('Context', 'AgentLoginStatus'))
+@fixtures.context(label='error')
+def test_delete_when_agent_is_logged(context):
+    with fixtures.agent_login_status(context=context['name']):
+        response = confd.contexts(context['id']).delete()
+        response.assert_match(400, e.resource_associated('Context', 'AgentLoginStatus'))
 
 
 @fixtures.context()