HYDRA-780 : Image-based NURBS unit test (#54)

* HYDRA-780 : Add image-based NURBS unit test * HYDRA-780 : Add image files and fix test * HYDRA-780 : Cleanup compareSnapshot * HYDRA-780 : Remove need for PluginLoaded * HYDRA-780 : Add comment on why specific NURBS were chosen * HYDRA-780 : Make each test have a new file by default * HYDRA-780 : Adjust camera * HYDRA-780 : Adjust image diff threshold * HYDRA-780 : Return makeNurbNodeName programmatically * HYDRA-780 : Put stricter percent threshold * HYDRA-780 : Adjust image diff threshold * HYDRA-780 : Move camera closer for fresh prims * HYDRA-780 : Remove new file in mtohutils * Create new scene before each test * HYDRA-780 : Add comment on ArubaTessellator * HYDRA-780 : Refactor nurbsCreationCallable setup * HYDRA-780 : Move ArubaTessellator load code to common code
Autodesk · Feb 5, 2024 · 6d54e8e · 6d54e8e
1 parent 574aa01
commit 6d54e8e
Show file tree

Hide file tree

Showing 15 changed files with 125 additions and 0 deletions.
diff --git a/test/lib/mayaUsd/render/mayaToHydra/CMakeLists.txt b/test/lib/mayaUsd/render/mayaToHydra/CMakeLists.txt
@@ -18,6 +18,7 @@ set(INTERACTIVE_TEST_SCRIPT_FILES
     testFlowViewportAPI.py
     testStageVariants.py
     testArnoldLights.py
+    testNurbsPrimitives.py
     cpp/testColorPreferences.py
     cpp/testCppFramework.py
     cpp/testMayaSceneFlattening.py

diff --git a/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/circle_fresh.png b/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/circle_fresh.png
diff --git a/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/circle_modified.png b/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/circle_modified.png
diff --git a/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/circle_tolerance.png b/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/circle_tolerance.png
diff --git a/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/circle_unfixedCenter.png b/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/circle_unfixedCenter.png
diff --git a/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/cube_fresh.png b/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/cube_fresh.png
diff --git a/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/cube_modified.png b/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/cube_modified.png
diff --git a/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/square_fresh.png b/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/square_fresh.png
diff --git a/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/square_modified.png b/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/square_modified.png
diff --git a/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/torus_fresh.png b/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/torus_fresh.png
diff --git a/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/torus_modified.png b/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/torus_modified.png
diff --git a/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/torus_tolerance.png b/test/lib/mayaUsd/render/mayaToHydra/NurbsPrimitivesTest/torus_tolerance.png
diff --git a/test/lib/mayaUsd/render/mayaToHydra/testNurbsPrimitives.py b/test/lib/mayaUsd/render/mayaToHydra/testNurbsPrimitives.py
@@ -0,0 +1,112 @@
+# Copyright 2024 Autodesk
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+import maya.cmds as cmds
+import fixturesUtils
+import mtohUtils
+
+class TestNurbsPrimitives(mtohUtils.MtohTestCase):
+    # MayaHydraBaseTestCase.setUpClass requirement.
+    _file = __file__
+
+    IMAGE_DIFF_FAIL_THRESHOLD = 0.1
+    IMAGE_DIFF_FAIL_PERCENT = 0.75
+
+    def compareSnapshot(self, referenceFilename, cameraDistance=10):
+        self.setBasicCam(cameraDistance)
+        cmds.refresh()
+        self.assertSnapshotClose(referenceFilename, self.IMAGE_DIFF_FAIL_THRESHOLD, self.IMAGE_DIFF_FAIL_PERCENT)
+
+    def setupScene(self, nurbsCreationCallable):
+        self.setHdStormRenderer()
+        makeNurbNodeName = nurbsCreationCallable()[1]
+        cmds.refresh()
+        return makeNurbNodeName
+
+    # Torus attributes is a superset of sphere, cone, and cylinder attributes
+    def test_NurbsTorus(self):
+        makeNurbNodeName = self.setupScene(cmds.torus)
+        self.compareSnapshot("torus_fresh.png", 5)
+
+        cmds.setAttr(makeNurbNodeName + ".startSweep", 50)
+        cmds.setAttr(makeNurbNodeName + ".endSweep", 300)
+        cmds.setAttr(makeNurbNodeName + ".radius", 2)
+        cmds.setAttr(makeNurbNodeName + ".degree", 1)
+        cmds.setAttr(makeNurbNodeName + ".sections", 12)
+        cmds.setAttr(makeNurbNodeName + ".spans", 6)
+        cmds.setAttr(makeNurbNodeName + ".heightRatio", 0.8)
+        cmds.setAttr(makeNurbNodeName + ".minorSweep", 250)
+        self.compareSnapshot("torus_modified.png")
+
+        cmds.setAttr(makeNurbNodeName + ".useTolerance", True)
+        cmds.setAttr(makeNurbNodeName + ".tolerance", 0.05)
+        self.compareSnapshot("torus_tolerance.png")
+
+    # Cube attributes is a superset of plane attributes
+    def test_NurbsCube(self):
+        makeNurbNodeName = self.setupScene(cmds.nurbsCube)
+        self.compareSnapshot("cube_fresh.png", 5)
+
+        cmds.setAttr(makeNurbNodeName + ".degree", 1)
+        cmds.setAttr(makeNurbNodeName + ".patchesU", 2)
+        cmds.setAttr(makeNurbNodeName + ".patchesV", 3)
+        cmds.setAttr(makeNurbNodeName + ".width", 4)
+        cmds.setAttr(makeNurbNodeName + ".lengthRatio", 2)
+        cmds.setAttr(makeNurbNodeName + ".heightRatio", 3)
+        self.compareSnapshot("cube_modified.png")
+
+    def test_NurbsCircle(self):
+        makeNurbNodeName = self.setupScene(cmds.circle)
+        self.compareSnapshot("circle_fresh.png", 5)
+
+        cmds.setAttr(makeNurbNodeName + ".sweep", 180)
+        cmds.setAttr(makeNurbNodeName + ".radius", 2)
+        cmds.setAttr(makeNurbNodeName + ".degree", 1)
+        cmds.setAttr(makeNurbNodeName + ".sections", 12)
+        cmds.setAttr(makeNurbNodeName + ".normalX", 1)
+        cmds.setAttr(makeNurbNodeName + ".normalY", 2)
+        cmds.setAttr(makeNurbNodeName + ".normalZ", 3)
+        cmds.setAttr(makeNurbNodeName + ".centerX", 4)
+        cmds.setAttr(makeNurbNodeName + ".centerY", 5)
+        cmds.setAttr(makeNurbNodeName + ".centerZ", 6)
+        cmds.setAttr(makeNurbNodeName + ".firstPointX", 7)
+        cmds.setAttr(makeNurbNodeName + ".firstPointY", 8)
+        cmds.setAttr(makeNurbNodeName + ".firstPointZ", 9)
+        self.compareSnapshot("circle_modified.png")
+
+        cmds.setAttr(makeNurbNodeName + ".useTolerance", True)
+        cmds.setAttr(makeNurbNodeName + ".tolerance", 0.05)
+        self.compareSnapshot("circle_tolerance.png")
+
+        cmds.setAttr(makeNurbNodeName + ".fixCenter", False)
+        self.compareSnapshot("circle_unfixedCenter.png")
+
+    def test_NurbsSquare(self):
+        makeNurbNodeName = self.setupScene(cmds.nurbsSquare)
+        self.compareSnapshot("square_fresh.png", 5)
+
+        cmds.setAttr(makeNurbNodeName + ".sideLength1", 2)
+        cmds.setAttr(makeNurbNodeName + ".sideLength2", 3)
+        cmds.setAttr(makeNurbNodeName + ".spansPerSide", 4)
+        cmds.setAttr(makeNurbNodeName + ".degree", 1)
+        cmds.setAttr(makeNurbNodeName + ".normalX", 1)
+        cmds.setAttr(makeNurbNodeName + ".normalY", 2)
+        cmds.setAttr(makeNurbNodeName + ".normalZ", 3)
+        cmds.setAttr(makeNurbNodeName + ".centerX", 4)
+        cmds.setAttr(makeNurbNodeName + ".centerY", 5)
+        cmds.setAttr(makeNurbNodeName + ".centerZ", 6)
+        self.compareSnapshot("square_modified.png")
+
+if __name__ == '__main__':
+    fixturesUtils.runTests(globals())
diff --git a/test/testUtils/fixturesUtils.py b/test/testUtils/fixturesUtils.py
@@ -19,6 +19,9 @@
 import sys
 import unittest
 
+# Plugins that are bundled and loaded by default in a Maya installation
+DEFAULT_PLUGINS = ['ArubaTessellator']
+
 def _setUpClass(modulePathName, pluginName, initializeStandalone):
     '''
     Common code for setUpClass() and readOnlySetUpClass()
@@ -31,6 +34,9 @@ def _setUpClass(modulePathName, pluginName, initializeStandalone):
         import maya.cmds as cmds
         cmds.loadPlugin(pluginName, quiet=True)
 
+    for defaultPlugin in DEFAULT_PLUGINS:
+        cmds.loadPlugin(defaultPlugin, quiet=True)
+
     realPath = os.path.realpath(modulePathName)
     return os.path.split(realPath)
 

diff --git a/test/testUtils/mtohUtils.py b/test/testUtils/mtohUtils.py
@@ -56,6 +56,12 @@ def setUpClass(cls):
                              "define `_file = __file__`")
         fixturesUtils.readOnlySetUpClass(cls._file, 'mayaHydra', 
                                          initializeStandalone=False)
+
+    def setUp(self):
+        # Maya is not closed/reset between each test of a test suite,
+        # so open a new file before each test to minimize leftovers
+        # from previous tests.
+        cmds.file(new=True, force=True)
 
     def setHdStormRenderer(self):
         self.activeEditor = cmds.playblast(activeEditor=1)