Add validation to Template API endpoints #4344
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes #1123 Add validation to API endpoints to ensure correct resourceType in template registration payloads. * **Workspace Service Templates**: Add validation in `api_app/api/routes/workspace_service_templates.py` to check if `resourceType` is `WorkspaceService` before registering the template. Return a 422 Unprocessable Entity error if the `resourceType` does not match. * **Workspace Templates**: Add validation in `api_app/api/routes/workspace_templates.py` to check if `resourceType` is `Workspace` before registering the template. Return a 422 Unprocessable Entity error if the `resourceType` does not match. * **User Resource Templates**: Add validation in `api_app/api/routes/user_resource_templates.py` to check if `resourceType` is `UserResource` before registering the template. Return a 422 Unprocessable Entity error if the `resourceType` does not match. * **Shared Service Templates**: Add validation in `api_app/api/routes/shared_service_templates.py` to check if `resourceType` is `SharedService` before registering the template. Return a 422 Unprocessable Entity error if the `resourceType` does not match. * **Common Error Message**: Add a common error message string `INVALID_RESOURCE_TYPE` in `api_app/resources/strings.py` for validation errors, including the expected and received resourceType. * **Tests**: Add tests in `api_app/tests_ma/test_api/test_routes/test_workspace_service_templates.py`, `api_app/tests_ma/test_api/test_routes/test_workspace_templates.py`, `api_app/tests_ma/test_api/test_routes/test_user_resource_templates.py`, and `api_app/tests_ma/test_api/test_routes/test_shared_service_templates.py` to cover validation for each template registration --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/microsoft/AzureTRE/issues/1123?shareId=XXXX-XXXX-XXXX-XXXX).
Unit Test Results600 tests 600 ✅ 6s ⏱️ Results for commit 85f14fa. ♻️ This comment has been updated with latest results. |
|
This PR uncovered a few test bugs, however we are inconsistent with our resourceType naming. In the CI and makefile we use Going to leave this here, but should resolve this inconsistency. Suggest by amending the CI and makefile to use
|
|
Propose we should handle the naming difference in the Python code, and deal with the script update later, add notes to the release, then revert the Python in the future. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1123
Add validation to API endpoints to ensure correct resourceType in template registration payloads.
api_app/api/routes/workspace_service_templates.pyto check ifresourceTypeisWorkspaceServicebefore registering the template. Return a 422 Unprocessable Entity error if theresourceTypedoes not match.api_app/api/routes/workspace_templates.pyto check ifresourceTypeisWorkspacebefore registering the template. Return a 422 Unprocessable Entity error if theresourceTypedoes not match.api_app/api/routes/user_resource_templates.pyto check ifresourceTypeisUserResourcebefore registering the template. Return a 422 Unprocessable Entity error if theresourceTypedoes not match.api_app/api/routes/shared_service_templates.pyto check ifresourceTypeisSharedServicebefore registering the template. Return a 422 Unprocessable Entity error if theresourceTypedoes not match.INVALID_RESOURCE_TYPEinapi_app/resources/strings.pyfor validation errors, including the expected and received resourceType.api_app/tests_ma/test_api/test_routes/test_workspace_service_templates.py,api_app/tests_ma/test_api/test_routes/test_workspace_templates.py,api_app/tests_ma/test_api/test_routes/test_user_resource_templates.py, andapi_app/tests_ma/test_api/test_routes/test_shared_service_templates.pyto cover validation for each template registrationFor more details, open the Copilot Workspace session.