Merge lp:~blake-rouse/maas/reload-on-version-change into lp:~maas-committers/maas/trunk

[Blake Rouse]

Reload the entire page if the region version changes.

[Andres Rodriguez (andreserl)]

lgtm!

review: Approve

=== modified file 'src/maasserver/context_processors.py'
--- src/maasserver/context_processors.py	2015-10-19 17:56:35 +0000
+++ src/maasserver/context_processors.py	2015-10-21 19:48:17 +0000
@@ -73,6 +73,7 @@
             'js/angular/directives/sticky_header.js',
             'js/angular/directives/placeholder.js',
             'js/angular/directives/enter_blur.js',
+            'js/angular/directives/version_reloader.js',
             'js/angular/filters/nodes.js',
             'js/angular/filters/by_fabric.js',
             'js/angular/filters/by_vlan.js',

=== added file 'src/maasserver/static/js/angular/directives/tests/test_version_reloader.js'
--- src/maasserver/static/js/angular/directives/tests/test_version_reloader.js	1970-01-01 00:00:00 +0000
+++ src/maasserver/static/js/angular/directives/tests/test_version_reloader.js	2015-10-21 19:48:17 +0000
@@ -0,0 +1,88 @@
+/* Copyright 2015 Canonical Ltd.  This software is licensed under the
+ * GNU Affero General Public License version 3 (see the file LICENSE).
+ *
+ * Unit tests for version reloader.
+ */
+
+describe("maasVersionReloader", function() {
+
+    // Load the MAAS module.
+    beforeEach(module("MAAS"));
+
+    // Grab the needed angular pieces.
+    var $q;
+    beforeEach(inject(function($injector) {
+        $q = $injector.get("$q");
+    }));
+
+    // Load the GeneralManager, ManagerHelperService, RegionConnection and
+    // mock the websocket connection.
+    var GeneralManager, ManagerHelperService, RegionConnection, webSocket;
+    beforeEach(inject(function($injector) {
+        GeneralManager = $injector.get("GeneralManager");
+        RegionConnection = $injector.get("RegionConnection");
+        ManagerHelperService = $injector.get("ManagerHelperService");
+
+        // Mock buildSocket so an actual connection is not made.
+        webSocket = new MockWebSocket();
+        spyOn(RegionConnection, "buildSocket").and.returnValue(webSocket);
+    }));
+
+
+    // Create a new scope before each test.
+    var $scope;
+    beforeEach(inject(function($rootScope) {
+        $scope = $rootScope.$new();
+    }));
+
+    // Return the compiled directive with the items from the scope.
+    function compileDirective() {
+        var directive;
+        var html = [
+            '<div>',
+                '<div data-maas-version-reloader></div>',
+            '</div>'
+            ].join('');
+        // Compile the directive.
+        inject(function($compile) {
+            directive = $compile(html)($scope);
+        });
+        // Perform the digest cycle to finish the compile.
+        $scope.$digest();
+        return directive.find("div[data-maas-version-reloader]");
+    }
+
+    it("sets version from GeneralManager", function() {
+        var directive = compileDirective();
+        expect($scope.version).toBe(GeneralManager.getData("version"));
+    });
+
+    it("watches version.test onces ManagerHelperService resolves", function() {
+        var defer = $q.defer();
+        spyOn(ManagerHelperService, "loadManager").and.returnValue(
+            defer.promise);
+        var directive = compileDirective();
+        spyOn($scope, "$watch");
+
+        defer.resolve();
+        $scope.$digest();
+
+        expect($scope.$watch.calls.argsFor(0)[0]).toBe("version.text");
+    });
+
+    it("calls reloadPage when version.text changes", function() {
+        var defer = $q.defer();
+        spyOn(ManagerHelperService, "loadManager").and.returnValue(
+            defer.promise);
+
+        var directive = compileDirective();
+        spyOn($scope, "reloadPage");
+        defer.resolve();
+        $scope.$digest();
+
+        $scope.version.text = makeName("new");
+        $scope.$digest();
+
+        expect($scope.reloadPage).toHaveBeenCalled();
+    });
+});

