Merge pull request #1259 from aws-lumberyard-dev/Prism/gem-db

Adding unit test for project properties cli

scripts/o3de/o3de/project_properties.py

@@ -45,20 +45,20 @@ def edit_project_props(proj_path, proj_name, new_origin, new_display,
     if new_icon:
         proj_json['icon_path'] = new_icon
     if new_tags:
-        tag_list = [new_tags] if isinstance(new_tags, str) else new_tags
+        tag_list = new_tags.split() if isinstance(new_tags, str) else new_tags
         proj_json.setdefault('user_tags', []).extend(tag_list)
     if delete_tags:
-        removal_list = [delete_tags] if isinstance(delete_tags, str) else delete_tags
+        removal_list = delete_tags.split() if isinstance(delete_tags, str) else delete_tags
         if 'user_tags' in proj_json:
             for tag in removal_list:
                 if tag in proj_json['user_tags']:
                     proj_json['user_tags'].remove(tag)
                 else:
-                    logger.warn(f'{tag} not found in user_tags for removal.')
+                    logger.warning(f'{tag} not found in user_tags for removal.')
         else:
-            logger.warn(f'user_tags property not found for removal of {remove_tags}.')
+            logger.warning(f'user_tags property not found for removal of {remove_tags}.')
     if replace_tags:
-        tag_list = [replace_tags] if isinstance(replace_tags, str) else replace_tags
+        tag_list = replace_tags.split() if isinstance(replace_tags, str) else replace_tags
         proj_json['user_tags'] = tag_list
 
     manifest.save_o3de_manifest(proj_json, pathlib.Path(proj_path) / 'project.json')

scripts/o3de/tests/CMakeLists.txt

@@ -41,3 +41,10 @@ ly_add_pytest(
     TEST_SUITE smoke
     EXCLUDE_TEST_RUN_TARGET_FROM_IDE
 )
+
+ly_add_pytest(
+    NAME o3de_project_properties
+    PATH ${CMAKE_CURRENT_LIST_DIR}/unit_test_project_properties.py
+    TEST_SUITE smoke
+    EXCLUDE_TEST_RUN_TARGET_FROM_IDE
+)

scripts/o3de/tests/unit_test_project_properties.py

@@ -0,0 +1,83 @@
+#
+# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
+# its licensors.
+#
+# For complete copyright and license terms please see the LICENSE at the root of this
+# distribution (the "License"). All use of this software is governed by the License,
+# or, if provided, by the license below or the license accompanying this file. Do not
+# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#
+
+import pytest
+import pathlib
+from unittest.mock import patch
+from o3de import project_properties
+
+
+TEST_DEFAULT_PROJECT_DATA = {
+    "template_name": "DefaultProject",
+    "restricted_name": "o3de",
+    "restricted_platform_relative_path": "Templates",
+    "origin": "The primary repo for DefaultProject goes here: i.e. http://www.mydomain.com",
+    "license": "What license DefaultProject uses goes here: i.e. https://opensource.org/licenses/MIT",
+    "display_name": "Default",
+    "summary": "A short description of DefaultProject.",
+    "included_gems": ["Atom","Camera","EMotionFX","UI","Maestro","Input","ImGui"],
+    "canonical_tags": [],
+    "user_tags": [
+        "DefaultProject"
+    ],
+    "icon_path": "preview.png"
+}
+
+@pytest.fixture(scope='class')
+def init_project_json_data(request):
+    class ProjectJsonData:
+        def __init__(self):
+            self.data = TEST_DEFAULT_PROJECT_DATA
+    request.cls.project_json = ProjectJsonData()
+
+@pytest.mark.usefixtures('init_project_json_data')
+class TestEditProjectProperties:
+    @pytest.mark.parametrize("project_path, project_name, project_origin, project_display,\
+                            project_summary, project_icon, add_tags, delete_tags,\
+                            replace_tags, expected_result", [
+        pytest.param(pathlib.PurePath('E:/TestProject'),
+        'test', 'editing by pytest', 'Unit Test', 'pyTest project', 'pytest.bmp', 'A B C',
+        'B', 'D E F', 0),
+        pytest.param('',
+        'test', 'editing by pytest', 'Unit Test', 'pyTest project', 'pytest.bmp', 'A B C',
+        'B', 'D E F', 1)
+        ]
+    )
+    def test_edit_project_properties(self, project_path, project_name, project_origin, project_display,
+                                    project_summary, project_icon, add_tags, delete_tags,
+                                    replace_tags, expected_result):
+
+        def get_project_json_data(project_name: str, project_path) -> dict:
+            if not project_path:
+                self.project_json.data = None
+                return None
+            return self.project_json.data
+
+        def save_o3de_manifest(new_proj_data: dict, project_path) -> None:
+            self.project_json.data = new_proj_data
+
+        with patch('o3de.manifest.get_project_json_data', side_effect=get_project_json_data) as get_project_json_data_patch, \
+                patch('o3de.manifest.save_o3de_manifest', side_effect=save_o3de_manifest) as save_o3de_manifest_patch:
+            result = project_properties.edit_project_props(project_path, project_name, project_origin,
+                                                            project_display, project_summary, project_icon,
+                                                            add_tags, delete_tags, replace_tags)
+            assert result == expected_result
+            if project_path:
+                assert self.project_json.data
+                assert self.project_json.data.get('origin', '') == project_origin
+                assert self.project_json.data.get('display_name', '') == project_display
+                assert self.project_json.data.get('summary', '') == project_summary
+                assert self.project_json.data.get('icon_path', '') == project_icon
+                expected_tag_set = set(replace_tags.split())
+                project_json_tag_set = set(self.project_json.data.get('user_tags', []))
+                assert project_json_tag_set == expected_tag_set
+            else:
+                assert not self.project_json.data