Make usdchecker use the new validation framework by default.

   Clients can still use the old and deprecated compliance checker interface by providing a --useOldComplianceCheckerInterface flag.

(Internal change: 2376195)

Author: tallytalwar

pxr/usdValidation/bin/usdchecker/CMakeLists.txt

@@ -39,22 +39,22 @@ pxr_install_test_dir(
 )
 
 pxr_register_test(testUsdChecker1
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker clean/clean.usd"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useOldComplianceCheckerInterface clean/clean.usd"
     EXPECTED_RETURN_CODE 0
 )
 
 pxr_register_test(testUsdChecker2
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker clean/clean_flat.usdc"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useOldComplianceCheckerInterface clean/clean_flat.usdc"
     EXPECTED_RETURN_CODE 0
 )
 
 pxr_register_test(testUsdChecker3
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker clean/clean.usdz"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useOldComplianceCheckerInterface clean/clean.usdz"
     EXPECTED_RETURN_CODE 0
 )
 
 pxr_register_test(testUsdChecker4
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker clean/clean_flat.usdz"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useOldComplianceCheckerInterface clean/clean_flat.usdz"
     EXPECTED_RETURN_CODE 0
 )
 
@@ -79,23 +79,23 @@ pxr_install_test_dir(
 )
 
 pxr_register_test(testUsdChecker5
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --arkit clean/clean_arkit.usdz"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useOldComplianceCheckerInterface --arkit clean/clean_arkit.usdz"
     EXPECTED_RETURN_CODE 0
 )
 
 pxr_register_test(testUsdChecker6
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --arkit clean/clean_flat.usdc"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useOldComplianceCheckerInterface --arkit clean/clean_flat.usdc"
     EXPECTED_RETURN_CODE 1
 )
 
 # Adding a "rootPackageOnly" option to the command line will make the clean files
 pxr_register_test(testUsdChecker7
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --arkit --rootPackageOnly clean/clean_flat.usdz"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useOldComplianceCheckerInterface --arkit --rootPackageOnly clean/clean_flat.usdz"
     EXPECTED_RETURN_CODE 0
 )
 
 pxr_register_test(testUsdChecker8
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --arkit clean/clean_flat.usdz"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useOldComplianceCheckerInterface --arkit clean/clean_flat.usdz"
     EXPECTED_RETURN_CODE 1
 )
 
@@ -120,23 +120,23 @@ pxr_install_test_dir(
 )
 
 pxr_register_test(testUsdChecker9
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker bad/badUsdz.usdz"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useOldComplianceCheckerInterface bad/badUsdz.usdz"
     EXPECTED_RETURN_CODE 1
 )
 
 pxr_register_test(testUsdChecker10
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --arkit --dumpRules bad/variants.usdc -o variants_failedChecks.txt"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useOldComplianceCheckerInterface --arkit --dumpRules bad/variants.usdc -o variants_failedChecks.txt"
     DIFF_COMPARE variants_failedChecks.txt
     EXPECTED_RETURN_CODE 1
 )
 
 pxr_register_test(testUsdChecker11
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker bad/brokenRef.usd"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useOldComplianceCheckerInterface bad/brokenRef.usd"
     EXPECTED_RETURN_CODE 1
 )
 
 pxr_register_test(testUsdChecker12
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --arkit bad/badShaderUnsupportedTexture.usdc"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useOldComplianceCheckerInterface --arkit bad/badShaderUnsupportedTexture.usdc"
     EXPECTED_RETURN_CODE 1
 )
 
@@ -146,7 +146,7 @@ pxr_install_test_dir(
 )
 
 pxr_register_test(testUsdChecker13
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker clean/cleanNormalMapReader.usda"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useOldComplianceCheckerInterface clean/cleanNormalMapReader.usda"
     EXPECTED_RETURN_CODE 0
 )
 
@@ -158,8 +158,8 @@ if (NOT BUILD_SHARED_LIBS)
     return()
 endif()
 
