Add support for "subclassing" SdfFileFormat in Swift

Examples/Plugins/SdfFileFormat/Tests/CodeCoverageTests.swift

@@ -0,0 +1,152 @@
+//===----------------------------------------------------------------------===//
+// This source file is part of github.com/apple/SwiftUsd
+//
+// Copyright © 2025 Apple Inc. and the SwiftUsd project authors.
+//
+// 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
+//
+//  https://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.
+//
+// SPDX-License-Identifier: Apache-2.0
+//===----------------------------------------------------------------------===//
+
+// This file runs through the test resources files included in usdcat-tests,
+// but as in-process instead of calling out to usdcat, so we can measure code coverage
+
+import Foundation
+import Testing
+import OpenUSD
+
+public typealias pxr = pxrInternal_v0_26_8__pxrReserved__
+
+func ensurePluginLoaded() throws {
+    let root = #bundle.resourceURL!
+        .absoluteURL
+        .deletingLastPathComponent()
+        .deletingLastPathComponent()
+        .deletingLastPathComponent()
+
+    let toLoad = root.path(percentEncoded: false) + "*/Contents/Resources/plugInfo_macOS.json"
+    print(toLoad)
+    let plugins = pxr.PlugRegistry.GetInstance().RegisterPlugins(std.string(toLoad))
+    try #require(!plugins.empty())
+}
+
+func resourcesUrl() -> URL {
+    #bundle.resourceURL!.appending(path: "Resources")
+}
+
+func usdResourcesFiles() throws -> [URL] {
+    var result = [URL]()
+    let enumerator = try #require(FileManager.default.enumerator(at: resourcesUrl(), includingPropertiesForKeys: nil))
+    for case let item as URL in enumerator {
+        guard item.pathExtension.hasPrefix("usd") else { continue }
+        guard !item.lastPathComponent.starts(with: "SKIP") else { continue }
+        result.append(item.absoluteURL)
+    }
+    result.sort(using: KeyPathComparator(\.path))
+    try #require(!result.isEmpty)
+    return result
+}
+
+func jsonResourcesFiles() throws -> [URL] {
+    var result = [URL]()
+    let enumerator = try #require(FileManager.default.enumerator(at: resourcesUrl(), includingPropertiesForKeys: nil))
+    for case let item as URL in enumerator {
+        guard item.pathExtension == "json" else { continue }
+        guard !item.lastPathComponent.starts(with: "SKIP") else { continue }
+        result.append(item.absoluteURL)
+    }
+    result.sort(using: KeyPathComparator(\.path))
+    try #require(!result.isEmpty)
+    return result
+}
+
+func expectJsonFailure(_ x: URL) throws {
+    try Overlay.withTfErrorMark { mark in
+        // Note: The #expect/#require macros require all subexpressions to be Copyable,
+        // so we can't use `mark` because Overlay.TfErrorMarkWrapper is ~Copyable
+        var isClean = mark.IsClean()
+        try #require(isClean)
+        let layer = Overlay.DereferenceOrNil(pxr.SdfLayer.FindOrOpen(x.forUsd, .init()))
+        // Don't want to put `layer` in the `#require`, because if it fails,
+        // Swift Testing will try to using reflection/mirrors to introspect the subexpressions
+        // and hit a runtime crash
+        let layerIsNil = layer == nil
+        if let layer {
+            let usdaLayer = Overlay.Dereference(pxr.SdfLayer.CreateAnonymous("", .init()))
+            usdaLayer.TransferContent(Overlay.TfWeakPtr(layer))
+            var s: std.string = ""
+            usdaLayer.ExportToString(&s)
+            print("\"\"\"\n" + String(s) + "\"\"\"")
+        }
+        try #require(layerIsNil, "\(x.forUsd)")
+        isClean = mark.IsClean()
+        try #require(!isClean)
+    }
+}
+
+func usdcat(a: std.string, b: std.string) throws {
+    let layer = try #require(Overlay.DereferenceOrNil(pxr.SdfLayer.FindOrOpen(a, .init())), "\(a), \(b)")
+    #expect(layer.Export(b, layer.GetComment(), .init()))
+}
+
+func diff(a: URL, b: URL) throws {
+    // Skip USDZ extraction since this isn't correctness,
+    // just code coverage
+    if a.pathExtension == "usdz" { return }
+
+    // Fake usddiff normalization by just usdcatting once more.
+    let aCatForDiff = std.string(String(b.forUsd) + ".acatfordiff.usda")
+    let bCatForDiff = std.string(String(b.forUsd) + ".bcatfordiff.usda")
+
+    try usdcat(a: a.forUsd, b: aCatForDiff)
+    try usdcat(a: b.forUsd, b: bCatForDiff)
+
+    let aLines = try String(contentsOf: URL(fileURLWithPath: String(aCatForDiff)),
+                            encoding: .utf8).components(separatedBy: .newlines)
+    let bLines = try String(contentsOf: URL(fileURLWithPath: String(bCatForDiff)),
+                            encoding: .utf8).components(separatedBy: .newlines)
+
+    try #require(aLines.count == bLines.count)
+    for i in 0..<aLines.count {
+        try #require(aLines[i] == bLines[i])
+    }
+}
+
+extension URL {
+    var forUsd: std.string { 
+        std.string(path(percentEncoded: false))
+    }
+}
+
+@Test func go() throws {
+    try ensurePluginLoaded()
+    for file in try usdResourcesFiles() {
+        let tempDir = FileManager.default.temporaryDirectory.appending(path: UUID().uuidString)
+        try FileManager.default.createDirectory(at: tempDir, withIntermediateDirectories: true)
+        print("Will test \(file.forUsd) in \(tempDir.forUsd)")
+
+
+        let json = tempDir.appending(path: file.lastPathComponent + ".json")
+        let secondUsda = tempDir.appending(path: file.lastPathComponent + ".second.usda")
+
+        try usdcat(a: file.forUsd, b: json.forUsd)
+        try usdcat(a: json.forUsd, b: secondUsda.forUsd)
+        try diff(a: file, b: secondUsda)
+        print("\(file.forUsd) passed")
+    }
+    for file in try jsonResourcesFiles() {
+        print("Will test \(file.forUsd)")
+        try expectJsonFailure(file)
+        print("\(file.forUsd) failed as expected")
+    }
+}