=== added file 'src/maasserver/static/js/angular/directives/version_reloader.js'
--- src/maasserver/static/js/angular/directives/version_reloader.js	1970-01-01 00:00:00 +0000
+++ src/maasserver/static/js/angular/directives/version_reloader.js	2015-10-21 19:48:17 +0000
@@ -0,0 +1,37 @@
+/* Copyright 2015 Canonical Ltd.  This software is licensed under the
+ * GNU Affero General Public License version 3 (see the file LICENSE).
+ *
+ * Version reloader.
+ *
+ * Watches the version reported by the GeneralManager if it changes then
+ * the entire page is reloaded by-passing the local browser cache.
+ */
+
+
+angular.module('MAAS').directive('maasVersionReloader', [
+    '$window', 'GeneralManager', 'ManagerHelperService',
+    function($window, GeneralManager, ManagerHelperService) {
+        return {
+            restrict: "A",
+            controller: function($scope) {
+                $scope.version = GeneralManager.getData("version");
+
+                // Reload the page by-passing the browser cache.
+                $scope.reloadPage = function() {
+                    // Force cache reload by passing true.
+                    $window.location.reload(true);
+                };
+
+                ManagerHelperService.loadManager(GeneralManager).then(
+                    function() {
+                        GeneralManager.enableAutoReload(true);
+                        $scope.$watch("version.text",
+                            function(newValue, oldValue) {
+                                if(newValue !== oldValue) {
+                                    $scope.reloadPage();
+                                }
+                            });
+                    });
+            }
+        };
+    }]);

=== modified file 'src/maasserver/static/js/angular/factories/general.js'
--- src/maasserver/static/js/angular/factories/general.js	2015-10-04 20:47:36 +0000
+++ src/maasserver/static/js/angular/factories/general.js	2015-10-21 19:48:17 +0000
@@ -73,6 +73,16 @@
                     replaceData: function(oldData, newData) {
                         angular.copy(newData, oldData);
                     }
+                },
+                version: {
+                    method: "general.version",
+                    data: { text: null },
+                    loaded: false,
+                    polling: false,
+                    nextPromise: null,
+                    replaceData: function(oldData, newData) {
+                        oldData.text = newData;
+                    }
                 }
             };
 

=== modified file 'src/maasserver/static/js/angular/factories/tests/test_general.js'
--- src/maasserver/static/js/angular/factories/tests/test_general.js	2015-10-04 21:01:20 +0000
+++ src/maasserver/static/js/angular/factories/tests/test_general.js	2015-10-21 19:48:17 +0000
@@ -51,7 +51,7 @@
     it("_data has expected keys", function() {
         expect(Object.keys(GeneralManager._data)).toEqual(
             ["node_actions", "device_actions", "architectures", "hwe_kernels",
-             "osinfo", "bond_options"]);
+             "osinfo", "bond_options", "version"]);
     });
 
     it("_data.node_actions has correct data", function() {
@@ -111,6 +111,16 @@
         expect(angular.isFunction(bond_options.replaceData)).toBe(true);
     });
 
+    it("_data.version has correct data", function() {
+        var version = GeneralManager._data.version;
+        expect(version.method).toBe("general.version");
+        expect(version.data).toEqual({ text: null });
+        expect(version.loaded).toBe(false);
+        expect(version.polling).toBe(false);
+        expect(version.nextPromise).toBeNull();
+        expect(angular.isFunction(version.replaceData)).toBe(true);
+    });
+
     describe("_getInternalData", function() {
 
         it("raises error for unknown data", function() {
@@ -146,7 +156,8 @@
             GeneralManager._data.architectures.loaded = true;
             GeneralManager._data.hwe_kernels.loaded = true;
             GeneralManager._data.osinfo.loaded = true;
-            GeneralManager._data.bond_options.loaded = false;
+            GeneralManager._data.bond_options.loaded = true;
+            GeneralManager._data.version.loaded = false;
             expect(GeneralManager.isLoaded()).toBe(false);
         });
 
@@ -157,6 +168,7 @@
             GeneralManager._data.hwe_kernels.loaded = true;
             GeneralManager._data.osinfo.loaded = true;
             GeneralManager._data.bond_options.loaded = true;
+            GeneralManager._data.version.loaded = true;
             expect(GeneralManager.isLoaded()).toBe(true);
         });
     });
