Merge pull request #4661 from Autodesk/bailp/EMSUSD-3304/add-purpose-tests

EMSUSD-3304 add CC purpose tests

Author: seando-adsk

test/lib/componentCreator/testComponentCreatorAddToComponentFromNodes.py

@@ -20,12 +20,19 @@ class AddToComponentFromNodesTestCase(_ComponentCreatorTestBase, unittest.TestCa
     def setUpClass(cls):
         fixturesUtils.readOnlySetUpClass(__file__, initializeStandalone=False)
 
+    @classmethod
+    def tearDownClass(cls):
+        cls._resetDefaultTemplate()
+        return super().tearDownClass()
+
     def setUp(self):
         self._setUpCC()
         # Clear the variant editor state so there is no lingering component from a
         # previous test.
         #from usd_component_creator_plugin import update_variant_editor_window
         #update_variant_editor_window(None, force_update=True)
+        self._resetDefaultTemplate()
+        return super().setUp()
 
     def _createInitialComponent(self, node_name='pCube1'):
         """Create a polyCube, build a single-node component, and return (proxy, desc)."""
@@ -181,6 +188,109 @@ def testTargetedVariantUnchangedAfterAdd(self):
             AdskUsdComponentCreator.ComponentAPI.IsVariantTarget(
                 updated_desc, [updated_vs, updated_default_var_desc]))
 
+    def testAddWithPurpose(self):
+        """add_to_component_from_nodes with purpose specified."""
+        from usd_component_creator_plugin import add_to_component_from_nodes
+        proxy, desc = self._createInitialComponent('pCube1')
+        self.assertIsNotNone(desc, 'Could not get initial ComponentDescription')
+        first_vs = next(iter(desc.GetVariantSets().values()))
+
+        cmds.polyCube(name='pCube2')
+        path2 = cmds.ls('pCube2', long=True)[0]
+
+        before = self._snapshotProxyShapes()
+
+        # Add pCube2 to the existing default variant (not a new one)
+        result = add_to_component_from_nodes(
+            [path2],
+            [(first_vs.name, first_vs.default_variant)],
+            is_replacing=False,
+            component_desc=desc,
+            purpose='guide')
+        self.assertTrue(result, "add_to_component_from_nodes should return True on success")
+
+        new_proxy = self._findNewProxyShape(before)
+        self.assertIsNone(new_proxy, "No new proxy shape should be created when adding to an existing component")
+
+        stage = mayaUsd.ufe.getStage(proxy)
+
+        cube_path = Sdf.Path('/root/geo/pCube1')
+        cube_prim = stage.GetPrimAtPath(cube_path)        
+        self.assertTrue(cube_prim.IsValid(), f"{cube_path} should be a valid prim")
+
+        purposed_path = Sdf.Path('/root/geo/guide/pCube2')
+        purposed_prim = stage.GetPrimAtPath(purposed_path)        
+        self.assertTrue(purposed_prim.IsValid(), f"{purposed_path} should be a valid prim after add_to_component_from_nodes with purpose")
+
+    def testAddWithPurposeCollidingName(self):
+        """add_to_component_from_nodes with purpose specified."""
+        from usd_component_creator_plugin import add_to_component_from_nodes
+        proxy, desc = self._createInitialComponent('pCube1')
+        self.assertIsNotNone(desc, 'Could not get initial ComponentDescription')
+        first_vs = next(iter(desc.GetVariantSets().values()))
+
+        cmds.setAttr('pCube1.translateX', 22.2)
+        before = self._snapshotProxyShapes()
+
+        # Add pCube1 to the existing default variant (not a new one) under a purpose.
+        # Because it will be placed under the purpose scope, its name will *not* conflict
+        # with the existing pCube1
+        result = add_to_component_from_nodes(
+            ['pCube1'],
+            [(first_vs.name, first_vs.default_variant)],
+            is_replacing=False,
+            component_desc=desc,
+            purpose='guide')
+        self.assertTrue(result, "add_to_component_from_nodes should return True on success")
+        new_proxy = self._findNewProxyShape(before)
+        self.assertIsNone(new_proxy, "No new proxy shape should be created when adding to an existing component")
+
+        stage = mayaUsd.ufe.getStage(proxy)
+
+        cube_path = Sdf.Path('/root/geo/pCube1')
+        cube_prim = stage.GetPrimAtPath(cube_path)        
+        self.assertTrue(cube_prim.IsValid(), f"{cube_path} should be a valid prim")
+
+        purposed_path = Sdf.Path('/root/geo/guide/pCube1')
+        purposed_prim = stage.GetPrimAtPath(purposed_path)        
+        self.assertTrue(purposed_prim.IsValid(), f"{purposed_path} should be a valid prim after add_to_component_from_nodes with purpose")
+        translateAttr = purposed_prim.GetAttribute('xformOp:translate')
+        self.assertTrue(translateAttr)
+        self.assertAlmostEqual(translateAttr.Get()[0], 22.2)
+
+    def testAddWithCustomPurposeScopeName(self):
+        """add_to_component_from_nodes with purpose specified and custom purpose scope names."""
+        from usd_component_creator_plugin import add_to_component_from_nodes
+        self._setCustomPurposeTemplate()
+        proxy, desc = self._createInitialComponent('pCube1')
+        self.assertIsNotNone(desc, 'Could not get initial ComponentDescription')
+        first_vs = next(iter(desc.GetVariantSets().values()))
+
+        cmds.polyCube(name='pCube2')
+        path2 = cmds.ls('pCube2', long=True)[0]
+
+        before = self._snapshotProxyShapes()
+
+        # Add pCube2 to the existing default variant (not a new one)
+        result = add_to_component_from_nodes(
+            [path2],
+            [(first_vs.name, first_vs.default_variant)],
+            is_replacing=False,
+            component_desc=desc,
+            purpose='guide')
+        self.assertTrue(result, "add_to_component_from_nodes should return True on success")
+        new_proxy = self._findNewProxyShape(before)
+        self.assertIsNone(new_proxy, "No new proxy shape should be created when adding to an existing component")
+
+        stage = mayaUsd.ufe.getStage(proxy)
+
+        cube_path = Sdf.Path('/root/geo/pCube1')
+        cube_prim = stage.GetPrimAtPath(cube_path)        
+        self.assertTrue(cube_prim.IsValid(), f"{cube_path} should be a valid prim")
+
+        purposed_path = Sdf.Path('/root/geo/gui/pCube2')
+        purposed_prim = stage.GetPrimAtPath(purposed_path)        
+        self.assertTrue(purposed_prim.IsValid(), f"{purposed_path} should be a valid prim after add_to_component_from_nodes with purpose")
 
 
 if __name__ == '__main__':