Examples/Plugins/SdfFileFormat/Tests/usdcat-tests/Package.swift

@@ -0,0 +1,44 @@
+// swift-tools-version: 6.2
+//===----------------------------------------------------------------------===//
+// This source file is part of github.com/apple/SwiftUsd
+//
+// Copyright © 2025 Apple Inc. and the SwiftUsd project authors.
+//
+// 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
+//
+//  https://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.
+//
+// SPDX-License-Identifier: Apache-2.0
+//===----------------------------------------------------------------------===//
+
+import PackageDescription
+
+// This package tests whether an SdfFileFormat plugin can losslessly roundtrip USD files. 
+
+let package = Package(
+    name: "usdcat-tests",
+    platforms: [.macOS(.v15)],
+    products: [
+        .executable(name: "usdcat-tests", targets: ["usdcat-tests"])
+    ],
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.2.0"),
+        .package(url: "https://github.com/swiftlang/swift-subprocess.git", from: "0.4.0"),
+    ],
+    targets: [
+        .executableTarget(name: "usdcat-tests",
+                          dependencies: [
+                            .product(name: "Subprocess", package: "swift-subprocess"),
+                            .product(name: "ArgumentParser", package: "swift-argument-parser"),
+                          ]
+        ),
+    ],
+)

Examples/Plugins/SdfFileFormat/Tests/usdcat-tests/Resources/10_deprecated/1_add-reference.usda

@@ -0,0 +1,7 @@
+#usda 1.0
+
+def "A" (
+    add references = </DoesntExist>
+)
+{
+}

Examples/Plugins/SdfFileFormat/Tests/usdcat-tests/Resources/10_deprecated/2_old-typename-transform.usda

@@ -0,0 +1,8 @@
+#usda 1.0
+
+def "foo"
+{
+    Transform transform = ( (1, 2, 3, 4), (5, 6, 7, 8), (9, 10, 11, 12), (13, 14, 15, 16) )
+}
+
+

Examples/Plugins/SdfFileFormat/Tests/usdcat-tests/Resources/10_deprecated/3_order-two-prepend-rels.usda

@@ -0,0 +1,20 @@
+#usda 1.0
+
+# pxr/usdImaging/usdImagingGL/testenv/testUsdImagingGLBasicDrawing/basicDrawing/shaders_bindings.usd
+
+def "Foo" (
+    apiSchemas = ["CollectionAPI:myCollection"]
+){
+    prepend rel collection:myCollection:includes = [
+        </Fizz1>,
+        </Fizz2>
+    ]
+}
+
+def "Fizz1" 
+{
+}
+
+def "Fizz2"
+{
+}

Examples/Plugins/SdfFileFormat/Tests/usdcat-tests/Resources/10_deprecated/4_permission-on-attr.usda

