# *************************************************************************** # * Copyright (c) 2003 Juergen Riegel * # * * # * This file is part of the FreeCAD CAx development system. * # * * # * This program is free software; you can redistribute it and/or modify * # * it under the terms of the GNU Lesser General Public License (LGPL) * # * as published by the Free Software Foundation; either version 2 of * # * the License, or (at your option) any later version. * # * for detail see the LICENCE text file. * # * * # * FreeCAD is distributed in the hope that it will be useful, * # * but WITHOUT ANY WARRANTY; without even the implied warranty of * # * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * # * GNU Library General Public License for more details. * # * * # * You should have received a copy of the GNU Library General Public * # * License along with FreeCAD; if not, write to the Free Software * # * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * # * USA * # * * # ***************************************************************************/ import FreeCAD, os, unittest, tempfile from FreeCAD import Base import math import xml.etree.ElementTree as ET # --------------------------------------------------------------------------- # define the functions to test the FreeCAD Document code # --------------------------------------------------------------------------- class Proxy: def __init__(self, obj): self.Dictionary = {} self.obj = obj obj.Proxy = self def dumps(self): return self.Dictionary def loads(self, data): self.Dictionary = data class MyFeature: def __init__(self, obj): obj.Proxy = self obj.addProperty("App::PropertyLinkList", "propLink") def onDocumentRestored(self, obj): if hasattr(obj, "propLink"): obj.removeProperty("propLink") class DocumentBasicCases(unittest.TestCase): def setUp(self): self.Doc = FreeCAD.newDocument("CreateTest") def saveAndRestore(self): # saving and restoring SaveName = tempfile.gettempdir() + os.sep + "CreateTest.FCStd" self.Doc.saveAs(SaveName) FreeCAD.closeDocument("CreateTest") self.Doc = FreeCAD.open(SaveName) return self.Doc def testIssue18601(self): lnk = self.Doc.addObject("App::FeaturePython", "MyLink") obj = self.Doc.addObject("App::FeaturePython", "MyFeature") fea = MyFeature(obj) obj.propLink = [lnk] doc = self.saveAndRestore() FreeCAD.closeDocument(doc.Name) self.Doc = FreeCAD.newDocument("CreateTest") def testAccessByNameOrID(self): obj = self.Doc.addObject("App::DocumentObject", "MyName") with self.assertRaises(TypeError): self.Doc.getObject([1]) self.assertEqual(self.Doc.getObject(obj.Name), obj) self.assertEqual(self.Doc.getObject("Unknown"), None) self.assertEqual(self.Doc.getObject(obj.ID), obj) self.assertEqual(self.Doc.getObject(obj.ID + 1), None) def testCreateDestroy(self): # FIXME: Causes somehow a ref count error but it's _not_ FreeCAD.getDocument()!!! # If we remove the whole method no error appears. self.assertTrue(FreeCAD.getDocument("CreateTest") is not None, "Creating Document failed") def testAddition(self): # Cannot write a real test case for that but when debugging the # C-code there shouldn't be a memory leak (see rev. 1814) self.Doc.openTransaction("Add") L1 = self.Doc.addObject("App::FeatureTest", "Label") self.Doc.commitTransaction() self.Doc.undo() def testAddRemoveUndo(self): # Bug #0000525 self.Doc.openTransaction("Add") obj = self.Doc.addObject("App::FeatureTest", "Label") self.Doc.commitTransaction() self.Doc.removeObject(obj.Name) self.Doc.undo() self.Doc.undo() def testNoRecompute(self): L1 = self.Doc.addObject("App::FeatureTest", "Label") self.Doc.recompute() L1.TypeNoRecompute = 2 execcount = L1.ExecCount objectcount = self.Doc.recompute() self.assertEqual(objectcount, 0) self.assertEqual(L1.ExecCount, execcount) def testNoRecomputeParent(self): L1 = self.Doc.addObject("App::FeatureTest", "Child") L2 = self.Doc.addObject("App::FeatureTest", "Parent") L2.Source1 = L1 self.Doc.recompute() L1.TypeNoRecompute = 2 countChild = L1.ExecCount countParent = L2.ExecCount objectcount = self.Doc.recompute() self.assertEqual(objectcount, 1) self.assertEqual(L1.ExecCount, countChild) self.assertEqual(L2.ExecCount, countParent + 1) L1.touch("") countChild = L1.ExecCount countParent = L2.ExecCount objectcount = self.Doc.recompute() self.assertEqual(objectcount, 1) self.assertEqual(L1.ExecCount, countChild) self.assertEqual(L2.ExecCount, countParent + 1) L1.enforceRecompute() countChild = L1.ExecCount countParent = L2.ExecCount objectcount = self.Doc.recompute() self.assertEqual(objectcount, 2) self.assertEqual(L1.ExecCount, countChild + 1) self.assertEqual(L2.ExecCount, countParent + 1) def testAbortTransaction(self): self.Doc.openTransaction("Add") obj = self.Doc.addObject("App::FeatureTest", "Label") self.Doc.abortTransaction() TempPath = tempfile.gettempdir() SaveName = TempPath + os.sep + "SaveRestoreTests.FCStd" self.Doc.saveAs(SaveName) def testRemoval(self): # Cannot write a real test case for that but when debugging the # C-code there shouldn't be a memory leak (see rev. 1814) self.Doc.openTransaction("Add") L1 = self.Doc.addObject("App::FeatureTest", "Label") self.Doc.commitTransaction() self.Doc.openTransaction("Rem") L1 = self.Doc.removeObject("Label") self.Doc.commitTransaction() def testObjects(self): L1 = self.Doc.addObject("App::FeatureTest", "Label_1") # call members to check for errors in ref counting self.Doc.ActiveObject self.Doc.Objects self.Doc.UndoMode self.Doc.UndoRedoMemSize self.Doc.UndoCount # test read only mechanismus try: self.Doc.UndoCount = 3 except Exception: FreeCAD.Console.PrintLog(" exception thrown, OK\n") else: self.fail("no exception thrown") self.Doc.RedoCount self.Doc.UndoNames self.Doc.RedoNames self.Doc.recompute() self.assertTrue(L1.Integer == 4711) self.assertTrue(L1.Float - 47.11 < 0.001) self.assertTrue(L1.Bool == True) self.assertTrue(L1.String == "4711") # temporarily not checked because of strange behavior of boost::filesystem JR # self.assertTrue(L1.Path == "c:/temp") self.assertTrue(float(L1.Angle) - 3.0 < 0.001) self.assertTrue(float(L1.Distance) - 47.11 < 0.001) # test basic property stuff self.assertTrue(not L1.getDocumentationOfProperty("Source1") == "") self.assertTrue(L1.getGroupOfProperty("Source1") == "Feature Test") self.assertTrue(L1.getTypeOfProperty("Source1") == []) self.assertTrue(L1.getEnumerationsOfProperty("Source1") is None) # test the constraint types ( both are constraint to percent range) self.assertTrue(L1.ConstraintInt == 5) self.assertTrue(L1.ConstraintFloat - 5.0 < 0.001) L1.ConstraintInt = 500 L1.ConstraintFloat = 500.0 self.assertTrue(L1.ConstraintInt == 100) self.assertTrue(L1.ConstraintFloat - 100.0 < 0.001) L1.ConstraintInt = -500 L1.ConstraintFloat = -500.0 self.assertTrue(L1.ConstraintInt == 0) self.assertTrue(L1.ConstraintFloat - 0.0 < 0.001) # test enum property # in App::FeatureTest the current value is set to 4 self.assertTrue(L1.Enum == "Four") L1.Enum = "Three" self.assertTrue(L1.Enum == "Three", "Different value to 'Three'") L1.Enum = 2 self.assertTrue(L1.Enum == "Two", "Different value to 'Two'") try: L1.Enum = "SurelyNotInThere!" except Exception: FreeCAD.Console.PrintLog(" exception thrown, OK\n") else: self.fail("no exception thrown") self.assertTrue( sorted(L1.getEnumerationsOfProperty("Enum")) == sorted(["Zero", "One", "Two", "Three", "Four"]) ) # self.assertTrue(L1.IntegerList == [4711] ) # f = L1.FloatList # self.assertTrue(f -47.11<0.001 ) # self.assertTrue(L1.Matrix == [1.0,2.0,3.0,4.0,5.0,6.0,7.0,8.0,9.0,10.0,11.0,12.0,13.0,14.0,15.0,16.0] ) # self.assertTrue(L1.Vector == [1.0,2.0,3.0]) self.assertTrue(L1.Label == "Label_1", "Invalid object name") L1.Label = "Label_2" self.Doc.recompute() self.assertTrue(L1.Label == "Label_2", "Invalid object name") self.Doc.removeObject("Label_1") def testEnum(self): enumeration_choices = ["one", "two"] obj = self.Doc.addObject("App::FeaturePython", "Label_2") obj.addProperty("App::PropertyEnumeration", "myEnumeration", "Enum", "mytest") with self.assertRaises(ValueError): obj.myEnumeration = enumeration_choices[0] obj.myEnumeration = enumeration_choices obj.myEnumeration = 0 self.Doc.openTransaction("Modify enum") obj.myEnumeration = 1 self.assertTrue(obj.myEnumeration, enumeration_choices[1]) self.Doc.commitTransaction() self.Doc.undo() self.assertTrue(obj.myEnumeration, enumeration_choices[0]) def testWrongTypes(self): with self.assertRaises(TypeError): self.Doc.addObject("App::DocumentObjectExtension") class Feature: pass with self.assertRaises(TypeError): self.Doc.addObject(type="App::DocumentObjectExtension", objProxy=Feature(), attach=True) ext = FreeCAD.Base.TypeId.fromName("App::DocumentObjectExtension") self.assertEqual(ext.createInstance(), None) obj = self.Doc.addObject("App::FeaturePython", "Object") with self.assertRaises(TypeError): obj.addProperty("App::DocumentObjectExtension", "Property") with self.assertRaises(TypeError): self.Doc.findObjects(Type="App::DocumentObjectExtension") e = FreeCAD.Base.TypeId.fromName("App::LinkExtensionPython") self.assertIsNone(e.createInstance()) if FreeCAD.GuiUp: obj = self.Doc.addObject("App::DocumentObject", viewType="App::Extension") self.assertIsNone(obj.ViewObject) def testMem(self): self.Doc.MemSize def testDuplicateLinks(self): obj = self.Doc.addObject("App::FeatureTest", "obj") grp = self.Doc.addObject("App::DocumentObjectGroup", "group") grp.Group = [obj, obj] self.Doc.removeObject(obj.Name) self.assertListEqual(grp.Group, []) def testPlacementList(self): obj = self.Doc.addObject("App::FeaturePython", "Label") obj.addProperty("App::PropertyPlacementList", "PlmList") plm = FreeCAD.Placement() plm.Base = (1, 2, 3) plm.Rotation = (0, 0, 1, 0) obj.PlmList = [plm] cpy = self.Doc.copyObject(obj) self.assertListEqual(obj.PlmList, cpy.PlmList) def testRawAxis(self): obj = self.Doc.addObject("App::FeaturePython", "Label") obj.addProperty("App::PropertyPlacement", "Plm") obj.addProperty("App::PropertyRotation", "Rot") obj.Plm.Rotation.Axis = (1, 2, 3) obj.Rot.Axis = (3, 2, 1) # saving and restoring SaveName = tempfile.gettempdir() + os.sep + "CreateTest.FCStd" self.Doc.saveAs(SaveName) FreeCAD.closeDocument("CreateTest") self.Doc = FreeCAD.open(SaveName) obj = self.Doc.ActiveObject self.assertEqual(obj.Plm.Rotation.RawAxis.x, 1) self.assertEqual(obj.Plm.Rotation.RawAxis.y, 2) self.assertEqual(obj.Plm.Rotation.RawAxis.z, 3) self.assertEqual(obj.Rot.RawAxis.x, 3) self.assertEqual(obj.Rot.RawAxis.y, 2) self.assertEqual(obj.Rot.RawAxis.z, 1) def testAddRemove(self): L1 = self.Doc.addObject("App::FeatureTest", "Label_1") # must delete object self.Doc.removeObject(L1.Name) try: L1.Name except Exception: self.assertTrue(True) else: self.assertTrue(False) del L1 # What do we expect here? self.Doc.openTransaction("AddRemove") L2 = self.Doc.addObject("App::FeatureTest", "Label_2") self.Doc.removeObject(L2.Name) self.Doc.commitTransaction() self.Doc.undo() try: L2.Name except Exception: self.assertTrue(True) else: self.assertTrue(False) del L2 def testSubObject(self): obj = self.Doc.addObject("App::Origin", "Origin") self.Doc.recompute() res = obj.getSubObject("X_Axis", retType=2) self.assertEqual( res[1].multVec(FreeCAD.Vector(1, 0, 0)).getAngle(FreeCAD.Vector(1, 0, 0)), 0.0 ) res = obj.getSubObject("Y_Axis", retType=2) self.assertEqual( res[1].multVec(FreeCAD.Vector(1, 0, 0)).getAngle(FreeCAD.Vector(0, 1, 0)), 0.0 ) res = obj.getSubObject("Z_Axis", retType=2) self.assertEqual( res[1].multVec(FreeCAD.Vector(1, 0, 0)).getAngle(FreeCAD.Vector(0, 0, 1)), 0.0 ) res = obj.getSubObject("XY_Plane", retType=2) self.assertEqual( res[1].multVec(FreeCAD.Vector(0, 0, 1)).getAngle(FreeCAD.Vector(0, 0, 1)), 0.0 ) res = obj.getSubObject("XZ_Plane", retType=2) self.assertEqual( res[1].multVec(FreeCAD.Vector(0, 0, 1)).getAngle(FreeCAD.Vector(0, -1, 0)), 0.0 ) res = obj.getSubObject("YZ_Plane", retType=2) self.assertEqual( res[1].multVec(FreeCAD.Vector(0, 0, 1)).getAngle(FreeCAD.Vector(1, 0, 0)), 0.0 ) res = obj.getSubObject("YZ_Plane", retType=3) self.assertEqual( res.multVec(FreeCAD.Vector(0, 0, 1)).getAngle(FreeCAD.Vector(1, 0, 0)), 0.0 ) res = obj.getSubObject("YZ_Plane", retType=4) self.assertEqual( res.multVec(FreeCAD.Vector(0, 0, 1)).getAngle(FreeCAD.Vector(1, 0, 0)), 0.0 ) self.assertEqual( obj.getSubObject(("XY_Plane", "YZ_Plane"), retType=4)[0], obj.getSubObject("XY_Plane", retType=4), ) self.assertEqual( obj.getSubObject(("XY_Plane", "YZ_Plane"), retType=4)[1], obj.getSubObject("YZ_Plane", retType=4), ) # Create a second origin object obj2 = self.Doc.addObject("App::Origin", "Origin2") self.Doc.recompute() # Use the names of the origin's out-list for i in obj2.OutList: self.assertEqual(obj2.getSubObject(i.Name, retType=1).Name, i.Name) # Add a '.' to the names for i in obj2.OutList: self.assertEqual(obj2.getSubObject(i.Name + ".", retType=1).Name, i.Name) def testExtensions(self): # we try to create a normal python object and add an extension to it obj = self.Doc.addObject("App::DocumentObject", "Extension_1") grp = self.Doc.addObject("App::DocumentObject", "Extension_2") # we should have all methods we need to handle extensions try: self.assertTrue(not grp.hasExtension("App::GroupExtensionPython")) grp.addExtension("App::GroupExtensionPython") self.assertTrue(grp.hasExtension("App::GroupExtension")) self.assertTrue(grp.hasExtension("App::GroupExtensionPython")) grp.addObject(obj) self.assertTrue(len(grp.Group) == 1) self.assertTrue(grp.Group[0] == obj) except Exception: self.assertTrue(False) # test if the method override works class SpecialGroup: def allowObject(self, obj): return False callback = SpecialGroup() grp2 = self.Doc.addObject("App::FeaturePython", "Extension_3") grp2.addExtension("App::GroupExtensionPython") grp2.Proxy = callback try: self.assertTrue(grp2.hasExtension("App::GroupExtension")) grp2.addObject(obj) self.assertTrue(len(grp2.Group) == 0) except Exception: self.assertTrue(True) self.Doc.removeObject(grp.Name) self.Doc.removeObject(grp2.Name) self.Doc.removeObject(obj.Name) del obj del grp del grp2 def testExtensionBug0002785(self): class MyExtension: def __init__(self, obj): obj.addExtension("App::GroupExtensionPython") obj = self.Doc.addObject("App::DocumentObject", "myObj") MyExtension(obj) self.assertTrue(obj.hasExtension("App::GroupExtension")) self.assertTrue(obj.hasExtension("App::GroupExtensionPython")) self.Doc.removeObject(obj.Name) del obj def testExtensionGroup(self): obj = self.Doc.addObject("App::DocumentObject", "Obj") grp = self.Doc.addObject("App::FeaturePython", "Extension_2") grp.addExtension("App::GroupExtensionPython") grp.Group = [obj] self.assertTrue(obj in grp.Group) def testExtensionBugViewProvider(self): class Layer: def __init__(self, obj): obj.addExtension("App::GroupExtensionPython") class LayerViewProvider: def __init__(self, obj): obj.addExtension("Gui::ViewProviderGroupExtensionPython") obj.Proxy = self obj = self.Doc.addObject("App::FeaturePython", "Layer") Layer(obj) self.assertTrue(obj.hasExtension("App::GroupExtension")) if FreeCAD.GuiUp: LayerViewProvider(obj.ViewObject) self.assertTrue(obj.ViewObject.hasExtension("Gui::ViewProviderGroupExtension")) self.assertTrue(obj.ViewObject.hasExtension("Gui::ViewProviderGroupExtensionPython")) self.Doc.removeObject(obj.Name) del obj def testHasSelection(self): if FreeCAD.GuiUp: import FreeCADGui self.assertFalse(FreeCADGui.Selection.hasSelection("", 1)) def testPropertyLink_Issue2902Part1(self): o1 = self.Doc.addObject("App::FeatureTest", "test1") o2 = self.Doc.addObject("App::FeatureTest", "test2") o3 = self.Doc.addObject("App::FeatureTest", "test3") o1.Link = o2 self.assertEqual(o1.Link, o2) o1.Link = o3 self.assertEqual(o1.Link, o3) o2.Placement = FreeCAD.Placement() self.assertEqual(o1.Link, o3) def testProp_NonePropertyLink(self): obj1 = self.Doc.addObject("App::FeaturePython", "Obj1") obj2 = self.Doc.addObject("App::FeaturePython", "Obj2") obj1.addProperty( "App::PropertyLink", "Link", "Base", "Link to another feature", FreeCAD.PropertyType.Prop_None, False, False, ) obj1.Link = obj2 self.assertEqual(obj1.MustExecute, True) def testProp_OutputPropertyLink(self): obj1 = self.Doc.addObject("App::FeaturePython", "Obj1") obj2 = self.Doc.addObject("App::FeaturePython", "Obj2") obj1.addProperty( "App::PropertyLink", "Link", "Base", "Link to another feature", FreeCAD.PropertyType.Prop_Output, False, False, ) obj1.Link = obj2 self.assertEqual(obj1.MustExecute, False) def testAttributeOfDynamicProperty(self): obj = self.Doc.addObject("App::FeaturePython", "Obj") # Prop_NoPersist is the enum with the highest value max_value = FreeCAD.PropertyType.Prop_NoPersist list_of_types = [] for i in range(0, max_value + 1): obj.addProperty("App::PropertyString", "String" + str(i), "", "", i) list_of_types.append(obj.getTypeOfProperty("String" + str(i))) # saving and restoring SaveName = tempfile.gettempdir() + os.sep + "CreateTest.FCStd" self.Doc.saveAs(SaveName) FreeCAD.closeDocument("CreateTest") self.Doc = FreeCAD.open(SaveName) obj = self.Doc.ActiveObject for i in range(0, max_value): types = obj.getTypeOfProperty("String" + str(i)) self.assertEqual(list_of_types[i], types) # A property with flag Prop_NoPersist won't be saved to the file with self.assertRaises(AttributeError): obj.getTypeOfProperty("String" + str(max_value)) def testNotification_Issue2902Part2(self): o = self.Doc.addObject("App::FeatureTest", "test") plm = o.Placement o.Placement = FreeCAD.Placement() plm.Base.x = 5 self.assertEqual(o.Placement.Base.x, 0) o.Placement.Base.x = 5 self.assertEqual(o.Placement.Base.x, 5) def testNotification_Issue2996(self): if not FreeCAD.GuiUp: return # works only if Gui is shown class ViewProvider: def __init__(self, vobj): vobj.Proxy = self def attach(self, vobj): self.ViewObject = vobj self.Object = vobj.Object def claimChildren(self): children = [self.Object.Link] return children obj = self.Doc.addObject("App::FeaturePython", "Sketch") obj.addProperty("App::PropertyLink", "Link") ViewProvider(obj.ViewObject) ext = self.Doc.addObject("App::FeatureTest", "Extrude") ext.Link = obj sli = self.Doc.addObject("App::FeaturePython", "Slice") sli.addProperty("App::PropertyLink", "Link").Link = ext ViewProvider(sli.ViewObject) com = self.Doc.addObject("App::FeaturePython", "CompoundFilter") com.addProperty("App::PropertyLink", "Link").Link = sli ViewProvider(com.ViewObject) ext.Label = "test" self.assertEqual(ext.Link, obj) self.assertNotEqual(ext.Link, sli) def testIssue4823(self): # https://forum.freecad.org/viewtopic.php?f=3&t=52775 # The issue was only visible in GUI mode and it crashed in the tree view obj = self.Doc.addObject("App::Origin") self.Doc.removeObject(obj.Name) def testSamePropertyOfLinkAndLinkedObject(self): # See also https://github.com/FreeCAD/FreeCAD/pull/6787 test = self.Doc.addObject("App::FeaturePython", "Python") link = self.Doc.addObject("App::Link", "Link") test.addProperty("App::PropertyFloat", "Test") link.addProperty("App::PropertyFloat", "Test") link.LinkedObject = test # saving and restoring SaveName = tempfile.gettempdir() + os.sep + "CreateTest.FCStd" self.Doc.saveAs(SaveName) FreeCAD.closeDocument("CreateTest") self.Doc = FreeCAD.open(SaveName) self.assertIn("Test", self.Doc.Python.PropertiesList) self.assertIn("Test", self.Doc.Link.PropertiesList) def testNoProxy(self): test = self.Doc.addObject("App::DocumentObject", "Object") test.addProperty("App::PropertyPythonObject", "Dictionary") test.Dictionary = {"Stored data": [3, 5, 7]} doc = self.saveAndRestore() obj = doc.Object self.assertEqual(obj.Dictionary, {"Stored data": [3, 5, 7]}) def testWithProxy(self): test = self.Doc.addObject("App::FeaturePython", "Python") proxy = Proxy(test) proxy.Dictionary["Stored data"] = [3, 5, 7] doc = self.saveAndRestore() obj = doc.Python.Proxy self.assertEqual(obj.Dictionary, {"Stored data": [3, 5, 7]}) def testContent(self): test = self.Doc.addObject("App::FeaturePython", "Python") types = Base.TypeId.getAllDerivedFrom("App::Property") for type in types: try: test.addProperty(type.Name, type.Name.replace(":", "_")) print("Add property type: {}".format(type.Name)) except Exception as e: pass root = ET.fromstring(test.Content) self.assertEqual(root.tag, "Properties") def tearDown(self): # closing doc FreeCAD.closeDocument("CreateTest") # class must be defined in global scope to allow it to be reloaded on document open class SaveRestoreSpecialGroup: def __init__(self, obj): obj.addExtension("App::GroupExtensionPython") obj.Proxy = self def allowObject(self, obj): return False # class must be defined in global scope to allow it to be reloaded on document open class SaveRestoreSpecialGroupViewProvider: def __init__(self, obj): obj.addExtension("Gui::ViewProviderGroupExtensionPython") obj.Proxy = self def testFunction(self): pass class DocumentSaveRestoreCases(unittest.TestCase): def setUp(self): self.Doc = FreeCAD.newDocument("SaveRestoreTests") L1 = self.Doc.addObject("App::FeatureTest", "Label_1") L2 = self.Doc.addObject("App::FeatureTest", "Label_2") L3 = self.Doc.addObject("App::FeatureTest", "Label_3") self.TempPath = tempfile.gettempdir() FreeCAD.Console.PrintLog(" Using temp path: " + self.TempPath + "\n") def testSaveAndRestore(self): # saving and restoring SaveName = self.TempPath + os.sep + "SaveRestoreTests.FCStd" self.assertTrue(self.Doc.Label_1.TypeTransient == 4711) self.Doc.Label_1.TypeTransient = 4712 # setup Linking self.Doc.Label_1.Link = self.Doc.Label_2 self.Doc.Label_2.Link = self.Doc.Label_3 self.Doc.Label_1.LinkSub = (self.Doc.Label_2, ["Sub1", "Sub2"]) self.Doc.Label_2.LinkSub = (self.Doc.Label_3, ["Sub3", "Sub4"]) # save the document self.Doc.saveAs(SaveName) FreeCAD.closeDocument("SaveRestoreTests") self.Doc = FreeCAD.open(SaveName) self.assertTrue(self.Doc.Label_1.Integer == 4711) self.assertTrue(self.Doc.Label_2.Integer == 4711) # test Linkage self.assertTrue(self.Doc.Label_1.Link == self.Doc.Label_2) self.assertTrue(self.Doc.Label_2.Link == self.Doc.Label_3) self.assertTrue(self.Doc.Label_1.LinkSub == (self.Doc.Label_2, ["Sub1", "Sub2"])) self.assertTrue(self.Doc.Label_2.LinkSub == (self.Doc.Label_3, ["Sub3", "Sub4"])) # do NOT save transient properties self.assertTrue(self.Doc.Label_1.TypeTransient == 4711) self.assertTrue(self.Doc == FreeCAD.getDocument(self.Doc.Name)) def testRestore(self): Doc = FreeCAD.newDocument("RestoreTests") Doc.addObject("App::FeatureTest", "Label_1") # saving and restoring FileName = self.TempPath + os.sep + "Test2.FCStd" Doc.saveAs(FileName) # restore must first clear the current content Doc.restore() self.assertTrue(len(Doc.Objects) == 1) FreeCAD.closeDocument("RestoreTests") def testActiveDocument(self): # open 2nd doc Second = FreeCAD.newDocument("Active") FreeCAD.closeDocument("Active") try: # There might be no active document anymore # This also checks for dangling pointers Active = FreeCAD.activeDocument() # Second is still a valid object self.assertTrue(Second != Active) except Exception: # Okay, no document open self.assertTrue(True) def testExtensionSaveRestore(self): # saving and restoring SaveName = self.TempPath + os.sep + "SaveRestoreExtensions.FCStd" Doc = FreeCAD.newDocument("SaveRestoreExtensions") # we try to create a normal python object and add an extension to it obj = Doc.addObject("App::DocumentObject", "Obj") grp1 = Doc.addObject("App::DocumentObject", "Extension_1") grp2 = Doc.addObject("App::FeaturePython", "Extension_2") grp1.addExtension("App::GroupExtensionPython") SaveRestoreSpecialGroup(grp2) if FreeCAD.GuiUp: SaveRestoreSpecialGroupViewProvider(grp2.ViewObject) grp2.Group = [obj] Doc.saveAs(SaveName) FreeCAD.closeDocument("SaveRestoreExtensions") Doc = FreeCAD.open(SaveName) self.assertTrue(Doc.Extension_1.hasExtension("App::GroupExtension")) self.assertTrue(Doc.Extension_2.hasExtension("App::GroupExtension")) self.assertTrue(Doc.Extension_2.Group[0] is Doc.Obj) self.assertTrue(hasattr(Doc.Extension_2.Proxy, "allowObject")) if FreeCAD.GuiUp: self.assertTrue( Doc.Extension_2.ViewObject.hasExtension("Gui::ViewProviderGroupExtensionPython") ) self.assertTrue(hasattr(Doc.Extension_2.ViewObject.Proxy, "testFunction")) FreeCAD.closeDocument("SaveRestoreExtensions") def testPersistenceContentDump(self): # test smallest level... property self.Doc.Label_1.Vector = (1, 2, 3) dump = self.Doc.Label_1.dumpPropertyContent("Vector", Compression=9) self.Doc.Label_2.restorePropertyContent("Vector", dump) self.assertEqual(self.Doc.Label_1.Vector, self.Doc.Label_2.Vector) # next higher: object self.Doc.Label_1.Distance = 12 self.Doc.Label_1.String = "test" dump = self.Doc.Label_1.dumpContent() self.Doc.Label_3.restoreContent(dump) self.assertEqual(self.Doc.Label_1.Distance, self.Doc.Label_3.Distance) self.assertEqual(self.Doc.Label_1.String, self.Doc.Label_3.String) # highest level: document dump = self.Doc.dumpContent(9) Doc = FreeCAD.newDocument("DumpTest") Doc.restoreContent(dump) self.assertEqual(len(self.Doc.Objects), len(Doc.Objects)) self.assertEqual(self.Doc.Label_1.Distance, Doc.Label_1.Distance) self.assertEqual(self.Doc.Label_1.String, Doc.Label_1.String) self.assertEqual(self.Doc.Label_1.Vector, Doc.Label_1.Vector) FreeCAD.closeDocument("DumpTest") def tearDown(self): # closing doc FreeCAD.closeDocument("SaveRestoreTests") class DocumentRecomputeCases(unittest.TestCase): def setUp(self): self.Doc = FreeCAD.newDocument("RecomputeTests") self.L1 = self.Doc.addObject("App::FeatureTest", "Label_1") self.L2 = self.Doc.addObject("App::FeatureTest", "Label_2") self.L3 = self.Doc.addObject("App::FeatureTest", "Label_3") def testDescent(self): # testing the up and downstream stuff FreeCAD.Console.PrintLog("def testDescent(self):Testcase not implemented\n") self.L1.Link = self.L2 self.L2.Link = self.L3 def testRecompute(self): # sequence to test recompute behaviour # L1---\ L7 # / \ \ | # L2 L3 \ L8 # / \ / \ / # L4 L5 L6 L1 = self.Doc.addObject("App::FeatureTest", "Label_1") L2 = self.Doc.addObject("App::FeatureTest", "Label_2") L3 = self.Doc.addObject("App::FeatureTest", "Label_3") L4 = self.Doc.addObject("App::FeatureTest", "Label_4") L5 = self.Doc.addObject("App::FeatureTest", "Label_5") L6 = self.Doc.addObject("App::FeatureTest", "Label_6") L7 = self.Doc.addObject("App::FeatureTest", "Label_7") L8 = self.Doc.addObject("App::FeatureTest", "Label_8") L1.LinkList = [L2, L3, L6] L2.Link = L4 L2.LinkList = [L5] L3.LinkList = [L5, L6] L7.Link = L8 # make second root self.assertTrue(L7 in self.Doc.RootObjects) self.assertTrue(L1 in self.Doc.RootObjects) self.assertTrue(len(self.Doc.Objects) == len(self.Doc.TopologicalSortedObjects)) seqDic = {} i = 0 for obj in self.Doc.TopologicalSortedObjects: seqDic[obj] = i print(obj) i += 1 self.assertTrue(seqDic[L2] > seqDic[L1]) self.assertTrue(seqDic[L3] > seqDic[L1]) self.assertTrue(seqDic[L5] > seqDic[L2]) self.assertTrue(seqDic[L5] > seqDic[L3]) self.assertTrue(seqDic[L5] > seqDic[L1]) self.assertTrue( (0, 0, 0, 0, 0, 0) == (L1.ExecCount, L2.ExecCount, L3.ExecCount, L4.ExecCount, L5.ExecCount, L6.ExecCount) ) self.assertTrue(self.Doc.recompute() == 4) self.assertTrue( (1, 1, 1, 0, 0, 0) == (L1.ExecCount, L2.ExecCount, L3.ExecCount, L4.ExecCount, L5.ExecCount, L6.ExecCount) ) L5.enforceRecompute() self.assertTrue( (1, 1, 1, 0, 0, 0) == (L1.ExecCount, L2.ExecCount, L3.ExecCount, L4.ExecCount, L5.ExecCount, L6.ExecCount) ) self.assertTrue(self.Doc.recompute() == 4) self.assertTrue( (2, 2, 2, 0, 1, 0) == (L1.ExecCount, L2.ExecCount, L3.ExecCount, L4.ExecCount, L5.ExecCount, L6.ExecCount) ) L4.enforceRecompute() self.assertTrue(self.Doc.recompute() == 3) self.assertTrue( (3, 3, 2, 1, 1, 0) == (L1.ExecCount, L2.ExecCount, L3.ExecCount, L4.ExecCount, L5.ExecCount, L6.ExecCount) ) L5.enforceRecompute() self.assertTrue(self.Doc.recompute() == 4) self.assertTrue( (4, 4, 3, 1, 2, 0) == (L1.ExecCount, L2.ExecCount, L3.ExecCount, L4.ExecCount, L5.ExecCount, L6.ExecCount) ) L6.enforceRecompute() self.assertTrue(self.Doc.recompute() == 3) self.assertTrue( (5, 4, 4, 1, 2, 1) == (L1.ExecCount, L2.ExecCount, L3.ExecCount, L4.ExecCount, L5.ExecCount, L6.ExecCount) ) L2.enforceRecompute() self.assertTrue(self.Doc.recompute() == 2) self.assertTrue( (6, 5, 4, 1, 2, 1) == (L1.ExecCount, L2.ExecCount, L3.ExecCount, L4.ExecCount, L5.ExecCount, L6.ExecCount) ) L1.enforceRecompute() self.assertTrue(self.Doc.recompute() == 1) self.assertTrue( (7, 5, 4, 1, 2, 1) == (L1.ExecCount, L2.ExecCount, L3.ExecCount, L4.ExecCount, L5.ExecCount, L6.ExecCount) ) self.Doc.removeObject(L1.Name) self.Doc.removeObject(L2.Name) self.Doc.removeObject(L3.Name) self.Doc.removeObject(L4.Name) self.Doc.removeObject(L5.Name) self.Doc.removeObject(L6.Name) self.Doc.removeObject(L7.Name) self.Doc.removeObject(L8.Name) def tearDown(self): # closing doc FreeCAD.closeDocument("RecomputeTests") class UndoRedoCases(unittest.TestCase): def setUp(self): self.Doc = FreeCAD.newDocument("UndoTest") self.Doc.UndoMode = 0 self.Doc.addObject("App::FeatureTest", "Base") self.Doc.addObject("App::FeatureTest", "Del") self.Doc.getObject("Del").Integer = 2 def testUndoProperties(self): # switch on the Undo self.Doc.UndoMode = 1 # first transaction self.Doc.openTransaction("Transaction1") self.Doc.addObject("App::FeatureTest", "test1") self.Doc.getObject("test1").Integer = 1 self.Doc.getObject("test1").String = "test1" self.Doc.getObject("test1").Float = 1.0 self.Doc.getObject("test1").Bool = 1 # self.Doc.getObject("test1").IntegerList = 1 # self.Doc.getObject("test1").FloatList = 1.0 # self.Doc.getObject("test1").Matrix = (1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0) # self.Doc.getObject("test1").Vector = (1.0,1.0,1.0) # second transaction self.Doc.openTransaction("Transaction2") self.Doc.getObject("test1").Integer = 2 self.Doc.getObject("test1").String = "test2" self.Doc.getObject("test1").Float = 2.0 self.Doc.getObject("test1").Bool = 0 # switch on the Undo OFF self.Doc.UndoMode = 0 def testUndoClear(self): # switch on the Undo self.Doc.UndoMode = 1 self.assertEqual(self.Doc.UndoNames, []) self.assertEqual(self.Doc.UndoCount, 0) self.assertEqual(self.Doc.RedoNames, []) self.assertEqual(self.Doc.RedoCount, 0) self.Doc.openTransaction("Transaction1") # becomes the active object self.Doc.addObject("App::FeatureTest", "test1") self.Doc.commitTransaction() # removes the active object self.Doc.undo() self.assertEqual(self.Doc.ActiveObject, None) # deletes the active object self.Doc.clearUndos() self.assertEqual(self.Doc.ActiveObject, None) def testUndo(self): # switch on the Undo self.Doc.UndoMode = 1 self.assertEqual(self.Doc.UndoNames, []) self.assertEqual(self.Doc.UndoCount, 0) self.assertEqual(self.Doc.RedoNames, []) self.assertEqual(self.Doc.RedoCount, 0) # first transaction self.Doc.openTransaction("Transaction1") self.Doc.addObject("App::FeatureTest", "test1") self.Doc.getObject("test1").Integer = 1 self.Doc.getObject("Del").Integer = 1 self.Doc.removeObject("Del") self.assertEqual(self.Doc.UndoNames, ["Transaction1"]) self.assertEqual(self.Doc.UndoCount, 1) self.assertEqual(self.Doc.RedoNames, []) self.assertEqual(self.Doc.RedoCount, 0) # second transaction self.Doc.openTransaction("Transaction2") # new behavior: no change, no transaction self.assertEqual(self.Doc.UndoNames, ["Transaction1"]) self.assertEqual(self.Doc.UndoCount, 1) self.assertEqual(self.Doc.RedoNames, []) self.assertEqual(self.Doc.RedoCount, 0) self.Doc.getObject("test1").Integer = 2 self.assertEqual(self.Doc.UndoNames, ["Transaction2", "Transaction1"]) self.assertEqual(self.Doc.UndoCount, 2) self.assertEqual(self.Doc.RedoNames, []) self.assertEqual(self.Doc.RedoCount, 0) # abort second transaction self.Doc.abortTransaction() self.assertEqual(self.Doc.UndoNames, ["Transaction1"]) self.assertEqual(self.Doc.UndoCount, 1) self.assertEqual(self.Doc.RedoNames, []) self.assertEqual(self.Doc.RedoCount, 0) self.assertEqual(self.Doc.getObject("test1").Integer, 1) # again second transaction self.Doc.openTransaction("Transaction2") self.Doc.getObject("test1").Integer = 2 self.assertEqual(self.Doc.UndoNames, ["Transaction2", "Transaction1"]) self.assertEqual(self.Doc.UndoCount, 2) self.assertEqual(self.Doc.RedoNames, []) self.assertEqual(self.Doc.RedoCount, 0) # third transaction self.Doc.openTransaction("Transaction3") self.Doc.getObject("test1").Integer = 3 self.assertEqual(self.Doc.UndoNames, ["Transaction3", "Transaction2", "Transaction1"]) self.assertEqual(self.Doc.UndoCount, 3) self.assertEqual(self.Doc.RedoNames, []) self.assertEqual(self.Doc.RedoCount, 0) # fourth transaction self.Doc.openTransaction("Transaction4") self.Doc.getObject("test1").Integer = 4 self.assertEqual( self.Doc.UndoNames, ["Transaction4", "Transaction3", "Transaction2", "Transaction1"] ) self.assertEqual(self.Doc.UndoCount, 4) self.assertEqual(self.Doc.RedoNames, []) self.assertEqual(self.Doc.RedoCount, 0) # undo the fourth transaction self.Doc.undo() self.assertEqual(self.Doc.getObject("test1").Integer, 3) self.assertEqual(self.Doc.UndoNames, ["Transaction3", "Transaction2", "Transaction1"]) self.assertEqual(self.Doc.UndoCount, 3) self.assertEqual(self.Doc.RedoNames, ["Transaction4"]) self.assertEqual(self.Doc.RedoCount, 1) # undo the third transaction self.Doc.undo() self.assertEqual(self.Doc.getObject("test1").Integer, 2) self.assertEqual(self.Doc.UndoNames, ["Transaction2", "Transaction1"]) self.assertEqual(self.Doc.UndoCount, 2) self.assertEqual(self.Doc.RedoNames, ["Transaction3", "Transaction4"]) self.assertEqual(self.Doc.RedoCount, 2) # undo the second transaction self.Doc.undo() self.assertEqual(self.Doc.getObject("test1").Integer, 1) self.assertEqual(self.Doc.UndoNames, ["Transaction1"]) self.assertEqual(self.Doc.UndoCount, 1) self.assertEqual(self.Doc.RedoNames, ["Transaction2", "Transaction3", "Transaction4"]) self.assertEqual(self.Doc.RedoCount, 3) # undo the first transaction self.Doc.undo() self.assertTrue(self.Doc.getObject("test1") is None) self.assertTrue(self.Doc.getObject("Del").Integer == 2) self.assertEqual(self.Doc.UndoNames, []) self.assertEqual(self.Doc.UndoCount, 0) self.assertEqual( self.Doc.RedoNames, ["Transaction1", "Transaction2", "Transaction3", "Transaction4"] ) self.assertEqual(self.Doc.RedoCount, 4) # redo the first transaction self.Doc.redo() self.assertEqual(self.Doc.getObject("test1").Integer, 1) self.assertEqual(self.Doc.UndoNames, ["Transaction1"]) self.assertEqual(self.Doc.UndoCount, 1) self.assertEqual(self.Doc.RedoNames, ["Transaction2", "Transaction3", "Transaction4"]) self.assertEqual(self.Doc.RedoCount, 3) # redo the second transaction self.Doc.redo() self.assertEqual(self.Doc.getObject("test1").Integer, 2) self.assertEqual(self.Doc.UndoNames, ["Transaction2", "Transaction1"]) self.assertEqual(self.Doc.UndoCount, 2) self.assertEqual(self.Doc.RedoNames, ["Transaction3", "Transaction4"]) self.assertEqual(self.Doc.RedoCount, 2) # undo the second transaction self.Doc.undo() self.assertEqual(self.Doc.getObject("test1").Integer, 1) self.assertEqual(self.Doc.UndoNames, ["Transaction1"]) self.assertEqual(self.Doc.UndoCount, 1) self.assertEqual(self.Doc.RedoNames, ["Transaction2", "Transaction3", "Transaction4"]) self.assertEqual(self.Doc.RedoCount, 3) # new transaction eight self.Doc.openTransaction("Transaction8") self.Doc.getObject("test1").Integer = 8 self.assertEqual(self.Doc.UndoNames, ["Transaction8", "Transaction1"]) self.assertEqual(self.Doc.UndoCount, 2) self.assertEqual(self.Doc.RedoNames, []) self.assertEqual(self.Doc.RedoCount, 0) self.Doc.abortTransaction() self.assertEqual(self.Doc.UndoNames, ["Transaction1"]) self.assertEqual(self.Doc.UndoCount, 1) self.assertEqual(self.Doc.RedoNames, []) self.assertEqual(self.Doc.RedoCount, 0) # again new transaction eight self.Doc.openTransaction("Transaction8") self.Doc.getObject("test1").Integer = 8 self.assertEqual(self.Doc.UndoNames, ["Transaction8", "Transaction1"]) self.assertEqual(self.Doc.UndoCount, 2) self.assertEqual(self.Doc.RedoNames, []) self.assertEqual(self.Doc.RedoCount, 0) # again new transaction nine self.Doc.openTransaction("Transaction9") self.Doc.getObject("test1").Integer = 9 self.assertEqual(self.Doc.UndoNames, ["Transaction9", "Transaction8", "Transaction1"]) self.assertEqual(self.Doc.UndoCount, 3) self.assertEqual(self.Doc.RedoNames, []) self.assertEqual(self.Doc.RedoCount, 0) self.Doc.commitTransaction() self.assertEqual(self.Doc.UndoNames, ["Transaction9", "Transaction8", "Transaction1"]) self.assertEqual(self.Doc.UndoCount, 3) self.assertEqual(self.Doc.RedoNames, []) self.assertEqual(self.Doc.RedoCount, 0) self.assertEqual(self.Doc.getObject("test1").Integer, 9) # undo the ninth transaction self.Doc.undo() self.assertEqual(self.Doc.getObject("test1").Integer, 8) self.assertEqual(self.Doc.UndoNames, ["Transaction8", "Transaction1"]) self.assertEqual(self.Doc.UndoCount, 2) self.assertEqual(self.Doc.RedoNames, ["Transaction9"]) self.assertEqual(self.Doc.RedoCount, 1) # switch on the Undo OFF self.Doc.UndoMode = 0 self.assertEqual(self.Doc.UndoNames, []) self.assertEqual(self.Doc.UndoCount, 0) self.assertEqual(self.Doc.RedoNames, []) self.assertEqual(self.Doc.RedoCount, 0) def testUndoInList(self): self.Doc.UndoMode = 1 self.Doc.openTransaction("Box") self.Box = self.Doc.addObject("App::FeatureTest") self.Doc.commitTransaction() self.Doc.openTransaction("Cylinder") self.Cylinder = self.Doc.addObject("App::FeatureTest") self.Doc.commitTransaction() self.Doc.openTransaction("Fuse") self.Fuse1 = self.Doc.addObject("App::FeatureTest", "Fuse") self.Fuse1.LinkList = [self.Box, self.Cylinder] self.Doc.commitTransaction() self.Doc.undo() self.assertTrue(len(self.Box.InList) == 0) self.assertTrue(len(self.Cylinder.InList) == 0) self.Doc.redo() self.assertTrue(len(self.Box.InList) == 1) self.assertTrue(self.Box.InList[0] == self.Doc.Fuse) self.assertTrue(len(self.Cylinder.InList) == 1) self.assertTrue(self.Cylinder.InList[0] == self.Doc.Fuse) def testUndoIssue0003150Part1(self): self.Doc.UndoMode = 1 self.Doc.openTransaction("Box") self.Box = self.Doc.addObject("App::FeatureTest") self.Doc.commitTransaction() self.Doc.openTransaction("Cylinder") self.Cylinder = self.Doc.addObject("App::FeatureTest") self.Doc.commitTransaction() self.Doc.openTransaction("Fuse") self.Fuse1 = self.Doc.addObject("App::FeatureTest") self.Fuse1.LinkList = [self.Box, self.Cylinder] self.Doc.commitTransaction() self.Doc.recompute() self.Doc.openTransaction("Sphere") self.Sphere = self.Doc.addObject("App::FeatureTest") self.Doc.commitTransaction() self.Doc.openTransaction("Fuse") self.Fuse2 = self.Doc.addObject("App::FeatureTest") self.Fuse2.LinkList = [self.Fuse1, self.Sphere] self.Doc.commitTransaction() self.Doc.recompute() self.Doc.openTransaction("Part") self.Part = self.Doc.addObject("App::Part") self.Doc.commitTransaction() self.Doc.openTransaction("Drag") self.Part.addObject(self.Fuse2) self.Doc.commitTransaction() # 3 undos show the problem of failing recompute self.Doc.undo() self.Doc.undo() self.Doc.undo() self.assertTrue(self.Doc.recompute() >= 0) def tearDown(self): # closing doc FreeCAD.closeDocument("UndoTest") class DocumentGroupCases(unittest.TestCase): def setUp(self): self.Doc = FreeCAD.newDocument("GroupTests") def testGroup(self): # Add an object to the group L2 = self.Doc.addObject("App::FeatureTest", "Label_2") G1 = self.Doc.addObject("App::DocumentObjectGroup", "Group") G1.addObject(L2) self.assertTrue(G1.hasObject(L2)) # Adding the group to itself must fail try: G1.addObject(G1) except Exception: FreeCAD.Console.PrintLog("Cannot add group to itself, OK\n") else: self.fail("Adding the group to itself must not be possible") self.Doc.UndoMode = 1 # Remove object from group self.Doc.openTransaction("Remove") self.Doc.removeObject("Label_2") self.Doc.commitTransaction() self.assertTrue(G1.getObject("Label_2") is None) self.Doc.undo() self.assertTrue(G1.getObject("Label_2") is not None) # Remove first group and then the object self.Doc.openTransaction("Remove") self.Doc.removeObject("Group") self.Doc.removeObject("Label_2") self.Doc.commitTransaction() self.Doc.undo() self.assertTrue(G1.getObject("Label_2") is not None) # Remove first object and then the group in two transactions self.Doc.openTransaction("Remove") self.Doc.removeObject("Label_2") self.Doc.commitTransaction() self.assertTrue(G1.getObject("Label_2") is None) self.Doc.openTransaction("Remove") self.Doc.removeObject("Group") self.Doc.commitTransaction() self.Doc.undo() self.Doc.undo() self.assertTrue(G1.getObject("Label_2") is not None) # Remove first object and then the group in one transaction self.Doc.openTransaction("Remove") self.Doc.removeObject("Label_2") self.assertTrue(G1.getObject("Label_2") is None) self.Doc.removeObject("Group") self.Doc.commitTransaction() self.Doc.undo() # FIXME: See bug #1820554 self.assertTrue(G1.getObject("Label_2") is not None) # Add a second object to the group L3 = self.Doc.addObject("App::FeatureTest", "Label_3") G1.addObject(L3) self.Doc.openTransaction("Remove") self.Doc.removeObject("Label_2") self.assertTrue(G1.getObject("Label_2") is None) self.Doc.removeObject("Label_3") self.assertTrue(G1.getObject("Label_3") is None) self.Doc.removeObject("Group") self.Doc.commitTransaction() self.Doc.undo() self.assertTrue(G1.getObject("Label_3") is not None) self.assertTrue(G1.getObject("Label_2") is not None) self.Doc.UndoMode = 0 # Cleanup self.Doc.removeObject("Group") self.Doc.removeObject("Label_2") self.Doc.removeObject("Label_3") def testGroupAndGeoFeatureGroup(self): # an object can only be in one group at once, that must be enforced obj1 = self.Doc.addObject("App::FeatureTest", "obj1") grp1 = self.Doc.addObject("App::DocumentObjectGroup", "Group1") grp2 = self.Doc.addObject("App::DocumentObjectGroup", "Group2") grp1.addObject(obj1) self.assertTrue(obj1.getParentGroup() == grp1) self.assertTrue(obj1.getParentGeoFeatureGroup() is None) self.assertTrue(grp1.hasObject(obj1)) grp2.addObject(obj1) self.assertTrue(grp1.hasObject(obj1) == False) self.assertTrue(grp2.hasObject(obj1)) # an object is allowed to be in a group and a geofeaturegroup prt1 = self.Doc.addObject("App::Part", "Part1") prt2 = self.Doc.addObject("App::Part", "Part2") prt1.addObject(grp2) self.assertTrue(grp2.getParentGeoFeatureGroup() == prt1) self.assertTrue(grp2.getParentGroup() is None) self.assertTrue(grp2.hasObject(obj1)) self.assertTrue(prt1.hasObject(grp2)) self.assertTrue(prt1.hasObject(obj1)) # it is not allowed to be in 2 geofeaturegroups prt2.addObject(grp2) self.assertTrue(grp2.hasObject(obj1)) self.assertTrue(prt1.hasObject(grp2) == False) self.assertTrue(prt1.hasObject(obj1) == False) self.assertTrue(prt2.hasObject(grp2)) self.assertTrue(prt2.hasObject(obj1)) try: grp = prt1.Group grp.append(obj1) prt1.Group = grp except Exception: grp.remove(obj1) self.assertTrue(prt1.Group == grp) else: self.fail("No exception thrown when object is in multiple Groups") # it is not allowed to be in 2 Groups prt2.addObject(grp1) grp = grp1.Group grp.append(obj1) try: grp1.Group = grp except Exception: pass else: self.fail("No exception thrown when object is in multiple Groups") # cross linking between GeoFeatureGroups is not allowed self.Doc.recompute() box = self.Doc.addObject("App::FeatureTest", "Box") cyl = self.Doc.addObject("App::FeatureTest", "Cylinder") fus = self.Doc.addObject("App::FeatureTest", "Fusion") fus.LinkList = [cyl, box] self.Doc.recompute() self.assertTrue(fus.State[0] == "Up-to-date") fus.LinkList = ( [] ) # remove all links as addObject would otherwise transfer all linked objects prt1.addObject(cyl) fus.LinkList = [cyl, box] self.Doc.recompute() # self.assertTrue(fus.State[0] == 'Invalid') fus.LinkList = [] prt1.addObject(box) fus.LinkList = [cyl, box] self.Doc.recompute() # self.assertTrue(fus.State[0] == 'Invalid') fus.LinkList = [] prt1.addObject(fus) fus.LinkList = [cyl, box] self.Doc.recompute() self.assertTrue(fus.State[0] == "Up-to-date") prt2.addObject(box) # this time addObject should move all dependencies to the new part self.Doc.recompute() self.assertTrue(fus.State[0] == "Up-to-date") # grouping must be resilient against cyclic links and not crash: #issue 0002567 prt1.addObject(prt2) grp = prt2.Group grp.append(prt1) prt2.Group = grp self.Doc.recompute() prt2.Group = [] try: prt2.Group = [prt2] except Exception: pass else: self.fail("Exception is expected") self.Doc.recompute() def testIssue0003150Part2(self): self.box = self.Doc.addObject("App::FeatureTest") self.cyl = self.Doc.addObject("App::FeatureTest") self.sph = self.Doc.addObject("App::FeatureTest") self.fus1 = self.Doc.addObject("App::FeatureTest") self.fus2 = self.Doc.addObject("App::FeatureTest") self.fus1.LinkList = [self.box, self.cyl] self.fus2.LinkList = [self.sph, self.cyl] self.prt = self.Doc.addObject("App::Part") self.prt.addObject(self.fus1) self.assertTrue(len(self.prt.Group) == 5) self.assertTrue(self.fus2.getParentGeoFeatureGroup() == self.prt) self.assertTrue(self.prt.hasObject(self.sph)) self.prt.removeObject(self.fus1) self.assertTrue(len(self.prt.Group) == 0) def tearDown(self): # closing doc FreeCAD.closeDocument("GroupTests") class DocumentPlatformCases(unittest.TestCase): def setUp(self): self.Doc = FreeCAD.newDocument("PlatformTests") self.Doc.addObject("App::FeatureTest", "Test") self.TempPath = tempfile.gettempdir() self.DocName = self.TempPath + os.sep + "PlatformTests.FCStd" def testFloatList(self): self.Doc.Test.FloatList = [-0.05, 2.5, 5.2] # saving and restoring self.Doc.saveAs(self.DocName) FreeCAD.closeDocument("PlatformTests") self.Doc = FreeCAD.open(self.DocName) self.assertTrue(abs(self.Doc.Test.FloatList[0] + 0.05) < 0.01) self.assertTrue(abs(self.Doc.Test.FloatList[1] - 2.5) < 0.01) self.assertTrue(abs(self.Doc.Test.FloatList[2] - 5.2) < 0.01) def testColorList(self): self.Doc.Test.ColourList = [(1.0, 0.5, 0.0), (0.0, 0.5, 1.0)] # saving and restoring self.Doc.saveAs(self.DocName) FreeCAD.closeDocument("PlatformTests") self.Doc = FreeCAD.open(self.DocName) self.assertTrue(abs(self.Doc.Test.ColourList[0][0] - 1.0) < 0.01) self.assertTrue(abs(self.Doc.Test.ColourList[0][1] - 0.5) < 0.01) self.assertTrue(abs(self.Doc.Test.ColourList[0][2] - 0.0) < 0.01) self.assertTrue(abs(self.Doc.Test.ColourList[0][3] - 0.0) < 0.01) self.assertTrue(abs(self.Doc.Test.ColourList[1][0] - 0.0) < 0.01) self.assertTrue(abs(self.Doc.Test.ColourList[1][1] - 0.5) < 0.01) self.assertTrue(abs(self.Doc.Test.ColourList[1][2] - 1.0) < 0.01) self.assertTrue(abs(self.Doc.Test.ColourList[1][3] - 0.0) < 0.01) def testVectorList(self): self.Doc.Test.VectorList = [(-0.05, 2.5, 5.2), (-0.05, 2.5, 5.2)] # saving and restoring self.Doc.saveAs(self.DocName) FreeCAD.closeDocument("PlatformTests") self.Doc = FreeCAD.open(self.DocName) self.assertTrue(len(self.Doc.Test.VectorList) == 2) def testPoints(self): try: self.Doc.addObject("Points::Feature", "Points") # saving and restoring self.Doc.saveAs(self.DocName) FreeCAD.closeDocument("PlatformTests") self.Doc = FreeCAD.open(self.DocName) self.assertTrue(self.Doc.Points.Points.count() == 0) except Exception: pass def tearDown(self): # closing doc FreeCAD.closeDocument("PlatformTests") class DocumentBacklinks(unittest.TestCase): def setUp(self): self.Doc = FreeCAD.newDocument("BackLinks") def testIssue0003323(self): self.Doc.UndoMode = 1 self.Doc.openTransaction("Create object") obj1 = self.Doc.addObject("App::FeatureTest", "Test1") obj2 = self.Doc.addObject("App::FeatureTest", "Test2") obj2.Link = obj1 self.Doc.commitTransaction() self.Doc.undo() self.Doc.openTransaction("Create object") def tearDown(self): # closing doc FreeCAD.closeDocument("BackLinks") class DocumentFileIncludeCases(unittest.TestCase): def setUp(self): self.Doc = FreeCAD.newDocument("FileIncludeTests") # testing with undo self.Doc.UndoMode = 1 def testApplyFiles(self): self.Doc.openTransaction("Transaction0") self.L1 = self.Doc.addObject("App::DocumentObjectFileIncluded", "FileObject1") self.assertTrue(self.L1.File == "") self.Filename = self.L1.File self.Doc.openTransaction("Transaction1") self.TempPath = tempfile.gettempdir() # creating a file in the Transient directory of the document file = open(self.Doc.getTempFileName("test"), "w") file.write("test No1") file.close() # applying the file self.L1.File = (file.name, "Test.txt") self.assertTrue(self.L1.File.split("/")[-1] == "Test.txt") # read again file = open(self.L1.File, "r") self.assertTrue(file.read() == "test No1") file.close() file = open(self.TempPath + "/testNest.txt", "w") file.write("test No2") file.close() # applying the file self.Doc.openTransaction("Transaction2") self.L1.File = file.name self.assertTrue(self.L1.File.split("/")[-1] == "Test.txt") # read again file = open(self.L1.File, "r") self.assertTrue(file.read() == "test No2") file.close() self.Doc.undo() self.assertTrue(self.L1.File.split("/")[-1] == "Test.txt") # read again file = open(self.L1.File, "r") self.assertTrue(file.read() == "test No1") file.close() self.Doc.undo() # read again self.assertTrue(self.L1.File == "") self.Doc.redo() self.assertTrue(self.L1.File.split("/")[-1] == "Test.txt") # read again file = open(self.L1.File, "r") self.assertTrue(file.read() == "test No1") file.close() self.Doc.redo() self.assertTrue(self.L1.File.split("/")[-1] == "Test.txt") # read again file = open(self.L1.File, "r") self.assertTrue(file.read() == "test No2") file.close() # Save restore test FileName = self.TempPath + "/FileIncludeTests.fcstd" self.Doc.saveAs(FileName) FreeCAD.closeDocument("FileIncludeTests") self.Doc = FreeCAD.open(self.TempPath + "/FileIncludeTests.fcstd") # check if the file is still there self.L1 = self.Doc.getObject("FileObject1") file = open(self.L1.File, "r") res = file.read() FreeCAD.Console.PrintLog(res + "\n") self.assertTrue(res == "test No2") self.assertTrue(self.L1.File.split("/")[-1] == "Test.txt") file.close() # test for bug #94 (File overlap in PropertyFileIncluded) L2 = self.Doc.addObject("App::DocumentObjectFileIncluded", "FileObject2") L3 = self.Doc.addObject("App::DocumentObjectFileIncluded", "FileObject3") # creating two files in the Transient directory of the document file1 = open(self.Doc.getTempFileName("test"), "w") file1.write("test No1") file1.close() file2 = open(self.Doc.getTempFileName("test"), "w") file2.write("test No2") file2.close() # applying the file with the same base name L2.File = (file1.name, "Test.txt") L3.File = (file2.name, "Test.txt") file = open(L2.File, "r") self.assertTrue(file.read() == "test No1") file.close() file = open(L3.File, "r") self.assertTrue(file.read() == "test No2") file.close() # create a second document, copy a file and close the document # the test is about to put the file to the correct transient dir doc2 = FreeCAD.newDocument("Doc2") L4 = doc2.addObject("App::DocumentObjectFileIncluded", "FileObject") L5 = doc2.addObject("App::DocumentObjectFileIncluded", "FileObject") L6 = doc2.addObject("App::DocumentObjectFileIncluded", "FileObject") L4.File = (L3.File, "Test.txt") L5.File = L3.File L6.File = L3.File FreeCAD.closeDocument("FileIncludeTests") self.Doc = FreeCAD.open(self.TempPath + "/FileIncludeTests.fcstd") self.assertTrue(os.path.exists(L4.File)) self.assertTrue(os.path.exists(L5.File)) self.assertTrue(os.path.exists(L6.File)) self.assertTrue(L5.File != L6.File) # copy file from L5 which is in the same directory L7 = doc2.addObject("App::DocumentObjectFileIncluded", "FileObject3") L7.File = (L5.File, "Copy.txt") self.assertTrue(os.path.exists(L7.File)) FreeCAD.closeDocument("Doc2") def tearDown(self): # closing doc FreeCAD.closeDocument("FileIncludeTests") class DocumentPropertyCases(unittest.TestCase): def setUp(self): self.Doc = FreeCAD.newDocument("PropertyTests") self.Obj = self.Doc.addObject("App::FeaturePython", "Test") def testDescent(self): # testing the up and downstream stuff props = self.Obj.supportedProperties() for i in props: self.Obj.addProperty(i, i.replace(":", "_")) tempPath = tempfile.gettempdir() tempFile = tempPath + os.sep + "PropertyTests.FCStd" self.Doc.saveAs(tempFile) FreeCAD.closeDocument("PropertyTests") self.Doc = FreeCAD.open(tempFile) def testRemoveProperty(self): prop = "Something" self.Obj.addProperty("App::PropertyFloat", prop) self.Obj.Something = 0.01 self.Doc.recompute() self.Doc.openTransaction("modify and remove property") self.Obj.Something = 0.00 self.Obj.removeProperty(prop) self.Obj.recompute() self.Doc.abortTransaction() def testRemovePropertyExpression(self): p1 = self.Doc.addObject("App::FeaturePython", "params1") p2 = self.Doc.addObject("App::FeaturePython", "params2") p1.addProperty("App::PropertyFloat", "a") p1.a = 42 p2.addProperty("App::PropertyFloat", "b") p2.setExpression("b", "params1.a") self.Doc.recompute() p2.removeProperty("b") p1.touch() self.Doc.recompute() self.assertTrue(not p2 in p1.InList) def testRemovePropertyOnChange(self): class Feature: def __init__(self, fp): fp.Proxy = self fp.addProperty("App::PropertyString", "Test") def onBeforeChange(self, fp, prop): if prop == "Test": fp.removeProperty("Test") def onChanged(self, fp, prop): getattr(fp, prop) obj = self.Doc.addObject("App::FeaturePython") fea = Feature(obj) obj.Test = "test" def tearDown(self): # closing doc FreeCAD.closeDocument("PropertyTests") class DocumentExpressionCases(unittest.TestCase): def setUp(self): self.Doc = FreeCAD.newDocument() def assertAlmostEqual(self, v1, v2): if math.fabs(v2 - v1) > 1e-12: self.assertEqual(v1, v2) def testExpression(self): self.Obj1 = self.Doc.addObject("App::FeatureTest", "Test") self.Obj2 = self.Doc.addObject("App::FeatureTest", "Test") # set the object twice to test that the backlinks are removed when overwriting the expression self.Obj2.setExpression( "Placement.Rotation.Angle", "%s.Placement.Rotation.Angle" % self.Obj1.Name ) self.Obj2.setExpression( "Placement.Rotation.Angle", "%s.Placement.Rotation.Angle" % self.Obj1.Name ) self.Obj1.Placement = FreeCAD.Placement( FreeCAD.Vector(0, 0, 0), FreeCAD.Rotation(FreeCAD.Vector(0, 0, 1), 10) ) self.Doc.recompute() self.assertAlmostEqual( self.Obj1.Placement.Rotation.Angle, self.Obj2.Placement.Rotation.Angle ) # clear the expression self.Obj2.setExpression("Placement.Rotation.Angle", None) self.assertAlmostEqual( self.Obj1.Placement.Rotation.Angle, self.Obj2.Placement.Rotation.Angle ) self.Doc.recompute() self.assertAlmostEqual( self.Obj1.Placement.Rotation.Angle, self.Obj2.Placement.Rotation.Angle ) # touch the objects to perform a recompute self.Obj1.Placement = self.Obj1.Placement self.Obj2.Placement = self.Obj2.Placement # must not raise a topological error self.assertEqual(self.Doc.recompute(), 2) # add test for issue #6948 self.Obj3 = self.Doc.addObject("App::FeatureTest", "Test") self.Obj3.setExpression("Float", "2*(5%3)") self.Doc.recompute() self.assertEqual(self.Obj3.Float, 4) self.assertEqual(self.Obj3.evalExpression(self.Obj3.ExpressionEngine[0][1]), 4) def testIssue4649(self): class Cls: def __init__(self, obj): self.MonitorChanges = False obj.Proxy = self obj.addProperty("App::PropertyFloat", "propA", "group") obj.addProperty("App::PropertyFloat", "propB", "group") self.MonitorChanges = True obj.setExpression("propB", "6*9") def onChanged(self, obj, prop): print("onChanged", self, obj, prop) if self.MonitorChanges and prop == "propA": print("Removing expression...") obj.setExpression("propB", None) obj = self.Doc.addObject("App::DocumentObjectGroupPython", "Obj") Cls(obj) self.Doc.UndoMode = 1 self.Doc.openTransaction("Expression") obj.setExpression("propA", "42") self.Doc.recompute() self.Doc.commitTransaction() self.assertTrue(("propB", None) in obj.ExpressionEngine) self.assertTrue(("propA", "42") in obj.ExpressionEngine) self.Doc.undo() self.assertFalse(("propB", None) in obj.ExpressionEngine) self.assertFalse(("propA", "42") in obj.ExpressionEngine) self.Doc.redo() self.assertTrue(("propB", None) in obj.ExpressionEngine) self.assertTrue(("propA", "42") in obj.ExpressionEngine) self.Doc.recompute() obj.ExpressionEngine TempPath = tempfile.gettempdir() SaveName = TempPath + os.sep + "ExpressionTests.FCStd" self.Doc.saveAs(SaveName) FreeCAD.closeDocument(self.Doc.Name) self.Doc = FreeCAD.openDocument(SaveName) def testCyclicDependencyOnPlacement(self): obj = self.Doc.addObject("App::FeaturePython", "Python") obj.addProperty("App::PropertyPlacement", "Placement") obj.setExpression(".Placement.Base.x", ".Placement.Base.y + 10mm") with self.assertRaises(RuntimeError): obj.setExpression(".Placement.Base.y", ".Placement.Base.x + 10mm") def tearDown(self): # closing doc FreeCAD.closeDocument(self.Doc.Name) class DocumentObserverCases(unittest.TestCase): class Observer: def __init__(self): self.clear() def clear(self): self.signal = [] self.parameter = [] self.parameter2 = [] def slotCreatedDocument(self, doc): self.signal.append("DocCreated") self.parameter.append(doc) def slotDeletedDocument(self, doc): self.signal.append("DocDeleted") self.parameter.append(doc) def slotRelabelDocument(self, doc): self.signal.append("DocRelabled") self.parameter.append(doc) def slotActivateDocument(self, doc): self.signal.append("DocActivated") self.parameter.append(doc) def slotRecomputedDocument(self, doc): self.signal.append("DocRecomputed") self.parameter.append(doc) def slotUndoDocument(self, doc): self.signal.append("DocUndo") self.parameter.append(doc) def slotRedoDocument(self, doc): self.signal.append("DocRedo") self.parameter.append(doc) def slotOpenTransaction(self, doc, name): self.signal.append("DocOpenTransaction") self.parameter.append(doc) self.parameter2.append(name) def slotCommitTransaction(self, doc): self.signal.append("DocCommitTransaction") self.parameter.append(doc) def slotAbortTransaction(self, doc): self.signal.append("DocAbortTransaction") self.parameter.append(doc) def slotBeforeChangeDocument(self, doc, prop): self.signal.append("DocBeforeChange") self.parameter.append(doc) self.parameter2.append(prop) def slotChangedDocument(self, doc, prop): self.signal.append("DocChanged") self.parameter.append(doc) self.parameter2.append(prop) def slotCreatedObject(self, obj): self.signal.append("ObjCreated") self.parameter.append(obj) def slotDeletedObject(self, obj): self.signal.append("ObjDeleted") self.parameter.append(obj) def slotChangedObject(self, obj, prop): self.signal.append("ObjChanged") self.parameter.append(obj) self.parameter2.append(prop) def slotBeforeChangeObject(self, obj, prop): self.signal.append("ObjBeforeChange") self.parameter.append(obj) self.parameter2.append(prop) def slotRecomputedObject(self, obj): self.signal.append("ObjRecomputed") self.parameter.append(obj) def slotAppendDynamicProperty(self, obj, prop): self.signal.append("ObjAddDynProp") self.parameter.append(obj) self.parameter2.append(prop) def slotRemoveDynamicProperty(self, obj, prop): self.signal.append("ObjRemoveDynProp") self.parameter.append(obj) self.parameter2.append(prop) def slotChangePropertyEditor(self, obj, prop): self.signal.append("ObjChangePropEdit") self.parameter.append(obj) self.parameter2.append(prop) def slotStartSaveDocument(self, obj, name): self.signal.append("DocStartSave") self.parameter.append(obj) self.parameter2.append(name) def slotFinishSaveDocument(self, obj, name): self.signal.append("DocFinishSave") self.parameter.append(obj) self.parameter2.append(name) def slotBeforeAddingDynamicExtension(self, obj, extension): self.signal.append("ObjBeforeDynExt") self.parameter.append(obj) self.parameter2.append(extension) def slotAddedDynamicExtension(self, obj, extension): self.signal.append("ObjDynExt") self.parameter.append(obj) self.parameter2.append(extension) class GuiObserver: def __init__(self): self.clear() def clear(self): self.signal = [] self.parameter = [] self.parameter2 = [] def slotCreatedDocument(self, doc): self.signal.append("DocCreated") self.parameter.append(doc) def slotDeletedDocument(self, doc): self.signal.append("DocDeleted") self.parameter.append(doc) def slotRelabelDocument(self, doc): self.signal.append("DocRelabled") self.parameter.append(doc) def slotRenameDocument(self, doc): self.signal.append("DocRenamed") self.parameter.append(doc) def slotActivateDocument(self, doc): self.signal.append("DocActivated") self.parameter.append(doc) def slotCreatedObject(self, obj): self.signal.append("ObjCreated") self.parameter.append(obj) def slotDeletedObject(self, obj): self.signal.append("ObjDeleted") self.parameter.append(obj) def slotChangedObject(self, obj, prop): self.signal.append("ObjChanged") self.parameter.append(obj) self.parameter2.append(prop) def slotInEdit(self, obj): self.signal.append("ObjInEdit") self.parameter.append(obj) def slotResetEdit(self, obj): self.signal.append("ObjResetEdit") self.parameter.append(obj) def setUp(self): self.Obs = self.Observer() FreeCAD.addDocumentObserver(self.Obs) def testRemoveObserver(self): FreeCAD.removeDocumentObserver(self.Obs) self.Obs.clear() self.Doc1 = FreeCAD.newDocument("Observer") FreeCAD.closeDocument(self.Doc1.Name) self.assertEqual(len(self.Obs.signal), 0) self.assertEqual(len(self.Obs.parameter2), 0) self.assertEqual(len(self.Obs.signal), 0) FreeCAD.addDocumentObserver(self.Obs) def testSave(self): TempPath = tempfile.gettempdir() SaveName = TempPath + os.sep + "SaveRestoreTests.FCStd" self.Doc1 = FreeCAD.newDocument("Observer1") self.Doc1.saveAs(SaveName) self.assertEqual(self.Obs.signal.pop(), "DocFinishSave") self.assertEqual(self.Obs.parameter2.pop(), self.Doc1.FileName) self.assertEqual(self.Obs.signal.pop(), "DocStartSave") self.assertEqual(self.Obs.parameter2.pop(), self.Doc1.FileName) FreeCAD.closeDocument(self.Doc1.Name) def testDocument(self): # in case another document already exists then the tests cannot # be done reliably if FreeCAD.GuiUp and FreeCAD.activeDocument(): return # testing document level signals self.Doc1 = FreeCAD.newDocument("Observer1") if FreeCAD.GuiUp: self.assertEqual(self.Obs.signal.pop(0), "DocActivated") self.assertTrue(self.Obs.parameter.pop(0) is self.Doc1) self.assertEqual(self.Obs.signal.pop(0), "DocCreated") self.assertTrue(self.Obs.parameter.pop(0) is self.Doc1) self.assertEqual(self.Obs.signal.pop(0), "DocBeforeChange") self.assertTrue(self.Obs.parameter.pop(0) is self.Doc1) self.assertEqual(self.Obs.parameter2.pop(0), "Label") self.assertEqual(self.Obs.signal.pop(0), "DocChanged") self.assertTrue(self.Obs.parameter.pop(0) is self.Doc1) self.assertEqual(self.Obs.parameter2.pop(0), "Label") self.assertEqual(self.Obs.signal.pop(0), "DocRelabled") self.assertTrue(self.Obs.parameter.pop(0) is self.Doc1) self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) self.Doc2 = FreeCAD.newDocument("Observer2") if FreeCAD.GuiUp: self.assertEqual(self.Obs.signal.pop(0), "DocActivated") self.assertTrue(self.Obs.parameter.pop(0) is self.Doc2) self.assertEqual(self.Obs.signal.pop(0), "DocCreated") self.assertTrue(self.Obs.parameter.pop(0) is self.Doc2) self.assertEqual(self.Obs.signal.pop(0), "DocBeforeChange") self.assertTrue(self.Obs.parameter.pop(0) is self.Doc2) self.assertEqual(self.Obs.parameter2.pop(0), "Label") self.assertEqual(self.Obs.signal.pop(0), "DocChanged") self.assertTrue(self.Obs.parameter.pop(0) is self.Doc2) self.assertEqual(self.Obs.parameter2.pop(0), "Label") self.assertEqual(self.Obs.signal.pop(0), "DocRelabled") self.assertTrue(self.Obs.parameter.pop(0) is self.Doc2) self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) FreeCAD.setActiveDocument("Observer1") self.assertEqual(self.Obs.signal.pop(), "DocActivated") self.assertTrue(self.Obs.parameter.pop() is self.Doc1) self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) # undo/redo is not enabled in cmd line mode by default self.Doc2.UndoMode = 1 # Must set Doc2 as active document before start transaction test. If not, # then a transaction will be auto created inside the active document if a # new transaction is triggered from a non active document FreeCAD.setActiveDocument("Observer2") self.assertEqual(self.Obs.signal.pop(), "DocActivated") self.assertTrue(self.Obs.parameter.pop() is self.Doc2) self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) self.Doc2.openTransaction("test") # openTransaction() now only setup pending transaction, which will only be # created when there is actual change self.Doc2.addObject("App::FeatureTest", "test") self.assertEqual(self.Obs.signal[0], "DocOpenTransaction") self.assertEqual(self.Obs.signal.count("DocOpenTransaction"), 1) self.assertTrue(self.Obs.parameter[0] is self.Doc2) self.assertEqual(self.Obs.parameter2[0], "test") self.Obs.clear() self.Doc2.commitTransaction() self.assertEqual(self.Obs.signal.pop(), "DocCommitTransaction") self.assertTrue(self.Obs.parameter.pop() is self.Doc2) self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) self.Doc2.openTransaction("test2") # openTransaction() now only setup pending transaction, which will only be # created when there is actual change self.Doc2.addObject("App::FeatureTest", "test") self.assertEqual(self.Obs.signal[0], "DocOpenTransaction") self.assertEqual(self.Obs.signal.count("DocOpenTransaction"), 1) self.assertTrue(self.Obs.parameter[0] is self.Doc2) self.assertEqual(self.Obs.parameter2[0], "test2") # there will be other signals because of the addObject() self.Obs.clear() self.Doc2.abortTransaction() self.assertEqual(self.Obs.signal.pop(), "DocAbortTransaction") self.assertTrue(self.Obs.parameter.pop() is self.Doc2) # there will be other signals because of aborting the above addObject() self.Obs.clear() self.Doc2.undo() self.assertEqual(self.Obs.signal.pop(), "DocUndo") self.assertTrue(self.Obs.parameter.pop() is self.Doc2) # there will be other signals because undoing the above addObject() self.Obs.clear() self.Doc2.redo() self.assertEqual(self.Obs.signal.pop(), "DocRedo") self.assertTrue(self.Obs.parameter.pop() is self.Doc2) # there will be other signals because redoing the above addObject() self.Obs.clear() self.Doc1.Comment = "test comment" self.assertEqual(self.Obs.signal.pop(0), "DocBeforeChange") self.assertTrue(self.Obs.parameter.pop(0) is self.Doc1) self.assertEqual(self.Obs.parameter2.pop(0), "Comment") self.assertEqual(self.Obs.signal.pop(0), "DocChanged") self.assertTrue(self.Obs.parameter.pop(0) is self.Doc1) self.assertEqual(self.Obs.parameter2.pop(0), "Comment") FreeCAD.closeDocument(self.Doc2.Name) self.assertEqual(self.Obs.signal.pop(), "DocDeleted") self.assertTrue(self.Obs.parameter.pop() is self.Doc2) if FreeCAD.GuiUp and not FreeCAD.Gui.HasQtBug_129596: # only has document activated signal when running in GUI mode self.assertEqual(self.Obs.signal.pop(), "DocActivated") self.assertTrue(self.Obs.parameter.pop() is self.Doc1) self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) FreeCAD.closeDocument(self.Doc1.Name) self.assertEqual(self.Obs.signal.pop(), "DocDeleted") self.assertEqual(self.Obs.parameter.pop(), self.Doc1) self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) def testObject(self): # testing signal on object changes self.Doc1 = FreeCAD.newDocument("Observer1") self.Obs.clear() obj = self.Doc1.addObject("App::DocumentObject", "obj") self.assertTrue(self.Obs.signal.pop() == "ObjCreated") self.assertTrue(self.Obs.parameter.pop() is obj) # there are multiple object change signals self.Obs.clear() obj.Label = "myobj" self.assertTrue(self.Obs.signal.pop(0) == "ObjBeforeChange") self.assertTrue(self.Obs.parameter.pop(0) is obj) self.assertTrue(self.Obs.parameter2.pop(0) == "Label") self.assertTrue(self.Obs.signal.pop(0) == "ObjChanged") self.assertTrue(self.Obs.parameter.pop(0) is obj) self.assertTrue(self.Obs.parameter2.pop(0) == "Label") self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) obj.enforceRecompute() obj.recompute() self.assertTrue(self.Obs.signal.pop(0) == "ObjRecomputed") self.assertTrue(self.Obs.parameter.pop(0) is obj) self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) obj.enforceRecompute() self.Doc1.recompute() self.assertTrue(self.Obs.signal.pop(0) == "ObjRecomputed") self.assertTrue(self.Obs.parameter.pop(0) is obj) self.assertTrue(self.Obs.signal.pop(0) == "DocRecomputed") self.assertTrue(self.Obs.parameter.pop(0) is self.Doc1) self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) FreeCAD.ActiveDocument.removeObject(obj.Name) self.assertTrue(self.Obs.signal.pop(0) == "ObjDeleted") self.assertTrue(self.Obs.parameter.pop(0) is obj) self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) pyobj = self.Doc1.addObject("App::FeaturePython", "pyobj") self.Obs.clear() pyobj.addProperty("App::PropertyLength", "Prop", "Group", "test property") self.assertTrue(self.Obs.signal.pop() == "ObjAddDynProp") self.assertTrue(self.Obs.parameter.pop() is pyobj) self.assertTrue(self.Obs.parameter2.pop() == "Prop") self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) pyobj.setEditorMode("Prop", ["ReadOnly"]) self.assertTrue(self.Obs.signal.pop() == "ObjChangePropEdit") self.assertTrue(self.Obs.parameter.pop() is pyobj) self.assertTrue(self.Obs.parameter2.pop() == "Prop") self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) pyobj.removeProperty("Prop") self.assertTrue(self.Obs.signal.pop() == "ObjRemoveDynProp") self.assertTrue(self.Obs.parameter.pop() is pyobj) self.assertTrue(self.Obs.parameter2.pop() == "Prop") self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) pyobj.addExtension("App::GroupExtensionPython") self.assertTrue(self.Obs.signal.pop() == "ObjDynExt") self.assertTrue(self.Obs.parameter.pop() is pyobj) self.assertTrue(self.Obs.parameter2.pop() == "App::GroupExtensionPython") self.assertTrue(self.Obs.signal.pop(0) == "ObjBeforeDynExt") self.assertTrue(self.Obs.parameter.pop(0) is pyobj) self.assertTrue(self.Obs.parameter2.pop(0) == "App::GroupExtensionPython") # a proxy property was changed, hence those events are also in the signal list self.Obs.clear() FreeCAD.closeDocument(self.Doc1.Name) self.Obs.clear() def testUndoDisabledDocument(self): # testing document level signals self.Doc1 = FreeCAD.newDocument("Observer1") self.Doc1.UndoMode = 0 self.Obs.clear() self.Doc1.openTransaction("test") self.Doc1.commitTransaction() self.Doc1.undo() self.Doc1.redo() self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) FreeCAD.closeDocument(self.Doc1.Name) self.Obs.clear() def testGuiObserver(self): if not FreeCAD.GuiUp: return # in case another document already exists then the tests cannot # be done reliably if FreeCAD.activeDocument(): return self.GuiObs = self.GuiObserver() FreeCAD.Gui.addDocumentObserver(self.GuiObs) self.Doc1 = FreeCAD.newDocument("Observer1") self.GuiDoc1 = FreeCAD.Gui.getDocument(self.Doc1.Name) self.Obs.clear() self.assertTrue(self.GuiObs.signal.pop(0) == "DocCreated") self.assertTrue(self.GuiObs.parameter.pop(0) is self.GuiDoc1) self.assertTrue(self.GuiObs.signal.pop(0) == "DocActivated") self.assertTrue(self.GuiObs.parameter.pop(0) is self.GuiDoc1) self.assertTrue(self.GuiObs.signal.pop(0) == "DocRelabled") self.assertTrue(self.GuiObs.parameter.pop(0) is self.GuiDoc1) self.assertTrue( not self.GuiObs.signal and not self.GuiObs.parameter and not self.GuiObs.parameter2 ) self.Doc1.Label = "test" self.assertTrue(self.Obs.signal.pop() == "DocRelabled") self.assertTrue(self.Obs.parameter.pop() is self.Doc1) # not interested in the change signals self.Obs.clear() self.assertTrue(self.GuiObs.signal.pop(0) == "DocRelabled") self.assertTrue(self.GuiObs.parameter.pop(0) is self.GuiDoc1) self.assertTrue( not self.GuiObs.signal and not self.GuiObs.parameter and not self.GuiObs.parameter2 ) FreeCAD.setActiveDocument(self.Doc1.Name) self.assertTrue(self.Obs.signal.pop() == "DocActivated") self.assertTrue(self.Obs.parameter.pop() is self.Doc1) self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) self.assertTrue(self.GuiObs.signal.pop() == "DocActivated") self.assertTrue(self.GuiObs.parameter.pop() is self.GuiDoc1) self.assertTrue( not self.GuiObs.signal and not self.GuiObs.parameter and not self.GuiObs.parameter2 ) obj = self.Doc1.addObject("App::FeaturePython", "obj") self.assertTrue(self.Obs.signal.pop() == "ObjCreated") self.assertTrue(self.Obs.parameter.pop() is obj) # there are multiple object change signals self.Obs.clear() self.assertTrue(self.GuiObs.signal.pop() == "ObjCreated") self.assertTrue(self.GuiObs.parameter.pop() is obj.ViewObject) # There are object change signals, caused by sync of obj.Visibility. Same below. self.GuiObs.clear() obj.ViewObject.Visibility = False self.assertTrue(self.Obs.signal.pop() == "ObjChanged") self.assertTrue(self.Obs.parameter.pop() is obj) self.assertTrue(self.Obs.parameter2.pop() == "Visibility") self.assertTrue(self.Obs.signal.pop() == "ObjBeforeChange") self.assertTrue(self.Obs.parameter.pop() is obj) self.assertTrue(self.Obs.parameter2.pop() == "Visibility") self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) self.assertTrue(self.GuiObs.signal.pop(0) == "ObjChanged") self.assertTrue(self.GuiObs.parameter.pop(0) is obj.ViewObject) self.assertTrue(self.GuiObs.parameter2.pop(0) == "Visibility") self.assertTrue( not self.GuiObs.signal and not self.GuiObs.parameter and not self.GuiObs.parameter2 ) obj.ViewObject.addProperty("App::PropertyLength", "Prop", "Group", "test property") self.assertTrue(self.Obs.signal.pop() == "ObjAddDynProp") self.assertTrue(self.Obs.parameter.pop() is obj.ViewObject) self.assertTrue(self.Obs.parameter2.pop() == "Prop") self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) self.assertTrue( not self.GuiObs.signal and not self.GuiObs.parameter and not self.GuiObs.parameter2 ) obj.ViewObject.setEditorMode("Prop", ["ReadOnly"]) self.assertTrue(self.Obs.signal.pop() == "ObjChangePropEdit") self.assertTrue(self.Obs.parameter.pop() is obj.ViewObject) self.assertTrue(self.Obs.parameter2.pop() == "Prop") self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) self.assertTrue( not self.GuiObs.signal and not self.GuiObs.parameter and not self.GuiObs.parameter2 ) obj.ViewObject.removeProperty("Prop") self.assertTrue(self.Obs.signal.pop() == "ObjRemoveDynProp") self.assertTrue(self.Obs.parameter.pop() is obj.ViewObject) self.assertTrue(self.Obs.parameter2.pop() == "Prop") self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) self.assertTrue( not self.GuiObs.signal and not self.GuiObs.parameter and not self.GuiObs.parameter2 ) self.GuiDoc1.setEdit("obj", 0) self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) self.assertTrue(self.GuiObs.signal.pop(0) == "ObjInEdit") self.assertTrue(self.GuiObs.parameter.pop(0) is obj.ViewObject) self.assertTrue( not self.GuiObs.signal and not self.GuiObs.parameter and not self.GuiObs.parameter2 ) self.GuiDoc1.resetEdit() self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) self.assertTrue(self.GuiObs.signal.pop(0) == "ObjResetEdit") self.assertTrue(self.GuiObs.parameter.pop(0) is obj.ViewObject) self.assertTrue( not self.GuiObs.signal and not self.GuiObs.parameter and not self.GuiObs.parameter2 ) obj.ViewObject.addExtension("Gui::ViewProviderGroupExtensionPython") self.assertTrue(self.Obs.signal.pop() == "ObjDynExt") self.assertTrue(self.Obs.parameter.pop() is obj.ViewObject) self.assertTrue(self.Obs.parameter2.pop() == "Gui::ViewProviderGroupExtensionPython") self.assertTrue(self.Obs.signal.pop() == "ObjBeforeDynExt") self.assertTrue(self.Obs.parameter.pop() is obj.ViewObject) self.assertTrue(self.Obs.parameter2.pop() == "Gui::ViewProviderGroupExtensionPython") # a proxy property was changed, hence those events are also in the signal list (but of GUI observer) self.GuiObs.clear() vo = obj.ViewObject FreeCAD.ActiveDocument.removeObject(obj.Name) self.assertTrue(self.Obs.signal.pop(0) == "ObjDeleted") self.assertTrue(self.Obs.parameter.pop(0) is obj) self.assertTrue(not self.Obs.signal and not self.Obs.parameter and not self.Obs.parameter2) self.assertTrue(self.GuiObs.signal.pop() == "ObjDeleted") self.assertTrue(self.GuiObs.parameter.pop() is vo) self.assertTrue( not self.GuiObs.signal and not self.GuiObs.parameter and not self.GuiObs.parameter2 ) FreeCAD.closeDocument(self.Doc1.Name) self.Obs.clear() self.assertTrue(self.GuiObs.signal.pop() == "DocDeleted") self.assertTrue(self.GuiObs.parameter.pop() is self.GuiDoc1) self.assertTrue( not self.GuiObs.signal and not self.GuiObs.parameter and not self.GuiObs.parameter2 ) FreeCAD.Gui.removeDocumentObserver(self.GuiObs) self.GuiObs.clear() def tearDown(self): # closing doc FreeCAD.removeDocumentObserver(self.Obs) self.Obs.clear() self.Obs = None class FeatureTestColumn(unittest.TestCase): def setUp(self): doc = FreeCAD.newDocument("TestColumn") self.obj = doc.addObject("App::FeatureTestColumn", "Column") def testEmpty(self): value = self.obj.Value self.obj.Column = "" self.assertFalse(self.obj.recompute()) self.assertEqual(self.obj.Value, value) def testA(self): self.obj.Column = "A" self.obj.recompute() self.assertEqual(self.obj.Value, 0) def testZ(self): self.obj.Column = "Z" self.obj.recompute() self.assertEqual(self.obj.Value, 25) def testAA(self): self.obj.Column = "AA" self.obj.recompute() self.assertEqual(self.obj.Value, 26) def testAB(self): self.obj.Column = "AB" self.obj.recompute() self.assertEqual(self.obj.Value, 27) def testAZ(self): self.obj.Column = "AZ" self.obj.recompute() self.assertEqual(self.obj.Value, 51) def testBA(self): self.obj.Column = "BA" self.obj.recompute() self.assertEqual(self.obj.Value, 52) def testCB(self): self.obj.Column = "CB" self.obj.recompute() self.assertEqual(self.obj.Value, 79) def testZA(self): self.obj.Column = "ZA" self.obj.recompute() self.assertEqual(self.obj.Value, 676) def testZZ(self): self.obj.Column = "ZZ" self.obj.recompute() self.assertEqual(self.obj.Value, 701) def testAAA(self): self.obj.Column = "AAA" self.obj.recompute() self.assertEqual(self.obj.Value, 702) def testAAZ(self): self.obj.Column = "AAZ" self.obj.recompute() self.assertEqual(self.obj.Value, 727) def testCBA(self): self.obj.Column = "CBA" self.obj.recompute() self.assertEqual(self.obj.Value, 2080) def testAZA(self): self.obj.Column = "AZA" self.obj.recompute() self.assertEqual(self.obj.Value, 1352) def testZZA(self): self.obj.Column = "ZZA" self.obj.recompute() self.assertEqual(self.obj.Value, 18252) def testZZZ(self): self.obj.Column = "ZZZ" self.obj.recompute() self.assertEqual(self.obj.Value, 18277) def testALL(self): self.obj.Column = "ALL" self.obj.recompute() self.assertEqual(self.obj.Value, 999) def testAb(self): value = self.obj.Value self.obj.Column = "Ab" self.assertFalse(self.obj.recompute()) self.assertEqual(self.obj.Value, value) def testABCD(self): value = self.obj.Value self.obj.Column = "ABCD" self.assertFalse(self.obj.recompute()) self.assertEqual(self.obj.Value, value) def testEmptySilent(self): self.obj.Column = "" self.obj.Silent = True self.assertTrue(self.obj.recompute()) self.assertEqual(self.obj.Value, -1) def testAbSilent(self): self.obj.Column = "Ab" self.obj.Silent = True self.assertTrue(self.obj.recompute()) self.assertEqual(self.obj.Value, -1) def testABCDSilent(self): self.obj.Column = "ABCD" self.obj.Silent = True self.assertTrue(self.obj.recompute()) self.assertEqual(self.obj.Value, -1) def tearDown(self): FreeCAD.closeDocument("TestColumn") class FeatureTestRow(unittest.TestCase): def setUp(self): doc = FreeCAD.newDocument("TestRow") self.obj = doc.addObject("App::FeatureTestRow", "Row") def testEmpty(self): self.obj.Silent = True self.obj.Row = "" self.obj.recompute() self.assertEqual(self.obj.Value, -1) def testA(self): self.obj.Silent = True self.obj.Row = "A" self.obj.recompute() self.assertEqual(self.obj.Value, -1) def testException(self): value = self.obj.Value self.obj.Row = "A" self.assertFalse(self.obj.recompute()) self.assertEqual(self.obj.Value, value) def test0(self): self.obj.Silent = True self.obj.Row = "0" self.obj.recompute() self.assertEqual(self.obj.Value, -1) def test1(self): self.obj.Silent = True self.obj.Row = "1" self.obj.recompute() self.assertEqual(self.obj.Value, 0) def test16384(self): self.obj.Silent = True self.obj.Row = "16384" self.obj.recompute() self.assertEqual(self.obj.Value, 16383) def test16385(self): self.obj.Silent = True self.obj.Row = "16385" self.obj.recompute() self.assertEqual(self.obj.Value, -1) def tearDown(self): FreeCAD.closeDocument("TestRow") class FeatureTestAbsAddress(unittest.TestCase): def setUp(self): doc = FreeCAD.newDocument("TestAbsAddress") self.obj = doc.addObject("App::FeatureTestAbsAddress", "Cell") def testAbsoluteA12(self): self.obj.Address = "$A$12" self.obj.recompute() self.assertEqual(self.obj.Valid, True) def testAbsoluteA13(self): self.obj.Address = "A$13" self.obj.recompute() self.assertEqual(self.obj.Valid, True) def testAbsoluteAA13(self): self.obj.Address = "AA$13" self.obj.recompute() self.assertEqual(self.obj.Valid, True) def testAbsoluteZZ12(self): self.obj.Address = "$ZZ$12" self.obj.recompute() self.assertEqual(self.obj.Valid, True) def testAbsoluteABC1(self): self.obj.Address = "$ABC1" self.obj.recompute() self.assertEqual(self.obj.Valid, False) def testAbsoluteABC2(self): self.obj.Address = "ABC$2" self.obj.recompute() self.assertEqual(self.obj.Valid, False) def testRelative(self): self.obj.Address = "A1" self.obj.recompute() self.assertEqual(self.obj.Valid, False) def testInvalid(self): self.obj.Address = "A" self.obj.recompute() self.assertEqual(self.obj.Valid, False) def testEmpty(self): self.obj.Address = "" self.obj.recompute() self.assertEqual(self.obj.Valid, False) def tearDown(self): FreeCAD.closeDocument("TestAbsAddress") class FeatureTestAttribute(unittest.TestCase): def setUp(self): self.doc = FreeCAD.newDocument("TestAttribute") self.doc.UndoMode = 0 def testValidAttribute(self): obj = self.doc.addObject("App::FeatureTestAttribute", "Attribute") obj.Object = obj obj.Attribute = "Name" self.doc.recompute() self.assertIn("Up-to-date", obj.State) def testInvalidAttribute(self): obj = self.doc.addObject("App::FeatureTestAttribute", "Attribute") obj.Object = obj obj.Attribute = "Name123" self.doc.recompute() self.assertIn("Invalid", obj.State) self.assertIn("Touched", obj.State) def testRemoval(self): obj = self.doc.addObject("App::FeatureTestAttribute", "Attribute") obj.Object = obj self.assertEqual(self.doc.removeObject("Attribute"), None) def tearDown(self): FreeCAD.closeDocument("TestAttribute")