Luce packages
LuceLuce BaseLuciaOS

dymokomi/luce-usd

Source of release 0.9.3

0.9.3 / tests / checks / pcp_checks.lucb

## Composition (Pcp) against OpenUSD's own museum cases in
## tests/fixtures/openusd/museum: each case's composition report must be
## the one OpenUSD prints (after the first line, which names the layer as
## given on the command line).
import memory
from luce_usd.kernel import Names, LayerData, Composer, anonymous_session, flatten_stage, write_usda, absolute_path, composition_report, read_file
from luce_geocore.core.growing import Growing
import strings

## One museum case: its directory, the session layer (or ""), and the
## prefix of prims whose payloads stay unloaded (or "").
struct Case:
    var name: str
    var session: str
    var unloaded: str

let cases: Case[28] = [
    Case(name = "BasicAncestralReference", session = "", unloaded = ""),
    Case(name = "BasicReferenceDiamond", session = "", unloaded = ""),
    Case(name = "BasicTimeOffset", session = "", unloaded = ""),
    Case(name = "TrickyListEditedTargetPaths", session = "", unloaded = ""),
    Case(name = "SubrootReferenceNonCycle", session = "", unloaded = ""),
    Case(name = "BasicOwner", session = "session.usda", unloaded = ""),
    Case(name = "BasicPayloadDiamond", session = "", unloaded = "/RootUnloaded"),
    Case(name = "BasicNestedVariants", session = "", unloaded = ""),
    Case(name = "TrickyVariantSelectionInVariant", session = "", unloaded = ""),
    Case(name = "TrickyVariantWeakerSelection", session = "", unloaded = ""),
    Case(name = "TrickyNonLocalVariantSelection", session = "", unloaded = ""),
    Case(name = "BasicReferenceAndClassDiamond", session = "", unloaded = ""),
    Case(name = "BasicSpecializesAndInherits", session = "", unloaded = ""),
    Case(name = "ImpliedAndAncestralInherits", session = "", unloaded = ""),
    Case(name = "TrickySpecializesAndInherits3", session = "", unloaded = ""),
    Case(name = "SpecializesAndVariants2", session = "", unloaded = ""),
    Case(name = "BasicInstancing", session = "", unloaded = ""),
    Case(name = "BasicInstancingAndNestedInstances", session = "", unloaded = ""),
    Case(name = "ImpliedArcsAndInstancing", session = "", unloaded = ""),
    Case(name = "BasicRelocateToAnimInterface", session = "", unloaded = ""),
    Case(name = "TrickyInheritsAndRelocates", session = "", unloaded = ""),
    Case(name = "TrickySpookyInherits", session = "", unloaded = ""),
    Case(name = "ErrorInvalidInstanceTargetPath", session = "", unloaded = ""),
    Case(name = "TrickyMultipleRelocations", session = "", unloaded = ""),
    Case(name = "RelocateToNone", session = "", unloaded = ""),
    Case(name = "ExpressionsInReferences", session = "", unloaded = ""),
    Case(name = "ExpressionsInVariantSelections", session = "", unloaded = ""),
    Case(name = "ExpressionsInSublayers", session = "session.usda", unloaded = ""),
]

pub func museum() -> !:
    for case in cases: try check_case(case)

func check_case(case: Case) -> !:
    var root: u8[256]
    let root_path = try strings.format(root, f"tests/fixtures/openusd/museum/{case.name}/root.usda")
    var session: u8[256]
    let session_path = try strings.format(session, f"tests/fixtures/openusd/museum/{case.name}/{case.session}") if case.session.length > 0 else ""
    var expected_buffer: u8[256]
    let expected = try read_file(try strings.format(expected_buffer, f"tests/fixtures/openusd/museum/{case.name}/expected.txt"))
    defer free(expected) in memory.heap
    var names = try Names()
    defer names.close()
    var report = Growing[u8]()
    defer report.close()
    try composition_report(&names, root_path, session_path, case.unloaded, "", &report)
    let ours = after_loading((str)report.view())
    let theirs = after_loading((str)expected)
    if ours != theirs:
        print(f"museum case {case.name} composes differently:")
        print(ours)
    assert(ours == theirs)

## The report after its "Loading @root@" line.
func after_loading(text: str) -> str:
    let marker = "Loading @"
    var at: usize = 0
    while at + marker.length <= text.length:
        if (str)text.bytes[at..<at + marker.length] == marker:
            var end = at
            while end < text.length and text.bytes[end] != 10: end += 1
            return (str)text.bytes[end..]
        at += 1
    return text

## Flattened stages of the museum cases, as usdcat --flatten
## --skipSourceFileComment writes them.
pub func flattened() -> !:
    for case in cases:
        if case.session.length > 0 or case.unloaded.length > 0: continue
        try check_flattened(case.name)

func check_flattened(name: str) -> !:
    var root: u8[256]
    var expected_buffer: u8[256]
    try compare_flattened(try strings.format(root, f"tests/fixtures/openusd/museum/{name}/root.usda"), try strings.format(expected_buffer, f"tests/fixtures/openusd/museum/{name}/flattened.usda"), name)

## Built-in properties take their schema's type and variability, and are
## not custom (UsdPrimDefinition), as usdcat --flatten writes them.
pub func builtins() -> !:
    try compare_flattened("tests/fixtures/flatten/builtins.usda", "tests/fixtures/flatten/builtins.flattened.usda", "builtins")

func compare_flattened(root_path: str, expected_path: str, name: str) -> !:
    let expected = try read_file(expected_path)
    defer free(expected) in memory.heap
    var names = try Names()
    defer names.close()
    var identifier = Growing[u8]()
    defer identifier.close()
    try absolute_path(root_path, &identifier)
    var composer = try Composer(&names, (str)identifier.view(), anonymous_session)
    defer composer.close()
    var flat = try LayerData(&names)
    defer flat.close()
    try flatten_stage(&composer, &flat, false, true)
    var text = Growing[u8]()
    defer text.close()
    try write_usda(&flat, &text)
    if (str)text.view() != (str)expected:
        print(f"museum case {name} flattens differently:")
        print((str)text.view())
    assert((str)text.view() == (str)expected)