@@ -0,0 +1,8 @@
+#usda 1.0
+
+def Mesh "card"
+{
+    int customInt (permission = public)
+}
+
+

Examples/Plugins/SdfFileFormat/Tests/usdcat-tests/Resources/10_deprecated/5_reorder-listop.usda

@@ -0,0 +1,7 @@
+#usda 1.0
+
+def "A" (
+    reorder references = </DoesntExist>
+)
+{
+}

Examples/Plugins/SdfFileFormat/Tests/usdcat-tests/Resources/10_deprecated/6_reorder-listop-2.usda

@@ -0,0 +1,7 @@
+#usda 1.0
+
+def "A" (
+    reorder clipSets = ["Fizz", "Buzz"]
+)
+{
+}

Examples/Plugins/SdfFileFormat/Tests/usdcat-tests/Resources/11_losslessly_handle_invalid_files/1_extent-wrong-type-name.usda

@@ -0,0 +1,14 @@
+#usda 1.0
+
+# pxr/usdImaging/usdImagingGL/testenv/testUsdImagingGLShadeBool/shadebool.usda
+# has two extent attributes with type `vec3f[]` when it should be `float3[]`
+
+def Scope "Geom"
+{
+    def Mesh "Foo" (
+        prepend apiSchemas = ["MaterialBindingAPI"]
+    )
+    {
+        vec3f[] extent = [(-1.21273, -1.21273, -1.21273), (1.21273, 1.21273, 1.21273)]
+    }
+}

Examples/Plugins/SdfFileFormat/Tests/usdcat-tests/Resources/11_losslessly_handle_invalid_files/2_lossless-attr-collection-api.usda

@@ -0,0 +1,10 @@
+#usda 1.0
+
+def "Foo" (
+    apiSchemas = ["CollectionAPI:bar"]
+) {
+    # CollectionAPI specifies that includeRoot should be uniform,
+    # but pxr/usd/usd/testenv/testUsdNamespaceEditorProperties/basic/root.usda
+    # has a non-uniform collection::includeRoot attr
+    bool collection:bar:includeRoot = true
+}

Examples/Plugins/SdfFileFormat/Tests/usdcat-tests/Resources/11_losslessly_handle_invalid_files/3_mismatched-types.usda

@@ -0,0 +1,9 @@
+#usda 1.0
+
+def "Foo"
+{
+    # @pxr/usdImaging/usdImagingGL/testenv/testUsdImagingGLShadeMaterial/coloredCubes.usda@</Materials/lambera1.outputs:ri:surface> is written as a token but assigned a path value
+    token bar = </Foo>
+}
+
+

Examples/Plugins/SdfFileFormat/Tests/usdcat-tests/Resources/11_losslessly_handle_invalid_files/4_unregistered_listops.usda

@@ -0,0 +1,6 @@
+#usda 1.0
+
+def "A" (
+    prepend foo = ["bar", "fizz"]
+) {
+}

Examples/Plugins/SdfFileFormat/Tests/usdcat-tests/Resources/12_bad_json/10_spline_no_postExtrapolation.json

@@ -0,0 +1,49 @@
+{
+    "children": [{
+            "attributes": [{
+                    "name": "myAttr",
+                    "spline": {
+                        "curveType": 0,
+                        "innerLoopParams": {
+                            "numPostLoops": 0,
+                            "numPreLoops": 0,
+                            "protoEnd": 0.0,
+                            "protoStart": 0.0,
+                            "valueOffset": 0.0
+                        },
+                        "knots": [{
+                                "customData": {},
+                                "nextInterpolation": 3,
+                                "postTanAlgorithm": 0,
+                                "postTanSlope": 0.0,
+                                "postTanWidth": 0.0,
+                                "preTanAlgorithm": 0,
+                                "preTanSlope": 0.0,
+                                "preTanWidth": 0.0,
+                                "time": 1.0,
+                                "value": 1.0
+                            }, {
+                                "customData": {},
+                                "nextInterpolation": 0,
+                                "postTanAlgorithm": 0,
+                                "postTanSlope": 0.0,
+                                "postTanWidth": 0.0,
+                                "preTanAlgorithm": 0,
+                                "preTanSlope": 0.0,
+                                "preTanWidth": 0.0,
+                                "time": 10.0,
+                                "value": 10.0
+                            }],
+                        "preExtrapolation": {
+                            "mode": 1,
+                            "slope": 0.0
+                        }
+                    },
+                    "type": "Double",
+                    "variability": 0
+                }],
+            "name": "hello",
+            "spec": "def"
+        }],
+    "name": "/"
+}