715 lines
30 KiB
Python
715 lines
30 KiB
Python
# ##### BEGIN GPL LICENSE BLOCK #####
|
|
#
|
|
# This program is free software; you can redistribute it and/or
|
|
# modify it under the terms of the GNU General Public License
|
|
# as published by the Free Software Foundation; either version 2
|
|
# of the License, or (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program; if not, write to the Free Software Foundation,
|
|
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
#
|
|
# ##### END GPL LICENSE BLOCK #####
|
|
|
|
# <pep8 compliant>
|
|
|
|
# A framework to run regression tests on mesh modifiers and operators based on howardt's mesh_ops_test.py
|
|
#
|
|
# General idea:
|
|
# A test is:
|
|
# Object mode
|
|
# Select <test_object>
|
|
# Duplicate the object
|
|
# Select the object
|
|
# Apply operation for each operation in <operations_stack> with given parameters
|
|
# (an operation is either a modifier or an operator)
|
|
# test_mesh = <test_object>.data
|
|
# run test_mesh.unit_test_compare(<expected object>.data)
|
|
# delete the duplicate object
|
|
#
|
|
# The words in angle brackets are parameters of the test, and are specified in
|
|
# the main class MeshTest.
|
|
#
|
|
# If the environment variable BLENDER_TEST_UPDATE is set to 1, the <expected_object>
|
|
# is updated with the new test result.
|
|
# Tests are verbose when the environment variable BLENDER_VERBOSE is set.
|
|
|
|
|
|
import bpy
|
|
import functools
|
|
import inspect
|
|
import os
|
|
|
|
# Output from this module and from blender itself will occur during tests.
|
|
# We need to flush python so that the output is properly interleaved, otherwise
|
|
# blender's output for one test will end up showing in the middle of another test...
|
|
print = functools.partial(print, flush=True)
|
|
|
|
|
|
class ModifierSpec:
|
|
"""
|
|
Holds a Generate or Deform or Physics modifier type and its parameters.
|
|
"""
|
|
|
|
def __init__(self, modifier_name: str, modifier_type: str, modifier_parameters: dict, frame_end=0):
|
|
"""
|
|
Constructs a modifier spec.
|
|
:param modifier_name: str - name of object modifier, e.g. "myFirstSubsurfModif"
|
|
:param modifier_type: str - type of object modifier, e.g. "SUBSURF"
|
|
:param modifier_parameters: dict - {name : val} dictionary giving modifier parameters, e.g. {"quality" : 4}
|
|
:param frame_end: int - frame at which simulation needs to be baked or modifier needs to be applied.
|
|
"""
|
|
self.modifier_name = modifier_name
|
|
self.modifier_type = modifier_type
|
|
self.modifier_parameters = modifier_parameters
|
|
self.frame_end = frame_end
|
|
|
|
def __str__(self):
|
|
return "Modifier: " + self.modifier_name + " of type " + self.modifier_type + \
|
|
" with parameters: " + str(self.modifier_parameters)
|
|
|
|
|
|
class ParticleSystemSpec:
|
|
"""
|
|
Holds a Particle System modifier and its parameters.
|
|
"""
|
|
|
|
def __init__(self, modifier_name: str, modifier_type: str, modifier_parameters: dict, frame_end: int):
|
|
"""
|
|
Constructs a particle system spec.
|
|
:param modifier_name: str - name of object modifier, e.g. "Particles"
|
|
:param modifier_type: str - type of object modifier, e.g. "PARTICLE_SYSTEM"
|
|
:param modifier_parameters: dict - {name : val} dictionary giving modifier parameters, e.g. {"seed" : 1}
|
|
:param frame_end: int - the last frame of the simulation at which the modifier is applied
|
|
"""
|
|
self.modifier_name = modifier_name
|
|
self.modifier_type = modifier_type
|
|
self.modifier_parameters = modifier_parameters
|
|
self.frame_end = frame_end
|
|
|
|
def __str__(self):
|
|
return "Physics Modifier: " + self.modifier_name + " of type " + self.modifier_type + \
|
|
" with parameters: " + str(self.modifier_parameters) + " with frame end: " + str(self.frame_end)
|
|
|
|
|
|
class OperatorSpecEditMode:
|
|
"""
|
|
Holds one operator and its parameters.
|
|
"""
|
|
|
|
def __init__(self, operator_name: str, operator_parameters: dict, select_mode: str, selection: set):
|
|
"""
|
|
Constructs an OperatorSpecEditMode. Raises ValueError if selec_mode is invalid.
|
|
:param operator_name: str - name of mesh operator from bpy.ops.mesh, e.g. "bevel" or "fill"
|
|
:param operator_parameters: dict - {name : val} dictionary containing operator parameters.
|
|
:param select_mode: str - mesh selection mode, must be either 'VERT', 'EDGE' or 'FACE'
|
|
:param selection: set - set of vertices/edges/faces indices to select, e.g. [0, 9, 10].
|
|
"""
|
|
self.operator_name = operator_name
|
|
self.operator_parameters = operator_parameters
|
|
if select_mode not in ['VERT', 'EDGE', 'FACE']:
|
|
raise ValueError("select_mode must be either {}, {} or {}".format('VERT', 'EDGE', 'FACE'))
|
|
self.select_mode = select_mode
|
|
self.selection = selection
|
|
|
|
def __str__(self):
|
|
return "Operator: " + self.operator_name + " with parameters: " + str(self.operator_parameters) + \
|
|
" in selection mode: " + self.select_mode + ", selecting " + str(self.selection)
|
|
|
|
|
|
class OperatorSpecObjectMode:
|
|
"""
|
|
Holds an object operator and its parameters. Helper class for DeformModifierSpec.
|
|
Needed to support operations in Object Mode and not Edit Mode which is supported by OperatorSpecEditMode.
|
|
"""
|
|
|
|
def __init__(self, operator_name: str, operator_parameters: dict):
|
|
"""
|
|
:param operator_name: str - name of the object operator from bpy.ops.object, e.g. "shade_smooth" or "shape_keys"
|
|
:param operator_parameters: dict - contains operator parameters.
|
|
"""
|
|
self.operator_name = operator_name
|
|
self.operator_parameters = operator_parameters
|
|
|
|
def __str__(self):
|
|
return "Operator: " + self.operator_name + " with parameters: " + str(self.operator_parameters)
|
|
|
|
|
|
class DeformModifierSpec:
|
|
"""
|
|
Holds a list of deform modifier and OperatorSpecObjectMode.
|
|
For deform modifiers which have an object operator
|
|
"""
|
|
|
|
def __init__(self, frame_number: int, modifier_list: list, object_operator_spec: OperatorSpecObjectMode = None):
|
|
"""
|
|
Constructs a Deform Modifier spec (for user input)
|
|
:param frame_number: int - the frame at which animated keyframe is inserted
|
|
:param modifier_list: ModifierSpec - contains modifiers
|
|
:param object_operator_spec: OperatorSpecObjectMode - contains object operators
|
|
"""
|
|
self.frame_number = frame_number
|
|
self.modifier_list = modifier_list
|
|
self.object_operator_spec = object_operator_spec
|
|
|
|
def __str__(self):
|
|
return "Modifier: " + str(self.modifier_list) + " with object operator " + str(self.object_operator_spec)
|
|
|
|
|
|
class MeshTest:
|
|
"""
|
|
A mesh testing class targeted at testing modifiers and operators on a single object.
|
|
It holds a stack of mesh operations, i.e. modifiers or operators. The test is executed using
|
|
the public method run_test().
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
test_name: str,
|
|
test_object_name: str,
|
|
expected_object_name: str,
|
|
operations_stack=None,
|
|
apply_modifiers=False,
|
|
do_compare=False,
|
|
threshold=None
|
|
):
|
|
"""
|
|
Constructs a MeshTest object. Raises a KeyError if objects with names expected_object_name
|
|
or test_object_name don't exist.
|
|
:param test_name: str - unique test name identifier.
|
|
:param test_object_name: str - Name of object of mesh type to run the operations on.
|
|
:param expected_object_name: str - Name of object of mesh type that has the expected
|
|
geometry after running the operations.
|
|
:param operations_stack: list - stack holding operations to perform on the test_object.
|
|
:param apply_modifiers: bool - True if we want to apply the modifiers right after adding them to the object.
|
|
- True if we want to apply the modifier to a list of modifiers, after some operation.
|
|
This affects operations of type ModifierSpec and DeformModifierSpec.
|
|
:param do_compare: bool - True if we want to compare the test and expected objects, False otherwise.
|
|
:param threshold : exponent: To allow variations and accept difference to a certain degree.
|
|
|
|
"""
|
|
if operations_stack is None:
|
|
operations_stack = []
|
|
for operation in operations_stack:
|
|
if not (isinstance(operation, ModifierSpec) or isinstance(operation, OperatorSpecEditMode)
|
|
or isinstance(operation, OperatorSpecObjectMode) or isinstance(operation, DeformModifierSpec)
|
|
or isinstance(operation, ParticleSystemSpec)):
|
|
raise ValueError("Expected operation of type {} or {} or {} or {}. Got {}".
|
|
format(type(ModifierSpec), type(OperatorSpecEditMode),
|
|
type(DeformModifierSpec), type(ParticleSystemSpec),
|
|
type(operation)))
|
|
self.operations_stack = operations_stack
|
|
self.apply_modifier = apply_modifiers
|
|
self.do_compare = do_compare
|
|
self.threshold = threshold
|
|
self.test_name = test_name
|
|
|
|
self.verbose = os.environ.get("BLENDER_VERBOSE") is not None
|
|
self.update = os.getenv('BLENDER_TEST_UPDATE') is not None
|
|
|
|
# Initialize test objects.
|
|
objects = bpy.data.objects
|
|
self.test_object = objects[test_object_name]
|
|
self.expected_object = objects[expected_object_name]
|
|
if self.verbose:
|
|
print("Found test object {}".format(test_object_name))
|
|
print("Found test object {}".format(expected_object_name))
|
|
|
|
# Private flag to indicate whether the blend file was updated after the test.
|
|
self._test_updated = False
|
|
|
|
def set_test_object(self, test_object_name):
|
|
"""
|
|
Set test object for the test. Raises a KeyError if object with given name does not exist.
|
|
:param test_object_name: name of test object to run operations on.
|
|
"""
|
|
objects = bpy.data.objects
|
|
self.test_object = objects[test_object_name]
|
|
|
|
def set_expected_object(self, expected_object_name):
|
|
"""
|
|
Set expected object for the test. Raises a KeyError if object with given name does not exist
|
|
:param expected_object_name: Name of expected object.
|
|
"""
|
|
objects = bpy.data.objects
|
|
self.expected_object = objects[expected_object_name]
|
|
|
|
def _on_failed_test(self, compare_result, validation_success, evaluated_test_object):
|
|
if self.update and validation_success:
|
|
if self.verbose:
|
|
print("Test failed expectantly. Updating expected mesh...")
|
|
|
|
# Replace expected object with object we ran operations on, i.e. evaluated_test_object.
|
|
evaluated_test_object.location = self.expected_object.location
|
|
expected_object_name = self.expected_object.name
|
|
|
|
bpy.data.objects.remove(self.expected_object, do_unlink=True)
|
|
evaluated_test_object.name = expected_object_name
|
|
|
|
# Save file.
|
|
bpy.ops.wm.save_as_mainfile(filepath=bpy.data.filepath)
|
|
|
|
self._test_updated = True
|
|
|
|
# Set new expected object.
|
|
self.expected_object = evaluated_test_object
|
|
return True
|
|
|
|
else:
|
|
print("Test comparison result: {}".format(compare_result))
|
|
print("Test validation result: {}".format(validation_success))
|
|
print("Resulting object mesh '{}' did not match expected object '{}' from file {}".
|
|
format(evaluated_test_object.name, self.expected_object.name, bpy.data.filepath))
|
|
|
|
return False
|
|
|
|
def is_test_updated(self):
|
|
"""
|
|
Check whether running the test with BLENDER_TEST_UPDATE actually modified the .blend test file.
|
|
:return: Bool - True if blend file has been updated. False otherwise.
|
|
"""
|
|
return self._test_updated
|
|
|
|
def _set_parameters_impl(self, modifier, modifier_parameters, nested_settings_path, modifier_name):
|
|
"""
|
|
Doing a depth first traversal of the modifier parameters and setting their values.
|
|
:param: modifier: Of type modifier, its altered to become a setting in recursion.
|
|
:param: modifier_parameters : dict or sequence, a simple/nested dictionary of modifier parameters.
|
|
:param: nested_settings_path : list(stack): helps in tracing path to each node.
|
|
"""
|
|
if not isinstance(modifier_parameters, dict):
|
|
param_setting = None
|
|
for i, setting in enumerate(nested_settings_path):
|
|
|
|
# We want to set the attribute only when we have reached the last setting.
|
|
# Applying of intermediate settings is meaningless.
|
|
if i == len(nested_settings_path) - 1:
|
|
setattr(modifier, setting, modifier_parameters)
|
|
|
|
elif hasattr(modifier, setting):
|
|
param_setting = getattr(modifier, setting)
|
|
# getattr doesn't accept canvas_surfaces["Surface"], but we need to pass it to setattr.
|
|
if setting == "canvas_surfaces":
|
|
modifier = param_setting.active
|
|
else:
|
|
modifier = param_setting
|
|
else:
|
|
# Clean up first
|
|
bpy.ops.object.delete()
|
|
raise Exception("Modifier '{}' has no parameter named '{}'".
|
|
format(modifier_name, setting))
|
|
|
|
# It pops the current node before moving on to its sibling.
|
|
nested_settings_path.pop()
|
|
return
|
|
|
|
for key in modifier_parameters:
|
|
nested_settings_path.append(key)
|
|
self._set_parameters_impl(modifier, modifier_parameters[key], nested_settings_path, modifier_name)
|
|
|
|
if nested_settings_path:
|
|
nested_settings_path.pop()
|
|
|
|
def set_parameters(self, modifier, modifier_parameters):
|
|
"""
|
|
Wrapper for _set_parameters_util
|
|
"""
|
|
settings = []
|
|
modifier_name = modifier.name
|
|
self._set_parameters_impl(modifier, modifier_parameters, settings, modifier_name)
|
|
|
|
def _add_modifier(self, test_object, modifier_spec: ModifierSpec):
|
|
"""
|
|
Add modifier to object.
|
|
:param test_object: bpy.types.Object - Blender object to apply modifier on.
|
|
:param modifier_spec: ModifierSpec - ModifierSpec object with parameters
|
|
"""
|
|
bakers_list = ['CLOTH', 'SOFT_BODY', 'DYNAMIC_PAINT', 'FLUID']
|
|
scene = bpy.context.scene
|
|
scene.frame_set(1)
|
|
modifier = test_object.modifiers.new(modifier_spec.modifier_name,
|
|
modifier_spec.modifier_type)
|
|
|
|
if modifier is None:
|
|
raise Exception("This modifier type is already added on the Test Object, please remove it and try again.")
|
|
|
|
if self.verbose:
|
|
print("Created modifier '{}' of type '{}'.".
|
|
format(modifier_spec.modifier_name, modifier_spec.modifier_type))
|
|
|
|
# Special case for Dynamic Paint, need to toggle Canvas on.
|
|
if modifier.type == "DYNAMIC_PAINT":
|
|
bpy.ops.dpaint.type_toggle(type='CANVAS')
|
|
|
|
self.set_parameters(modifier, modifier_spec.modifier_parameters)
|
|
|
|
if modifier.type in bakers_list:
|
|
self._bake_current_simulation(test_object, modifier.name, modifier_spec.frame_end)
|
|
|
|
scene.frame_set(modifier_spec.frame_end)
|
|
|
|
def _apply_modifier(self, test_object, modifier_name):
|
|
# Modifier automatically gets applied when converting from Curve to Mesh.
|
|
if test_object.type == 'CURVE':
|
|
bpy.ops.object.convert(target='MESH')
|
|
elif test_object.type == 'MESH':
|
|
bpy.ops.object.modifier_apply(modifier=modifier_name)
|
|
else:
|
|
raise Exception("This object type is not yet supported!")
|
|
|
|
def _bake_current_simulation(self, test_object, test_modifier_name, frame_end):
|
|
"""
|
|
FLUID: Bakes the simulation
|
|
SOFT BODY, CLOTH, DYNAMIC PAINT: Overrides the point_cache context and then bakes.
|
|
"""
|
|
|
|
for scene in bpy.data.scenes:
|
|
for modifier in test_object.modifiers:
|
|
if modifier.type == 'FLUID':
|
|
bpy.ops.fluid.bake_all()
|
|
break
|
|
|
|
elif modifier.type == 'CLOTH' or modifier.type == 'SOFT_BODY':
|
|
test_object.modifiers[test_modifier_name].point_cache.frame_end = frame_end
|
|
override_setting = modifier.point_cache
|
|
override = {'scene': scene, 'active_object': test_object, 'point_cache': override_setting}
|
|
bpy.ops.ptcache.bake(override, bake=True)
|
|
break
|
|
|
|
elif modifier.type == 'DYNAMIC_PAINT':
|
|
dynamic_paint_setting = modifier.canvas_settings.canvas_surfaces.active
|
|
override_setting = dynamic_paint_setting.point_cache
|
|
override = {'scene': scene, 'active_object': test_object, 'point_cache': override_setting}
|
|
bpy.ops.ptcache.bake(override, bake=True)
|
|
break
|
|
|
|
def _apply_particle_system(self, test_object, particle_sys_spec: ParticleSystemSpec):
|
|
"""
|
|
Applies Particle System settings to test objects
|
|
"""
|
|
bpy.context.scene.frame_set(1)
|
|
bpy.ops.object.select_all(action='DESELECT')
|
|
|
|
test_object.modifiers.new(particle_sys_spec.modifier_name, particle_sys_spec.modifier_type)
|
|
|
|
settings_name = test_object.particle_systems.active.settings.name
|
|
particle_setting = bpy.data.particles[settings_name]
|
|
if self.verbose:
|
|
print("Created modifier '{}' of type '{}'.".
|
|
format(particle_sys_spec.modifier_name, particle_sys_spec.modifier_type))
|
|
|
|
for param_name in particle_sys_spec.modifier_parameters:
|
|
try:
|
|
if param_name == "seed":
|
|
system_setting = test_object.particle_systems[particle_sys_spec.modifier_name]
|
|
setattr(system_setting, param_name, particle_sys_spec.modifier_parameters[param_name])
|
|
else:
|
|
setattr(particle_setting, param_name, particle_sys_spec.modifier_parameters[param_name])
|
|
|
|
if self.verbose:
|
|
print("\t set parameter '{}' with value '{}'".
|
|
format(param_name, particle_sys_spec.modifier_parameters[param_name]))
|
|
except AttributeError:
|
|
# Clean up first
|
|
bpy.ops.object.delete()
|
|
raise AttributeError("Modifier '{}' has no parameter named '{}'".
|
|
format(particle_sys_spec.modifier_type, param_name))
|
|
|
|
bpy.context.scene.frame_set(particle_sys_spec.frame_end)
|
|
test_object.select_set(True)
|
|
bpy.ops.object.duplicates_make_real()
|
|
test_object.select_set(True)
|
|
bpy.ops.object.join()
|
|
if self.apply_modifier:
|
|
self._apply_modifier(test_object, particle_sys_spec.modifier_name)
|
|
|
|
def _apply_operator_edit_mode(self, test_object, operator: OperatorSpecEditMode):
|
|
"""
|
|
Apply operator on test object.
|
|
:param test_object: bpy.types.Object - Blender object to apply operator on.
|
|
:param operator: OperatorSpecEditMode - OperatorSpecEditMode object with parameters.
|
|
"""
|
|
mesh = test_object.data
|
|
bpy.ops.object.mode_set(mode='EDIT')
|
|
bpy.ops.mesh.select_all(action='DESELECT')
|
|
bpy.ops.object.mode_set(mode='OBJECT')
|
|
|
|
# Do selection.
|
|
bpy.context.tool_settings.mesh_select_mode = (operator.select_mode == 'VERT',
|
|
operator.select_mode == 'EDGE',
|
|
operator.select_mode == 'FACE')
|
|
for index in operator.selection:
|
|
if operator.select_mode == 'VERT':
|
|
mesh.vertices[index].select = True
|
|
elif operator.select_mode == 'EDGE':
|
|
mesh.edges[index].select = True
|
|
elif operator.select_mode == 'FACE':
|
|
mesh.polygons[index].select = True
|
|
else:
|
|
raise ValueError("Invalid selection mode")
|
|
|
|
# Apply operator in edit mode.
|
|
bpy.ops.object.mode_set(mode='EDIT')
|
|
bpy.ops.mesh.select_mode(type=operator.select_mode)
|
|
mesh_operator = getattr(bpy.ops.mesh, operator.operator_name)
|
|
|
|
try:
|
|
retval = mesh_operator(**operator.operator_parameters)
|
|
except AttributeError:
|
|
raise AttributeError("bpy.ops.mesh has no attribute {}".format(operator.operator_name))
|
|
except TypeError as ex:
|
|
raise TypeError("Incorrect operator parameters {!r} raised {!r}".format(operator.operator_parameters, ex))
|
|
|
|
if retval != {'FINISHED'}:
|
|
raise RuntimeError("Unexpected operator return value: {}".format(retval))
|
|
if self.verbose:
|
|
print("Applied {}".format(operator))
|
|
|
|
bpy.ops.object.mode_set(mode='OBJECT')
|
|
|
|
def _apply_operator_object_mode(self, operator: OperatorSpecObjectMode):
|
|
"""
|
|
Applies the object operator.
|
|
"""
|
|
bpy.ops.object.mode_set(mode='OBJECT')
|
|
object_operator = getattr(bpy.ops.object, operator.operator_name)
|
|
|
|
try:
|
|
retval = object_operator(**operator.operator_parameters)
|
|
except AttributeError:
|
|
raise AttributeError("bpy.ops.object has no attribute {}".format(operator.operator_name))
|
|
except TypeError as ex:
|
|
raise TypeError("Incorrect operator parameters {!r} raised {!r}".format(operator.operator_parameters, ex))
|
|
|
|
if retval != {'FINISHED'}:
|
|
raise RuntimeError("Unexpected operator return value: {}".format(retval))
|
|
if self.verbose:
|
|
print("Applied operator {}".format(operator))
|
|
|
|
def _apply_deform_modifier(self, test_object, operation: list):
|
|
"""
|
|
param: operation: list: List of modifiers or combination of modifier and object operator.
|
|
"""
|
|
|
|
scene = bpy.context.scene
|
|
scene.frame_set(1)
|
|
bpy.ops.object.mode_set(mode='OBJECT')
|
|
modifier_operations_list = operation.modifier_list
|
|
modifier_names = []
|
|
object_operations = operation.object_operator_spec
|
|
for modifier_operations in modifier_operations_list:
|
|
if isinstance(modifier_operations, ModifierSpec):
|
|
self._add_modifier(test_object, modifier_operations)
|
|
modifier_names.append(modifier_operations.modifier_name)
|
|
|
|
if isinstance(object_operations, OperatorSpecObjectMode):
|
|
self._apply_operator_object_mode(object_operations)
|
|
|
|
scene.frame_set(operation.frame_number)
|
|
|
|
if self.apply_modifier:
|
|
for mod_name in modifier_names:
|
|
self._apply_modifier(test_object, mod_name)
|
|
|
|
def run_test(self):
|
|
"""
|
|
Apply operations in self.operations_stack on self.test_object and compare the
|
|
resulting mesh with self.expected_object.data
|
|
:return: bool - True if the test passed, False otherwise.
|
|
"""
|
|
self._test_updated = False
|
|
bpy.context.view_layer.objects.active = self.test_object
|
|
|
|
# Duplicate test object.
|
|
bpy.ops.object.mode_set(mode="OBJECT")
|
|
bpy.ops.object.select_all(action="DESELECT")
|
|
bpy.context.view_layer.objects.active = self.test_object
|
|
|
|
self.test_object.select_set(True)
|
|
bpy.ops.object.duplicate()
|
|
evaluated_test_object = bpy.context.active_object
|
|
evaluated_test_object.name = "evaluated_object"
|
|
if self.verbose:
|
|
print()
|
|
print(evaluated_test_object.name, "is set to active")
|
|
|
|
# Add modifiers and operators.
|
|
for operation in self.operations_stack:
|
|
if isinstance(operation, ModifierSpec):
|
|
self._add_modifier(evaluated_test_object, operation)
|
|
if self.apply_modifier:
|
|
self._apply_modifier(evaluated_test_object, operation.modifier_name)
|
|
|
|
elif isinstance(operation, OperatorSpecEditMode):
|
|
self._apply_operator_edit_mode(evaluated_test_object, operation)
|
|
|
|
elif isinstance(operation, OperatorSpecObjectMode):
|
|
self._apply_operator_object_mode(operation)
|
|
|
|
elif isinstance(operation, DeformModifierSpec):
|
|
self._apply_deform_modifier(evaluated_test_object, operation)
|
|
|
|
elif isinstance(operation, ParticleSystemSpec):
|
|
self._apply_particle_system(evaluated_test_object, operation)
|
|
|
|
else:
|
|
raise ValueError("Expected operation of type {} or {} or {} or {}. Got {}".
|
|
format(type(ModifierSpec), type(OperatorSpecEditMode),
|
|
type(OperatorSpecObjectMode), type(ParticleSystemSpec), type(operation)))
|
|
|
|
# Compare resulting mesh with expected one.
|
|
# Compare only when self.do_compare is set to True, it is set to False for run-test and returns.
|
|
if not self.do_compare:
|
|
print("Meshes/objects are not compared, compare evaluated and expected object in Blender for "
|
|
"visualization only.")
|
|
return False
|
|
|
|
if self.verbose:
|
|
print("Comparing expected mesh with resulting mesh...")
|
|
evaluated_test_mesh = evaluated_test_object.data
|
|
expected_mesh = self.expected_object.data
|
|
if self.threshold:
|
|
compare_result = evaluated_test_mesh.unit_test_compare(mesh=expected_mesh, threshold=self.threshold)
|
|
else:
|
|
compare_result = evaluated_test_mesh.unit_test_compare(mesh=expected_mesh)
|
|
compare_success = (compare_result == 'Same')
|
|
|
|
# Also check if invalid geometry (which is never expected) had to be corrected...
|
|
validation_success = evaluated_test_mesh.validate(verbose=True) == False
|
|
|
|
if compare_success and validation_success:
|
|
if self.verbose:
|
|
print("Success!")
|
|
|
|
# Clean up.
|
|
if self.verbose:
|
|
print("Cleaning up...")
|
|
# Delete evaluated_test_object.
|
|
bpy.ops.object.delete()
|
|
return True
|
|
|
|
else:
|
|
return self._on_failed_test(compare_result, validation_success, evaluated_test_object)
|
|
|
|
|
|
class RunTest:
|
|
"""
|
|
Helper class that stores and executes modifier tests.
|
|
|
|
Example usage:
|
|
|
|
>>> modifier_list = [
|
|
>>> ModifierSpec("firstSUBSURF", "SUBSURF", {"quality": 5}),
|
|
>>> ModifierSpec("firstSOLIDIFY", "SOLIDIFY", {"thickness_clamp": 0.9, "thickness": 1})
|
|
>>> ]
|
|
>>> operator_list = [
|
|
>>> OperatorSpecEditMode("delete_edgeloop", {}, "EDGE", MONKEY_LOOP_EDGE),
|
|
>>> ]
|
|
>>> tests = [
|
|
>>> MeshTest("Test1", "testCube", "expectedCube", modifier_list),
|
|
>>> MeshTest("Test2", "testCube_2", "expectedCube_2", modifier_list),
|
|
>>> MeshTest("MonkeyDeleteEdge", "testMonkey","expectedMonkey", operator_list)
|
|
>>> ]
|
|
>>> modifiers_test = RunTest(tests)
|
|
>>> modifiers_test.run_all_tests()
|
|
"""
|
|
|
|
def __init__(self, tests, apply_modifiers=False, do_compare=False):
|
|
"""
|
|
Construct a modifier test.
|
|
:param tests: list - list of modifier or operator test cases. Each element in the list must contain the
|
|
following
|
|
in the correct order:
|
|
0) test_name: str - unique test name
|
|
1) test_object_name: bpy.Types.Object - test object
|
|
2) expected_object_name: bpy.Types.Object - expected object
|
|
3) modifiers or operators: list - list of mesh_test.ModifierSpec objects or
|
|
mesh_test.OperatorSpecEditMode objects
|
|
"""
|
|
self.tests = tests
|
|
self._ensure_unique_test_name_or_raise_error()
|
|
self.apply_modifiers = apply_modifiers
|
|
self.do_compare = do_compare
|
|
self.verbose = os.environ.get("BLENDER_VERBOSE") is not None
|
|
self._failed_tests_list = []
|
|
|
|
def _ensure_unique_test_name_or_raise_error(self):
|
|
"""
|
|
Check if the test name is unique else raise an error.
|
|
"""
|
|
all_test_names = []
|
|
for each_test in self.tests:
|
|
test_name = each_test.test_name
|
|
all_test_names.append(test_name)
|
|
|
|
seen_name = set()
|
|
for ele in all_test_names:
|
|
if ele in seen_name:
|
|
raise ValueError("{} is a duplicate, write a new unique name.".format(ele))
|
|
else:
|
|
seen_name.add(ele)
|
|
|
|
def run_all_tests(self):
|
|
"""
|
|
Run all tests in self.tests list. Raises an exception if one the tests fails.
|
|
"""
|
|
for test_number, each_test in enumerate(self.tests):
|
|
test_name = each_test.test_name
|
|
if self.verbose:
|
|
print()
|
|
print("Running test {}...".format(test_number))
|
|
print("Test name {}\n".format(test_name))
|
|
success = self.run_test(test_name)
|
|
|
|
if not success:
|
|
self._failed_tests_list.append(test_name)
|
|
|
|
if len(self._failed_tests_list) != 0:
|
|
print("\nFollowing tests failed: {}".format(self._failed_tests_list))
|
|
|
|
blender_path = bpy.app.binary_path
|
|
blend_path = bpy.data.filepath
|
|
frame = inspect.stack()[1]
|
|
module = inspect.getmodule(frame[0])
|
|
python_path = module.__file__
|
|
|
|
print("Run following command to open Blender and run the failing test:")
|
|
print("{} {} --python {} -- {} {}"
|
|
.format(blender_path, blend_path, python_path, "--run-test", "<test_name>"))
|
|
|
|
raise Exception("Tests {} failed".format(self._failed_tests_list))
|
|
|
|
def run_test(self, test_name: str):
|
|
"""
|
|
Run a single test from self.tests list
|
|
:param test_name: int - name of test
|
|
:return: bool - True if test passed, False otherwise.
|
|
"""
|
|
case = None
|
|
for index, each_test in enumerate(self.tests):
|
|
if test_name == each_test.test_name:
|
|
case = self.tests[index]
|
|
break
|
|
|
|
if case is None:
|
|
raise Exception('No test called {} found!'.format(test_name))
|
|
|
|
test = case
|
|
if self.apply_modifiers:
|
|
test.apply_modifier = True
|
|
|
|
if self.do_compare:
|
|
test.do_compare = True
|
|
|
|
success = test.run_test()
|
|
if test.is_test_updated():
|
|
# Run the test again if the blend file has been updated.
|
|
success = test.run_test()
|
|
|
|
return success
|