def test_ordering():
"""Validate CompoundDefinition can be sorted."""
inst1 = CompoundDefinition(name="test1", version="0.0.1")
inst1_same = CompoundDefinition(name="test1", version="0.0.1")
inst2 = CompoundDefinition(name="test1", version="0.0.2")
inst3 = CompoundDefinition(name="test2", version="0.0.1")
# Equality
assert inst1 == inst1_same
assert not inst1 != inst1_same # pylint: disable=unneeded-not
assert not inst1 > inst1_same # pylint: disable=unneeded-not
assert inst1 >= inst1_same
assert not inst1 < inst1_same # pylint: disable=unneeded-not
assert inst1 <= inst1_same
# Greater name
assert not inst3 == inst1 # pylint: disable=unneeded-not
assert inst3 != inst1
assert inst3 > inst1
assert inst3 >= inst1
assert not inst3 < inst1 # pylint: disable=unneeded-not
assert not inst3 <= inst1 # pylint: disable=unneeded-not
# Same name, greater version
assert not inst2 == inst1 # pylint: disable=unneeded-not
assert inst2 != inst1
assert inst2 > inst1
assert inst2 >= inst1
assert not inst2 < inst1 # pylint: disable=unneeded-not
assert not inst2 <= inst1 # pylint: disable=unneeded-not
# Sorting
actual = sorted((inst1, inst2, inst3))
expected = [inst1, inst2, inst3]
assert actual == expected
def test_properties():
"""Test the helper properties."""
inst = CompoundDefinition(uid="test_uid",
name="test_name",
author="test_author",
version="test_version",
path="some_path")
assert inst.uid == "test_uid"
assert inst.name == "test_name"
assert inst.author == "test_author"
assert inst.version == "test_version"
assert inst.path == "some_path"
def test_from_file(cmds, tmp_path, compdef):
"""Validate we can write a compound definition to an existing file. WIP"""
# Write compound definition (without it's compound body) to a maya ASCII file
path = str(tmp_path / "def.ma")
cmds.file(rename=path)
cmds.file(save=True, type="mayaAscii")
compdef.write_metadata_to_file(path)
# Validate we can read the metadata back
expected = compdef
expected["path"] = path
actual = CompoundDefinition.from_file(path)
assert actual == expected
def parse_directory(self, startdir):
""" Scan a directory and register any found definitions.
"""
for rootdir, _, filenames in os.walk(startdir):
for filename in filenames:
if filename.endswith(".ma"):
path = os.path.join(rootdir, filename)
try:
inst = CompoundDefinition.from_file(path)
except ValueError: # TODO: Use custom exception
pass
else:
self.register(inst)
def publish_compound(self, compound, force=False):
""" Publish a compound
:param Component compound: The compound to publish
:param bool force: Should we overwrite the file if the compound is already published?
"""
compound_def = CompoundDefinition(**compound.get_metadata())
path = self._get_publish_location(compound_def)
compound_def["path"] = path
if os.path.exists(path) and not force:
raise ValueError("Component path already exist on disk. %r" % path)
compound.export(path)
self.registry.register(compound_def)
def entry1_v2():
"""Fixture for a simple compound v2"""
return CompoundDefinition(name="testComponent", version="2.0.0", uid=1)
def compdef():
return CompoundDefinition(name="test_name")
def test_missing_field():
"""Validate we raise an error if we fail to provide all mandatory fields."""
with pytest.raises(ValueError) as error:
CompoundDefinition()
assert str(error.value) == "Missing mandatory fields: 'name'"
def test_get_uid():
"""Validate creating two compounds will have difference uids."""
c1 = CompoundDefinition(name="compound_a")
c2 = CompoundDefinition(name="compound_b")
assert c1.uid != c2.uid
def compdef():
"""Fixture for a preconfigured compound definition"""
return CompoundDefinition(name="test_name")