import tempfile
import unittest
import warnings
from pathlib import Path
from urdf.source import (
MeshUriKind,
UrdfSourceError,
UrdfSourceWarning,
classify_mesh_uri,
read_urdf_source,
resolve_mesh_uri,
)
class UrdfSourceTests(unittest.TestCase):
def setUp(self) -> None:
self._tempdir = tempfile.TemporaryDirectory(prefix="tmp-urdf-source-")
self.temp_root = Path(self._tempdir.name)
def tearDown(self) -> None:
self._tempdir.cleanup()
def _file_ref(self, name: str) -> str:
return (self.temp_root / f"{name}.urdf").resolve().as_posix()
def _write_mesh(self, name: str) -> Path:
mesh_path = self.temp_root / name if Path(name).suffix else self.temp_root / f"{name}.stl"
mesh_path.parent.mkdir(parents=True, exist_ok=True)
mesh_path.write_text("solid empty\nendsolid empty\n", encoding="utf-8")
return mesh_path
def _write_urdf(self, name: str, body: str) -> Path:
urdf_path = self.temp_root / f"{name}.urdf"
urdf_path.write_text(body.strip() + "\n", encoding="utf-8")
script_path = self.temp_root / f"{name}.py"
if not script_path.exists():
script_path.write_text(
"\n".join(
[
"def gen_step():",
" return {'instances': []}",
"",
"def gen_urdf():",
" return {'xml': ''}",
"",
]
),
encoding="utf-8",
)
return urdf_path
def test_read_urdf_source_accepts_valid_mesh_robot(self) -> None:
mesh_path = self._write_mesh("base")
source_path = self._write_urdf(
"robot",
f"""
""",
)
source = read_urdf_source(source_path)
self.assertEqual(self._file_ref("robot"), source.file_ref)
self.assertEqual("sample-robot", source.robot_name)
self.assertEqual("base_link", source.root_link)
self.assertEqual(("base_link",), source.links)
self.assertEqual(0, len(source.joints))
self.assertEqual((mesh_path.resolve(),), source.mesh_paths)
self.assertEqual((mesh_path.resolve(),), source.visual_mesh_paths)
self.assertEqual((), source.collision_mesh_paths)
def test_read_urdf_source_accepts_collision_meshes(self) -> None:
visual_mesh_path = self._write_mesh("visual")
collision_mesh_path = self._write_mesh("collision")
source_path = self._write_urdf(
"robot",
f"""
""",
)
source = read_urdf_source(source_path)
self.assertEqual(
(visual_mesh_path.resolve(), collision_mesh_path.resolve()),
source.mesh_paths,
)
self.assertEqual((visual_mesh_path.resolve(),), source.visual_mesh_paths)
self.assertEqual((collision_mesh_path.resolve(),), source.collision_mesh_paths)
def test_read_urdf_source_accepts_primitive_collision_geometry(self) -> None:
visual_mesh_path = self._write_mesh("visual")
source_path = self._write_urdf(
"robot",
f"""
""",
)
source = read_urdf_source(source_path)
self.assertEqual((visual_mesh_path.resolve(),), source.mesh_paths)
self.assertEqual((), source.collision_mesh_paths)
def test_read_urdf_source_accepts_primitive_visual_geometry(self) -> None:
source_path = self._write_urdf(
"robot",
"""
""",
)
source = read_urdf_source(source_path)
self.assertEqual(("base_link",), source.links)
self.assertEqual((), source.mesh_paths)
def test_read_urdf_source_accepts_non_stl_mesh_formats(self) -> None:
visual_mesh_path = self._write_mesh("meshes/base.dae")
collision_mesh_path = self._write_mesh("meshes/base_collision.obj")
source_path = self._write_urdf(
"robot",
f"""
""",
)
source = read_urdf_source(source_path)
self.assertEqual((visual_mesh_path.resolve(), collision_mesh_path.resolve()), source.mesh_paths)
def test_classifies_mesh_uris(self) -> None:
package_ref = classify_mesh_uri("package://robot_description/meshes/base.stl")
self.assertEqual(MeshUriKind.PACKAGE, package_ref.kind)
self.assertEqual("robot_description", package_ref.package_name)
self.assertEqual("meshes/base.stl", package_ref.package_path.as_posix())
self.assertEqual(MeshUriKind.REMOTE, classify_mesh_uri("https://example.com/base.stl").kind)
self.assertEqual(MeshUriKind.LOCAL_ABSOLUTE, classify_mesh_uri("/tmp/base.stl").kind)
self.assertEqual(MeshUriKind.LOCAL_RELATIVE, classify_mesh_uri("meshes/base.stl").kind)
def test_resolves_package_mesh_uri_with_package_map(self) -> None:
package_root = self.temp_root / "robot_description"
mesh_path = package_root / "meshes" / "base.stl"
mesh_path.parent.mkdir(parents=True)
mesh_path.write_text("solid empty\nendsolid empty\n", encoding="utf-8")
self.assertEqual(
mesh_path.resolve(),
resolve_mesh_uri(
"package://robot_description/meshes/base.stl",
package_map={"robot_description": package_root},
),
)
def test_read_urdf_source_accepts_unresolved_package_mesh_with_warning(self) -> None:
source_path = self._write_urdf(
"robot",
"""
""",
)
with warnings.catch_warnings(record=True) as caught:
warnings.simplefilter("always", UrdfSourceWarning)
source = read_urdf_source(source_path)
self.assertEqual((), source.mesh_paths)
warning_messages = [str(warning.message) for warning in caught]
self.assertTrue(any("syntax is valid but was not resolved" in message for message in warning_messages))
def test_read_urdf_source_accepts_unresolved_remote_mesh_with_warning(self) -> None:
source_path = self._write_urdf(
"robot",
"""
""",
)
with warnings.catch_warnings(record=True) as caught:
warnings.simplefilter("always", UrdfSourceWarning)
source = read_urdf_source(source_path)
self.assertEqual((), source.mesh_paths)
warning_messages = [str(warning.message) for warning in caught]
self.assertTrue(any("is not a local mesh URI and was not resolved" in message for message in warning_messages))
def test_read_urdf_source_resolves_package_mesh_with_package_map(self) -> None:
package_root = self.temp_root / "robot_description"
mesh_path = package_root / "meshes" / "base.stl"
mesh_path.parent.mkdir(parents=True)
mesh_path.write_text("solid empty\nendsolid empty\n", encoding="utf-8")
source_path = self._write_urdf(
"robot",
"""
""",
)
source = read_urdf_source(source_path, package_map={"robot_description": package_root})
self.assertEqual((mesh_path.resolve(),), source.mesh_paths)
def test_read_urdf_source_accepts_valid_inertial(self) -> None:
source_path = self._write_urdf(
"robot",
"""
""",
)
source = read_urdf_source(source_path)
self.assertEqual(("base_link",), source.links)
def test_read_urdf_source_rejects_nonpositive_inertial_mass(self) -> None:
source_path = self._write_urdf(
"robot",
"""
""",
)
with self.assertRaisesRegex(UrdfSourceError, "mass must be positive"):
read_urdf_source(source_path)
def test_read_urdf_source_rejects_invalid_inertia_triangle(self) -> None:
source_path = self._write_urdf(
"robot",
"""
""",
)
with self.assertRaisesRegex(UrdfSourceError, "triangle"):
read_urdf_source(source_path)
def test_read_urdf_source_rejects_invalid_origin_vector(self) -> None:
source_path = self._write_urdf(
"robot",
"""
""",
)
with self.assertRaisesRegex(UrdfSourceError, "origin xyz must have 3 values"):
read_urdf_source(source_path)
def test_read_urdf_source_rejects_zero_joint_axis(self) -> None:
source_path = self._write_urdf(
"robot",
"""
""",
)
with self.assertRaisesRegex(UrdfSourceError, "axis must be nonzero"):
read_urdf_source(source_path)
def test_read_urdf_source_rejects_invalid_mesh_scale(self) -> None:
mesh_path = self._write_mesh("base.obj")
source_path = self._write_urdf(
"robot",
f"""
""",
)
with self.assertRaisesRegex(UrdfSourceError, "scale values must be positive"):
read_urdf_source(source_path)
def test_read_urdf_source_rejects_invalid_primitive_dimensions(self) -> None:
source_path = self._write_urdf(
"robot",
"""
""",
)
with self.assertRaisesRegex(UrdfSourceError, "sphere radius must be positive"):
read_urdf_source(source_path)
def test_read_urdf_source_rejects_missing_geometry_element(self) -> None:
source_path = self._write_urdf(
"robot",
"""
""",
)
with self.assertRaisesRegex(UrdfSourceError, "visual requires "):
read_urdf_source(source_path)
def test_read_urdf_source_rejects_duplicate_links(self) -> None:
mesh_path = self._write_mesh("base")
source_path = self._write_urdf(
"robot",
f"""
""",
)
with self.assertRaisesRegex(UrdfSourceError, "duplicates"):
read_urdf_source(source_path)
def test_read_urdf_source_rejects_missing_mesh(self) -> None:
source_path = self._write_urdf(
"robot",
"""
""",
)
with self.assertRaisesRegex(UrdfSourceError, "missing mesh file"):
read_urdf_source(source_path)
def test_read_urdf_source_rejects_missing_collision_mesh(self) -> None:
source_path = self._write_urdf(
"robot",
"""
""",
)
with self.assertRaisesRegex(UrdfSourceError, "missing mesh file"):
read_urdf_source(source_path)
def test_read_urdf_source_accepts_prismatic_joint_with_limits(self) -> None:
mesh_path = self._write_mesh("base")
source_path = self._write_urdf(
"robot",
f"""
""",
)
source = read_urdf_source(source_path)
self.assertEqual("prismatic", source.joints[0].joint_type)
self.assertEqual(0.0, source.joints[0].min_value_deg)
self.assertEqual(0.05, source.joints[0].max_value_deg)
def test_read_urdf_source_rejects_reversed_joint_limits(self) -> None:
source_path = self._write_urdf(
"robot",
"""
""",
)
with self.assertRaisesRegex(UrdfSourceError, "lower limit exceeds upper limit"):
read_urdf_source(source_path)
def test_read_urdf_source_rejects_unsupported_joint_type(self) -> None:
mesh_path = self._write_mesh("base")
source_path = self._write_urdf(
"robot",
f"""
""",
)
with self.assertRaisesRegex(UrdfSourceError, "unsupported type"):
read_urdf_source(source_path)
def test_file_ref_ignores_neighbor_step_toml(self) -> None:
source_path = self._write_urdf(
"robot",
"""
""",
)
stale_path = self.temp_root / "robot.step.toml"
stale_path.write_text(
"\n".join(
[
'kind = "part"',
'source = "robot.urdf"',
]
)
+ "\n",
encoding="utf-8",
)
source = read_urdf_source(source_path)
self.assertEqual(source_path.resolve().as_posix(), source.file_ref)
if __name__ == "__main__":
unittest.main()