@@ -404,7 +416,7 @@
             spyOn(GeneralManager, "_loadData").and.returnValue(
                 $q.defer().promise);
             GeneralManager.loadItems();
-            expect(GeneralManager._loadData.calls.count()).toBe(6);
+            expect(GeneralManager._loadData.calls.count()).toBe(7);
         });
 
         it("resolve defer once all resolve", function(done) {
@@ -414,6 +426,7 @@
                 $q.defer(),
                 $q.defer(),
                 $q.defer(),
+                $q.defer(),
                 $q.defer()
             ];
             var i = 0;

=== modified file 'src/maasserver/templates/maasserver/index.html'
--- src/maasserver/templates/maasserver/index.html	2015-09-29 07:21:52 +0000
+++ src/maasserver/templates/maasserver/index.html	2015-10-21 19:48:17 +0000
@@ -21,7 +21,7 @@
 
     {% include "maasserver/js-conf.html" %}
 </head>
-<body data-ng-init="site = '{{ global_options.site_name }}'">
+<body data-ng-init="site = '{{ global_options.site_name }}'" data-maas-version-reloader>
     <div class="wrapper maas-wrapper">
         <header class="banner global fixed" role="banner">
             <nav role="navigation" class="nav-primary nav-right">

=== modified file 'src/maasserver/websockets/handlers/general.py'
--- src/maasserver/websockets/handlers/general.py	2015-10-04 20:47:36 +0000
+++ src/maasserver/websockets/handlers/general.py	2015-10-21 19:48:17 +0000
@@ -34,6 +34,7 @@
     list_osystem_choices,
     list_release_choices,
 )
+from maasserver.utils.version import get_maas_version_ui
 from maasserver.websockets.base import Handler
 
 
@@ -49,6 +50,7 @@
             'device_actions',
             'random_hostname',
             'bond_options',
+            'version',
             ]
 
     def architectures(self, params):
@@ -126,3 +128,7 @@
             "lacp_rates": BOND_LACP_RATE_CHOICES,
             "xmit_hash_policies": BOND_XMIT_HASH_POLICY_CHOICES,
         }
+
+    def version(self, params):
+        """Return the MAAS version."""
+        return get_maas_version_ui()

=== modified file 'src/maasserver/websockets/handlers/tests/test_general.py'
--- src/maasserver/websockets/handlers/tests/test_general.py	2015-10-04 20:47:36 +0000
+++ src/maasserver/websockets/handlers/tests/test_general.py	2015-10-21 19:48:17 +0000
@@ -27,6 +27,7 @@
 from maasserver.testing.testcase import MAASServerTestCase
 from maasserver.websockets.handlers import general
 from maasserver.websockets.handlers.general import GeneralHandler
+from mock import sentinel
 
 
 class TestGeneralHandler(MAASServerTestCase):
@@ -121,3 +122,9 @@
             "lacp_rates": BOND_LACP_RATE_CHOICES,
             "xmit_hash_policies": BOND_XMIT_HASH_POLICY_CHOICES,
             }, handler.bond_options({}))
+
+    def test_version(self):
+        handler = GeneralHandler(factory.make_User(), {})
+        self.patch_autospec(
+            general, "get_maas_version_ui").return_value = sentinel.version
+        self.assertEquals(sentinel.version, handler.version({}))