|
|
|
|
@ -1,5 +1,6 @@
|
|
|
|
|
"""
|
|
|
|
|
Copyright (c) Contributors to the Open 3D Engine Project. For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
|
|
|
|
Copyright (c) Contributors to the Open 3D Engine Project.
|
|
|
|
|
For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
|
|
|
|
|
|
|
|
|
SPDX-License-Identifier: Apache-2.0 OR MIT
|
|
|
|
|
|
|
|
|
|
@ -8,12 +9,19 @@ import datetime
|
|
|
|
|
import os
|
|
|
|
|
import zipfile
|
|
|
|
|
|
|
|
|
|
from ly_test_tools.image.screenshot_compare_qssim import qssim as compare_screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class ImageComparisonTestFailure(Exception):
|
|
|
|
|
"""Custom test failure for failed image comparisons."""
|
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def create_screenshots_archive(screenshot_path):
|
|
|
|
|
"""
|
|
|
|
|
Creates a new zip file archive at archive_path containing all files listed within archive_path.
|
|
|
|
|
:param screenshot_path: location containing the files to archive, the zip archive file will also be saved here.
|
|
|
|
|
:return: None, but creates a new zip file archive inside path containing all of the files inside archive_path.
|
|
|
|
|
:return: path to the created .zip file archive.
|
|
|
|
|
"""
|
|
|
|
|
files_to_archive = []
|
|
|
|
|
|
|
|
|
|
@ -27,14 +35,16 @@ def create_screenshots_archive(screenshot_path):
|
|
|
|
|
# Setup variables for naming the zip archive file.
|
|
|
|
|
timestamp = datetime.datetime.now().timestamp()
|
|
|
|
|
formatted_timestamp = datetime.datetime.utcfromtimestamp(timestamp).strftime("%Y-%m-%d_%H-%M-%S")
|
|
|
|
|
screenshots_file = os.path.join(screenshot_path, f'screenshots_{formatted_timestamp}.zip')
|
|
|
|
|
screenshots_zip_file = os.path.join(screenshot_path, f'screenshots_{formatted_timestamp}.zip')
|
|
|
|
|
|
|
|
|
|
# Write all of the valid .png and .ppm files to the archive file.
|
|
|
|
|
with zipfile.ZipFile(screenshots_file, 'w', compression=zipfile.ZIP_DEFLATED, allowZip64=True) as zip_archive:
|
|
|
|
|
with zipfile.ZipFile(screenshots_zip_file, 'w', compression=zipfile.ZIP_DEFLATED, allowZip64=True) as zip_archive:
|
|
|
|
|
for file_path in files_to_archive:
|
|
|
|
|
file_name = os.path.basename(file_path)
|
|
|
|
|
zip_archive.write(file_path, file_name)
|
|
|
|
|
|
|
|
|
|
return screenshots_zip_file
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def golden_images_directory():
|
|
|
|
|
"""
|
|
|
|
|
@ -53,6 +63,36 @@ def golden_images_directory():
|
|
|
|
|
return golden_images_dir
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def compare_screenshot_similarity(
|
|
|
|
|
test_screenshot, golden_image, similarity_threshold, create_zip_archive=False, screenshot_directory=""):
|
|
|
|
|
"""
|
|
|
|
|
Compares the similarity between a test screenshot and a golden image.
|
|
|
|
|
It returns a "Screenshots match" string if the comparison mean value is higher than the similarity threshold.
|
|
|
|
|
Otherwise, it returns an error string.
|
|
|
|
|
:param test_screenshot: path to the test screenshot to compare.
|
|
|
|
|
:param golden_image: path to the golden image to compare.
|
|
|
|
|
:param similarity_threshold: value for the comparison mean value to be asserted against.
|
|
|
|
|
:param create_zip_archive: toggle to create a zip archive containing the screenshots if the assert check fails.
|
|
|
|
|
:param screenshot_directory: directory containing screenshots to create zip archive from.
|
|
|
|
|
:return: Error string if compared mean value < similarity threshold or screenshot_directory is missing for .zip,
|
|
|
|
|
otherwise it returns a "Screenshots match" string.
|
|
|
|
|
"""
|
|
|
|
|
result = "Screenshots match"
|
|
|
|
|
if create_zip_archive and not screenshot_directory:
|
|
|
|
|
result = 'You must specify a screenshot_directory in order to create a zip archive.\n'
|
|
|
|
|
|
|
|
|
|
mean_similarity = compare_screenshots(test_screenshot, golden_image)
|
|
|
|
|
if not mean_similarity > similarity_threshold:
|
|
|
|
|
if create_zip_archive:
|
|
|
|
|
create_screenshots_archive(screenshot_directory)
|
|
|
|
|
result = (
|
|
|
|
|
f"When comparing the test_screenshot: '{test_screenshot}' "
|
|
|
|
|
f"to golden_image: '{golden_image}' the mean similarity of '{mean_similarity}' "
|
|
|
|
|
f"was lower than the similarity threshold of '{similarity_threshold}'. ")
|
|
|
|
|
|
|
|
|
|
return result
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def create_basic_atom_level(level_name):
|
|
|
|
|
"""
|
|
|
|
|
Creates a new level inside the Editor matching level_name & adds the following:
|
|
|
|
|
@ -76,29 +116,11 @@ def create_basic_atom_level(level_name):
|
|
|
|
|
|
|
|
|
|
helper = EditorTestHelper(log_prefix="Atom_EditorTestHelper")
|
|
|
|
|
|
|
|
|
|
# Create a new level.
|
|
|
|
|
new_level_name = level_name
|
|
|
|
|
heightmap_resolution = 512
|
|
|
|
|
heightmap_meters_per_pixel = 1
|
|
|
|
|
terrain_texture_resolution = 412
|
|
|
|
|
use_terrain = False
|
|
|
|
|
|
|
|
|
|
# Return codes are ECreateLevelResult defined in CryEdit.h
|
|
|
|
|
return_code = general.create_level_no_prompt(
|
|
|
|
|
new_level_name, heightmap_resolution, heightmap_meters_per_pixel, terrain_texture_resolution, use_terrain)
|
|
|
|
|
if return_code == 1:
|
|
|
|
|
general.log(f"{new_level_name} level already exists")
|
|
|
|
|
elif return_code == 2:
|
|
|
|
|
general.log("Failed to create directory")
|
|
|
|
|
elif return_code == 3:
|
|
|
|
|
general.log("Directory length is too long")
|
|
|
|
|
elif return_code != 0:
|
|
|
|
|
general.log("Unknown error, failed to create level")
|
|
|
|
|
else:
|
|
|
|
|
general.log(f"{new_level_name} level created successfully")
|
|
|
|
|
|
|
|
|
|
# Enable idle and update viewport.
|
|
|
|
|
# Wait for Editor idle loop before executing Python hydra scripts.
|
|
|
|
|
general.idle_enable(True)
|
|
|
|
|
|
|
|
|
|
# Basic setup for opened level.
|
|
|
|
|
helper.open_level(level_name="Base")
|
|
|
|
|
general.idle_wait(1.0)
|
|
|
|
|
general.update_viewport()
|
|
|
|
|
general.idle_wait(0.5) # half a second is more than enough for updating the viewport.
|
|
|
|
|
@ -165,24 +187,25 @@ def create_basic_atom_level(level_name):
|
|
|
|
|
components=["Material"],
|
|
|
|
|
parent_id=default_level.id)
|
|
|
|
|
azlmbr.components.TransformBus(azlmbr.bus.Event, "SetLocalUniformScale", ground_plane.id, 32.0)
|
|
|
|
|
ground_plane_material_asset_path = os.path.join(
|
|
|
|
|
"Materials", "Presets", "PBR", "metal_chrome.azmaterial")
|
|
|
|
|
ground_plane_material_asset_value = asset.AssetCatalogRequestBus(
|
|
|
|
|
bus.Broadcast, "GetAssetIdByPath", ground_plane_material_asset_path, math.Uuid(), False)
|
|
|
|
|
ground_plane.get_set_test(0, "Default Material|Material Asset", ground_plane_material_asset_value)
|
|
|
|
|
|
|
|
|
|
# Work around to add the correct Atom Mesh component
|
|
|
|
|
# Work around to add the correct Atom Mesh component and asset.
|
|
|
|
|
mesh_type_id = azlmbr.globals.property.EditorMeshComponentTypeId
|
|
|
|
|
ground_plane.components.append(
|
|
|
|
|
editor.EditorComponentAPIBus(
|
|
|
|
|
bus.Broadcast, "AddComponentsOfType", ground_plane.id, [mesh_type_id]
|
|
|
|
|
).GetValue()[0]
|
|
|
|
|
)
|
|
|
|
|
ground_plane_mesh_asset_path = os.path.join("Models", "plane.azmodel")
|
|
|
|
|
ground_plane_mesh_asset_path = os.path.join("TestData", "Objects", "plane.azmodel")
|
|
|
|
|
ground_plane_mesh_asset_value = asset.AssetCatalogRequestBus(
|
|
|
|
|
bus.Broadcast, "GetAssetIdByPath", ground_plane_mesh_asset_path, math.Uuid(), False)
|
|
|
|
|
ground_plane.get_set_test(1, "Controller|Configuration|Mesh Asset", ground_plane_mesh_asset_value)
|
|
|
|
|
|
|
|
|
|
# Add Atom Material component and asset.
|
|
|
|
|
ground_plane_material_asset_path = os.path.join("Materials", "Presets", "PBR", "metal_chrome.azmaterial")
|
|
|
|
|
ground_plane_material_asset_value = asset.AssetCatalogRequestBus(
|
|
|
|
|
bus.Broadcast, "GetAssetIdByPath", ground_plane_material_asset_path, math.Uuid(), False)
|
|
|
|
|
ground_plane.get_set_test(0, "Default Material|Material Asset", ground_plane_material_asset_value)
|
|
|
|
|
|
|
|
|
|
# Create directional_light entity and set the properties
|
|
|
|
|
directional_light = hydra.Entity("directional_light")
|
|
|
|
|
directional_light.create_entity(
|
|
|
|
|
@ -199,12 +222,8 @@ def create_basic_atom_level(level_name):
|
|
|
|
|
entity_position=math.Vector3(0.0, 0.0, 1.0),
|
|
|
|
|
components=["Material"],
|
|
|
|
|
parent_id=default_level.id)
|
|
|
|
|
sphere_material_asset_path = os.path.join("Materials", "Presets", "PBR", "metal_brass_polished.azmaterial")
|
|
|
|
|
sphere_material_asset_value = asset.AssetCatalogRequestBus(
|
|
|
|
|
bus.Broadcast, "GetAssetIdByPath", sphere_material_asset_path, math.Uuid(), False)
|
|
|
|
|
sphere_entity.get_set_test(0, "Default Material|Material Asset", sphere_material_asset_value)
|
|
|
|
|
|
|
|
|
|
# Work around to add the correct Atom Mesh component
|
|
|
|
|
# Work around to add the correct Atom Mesh component and asset.
|
|
|
|
|
sphere_entity.components.append(
|
|
|
|
|
editor.EditorComponentAPIBus(
|
|
|
|
|
bus.Broadcast, "AddComponentsOfType", sphere_entity.id, [mesh_type_id]
|
|
|
|
|
@ -215,6 +234,12 @@ def create_basic_atom_level(level_name):
|
|
|
|
|
bus.Broadcast, "GetAssetIdByPath", sphere_mesh_asset_path, math.Uuid(), False)
|
|
|
|
|
sphere_entity.get_set_test(1, "Controller|Configuration|Mesh Asset", sphere_mesh_asset_value)
|
|
|
|
|
|
|
|
|
|
# Add Atom Material component and asset.
|
|
|
|
|
sphere_material_asset_path = os.path.join("Materials", "Presets", "PBR", "metal_brass_polished.azmaterial")
|
|
|
|
|
sphere_material_asset_value = asset.AssetCatalogRequestBus(
|
|
|
|
|
bus.Broadcast, "GetAssetIdByPath", sphere_material_asset_path, math.Uuid(), False)
|
|
|
|
|
sphere_entity.get_set_test(0, "Default Material|Material Asset", sphere_material_asset_value)
|
|
|
|
|
|
|
|
|
|
# Create camera component and set the properties
|
|
|
|
|
camera_entity = hydra.Entity("camera")
|
|
|
|
|
camera_entity.create_entity(
|
|
|
|
|
|
jromnoa
4 years ago
committed by
GitHub