[Edit] Test EditPanesController

Test EditPanesController, particularly for the root
cause of tree collapse, WTD-788.

platform/commonUI/edit/test/controllers/EditPanesControllerSpec.js

@@ -0,0 +1,94 @@
+/*global define,describe,it,expect,beforeEach,jasmine*/
+
+define(
+    ["../../src/controllers/EditPanesController"],
+    function (EditPanesController) {
+        "use strict";
+
+        describe("The Edit Panes controller", function () {
+            var mockScope,
+                mockDomainObject,
+                mockContext,
+                controller;
+
+            beforeEach(function () {
+                mockScope = jasmine.createSpyObj("$scope", ["$watch"]);
+                mockDomainObject = jasmine.createSpyObj(
+                    'domainObject',
+                    [ 'getId', 'getCapability' ]
+                );
+                mockContext = jasmine.createSpyObj(
+                    'context',
+                    [ 'getRoot' ]
+                );
+
+                mockDomainObject.getId.andReturn('test-id');
+                mockDomainObject.getCapability.andReturn(mockContext);
+
+                // Return a new instance of the root object each time
+                mockContext.getRoot.andCallFake(function () {
+                    var mockRoot = jasmine.createSpyObj('root', ['getId']);
+                    mockRoot.getId.andReturn('root-id');
+                    return mockRoot;
+                });
+
+
+                controller = new EditPanesController(mockScope);
+            });
+
+            it("watches for the domain object in view", function () {
+                expect(mockScope.$watch).toHaveBeenCalledWith(
+                    "domainObject",
+                    jasmine.any(Function)
+                );
+            });
+
+            it("exposes the root object found via the object's context capability", function () {
+                mockScope.$watch.mostRecentCall.args[1](mockDomainObject);
+
+                // Verify that the correct capability was used
+                expect(mockDomainObject.getCapability)
+                    .toHaveBeenCalledWith('context');
+
+                // Should have exposed the root from getRoot
+                expect(controller.getRoot().getId()).toEqual('root-id');
+            });
+
+            it("preserves the same root instance to avoid excessive refreshing", function () {
+                var firstRoot;
+                // Expose the domain object
+                mockScope.$watch.mostRecentCall.args[1](mockDomainObject);
+                firstRoot = controller.getRoot();
+                // Update!
+                mockScope.$watch.mostRecentCall.args[1](mockDomainObject);
+                // Should still have the same object instance, to avoid
+                // triggering the watch used by the template we're supporting
+                expect(controller.getRoot()).toBe(firstRoot);
+            });
+
+            // Complements the test above; the object pointed to should change
+            // when the actual root has changed (detected by identifier)
+            it("updates the root when it changes", function () {
+                var firstRoot;
+                // Expose the domain object
+                mockScope.$watch.mostRecentCall.args[1](mockDomainObject);
+                firstRoot = controller.getRoot();
+
+                // Change the exposed root
+                mockContext.getRoot.andCallFake(function () {
+                    var mockRoot = jasmine.createSpyObj('root', ['getId']);
+                    mockRoot.getId.andReturn('other-root-id');
+                    return mockRoot;
+                });
+
+                // Update!
+                mockScope.$watch.mostRecentCall.args[1](mockDomainObject);
+
+                // Should still have the same object instance, to avoid
+                // triggering the watch used by the template we're supporting
+                expect(controller.getRoot()).not.toBe(firstRoot);
+                expect(controller.getRoot().getId()).toEqual('other-root-id');
+            });
+        });
+    }
+);

platform/commonUI/edit/test/suite.json

@@ -13,6 +13,7 @@
     "capabilities/EditableLookupCapability",
     "capabilities/EditablePersistenceCapability",
     "capabilities/EditorCapability",
+    "controllers/EditPanesController",
     "objects/EditableDomainObject",
     "objects/EditableDomainObjectCache",
     "objects/EditableModelCache",