Change debug api for tree

commonspace/object/tree/objecttree/mock_objecttree/mock_objecttree.go

@@ -96,19 +96,19 @@ func (mr *MockObjectTreeMockRecorder) Close() *gomock.Call {
 	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Close", reflect.TypeOf((*MockObjectTree)(nil).Close))
 }
 
-// DebugDump mocks base method.
+// Debug mocks base method.
-func (m *MockObjectTree) DebugDump(arg0 objecttree.DescriptionParser) (string, error) {
+func (m *MockObjectTree) Debug(arg0 objecttree.DescriptionParser) (objecttree.DebugInfo, error) {
 	m.ctrl.T.Helper()
-	ret := m.ctrl.Call(m, "DebugDump", arg0)
+	ret := m.ctrl.Call(m, "Debug", arg0)
-	ret0, _ := ret[0].(string)
+	ret0, _ := ret[0].(objecttree.DebugInfo)
 	ret1, _ := ret[1].(error)
 	return ret0, ret1
 }
 
-// DebugDump indicates an expected call of DebugDump.
+// Debug indicates an expected call of Debug.
-func (mr *MockObjectTreeMockRecorder) DebugDump(arg0 interface{}) *gomock.Call {
+func (mr *MockObjectTreeMockRecorder) Debug(arg0 interface{}) *gomock.Call {
 	mr.mock.ctrl.T.Helper()
-	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DebugDump", reflect.TypeOf((*MockObjectTree)(nil).DebugDump), arg0)
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Debug", reflect.TypeOf((*MockObjectTree)(nil).Debug), arg0)
 }
 
 // Delete mocks base method.

commonspace/object/tree/objecttree/objecttree.go

@@ -55,7 +55,7 @@ type ReadableObjectTree interface {
 	HasChanges(...string) bool
 	GetChange(string) (*Change, error)
 
-	DebugDump(parser DescriptionParser) (string, error)
+	Debug(parser DescriptionParser) (DebugInfo, error)
 	IterateRoot(convert ChangeConvertFunc, iterate ChangeIterateFunc) error
 	IterateFrom(id string, convert ChangeConvertFunc, iterate ChangeIterateFunc) error
 }
@@ -609,6 +609,6 @@ func (ot *objectTree) validateTree(newChanges []*Change) error {
 	return ot.validator.ValidateNewChanges(ot.tree, ot.aclList, newChanges)
 }
 
-func (ot *objectTree) DebugDump(parser DescriptionParser) (string, error) {
+func (ot *objectTree) Debug(parser DescriptionParser) (DebugInfo, error) {
-	return ot.tree.Graph(parser)
+	return objectTreeDebug{}.debugInfo(ot, parser)
 }

commonspace/object/tree/objecttree/objecttreedebug.go

@@ -0,0 +1,25 @@
+package objecttree
+
+type objectTreeDebug struct {
+}
+
+type DebugInfo struct {
+	TreeLen      int
+	TreeString   string
+	Graphviz     string
+	Heads        []string
+	SnapshotPath []string
+}
+
+func (o objectTreeDebug) debugInfo(ot *objectTree, parser DescriptionParser) (di DebugInfo, err error) {
+	di = DebugInfo{}
+	di.Graphviz, err = ot.tree.Graph(parser)
+	if err != nil {
+		return
+	}
+	di.TreeString = ot.tree.String()
+	di.TreeLen = ot.tree.Len()
+	di.Heads = ot.Heads()
+	di.SnapshotPath = ot.SnapshotPath()
+	return
+}

commonspace/object/tree/synctree/mock_synctree/mock_synctree.go

@@ -221,19 +221,19 @@ func (mr *MockSyncTreeMockRecorder) Close() *gomock.Call {
 	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Close", reflect.TypeOf((*MockSyncTree)(nil).Close))
 }
 
-// DebugDump mocks base method.
+// Debug mocks base method.
-func (m *MockSyncTree) DebugDump(arg0 objecttree.DescriptionParser) (string, error) {
+func (m *MockSyncTree) Debug(arg0 objecttree.DescriptionParser) (objecttree.DebugInfo, error) {
 	m.ctrl.T.Helper()
-	ret := m.ctrl.Call(m, "DebugDump", arg0)
+	ret := m.ctrl.Call(m, "Debug", arg0)
-	ret0, _ := ret[0].(string)
+	ret0, _ := ret[0].(objecttree.DebugInfo)
 	ret1, _ := ret[1].(error)
 	return ret0, ret1
 }
 
-// DebugDump indicates an expected call of DebugDump.
+// Debug indicates an expected call of Debug.
-func (mr *MockSyncTreeMockRecorder) DebugDump(arg0 interface{}) *gomock.Call {
+func (mr *MockSyncTreeMockRecorder) Debug(arg0 interface{}) *gomock.Call {
 	mr.mock.ctrl.T.Helper()
-	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DebugDump", reflect.TypeOf((*MockSyncTree)(nil).DebugDump), arg0)
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Debug", reflect.TypeOf((*MockSyncTree)(nil).Debug), arg0)
 }
 
 // Delete mocks base method.