220 lines
9.0 KiB
Python
220 lines
9.0 KiB
Python
import hashlib
|
|
import json
|
|
import os
|
|
|
|
import FreeCAD as App
|
|
import Part
|
|
|
|
|
|
FREECAD_COMMIT = "0108fd4b4850cc46e625b60e53cea7a7bbe69f8d"
|
|
OUTPUT_PATH = os.environ.get("FREECAD_PROPERTY_LINKSUBHIDDEN_FAILURE_OUTPUT", "")
|
|
|
|
|
|
def value_of(owner):
|
|
value = owner.ColoredElements
|
|
if value is None:
|
|
return None
|
|
return {"object": value[0].Name if value[0] else None, "subElements": list(value[1])}
|
|
|
|
|
|
def shape_hash(obj):
|
|
shape = obj.Shape
|
|
if shape.isNull():
|
|
return None
|
|
return hashlib.sha256(shape.exportBrepToString().encode("utf-8")).hexdigest()
|
|
|
|
|
|
def object_set(document):
|
|
return [{"name": obj.Name, "typeId": obj.TypeId} for obj in document.Objects]
|
|
|
|
|
|
def snapshot(document, owner, targets):
|
|
return {
|
|
"value": value_of(owner),
|
|
"propertyTypeId": owner.getTypeIdOfProperty("ColoredElements"),
|
|
"propertyStatus": [str(item) for item in owner.getPropertyStatus("ColoredElements")],
|
|
"editorMode": [str(item) for item in owner.getEditorMode("ColoredElements")],
|
|
"ownerState": [str(item) for item in owner.State],
|
|
"statusString": str(owner.getStatusString()),
|
|
"ownerOutList": [candidate.Name for candidate in owner.OutList],
|
|
"targetInLists": {target.Name: [candidate.Name for candidate in target.InList] for target in targets},
|
|
"targetShapeHashes": {target.Name: shape_hash(target) for target in targets},
|
|
"objectSet": object_set(document),
|
|
}
|
|
|
|
|
|
def exception_snapshot(callback):
|
|
try:
|
|
callback()
|
|
except Exception as error:
|
|
return {"type": type(error).__name__, "message": str(error)}
|
|
return None
|
|
|
|
|
|
def active_transaction_snapshot():
|
|
active = App.getActiveTransaction()
|
|
return {"name": str(active[0]), "id": int(active[1])} if active else {"name": "", "id": 0}
|
|
|
|
|
|
def run_case():
|
|
document = App.newDocument("PropertyLinkSubHiddenFailure")
|
|
external = App.newDocument("PropertyLinkSubHiddenExternal")
|
|
try:
|
|
owner = document.addObject("App::LinkGroup", "LinkGroupProbe")
|
|
first = document.addObject("Part::Feature", "ColorSourceA")
|
|
first.Shape = Part.makeBox(2.0, 3.0, 4.0)
|
|
second = document.addObject("Part::Feature", "ColorSourceB")
|
|
second.Shape = Part.makeCylinder(1.5, 5.0)
|
|
other = external.addObject("Part::Feature", "ExternalSource")
|
|
other.Shape = Part.makeBox(1.0, 1.0, 1.0)
|
|
targets = [first, second]
|
|
|
|
owner.ColoredElements = (first, ["Face1", "Face3"])
|
|
document.recompute()
|
|
document.UndoMode = 1
|
|
initial = snapshot(document, owner, targets)
|
|
|
|
failures = []
|
|
for name, candidate in [("scalar", "ColorSourceA"), ("wrongSubList", (first, "Face1")), ("unknownTuple", (first, ["MissingFace"]))]:
|
|
before = snapshot(document, owner, targets)
|
|
exception = exception_snapshot(lambda value=candidate: setattr(owner, "ColoredElements", value))
|
|
after = snapshot(document, owner, targets)
|
|
failures.append({
|
|
"name": name,
|
|
"requested": repr(candidate),
|
|
"accepted": exception is None,
|
|
"error": exception,
|
|
"before": before,
|
|
"after": after,
|
|
"valuePreserved": before["value"] == after["value"],
|
|
"documentPreserved": before == after,
|
|
})
|
|
owner.ColoredElements = (first, ["Face1", "Face3"])
|
|
document.recompute()
|
|
|
|
owner.ColoredElements = (first, ["Face1", "Face3"])
|
|
document.recompute()
|
|
before = snapshot(document, owner, targets)
|
|
exception = exception_snapshot(lambda: setattr(owner, "ColoredElements", (other, ["Face1"])))
|
|
after = snapshot(document, owner, targets)
|
|
cross_document = {
|
|
"accepted": exception is None,
|
|
"error": exception,
|
|
"before": before,
|
|
"after": after,
|
|
"valuePreserved": before["value"] == after["value"],
|
|
"documentPreserved": before == after,
|
|
}
|
|
|
|
owner.ColoredElements = (first, ["Face1", "Face3"])
|
|
document.recompute()
|
|
owner.setPropertyStatus("ColoredElements", "ReadOnly")
|
|
read_only_before = snapshot(document, owner, targets)
|
|
read_only_exception = exception_snapshot(lambda: setattr(owner, "ColoredElements", (second, ["Face2"])))
|
|
read_only_after = snapshot(document, owner, targets)
|
|
read_only = {
|
|
"accepted": read_only_exception is None,
|
|
"error": read_only_exception,
|
|
"before": read_only_before,
|
|
"after": read_only_after,
|
|
"status": [str(item) for item in owner.getPropertyStatus("ColoredElements")],
|
|
"pythonBypassesEditorReadOnly": read_only_exception is None,
|
|
}
|
|
owner.setPropertyStatus("ColoredElements", "-ReadOnly")
|
|
|
|
owner.ColoredElements = (first, ["Face1", "Face3"])
|
|
document.recompute()
|
|
owner.setPropertyStatus("ColoredElements", "Immutable")
|
|
immutable_before = snapshot(document, owner, targets)
|
|
immutable_exception = exception_snapshot(lambda: setattr(owner, "ColoredElements", (first, ["Face4"])))
|
|
immutable_after = snapshot(document, owner, targets)
|
|
immutable = {
|
|
"accepted": immutable_exception is None,
|
|
"error": immutable_exception,
|
|
"before": immutable_before,
|
|
"after": immutable_after,
|
|
"status": [str(item) for item in owner.getPropertyStatus("ColoredElements")],
|
|
"pythonBypassesImmutable": immutable_exception is None,
|
|
}
|
|
owner.setPropertyStatus("ColoredElements", "-Immutable")
|
|
|
|
owner.ColoredElements = (first, ["Face1", "Face3"])
|
|
document.recompute()
|
|
document.openTransaction("property-linksubhidden-cancel")
|
|
transaction_before = snapshot(document, owner, targets)
|
|
owner.ColoredElements = (second, ["Face5"])
|
|
transaction_edited = snapshot(document, owner, targets)
|
|
pending_after_edit = bool(document.HasPendingTransaction)
|
|
active_after_edit = active_transaction_snapshot()
|
|
document.abortTransaction()
|
|
transaction_after_abort_before_recompute = snapshot(document, owner, targets)
|
|
recompute_after_abort = bool(document.recompute())
|
|
transaction_after = snapshot(document, owner, targets)
|
|
|
|
return {
|
|
"objectTypeId": "App::LinkGroup",
|
|
"objectName": "LinkGroupProbe",
|
|
"propertyName": "ColoredElements",
|
|
"propertyTypeId": owner.getTypeIdOfProperty("ColoredElements"),
|
|
"baseline": initial["value"],
|
|
"initial": initial,
|
|
"failures": failures,
|
|
"crossDocument": cross_document,
|
|
"readOnly": read_only,
|
|
"immutable": immutable,
|
|
"transaction": {
|
|
"before": transaction_before,
|
|
"edited": transaction_edited,
|
|
"afterAbortBeforeRecompute": transaction_after_abort_before_recompute,
|
|
"afterAbort": transaction_after,
|
|
"recomputeAfterAbort": recompute_after_abort,
|
|
"undoMode": int(document.UndoMode),
|
|
"pendingAfterEdit": pending_after_edit,
|
|
"pendingAfterAbort": bool(document.HasPendingTransaction),
|
|
"activeAfterEdit": active_after_edit,
|
|
"activeAfterAbort": active_transaction_snapshot(),
|
|
"restored": transaction_before == transaction_after,
|
|
},
|
|
"documentIntegrity": {
|
|
"initialObjects": initial["objectSet"],
|
|
"finalObjects": object_set(document),
|
|
"objectsPreserved": initial["objectSet"] == object_set(document),
|
|
"foreignDocumentObjects": object_set(external),
|
|
},
|
|
}
|
|
finally:
|
|
App.closeDocument(external.Name)
|
|
App.closeDocument(document.Name)
|
|
|
|
|
|
case = run_case()
|
|
report = {
|
|
"schemaVersion": 1,
|
|
"status": "pass",
|
|
"baselineId": "freecad-1.1.1-property-linksubhidden-failure",
|
|
"freecadVersion": ".".join(str(value) for value in App.Version()[:3]),
|
|
"gitCommit": FREECAD_COMMIT,
|
|
"propertyType": "App::PropertyLinkSubHidden",
|
|
"caseCount": 1,
|
|
"case": case,
|
|
"disabled": {
|
|
"classification": "editor-read-only-python-mutable-until-immutable",
|
|
"readOnlySetter": "accepted",
|
|
"immutableSetter": "rejected",
|
|
"readOnly": case["readOnly"],
|
|
"immutable": case["immutable"],
|
|
},
|
|
"cancellationBoundary": {
|
|
"supported": False,
|
|
"classification": "synchronous-property-setter",
|
|
"reason": "no-native-cancel-hook",
|
|
"replacement": "abort-active-document-transaction",
|
|
},
|
|
}
|
|
if not OUTPUT_PATH:
|
|
raise RuntimeError("FREECAD_PROPERTY_LINKSUBHIDDEN_FAILURE_OUTPUT is required")
|
|
with open(OUTPUT_PATH, "w", encoding="utf-8") as handle:
|
|
json.dump(report, handle, indent=2, sort_keys=True)
|
|
handle.write("\n")
|
|
print("FREECAD_PROPERTY_LINKSUBHIDDEN_FAILURE_RESULT=" + json.dumps({"status": report["status"], "caseCount": report["caseCount"]}, sort_keys=True))
|