test/lib/componentCreator/testComponentCreatorAddToComponentFromUsdPrims.py

@@ -20,12 +20,19 @@ class AddToComponentFromUsdPrimsTestCase(_ComponentCreatorTestBase, unittest.Tes
     def setUpClass(cls):
         fixturesUtils.readOnlySetUpClass(__file__, initializeStandalone=False)
 
+    @classmethod
+    def tearDownClass(cls):
+        cls._resetDefaultTemplate()
+        return super().tearDownClass()
+
     def setUp(self):
         self._setUpCC()
         # Clear the variant editor state so there is no lingering component from a
         # previous test.
         #from usd_component_creator_plugin import update_variant_editor_window
         #update_variant_editor_window(None, force_update=True)
+        self._resetDefaultTemplate()
+        return super().setUp()
 
     def _createInitialComponent(self, node_name='pCube1'):
         """Create a polyCube, build a single-node component, and return (proxy, desc)."""
@@ -108,6 +115,75 @@ def testAddWithPurpose(self):
         purposed_prim = stage.GetPrimAtPath(purposed_path)        
         self.assertTrue(purposed_prim.IsValid(), f"{purposed_path} should be a valid prim after add_to_component_from_usd_prims with purpose")
 
+    def testAddWithPurposeCollidingName(self):
+        """add_to_component_from_usd_prims with purpose specified."""
+        from usd_component_creator_plugin import add_to_component_from_usd_prims
+        proxy, desc, proxyShape = self._createInitialComponent('pCube1')
+        self.assertIsNotNone(desc, 'Could not get initial ComponentDescription')
+        first_vs = next(iter(desc.GetVariantSets().values()))
+
+        path2 = Sdf.Path('/pCube1')
+        prim2 = self._input_stage.DefinePrim(path2, 'Cube')
+        prim2.GetAttribute('size').Set(22.2)
+        before = self._snapshotProxyShapes()
+
+        # Add pCube1 to the existing default variant (not a new one) under a purpose.
+        # Because it will be placed under the purpose scope, its name will *not* conflict
+        # with the existing pCube1
+        result = add_to_component_from_usd_prims(
+            [f'{proxyShape},{path2}'],
+            [(first_vs.name, first_vs.default_variant)],
+            is_replacing=False,
+            component_desc=desc,
+            purpose='guide')
+        self.assertTrue(result, "add_to_component_from_usd_prims should return True on success")
+        new_proxy = self._findNewProxyShape(before)
+        self.assertIsNone(new_proxy, "No new proxy shape should be created when adding to an existing component")
+
+        stage = mayaUsd.ufe.getStage(proxy)
+
+        cube_path = Sdf.Path('/root/geo/pCube1')
+        cube_prim = stage.GetPrimAtPath(cube_path)        
+        self.assertTrue(cube_prim.IsValid(), f"{cube_path} should be a valid prim")
+
+        purposed_path = Sdf.Path('/root/geo/guide/pCube1')
+        purposed_prim = stage.GetPrimAtPath(purposed_path)        
+        self.assertTrue(purposed_prim.IsValid(), f"{purposed_path} should be a valid prim after add_to_component_from_usd_prims with purpose")
+        self.assertAlmostEqual(purposed_prim.GetAttribute('size').Get(), 22.2)
+
+    def testAddWithCustomPurposeScopeName(self):
+        """add_to_component_from_usd_prims with purpose specified and custom purpose scope names."""
+        from usd_component_creator_plugin import add_to_component_from_usd_prims
+        self._setCustomPurposeTemplate()
+        proxy, desc, proxyShape = self._createInitialComponent('pCube1')
+        self.assertIsNotNone(desc, 'Could not get initial ComponentDescription')
+        first_vs = next(iter(desc.GetVariantSets().values()))
+
+        path2 = Sdf.Path('/pCube2')
+        self._input_stage.DefinePrim(path2, 'Cube')
+        before = self._snapshotProxyShapes()
+
+        # Add pCube2 to the existing default variant (not a new one)
+        result = add_to_component_from_usd_prims(
+            [f'{proxyShape},{path2}'],
+            [(first_vs.name, first_vs.default_variant)],
+            is_replacing=False,
+            component_desc=desc,
+            purpose='guide')
+        self.assertTrue(result, "add_to_component_from_usd_prims should return True on success")
+        new_proxy = self._findNewProxyShape(before)
+        self.assertIsNone(new_proxy, "No new proxy shape should be created when adding to an existing component")
+
+        stage = mayaUsd.ufe.getStage(proxy)
+
+        cube_path = Sdf.Path('/root/geo/pCube1')
+        cube_prim = stage.GetPrimAtPath(cube_path)        
+        self.assertTrue(cube_prim.IsValid(), f"{cube_path} should be a valid prim")
+
+        purposed_path = Sdf.Path('/root/geo/gui/pCube2')
+        purposed_prim = stage.GetPrimAtPath(purposed_path)        
+        self.assertTrue(purposed_prim.IsValid(), f"{purposed_path} should be a valid prim after add_to_component_from_usd_prims with purpose")
+
     def testDefaultVariantUnchanged(self):
         """Adding a node to an existing variant must not change the default_variant name."""
         from usd_component_creator_plugin import add_to_component_from_usd_prims

test/lib/componentCreator/testComponentCreatorBase.py

@@ -39,6 +39,26 @@ def _getDescFromStage(self, stage):
         import AdskUsdComponentCreator
         return AdskUsdComponentCreator.ComponentDescription.CreateFromStageMetadata(stage)
 
+    @classmethod
+    def _setCustomPurposeTemplate(cls):
+        import AdskUsdComponentCreator
+        options = AdskUsdComponentCreator.GetKnownOptions('ASWF Standard (default)')
+        options = options.Clone()
+        options.purpose_scope_names = {
+            'guide' : 'gui',
+            'proxy' : 'prox',
+            'render': 'rend',
+        }
+        options_name = 'test_options'
+        AdskUsdComponentCreator.AddKnownOptions(options_name, options)
+        from usd_component_creator_plugin import save_selected_component_options_name
+        save_selected_component_options_name(options_name)
+
+    @classmethod
+    def _resetDefaultTemplate(cls):
+        from usd_component_creator_plugin import save_selected_component_options_name
+        save_selected_component_options_name('ASWF Standard (default)')
+
     def _createComponent(self):
         """Create a new Adsk USD Component with a `model/default` variant and a
         proxy shape pointing to its root layer.