-# Following are all usdchecker tests using the new --useNewValidationFramework
-# flag. These tests are expected to pass with the new validation framework.
+# Following are all usdchecker tests using the new Validation Framework.
+# These tests are expected to pass with the new validation framework.
 pxr_install_test_dir(
     SRC testenv/testUsdChecker
     DEST testUsdChecker14
@@ -181,23 +181,23 @@ pxr_install_test_dir(
 )
 
 pxr_register_test(testUsdChecker14
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework clean/clean.usd"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker clean/clean.usd"
     EXPECTED_RETURN_CODE 0
 )
 
 
 pxr_register_test(testUsdChecker15
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework clean/clean_flat.usdc"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker clean/clean_flat.usdc"
     EXPECTED_RETURN_CODE 0
 )
 
 pxr_register_test(testUsdChecker16
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework clean/clean.usdz"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker clean/clean.usdz"
     EXPECTED_RETURN_CODE 0
 )
 
 pxr_register_test(testUsdChecker17
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework clean/clean_flat.usdz"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker clean/clean_flat.usdz"
     EXPECTED_RETURN_CODE 0
 )
 
@@ -223,7 +223,7 @@ pxr_install_test_dir(
 )
 
 pxr_register_test(testUsdChecker18
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework --arkit clean/clean_arkit.usdz"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --arkit clean/clean_arkit.usdz"
     EXPECTED_RETURN_CODE 0
 )
 
@@ -232,19 +232,19 @@ pxr_register_test(testUsdChecker18
 #following are disabled.
 
 #pxr_register_test(testUsdChecker19
-#    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework --arkit clean/clean_flat.usdc"
+#    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --arkit clean/clean_flat.usdc"
 #    EXPECTED_RETURN_CODE 1
 #)
 
 # "rootPackageOnly" won't report validation errors within the subpackages, so it should pass
 pxr_register_test(testUsdChecker20
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework --arkit --rootPackageOnly bad/sceneWithInvalidPackage.usda"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --arkit --rootPackageOnly bad/sceneWithInvalidPackage.usda"
     EXPECTED_RETURN_CODE 0
 )
 
 # Removing rootPackageOnly, should fail as the subpackage has invalid content
 pxr_register_test(testUsdChecker21
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework --arkit bad/sceneWithInvalidPackage.usda"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --arkit bad/sceneWithInvalidPackage.usda"
     EXPECTED_RETURN_CODE 1
 )
 
@@ -314,7 +314,7 @@ pxr_install_test_dir(
 )
 
 pxr_register_test(testUsdChecker22
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework bad/badUsdz.usdz"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker bad/badUsdz.usdz"
     EXPECTED_RETURN_CODE 1
 )
 
@@ -325,76 +325,76 @@ pxr_register_test(testUsdChecker22
 # Simple variant file, showing all combination of variants being validated and
 # failing
 pxr_register_test(testUsdChecker23
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework --arkit --dumpRules bad/badVariants.usdc"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --arkit --dumpRules bad/badVariants.usdc"
     EXPECTED_RETURN_CODE 1
 )
 
 # Complex variants, with default variant being clean but still one of the
 # combination of variant failing.
 pxr_register_test(testUsdChecker24
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework bad/badVariants2.usda"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker bad/badVariants2.usda"
     EXPECTED_RETURN_CODE 1
 )
 
 # Explicitly set broken variant combination, should fail
 pxr_register_test(testUsdChecker25
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework bad/badVariants2.usda --variants testSet:test2,testSet2:test2C"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker bad/badVariants2.usda --variants testSet:test2,testSet2:test2C"
     EXPECTED_RETURN_CODE 1
 )
 
 # Explicitly set clean variant combination, should pass
 pxr_register_test(testUsdChecker26
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework bad/badVariants2.usda --variants testSet:test1,testSet2:test2A"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker bad/badVariants2.usda --variants testSet:test1,testSet2:test2A"
     EXPECTED_RETURN_CODE 0
 )
 
 # Explicitly set variant combination which doesn't exist (test2C doesn't exist
 # in testSet:test1 variant, should pass
 pxr_register_test(testUsdChecker27
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework bad/badVariants2.usda --variants testSet:test1,testSet2:test2C"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker bad/badVariants2.usda --variants testSet:test1,testSet2:test2C"
     EXPECTED_RETURN_CODE 0
 )
 
 # Explicitly set variantSets, one combination of testSet variantSet will fail
 pxr_register_test(testUsdChecker28
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework bad/badVariants2.usda --variantSets testSet"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker bad/badVariants2.usda --variantSets testSet"
     EXPECTED_RETURN_CODE 1
 )
 
 
 # Complex variant example with variant on a prim changing its variantSet
 # This test should fail as the variantSet set1 has a variant ref2, which brings in more variantSets set2 and set3, and one of these defaults set3:D fails validation
 pxr_register_test(testUsdChecker29
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework bad/badVariants3.usda"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker bad/badVariants3.usda"
     EXPECTED_RETURN_CODE 1
 )
 
 # When running variantSets set1 explicitly, it traverses the set1:ref2 which again brings in a default set3:D which fails validation
 pxr_register_test(testUsdChecker30
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework bad/badVariants3.usda --variantSets set1"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker bad/badVariants3.usda --variantSets set1"
     EXPECTED_RETURN_CODE 1
 )
 
 # variantSets set2, set3 do not exist by default, as set1:ref1 default on the /World prim, doesn't bring in any new variant set via a reference and hence doesn't fail validation.
 pxr_register_test(testUsdChecker31
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework bad/badVariants3.usda --variantSets set2"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker bad/badVariants3.usda --variantSets set2"
     EXPECTED_RETURN_CODE 0
 )
 
 pxr_register_test(testUsdChecker32
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework bad/badVariants3.usda --variantSets set3"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker bad/badVariants3.usda --variantSets set3"
     EXPECTED_RETURN_CODE 0
 )
 
 # Running a specific variant combination which fails validation
 pxr_register_test(testUsdChecker33
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework bad/badVariants3.usda --variants set1:ref2,set2:A,set3:D"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker bad/badVariants3.usda --variants set1:ref2,set2:A,set3:D"
     EXPECTED_RETURN_CODE 1
 )
 
 # Running a specific variant with variants from a specific variantSet (one of this combination fails validation, set1:ref2 set3:D)
 pxr_register_test(testUsdChecker34
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework bad/badVariants3.usda --variants set1:ref2 --variantSets set3"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker bad/badVariants3.usda --variants set1:ref2 --variantSets set3"
     EXPECTED_RETURN_CODE 1
 )
 
@@ -409,12 +409,12 @@ pxr_install_test_dir(
 )
 
 pxr_register_test(testUsdChecker35
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework bad/brokenRef.usd"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker bad/brokenRef.usd"
     EXPECTED_RETURN_CODE 1
 )
 
 pxr_register_test(testUsdChecker36
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework --arkit bad/badShaderUnsupportedTexture.usdc"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --arkit bad/badShaderUnsupportedTexture.usdc"
     EXPECTED_RETURN_CODE 1
 )
 
@@ -424,6 +424,6 @@ pxr_install_test_dir(
 )
 
 pxr_register_test(testUsdChecker37
-    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker --useNewValidationFramework clean/cleanNormalMapReader.usda"
+    COMMAND "${CMAKE_INSTALL_PREFIX}/bin/usdchecker clean/cleanNormalMapReader.usda"
     EXPECTED_RETURN_CODE 0
 )

pxr/usdValidation/bin/usdchecker/usdchecker.cpp

@@ -61,7 +61,7 @@ struct Args {
     bool dumpRules = false;
     bool verbose = false;
     bool strict = false;
-    bool useNewValidationFramework = false;
+    bool useOldComplianceCheckerInterface = false;
 };
 
 static
@@ -108,8 +108,13 @@ _Configure(CLI::App* app, Args& args) {
         "Return failure code even if only warnings are issued, for stricter\n"
         "compliance.");
     app->add_flag(
-        "--useNewValidationFramework", args.useNewValidationFramework, 
-        "Enable the new validation framework.");
+        "--useNewValidationFramework",
+        "Default behavior, this option is IGNORED but retained to avoid client "
+        "code breakage.")->group("");
+    app->add_flag(
+        "--useOldComplianceCheckerInterface", 
+        args.useOldComplianceCheckerInterface, 
+        "Use the old and now deprecated Compliance Checker interface.");
     app->add_option(
         "--variantSets", args.variantSets,
         "List of variantSets to validate. All variants for the given\n"
@@ -153,15 +158,15 @@ _ValidateArgs(const Args& args) {
     }
 
     // variants option is only valid when using new validation framework.
-    if (!args.variants.empty() && !args.useNewValidationFramework) {
+    if (!args.variants.empty() && args.useOldComplianceCheckerInterface) {
         std::cerr<<"Error: The --variants option is only valid when using the "
-            "--useNewValidationFramework option."<<"\n";
+            "new ValidationFramework."<<"\n";
         return false;
     }
 
-    if (!args.variantSets.empty() && !args.useNewValidationFramework) {
+    if (!args.variantSets.empty() && args.useOldComplianceCheckerInterface) {
         std::cerr<<"Error: The --variantSets option is only valid when using "
-            "the --useNewValidationFramework option."<<"\n";
+            "the new ValidationFramework."<<"\n";
         return false;
     }
 
@@ -540,7 +545,7 @@ _UsdChecker(const Args& args)
         return 1;
     }
 
-    if (args.useNewValidationFramework) {
+    if (!args.useOldComplianceCheckerInterface) {
         UsdValidationRegistry &validationReg = 
             UsdValidationRegistry::GetInstance();
         UsdValidationValidatorMetadataVector metadata = 
@@ -671,7 +676,7 @@ _UsdChecker(const Args& args)
 
     std::cerr<<"usdchecker using UsdUtilsComplianceChecker requires Python "
         "support to be enabled in the build of USD. Its recommended to use "
-        "--useNewValidationFramework which doesn't require any python "
+        "the new ValidationFramework which doesn't require any python "
         "support.\n";
     return 1;
 
@@ -786,8 +791,8 @@ main(int argc, char const *argv[]) {
         "attribute is checked, currently.  General USD checks are always "
         "performed, and more restrictive checks targeted at distributable "
         "consumer content are also applied when the \"--arkit\" option is "
-        "specified. In order to use the new validation framework provide the "
-        "'--useNewValidationFramework' option.");
+        "specified. In order to use the old compliance checker (deprecated) "
+        "provide the '--useOldComplianceCheckerInterface' option.");
 
     Args args;
     _Configure(&app, args);