Allow Template upgrade properties to be set and remove properties that no longer exist.

CHANGELOG.md

@@ -3,6 +3,7 @@
 **BREAKING CHANGES**
 
 ENHANCEMENTS:
+* Allow new template properties to be specified during template upgrades. Remove Template properties that no longer exist. ([#4783](https://github.com/microsoft/AzureTRE/pull/4783))
 
 ## (0.29.0) (August 14, 2026)
 **BREAKING CHANGES**

api_app/_version.py

@@ -1 +1 @@
-__version__ = "0.26.5"
+__version__ = "0.27.0"

api_app/tests_ma/test_api/test_routes/test_shared_services.py

@@ -8,7 +8,7 @@
 from models.domain.resource import ResourceHistoryItem
 
 from tests_ma.test_api.conftest import create_admin_user, create_test_user
-from .test_workspaces import FAKE_CREATE_TIMESTAMP, FAKE_UPDATE_TIMESTAMP, OPERATION_ID, sample_resource_operation
+from .test_workspaces import FAKE_CREATE_TIMESTAMP, FAKE_UPDATE_TIMESTAMP, OPERATION_ID, sample_resource_operation, sample_resource_template
 
 from db.errors import EntityDoesNotExist
 from models.domain.shared_service import SharedService
@@ -44,7 +44,9 @@ def sample_shared_service(shared_service_id=SHARED_SERVICE_ID):
             'description': 'desc here',
             'overview': 'overview here',
             'private_field_1': 'value_1',
-            'private_field_2': 'value_2'
+            'private_field_2': 'value_2',
+            'title': 'A display name',
+            'os_image': 'Windows 11'
         },
         resourcePath=f'/shared-services/{shared_service_id}',
         updatedWhen=FAKE_CREATE_TIMESTAMP,
@@ -220,7 +222,7 @@ async def test_patch_shared_service_patches_shared_service(self, _, update_item_
     @patch("api.routes.shared_services.ResourceHistoryRepository.save_item", return_value=AsyncMock())
     @patch("api.routes.shared_services.SharedServiceRepository.get_timestamp", return_value=FAKE_UPDATE_TIMESTAMP)
     @patch("api.dependencies.shared_services.SharedServiceRepository.get_shared_service_by_id", return_value=sample_shared_service(SHARED_SERVICE_ID))
-    @patch("api.routes.shared_services.ResourceTemplateRepository.get_template_by_name_and_version", return_value=sample_shared_service())
+    @patch("api.routes.shared_services.ResourceTemplateRepository.get_template_by_name_and_version", return_value=sample_resource_template())
     @patch("api.routes.shared_services.SharedServiceRepository.update_item_with_etag", return_value=sample_shared_service())
     @patch("api.routes.shared_services.send_resource_request_message", return_value=sample_resource_operation(resource_id=SHARED_SERVICE_ID, operation_id=OPERATION_ID))
     async def test_patch_shared_service_with_upgrade_minor_version_patches_shared_service(self, _, update_item_mock, __, ___, ____, _____, app, client):
@@ -242,7 +244,7 @@ async def test_patch_shared_service_with_upgrade_minor_version_patches_shared_se
     @patch("api.routes.shared_services.ResourceHistoryRepository.save_item", return_value=AsyncMock())
     @patch("api.routes.shared_services.SharedServiceRepository.get_timestamp", return_value=FAKE_UPDATE_TIMESTAMP)
     @patch("api.dependencies.shared_services.SharedServiceRepository.get_shared_service_by_id", return_value=sample_shared_service(SHARED_SERVICE_ID))
-    @patch("api.routes.shared_services.ResourceTemplateRepository.get_template_by_name_and_version", return_value=sample_shared_service())
+    @patch("api.routes.shared_services.ResourceTemplateRepository.get_template_by_name_and_version", return_value=sample_resource_template())
     @patch("api.routes.shared_services.SharedServiceRepository.update_item_with_etag", return_value=sample_shared_service())
     @patch("api.routes.shared_services.send_resource_request_message", return_value=sample_resource_operation(resource_id=SHARED_SERVICE_ID, operation_id=OPERATION_ID))
     async def test_patch_shared_service_with_upgrade_major_version_and_force_update_patches_shared_service(self, _, update_item_mock, __, ___, ____, _____, app, client):

api_app/tests_ma/test_api/test_routes/test_workspaces.py

@@ -91,7 +91,11 @@ def sample_workspace(workspace_id=WORKSPACE_ID, auth_info: dict = {}) -> Workspa
         properties={
             "client_id": "12345",
             "scope_id": "test_scope_id",
-            "sp_id": "test_sp_id"
+            "sp_id": "test_sp_id",
+            "display_name": "Test Name",
+            "description": "desc here",
+            "title": "Test Title",
+            "os_image": "Windows 11"
         },
         resourcePath=f'/workspaces/{workspace_id}',
         updatedWhen=FAKE_CREATE_TIMESTAMP,
@@ -164,12 +168,12 @@ def sample_deployed_workspace(workspace_id=WORKSPACE_ID, authInfo={}):
         templateName="tre-workspace-base",
         templateVersion="0.1.0",
         etag="",
-        properties={},
+        properties={'display_name': 'Test Name', 'description': 'desc here', 'title': 'Test Title', 'os_image': 'Windows 11'},
         resourcePath="test",
         updatedWhen=FAKE_CREATE_TIMESTAMP
     )
     if authInfo:
-        workspace.properties = {**authInfo}
+        workspace.properties.update(authInfo)
     return workspace
 
 
@@ -180,7 +184,7 @@ def sample_workspace_service(workspace_service_id=SERVICE_ID, workspace_id=WORKS
         templateName="tre-workspace-base",
         templateVersion="0.1.0",
         etag="",
-        properties={},
+        properties={'display_name': 'Test Name', 'description': 'desc here', 'title': 'Test Title', 'os_image': 'Windows 11'},
         resourcePath=f'/workspaces/{workspace_id}/workspace-services/{workspace_service_id}',
         updatedWhen=FAKE_CREATE_TIMESTAMP,
         user=create_workspace_owner_user().model_dump()
@@ -195,7 +199,7 @@ def sample_user_resource_object(user_resource_id=USER_RESOURCE_ID, workspace_id=
         templateName="tre-user-resource",
         templateVersion="0.1.0",
         etag="",
-        properties={},
+        properties={'display_name': 'Test Name', 'description': 'desc here', 'title': 'Test Title', 'os_image': 'Windows 11'},
         resourcePath=f'/workspaces/{workspace_id}/workspace-services/{parent_workspace_service_id}/user-resources/{user_resource_id}',
         updatedWhen=FAKE_CREATE_TIMESTAMP,
         user=create_workspace_researcher_user().model_dump()
@@ -213,6 +217,14 @@ def sample_resource_template() -> ResourceTemplate:
                             current=True,
                             required=['os_image', 'title'],
                             properties={
+                                'display_name': {
+                                    'type': 'string',
+                                    'title': 'Display Name'
+                                },
+                                'description': {
+                                    'type': 'string',
+                                    'title': 'Description'
+                                },
                                 'title': {
                                     'type': 'string',
                                     'title': 'Title of the resource'
@@ -237,6 +249,30 @@ def sample_resource_template() -> ResourceTemplate:
                                         'large'
                                     ],
                                     'updateable': True
+                                },
+                                'overview': {
+                                    'type': 'string',
+                                    'title': 'Overview'
+                                },
+                                'private_field_1': {
+                                    'type': 'string',
+                                    'title': 'Private Field 1'
+                                },
+                                'private_field_2': {
+                                    'type': 'string',
+                                    'title': 'Private Field 2'
+                                },
+                                'client_id': {
+                                    'type': 'string',
+                                    'title': 'Client ID'
+                                },
+                                'scope_id': {
+                                    'type': 'string',
+                                    'title': 'Scope ID'
+                                },
+                                'sp_id': {
+                                    'type': 'string',
+                                    'title': 'SP ID'
                                 }
                             },
                             actions=[])
@@ -597,7 +633,7 @@ async def test_patch_workspaces_with_upgrade_major_version_returns_bad_request(s
     @patch("api.routes.workspaces.send_resource_request_message", return_value=sample_resource_operation(resource_id=WORKSPACE_ID, operation_id=OPERATION_ID))
     @patch("api.dependencies.workspaces.WorkspaceRepository.get_workspace_by_id", return_value=sample_workspace())
     @patch("api.routes.workspaces.WorkspaceRepository.update_item_with_etag", return_value=sample_workspace())
-    @patch("api.routes.workspaces.ResourceTemplateRepository.get_template_by_name_and_version", return_value=sample_workspace())
+    @patch("api.routes.workspaces.ResourceTemplateRepository.get_template_by_name_and_version", return_value=sample_resource_template())
     @patch("api.routes.workspaces.WorkspaceRepository.get_timestamp", return_value=FAKE_UPDATE_TIMESTAMP)
     async def test_patch_workspaces_with_upgrade_major_version_and_force_update_returns_patched_workspace(self, _, __, update_item_mock, ___, ____, _____, ______, app, client):
         workspace_patch = {"templateVersion": "2.0.0"}
@@ -644,7 +680,7 @@ async def test_patch_workspaces_with_downgrade_version_returns_bad_request(self,
     @patch("api.routes.workspaces.send_resource_request_message", return_value=sample_resource_operation(resource_id=WORKSPACE_ID, operation_id=OPERATION_ID))
     @patch("api.dependencies.workspaces.WorkspaceRepository.get_workspace_by_id", return_value=sample_workspace())
     @patch("api.routes.workspaces.WorkspaceRepository.update_item_with_etag", return_value=sample_workspace())
-    @patch("api.routes.workspaces.ResourceTemplateRepository.get_template_by_name_and_version", return_value=sample_workspace())
+    @patch("api.routes.workspaces.ResourceTemplateRepository.get_template_by_name_and_version", return_value=sample_resource_template())
     @patch("api.routes.workspaces.WorkspaceRepository.get_timestamp", return_value=FAKE_UPDATE_TIMESTAMP)
     async def test_patch_workspaces_with_upgrade_minor_version_patches_workspace(self, _, __, update_item_mock, ___, ____, _____, ______, app, client):
         workspace_patch = {"templateVersion": "0.2.0"}
@@ -658,7 +694,6 @@ async def test_patch_workspaces_with_upgrade_minor_version_patches_workspace(sel
         modified_workspace.templateVersion = "0.2.0"
 
         response = await client.patch(app.url_path_for(strings.API_UPDATE_WORKSPACE, workspace_id=WORKSPACE_ID), json=workspace_patch, headers={"etag": etag})
-
         update_item_mock.assert_called_once_with(modified_workspace, etag)
         assert response.status_code == status.HTTP_202_ACCEPTED