File size: 12,723 Bytes
a0ea4e3 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 | # Copyright (c) 2022-2026, The Isaac Lab Project Developers (https://github.com/isaac-sim/IsaacLab/blob/main/CONTRIBUTORS.md).
# All rights reserved.
#
# SPDX-License-Identifier: BSD-3-Clause
"""Tests for USD cloner utilities (no PhysX dependency)."""
"""Launch Isaac Sim Simulator first."""
from isaaclab.app import AppLauncher
# launch omniverse app
simulation_app = AppLauncher(headless=True).app
"""Rest everything follows."""
import pytest
import torch
from pxr import UsdGeom
import isaaclab.sim as sim_utils
from isaaclab.cloner import ClonePlan, make_clone_plan, sequential, usd_replicate
from isaaclab.cloner.cloner_utils import iter_clone_plan_matches
from isaaclab.sim import build_simulation_context
pytestmark = pytest.mark.isaacsim_ci
@pytest.fixture(params=["cpu", "cuda"])
def sim(request):
"""Provide a fresh simulation context for each test on CPU and CUDA."""
with build_simulation_context(device=request.param, dt=0.01, add_lighting=False) as sim:
yield sim
def test_usd_replicate_with_positions_and_mask(sim):
"""Replicate sources to selected envs and author translate ops from positions."""
# Prepare sources under /World/template
sim_utils.create_prim("/World/template", "Xform")
sim_utils.create_prim("/World/template/A", "Xform")
sim_utils.create_prim("/World/template/B", "Xform")
# Prepare destination env namespaces
num_envs = 3
env_ids = torch.arange(num_envs, dtype=torch.long)
sim_utils.create_prim("/World/envs", "Xform")
for i in range(num_envs):
sim_utils.create_prim(f"/World/envs/env_{i}", "Xform")
# Map A -> env 0 and 2; B -> env 1 only
mask = torch.zeros((2, num_envs), dtype=torch.bool)
mask[0, [0, 2]] = True
mask[1, [1]] = True
usd_replicate(
sim_utils.get_current_stage(),
sources=["/World/template/A", "/World/template/B"],
destinations=["/World/envs/env_{}/Object/A", "/World/envs/env_{}/Object/B"],
env_ids=env_ids,
mask=mask,
)
# Validate replication and translate op
stage = sim_utils.get_current_stage()
assert stage.GetPrimAtPath("/World/envs/env_0/Object/A").IsValid()
assert not stage.GetPrimAtPath("/World/envs/env_0/Object/B").IsValid()
assert stage.GetPrimAtPath("/World/envs/env_1/Object/B").IsValid()
assert not stage.GetPrimAtPath("/World/envs/env_1/Object/A").IsValid()
assert stage.GetPrimAtPath("/World/envs/env_2/Object/A").IsValid()
# Check xformOp:translate authored for env_2/A
prim = stage.GetPrimAtPath("/World/envs/env_2/Object/A")
xform = UsdGeom.Xformable(prim)
ops = xform.GetOrderedXformOps()
assert any(op.GetOpType() == UsdGeom.XformOp.TypeTranslate for op in ops)
def test_usd_replicate_depth_order_parent_child(sim):
"""Replicate parent and child when provided out of order; parent should exist before child."""
# Prepare sources
sim_utils.create_prim("/World/template", "Xform")
sim_utils.create_prim("/World/template/Parent", "Xform")
sim_utils.create_prim("/World/template/Parent/Child", "Xform")
# Destinations (single env)
env_ids = torch.tensor([0, 1], dtype=torch.long)
sim_utils.create_prim("/World/envs", "Xform")
sim_utils.create_prim("/World/envs/env_0", "Xform")
sim_utils.create_prim("/World/envs/env_1", "Xform")
# Provide child first, then parent; depth sort should handle this
usd_replicate(
sim_utils.get_current_stage(),
sources=["/World/template/Parent/Child", "/World/template/Parent"],
destinations=["/World/envs/env_{}/Parent/Child", "/World/envs/env_{}/Parent"],
env_ids=env_ids,
)
stage = sim_utils.get_current_stage()
for i in range(2):
assert stage.GetPrimAtPath(f"/World/envs/env_{i}/Parent").IsValid()
assert stage.GetPrimAtPath(f"/World/envs/env_{i}/Parent/Child").IsValid()
def test_usd_replicate_self_copy_skips_copy_spec(sim):
"""usd_replicate must not call Sdf.CopySpec when source and destination paths are identical.
Sdf.CopySpec(src, src) is a no-op in the current USD version so it does not corrupt children,
but the call is still wasteful. The guard ensures it is skipped entirely. This test mocks
Sdf.CopySpec to verify it is called exactly once (for env_1) and never for the self case (env_0).
"""
from unittest.mock import patch
import isaaclab.cloner.cloner_utils as _cloner_mod
stage = sim_utils.get_current_stage()
sim_utils.create_prim("/World/envs", "Xform")
sim_utils.create_prim("/World/envs/env_0", "Xform")
sim_utils.create_prim("/World/envs/env_0/Robot", "Xform")
sim_utils.create_prim("/World/envs/env_0/Robot/base_link", "Xform")
sim_utils.create_prim("/World/envs/env_1", "Xform")
copy_calls: list[tuple[str, str]] = []
real_copy_spec = _cloner_mod.Sdf.CopySpec
def capturing_copy_spec(src_layer, src_path, dst_layer, dst_path):
copy_calls.append((str(src_path), str(dst_path)))
return real_copy_spec(src_layer, src_path, dst_layer, dst_path)
with patch.object(_cloner_mod.Sdf, "CopySpec", capturing_copy_spec):
usd_replicate(
stage,
sources=["/World/envs/env_0"],
destinations=["/World/envs/env_{}"],
env_ids=torch.tensor([0, 1], dtype=torch.long),
mask=torch.ones((1, 2), dtype=torch.bool),
)
# CopySpec must be called for env_1 but never for env_0 (self-copy)
assert all(src != dst for src, dst in copy_calls), f"Self-copy detected in CopySpec calls: {copy_calls}"
assert any(dst == "/World/envs/env_1" for _, dst in copy_calls), "CopySpec was not called for env_1"
@pytest.mark.parametrize(
"parent_paths, spawn_pattern, expected_child_paths, bad_path, match_expr",
[
(
["/World/rig_0_alpha", "/World/rig_0_beta", "/World/rig_0_gamma"],
"/World/rig_0_.*/Sensor",
["/World/rig_0_alpha/Sensor", "/World/rig_0_beta/Sensor", "/World/rig_0_gamma/Sensor"],
"/World/rig_00/Sensor",
"/World/rig_0_.*",
),
(
[
"/World/group_a/slot_0",
"/World/group_a/slot_1",
"/World/group_b/slot_0",
"/World/group_b/slot_1",
],
"/World/group_.*/slot_.*/Sensor",
[
"/World/group_a/slot_0/Sensor",
"/World/group_a/slot_1/Sensor",
"/World/group_b/slot_0/Sensor",
"/World/group_b/slot_1/Sensor",
],
"/World/group_0/slot_0/Sensor",
"/World/group_.*/slot_.*",
),
(
["/World/template/Object"],
"/World/template/Object/proto_.*",
["/World/template/Object/proto_0"],
"/World/template/Object0/proto_0",
"/World/template/Object",
),
],
)
def test_clone_decorator_wildcard_patterns(
sim, parent_paths, spawn_pattern, expected_child_paths, bad_path, match_expr
):
"""The @clone decorator handles two distinct wildcard patterns correctly.
Case A – ``.*`` in root_path (parent is a regex): the child prim is spawned at
``source_prim_paths[0]`` as a prototype and then copied to every other matching
parent via ``Sdf.CopySpec``, so **all** parents end up with the child. The old
``prim_path.replace(".*", "0")`` approach created spurious intermediate prims
that inflated ``find_matching_prims`` counts and broke tiled-camera initialization.
Case B – ``.*`` only in asset_path (leaf): no parent regex, so
``source_prim_paths == [root_path]`` (one entry, no copy step). Replacing
``".*"`` → ``"0"`` in the asset name gives the intended prototype name
(e.g. ``proto_asset_0``) under the single real parent.
"""
for path in parent_paths:
sim_utils.create_prim(path, "Xform")
cfg = sim_utils.ConeCfg(radius=0.1, height=0.2)
cfg.func(spawn_pattern, cfg)
stage = sim_utils.get_current_stage()
# Every expected child path must exist
for child_path in expected_child_paths:
assert stage.GetPrimAtPath(child_path).IsValid(), (
f"Prim was not spawned at '{child_path}'. The @clone decorator may have used the wrong spawn path."
)
# The spurious path from the old replace(".*", "0") must NOT exist
assert not stage.GetPrimAtPath(bad_path).IsValid(), (
f"Spurious prim found at '{bad_path}'. "
"The @clone decorator incorrectly derived the spawn path by replacing '.*' with '0'."
)
# find_matching_prims must see exactly the original parents — no spurious extras
all_matching = sim_utils.find_matching_prims(match_expr)
assert len(all_matching) == len(parent_paths), (
f"Expected {len(parent_paths)} matching prims, got {len(all_matching)}. "
"Spurious parent prims were likely created by the @clone decorator."
)
def test_make_clone_plan_returns_flat_source_rows(sim):
"""make_clone_plan exposes the flat source-to-env mask used by scene cloning."""
sources, destinations, clone_mask = make_clone_plan(
[["/World/envs/env_0/Object", "/World/envs/env_1/Object"]],
["/World/envs/env_{}/Object"],
num_clones=4,
clone_strategy=sequential,
device=sim.cfg.device,
)
assert sources == ("/World/envs/env_0/Object", "/World/envs/env_1/Object")
assert destinations == ("/World/envs/env_{}/Object", "/World/envs/env_{}/Object")
assert clone_mask.shape == (2, 4)
assert clone_mask.dtype == torch.bool
assert torch.all(clone_mask.sum(dim=0) == 1)
actual_source_idx = clone_mask.to(torch.int).argmax(dim=0).cpu()
assert torch.equal(actual_source_idx, torch.tensor([0, 1, 0, 1]))
def test_iter_clone_plan_matches(sim):
"""ClonePlan entries can be matched by destination path expression."""
sources, destinations, clone_mask = make_clone_plan(
[["/World/envs/env_0/Object", "/World/envs/env_1/Object"]],
["/World/envs/env_{}/Object"],
num_clones=4,
clone_strategy=sequential,
device=sim.cfg.device,
)
plan = ClonePlan(sources=sources, destinations=destinations, clone_mask=clone_mask)
matches = list(iter_clone_plan_matches(plan, "/World/envs/env_.*/Object/Body/Camera"))
assert matches == [
(
"/World/envs/env_0/Object",
"/World/envs/env_{}/Object",
"/World/envs/env_0/Object/Body/Camera",
(0, 2),
),
(
"/World/envs/env_1/Object",
"/World/envs/env_{}/Object",
"/World/envs/env_1/Object/Body/Camera",
(1, 3),
),
]
plan = ClonePlan(
sources=("/World/envs/env_3/Object",),
destinations=("/World/envs/env_{}/Object",),
clone_mask=torch.tensor([[False, False, True, True]], device=sim.cfg.device),
)
matches = list(iter_clone_plan_matches(plan, "/World/envs/env_.*/Object/Body/Camera"))
assert matches == [
(
"/World/envs/env_3/Object",
"/World/envs/env_{}/Object",
"/World/envs/env_3/Object/Body/Camera",
(2, 3),
)
]
plan = ClonePlan(
sources=("/World/source/Object",),
destinations=("/World/scenes/{}/Object",),
clone_mask=torch.tensor([[True, True]], device=sim.cfg.device),
)
matches = list(iter_clone_plan_matches(plan, "/World/scenes/.*/Object/Body/Camera"))
assert matches == [
(
"/World/source/Object",
"/World/scenes/{}/Object",
"/World/source/Object/Body/Camera",
(0, 1),
)
]
plan = ClonePlan(
sources=("/World/source",),
destinations=("/World/scenes/{}",),
clone_mask=torch.tensor([[True, True]], device=sim.cfg.device),
)
matches = list(iter_clone_plan_matches(plan, "/World/scenes/.*/Object/Body/Camera"))
assert matches == [
(
"/World/source",
"/World/scenes/{}",
"/World/source/Object/Body/Camera",
(0, 1),
)
]
plan = ClonePlan(
sources=("/World/envs/env_0", "/World/envs/env_0/Object"),
destinations=("/World/envs/env_{}", "/World/envs/env_{}/Object"),
clone_mask=torch.tensor([[True, True], [True, True]], device=sim.cfg.device),
)
matches = list(iter_clone_plan_matches(plan, "/World/envs/env_.*/Object/Body/Camera"))
assert matches == [
(
"/World/envs/env_0/Object",
"/World/envs/env_{}/Object",
"/World/envs/env_0/Object/Body/Camera",
(0, 1),
)
]
|