birkeh/o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed the enable-gem command unit test (#2880)

Browse Source 
* Fixed the enable-gem command unit test

The enable-gem unit test would fail if there wasn't an
o3de_manifest.json file in the users $HOME/.o3de directory

The change now is to patch the call to load the o3de manifest

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>

* Adjustments to the enable-gem command unit test to pass on Linux

Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>
This commit is contained in:
lumberyard-employee-dm
2021-08-05 16:58:57 -05:00
committed by GitHub
parent 7448bccea3
commit a65b326558
1 changed files with 39 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/o3de/tests/unit_test_enable_gem.py
+39 -5
View File
@@ -57,6 +57,31 @@ TEST_GEM_JSON_PAYLOAD = '''
}
'''
TEST_O3DE_MANIFEST_JSON_PAYLOAD = '''
{
"o3de_manifest_name": "testuser",
"origin": "C:/Users/testuser/.o3de",
"default_engines_folder": "C:/Users/testuser/.o3de/Engines",
"default_projects_folder": "C:/Users/testuser/.o3de/Projects",
"default_gems_folder": "C:/Users/testuser/.o3de/Gems",
"default_templates_folder": "C:/Users/testuser/.o3de/Templates",
"default_restricted_folder": "C:/Users/testuser/.o3de/Restricted",
"default_third_party_folder": "C:/Users/testuser/.o3de/3rdParty",
"projects": [
"D:/MinimalProject"
],
"external_subdirectories": [],
"templates": [],
"restricted": [],
"repos": [],
"engines": [
"D:/o3de/o3de"
],
"engines_path": {
"o3de": "D:/o3de/o3de"
}
}
'''
@pytest.fixture(scope='class')
def init_enable_gem_data(request):
@@ -71,9 +96,9 @@ def init_enable_gem_data(request):
class TestEnableGemCommand:
@pytest.mark.parametrize("gem_path, project_path, gem_registered_with_project, gem_registered_with_engine,"
"expected_result", [
pytest.param(pathlib.PurePath('E:/TestGem'), pathlib.PurePath('E:/TestProject'), False, True, 0),
pytest.param(pathlib.PurePath('E:/TestGem'), pathlib.PurePath('E:/TestProject'), False, False, 0),
pytest.param(pathlib.PurePath('E:/TestGem'), pathlib.PurePath('E:/TestProject'), True, False, 0),
pytest.param(pathlib.PurePath('TestProject/TestGem'), pathlib.PurePath('TestProject'), False, True, 0),
pytest.param(pathlib.PurePath('TestProject/TestGem'), pathlib.PurePath('TestProject'), False, False, 0),
pytest.param(pathlib.PurePath('TestProject/TestGem'), pathlib.PurePath('TestProject'), True, False, 0),
]
)
def test_enable_gem_registers_gem_as_well(self, gem_path, project_path, gem_registered_with_project, gem_registered_with_engine,
@@ -94,6 +119,11 @@ class TestEnableGemCommand:
self.enable_gem.project_data = new_project_data
return True
def load_o3de_manifest(manifest_path: pathlib.Path = None) -> dict:
if not manifest_path:
return json.loads(TEST_O3DE_MANIFEST_JSON_PAYLOAD)
return None
def get_project_json_data(json_data: pathlib.Path, project_path: pathlib.Path):
return self.enable_gem.project_data
@@ -110,7 +140,8 @@ class TestEnableGemCommand:
return 0
with patch('pathlib.Path.is_dir', return_value=True) as pathlib_is_dir_patch,\
patch('pathlib.Path.is_file', return_value=True) as pathlib_is_file_patch,\
patch('pathlib.Path.is_file', return_value=True) as pathlib_is_file_patch, \
patch('o3de.manifest.load_o3de_manifest', side_effect=load_o3de_manifest) as load_o3de_manifest_patch, \
patch('o3de.manifest.save_o3de_manifest', side_effect=save_o3de_manifest) as save_o3de_manifest_patch,\
patch('o3de.manifest.get_registered', side_effect=get_registered_path) as get_registered_patch,\
patch('o3de.manifest.get_gem_json_data', side_effect=get_gem_json_data) as get_gem_json_data_patch,\
@@ -123,4 +154,7 @@ class TestEnableGemCommand:
assert result == expected_result
# If the gem isn't registered with the engine or project already it should now be registered with the project
if not gem_registered_with_engine and gem_registered_with_project:
assert gem_path.as_posix() in self.enable_gem.project_data.get('external_subdirectories', [])
# Prepend the project path to each external subdirectory
project_relative_subdirs = map(lambda subdir: (pathlib.Path(project_path) / subdir).as_posix(),
self.enable_gem.project_data.get('external_subdirectories', []))
assert gem_path.as_posix() in project_relative_subdirs