launchpad-reviewers team mailing list archive
-
launchpad-reviewers team
-
Mailing list archive
-
Message #06275
[Merge] lp:~rharding/launchpad/combo_yui_tests4 into lp:launchpad
Richard Harding has proposed merging lp:~rharding/launchpad/combo_yui_tests4 into lp:launchpad with lp:~rharding/launchpad/combo_yui_tests as a prerequisite.
Requested reviews:
Launchpad code reviewers (launchpad-reviewers)
For more details, see:
https://code.launchpad.net/~rharding/launchpad/combo_yui_tests4/+merge/91915
= Summary =
Updating more of the YUI tests to be updated per the new convoy/buid dir setup.
See the first MP for the main details. I'm breaking the changes into multiple MP since this is going to be a giant diff due to touching each JS test file.
https://code.launchpad.net/~rharding/launchpad/combo_yui_tests/+merge/91478
== Tests in this batch ==
lib/lp/app/javascript/testing/tests/test_mockio.html
lib/lp/app/javascript/subscribers/tests/test_subscribers_list.html
lib/lp/app/javascript/tests/test_ajax_batch_navigator.html
lib/lp/app/javascript/tests/test_beta_notification.html
--
https://code.launchpad.net/~rharding/launchpad/combo_yui_tests4/+merge/91915
Your team Launchpad code reviewers is requested to review the proposed merge of lp:~rharding/launchpad/combo_yui_tests4 into lp:launchpad.
=== modified file 'lib/lp/app/javascript/subscribers/tests/test_subscribers_list.html'
--- lib/lp/app/javascript/subscribers/tests/test_subscribers_list.html 2011-08-10 08:43:17 +0000
+++ lib/lp/app/javascript/subscribers/tests/test_subscribers_list.html 2012-02-07 20:25:28 +0000
@@ -1,58 +1,77 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd";>
+<!--
+Copyright 2012 Canonical Ltd. This software is licensed under the
+GNU Affero General Public License version 3 (see the file LICENSE).
+-->
+
<html>
<head>
- <title>Launchpad subscriptions: subscribers list</title>
-
- <!-- YUI and test setup -->
- <script type="text/javascript"
- src="../../../../../canonical/launchpad/icing/yui/yui/yui.js">
- </script>
- <link rel="stylesheet" href="../../testing/test.css" />
- <script type="text/javascript"
- src="../../testing/testrunner.js"></script>
-
-
- <script type="text/javascript"
- src="../../client.js"></script>
- <script type="text/javascript"
- src="../../errors.js"></script>
- <script type="text/javascript"
- src="../../lp-names.js"></script>
- <script type="text/javascript"
- src="../../anim/anim.js"></script>
- <script type="text/javascript"
- src="../../formoverlay/formoverlay.js"></script>
- <script type="text/javascript"
- src="../../overlay/overlay.js"></script>
- <script type="text/javascript"
- src="../../anim/anim.js"></script>
- <script type="text/javascript"
- src="../../activator/activator.js"></script>
- <script type="text/javascript"
- src="../../lazr/lazr.js"></script>
- <script type="text/javascript"
- src="../../picker/picker_patcher.js"></script>
- <script type="text/javascript"
- src="../../picker/picker.js"></script>
- <script type="text/javascript"
- src="../../picker/person_picker.js"></script>
- <script type="text/javascript"
- src="../../extras/extras.js"></script>
-
- <!-- The module under test -->
- <script type="text/javascript"
- src="../subscribers_list.js"></script>
-
- <!-- The test suite -->
- <script type="text/javascript"
- src="test_subscribers_list.js"></script>
-
- <!-- Pretty up the sample html -->
- <style type="text/css">
- div#sample {margin:15px; width:200px; border:1px solid #999; padding:10px;}
- </style>
- </head>
- <body class="yui3-skin-sam">
- <!-- Example markup required by test suite -->
- <div id="test-root"></div>
- </body>
+ <title>Test subscribers_list</title>
+
+ <!-- YUI and test setup -->
+ <script type="text/javascript"
+ src="../../../../../../build/js/yui/yui/yui.js">
+ </script>
+ <link rel="stylesheet"
+ href="../../../../../../build/js/yui/console/assets/console-core.css" />
+ <link rel="stylesheet"
+ href="../../../../../../build/js/yui/console/assets/skins/sam/console.css" />
+ <link rel="stylesheet"
+ href="../../../../../../build/js/yui/test/assets/skins/sam/test.css" />
+
+ <script type="text/javascript"
+ src="../../../../../../build/js/lp/app/testing/testrunner.js"></script>
+
+ <link rel="stylesheet" href="../../../../app/javascript/testing/test.css" />
+
+ <!-- Dependencies -->
+ <script type="text/javascript"
+ src="../../../../../../build/js/lp/app/client.js"></script>
+ <script type="text/javascript"
+ src="../../../../../../build/js/lp/app/errors.js"></script>
+ <script type="text/javascript"
+ src="../../../../../../build/js/lp/app/lp-names.js"></script>
+ <script type="text/javascript"
+ src="../../../../../../build/js/lp/app/anim/anim.js"></script>
+ <script type="text/javascript"
+ src="../../../../../../build/js/lp/app/activator/activator.js"></script>
+ <script type="text/javascript"
+ src="../../../../../../build/js/lp/app/extras/extras.js"></script>
+ <script type="text/javascript"
+ src="../../../../../../build/js/lp/app/formoverlay/formoverlay.js"></script>
+ <script type="text/javascript"
+ src="../../../../../../build/js/lp/app/overlay/overlay.js"></script>
+ <script type="text/javascript"
+ src="../../../../../../build/js/lp/app/lazr/lazr.js"></script>
+ <script type="text/javascript"
+ src="../../../../../../build/js/lp/app/picker/picker.js"></script>
+ <script type="text/javascript"
+ src="../../../../../../build/js/lp/app/picker/person_picker.js"></script>
+ <script type="text/javascript"
+ src="../../../../../../build/js/lp/app/picker/picker_patcher.js"></script>
+
+
+ <!-- The module under test. -->
+ <script type="text/javascript" src="../subscribers_list.js"></script>
+
+ <!-- Any css assert for this module. -->
+ <!-- <link rel="stylesheet" href="../assets/subscribers_list-core.css" /> -->
+
+ <!-- The test suite. -->
+ <script type="text/javascript" src="test_subscribers_list.js"></script>
+
+ <!-- Pretty up the sample html -->
+ <style type="text/css">
+ div#sample {margin:15px; width:200px; border:1px solid #999; padding:10px;}
+ </style>
+
+ </head>
+ <body class="yui3-skin-sam">
+ <ul id="suites">
+ <!-- <li>lp.large_indicator.test</li> -->
+ <li>lp.app.subscribers.subscribers_list.test</li>
+ </ul>
+ <div id="test-root"></div>
+ </body>
</html>
=== modified file 'lib/lp/app/javascript/subscribers/tests/test_subscribers_list.js'
--- lib/lp/app/javascript/subscribers/tests/test_subscribers_list.js 2011-09-15 11:24:46 +0000
+++ lib/lp/app/javascript/subscribers/tests/test_subscribers_list.js 2012-02-07 20:25:28 +0000
@@ -1,2792 +1,2804 @@
-YUI().use('lp.testing.runner', 'test', 'console', 'node',
- 'lp.app.subscribers.subscribers_list',
- 'event', 'node-event-simulate', 'dump', function(Y) {
-
-var suite = new Y.Test.Suite("lp.app.subscribers.subscribers_list Tests");
-var module = Y.lp.app.subscribers.subscribers_list;
-
-
-/**
- * Set-up all the nodes required for subscribers list testing.
- */
-
-var subscriber_levels = {
- 'Level1': 'Subscriber level 1',
- 'Level2': 'Subscriber level 2',
- 'Level3': 'Subscriber level 3',
- 'Default': 'Default subscription level'
-};
-
-function setUpSubscribersList(root_node) {
- // Set-up subscribers list.
- var node = Y.Node.create('<div />')
- .set('id', 'other-subscribers-container');
- root_node.appendChild(node);
- var config = {
- container_box: '#other-subscribers-container',
- subscriber_levels: subscriber_levels,
- subscribers_label: "subscribers",
- unsubscribe_label: "Unsubscribe"
+/* Copyright (c) 2012, Canonical Ltd. All rights reserved. */
+
+YUI.add('lp.app.subscribers.subscribers_list.test', function (Y) {
+
+ var tests = Y.namespace('lp.app.subscribers.subscribers_list.test');
+ tests.suite = new Y.Test.Suite('subscribers_list Tests');
+
+ var module = Y.lp.app.subscribers.subscribers_list;
+
+ /**
+ * Set-up all the nodes required for subscribers list testing.
+ */
+ var subscriber_levels = {
+ 'Level1': 'Subscriber level 1',
+ 'Level2': 'Subscriber level 2',
+ 'Level3': 'Subscriber level 3',
+ 'Default': 'Default subscription level'
};
- return new module.SubscribersList(config);
-}
-
-
-/**
- * Test resetting of the no subscribers indication.
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersList constructor test',
-
- _should: {
- error: {
- test_no_container_error:
- new Error(
- 'Container node must be specified in config.container_box.'),
- test_multiple_containers_error:
- new Error(
- "Multiple container nodes for selector '.container' "+
- "present in the page. You need to be more explicit.")
- }
- },
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- },
-
- tearDown: function() {
- this.root.remove();
- },
-
- test_no_container_error: function() {
- // When there is no matching container node in the DOM tree,
- // an exception is thrown.
- var sl = new module.SubscribersList({
- container_box: '#not-found',
- subscriber_levels: []});
- },
-
- test_single_container: function() {
- // With an exactly single container node matches, all is well.
- var container_node = Y.Node.create('<div />')
- .set('id', 'container');
- this.root.appendChild(container_node);
- var list = new module.SubscribersList({
- container_box: '#container',
- subscriber_levels: []});
- Y.Assert.areSame(container_node, list.container_node);
- },
-
- test_multiple_containers_error: function() {
- // With two nodes matching the given CSS selector,
- // an exception is thrown.
- this.root.appendChild(
- Y.Node.create('<div />').addClass('container'));
- this.root.appendChild(
- Y.Node.create('<div />').addClass('container'));
- var sl = new module.SubscribersList({
- container_box: '.container',
- subscriber_levels: []});
- },
-
- test_subscriber_levels: function() {
- // Check that subscriber_levels are registered.
- var container_node = Y.Node.create('<div />')
- .set('id', 'container');
- this.root.appendChild(container_node);
- var list = new module.SubscribersList({
- container_box: '#container',
- subscriber_levels: subscriber_levels});
- var level;
- for (level in subscriber_levels) {
- if (subscriber_levels.hasOwnProperty(level)) {
- list._checkSubscriptionLevel(level);
- }
- }
- }
-}));
-
-
-/**
- * Test resetting of the no subscribers indication.
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersList.resetNoSubscribers() test',
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- },
-
- tearDown: function() {
- this.root.remove();
- },
-
- test_initially_empty: function() {
- // When the SubscribersList is set-up, it's initially
- // entirely empty.
- var subscribers_list = setUpSubscribersList(this.root);
- Y.Assert.isTrue(
- subscribers_list.container_node.all().isEmpty());
- },
-
- test_no_subscribers: function() {
- // When resetNoSubscribers() is called on an empty
- // SubscribersList, indication of no subscribers is added.
- var subscribers_list = setUpSubscribersList(this.root);
- subscribers_list.resetNoSubscribers();
- var no_subs_nodes = this.root.all(
- '.no-subscribers-indicator');
- Y.Assert.areEqual(1, no_subs_nodes.size());
- Y.Assert.areEqual('No other subscribers.',
- no_subs_nodes.item(0).get('text'));
- },
-
- test_no_subscribers_no_levels: function() {
- // When resetNoSubscribers() is called on an empty
- // SubscribersList, indication of no subscribers is added. If there
- // are no subscriber_levels, a different message is displayed.
- var subscribers_list = setUpSubscribersList(this.root);
- subscribers_list.subscriber_levels = [];
- subscribers_list.resetNoSubscribers();
- var no_subs_nodes = this.root.all(
- '.no-subscribers-indicator');
- Y.Assert.areEqual(1, no_subs_nodes.size());
- Y.Assert.areEqual('No subscribers.',
- no_subs_nodes.item(0).get('text'));
- },
-
- test_no_subscribers_force_hide: function() {
- // When resetNoSubscribers() is called on an empty
- // SubscribersList but with force_hide parameter set to true,
- // indication of no subscribers is not added.
- var subscribers_list = setUpSubscribersList(this.root);
- subscribers_list.resetNoSubscribers(true);
- var no_subs_nodes = this.root.all(
- '.no-subscribers-indicator');
- Y.Assert.areEqual(0, no_subs_nodes.size());
- },
-
- test_no_subscribers_force_hide_removal: function() {
- // When resetNoSubscribers() is called on an empty
- // SubscribersList which already has a no-subscribers
- // indication shown, it is removed.
- var subscribers_list = setUpSubscribersList(this.root);
- subscribers_list.resetNoSubscribers();
- subscribers_list.resetNoSubscribers(true);
- var no_subs_nodes = this.root.all(
- '.no-subscribers-indicator');
- Y.Assert.areEqual(0, no_subs_nodes.size());
- },
-
- test_subscribers_no_addition: function() {
- // When resetNoSubscribers() is called on a SubscribersList
- // with some subscribers, no indication of no subscribers is added.
- var subscribers_list = setUpSubscribersList(this.root);
- // Hack a section node into the list so it appears as if
- // there are subscribers.
- subscribers_list.container_node.appendChild(
- Y.Node.create('<div />')
- .addClass('subscribers-section'));
-
- // There is no indication of no subscribers added by
- // resetNoSubscribers.
- subscribers_list.resetNoSubscribers();
- var no_subs_nodes = this.root.all(
- '.no-subscribers-indicator');
- Y.Assert.isTrue(no_subs_nodes.isEmpty());
- },
-
- test_subscribers_remove_previous_indication: function() {
- // When resetNoSubscribers() is called on a SubscribersList
- // with some subscribers, existing indication of no subscribers
- // is removed.
- var subscribers_list = setUpSubscribersList(this.root);
- // Hack a section node into the list so it appears as if
- // there are subscribers.
- subscribers_list.container_node.appendChild(
- Y.Node.create('<div />')
- .addClass('subscribers-section'));
- subscribers_list.container_node.appendChild(
- Y.Node.create('<div />')
- .addClass('no-subscribers-indicator'));
-
- // There is no indication of no subscribers anymore after
- // the call to resetNoSubscribers.
- subscribers_list.resetNoSubscribers();
- var no_subs_nodes = this.root.all(
- '.no-subscribers-indicator');
- Y.Assert.isTrue(no_subs_nodes.isEmpty());
- }
-
-}));
-
-
-/**
- * Test activity/progress indication for the entire subscribers list.
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersList.startActivity() and stopActivity() test',
-
- _should: {
- error: {
- test_setActivityErrorIcon_error: true,
- test_setActivityText_error: true
- }
- },
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- },
-
- tearDown: function() {
- this.root.remove();
- },
-
- test_ensureActivityNode: function() {
- // With no activity node present, one is created and put
- // into the subscribers list container node.
- var subscribers_list = setUpSubscribersList(this.root);
- var node = subscribers_list._ensureActivityNode();
- Y.Assert.isNotNull(node);
- Y.Assert.isTrue(node.hasClass('global-activity-indicator'));
- Y.Assert.areSame(
- subscribers_list.container_node, node.get('parentNode'));
- },
-
- test_ensureActivityNode_contents: function() {
- // Created node contains an img tag with the spinner icon
- // and a span tag for the text.
- var subscribers_list = setUpSubscribersList(this.root);
- var node = subscribers_list._ensureActivityNode();
- var icon = node.one('img');
- Y.Assert.isNotNull(icon);
- Y.Assert.areEqual('file:///@@/spinner', icon.get('src'));
- var text = node.one('span');
- Y.Assert.isNotNull(text);
- Y.Assert.isTrue(text.hasClass('global-activity-text'));
- },
-
- test_ensureActivityNode_existing: function() {
- // When activity node already exists, it is returned
- // and no new one is created.
- var subscribers_list = setUpSubscribersList(this.root);
- var existing_node = subscribers_list._ensureActivityNode();
- var new_node = subscribers_list._ensureActivityNode();
- Y.Assert.areSame(existing_node, new_node);
- Y.Assert.areEqual(
- 1,
- subscribers_list
- .container_node
- .all('.global-activity-indicator')
- .size());
- },
-
- test_setActivityErrorIcon_error_icon: function() {
- // With the activity node passed in, error icon is set
- // when desired.
- var subscribers_list = setUpSubscribersList(this.root);
- var node = subscribers_list._ensureActivityNode();
- var icon_node = node.one('img');
- subscribers_list._setActivityErrorIcon(node, true);
- Y.Assert.areEqual('file:///@@/error', icon_node.get('src'));
- },
-
- test_setActivityErrorIcon_spinner_icon: function() {
- // With the activity node passed in, spinner icon is restored
- // when requested (error parameter !== true).
- var subscribers_list = setUpSubscribersList(this.root);
- var node = subscribers_list._ensureActivityNode();
- var icon_node = node.one('img');
- subscribers_list._setActivityErrorIcon(node, false);
- Y.Assert.areEqual('file:///@@/spinner', icon_node.get('src'));
- },
-
- test_setActivityErrorIcon_error: function() {
- // With non-activity node passed in, it fails.
- var subscribers_list = setUpSubscribersList(this.root);
- var node = Y.Node.create('<div />');
- subscribers_list._setActivityErrorIcon(node, true);
- },
-
- test_setActivityText: function() {
- // With activity node and text passed in, proper
- // text is set in the activity text node.
- var subscribers_list = setUpSubscribersList(this.root);
- var node = subscribers_list._ensureActivityNode();
- subscribers_list._setActivityText(node, "Blah");
- // Single whitespace is prepended to better separate
- // icon from the text.
- Y.Assert.areEqual(" Blah", node.one('span').get('text'));
- },
-
- test_setActivityText_error: function() {
- // With non-activity node passed in, it fails.
- var subscribers_list = setUpSubscribersList(this.root);
- var node = Y.Node.create('<div />');
- subscribers_list._setActivityText(node, "Blah");
- },
-
- test_startActivity: function() {
- // startActivity adds the spinner icon and sets the appropriate text.
- var subscribers_list = setUpSubscribersList(this.root);
- subscribers_list.startActivity("Blah");
-
- var node = subscribers_list._ensureActivityNode();
-
- Y.Assert.areEqual('file:///@@/spinner', node.one('img').get('src'));
- Y.Assert.areEqual(" Blah", node.one('span').get('text'));
- },
-
- test_startActivity_restores_state: function() {
- // startActivity removes the no-subscribers indicator if present
- // and restores the activity node icon.
- var subscribers_list = setUpSubscribersList(this.root);
- // Add a no-subscribers indication.
- subscribers_list.resetNoSubscribers();
- // Create an activity node and set the error icon.
- var node = subscribers_list._ensureActivityNode();
- subscribers_list._setActivityErrorIcon(node, true);
-
- // Call startActivity() and see how it restores everything.
- subscribers_list.startActivity();
- Y.Assert.areEqual('file:///@@/spinner', node.one('img').get('src'));
- Y.Assert.isNull(
- subscribers_list.container_node.one('.no-subscribers-indicator'));
- },
-
- test_stopActivity: function() {
- // stopActivity without parameters assumes a successful completion
- // of the activity, so it removes the activity node and restores
- // no-subscribers indication if needed.
- var subscribers_list = setUpSubscribersList(this.root);
- subscribers_list.startActivity("Blah");
- subscribers_list.stopActivity();
-
- var node = subscribers_list.container_node.one(
- '.global-activity-indicator');
- Y.Assert.isNull(node);
- // Indication of no subscribers is restored.
- Y.Assert.isNotNull(
- subscribers_list.container_node.one('.no-subscribers-indicator'));
- },
-
- test_stopActivity_noop: function() {
- // stopActivity without parameters assumes a successful completion
- // of the activity. If no activity was in progress, nothing happens.
- var subscribers_list = setUpSubscribersList(this.root);
- subscribers_list.stopActivity();
-
- var node = subscribers_list.container_node.one(
- '.global-activity-indicator');
- Y.Assert.isNull(node);
- },
-
- test_stopActivity_with_error_message: function() {
- // stopActivity with error message passed in creates an activity
- // node even if activity was not in progress and sets the error
- // icon and error text to the passed in message..
- var subscribers_list = setUpSubscribersList(this.root);
- subscribers_list.stopActivity("Problem!");
- var node = subscribers_list._ensureActivityNode();
- Y.Assert.areEqual('file:///@@/error', node.one('img').get('src'));
- Y.Assert.areEqual(" Problem!", node.one('span').get('text'));
-
- // Indication of no subscribers is not added.
- Y.Assert.isNull(
- subscribers_list.container_node.one('.no-subscribers-indicator'));
- }
-}));
-
-
-/**
- * Function to get a list of all the sections present in the
- * subscribers_list (a SubscribersList object).
- */
-function _getAllSections(subscribers_list) {
- var nodes = [];
- var node;
- var all = subscribers_list.container_node.all('.subscribers-section');
- node = all.shift();
- while (node !== undefined) {
- nodes.push(node);
- node = all.shift();
- }
- return nodes;
-}
-
-/**
- * Test subscribers section creation and helper methods.
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersList._getOrCreateSection() test',
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- },
-
- tearDown: function() {
- this.root.remove();
- },
-
- test_getSectionCSSClass: function() {
- // Returns a CSS class name to use for a section
- // for subscribers with a particular subscription level.
- var subscribers_list = setUpSubscribersList(this.root);
- Y.Assert.areEqual(
- 'subscribers-section-level3',
- subscribers_list._getSectionCSSClass('Level3'));
- },
-
- test_getSection: function() {
- // Gets a subscribers section for the subscription level.
- var subscribers_list = setUpSubscribersList(this.root);
-
- var section_node = Y.Node.create('<div />')
- .addClass('subscribers-section-level3')
- .addClass('subscribers-section');
- subscribers_list.container_node.appendChild(section_node);
-
- Y.Assert.areEqual(section_node,
- subscribers_list._getSection('level3'));
- },
-
- test_getSection_none: function() {
- // When there is no requested section, returns null.
- var subscribers_list = setUpSubscribersList(this.root);
-
- var section_node = Y.Node.create('<div />')
- .addClass('subscribers-section-level3')
- .addClass('subscribers-section');
- subscribers_list.container_node.appendChild(section_node);
-
- Y.Assert.isNull(subscribers_list._getSection('level1'));
- },
-
- test_createSectionNode: function() {
- // Creates a subscribers section for the given subscription level.
- var subscribers_list = setUpSubscribersList(this.root);
-
- var section_node = subscribers_list._createSectionNode('Level1');
-
- // A CSS class is added to the node for this particular level.
- Y.Assert.isTrue(
- section_node.hasClass('subscribers-section-level1'));
- // As well as a generic CSS class to indicate it's a section.
- Y.Assert.isTrue(section_node.hasClass('subscribers-section'));
-
- // Header is appropriate for the subscription level.
- var header = section_node.one('h3');
- Y.Assert.areEqual('Subscriber level 1', header.get('text'));
-
- // There is a separate node for the subscribers list in this section.
- Y.Assert.isNotNull(section_node.one('.subscribers-list'));
- },
-
- test_insertSectionNode: function() {
- // Inserts a section node in the subscribers list.
- var subscribers_list = setUpSubscribersList(this.root);
-
- var section_node = subscribers_list._createSectionNode('Level2');
-
- subscribers_list._insertSectionNode('Level2', section_node);
- Y.ArrayAssert.itemsAreEqual(
- [section_node], _getAllSections(subscribers_list));
- },
-
- test_insertSectionNode_before: function() {
- // Inserts a section node in front of the existing section
- // in the subscribers list.
- var subscribers_list = setUpSubscribersList(this.root);
-
- // Sections we'll be inserting in the order they should end up in.
- var section_node1 = subscribers_list._createSectionNode('Level1');
- var section_node2 = subscribers_list._createSectionNode('Level2');
-
- subscribers_list._insertSectionNode('Level2', section_node2);
- Y.ArrayAssert.itemsAreEqual(
- [section_node2],
- _getAllSections(subscribers_list));
-
- // Details section comes in front of the 'Level1' section.
- subscribers_list._insertSectionNode('Level1', section_node1);
- Y.ArrayAssert.itemsAreEqual(
- [section_node1, section_node2],
- _getAllSections(subscribers_list));
- },
-
- test_insertSectionNode_after: function() {
- // Inserts a section node after the existing section
- // in the subscribers list.
- var subscribers_list = setUpSubscribersList(this.root);
-
- // Sections we'll be inserting in the order they should end up in.
- var section_node1 = subscribers_list._createSectionNode('Level1');
- var section_node2 = subscribers_list._createSectionNode('Default');
-
- subscribers_list._insertSectionNode('Level1', section_node1);
- Y.ArrayAssert.itemsAreEqual(
- [section_node1],
- _getAllSections(subscribers_list));
-
- subscribers_list._insertSectionNode('Default', section_node2);
- Y.ArrayAssert.itemsAreEqual(
- [section_node1, section_node2],
- _getAllSections(subscribers_list));
- },
-
- test_insertSectionNode_full_list: function() {
- // Inserts a section node in the appropriate place in the
- // subscribers list for all the possible subscription levels.
- var subscribers_list = setUpSubscribersList(this.root);
-
- // Sections we'll be inserting in the order they should end up in.
- var section_node1 = subscribers_list._createSectionNode('Level1');
- var section_node2 = subscribers_list._createSectionNode('Level2');
- var section_node3 = subscribers_list._createSectionNode('Level3');
- var section_node4 = subscribers_list._createSectionNode('Default');
-
- subscribers_list._insertSectionNode('Level3', section_node3);
- Y.ArrayAssert.itemsAreEqual(
- [section_node3], _getAllSections(subscribers_list));
-
- subscribers_list._insertSectionNode('Level1', section_node1);
- Y.ArrayAssert.itemsAreEqual(
- [section_node1, section_node3],
- _getAllSections(subscribers_list));
-
- subscribers_list._insertSectionNode('Level2', section_node2);
- Y.ArrayAssert.itemsAreEqual(
- [section_node1, section_node2, section_node3],
- _getAllSections(subscribers_list));
-
- subscribers_list._insertSectionNode('Default', section_node4);
- Y.ArrayAssert.itemsAreEqual(
- [section_node1, section_node2, section_node3, section_node4],
- _getAllSections(subscribers_list));
- },
-
- test_getOrCreateSection_get_existing: function() {
- // When there is an existing section, _getOrCreateSection
- // returns the existing node.
- var subscribers_list = setUpSubscribersList(this.root);
-
- var section_node = subscribers_list._createSectionNode('Level2');
- subscribers_list._insertSectionNode('Level2', section_node);
-
- Y.Assert.areSame(section_node,
- subscribers_list._getOrCreateSection('Level2'));
-
- },
-
- test_getOrCreateSection_new: function() {
- // When there is no existing matching section, a new one
- // is created and added to the subscribers list.
- var subscribers_list = setUpSubscribersList(this.root);
-
- var section_node = subscribers_list._getOrCreateSection('Level3');
- Y.ArrayAssert.itemsAreEqual(
- [section_node],
- _getAllSections(subscribers_list));
- },
-
- test_getOrCreateSection_positioning: function() {
- // When new sections are created, they are inserted into proper
- // positions using _insertSectionNode.
- var subscribers_list = setUpSubscribersList(this.root);
-
- var section_node2 = subscribers_list._getOrCreateSection('Level3');
- var section_node1 = subscribers_list._getOrCreateSection(
- 'Level1');
- Y.ArrayAssert.itemsAreEqual(
- [section_node1, section_node2],
- _getAllSections(subscribers_list));
- },
-
- test_getOrCreateSection_removes_no_subscribers_indication: function() {
- // When there is a div indicating no subscribers, _getOrCreateSection
- // removes it because it's adding a section where subscribers are
- // to come in.
- var subscribers_list = setUpSubscribersList(this.root);
-
- // Add a div saying 'No other subscribers.'
- subscribers_list.resetNoSubscribers();
- Y.Assert.isNotNull(this.root.one('.no-subscribers-indicator'));
-
- // And there is no matching div after _getOrCreateSection call.
- subscribers_list._getOrCreateSection('Level3');
- Y.Assert.isNull(this.root.one('.no-subscribers-indicator'));
- }
-
-}));
-
-
-/**
- * Test removal of a subscribers section.
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersList._removeSectionNodeIfEmpty() test',
-
- _should: {
- error: {
- test_sectionNodeHasSubscribers_error:
- new Error(
- 'No div.subscribers-list found inside the passed `node`.'),
- test_removeSectionNodeIfEmpty_non_section_error:
- new Error(
- 'Node is not a section node.')
- }
- },
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- },
-
- tearDown: function() {
- this.root.remove();
- },
-
- test_sectionNodeHasSubscribers_error: function() {
- // When called on a node not containing the subscribers list,
- // it throws an error.
- var subscribers_list = setUpSubscribersList(this.root);
- var node = Y.Node.create('<div />');
- subscribers_list._sectionNodeHasSubscribers(node);
- },
-
- test_sectionNodeHasSubscribers_no_subscribers: function() {
- // When called on a proper section node but with no subscribers,
- // it returns false.
- var subscribers_list = setUpSubscribersList(this.root);
- var node = subscribers_list._getOrCreateSection('Level3');
- Y.Assert.isFalse(subscribers_list._sectionNodeHasSubscribers(node));
- },
-
- test_sectionNodeHasSubscribers_subscribers: function() {
- // When called on a proper section node with subscribers,
- // it returns true.
- var subscribers_list = setUpSubscribersList(this.root);
- var node = subscribers_list._getOrCreateSection('Level3');
- var subscriber = Y.Node.create('<div />')
- .addClass('subscriber');
- node.one('.subscribers-list').appendChild(subscriber);
- Y.Assert.isTrue(subscribers_list._sectionNodeHasSubscribers(node));
- },
-
- test_removeSectionNodeIfEmpty_noop: function() {
- // When there is no requested section, nothing happens.
- var subscribers_list = setUpSubscribersList(this.root);
- var section_node = subscribers_list._getSection('Level3');
- subscribers_list._removeSectionNodeIfEmpty(section_node);
- },
-
- test_removeSectionNodeIfEmpty_non_section_error: function() {
- // When called on a node which is not a section, it throws
- // an exception.
- var subscribers_list = setUpSubscribersList(this.root);
- var section_node = Y.Node.create('<div />');
- subscribers_list._removeSectionNodeIfEmpty(section_node);
- },
-
- test_removeSectionNodeIfEmpty_remove: function() {
- // When there is an empty section, it's removed.
- var subscribers_list = setUpSubscribersList(this.root);
- var section_node = subscribers_list._getOrCreateSection('Level3');
-
- subscribers_list._removeSectionNodeIfEmpty(section_node);
- Y.ArrayAssert.itemsAreEqual(
- [],
- _getAllSections(subscribers_list));
-
- // Indication that there are no subscribers is added.
- Y.Assert.isNotNull(this.root.one('.no-subscribers-indicator'));
- },
-
- test_removeSectionNodeIfEmpty_keep: function() {
- // When there is a section with a subscriber, it's not removed.
- var subscribers_list = setUpSubscribersList(this.root);
- var section_node = subscribers_list._getOrCreateSection('Level3');
-
- // Add a subscriber.
- section_node.one('.subscribers-list').appendChild(
- Y.Node.create('<div />')
- .addClass('subscriber'));
-
- subscribers_list._removeSectionNodeIfEmpty(section_node);
- Y.ArrayAssert.itemsAreEqual(
- [section_node],
- _getAllSections(subscribers_list));
- // Indication that there are no subscribers is not added.
- Y.Assert.isNull(this.root.one('.no-subscribers-indicator'));
- },
-
- test_removeSectionNodeIfEmpty_keeps_others: function() {
- // With two empty sections, only the requested one is removed.
- var subscribers_list = setUpSubscribersList(this.root);
- var section_node1 = subscribers_list._getOrCreateSection('Level3');
- var section_node2 = subscribers_list._getOrCreateSection(
- 'Level1');
-
- var section_node = subscribers_list._getSection('Level3');
- subscribers_list._removeSectionNodeIfEmpty(section_node);
- Y.ArrayAssert.itemsAreEqual(
- [section_node2],
- _getAllSections(subscribers_list));
- // Indication that there are no subscribers is not added.
- Y.Assert.isNull(this.root.one('.no-subscribers-indicator'));
- }
-
-}));
-
-
-/**
- * Test adding of subscribers and relevant helper methods.
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersList.addSubscriber() test',
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- },
-
- tearDown: function() {
- this.root.remove();
- },
-
- _should: {
- error: {
- test_validateSubscriber_no_name_error:
- new Error('No `name` passed in `subscriber`.'),
- test_addSubscriber_incorrect_level:
- new Error(
- 'Level "Test" is not an acceptable subscription level.'),
- test_addSubscriber_not_in_section_error:
- new Error(
- "Matching subscriber node doesn't seem to be in any " +
- "subscribers list sections.")
- }
- },
-
- test_getNodeIdForSubscriberName: function() {
- // Returns a CSS class name to use as the ID for subscribers
- // prefixed with 'subscriber-'.
- // Uses launchpad_to_css for escaping (eg. it replaces '+' with '_y').
- var subscribers_list = setUpSubscribersList(this.root);
- Y.Assert.areEqual(
- 'subscriber-danilo_y',
- subscribers_list._getNodeIdForSubscriberName('danilo+'));
- },
-
- test_validateSubscriber: function() {
- // Ensures a passed in subscriber object has at least the
- // `name` attribute. Presets display_name and web_link
- // values based on it.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- subscriber = subscribers_list._validateSubscriber(subscriber);
- Y.Assert.areEqual('user', subscriber.name);
- Y.Assert.areEqual('user', subscriber.display_name);
- Y.Assert.areEqual('/~user', subscriber.web_link);
- },
-
- test_validateSubscriber_no_name_error: function() {
- // When no name attribute is present, an exception is thrown.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { };
- subscribers_list._validateSubscriber(subscriber);
- },
-
- test_validateSubscriber_no_overriding: function() {
- // Attributes display_name and web_link are not overridden if
- // already set.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = {
- name: 'user',
- display_name: 'User Name',
- web_link: 'http://launchpad.net/'
- };
- subscriber = subscribers_list._validateSubscriber(subscriber);
- Y.Assert.areEqual('user', subscriber.name);
- Y.Assert.areEqual('User Name', subscriber.display_name);
- Y.Assert.areEqual('http://launchpad.net/', subscriber.web_link);
- },
-
- test_createSubscriberNode: function() {
- // When passed a subscriber object, it constructs a node
- // containing a link to the subscriber (using web_link for the
- // link target, and display name for the text).
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = {
- name: 'user',
- display_name: 'User Name',
- web_link: 'http://launchpad.net/~user',
- display_subscribed_by: 'Subscribed by Someone (someone)'
- };
- var node = subscribers_list._createSubscriberNode(subscriber);
- Y.Assert.isTrue(node.hasClass('subscriber'));
-
- var link = node.one('a');
- Y.Assert.areEqual('http://launchpad.net/~user', link.get('href'));
- Y.Assert.areEqual(
- 'Subscribed by Someone (someone)', link.get('title'));
- var text = link.one('span');
- Y.Assert.areEqual('User Name', text.get('text'));
- Y.Assert.isTrue(text.hasClass('sprite'));
- Y.Assert.isTrue(text.hasClass('person'));
-
- },
-
- test_createSubscriberNode_missing_display_subscribed_by: function() {
- // When passed a subscriber object with no 'display_subscribed_by'
- // attribute then the title is simply not set but shows up
- // as a null string.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = {
- name: 'user',
- display_name: 'User Name',
- web_link: 'http://launchpad.net/~user'
- };
- var node = subscribers_list._createSubscriberNode(subscriber);
- Y.Assert.isTrue(node.hasClass('subscriber'));
-
- var link = node.one('a');
- Y.Assert.areEqual('http://launchpad.net/~user', link.get('href'));
- Y.Assert.areEqual('', link.get('title'));
- },
-
- test_createSubscriberNode_display_name_truncated: function() {
- // The display name displayed should be truncted to 20 characters.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = {
- name: 'user',
- display_name: 'Really Really Long Name',
- web_link: 'http://launchpad.net/~user'
- };
- var node = subscribers_list._createSubscriberNode(subscriber);
- var link = node.one('a');
- var text = link.one('span');
- Y.Assert.areEqual('Really Really Lon...', text.get('text'));
- },
-
- test_createSubscriberNode_team: function() {
- // When passed a subscriber object which has is_team === true,
- // a constructed node uses a 'sprite team' CSS classes instead
- // of 'sprite person' for display.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = {
- name: 'team',
- display_name: 'Team Name',
- web_link: 'http://launchpad.net/~team',
- is_team: true
- };
- var node = subscribers_list._createSubscriberNode(subscriber);
- var link_text = node.one('a span');
- Y.Assert.isTrue(link_text.hasClass('sprite'));
- Y.Assert.isTrue(link_text.hasClass('team'));
- },
-
- test_addSubscriber: function() {
- // When there is no subscriber in the subscriber list,
- // a new node is constructed and the appropriate section is added.
- var subscribers_list = setUpSubscribersList(this.root);
- var node = subscribers_list.addSubscriber(
- { name: 'user' }, 'Level2');
-
- // Node is constructed using _createSubscriberNode.
- Y.Assert.isTrue(node.hasClass('subscriber'));
- // And the ID is set inside addSubscriber() method.
- Y.Assert.areEqual('subscriber-user', node.get('id'));
-
- // And it nested in the subscribers-list of a 'Level3' section.
- var list_node = node.ancestor('.subscribers-list');
- Y.Assert.isNotNull(list_node);
- var section_node = list_node.ancestor('.subscribers-section-level2');
- Y.Assert.isNotNull(section_node);
- },
-
- test_addSubscriber_no_levels: function() {
- // Check that addSubscriber works if there are no subscription levels.
- var container_node = Y.Node.create('<div />')
+
+ function setUpSubscribersList(root_node) {
+ // Set-up subscribers list.
+ var node = Y.Node.create('<div />')
.set('id', 'other-subscribers-container');
- this.root.appendChild(container_node);
+ root_node.appendChild(node);
var config = {
container_box: '#other-subscribers-container',
- subscriber_levels: [],
+ subscriber_levels: subscriber_levels,
subscribers_label: "subscribers",
unsubscribe_label: "Unsubscribe"
};
- var subscribers_list = new module.SubscribersList(config);
-
- var node = subscribers_list.addSubscriber(
- { name: 'user' }, '');
-
- // Node is constructed using _createSubscriberNode.
- Y.Assert.isTrue(node.hasClass('subscriber'));
- // And the ID is set inside addSubscriber() method.
- Y.Assert.areEqual('subscriber-user', node.get('id'));
-
- // And it nested in the subscribers-list of a 'Default' section with
- // no header.
- var list_node = node.ancestor('.subscribers-list');
- Y.Assert.isNotNull(list_node);
- var section_node = list_node.ancestor(
- '.subscribers-section-default');
- Y.Assert.isNotNull(section_node);
- var header_node = section_node.one('h3');
- Y.Assert.isNull(header_node);
- },
-
- test_addSubscriber_incorrect_level: function() {
- // When an incorrect level is passed in, an exception is thrown.
- var subscribers_list = setUpSubscribersList(this.root);
- subscribers_list.addSubscriber(
- { name: 'user' }, 'Test');
- },
-
- test_addSubscriber_change_level: function() {
- // addSubscriber also allows changing a subscribtion level
- // for a subscriber when they are moved to a different section.
- var subscribers_list = setUpSubscribersList(this.root);
- var node = subscribers_list.addSubscriber(
- { name: 'user' }, 'Level2');
- Y.Assert.isNotNull(node.ancestor('.subscribers-section-level2'));
-
- // Move the subscriber to lifecycle section.
- node = subscribers_list.addSubscriber(
- { name: 'user' }, 'Level3');
- // It's now in 'Level3' section.
- Y.Assert.isNotNull(node.ancestor('.subscribers-section-level3'));
- // And 'Level3' section is removed.
- Y.Assert.isNull(subscribers_list._getSection('Level2'));
- },
-
- test_addSubscriber_not_in_section_error: function() {
- // addSubscriber throws an exception if a subscriber node is found,
- // but it is not properly nested inside a subscribers-section node.
- var subscribers_list = setUpSubscribersList(this.root);
- var node = Y.Node.create('<div />')
- .set('id', 'subscriber-user');
- // We hack the node directly into the entire subscribers list node.
- subscribers_list.container_node.appendChild(node);
-
- // And addSubscriber now throws an exception.
- subscribers_list.addSubscriber(
- { name: 'user' }, 'Level3');
- },
-
- test_addSubscriber_ordering: function() {
- // With multiple subscribers being added to the same section,
- // the last one is listed first.
- var subscribers_list = setUpSubscribersList(this.root);
- var node1 = subscribers_list.addSubscriber(
- { name: 'user1' }, 'Level3');
- var node2 = subscribers_list.addSubscriber(
- { name: 'user2' }, 'Level3');
-
- var list_node = subscribers_list._getSection('Level3')
- .one('.subscribers-list');
- var all_subscribers = list_node.all('.subscriber');
-
- var returned_nodes = [];
- var index;
- for (index = 0; index < all_subscribers.size(); index++) {
- returned_nodes.push(all_subscribers.item(index));
- }
- Y.ArrayAssert.itemsAreSame(
- [node2, node1],
- returned_nodes);
- },
-
- test_addSubscriber_unsubscribe_callback: function() {
- // When config.unsubscribe_callback is passed in,
- // addUnsubscribeAction(subscriber, callback) is
- // called as well.
-
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- var callback = function() {};
-
- var callback_setup = false;
- subscribers_list.addUnsubscribeAction = function(
- unsub_subscriber, unsub_callback) {
- callback_setup = true;
- Y.Assert.areSame(subscriber, unsub_subscriber);
- Y.Assert.areSame(callback, unsub_callback);
- };
- subscribers_list.addSubscriber(subscriber, 'Level3',
- { unsubscribe_callback: callback });
- // Setting up a callback was performed.
- Y.Assert.isTrue(callback_setup);
- }
-
-}));
-
-
-/**
- * Test adding of unsubscribe action for a subscriber, removal of subscribers
- * and relevant helper methods.
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersList.addUnsubscribeAction() and ' +
- 'removeSubscriber() test',
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- },
-
- tearDown: function() {
- this.root.remove();
- },
-
- _should: {
- error: {
- test_getSubscriberNode_error:
- new Error('Subscriber is not present in the subscribers list. ' +
- 'Please call addSubscriber(subscriber) first.'),
- test_addUnsubscribeAction_error:
- new Error('Passed in callback for unsubscribe action ' +
- 'is not a function.'),
- test_removeSubscriber_error:
- new Error(
- 'Subscriber is not present in the subscribers list. ' +
- 'Please call addSubscriber(subscriber) first.'),
- test_removeSubscriber_not_in_section_error:
- new Error(
- "Matching subscriber node doesn't seem to be in any " +
- "subscribers list sections.")
- }
- },
-
- test_getSubscriberNode: function() {
- // Gets a subscriber node from the subscribers list when present.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- var node = subscribers_list.addSubscriber(subscriber, 'Level3');
- Y.Assert.areSame(
- node, subscribers_list._getSubscriberNode(subscriber));
- },
-
- test_getSubscriberNode_error: function() {
- // When subscriber node is not present, throws an error.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- subscribers_list._getSubscriberNode(subscriber);
- },
-
- test_getOrCreateActionsNode: function() {
- // When no actions node is present, one is created, appended
- // to the subscriber node, and returned.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber_node = subscribers_list.addSubscriber(
- { name: 'user' }, 'Level1');
- var actions_node = subscribers_list._getOrCreateActionsNode(
- subscriber_node);
- // Newly created node has 'subscriber-actions' CSS class.
- Y.Assert.isTrue(actions_node.hasClass('subscriber-actions'));
-
- // It is also nested inside the subscriber_node.
- Y.Assert.areSame(subscriber_node, actions_node.get('parentNode'));
- },
-
- test_getOrCreateActionsNode_already_exists: function() {
- // When actions node is present, it is returned.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber_node = subscribers_list.addSubscriber(
- { name: 'user' }, 'Level1');
- var old_actions_node = subscribers_list._getOrCreateActionsNode(
- subscriber_node);
- var new_actions_node = subscribers_list._getOrCreateActionsNode(
- subscriber_node);
- Y.Assert.areSame(old_actions_node, new_actions_node);
- },
-
- test_addUnsubscribeAction_node: function() {
- // Adding an unsubscribe action creates an unsubscribe icon
- // nested inside the actions node for the subscriber.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user', display_name: 'User Name' };
- var callback = function() {};
-
- var subscriber_node = subscribers_list.addSubscriber(
- subscriber, 'Level1');
- subscribers_list.addUnsubscribeAction(subscriber, callback);
- // An actions node is created.
- var actions_node = subscriber_node.one('.subscriber-actions');
- Y.Assert.isNotNull(actions_node);
- // It contains an A tag for the unsubscribe action.
- var unsub_node = actions_node.one('a.unsubscribe-action');
- Y.Assert.isNotNull(unsub_node);
- Y.Assert.areEqual('Unsubscribe User Name', unsub_node.get('title'));
- var unsub_icon = unsub_node.one('img');
- Y.Assert.isNotNull(unsub_icon);
- Y.Assert.areEqual('Remove', unsub_icon.get('alt'));
- // Getting a URI returns an absolute one, and with this being run
- // from the local file system, that's what we get.
- Y.Assert.areEqual('file:///@@/remove', unsub_icon.get('src'));
- },
-
- test_addUnsubscribeAction_node_exists: function() {
- // When an unsubscribe node already exists, a new one is not created.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user', display_name: 'User Name' };
- var callback = function() {};
- var subscriber_node = subscribers_list.addSubscriber(
- subscriber, 'Level1');
- subscribers_list.addUnsubscribeAction(subscriber, callback);
- var unsub_node = subscriber_node.one('a.unsubscribe-action');
-
- subscribers_list.addUnsubscribeAction(subscriber, callback);
- var unsub_nodes = subscriber_node.all('a.unsubscribe-action');
- Y.Assert.areEqual(1, unsub_nodes.size());
- Y.Assert.areSame(unsub_node, unsub_nodes.item(0));
- },
-
- test_addUnsubscribeAction_error: function() {
- // Adding an unsubscribe action with callback not a function
- // fails with an exception.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- var subscriber_node = subscribers_list.addSubscriber(
- subscriber, 'Level1');
- subscribers_list.addUnsubscribeAction(subscriber, "not-function");
- },
-
- test_addUnsubscribeAction_callback_on_click: function() {
- // When unsubscribe link is clicked, callback is activated
- // and passed in the subscribers_list and subscriber parameters.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user', display_name: 'User Name' };
-
- var callback_called = false;
- var callback = function(my_list, my_subscriber) {
- callback_called = true;
- Y.Assert.areSame(subscribers_list, my_list);
- Y.Assert.areSame(subscriber, my_subscriber);
- };
- var subscriber_node = subscribers_list.addSubscriber(
- subscriber, 'Level1');
- subscribers_list.addUnsubscribeAction(subscriber, callback);
- var unsub_node = subscriber_node.one('a.unsubscribe-action');
- unsub_node.simulate('click');
-
- Y.Assert.isTrue(callback_called);
- },
-
- test_removeSubscriber_error: function() {
- // Removing a non-existent subscriber fails with an error.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- subscribers_list.removeSubscriber(subscriber);
- },
-
- test_removeSubscriber_section_removed: function() {
- // Removing a subscriber works when the subscriber is in the list.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- var subscriber_node = subscribers_list.addSubscriber(
- subscriber, 'Level3');
- var section_node = subscriber_node.ancestor('.subscribers-section');
- subscribers_list.removeSubscriber(subscriber);
- // Entire section is removed along with the subscriber.
- Y.Assert.areEqual(0, _getAllSections(subscribers_list).length);
- },
-
- test_removeSubscriber_section_remains: function() {
- // Removing a subscriber works when the subscriber is in the list.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- var other_node = subscribers_list.addSubscriber(
- { name: 'other' }, 'Level3');
- var subscriber_node = subscribers_list.addSubscriber(
- subscriber, 'Level3');
- var section_node = subscriber_node.ancestor('.subscribers-section');
- subscribers_list.removeSubscriber(subscriber);
- // Section is not removed because it still has 'other' subscriber.
- var all_sections = _getAllSections(subscribers_list);
- Y.Assert.areEqual(1, all_sections.length);
- // User is removed.
- Y.Assert.isNull(all_sections[0].one('#subscriber-user'));
- // Other is still in the list.
- Y.Assert.areSame(
- other_node, all_sections[0].one('#subscriber-other'));
- },
-
- test_removeSubscriber_not_in_section_error: function() {
- // If subscriber is not in a section, an exception is thrown.
- var subscribers_list = setUpSubscribersList(this.root);
- var node = Y.Node.create('<div />')
- .set('id', 'subscriber-user');
- // We hack the node directly into the entire subscribers list node.
- subscribers_list.container_node.appendChild(node);
- subscribers_list.removeSubscriber({ name: 'user' });
- }
-}));
-
-
-/**
- * Test showing/stopping indication of activity for a subscriber.
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersList.indicateSubscriberActivity() and ' +
- 'SubscribersList.stopSubscriberActivity() test',
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- // Monkey-patch animation duration to make the tests quicker.
- this.anim_duration = Y.lp.anim.flash_in.defaults.duration;
- Y.lp.anim.flash_in.defaults.duration = 0;
- },
-
- tearDown: function() {
- this.root.remove();
- Y.lp.anim.flash_in.defaults.duration = this.anim_duration;
- },
-
- _should: {
- error: {
- test_indicateSubscriberActivity_error:
- new Error('Subscriber is not present in the subscribers list. ' +
- 'Please call addSubscriber(subscriber) first.'),
- test_stopSubscriberActivity_error:
- new Error('Subscriber is not present in the subscribers list. ' +
- 'Please call addSubscriber(subscriber) first.')
- }
- },
-
- test_indicateSubscriberActivity_error: function() {
- // When subscriber is not in the list, fails with an exception.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- subscribers_list.indicateSubscriberActivity(subscriber);
- },
-
- test_indicateSubscriberActivity_node: function() {
- // Creates a node with spinner image in it.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- var node = subscribers_list.addSubscriber(subscriber, 'Level3');
- subscribers_list.indicateSubscriberActivity(subscriber);
-
- // This is the created node.
- var progress_node = node.one('.subscriber-activity-indicator');
- Y.Assert.isNotNull(progress_node);
- var progress_icon = progress_node.one('img');
- // We get an absolute URI, instead of the relative one which
- // the code sets. Since the test runs from the local file system,
- // that means "file://".
- Y.Assert.areEqual('file:///@@/spinner', progress_icon.get('src'));
- },
-
- test_indicateSubscriberActivity_actions_hidden: function() {
- // If there are any actions (in an actions node), they are
- // all hidden.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- var node = subscribers_list.addSubscriber(subscriber, 'Level3');
- var actions_node = subscribers_list._getOrCreateActionsNode(node);
-
- subscribers_list.indicateSubscriberActivity(subscriber);
- Y.Assert.areEqual('none', actions_node.getStyle('display'));
- },
-
- test_stopSubscriberActivity_error: function() {
- // When subscriber is not in the list, fails with an exception.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- subscribers_list.stopSubscriberActivity(subscriber);
- },
-
- test_stopSubscriberActivity_noop: function() {
- // When there's no activity in progress, nothing happens.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- var node = subscribers_list.addSubscriber(subscriber, 'Level3');
- subscribers_list.stopSubscriberActivity(subscriber);
- },
-
- test_stopSubscriberActivity_spinner_removed: function() {
- // When there is some activity in progress, spinner is removed.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- var node = subscribers_list.addSubscriber(subscriber, 'Level3');
- // Create the spinner.
- subscribers_list.indicateSubscriberActivity(subscriber);
- // And remove it.
- subscribers_list.stopSubscriberActivity(subscriber);
- Y.Assert.isNull(node.one('.subscriber-activity-indicator'));
- },
-
- test_stopSubscriberActivity_actions_restored: function() {
- // When there is some activity in progress, spinner is removed.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- var node = subscribers_list.addSubscriber(subscriber, 'Level3');
- var actions_node = subscribers_list._getOrCreateActionsNode(node);
- // Hide actions.
- actions_node.setStyle('display', 'none');
- // And restore actions.
- subscribers_list.stopSubscriberActivity(subscriber);
- Y.Assert.areEqual('inline', actions_node.getStyle('display'));
- },
-
- test_stopSubscriberActivity_success_callback: function() {
- // When we are indicating successful/failed operation,
- // green_flash/red_flash animation is executed and callback
- // function is called when it ends.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- subscribers_list.addSubscriber(subscriber, 'Level3');
- var callback_called = false;
- var callback = function() {
- callback_called = true;
- };
-
- subscribers_list.stopSubscriberActivity(
- subscriber, true, callback);
- // Callback is not called immediatelly.
- Y.Assert.isFalse(callback_called);
- this.wait(function() {
- // But after waiting for animation to complete,
- // callback is called.
+ return new module.SubscribersList(config);
+ }
+
+ /**
+ * Set-up all the nodes required for SubscribersLoader.
+ */
+ function setUpLoader(root_node, config, barebone) {
+ // Set-up subscribers list node.
+ var node = Y.Node.create('<div />')
+ .set('id', 'other-subscribers-container');
+ var container_config = {
+ container_box: '#other-subscribers-container',
+ subscriber_levels: subscriber_levels,
+ subscribe_me_level: 'Level1',
+ subscribe_someone_else_level: 'Level1',
+ default_subscriber_level: 'Default'
+ };
+ if (barebone !== true) {
+ container_config.context = {
+ web_link: '/base', self_link: '/thing/1' };
+ container_config.subscribers_details_view = '/+details';
+ }
+ root_node.appendChild(node);
+ if (Y.Lang.isValue(config)) {
+ config = Y.mix(container_config, config);
+ } else {
+ config = container_config;
+ }
+ window.LP = { links: { me : "/~viewer" } };
+ return new module.SubscribersLoader(config);
+ }
+
+ /**
+ * Function to get a list of all the sections present in the
+ * subscribers_list (a SubscribersList object).
+ */
+ function _getAllSections(subscribers_list) {
+ var nodes = [];
+ var node;
+ var all = subscribers_list.container_node.all('.subscribers-section');
+ node = all.shift();
+ while (node !== undefined) {
+ nodes.push(node);
+ node = all.shift();
+ }
+ return nodes;
+ }
+
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersList constructor test',
+
+ _should: {
+ error: {
+ test_no_container_error:
+ new Error(
+ 'Container node must be specified in ' +
+ 'config.container_box.'),
+ test_multiple_containers_error:
+ new Error(
+ "Multiple container nodes for selector '.container' "+
+ "present in the page. You need to be more explicit.")
+ }
+ },
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ },
+
+ test_library_exists: function () {
+ Y.Assert.isObject(Y.lp.app.subscribers.subscribers_list,
+ "We should be able to locate the " +
+ "lp.app.subscribers.subscribers_list module");
+ },
+ test_no_container_error: function() {
+ // When there is no matching container node in the DOM tree,
+ // an exception is thrown.
+ var sl = new module.SubscribersList({
+ container_box: '#not-found',
+ subscriber_levels: []});
+ },
+
+ test_single_container: function() {
+ // With an exactly single container node matches, all is well.
+ var container_node = Y.Node.create('<div />')
+ .set('id', 'container');
+ this.root.appendChild(container_node);
+ var list = new module.SubscribersList({
+ container_box: '#container',
+ subscriber_levels: []});
+ Y.Assert.areSame(container_node, list.container_node);
+ },
+
+ test_multiple_containers_error: function() {
+ // With two nodes matching the given CSS selector,
+ // an exception is thrown.
+ this.root.appendChild(
+ Y.Node.create('<div />').addClass('container'));
+ this.root.appendChild(
+ Y.Node.create('<div />').addClass('container'));
+ var sl = new module.SubscribersList({
+ container_box: '.container',
+ subscriber_levels: []});
+ },
+
+ test_subscriber_levels: function() {
+ // Check that subscriber_levels are registered.
+ var container_node = Y.Node.create('<div />')
+ .set('id', 'container');
+ this.root.appendChild(container_node);
+ var list = new module.SubscribersList({
+ container_box: '#container',
+ subscriber_levels: subscriber_levels});
+ var level;
+ for (level in subscriber_levels) {
+ if (subscriber_levels.hasOwnProperty(level)) {
+ list._checkSubscriptionLevel(level);
+ }
+ }
+ }
+
+ }));
+
+ /**
+ * Test resetting of the no subscribers indication.
+ */
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersList.resetNoSubscribers() test',
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ },
+
+ test_initially_empty: function() {
+ // When the SubscribersList is set-up, it's initially
+ // entirely empty.
+ var subscribers_list = setUpSubscribersList(this.root);
+ Y.Assert.isTrue(
+ subscribers_list.container_node.all().isEmpty());
+ },
+
+ test_no_subscribers: function() {
+ // When resetNoSubscribers() is called on an empty
+ // SubscribersList, indication of no subscribers is added.
+ var subscribers_list = setUpSubscribersList(this.root);
+ subscribers_list.resetNoSubscribers();
+ var no_subs_nodes = this.root.all(
+ '.no-subscribers-indicator');
+ Y.Assert.areEqual(1, no_subs_nodes.size());
+ Y.Assert.areEqual('No other subscribers.',
+ no_subs_nodes.item(0).get('text'));
+ },
+
+ test_no_subscribers_no_levels: function() {
+ // When resetNoSubscribers() is called on an empty
+ // SubscribersList, indication of no subscribers is added. If there
+ // are no subscriber_levels, a different message is displayed.
+ var subscribers_list = setUpSubscribersList(this.root);
+ subscribers_list.subscriber_levels = [];
+ subscribers_list.resetNoSubscribers();
+ var no_subs_nodes = this.root.all(
+ '.no-subscribers-indicator');
+ Y.Assert.areEqual(1, no_subs_nodes.size());
+ Y.Assert.areEqual('No subscribers.',
+ no_subs_nodes.item(0).get('text'));
+ },
+
+ test_no_subscribers_force_hide: function() {
+ // When resetNoSubscribers() is called on an empty
+ // SubscribersList but with force_hide parameter set to true,
+ // indication of no subscribers is not added.
+ var subscribers_list = setUpSubscribersList(this.root);
+ subscribers_list.resetNoSubscribers(true);
+ var no_subs_nodes = this.root.all(
+ '.no-subscribers-indicator');
+ Y.Assert.areEqual(0, no_subs_nodes.size());
+ },
+
+ test_no_subscribers_force_hide_removal: function() {
+ // When resetNoSubscribers() is called on an empty
+ // SubscribersList which already has a no-subscribers
+ // indication shown, it is removed.
+ var subscribers_list = setUpSubscribersList(this.root);
+ subscribers_list.resetNoSubscribers();
+ subscribers_list.resetNoSubscribers(true);
+ var no_subs_nodes = this.root.all(
+ '.no-subscribers-indicator');
+ Y.Assert.areEqual(0, no_subs_nodes.size());
+ },
+
+ test_subscribers_no_addition: function() {
+ // When resetNoSubscribers() is called on a SubscribersList
+ // with some subscribers, no indication of no subscribers is added.
+ var subscribers_list = setUpSubscribersList(this.root);
+ // Hack a section node into the list so it appears as if
+ // there are subscribers.
+ subscribers_list.container_node.appendChild(
+ Y.Node.create('<div />')
+ .addClass('subscribers-section'));
+
+ // There is no indication of no subscribers added by
+ // resetNoSubscribers.
+ subscribers_list.resetNoSubscribers();
+ var no_subs_nodes = this.root.all(
+ '.no-subscribers-indicator');
+ Y.Assert.isTrue(no_subs_nodes.isEmpty());
+ },
+
+ test_subscribers_remove_previous_indication: function() {
+ // When resetNoSubscribers() is called on a SubscribersList
+ // with some subscribers, existing indication of no subscribers
+ // is removed.
+ var subscribers_list = setUpSubscribersList(this.root);
+ // Hack a section node into the list so it appears as if
+ // there are subscribers.
+ subscribers_list.container_node.appendChild(
+ Y.Node.create('<div />')
+ .addClass('subscribers-section'));
+ subscribers_list.container_node.appendChild(
+ Y.Node.create('<div />')
+ .addClass('no-subscribers-indicator'));
+
+ // There is no indication of no subscribers anymore after
+ // the call to resetNoSubscribers.
+ subscribers_list.resetNoSubscribers();
+ var no_subs_nodes = this.root.all(
+ '.no-subscribers-indicator');
+ Y.Assert.isTrue(no_subs_nodes.isEmpty());
+ }
+ }));
+
+ /**
+ * Test activity/progress indication for the entire subscribers list.
+ */
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersList.startActivity() and stopActivity() test',
+
+ _should: {
+ error: {
+ test_setActivityErrorIcon_error: true,
+ test_setActivityText_error: true
+ }
+ },
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ },
+
+ test_ensureActivityNode: function() {
+ // With no activity node present, one is created and put
+ // into the subscribers list container node.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var node = subscribers_list._ensureActivityNode();
+ Y.Assert.isNotNull(node);
+ Y.Assert.isTrue(node.hasClass('global-activity-indicator'));
+ Y.Assert.areSame(
+ subscribers_list.container_node, node.get('parentNode'));
+ },
+
+ test_ensureActivityNode_contents: function() {
+ // Created node contains an img tag with the spinner icon
+ // and a span tag for the text.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var node = subscribers_list._ensureActivityNode();
+ var icon = node.one('img');
+ Y.Assert.isNotNull(icon);
+ Y.Assert.areEqual('file:///@@/spinner', icon.get('src'));
+ var text = node.one('span');
+ Y.Assert.isNotNull(text);
+ Y.Assert.isTrue(text.hasClass('global-activity-text'));
+ },
+
+ test_ensureActivityNode_existing: function() {
+ // When activity node already exists, it is returned
+ // and no new one is created.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var existing_node = subscribers_list._ensureActivityNode();
+ var new_node = subscribers_list._ensureActivityNode();
+ Y.Assert.areSame(existing_node, new_node);
+ Y.Assert.areEqual(
+ 1,
+ subscribers_list
+ .container_node
+ .all('.global-activity-indicator')
+ .size());
+ },
+
+ test_setActivityErrorIcon_error_icon: function() {
+ // With the activity node passed in, error icon is set
+ // when desired.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var node = subscribers_list._ensureActivityNode();
+ var icon_node = node.one('img');
+ subscribers_list._setActivityErrorIcon(node, true);
+ Y.Assert.areEqual('file:///@@/error', icon_node.get('src'));
+ },
+
+ test_setActivityErrorIcon_spinner_icon: function() {
+ // With the activity node passed in, spinner icon is restored
+ // when requested (error parameter !== true).
+ var subscribers_list = setUpSubscribersList(this.root);
+ var node = subscribers_list._ensureActivityNode();
+ var icon_node = node.one('img');
+ subscribers_list._setActivityErrorIcon(node, false);
+ Y.Assert.areEqual('file:///@@/spinner', icon_node.get('src'));
+ },
+
+ test_setActivityErrorIcon_error: function() {
+ // With non-activity node passed in, it fails.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var node = Y.Node.create('<div />');
+ subscribers_list._setActivityErrorIcon(node, true);
+ },
+
+ test_setActivityText: function() {
+ // With activity node and text passed in, proper
+ // text is set in the activity text node.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var node = subscribers_list._ensureActivityNode();
+ subscribers_list._setActivityText(node, "Blah");
+ // Single whitespace is prepended to better separate
+ // icon from the text.
+ Y.Assert.areEqual(" Blah", node.one('span').get('text'));
+ },
+
+ test_setActivityText_error: function() {
+ // With non-activity node passed in, it fails.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var node = Y.Node.create('<div />');
+ subscribers_list._setActivityText(node, "Blah");
+ },
+
+ test_startActivity: function() {
+ // startActivity adds the spinner icon and sets the appropriate
+ // text.
+ var subscribers_list = setUpSubscribersList(this.root);
+ subscribers_list.startActivity("Blah");
+
+ var node = subscribers_list._ensureActivityNode();
+
+ Y.Assert.areEqual('file:///@@/spinner', node.one('img').get('src'));
+ Y.Assert.areEqual(" Blah", node.one('span').get('text'));
+ },
+
+ test_startActivity_restores_state: function() {
+ // startActivity removes the no-subscribers indicator if present
+ // and restores the activity node icon.
+ var subscribers_list = setUpSubscribersList(this.root);
+ // Add a no-subscribers indication.
+ subscribers_list.resetNoSubscribers();
+ // Create an activity node and set the error icon.
+ var node = subscribers_list._ensureActivityNode();
+ subscribers_list._setActivityErrorIcon(node, true);
+
+ // Call startActivity() and see how it restores everything.
+ subscribers_list.startActivity();
+ Y.Assert.areEqual('file:///@@/spinner', node.one('img').get('src'));
+ Y.Assert.isNull(
+ subscribers_list.container_node.one(
+ '.no-subscribers-indicator'));
+ },
+
+ test_stopActivity: function() {
+ // stopActivity without parameters assumes a successful completion
+ // of the activity, so it removes the activity node and restores
+ // no-subscribers indication if needed.
+ var subscribers_list = setUpSubscribersList(this.root);
+ subscribers_list.startActivity("Blah");
+ subscribers_list.stopActivity();
+
+ var node = subscribers_list.container_node.one(
+ '.global-activity-indicator');
+ Y.Assert.isNull(node);
+ // Indication of no subscribers is restored.
+ Y.Assert.isNotNull(
+ subscribers_list.container_node.one(
+ '.no-subscribers-indicator'));
+ },
+
+ test_stopActivity_noop: function() {
+ // stopActivity without parameters assumes a successful completion
+ // of the activity. If no activity was in progress, nothing
+ // happens.
+ var subscribers_list = setUpSubscribersList(this.root);
+ subscribers_list.stopActivity();
+
+ var node = subscribers_list.container_node.one(
+ '.global-activity-indicator');
+ Y.Assert.isNull(node);
+ },
+
+ test_stopActivity_with_error_message: function() {
+ // stopActivity with error message passed in creates an activity
+ // node even if activity was not in progress and sets the error
+ // icon and error text to the passed in message..
+ var subscribers_list = setUpSubscribersList(this.root);
+ subscribers_list.stopActivity("Problem!");
+ var node = subscribers_list._ensureActivityNode();
+ Y.Assert.areEqual('file:///@@/error', node.one('img').get('src'));
+ Y.Assert.areEqual(" Problem!", node.one('span').get('text'));
+
+ // Indication of no subscribers is not added.
+ Y.Assert.isNull(
+ subscribers_list.container_node.one(
+ '.no-subscribers-indicator'));
+ }
+ }));
+
+ /**
+ * Test subscribers section creation and helper methods.
+ */
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersList._getOrCreateSection() test',
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ },
+
+ test_getSectionCSSClass: function() {
+ // Returns a CSS class name to use for a section
+ // for subscribers with a particular subscription level.
+ var subscribers_list = setUpSubscribersList(this.root);
+ Y.Assert.areEqual(
+ 'subscribers-section-level3',
+ subscribers_list._getSectionCSSClass('Level3'));
+ },
+
+ test_getSection: function() {
+ // Gets a subscribers section for the subscription level.
+ var subscribers_list = setUpSubscribersList(this.root);
+
+ var section_node = Y.Node.create('<div />')
+ .addClass('subscribers-section-level3')
+ .addClass('subscribers-section');
+ subscribers_list.container_node.appendChild(section_node);
+
+ Y.Assert.areEqual(section_node,
+ subscribers_list._getSection('level3'));
+ },
+
+ test_getSection_none: function() {
+ // When there is no requested section, returns null.
+ var subscribers_list = setUpSubscribersList(this.root);
+
+ var section_node = Y.Node.create('<div />')
+ .addClass('subscribers-section-level3')
+ .addClass('subscribers-section');
+ subscribers_list.container_node.appendChild(section_node);
+
+ Y.Assert.isNull(subscribers_list._getSection('level1'));
+ },
+
+ test_createSectionNode: function() {
+ // Creates a subscribers section for the given subscription level.
+ var subscribers_list = setUpSubscribersList(this.root);
+
+ var section_node = subscribers_list._createSectionNode('Level1');
+
+ // A CSS class is added to the node for this particular level.
+ Y.Assert.isTrue(
+ section_node.hasClass('subscribers-section-level1'));
+ // As well as a generic CSS class to indicate it's a section.
+ Y.Assert.isTrue(section_node.hasClass('subscribers-section'));
+
+ // Header is appropriate for the subscription level.
+ var header = section_node.one('h3');
+ Y.Assert.areEqual('Subscriber level 1', header.get('text'));
+
+ // There is a separate node for the subscribers list in this
+ // section.
+ Y.Assert.isNotNull(section_node.one('.subscribers-list'));
+ },
+
+ test_insertSectionNode: function() {
+ // Inserts a section node in the subscribers list.
+ var subscribers_list = setUpSubscribersList(this.root);
+
+ var section_node = subscribers_list._createSectionNode('Level2');
+
+ subscribers_list._insertSectionNode('Level2', section_node);
+ Y.ArrayAssert.itemsAreEqual(
+ [section_node], _getAllSections(subscribers_list));
+ },
+
+ test_insertSectionNode_before: function() {
+ // Inserts a section node in front of the existing section
+ // in the subscribers list.
+ var subscribers_list = setUpSubscribersList(this.root);
+
+ // Sections we'll be inserting in the order they should end up in.
+ var section_node1 = subscribers_list._createSectionNode('Level1');
+ var section_node2 = subscribers_list._createSectionNode('Level2');
+
+ subscribers_list._insertSectionNode('Level2', section_node2);
+ Y.ArrayAssert.itemsAreEqual(
+ [section_node2],
+ _getAllSections(subscribers_list));
+
+ // Details section comes in front of the 'Level1' section.
+ subscribers_list._insertSectionNode('Level1', section_node1);
+ Y.ArrayAssert.itemsAreEqual(
+ [section_node1, section_node2],
+ _getAllSections(subscribers_list));
+ },
+
+ test_insertSectionNode_after: function() {
+ // Inserts a section node after the existing section
+ // in the subscribers list.
+ var subscribers_list = setUpSubscribersList(this.root);
+
+ // Sections we'll be inserting in the order they should end up in.
+ var section_node1 = subscribers_list._createSectionNode('Level1');
+ var section_node2 = subscribers_list._createSectionNode('Default');
+
+ subscribers_list._insertSectionNode('Level1', section_node1);
+ Y.ArrayAssert.itemsAreEqual(
+ [section_node1],
+ _getAllSections(subscribers_list));
+
+ subscribers_list._insertSectionNode('Default', section_node2);
+ Y.ArrayAssert.itemsAreEqual(
+ [section_node1, section_node2],
+ _getAllSections(subscribers_list));
+ },
+
+ test_insertSectionNode_full_list: function() {
+ // Inserts a section node in the appropriate place in the
+ // subscribers list for all the possible subscription levels.
+ var subscribers_list = setUpSubscribersList(this.root);
+
+ // Sections we'll be inserting in the order they should end up in.
+ var section_node1 = subscribers_list._createSectionNode('Level1');
+ var section_node2 = subscribers_list._createSectionNode('Level2');
+ var section_node3 = subscribers_list._createSectionNode('Level3');
+ var section_node4 = subscribers_list._createSectionNode('Default');
+
+ subscribers_list._insertSectionNode('Level3', section_node3);
+ Y.ArrayAssert.itemsAreEqual(
+ [section_node3], _getAllSections(subscribers_list));
+
+ subscribers_list._insertSectionNode('Level1', section_node1);
+ Y.ArrayAssert.itemsAreEqual(
+ [section_node1, section_node3],
+ _getAllSections(subscribers_list));
+
+ subscribers_list._insertSectionNode('Level2', section_node2);
+ Y.ArrayAssert.itemsAreEqual(
+ [section_node1, section_node2, section_node3],
+ _getAllSections(subscribers_list));
+
+ subscribers_list._insertSectionNode('Default', section_node4);
+ Y.ArrayAssert.itemsAreEqual(
+ [section_node1, section_node2, section_node3, section_node4],
+ _getAllSections(subscribers_list));
+ },
+
+ test_getOrCreateSection_get_existing: function() {
+ // When there is an existing section, _getOrCreateSection
+ // returns the existing node.
+ var subscribers_list = setUpSubscribersList(this.root);
+
+ var section_node = subscribers_list._createSectionNode('Level2');
+ subscribers_list._insertSectionNode('Level2', section_node);
+
+ Y.Assert.areSame(section_node,
+ subscribers_list._getOrCreateSection('Level2'));
+
+ },
+
+ test_getOrCreateSection_new: function() {
+ // When there is no existing matching section, a new one
+ // is created and added to the subscribers list.
+ var subscribers_list = setUpSubscribersList(this.root);
+
+ var section_node = subscribers_list._getOrCreateSection('Level3');
+ Y.ArrayAssert.itemsAreEqual(
+ [section_node],
+ _getAllSections(subscribers_list));
+ },
+
+ test_getOrCreateSection_positioning: function() {
+ // When new sections are created, they are inserted into proper
+ // positions using _insertSectionNode.
+ var subscribers_list = setUpSubscribersList(this.root);
+
+ var section_node2 = subscribers_list._getOrCreateSection('Level3');
+ var section_node1 = subscribers_list._getOrCreateSection(
+ 'Level1');
+ Y.ArrayAssert.itemsAreEqual(
+ [section_node1, section_node2],
+ _getAllSections(subscribers_list));
+ },
+
+ test_getOrCreateSection_removes_no_subscribers_indication: function() {
+ // When there is a div indicating no subscribers,
+ // _getOrCreateSection removes it because it's adding a section
+ // where subscribers are to come in.
+ var subscribers_list = setUpSubscribersList(this.root);
+
+ // Add a div saying 'No other subscribers.'
+ subscribers_list.resetNoSubscribers();
+ Y.Assert.isNotNull(this.root.one('.no-subscribers-indicator'));
+
+ // And there is no matching div after _getOrCreateSection call.
+ subscribers_list._getOrCreateSection('Level3');
+ Y.Assert.isNull(this.root.one('.no-subscribers-indicator'));
+ }
+
+ }));
+
+ /**
+ * Test removal of a subscribers section.
+ */
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersList._removeSectionNodeIfEmpty() test',
+
+ _should: {
+ error: {
+ test_sectionNodeHasSubscribers_error:
+ new Error(
+ 'No div.subscribers-list found inside the passed `node`.'),
+ test_removeSectionNodeIfEmpty_non_section_error:
+ new Error(
+ 'Node is not a section node.')
+ }
+ },
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ },
+
+ test_sectionNodeHasSubscribers_error: function() {
+ // When called on a node not containing the subscribers list,
+ // it throws an error.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var node = Y.Node.create('<div />');
+ subscribers_list._sectionNodeHasSubscribers(node);
+ },
+
+ test_sectionNodeHasSubscribers_no_subscribers: function() {
+ // When called on a proper section node but with no subscribers,
+ // it returns false.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var node = subscribers_list._getOrCreateSection('Level3');
+ Y.Assert.isFalse(subscribers_list._sectionNodeHasSubscribers(node));
+ },
+
+ test_sectionNodeHasSubscribers_subscribers: function() {
+ // When called on a proper section node with subscribers,
+ // it returns true.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var node = subscribers_list._getOrCreateSection('Level3');
+ var subscriber = Y.Node.create('<div />')
+ .addClass('subscriber');
+ node.one('.subscribers-list').appendChild(subscriber);
+ Y.Assert.isTrue(subscribers_list._sectionNodeHasSubscribers(node));
+ },
+
+ test_removeSectionNodeIfEmpty_noop: function() {
+ // When there is no requested section, nothing happens.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var section_node = subscribers_list._getSection('Level3');
+ subscribers_list._removeSectionNodeIfEmpty(section_node);
+ },
+
+ test_removeSectionNodeIfEmpty_non_section_error: function() {
+ // When called on a node which is not a section, it throws
+ // an exception.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var section_node = Y.Node.create('<div />');
+ subscribers_list._removeSectionNodeIfEmpty(section_node);
+ },
+
+ test_removeSectionNodeIfEmpty_remove: function() {
+ // When there is an empty section, it's removed.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var section_node = subscribers_list._getOrCreateSection('Level3');
+
+ subscribers_list._removeSectionNodeIfEmpty(section_node);
+ Y.ArrayAssert.itemsAreEqual(
+ [],
+ _getAllSections(subscribers_list));
+
+ // Indication that there are no subscribers is added.
+ Y.Assert.isNotNull(this.root.one('.no-subscribers-indicator'));
+ },
+
+ test_removeSectionNodeIfEmpty_keep: function() {
+ // When there is a section with a subscriber, it's not removed.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var section_node = subscribers_list._getOrCreateSection('Level3');
+
+ // Add a subscriber.
+ section_node.one('.subscribers-list').appendChild(
+ Y.Node.create('<div />')
+ .addClass('subscriber'));
+
+ subscribers_list._removeSectionNodeIfEmpty(section_node);
+ Y.ArrayAssert.itemsAreEqual(
+ [section_node],
+ _getAllSections(subscribers_list));
+ // Indication that there are no subscribers is not added.
+ Y.Assert.isNull(this.root.one('.no-subscribers-indicator'));
+ },
+
+ test_removeSectionNodeIfEmpty_keeps_others: function() {
+ // With two empty sections, only the requested one is removed.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var section_node1 = subscribers_list._getOrCreateSection('Level3');
+ var section_node2 = subscribers_list._getOrCreateSection(
+ 'Level1');
+
+ var section_node = subscribers_list._getSection('Level3');
+ subscribers_list._removeSectionNodeIfEmpty(section_node);
+ Y.ArrayAssert.itemsAreEqual(
+ [section_node2],
+ _getAllSections(subscribers_list));
+ // Indication that there are no subscribers is not added.
+ Y.Assert.isNull(this.root.one('.no-subscribers-indicator'));
+ }
+
+ }));
+
+ /**
+ * Test adding of subscribers and relevant helper methods.
+ */
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersList.addSubscriber() test',
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ },
+
+ _should: {
+ error: {
+ test_validateSubscriber_no_name_error:
+ new Error('No `name` passed in `subscriber`.'),
+ test_addSubscriber_incorrect_level:
+ new Error(
+ 'Level "Test" is not an acceptable subscription level.'),
+ test_addSubscriber_not_in_section_error:
+ new Error(
+ "Matching subscriber node doesn't seem to be in any " +
+ "subscribers list sections.")
+ }
+ },
+
+ test_getNodeIdForSubscriberName: function() {
+ // Returns a CSS class name to use as the ID for subscribers
+ // prefixed with 'subscriber-'. Uses launchpad_to_css for
+ // escaping (eg. it replaces '+' with '_y').
+ var subscribers_list = setUpSubscribersList(this.root);
+ Y.Assert.areEqual(
+ 'subscriber-danilo_y',
+ subscribers_list._getNodeIdForSubscriberName('danilo+'));
+ },
+
+ test_validateSubscriber: function() {
+ // Ensures a passed in subscriber object has at least the
+ // `name` attribute. Presets display_name and web_link
+ // values based on it.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ subscriber = subscribers_list._validateSubscriber(subscriber);
+ Y.Assert.areEqual('user', subscriber.name);
+ Y.Assert.areEqual('user', subscriber.display_name);
+ Y.Assert.areEqual('/~user', subscriber.web_link);
+ },
+
+ test_validateSubscriber_no_name_error: function() {
+ // When no name attribute is present, an exception is thrown.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { };
+ subscribers_list._validateSubscriber(subscriber);
+ },
+
+ test_validateSubscriber_no_overriding: function() {
+ // Attributes display_name and web_link are not overridden if
+ // already set.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = {
+ name: 'user',
+ display_name: 'User Name',
+ web_link: 'http://launchpad.net/'
+ };
+ subscriber = subscribers_list._validateSubscriber(subscriber);
+ Y.Assert.areEqual('user', subscriber.name);
+ Y.Assert.areEqual('User Name', subscriber.display_name);
+ Y.Assert.areEqual('http://launchpad.net/', subscriber.web_link);
+ },
+
+ test_createSubscriberNode: function() {
+ // When passed a subscriber object, it constructs a node
+ // containing a link to the subscriber (using web_link for the
+ // link target, and display name for the text).
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = {
+ name: 'user',
+ display_name: 'User Name',
+ web_link: 'http://launchpad.net/~user',
+ display_subscribed_by: 'Subscribed by Someone (someone)'
+ };
+ var node = subscribers_list._createSubscriberNode(subscriber);
+ Y.Assert.isTrue(node.hasClass('subscriber'));
+
+ var link = node.one('a');
+ Y.Assert.areEqual('http://launchpad.net/~user', link.get('href'));
+ Y.Assert.areEqual(
+ 'Subscribed by Someone (someone)', link.get('title'));
+ var text = link.one('span');
+ Y.Assert.areEqual('User Name', text.get('text'));
+ Y.Assert.isTrue(text.hasClass('sprite'));
+ Y.Assert.isTrue(text.hasClass('person'));
+
+ },
+
+ test_createSubscriberNode_missing_display_subscribed_by: function() {
+ // When passed a subscriber object with no 'display_subscribed_by'
+ // attribute then the title is simply not set but shows up
+ // as a null string.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = {
+ name: 'user',
+ display_name: 'User Name',
+ web_link: 'http://launchpad.net/~user'
+ };
+ var node = subscribers_list._createSubscriberNode(subscriber);
+ Y.Assert.isTrue(node.hasClass('subscriber'));
+
+ var link = node.one('a');
+ Y.Assert.areEqual('http://launchpad.net/~user', link.get('href'));
+ Y.Assert.areEqual('', link.get('title'));
+ },
+
+ test_createSubscriberNode_display_name_truncated: function() {
+ // The display name displayed should be truncted to 20 characters.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = {
+ name: 'user',
+ display_name: 'Really Really Long Name',
+ web_link: 'http://launchpad.net/~user'
+ };
+ var node = subscribers_list._createSubscriberNode(subscriber);
+ var link = node.one('a');
+ var text = link.one('span');
+ Y.Assert.areEqual('Really Really Lon...', text.get('text'));
+ },
+
+ test_createSubscriberNode_team: function() {
+ // When passed a subscriber object which has is_team === true,
+ // a constructed node uses a 'sprite team' CSS classes instead
+ // of 'sprite person' for display.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = {
+ name: 'team',
+ display_name: 'Team Name',
+ web_link: 'http://launchpad.net/~team',
+ is_team: true
+ };
+ var node = subscribers_list._createSubscriberNode(subscriber);
+ var link_text = node.one('a span');
+ Y.Assert.isTrue(link_text.hasClass('sprite'));
+ Y.Assert.isTrue(link_text.hasClass('team'));
+ },
+
+ test_addSubscriber: function() {
+ // When there is no subscriber in the subscriber list,
+ // a new node is constructed and the appropriate section is added.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var node = subscribers_list.addSubscriber(
+ { name: 'user' }, 'Level2');
+
+ // Node is constructed using _createSubscriberNode.
+ Y.Assert.isTrue(node.hasClass('subscriber'));
+ // And the ID is set inside addSubscriber() method.
+ Y.Assert.areEqual('subscriber-user', node.get('id'));
+
+ // And it nested in the subscribers-list of a 'Level3' section.
+ var list_node = node.ancestor('.subscribers-list');
+ Y.Assert.isNotNull(list_node);
+ var section_node =
+ list_node.ancestor('.subscribers-section-level2');
+ Y.Assert.isNotNull(section_node);
+ },
+
+ test_addSubscriber_no_levels: function() {
+ // Check that addSubscriber works if there are no subscription
+ // levels.
+ var container_node = Y.Node.create('<div />')
+ .set('id', 'other-subscribers-container');
+ this.root.appendChild(container_node);
+ var config = {
+ container_box: '#other-subscribers-container',
+ subscriber_levels: [],
+ subscribers_label: "subscribers",
+ unsubscribe_label: "Unsubscribe"
+ };
+ var subscribers_list = new module.SubscribersList(config);
+
+ var node = subscribers_list.addSubscriber(
+ { name: 'user' }, '');
+
+ // Node is constructed using _createSubscriberNode.
+ Y.Assert.isTrue(node.hasClass('subscriber'));
+ // And the ID is set inside addSubscriber() method.
+ Y.Assert.areEqual('subscriber-user', node.get('id'));
+
+ // And it nested in the subscribers-list of a 'Default' section with
+ // no header.
+ var list_node = node.ancestor('.subscribers-list');
+ Y.Assert.isNotNull(list_node);
+ var section_node = list_node.ancestor(
+ '.subscribers-section-default');
+ Y.Assert.isNotNull(section_node);
+ var header_node = section_node.one('h3');
+ Y.Assert.isNull(header_node);
+ },
+
+ test_addSubscriber_incorrect_level: function() {
+ // When an incorrect level is passed in, an exception is thrown.
+ var subscribers_list = setUpSubscribersList(this.root);
+ subscribers_list.addSubscriber(
+ { name: 'user' }, 'Test');
+ },
+
+ test_addSubscriber_change_level: function() {
+ // addSubscriber also allows changing a subscribtion level
+ // for a subscriber when they are moved to a different section.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var node = subscribers_list.addSubscriber(
+ { name: 'user' }, 'Level2');
+ Y.Assert.isNotNull(node.ancestor('.subscribers-section-level2'));
+
+ // Move the subscriber to lifecycle section.
+ node = subscribers_list.addSubscriber(
+ { name: 'user' }, 'Level3');
+ // It's now in 'Level3' section.
+ Y.Assert.isNotNull(node.ancestor('.subscribers-section-level3'));
+ // And 'Level3' section is removed.
+ Y.Assert.isNull(subscribers_list._getSection('Level2'));
+ },
+
+ test_addSubscriber_not_in_section_error: function() {
+ // addSubscriber throws an exception if a subscriber node is found,
+ // but it is not properly nested inside a subscribers-section node.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var node = Y.Node.create('<div />')
+ .set('id', 'subscriber-user');
+ // We hack the node directly into the entire subscribers list node.
+ subscribers_list.container_node.appendChild(node);
+
+ // And addSubscriber now throws an exception.
+ subscribers_list.addSubscriber(
+ { name: 'user' }, 'Level3');
+ },
+
+ test_addSubscriber_ordering: function() {
+ // With multiple subscribers being added to the same section,
+ // the last one is listed first.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var node1 = subscribers_list.addSubscriber(
+ { name: 'user1' }, 'Level3');
+ var node2 = subscribers_list.addSubscriber(
+ { name: 'user2' }, 'Level3');
+
+ var list_node = subscribers_list._getSection('Level3')
+ .one('.subscribers-list');
+ var all_subscribers = list_node.all('.subscriber');
+
+ var returned_nodes = [];
+ var index;
+ for (index = 0; index < all_subscribers.size(); index++) {
+ returned_nodes.push(all_subscribers.item(index));
+ }
+ Y.ArrayAssert.itemsAreSame(
+ [node2, node1],
+ returned_nodes);
+ },
+
+ test_addSubscriber_unsubscribe_callback: function() {
+ // When config.unsubscribe_callback is passed in,
+ // addUnsubscribeAction(subscriber, callback) is
+ // called as well.
+
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ var callback = function() {};
+
+ var callback_setup = false;
+ subscribers_list.addUnsubscribeAction = function(
+ unsub_subscriber, unsub_callback) {
+ callback_setup = true;
+ Y.Assert.areSame(subscriber, unsub_subscriber);
+ Y.Assert.areSame(callback, unsub_callback);
+ };
+ subscribers_list.addSubscriber(subscriber, 'Level3',
+ { unsubscribe_callback: callback });
+ // Setting up a callback was performed.
+ Y.Assert.isTrue(callback_setup);
+ }
+
+ }));
+
+ /**
+ * Test adding of unsubscribe action for a subscriber, removal of
+ * subscribers and relevant helper methods.
+ */
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersList.addUnsubscribeAction() and ' +
+ 'removeSubscriber() test',
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ },
+
+ _should: {
+ error: {
+ test_getSubscriberNode_error:
+ new Error('Subscriber is not present in the subscribers ' +
+ 'list. Please call addSubscriber(subscriber) first.'),
+ test_addUnsubscribeAction_error:
+ new Error('Passed in callback for unsubscribe action ' +
+ 'is not a function.'),
+ test_removeSubscriber_error:
+ new Error(
+ 'Subscriber is not present in the subscribers list. ' +
+ 'Please call addSubscriber(subscriber) first.'),
+ test_removeSubscriber_not_in_section_error:
+ new Error(
+ "Matching subscriber node doesn't seem to be in any " +
+ "subscribers list sections.")
+ }
+ },
+
+ test_getSubscriberNode: function() {
+ // Gets a subscriber node from the subscribers list when present.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ var node = subscribers_list.addSubscriber(subscriber, 'Level3');
+ Y.Assert.areSame(
+ node, subscribers_list._getSubscriberNode(subscriber));
+ },
+
+ test_getSubscriberNode_error: function() {
+ // When subscriber node is not present, throws an error.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ subscribers_list._getSubscriberNode(subscriber);
+ },
+
+ test_getOrCreateActionsNode: function() {
+ // When no actions node is present, one is created, appended
+ // to the subscriber node, and returned.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber_node = subscribers_list.addSubscriber(
+ { name: 'user' }, 'Level1');
+ var actions_node = subscribers_list._getOrCreateActionsNode(
+ subscriber_node);
+ // Newly created node has 'subscriber-actions' CSS class.
+ Y.Assert.isTrue(actions_node.hasClass('subscriber-actions'));
+
+ // It is also nested inside the subscriber_node.
+ Y.Assert.areSame(subscriber_node, actions_node.get('parentNode'));
+ },
+
+ test_getOrCreateActionsNode_already_exists: function() {
+ // When actions node is present, it is returned.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber_node = subscribers_list.addSubscriber(
+ { name: 'user' }, 'Level1');
+ var old_actions_node = subscribers_list._getOrCreateActionsNode(
+ subscriber_node);
+ var new_actions_node = subscribers_list._getOrCreateActionsNode(
+ subscriber_node);
+ Y.Assert.areSame(old_actions_node, new_actions_node);
+ },
+
+ test_addUnsubscribeAction_node: function() {
+ // Adding an unsubscribe action creates an unsubscribe icon
+ // nested inside the actions node for the subscriber.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user', display_name: 'User Name' };
+ var callback = function() {};
+
+ var subscriber_node = subscribers_list.addSubscriber(
+ subscriber, 'Level1');
+ subscribers_list.addUnsubscribeAction(subscriber, callback);
+ // An actions node is created.
+ var actions_node = subscriber_node.one('.subscriber-actions');
+ Y.Assert.isNotNull(actions_node);
+ // It contains an A tag for the unsubscribe action.
+ var unsub_node = actions_node.one('a.unsubscribe-action');
+ Y.Assert.isNotNull(unsub_node);
+ Y.Assert.areEqual('Unsubscribe User Name', unsub_node.get('title'));
+ var unsub_icon = unsub_node.one('img');
+ Y.Assert.isNotNull(unsub_icon);
+ Y.Assert.areEqual('Remove', unsub_icon.get('alt'));
+ // Getting a URI returns an absolute one, and with this being run
+ // from the local file system, that's what we get.
+ Y.Assert.areEqual('file:///@@/remove', unsub_icon.get('src'));
+ },
+
+ test_addUnsubscribeAction_node_exists: function() {
+ // When an unsubscribe node already exists, a new one is not
+ // created.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user', display_name: 'User Name' };
+ var callback = function() {};
+ var subscriber_node = subscribers_list.addSubscriber(
+ subscriber, 'Level1');
+ subscribers_list.addUnsubscribeAction(subscriber, callback);
+ var unsub_node = subscriber_node.one('a.unsubscribe-action');
+
+ subscribers_list.addUnsubscribeAction(subscriber, callback);
+ var unsub_nodes = subscriber_node.all('a.unsubscribe-action');
+ Y.Assert.areEqual(1, unsub_nodes.size());
+ Y.Assert.areSame(unsub_node, unsub_nodes.item(0));
+ },
+
+ test_addUnsubscribeAction_error: function() {
+ // Adding an unsubscribe action with callback not a function
+ // fails with an exception.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ var subscriber_node = subscribers_list.addSubscriber(
+ subscriber, 'Level1');
+ subscribers_list.addUnsubscribeAction(subscriber, "not-function");
+ },
+
+ test_addUnsubscribeAction_callback_on_click: function() {
+ // When unsubscribe link is clicked, callback is activated
+ // and passed in the subscribers_list and subscriber parameters.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user', display_name: 'User Name' };
+
+ var callback_called = false;
+ var callback = function(my_list, my_subscriber) {
+ callback_called = true;
+ Y.Assert.areSame(subscribers_list, my_list);
+ Y.Assert.areSame(subscriber, my_subscriber);
+ };
+ var subscriber_node = subscribers_list.addSubscriber(
+ subscriber, 'Level1');
+ subscribers_list.addUnsubscribeAction(subscriber, callback);
+ var unsub_node = subscriber_node.one('a.unsubscribe-action');
+ unsub_node.simulate('click');
+
Y.Assert.isTrue(callback_called);
- }, 50);
- },
-
- test_stopSubscriberActivity_no_callback: function() {
- // When we pass the callback in, but success is neither
- // 'true' nor 'false', callback is not called.
- var subscribers_list = setUpSubscribersList(this.root);
- var subscriber = { name: 'user' };
- subscribers_list.addSubscriber(subscriber, 'Level3');
- var callback_called = false;
- var callback = function() {
- callback_called = true;
- };
-
- subscribers_list.stopSubscriberActivity(
- subscriber, "no-callback", callback);
- // Callback is not called.
- Y.Assert.isFalse(callback_called);
- this.wait(function() {
- // Nor is it called after any potential animations complete.
- Y.Assert.isFalse(callback_called);
- }, 50);
- }
-
-}));
-
-
-/**
- * Set-up all the nodes required for SubscribersLoader.
- */
-function setUpLoader(root_node, config, barebone) {
- // Set-up subscribers list node.
- var node = Y.Node.create('<div />')
- .set('id', 'other-subscribers-container');
- var container_config = {
- container_box: '#other-subscribers-container',
- subscriber_levels: subscriber_levels,
- subscribe_me_level: 'Level1',
- subscribe_someone_else_level: 'Level1',
- default_subscriber_level: 'Default'
- };
- if (barebone !== true) {
- container_config.context = {
- web_link: '/base', self_link: '/thing/1' };
- container_config.subscribers_details_view = '/+details';
- }
- root_node.appendChild(node);
- if (Y.Lang.isValue(config)) {
- config = Y.mix(container_config, config);
- } else {
- config = container_config;
- }
- window.LP = { links: { me : "/~viewer" } };
- return new module.SubscribersLoader(config);
-}
-
-/**
- * Test SubscribersLoader class construction.
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersLoader() construction test',
-
- _should: {
- error: {
- test_SubscribersLoader_container_error:
- new Error(
- 'Container node must be specified in config.container_box.'),
- test_SubscribersLoader_context_error:
- new Error(
- "No context specified in `config' or context.web_link " +
- "is invalid."),
- test_SubscribersLoader_context_web_link_error:
- new Error(
- "No context specified in `config' or context.web_link " +
- "is invalid."),
- test_SubscribersLoader_portlet_link_error:
- new Error(
- "No config.subscribers_details_view specified to load " +
- "other subscribers from.")
- }
- },
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- },
-
- tearDown: function() {
- this.root.remove();
- },
-
- test_SubscribersLoader_container_error: function() {
- // If no container node to hold the subscribers list is specified,
- // it fails with an error.
- var loader =
- new module.SubscribersLoader({
- container_box: '#not-found',
- subscriber_levels: []});
- },
-
- test_SubscribersLoader_context_error: function() {
- // Context needs to be passed in as well.
- // setUpLoader constructs the container node for us.
- var config = {};
- setUpLoader(this.root, config, true);
- },
-
- test_SubscribersLoader_context_web_link_error: function() {
- // Fails if the passed in context has no web_link attribute defined.
- var config = { context: {} };
- setUpLoader(this.root, config, true);
- },
-
- test_SubscribersLoader_portlet_link_error: function() {
- // Fails if the passed in config has no passed in
- // portlet URI for loading context subscribers details.
- var config = { context: { web_link: '' } };
- setUpLoader(this.root, config, true);
- },
-
- test_SubscribersLoader_default_config_parameters: function() {
- // Check that CONFIG_DEFAULTS are used.
- var node = Y.Node.create('<div />')
- .set('id', 'other-subscribers-container');
- var config = {
- container_box: '#other-subscribers-container',
- context: {web_link: '', self_link: ''},
- subscribers_details_view: '/+details',
- subscriber_levels: []
- };
- this.root.appendChild(node);
- window.LP = { links: { me : "/~viewer" } };
-
- // Save original method for restoring later.
- var old_load = module.SubscribersLoader.prototype._loadSubscribers;
- module.SubscribersLoader.prototype._loadSubscribers = function() {};
-
- var loader = new module.SubscribersLoader(config);
- var default_config = {
- default_subscriber_level: '',
- subscribers_label: 'subscribers',
- subscribe_label:'Subscribe',
- unsubscribe_label:'Unsubscribe',
- subscribe_api: 'subscribe',
- unsubscribe_api: 'unsubscribe'
- };
-
- var config_var;
- for (config_var in default_config) {
- if (default_config.hasOwnProperty(config_var)) {
- Y.Assert.areEqual(
- default_config[config_var], loader[config_var],
- 'Unexpected config value for ' + config_var);
- }
- }
- // Restore original method.
- module.SubscribersLoader.prototype._loadSubscribers = old_load;
- },
-
- test_SubscribersLoader_default_config_override: function() {
- // Check that CONFIG_DEFAULTS parameters can be overridden.
- var node = Y.Node.create('<div />')
- .set('id', 'other-subscribers-container');
- var config = {
- container_box: '#other-subscribers-container',
- context: {web_link: '', self_link: ''},
- subscribers_details_view: '/+details',
- subscriber_levels: []
- };
- var override_config = {
- default_subscriber_level: 'aaa',
- subscribers_label: 'bbbb',
- subscribe_label:'cccc',
- unsubscribe_label:'dddd',
- subscribe_api: 'eeee',
- unsubscribe_api: 'ffff'
- };
-
- this.root.appendChild(node);
- window.LP = { links: { me : "/~viewer" } };
-
- // Save original method for restoring later.
- var old_load = module.SubscribersLoader.prototype._loadSubscribers;
- module.SubscribersLoader.prototype._loadSubscribers = function() {};
-
- config = Y.mix(config, override_config);
- var loader = new module.SubscribersLoader(config);
-
- var config_var;
- for (config_var in override_config) {
- if (override_config.hasOwnProperty(config_var)) {
- Y.Assert.areEqual(
- override_config[config_var], loader[config_var],
- 'Unexpected config value for ' + config_var);
- }
- }
- // Restore original method.
- module.SubscribersLoader.prototype._loadSubscribers = old_load;
- },
-
- test_SubscribersLoader: function() {
- // With all the parameters specified, it returns an instance
- // with subscribers_portlet_uri, subscribers_list, error_handler,
- // and calls the _loadSubscribers() method.
- var config = {
- context: { web_link: '/base' },
- subscribers_details_view: '/+details'
- };
-
- // Save original method for restoring later.
- var old_load = module.SubscribersLoader.prototype._loadSubscribers;
-
- var loading_started = false;
- module.SubscribersLoader.prototype._loadSubscribers = function() {
- loading_started = true;
- };
- var loader = setUpLoader(this.root, config);
- Y.Assert.areEqual('/base/+details', loader.subscribers_portlet_uri);
- Y.Assert.isNotNull(loader.subscribers_list);
- Y.Assert.isTrue(
- loader.subscribers_list instanceof module.SubscribersList);
- Y.Assert.isNotNull(loader.error_handler);
- Y.Assert.isTrue(loading_started);
- var container_node = Y.one('#other-subscribers-container');
- Y.Assert.areEqual(
- loader, container_node.getData('subscribers_loader'));
-
- // Restore original method.
- module.SubscribersLoader.prototype._loadSubscribers = old_load;
- }
-}));
-
-
-/**
- * Test SubscribersLoader subscribers loading and helper methods.
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersLoader() subscribers loading test',
-
- _should: {
- error: {
- test_loadSubscribersFromList_not_list_error:
- new Error('Got non-array "Not-a-list" in ' +
- '_loadSubscribersFromList().'),
- test_loadSubscribersFromList_no_objects_error:
- new Error('Subscriber details at index 0 (Subscriber)' +
- ' are not an object.')
- }
- },
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- },
-
- tearDown: function() {
- this.root.remove();
- },
-
- test_addSubscriber_wraps_list_addSubscriber: function() {
- // addSubscriber wraps the SubscribersList.addSubscriber.
- // When no can_edit is set on the subscriber, no unsubscribe
- // callback is added.
- var subscriber = { name: "user", self_link: "/~user" };
- var level = 'Level1';
- var call_passed_through = false;
- // Save the old method for restoring later.
- var old_addSub = module.SubscribersList.prototype.addSubscriber;
- module.SubscribersList.prototype.addSubscriber = function(
- passed_subscriber, passed_level) {
- call_passed_through = true;
- Y.Assert.areSame(subscriber, passed_subscriber);
- Y.Assert.areSame(level, passed_level);
- };
- var loader = setUpLoader(this.root);
- loader._addSubscriber(subscriber, level);
- Y.Assert.isTrue(call_passed_through);
-
- // Restore the real method.
- module.SubscribersList.prototype.addSubscriber = old_addSub;
- },
-
- test_addSubscriber_normalizes_level: function() {
- // addSubscriber normalizes the subscription level to 'Default'
- // when it's otherwise unknown subscription level.
- var subscriber = { name: "user", self_link: "/~user" };
- var level = "Not a level";
-
- // Save the old method for restoring later.
- var old_addSub = module.SubscribersList.prototype.addSubscriber;
- module.SubscribersList.prototype.addSubscriber = function(
- passed_subscriber, passed_level, passed_config) {
- Y.Assert.areSame('Default', passed_level);
- Y.Assert.isUndefined(passed_config);
- };
- var loader = setUpLoader(this.root);
- loader._addSubscriber(subscriber, level);
-
- // Restore the real method.
- module.SubscribersList.prototype.addSubscriber = old_addSub;
- },
-
- test_addSubscriber_unsubscribe_callback: function() {
- // addSubscriber sets the unsubscribe callback to function
- // returned by SubscribersLoader._getUnsubscribeCallback()
- // if subscriber.can_edit === true.
- var subscriber = { name: "user", can_edit: true,
- self_link: "/~user" };
- var unsubscribe_callback = function() {};
-
- // Save old methods for restoring later.
- var old_getUnsub = module.SubscribersLoader.prototype
- ._getUnsubscribeCallback;
- var old_addSub = module.SubscribersList.prototype.addSubscriber;
-
- // Make _getUnsubscribeCallback return the new callback.
- module.SubscribersLoader.prototype._getUnsubscribeCallback =
- function() {
- return unsubscribe_callback;
- };
-
- // Assert in addSubscriber that it's being passed the new
- // callback in the config parameter.
- module.SubscribersList.prototype.addSubscriber = function(
- passed_subscriber, passed_level, passed_config) {
- Y.Assert.areSame(unsubscribe_callback,
- passed_config.unsubscribe_callback);
- };
-
- var loader = setUpLoader(this.root);
- loader._addSubscriber(subscriber);
-
- // Restore original methods.
- module.SubscribersLoader.prototype._getUnsubscribeCallback =
- old_getUnsub;
- module.SubscribersList.prototype.addSubscriber = old_addSub;
- },
-
-
- test_loadSubscribersFromList: function() {
- // Accepts a list of dicts with 'subscriber' and 'subscription_level'
- // fields, passing them directly to _addSubscriber() method.
- var data = [{ subscriber: { name: "Subscriber 1" },
- subscription_level: 'Level3' },
- { subscriber: { name: "Subscriber 2" },
- subscription_level: "Unknown" }];
-
- // Save the original method for restoring later.
- var old_addSub = module.SubscribersLoader.prototype._addSubscriber;
-
- var call_count = 0;
- module.SubscribersLoader.prototype._addSubscriber =
- function(subscriber, level) {
- call_count++;
- if (call_count === 1) {
- Y.Assert.areEqual("Subscriber 1", subscriber.name);
- Y.Assert.areEqual('Level3', level);
- } else if (call_count === 2) {
- Y.Assert.areEqual("Subscriber 2", subscriber.name);
- Y.Assert.areEqual("Unknown", level);
- }
- };
-
- var loader = setUpLoader(this.root);
- loader._loadSubscribersFromList(data);
-
- // Two subscribers have been processed total.
- Y.Assert.areEqual(2, call_count);
-
- // Restore the original method.
- module.SubscribersLoader.prototype._addSubscriber = old_addSub;
- },
-
- test_loadSubscribersFromList_not_list_error: function() {
- // When the data is not a list, it throws an error.
- var data = "Not-a-list";
-
- var loader = setUpLoader(this.root);
- loader._loadSubscribersFromList(data);
- },
-
- test_loadSubscribersFromList_no_objects_error: function() {
- // When the data is not a list of objects, it throws an error.
- var data = ["Subscriber"];
-
- var loader = setUpLoader(this.root);
- loader._loadSubscribersFromList(data);
- },
-
- test_loadSubscribers_success: function() {
- // Testing successful operation of _loadSubscribers.
- var details = [
- { subscriber: { name: "subscriber" },
- subscription_level: 'Level3' }
- ];
-
- // Override loadSubscribersList to ensure it gets called with
- // the right parameters.
- var old_loadSubsList =
- module.SubscribersLoader.prototype._loadSubscribersFromList;
- var loading_done = false;
- module.SubscribersLoader.prototype._loadSubscribersFromList =
- function(my_details) {
- Y.Assert.areSame(details, my_details);
- loading_done = true;
- };
-
- var loader = setUpLoader(this.root);
-
- // Mock lp_client for testing.
- loader.lp_client = {
- get: function(uri, get_config) {
- // Assert that there is activity in progress.
- var node = loader.subscribers_list.container_node
- .one('.global-activity-indicator');
- Y.Assert.isNotNull(node);
- // Call the success handler.
- get_config.on.success(details);
- }
- };
- // Re-run _loadSubscribers with our mock methods in place.
- loader._loadSubscribers();
-
- // Assert that _loadSubscribersList was run in the process.
- Y.Assert.isTrue(loading_done);
-
- // And activity node was removed when everything was done.
- var node = loader.subscribers_list.container_node
- .one('.global-activity-indicator');
- Y.Assert.isNull(node);
-
- // Restore original method.
- module.SubscribersLoader.prototype._loadSubscribersFromList =
- old_loadSubsList;
- },
-
- test_loadSubscribers_failure: function() {
- // On failure to load, activity indication is set to an error
- // message received from the server.
- var details = [
- { subscriber: { name: "subscriber" },
- subscription_level: 'Level3' }
- ];
-
- var loader = setUpLoader(this.root);
-
- // Mock lp_client for testing erroring out with 'BOOM'.
- loader.lp_client = {
- get: function(uri, get_config) {
- // Assert that there is activity in progress.
- var node = loader.subscribers_list.container_node
- .one('.global-activity-indicator');
- Y.Assert.isNotNull(node);
- // Call the success handler.
- get_config.on.failure(1,{ status: 403,
- statusText: 'BOOM',
- responseText: '' });
- }
- };
- // Re-run _loadSubscribers with our mock methods in place.
- loader._loadSubscribers();
-
- // And activity node is there with an error message.
- var node = loader.subscribers_list.container_node
- .one('.global-activity-indicator');
- Y.Assert.isNotNull(node);
- Y.Assert.areEqual('file:///@@/error', node.one('img').get('src'));
- Y.Assert.areEqual(' Problem loading subscribers. 403 BOOM',
- node.one('span').get('text'));
- }
-}));
-
-
-
-/**
- * Test SubscribersLoader unsubscribe callback function.
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersLoader() unsubscribe test',
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- // Monkey-patch animation duration to make the tests quicker.
- this.anim_duration = Y.lp.anim.flash_in.defaults.duration;
- Y.lp.anim.flash_in.defaults.duration = 0;
- },
-
- tearDown: function() {
- this.root.remove();
- Y.lp.anim.flash_in.defaults.duration = this.anim_duration;
- },
-
- test_unsubscribe_callback_success: function() {
- // _getUnsubscribeCallback returns a function which takes
- // subscribers list and subscriber as the two parameters.
- // That function calls 'unsubscribe' API method on the bug
- // to unsubscribe the user, and on successful completion,
- // it removes the user from the subscribers list.
-
- // Mock LP client.
- var received_uri, received_method, received_params;
- var config = {};
- config.lp_client = {
- named_post: function(uri, method, my_conf) {
- received_uri = uri;
- received_method = method;
- received_params = my_conf.parameters;
- my_conf.on.success();
- },
- get: function() {}
- };
- var subscriber = { name: "user", "can_edit": true,
- self_link: "user-self-link" };
-
- // Mock removeSubscriber method to ensure it's called.
- var removed_subscriber = false;
- var old_rmSub = module.SubscribersList.prototype.removeSubscriber;
- module.SubscribersList.prototype.removeSubscriber = function(
- my_subscriber) {
- Y.Assert.areSame(subscriber.name, my_subscriber.name);
- removed_subscriber = true;
- };
-
- var loader = setUpLoader(this.root, config);
- var unsub_callback = loader._getUnsubscribeCallback();
- loader._addSubscriber(subscriber);
- unsub_callback(loader.subscribers_list, subscriber);
-
- Y.Assert.areSame(loader.context.self_link, received_uri);
- Y.Assert.areSame('unsubscribe', received_method);
- Y.Assert.areSame(subscriber.self_link, received_params.person);
-
- this.wait(function() {
- // Removal is triggered from the stopSubscriberActivity,
- // which shows the success animation first.
- Y.Assert.isTrue(removed_subscriber);
- }, 50);
-
- // Restore the real method.
- module.SubscribersList.prototype.removeSubscriber = old_rmSub;
- },
-
- test_unsubscribe_callback_failure: function() {
- // Function returned by _getUnsubscribeCallback calls
- // 'unsubscribe' API method on the bug, and on failure,
- // it keeps the user in the list and calls
- // stopSubscriberActivity to indicate the failure.
-
- // Mock LP client.
- var config = {};
- config.lp_client = {
- named_post: function(uri, method, my_conf) {
- my_conf.on.failure(0, { status: 500, statusText: "BOOM!" });
- },
- get: function() {}
- };
- var subscriber = { name: "user", "can_edit": true,
- self_link: "user-self-link" };
-
- // Mock stopSubscriberActivity to ensure it's called.
- var subscriber_activity_stopped = false;
- var old_method =
- module.SubscribersList.prototype.stopSubscriberActivity;
- module.SubscribersList.prototype.stopSubscriberActivity = function(
- my_subscriber, success, callback) {
- Y.Assert.areSame(subscriber.name, my_subscriber.name);
- // The passed-in parameter indicates failure.
- Y.Assert.isFalse(success);
- // And there is no callback.
- Y.Assert.isUndefined(callback);
- subscriber_activity_stopped = true;
- };
-
- // Ensure display_error is called.
- var error_shown = false;
- var old_error_method = Y.lp.app.errors.display_error;
- Y.lp.app.errors.display_error = function(text) {
- error_shown = true;
- };
-
- var loader = setUpLoader(this.root, config);
- var unsub_callback = loader._getUnsubscribeCallback();
- loader._addSubscriber(subscriber);
- unsub_callback(loader.subscribers_list, subscriber);
-
- Y.Assert.isTrue(subscriber_activity_stopped);
- Y.Assert.isTrue(error_shown);
-
- // Restore original methods.
- module.SubscribersList.prototype.stopSubscriberActivity = old_method;
- Y.lp.app.errors.display_error = old_error_method;
- }
-
-}));
-
-
-
-/**
- * Test SubscribersLoader subscribe-someone-else functionality.
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersLoader() subscribe-someone-else test',
-
- _should: {
- error: {
- test_setupSubscribeSomeoneElse_error:
- new Error("No link matching CSS selector " +
- "'#sub-someone-else-link' " +
- "for subscribing someone else found.")
- }
- },
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- // Monkey-patch animation duration to make the tests quicker.
- this.anim_duration = Y.lp.anim.flash_in.defaults.duration;
- Y.lp.anim.flash_in.defaults.duration = 0;
- },
-
- tearDown: function() {
- this.root.remove();
- Y.lp.anim.flash_in.defaults.duration = this.anim_duration;
- },
-
- test_constructor_calls_setup: function() {
- // When subscribe_someone_else_link is passed in the constructor,
- // link identified by that CSS selector is set to pop up a person
- // picker for choosing a person/team to subscribe.
- var config = {
- subscribe_someone_else_link: '#sub-someone-else-link'
- };
-
- var setup_called = false;
- // Replace the original method to ensure it's getting called.
- var old_method =
- module.SubscribersLoader.prototype._setupSubscribeSomeoneElse;
- module.SubscribersLoader.prototype._setupSubscribeSomeoneElse =
- function() {
- setup_called = true;
- };
-
- var loader = setUpLoader(this.root, config);
-
- Y.Assert.isTrue(setup_called);
-
- // Restore original method.
- module.SubscribersLoader.prototype._setupSubscribeSomeoneElse =
- old_method;
- },
-
- test_setupSubscribeSomeoneElse_error: function() {
- // When link is not found in the page, exception is raised.
-
- // Initialize the loader with no subscribe-someone-else link.
- var loader = setUpLoader(this.root);
- loader.subscribe_someone_else_link = '#sub-someone-else-link';
- loader._setupSubscribeSomeoneElse();
- },
-
- test_setupSubscribeSomeoneElse_not_logged_in: function() {
- // When user is not logged in (LP.links.me undefined),
- // it silently does nothing.
-
- // Initialize the loader and make sure the user is not logged in.
- var loader = setUpLoader(this.root);
- window.LP.links.me = undefined;
- loader._setupSubscribeSomeoneElse();
- // Nothing happens, not even a person picker is set up.
- Y.Assert.isUndefined(loader._picker);
- },
-
- test_setupSubscribeSomeoneElse: function() {
- // _setupSubscribeSomeoneElse ties in a link with
- // the appropriate person picker and with the save
- // handler that calls _subscribePersonURI with the
- // selected person URI as the parameter.
-
- // Initialize the loader with no subscribe-someone-else link.
- var loader = setUpLoader(this.root);
-
- // Mock LP client that always returns a person-like object.
- var subscriber = { name: "user", "can_edit": true,
- self_link: "/~user",
- api_uri: "/~user" };
-
- loader.subscribe_someone_else_link = '#sub-someone-else-link';
- var link = Y.Node.create('<a />').set('id', 'sub-someone-else-link');
- this.root.appendChild(link);
-
- // Mock _subscribePersonURI method to ensure it's called.
- var subscribe_done = false;
- var old_method =
- module.SubscribersLoader.prototype._subscribePersonURI;
- module.SubscribersLoader.prototype._subscribePersonURI =
- function(person_uri) {
- Y.Assert.isNotNull(
- person_uri.match(subscriber.api_uri + "$"));
- subscribe_done = true;
- };
-
- // Mock the picker creation as well.
- var picker_shown = false;
- var old_create_picker = Y.lp.app.picker.create;
- Y.lp.app.picker.create = function(vocabulary, my_config) {
- Y.Assert.areSame('ValidPersonOrTeam', vocabulary);
- // On link click, simulate the save action.
- link.on('click', function() {
- picker_shown = true;
- my_config.save(subscriber);
- });
- };
-
- loader._setupSubscribeSomeoneElse();
-
- // Show the picker and simulate the save action.
- link.simulate('click');
-
- Y.Assert.isTrue(picker_shown);
- Y.Assert.isTrue(subscribe_done);
-
- // Restore original methods.
- module.SubscribersLoader.prototype._subscribePersonURI =
- old_method;
- Y.lp.app.picker.create = old_create_picker;
- },
-
- test_setupSubscribeSomeoneElse_failure: function() {
- // When fetching a person as returned by the picker fails
- // error message is shown.
-
- // Initialize the loader with no subscribe-someone-else link.
- var loader = setUpLoader(this.root);
-
- // Mock LP client that always returns a person-like object.
- var subscriber = { name: "user", "can_edit": true,
- self_link: "/~user",
- api_uri: "/~user" };
- loader.lp_client = {
- get: function(uri, conf) {
- conf.on.failure(99, { status: 500,
- statusText: "BOOM" });
- }
- };
- var expected_error_msg = "500 (BOOM)\n" +
- "Couldn't get subscriber details from the " +
- "server, so they have not been subscribed.\n";
- var received_error_msg;
-
- // Mock display_error to ensure it's called.
- var old_display_error = Y.lp.app.errors.display_error;
- Y.lp.app.errors.display_error = function(animate, msg) {
- Y.Assert.isFalse(animate);
- received_error_msg = msg;
- };
-
- loader.subscribe_someone_else_link = '#sub-someone-else-link';
- var link = Y.Node.create('<a />').set('id', 'sub-someone-else-link');
- this.root.appendChild(link);
-
- // Mock the picker creation as well.
- var old_create_picker = Y.lp.app.picker.create;
- Y.lp.app.picker.create = function(vocabulary, my_config) {
- Y.Assert.areSame('ValidPersonOrTeam', vocabulary);
- // On link click, simulate the save action.
- link.on('click', function() {
- my_config.save(subscriber);
- });
- };
-
- loader._setupSubscribeSomeoneElse();
-
- // Show the picker and simulate the save action.
- link.simulate('click');
-
- // display_error was called with the appropriate error message.
- Y.Assert.areSame(expected_error_msg, received_error_msg);
-
- // Restore original methods.
- Y.lp.app.errors.display_error = old_display_error;
- Y.lp.app.picker.create = old_create_picker;
- }
-}));
-
-/**
- * Test SubscribersLoader helper method to update the "subscribe" link attrs.
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersLoader() _updateSubscribeMeLink test',
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- var link = Y.Node.create('<a />').set('id', 'sub-me-link');
- this.root.appendChild(link);
-
- var config = {
- subscribe_me_link: '#sub-me-link',
- subscribed_help_text: "Subscribed help",
- unsubscribed_help_text: "Unsubscribed help"
- };
- this.loader = setUpLoader(this.root, config);
- this.loader._setupSubscribeMe();
- },
-
- tearDown: function() {
- this.root.remove();
- },
-
- test_update_link_when_subscribed: function() {
- this.loader._updateSubscribeMeLink(true);
- var link = Y.one('#sub-me-link');
- Y.Assert.areEqual('Unsubscribe', link.get('text'));
- Y.Assert.areEqual('Subscribed help', link.get('title'));
- Y.Assert.isTrue(link.hasClass('remove'));
- },
-
- test_update_link_when_unsubscribed: function() {
- this.loader._updateSubscribeMeLink(false);
- var link = Y.one('#sub-me-link');
- Y.Assert.areEqual('Subscribe', link.get('text'));
- Y.Assert.areEqual('Unsubscribed help', link.get('title'));
- Y.Assert.isTrue(link.hasClass('add'));
- }
-}));
-
-/**
- * Test SubscribersLoader subscribe-me functionality.
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersLoader() subscribe-me test',
-
- _should: {
- error: {
- test_setupSubscribeMe_error:
- new Error("No link matching CSS selector " +
- "'#sub-not-found-me-link' " +
- "for subscribing me found.")
- }
- },
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- var link = Y.Node.create('<a />').set('id', 'sub-me-link');
- this.root.appendChild(link);
-
- // Monkey-patch animation duration to make the tests quicker.
- this.anim_duration = Y.lp.anim.flash_in.defaults.duration;
- Y.lp.anim.flash_in.defaults.duration = 0;
- },
-
- tearDown: function() {
- this.root.remove();
- Y.lp.anim.flash_in.defaults.duration = this.anim_duration;
- },
-
- _setUpLoaderWithSubscribeMeLink: function(setup_config) {
- var config = {
- subscribe_me_link: '#sub-me-link'
- };
- if (Y.Lang.isValue(setup_config)) {
- setup_config = Y.mix(config, setup_config);
- } else {
- setup_config = config;
- }
- return setUpLoader(this.root, setup_config);
- },
-
- test_constructor_calls_setup: function() {
- // When subscribe_me_link is passed in the constructor,
- // link identified by that CSS selector is set perform the subscribe
- // operation by calling _setupSubscribeMe.
-
- var setup_called = false;
- // Replace the original method to ensure it's getting called.
- var old_method =
- module.SubscribersLoader.prototype._setupSubscribeMe;
- module.SubscribersLoader.prototype._setupSubscribeMe =
- function() {
- setup_called = true;
- };
-
- var config = {
- lp_client: {
- get: function(uri, conf) {
- conf.on.success([]);
- }
- }
- };
- this._setUpLoaderWithSubscribeMeLink(config);
-
- Y.Assert.isTrue(setup_called);
-
- // Restore original method.
- module.SubscribersLoader.prototype._setupSubscribeMe =
- old_method;
- },
-
- test_setupSubscribeMe_error: function() {
- // When link is not found in the page, exception is raised.
-
- // Initialize the loader with no subscribe-me link.
- var loader = setUpLoader(this.root);
- loader.subscribe_me_link = '#sub-not-found-me-link';
- loader._setupSubscribeMe();
- },
-
- test_setupSubscribeMe_not_logged_in: function() {
- // When user is not logged in (LP.links.me undefined),
- // it silently does nothing.
-
- // Initialize the loader and make sure the user is not logged in.
- var loader = this._setUpLoaderWithSubscribeMeLink();
- window.LP.links.me = undefined;
- loader._setupSubscribeMe();
- // Nothing happens, no js-action class is added to link.
- Y.Assert.isFalse(Y.one(loader.subscribe_me_link)
- .hasClass('js-action'));
- },
-
- test_subscribeMe: function() {
- // When the current logged in user is not already subscribed, the
- // _setupSubscribeMe ties in a link with the save
- // handler that calls _subscribePersonURI with the
- // current logged in person URI as the parameter.
-
- var update_link_done = false;
- var old_update_method =
- module.SubscribersLoader.prototype._updateSubscribeMeLink;
- module.SubscribersLoader.prototype._updateSubscribeMeLink =
- function(is_subscribed) {
- Y.Assert.isFalse(is_subscribed);
- update_link_done = true;
- };
-
- var config = {
- lp_client: {
- get: function(uri, conf) {
- conf.on.success([]);
- }
- }
- };
-
- var loader = this._setUpLoaderWithSubscribeMeLink(config);
- // The loader should not have had the _unsubscribe_me callback set.
- Y.Assert.isUndefined(loader._unsubscribe_me);
- // The "subscribe" link should be correctly updated.
- Y.Assert.isTrue(update_link_done);
-
- window.LP.links.me = "/~user";
- // Mock _subscribePersonURI method to ensure it's called.
- var subscribe_done = false;
- var old_method =
- module.SubscribersLoader.prototype._subscribePersonURI;
- module.SubscribersLoader.prototype._subscribePersonURI =
- function(person_uri) {
- Y.Assert.isNotNull(
- person_uri.match("/~user$"));
- subscribe_done = true;
- };
- var activity_started = false;
- var old_start = module.SubscribersList.prototype.startActivity;
- module.SubscribersList.prototype.startActivity =
- function(text) {
- Y.Assert.areEqual(text, "Subscribing...");
- activity_started = true;
- };
-
- loader._setupSubscribeMe();
-
- // Simulate the subscribe action.
- var link = Y.one('#sub-me-link');
- link.simulate('click');
-
- Y.Assert.isTrue(subscribe_done);
- Y.Assert.isTrue(activity_started, 'activity was not started');
-
- // Restore original methods.
- module.SubscribersLoader.prototype._subscribePersonURI =
- old_method;
- module.SubscribersLoader.prototype._updateSubscribeMeLink =
- old_update_method;
- module.SubscribersList.prototype.startActivity = old_start;
- },
-
- test_unsubscribeMe: function() {
- // When the current logged in user is already subscribed, the
- // _setupSubscribeMe ties in a link with the save
- // handler that calls the relevant unsubscribe callback.
-
- // Mock the unsubscribe callback method to ensure it's called.
- var unsubscribe_done = false;
- var old_callback_method =
- module.SubscribersLoader.prototype._getUnsubscribeCallback;
- module.SubscribersLoader.prototype._getUnsubscribeCallback =
- function() {
- return function(subscribers_list, subscriber) {
- Y.Assert.isNotNull(
- subscriber.self_link.match('/~viewer$'));
- unsubscribe_done = true;
- };
- };
- var update_link_done = false;
- var old_update_method =
- module.SubscribersLoader.prototype._updateSubscribeMeLink;
- module.SubscribersLoader.prototype._updateSubscribeMeLink =
- function(is_subscribed) {
- Y.Assert.isTrue(is_subscribed);
- update_link_done = true;
- };
-
- var config = {
- lp_client: {
- get: function(uri, conf) {
- var me = {
- 'self_link': '/~viewer'};
- var record = {
- 'subscriber': me,
- 'subscription_level': 'Direct'};
- conf.on.success([record]);
- }
- }
- };
- var loader = this._setUpLoaderWithSubscribeMeLink(config);
-
- // The loader should have had the _unsubscribe_me callback set.
- Y.Assert.isFunction(loader._unsubscribe_me);
- // The "subscribe" link should be correctly updated.
- Y.Assert.isTrue(update_link_done);
-
- var link = Y.one('#sub-me-link');
- // Simulate the subscribe action.
- link.simulate('click');
-
- Y.Assert.isTrue(unsubscribe_done);
-
- // Restore original methods.
- module.SubscribersLoader.prototype._getUnsubscribeCallback =
- old_callback_method;
- module.SubscribersLoader.prototype._updateSubscribeMeLink =
- old_update_method;
- },
-
- test_setupSubscribeMe_failure: function() {
- // When fetching the details for the current logged in user fails
- // an error message is shown.
-
- var config = {
- lp_client: {
- get: function(uri, conf) {
- if (uri==='/base/+details') {
- conf.on.success([]);
- } else {
- conf.on.failure(99, { status: 500,
- statusText: "BOOM" });
- }
- }
- }
- };
- var loader = this._setUpLoaderWithSubscribeMeLink(config);
-
- var expected_error_msg = "500 (BOOM)\n" +
- "Couldn't get subscriber details from the " +
- "server, so they have not been subscribed.\n";
- var received_error_msg;
-
- // Mock display_error to ensure it's called.
- var old_display_error = Y.lp.app.errors.display_error;
- Y.lp.app.errors.display_error = function(animate, msg) {
- Y.Assert.isFalse(animate);
- received_error_msg = msg;
- };
-
- loader._setupSubscribeMe();
-
- // Simulate the subscribe action.
- var link = Y.one('#sub-me-link');
- link.simulate('click');
-
- // display_error was called with the appropriate error message.
- Y.Assert.areSame(expected_error_msg, received_error_msg);
-
- // Restore original methods.
- Y.lp.app.errors.display_error = old_display_error;
- }
-}));
-
-/**
- * Test SubscribersLoader _subscribe functionality.
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersLoader() _subscribe',
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- // Monkey-patch animation duration to make the tests quicker.
- this.anim_duration = Y.lp.anim.flash_in.defaults.duration;
- Y.lp.anim.flash_in.defaults.duration = 0;
- },
-
- tearDown: function() {
- this.root.remove();
- Y.lp.anim.flash_in.defaults.duration = this.anim_duration;
- },
-
- test_subscribePersonURI: function() {
- // _subscribePersonURI retrieves the details for the specified
- // person URI from the server and calls _subscribe().
-
- var loader = setUpLoader(this.root);
-
- // Mock LP client that always returns a person-like object.
- var subscriber = { name: "user", self_link: "/~user"};
- loader.lp_client = {
- get: function(uri, conf) {
- subscriber.api_uri = uri;
- conf.on.success(subscriber);
- }
- };
-
- // Mock _subscribe method to ensure it's called.
- var subscribe_done = false;
- var old_method =
- module.SubscribersLoader.prototype._subscribe;
- module.SubscribersLoader.prototype._subscribe =
- function(person) {
- Y.Assert.areSame(person, subscriber);
- subscribe_done = true;
- };
-
- loader._subscribePersonURI("/~user");
- Y.Assert.isTrue(subscribe_done);
-
- // Restore original methods.
- module.SubscribersLoader.prototype._subscribe = old_method;
- },
-
- test_subscribe: function() {
- // _subscribe method takes a Person object as returned
- // by the API, and adds that subscriber at 'Level1' level.
-
- var subscriber = { self_link: "/~user" };
-
- // Mock-up addSubscriber method to ensure subscriber is added.
- var subscriber_added = false;
- var old_addSub = module.SubscribersList.prototype.addSubscriber;
- module.SubscribersList.prototype.addSubscriber = function(
- my_subscriber, level) {
- Y.Assert.areSame(subscriber, my_subscriber);
- subscriber_added = true;
- };
-
- // Mock-up indicateSubscriberActivity to ensure it's called.
- var activity_on = false;
- var old_indicate =
- module.SubscribersList.prototype.indicateSubscriberActivity;
- module.SubscribersList.prototype.indicateSubscriberActivity =
- function(my_subscriber) {
- Y.Assert.areSame(subscriber, my_subscriber);
- activity_on = true;
- };
-
- // Initialize the loader.
- var loader = setUpLoader(this.root);
-
- // Mock lp_client which records the call.
- var received_method, received_uri, received_params;
- loader.lp_client = {
- named_post: function(uri, method, conf) {
- received_uri = uri;
- received_method = method;
- received_params = conf.parameters;
- }
- };
-
- // Wrap subscriber like an API-returned value.
- var person = {
- getAttrs: function() {
- return subscriber;
- }
- };
-
- loader._subscribe(person);
-
- Y.Assert.isTrue(subscriber_added);
- Y.Assert.isTrue(activity_on);
-
- Y.Assert.areEqual('subscribe', received_method);
- Y.Assert.areEqual(loader.context.self_link, received_uri);
- Y.Assert.areEqual(subscriber.self_link, received_params.person);
-
- // Restore original methods.
- module.SubscribersList.prototype.addSubscriber = old_addSub;
- module.SubscribersList.prototype.indicateSubscriberActivity =
- old_indicate;
- },
-
- test_subscribe_success_with_list_update: function() {
- // When subscribing someone such that the subscribers list should be
- // updated, check that the correct start/stop progress indication
- // calls are used ie stopSubscriberActivity is called indicating
- // success, and addUnsubscribeAction is called with the correct
- // parameters.
-
- var subscriber = { name: "user", self_link: "/~user" };
-
- // Initialize the loader.
- var loader = setUpLoader(this.root);
- loader.subscribers_list.addSubscriber(subscriber, 'Default');
-
- // Mock-up addUnsubscribeAction method to
- // ensure it's called with the right parameters.
- // We need to stub the _getUnsubscribeCallback result so we can check
- // the unsubscribe_callback.
- var unsubscribe_callback = function() {};
- // Save old methods for restoring later.
- var old_getUnsub = module.SubscribersLoader.prototype
- ._getUnsubscribeCallback;
-
- // Make _getUnsubscribeCallback return the new callback.
- module.SubscribersLoader.prototype._getUnsubscribeCallback =
- function() {
- return unsubscribe_callback;
- };
-
- var unsubscribe_link_added = false;
- var old_unsubscribe_action =
- module.SubscribersList.prototype.addUnsubscribeAction;
- module.SubscribersList.prototype.addUnsubscribeAction =
- function(my_subscriber, callback) {
- Y.Assert.areSame(subscriber, my_subscriber);
- Y.Assert.areEqual(unsubscribe_callback, callback);
- unsubscribe_link_added = true;
- };
-
- // Mock-up stopSubscriberActivity to ensure it's called.
- var activity_on = true;
- var old_indicate =
- module.SubscribersList.prototype.stopSubscriberActivity;
- module.SubscribersList.prototype.stopSubscriberActivity =
- function(my_subscriber, success) {
- Y.Assert.areSame(subscriber, my_subscriber);
- Y.Assert.isTrue(success);
- activity_on = false;
- };
-
- // Mock lp_client which calls the success handler.
- loader.lp_client = {
- named_post: function(uri, method, conf) {
- conf.on.success();
- }
- };
-
- // Wrap subscriber like an API-returned value.
- var person = {
- getAttrs: function() {
- return subscriber;
- }
- };
-
- loader._subscribe(person, 'Level1');
-
- Y.Assert.isTrue(unsubscribe_link_added);
- Y.Assert.isFalse(activity_on);
-
- // Restore original methods.
- module.SubscribersList.prototype.addUnsubscribeAction =
- old_unsubscribe_action;
- module.SubscribersLoader.prototype._getUnsubscribeCallback =
- old_getUnsub;
- module.SubscribersList.prototype.stopSubscriberActivity =
- old_indicate;
-
- },
-
- test_subscribe_success_without_list_update: function() {
- // When subscribing someone such that the subscribers list should not
- // updated, check that the correct stop progress indication
- // call is used ie stopActivity is called indicating success.
-
- var subscriber = { name: "user", self_link: "/~user" };
-
- // Initialize the loader.
- var loader = setUpLoader(this.root, {display_me_in_list: false});
- loader.subscribers_list.addSubscriber(subscriber, 'Default');
- window.LP.links.me = "/~user";
-
- // Mock-up stopActivity to ensure it's called.
- var activity_stopped = false;
- var old_stop = module.SubscribersList.prototype.stopActivity;
- module.SubscribersList.prototype.stopActivity =
- function() {
- activity_stopped = true;
- };
-
- // Mock lp_client which calls the success handler.
- loader.lp_client = {
- named_post: function(uri, method, conf) {
- conf.on.success();
- }
- };
-
- // Wrap subscriber like an API-returned value.
- var person = {
- getAttrs: function() {
- return subscriber;
- }
- };
-
- loader._subscribe(person, 'Level1');
- Y.Assert.isTrue(activity_stopped, 'activity was not stopped');
-
- // Restore original methods.
- module.SubscribersList.prototype.stopActivity = old_stop;
- },
-
- test_subscribe_failure: function() {
- // When subscribing fails, stopSubscriberActivity
- // is called indicating failure and it calls removeSubscriber
- // from the callback when animation completes.
- // Error is shown as well.
-
- var subscriber = { name: "user", self_link: "/~user",
- display_name: "User Name" };
-
- // Initialize the loader.
- var loader = setUpLoader(this.root);
- loader.subscribers_list.addSubscriber(subscriber, 'Default');
-
- // Mock-up removeSubscriber to ensure it's called.
- var remove_called = false;
- var old_remove =
- module.SubscribersList.prototype.removeSubscriber;
- module.SubscribersList.prototype.removeSubscriber =
- function(my_subscriber) {
- Y.Assert.areSame(subscriber, my_subscriber);
- remove_called = true;
- };
-
- // Ensure display_error is called.
- var old_error_method = Y.lp.app.errors.display_error;
- var received_error;
- Y.lp.app.errors.display_error = function(anim, text) {
- received_error = text;
- };
-
- // Mock lp_client which calls the failure handler.
- loader.lp_client = {
- named_post: function(uri, method, conf) {
- conf.on.failure(99, { status: 500,
- statusText: "BOOM" });
- }
- };
-
- // Wrap subscriber like an API-returned value.
- var person = {
- getAttrs: function() {
- return subscriber;
- }
- };
-
- loader._subscribe(person, 'Level1');
-
- Y.Assert.areSame('500 (BOOM). Failed to subscribe User Name.',
- received_error);
-
- // Remove function is only called after animation completes.
- this.wait(function() {
- Y.Assert.isTrue(remove_called);
- }, 50);
-
- // Restore original methods.
- module.SubscribersList.prototype.removeSubscriber = old_remove;
- Y.lp.app.errors.display_error = old_error_method;
-
- }
-}));
-
-/**
- * Re-test several resetNoSubscribers() tests that need config options merging
- * (LP Bug 837290)
- */
-suite.add(new Y.Test.Case({
- name: 'SubscribersLoader.SubscribersList.resetNoSubscribers() re-test',
-
- setUp: function() {
- this.root = Y.Node.create('<div />');
- Y.one('body').appendChild(this.root);
- },
-
- tearDown: function() {
- this.root.remove();
- },
-
- test_no_subscribers: function() {
- // When resetNoSubscribers() is called on an empty
- // SubscribersList, indication of no subscribers is added.
- // In addition, this checks that the default configuration options
- // have been correctly merged without SubscribersLoader()
- var loader = setUpLoader(this.root);
- var subscribers_list = loader.subscribers_list;
- subscribers_list.resetNoSubscribers();
- var no_subs_nodes = this.root.all(
- '.no-subscribers-indicator');
- Y.Assert.areEqual(1, no_subs_nodes.size());
- Y.Assert.areEqual('No other subscribers.',
- no_subs_nodes.item(0).get('text'));
- },
-
- test_no_subscribers_no_levels: function() {
- // When resetNoSubscribers() is called on an empty
- // SubscribersList, indication of no subscribers is added. If there
- // are no subscriber_levels, a different message is displayed.
- // In addition, this checks that the default configuration options
- // have been correctly merged without SubscribersLoader()
- var loader = setUpLoader(this.root);
- var subscribers_list = loader.subscribers_list;
- subscribers_list.subscriber_levels = [];
- subscribers_list.resetNoSubscribers();
- var no_subs_nodes = this.root.all(
- '.no-subscribers-indicator');
- Y.Assert.areEqual(1, no_subs_nodes.size());
- Y.Assert.areEqual('No subscribers.',
- no_subs_nodes.item(0).get('text'));
- }
-}));
-
-
-Y.lp.testing.Runner.run(suite);
-
+ },
+
+ test_removeSubscriber_error: function() {
+ // Removing a non-existent subscriber fails with an error.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ subscribers_list.removeSubscriber(subscriber);
+ },
+
+ test_removeSubscriber_section_removed: function() {
+ // Removing a subscriber works when the subscriber is in the list.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ var subscriber_node = subscribers_list.addSubscriber(
+ subscriber, 'Level3');
+ var section_node = subscriber_node.ancestor('.subscribers-section');
+ subscribers_list.removeSubscriber(subscriber);
+ // Entire section is removed along with the subscriber.
+ Y.Assert.areEqual(0, _getAllSections(subscribers_list).length);
+ },
+
+ test_removeSubscriber_section_remains: function() {
+ // Removing a subscriber works when the subscriber is in the list.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ var other_node = subscribers_list.addSubscriber(
+ { name: 'other' }, 'Level3');
+ var subscriber_node = subscribers_list.addSubscriber(
+ subscriber, 'Level3');
+ var section_node = subscriber_node.ancestor('.subscribers-section');
+ subscribers_list.removeSubscriber(subscriber);
+ // Section is not removed because it still has 'other' subscriber.
+ var all_sections = _getAllSections(subscribers_list);
+ Y.Assert.areEqual(1, all_sections.length);
+ // User is removed.
+ Y.Assert.isNull(all_sections[0].one('#subscriber-user'));
+ // Other is still in the list.
+ Y.Assert.areSame(
+ other_node, all_sections[0].one('#subscriber-other'));
+ },
+
+ test_removeSubscriber_not_in_section_error: function() {
+ // If subscriber is not in a section, an exception is thrown.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var node = Y.Node.create('<div />')
+ .set('id', 'subscriber-user');
+ // We hack the node directly into the entire subscribers list node.
+ subscribers_list.container_node.appendChild(node);
+ subscribers_list.removeSubscriber({ name: 'user' });
+ }
+ }));
+
+ /**
+ * Test showing/stopping indication of activity for a subscriber.
+ */
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersList.indicateSubscriberActivity() and ' +
+ 'SubscribersList.stopSubscriberActivity() test',
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ // Monkey-patch animation duration to make the tests quicker.
+ this.anim_duration = Y.lp.anim.flash_in.defaults.duration;
+ Y.lp.anim.flash_in.defaults.duration = 0;
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ Y.lp.anim.flash_in.defaults.duration = this.anim_duration;
+ },
+
+ _should: {
+ error: {
+ test_indicateSubscriberActivity_error:
+ new Error('Subscriber is not present in the subscribers ' +
+ 'list. Please call addSubscriber(subscriber) first.'),
+ test_stopSubscriberActivity_error:
+ new Error('Subscriber is not present in the subscribers ' +
+ 'list. Please call addSubscriber(subscriber) first.')
+ }
+ },
+
+ test_indicateSubscriberActivity_error: function() {
+ // When subscriber is not in the list, fails with an exception.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ subscribers_list.indicateSubscriberActivity(subscriber);
+ },
+
+ test_indicateSubscriberActivity_node: function() {
+ // Creates a node with spinner image in it.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ var node = subscribers_list.addSubscriber(subscriber, 'Level3');
+ subscribers_list.indicateSubscriberActivity(subscriber);
+
+ // This is the created node.
+ var progress_node = node.one('.subscriber-activity-indicator');
+ Y.Assert.isNotNull(progress_node);
+ var progress_icon = progress_node.one('img');
+ // We get an absolute URI, instead of the relative one which
+ // the code sets. Since the test runs from the local file system,
+ // that means "file://".
+ Y.Assert.areEqual('file:///@@/spinner', progress_icon.get('src'));
+ },
+
+ test_indicateSubscriberActivity_actions_hidden: function() {
+ // If there are any actions (in an actions node), they are
+ // all hidden.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ var node = subscribers_list.addSubscriber(subscriber, 'Level3');
+ var actions_node = subscribers_list._getOrCreateActionsNode(node);
+
+ subscribers_list.indicateSubscriberActivity(subscriber);
+ Y.Assert.areEqual('none', actions_node.getStyle('display'));
+ },
+
+ test_stopSubscriberActivity_error: function() {
+ // When subscriber is not in the list, fails with an exception.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ subscribers_list.stopSubscriberActivity(subscriber);
+ },
+
+ test_stopSubscriberActivity_noop: function() {
+ // When there's no activity in progress, nothing happens.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ var node = subscribers_list.addSubscriber(subscriber, 'Level3');
+ subscribers_list.stopSubscriberActivity(subscriber);
+ },
+
+ test_stopSubscriberActivity_spinner_removed: function() {
+ // When there is some activity in progress, spinner is removed.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ var node = subscribers_list.addSubscriber(subscriber, 'Level3');
+ // Create the spinner.
+ subscribers_list.indicateSubscriberActivity(subscriber);
+ // And remove it.
+ subscribers_list.stopSubscriberActivity(subscriber);
+ Y.Assert.isNull(node.one('.subscriber-activity-indicator'));
+ },
+
+ test_stopSubscriberActivity_actions_restored: function() {
+ // When there is some activity in progress, spinner is removed.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ var node = subscribers_list.addSubscriber(subscriber, 'Level3');
+ var actions_node = subscribers_list._getOrCreateActionsNode(node);
+ // Hide actions.
+ actions_node.setStyle('display', 'none');
+ // And restore actions.
+ subscribers_list.stopSubscriberActivity(subscriber);
+ Y.Assert.areEqual('inline', actions_node.getStyle('display'));
+ },
+
+ test_stopSubscriberActivity_success_callback: function() {
+ // When we are indicating successful/failed operation,
+ // green_flash/red_flash animation is executed and callback
+ // function is called when it ends.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ subscribers_list.addSubscriber(subscriber, 'Level3');
+ var callback_called = false;
+ var callback = function() {
+ callback_called = true;
+ };
+
+ subscribers_list.stopSubscriberActivity(
+ subscriber, true, callback);
+ // Callback is not called immediatelly.
+ Y.Assert.isFalse(callback_called);
+ this.wait(function() {
+ // But after waiting for animation to complete,
+ // callback is called.
+ Y.Assert.isTrue(callback_called);
+ }, 50);
+ },
+
+ test_stopSubscriberActivity_no_callback: function() {
+ // When we pass the callback in, but success is neither
+ // 'true' nor 'false', callback is not called.
+ var subscribers_list = setUpSubscribersList(this.root);
+ var subscriber = { name: 'user' };
+ subscribers_list.addSubscriber(subscriber, 'Level3');
+ var callback_called = false;
+ var callback = function() {
+ callback_called = true;
+ };
+
+ subscribers_list.stopSubscriberActivity(
+ subscriber, "no-callback", callback);
+ // Callback is not called.
+ Y.Assert.isFalse(callback_called);
+ this.wait(function() {
+ // Nor is it called after any potential animations complete.
+ Y.Assert.isFalse(callback_called);
+ }, 50);
+ }
+
+ }));
+
+ /**
+ * Test SubscribersLoader class construction.
+ */
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersLoader() construction test',
+
+ _should: {
+ error: {
+ test_SubscribersLoader_container_error:
+ new Error(
+ 'Container node must be specified in config.container_box.'),
+ test_SubscribersLoader_context_error:
+ new Error(
+ "No context specified in `config' or context.web_link " +
+ "is invalid."),
+ test_SubscribersLoader_context_web_link_error:
+ new Error(
+ "No context specified in `config' or context.web_link " +
+ "is invalid."),
+ test_SubscribersLoader_portlet_link_error:
+ new Error(
+ "No config.subscribers_details_view specified to load " +
+ "other subscribers from.")
+ }
+ },
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ },
+
+ test_SubscribersLoader_container_error: function() {
+ // If no container node to hold the subscribers list is specified,
+ // it fails with an error.
+ var loader =
+ new module.SubscribersLoader({
+ container_box: '#not-found',
+ subscriber_levels: []});
+ },
+
+ test_SubscribersLoader_context_error: function() {
+ // Context needs to be passed in as well.
+ // setUpLoader constructs the container node for us.
+ var config = {};
+ setUpLoader(this.root, config, true);
+ },
+
+ test_SubscribersLoader_context_web_link_error: function() {
+ // Fails if the passed in context has no web_link attribute defined.
+ var config = { context: {} };
+ setUpLoader(this.root, config, true);
+ },
+
+ test_SubscribersLoader_portlet_link_error: function() {
+ // Fails if the passed in config has no passed in
+ // portlet URI for loading context subscribers details.
+ var config = { context: { web_link: '' } };
+ setUpLoader(this.root, config, true);
+ },
+
+ test_SubscribersLoader_default_config_parameters: function() {
+ // Check that CONFIG_DEFAULTS are used.
+ var node = Y.Node.create('<div />')
+ .set('id', 'other-subscribers-container');
+ var config = {
+ container_box: '#other-subscribers-container',
+ context: {web_link: '', self_link: ''},
+ subscribers_details_view: '/+details',
+ subscriber_levels: []
+ };
+ this.root.appendChild(node);
+ window.LP = { links: { me : "/~viewer" } };
+
+ // Save original method for restoring later.
+ var old_load = module.SubscribersLoader.prototype._loadSubscribers;
+ module.SubscribersLoader.prototype._loadSubscribers = function() {};
+
+ var loader = new module.SubscribersLoader(config);
+ var default_config = {
+ default_subscriber_level: '',
+ subscribers_label: 'subscribers',
+ subscribe_label:'Subscribe',
+ unsubscribe_label:'Unsubscribe',
+ subscribe_api: 'subscribe',
+ unsubscribe_api: 'unsubscribe'
+ };
+
+ var config_var;
+ for (config_var in default_config) {
+ if (default_config.hasOwnProperty(config_var)) {
+ Y.Assert.areEqual(
+ default_config[config_var], loader[config_var],
+ 'Unexpected config value for ' + config_var);
+ }
+ }
+ // Restore original method.
+ module.SubscribersLoader.prototype._loadSubscribers = old_load;
+ },
+
+ test_SubscribersLoader_default_config_override: function() {
+ // Check that CONFIG_DEFAULTS parameters can be overridden.
+ var node = Y.Node.create('<div />')
+ .set('id', 'other-subscribers-container');
+ var config = {
+ container_box: '#other-subscribers-container',
+ context: {web_link: '', self_link: ''},
+ subscribers_details_view: '/+details',
+ subscriber_levels: []
+ };
+ var override_config = {
+ default_subscriber_level: 'aaa',
+ subscribers_label: 'bbbb',
+ subscribe_label:'cccc',
+ unsubscribe_label:'dddd',
+ subscribe_api: 'eeee',
+ unsubscribe_api: 'ffff'
+ };
+
+ this.root.appendChild(node);
+ window.LP = { links: { me : "/~viewer" } };
+
+ // Save original method for restoring later.
+ var old_load = module.SubscribersLoader.prototype._loadSubscribers;
+ module.SubscribersLoader.prototype._loadSubscribers = function() {};
+
+ config = Y.mix(config, override_config);
+ var loader = new module.SubscribersLoader(config);
+
+ var config_var;
+ for (config_var in override_config) {
+ if (override_config.hasOwnProperty(config_var)) {
+ Y.Assert.areEqual(
+ override_config[config_var], loader[config_var],
+ 'Unexpected config value for ' + config_var);
+ }
+ }
+ // Restore original method.
+ module.SubscribersLoader.prototype._loadSubscribers = old_load;
+ },
+
+ test_SubscribersLoader: function() {
+ // With all the parameters specified, it returns an instance
+ // with subscribers_portlet_uri, subscribers_list, error_handler,
+ // and calls the _loadSubscribers() method.
+ var config = {
+ context: { web_link: '/base' },
+ subscribers_details_view: '/+details'
+ };
+
+ // Save original method for restoring later.
+ var old_load = module.SubscribersLoader.prototype._loadSubscribers;
+
+ var loading_started = false;
+ module.SubscribersLoader.prototype._loadSubscribers = function() {
+ loading_started = true;
+ };
+ var loader = setUpLoader(this.root, config);
+ Y.Assert.areEqual('/base/+details', loader.subscribers_portlet_uri);
+ Y.Assert.isNotNull(loader.subscribers_list);
+ Y.Assert.isTrue(
+ loader.subscribers_list instanceof module.SubscribersList);
+ Y.Assert.isNotNull(loader.error_handler);
+ Y.Assert.isTrue(loading_started);
+ var container_node = Y.one('#other-subscribers-container');
+ Y.Assert.areEqual(
+ loader, container_node.getData('subscribers_loader'));
+
+ // Restore original method.
+ module.SubscribersLoader.prototype._loadSubscribers = old_load;
+ }
+ }));
+
+ /**
+ * Test SubscribersLoader subscribers loading and helper methods.
+ */
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersLoader() subscribers loading test',
+
+ _should: {
+ error: {
+ test_loadSubscribersFromList_not_list_error:
+ new Error('Got non-array "Not-a-list" in ' +
+ '_loadSubscribersFromList().'),
+ test_loadSubscribersFromList_no_objects_error:
+ new Error('Subscriber details at index 0 (Subscriber)' +
+ ' are not an object.')
+ }
+ },
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ },
+
+ test_addSubscriber_wraps_list_addSubscriber: function() {
+ // addSubscriber wraps the SubscribersList.addSubscriber.
+ // When no can_edit is set on the subscriber, no unsubscribe
+ // callback is added.
+ var subscriber = { name: "user", self_link: "/~user" };
+ var level = 'Level1';
+ var call_passed_through = false;
+ // Save the old method for restoring later.
+ var old_addSub = module.SubscribersList.prototype.addSubscriber;
+ module.SubscribersList.prototype.addSubscriber = function(
+ passed_subscriber, passed_level) {
+ call_passed_through = true;
+ Y.Assert.areSame(subscriber, passed_subscriber);
+ Y.Assert.areSame(level, passed_level);
+ };
+ var loader = setUpLoader(this.root);
+ loader._addSubscriber(subscriber, level);
+ Y.Assert.isTrue(call_passed_through);
+
+ // Restore the real method.
+ module.SubscribersList.prototype.addSubscriber = old_addSub;
+ },
+
+ test_addSubscriber_normalizes_level: function() {
+ // addSubscriber normalizes the subscription level to 'Default'
+ // when it's otherwise unknown subscription level.
+ var subscriber = { name: "user", self_link: "/~user" };
+ var level = "Not a level";
+
+ // Save the old method for restoring later.
+ var old_addSub = module.SubscribersList.prototype.addSubscriber;
+ module.SubscribersList.prototype.addSubscriber = function(
+ passed_subscriber, passed_level, passed_config) {
+ Y.Assert.areSame('Default', passed_level);
+ Y.Assert.isUndefined(passed_config);
+ };
+ var loader = setUpLoader(this.root);
+ loader._addSubscriber(subscriber, level);
+
+ // Restore the real method.
+ module.SubscribersList.prototype.addSubscriber = old_addSub;
+ },
+
+ test_addSubscriber_unsubscribe_callback: function() {
+ // addSubscriber sets the unsubscribe callback to function
+ // returned by SubscribersLoader._getUnsubscribeCallback()
+ // if subscriber.can_edit === true.
+ var subscriber = { name: "user", can_edit: true,
+ self_link: "/~user" };
+ var unsubscribe_callback = function() {};
+
+ // Save old methods for restoring later.
+ var old_getUnsub = module.SubscribersLoader.prototype
+ ._getUnsubscribeCallback;
+ var old_addSub = module.SubscribersList.prototype.addSubscriber;
+
+ // Make _getUnsubscribeCallback return the new callback.
+ module.SubscribersLoader.prototype._getUnsubscribeCallback =
+ function() {
+ return unsubscribe_callback;
+ };
+
+ // Assert in addSubscriber that it's being passed the new
+ // callback in the config parameter.
+ module.SubscribersList.prototype.addSubscriber = function(
+ passed_subscriber, passed_level, passed_config) {
+ Y.Assert.areSame(unsubscribe_callback,
+ passed_config.unsubscribe_callback);
+ };
+
+ var loader = setUpLoader(this.root);
+ loader._addSubscriber(subscriber);
+
+ // Restore original methods.
+ module.SubscribersLoader.prototype._getUnsubscribeCallback =
+ old_getUnsub;
+ module.SubscribersList.prototype.addSubscriber = old_addSub;
+ },
+
+
+ test_loadSubscribersFromList: function() {
+ // Accepts a list of dicts with 'subscriber' and
+ // 'subscription_level' fields, passing them directly to
+ // _addSubscriber() method.
+ var data = [{ subscriber: { name: "Subscriber 1" },
+ subscription_level: 'Level3' },
+ { subscriber: { name: "Subscriber 2" },
+ subscription_level: "Unknown" }];
+
+ // Save the original method for restoring later.
+ var old_addSub = module.SubscribersLoader.prototype._addSubscriber;
+
+ var call_count = 0;
+ module.SubscribersLoader.prototype._addSubscriber =
+ function(subscriber, level) {
+ call_count++;
+ if (call_count === 1) {
+ Y.Assert.areEqual("Subscriber 1", subscriber.name);
+ Y.Assert.areEqual('Level3', level);
+ } else if (call_count === 2) {
+ Y.Assert.areEqual("Subscriber 2", subscriber.name);
+ Y.Assert.areEqual("Unknown", level);
+ }
+ };
+
+ var loader = setUpLoader(this.root);
+ loader._loadSubscribersFromList(data);
+
+ // Two subscribers have been processed total.
+ Y.Assert.areEqual(2, call_count);
+
+ // Restore the original method.
+ module.SubscribersLoader.prototype._addSubscriber = old_addSub;
+ },
+
+ test_loadSubscribersFromList_not_list_error: function() {
+ // When the data is not a list, it throws an error.
+ var data = "Not-a-list";
+
+ var loader = setUpLoader(this.root);
+ loader._loadSubscribersFromList(data);
+ },
+
+ test_loadSubscribersFromList_no_objects_error: function() {
+ // When the data is not a list of objects, it throws an error.
+ var data = ["Subscriber"];
+
+ var loader = setUpLoader(this.root);
+ loader._loadSubscribersFromList(data);
+ },
+
+ test_loadSubscribers_success: function() {
+ // Testing successful operation of _loadSubscribers.
+ var details = [
+ { subscriber: { name: "subscriber" },
+ subscription_level: 'Level3' }
+ ];
+
+ // Override loadSubscribersList to ensure it gets called with
+ // the right parameters.
+ var old_loadSubsList =
+ module.SubscribersLoader.prototype._loadSubscribersFromList;
+ var loading_done = false;
+ module.SubscribersLoader.prototype._loadSubscribersFromList =
+ function(my_details) {
+ Y.Assert.areSame(details, my_details);
+ loading_done = true;
+ };
+
+ var loader = setUpLoader(this.root);
+
+ // Mock lp_client for testing.
+ loader.lp_client = {
+ get: function(uri, get_config) {
+ // Assert that there is activity in progress.
+ var node = loader.subscribers_list.container_node
+ .one('.global-activity-indicator');
+ Y.Assert.isNotNull(node);
+ // Call the success handler.
+ get_config.on.success(details);
+ }
+ };
+ // Re-run _loadSubscribers with our mock methods in place.
+ loader._loadSubscribers();
+
+ // Assert that _loadSubscribersList was run in the process.
+ Y.Assert.isTrue(loading_done);
+
+ // And activity node was removed when everything was done.
+ var node = loader.subscribers_list.container_node
+ .one('.global-activity-indicator');
+ Y.Assert.isNull(node);
+
+ // Restore original method.
+ module.SubscribersLoader.prototype._loadSubscribersFromList =
+ old_loadSubsList;
+ },
+
+ test_loadSubscribers_failure: function() {
+ // On failure to load, activity indication is set to an error
+ // message received from the server.
+ var details = [
+ { subscriber: { name: "subscriber" },
+ subscription_level: 'Level3' }
+ ];
+
+ var loader = setUpLoader(this.root);
+
+ // Mock lp_client for testing erroring out with 'BOOM'.
+ loader.lp_client = {
+ get: function(uri, get_config) {
+ // Assert that there is activity in progress.
+ var node = loader.subscribers_list.container_node
+ .one('.global-activity-indicator');
+ Y.Assert.isNotNull(node);
+ // Call the success handler.
+ get_config.on.failure(1,{ status: 403,
+ statusText: 'BOOM',
+ responseText: '' });
+ }
+ };
+ // Re-run _loadSubscribers with our mock methods in place.
+ loader._loadSubscribers();
+
+ // And activity node is there with an error message.
+ var node = loader.subscribers_list.container_node
+ .one('.global-activity-indicator');
+ Y.Assert.isNotNull(node);
+ Y.Assert.areEqual('file:///@@/error', node.one('img').get('src'));
+ Y.Assert.areEqual(' Problem loading subscribers. 403 BOOM',
+ node.one('span').get('text'));
+ }
+ }));
+
+
+
+ /**
+ * Test SubscribersLoader unsubscribe callback function.
+ */
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersLoader() unsubscribe test',
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ // Monkey-patch animation duration to make the tests quicker.
+ this.anim_duration = Y.lp.anim.flash_in.defaults.duration;
+ Y.lp.anim.flash_in.defaults.duration = 0;
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ Y.lp.anim.flash_in.defaults.duration = this.anim_duration;
+ },
+
+ test_unsubscribe_callback_success: function() {
+ // _getUnsubscribeCallback returns a function which takes
+ // subscribers list and subscriber as the two parameters.
+ // That function calls 'unsubscribe' API method on the bug
+ // to unsubscribe the user, and on successful completion,
+ // it removes the user from the subscribers list.
+
+ // Mock LP client.
+ var received_uri, received_method, received_params;
+ var config = {};
+ config.lp_client = {
+ named_post: function(uri, method, my_conf) {
+ received_uri = uri;
+ received_method = method;
+ received_params = my_conf.parameters;
+ my_conf.on.success();
+ },
+ get: function() {}
+ };
+ var subscriber = { name: "user", "can_edit": true,
+ self_link: "user-self-link" };
+
+ // Mock removeSubscriber method to ensure it's called.
+ var removed_subscriber = false;
+ var old_rmSub = module.SubscribersList.prototype.removeSubscriber;
+ module.SubscribersList.prototype.removeSubscriber = function(
+ my_subscriber) {
+ Y.Assert.areSame(subscriber.name, my_subscriber.name);
+ removed_subscriber = true;
+ };
+
+ var loader = setUpLoader(this.root, config);
+ var unsub_callback = loader._getUnsubscribeCallback();
+ loader._addSubscriber(subscriber);
+ unsub_callback(loader.subscribers_list, subscriber);
+
+ Y.Assert.areSame(loader.context.self_link, received_uri);
+ Y.Assert.areSame('unsubscribe', received_method);
+ Y.Assert.areSame(subscriber.self_link, received_params.person);
+
+ this.wait(function() {
+ // Removal is triggered from the stopSubscriberActivity,
+ // which shows the success animation first.
+ Y.Assert.isTrue(removed_subscriber);
+ }, 50);
+
+ // Restore the real method.
+ module.SubscribersList.prototype.removeSubscriber = old_rmSub;
+ },
+
+ test_unsubscribe_callback_failure: function() {
+ // Function returned by _getUnsubscribeCallback calls
+ // 'unsubscribe' API method on the bug, and on failure,
+ // it keeps the user in the list and calls
+ // stopSubscriberActivity to indicate the failure.
+
+ // Mock LP client.
+ var config = {};
+ config.lp_client = {
+ named_post: function(uri, method, my_conf) {
+ my_conf.on.failure(0, { status: 500, statusText: "BOOM!" });
+ },
+ get: function() {}
+ };
+ var subscriber = { name: "user", "can_edit": true,
+ self_link: "user-self-link" };
+
+ // Mock stopSubscriberActivity to ensure it's called.
+ var subscriber_activity_stopped = false;
+ var old_method =
+ module.SubscribersList.prototype.stopSubscriberActivity;
+ module.SubscribersList.prototype.stopSubscriberActivity = function(
+ my_subscriber, success, callback) {
+ Y.Assert.areSame(subscriber.name, my_subscriber.name);
+ // The passed-in parameter indicates failure.
+ Y.Assert.isFalse(success);
+ // And there is no callback.
+ Y.Assert.isUndefined(callback);
+ subscriber_activity_stopped = true;
+ };
+
+ // Ensure display_error is called.
+ var error_shown = false;
+ var old_error_method = Y.lp.app.errors.display_error;
+ Y.lp.app.errors.display_error = function(text) {
+ error_shown = true;
+ };
+
+ var loader = setUpLoader(this.root, config);
+ var unsub_callback = loader._getUnsubscribeCallback();
+ loader._addSubscriber(subscriber);
+ unsub_callback(loader.subscribers_list, subscriber);
+
+ Y.Assert.isTrue(subscriber_activity_stopped);
+ Y.Assert.isTrue(error_shown);
+
+ // Restore original methods.
+ module.SubscribersList.prototype.stopSubscriberActivity =
+ old_method;
+ Y.lp.app.errors.display_error = old_error_method;
+ }
+
+ }));
+
+
+
+ /**
+ * Test SubscribersLoader subscribe-someone-else functionality.
+ */
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersLoader() subscribe-someone-else test',
+
+ _should: {
+ error: {
+ test_setupSubscribeSomeoneElse_error:
+ new Error("No link matching CSS selector " +
+ "'#sub-someone-else-link' " +
+ "for subscribing someone else found.")
+ }
+ },
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ // Monkey-patch animation duration to make the tests quicker.
+ this.anim_duration = Y.lp.anim.flash_in.defaults.duration;
+ Y.lp.anim.flash_in.defaults.duration = 0;
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ Y.lp.anim.flash_in.defaults.duration = this.anim_duration;
+ },
+
+ test_constructor_calls_setup: function() {
+ // When subscribe_someone_else_link is passed in the constructor,
+ // link identified by that CSS selector is set to pop up a person
+ // picker for choosing a person/team to subscribe.
+ var config = {
+ subscribe_someone_else_link: '#sub-someone-else-link'
+ };
+
+ var setup_called = false;
+ // Replace the original method to ensure it's getting called.
+ var old_method =
+ module.SubscribersLoader.prototype._setupSubscribeSomeoneElse;
+ module.SubscribersLoader.prototype._setupSubscribeSomeoneElse =
+ function() {
+ setup_called = true;
+ };
+
+ var loader = setUpLoader(this.root, config);
+
+ Y.Assert.isTrue(setup_called);
+
+ // Restore original method.
+ module.SubscribersLoader.prototype._setupSubscribeSomeoneElse =
+ old_method;
+ },
+
+ test_setupSubscribeSomeoneElse_error: function() {
+ // When link is not found in the page, exception is raised.
+
+ // Initialize the loader with no subscribe-someone-else link.
+ var loader = setUpLoader(this.root);
+ loader.subscribe_someone_else_link = '#sub-someone-else-link';
+ loader._setupSubscribeSomeoneElse();
+ },
+
+ test_setupSubscribeSomeoneElse_not_logged_in: function() {
+ // When user is not logged in (LP.links.me undefined),
+ // it silently does nothing.
+
+ // Initialize the loader and make sure the user is not logged in.
+ var loader = setUpLoader(this.root);
+ window.LP.links.me = undefined;
+ loader._setupSubscribeSomeoneElse();
+ // Nothing happens, not even a person picker is set up.
+ Y.Assert.isUndefined(loader._picker);
+ },
+
+ test_setupSubscribeSomeoneElse: function() {
+ // _setupSubscribeSomeoneElse ties in a link with
+ // the appropriate person picker and with the save
+ // handler that calls _subscribePersonURI with the
+ // selected person URI as the parameter.
+
+ // Initialize the loader with no subscribe-someone-else link.
+ var loader = setUpLoader(this.root);
+
+ // Mock LP client that always returns a person-like object.
+ var subscriber = { name: "user", "can_edit": true,
+ self_link: "/~user",
+ api_uri: "/~user" };
+
+ loader.subscribe_someone_else_link = '#sub-someone-else-link';
+ var link = Y.Node.create('<a />').
+ set('id', 'sub-someone-else-link');
+ this.root.appendChild(link);
+
+ // Mock _subscribePersonURI method to ensure it's called.
+ var subscribe_done = false;
+ var old_method =
+ module.SubscribersLoader.prototype._subscribePersonURI;
+ module.SubscribersLoader.prototype._subscribePersonURI =
+ function(person_uri) {
+ Y.Assert.isNotNull(
+ person_uri.match(subscriber.api_uri + "$"));
+ subscribe_done = true;
+ };
+
+ // Mock the picker creation as well.
+ var picker_shown = false;
+ var old_create_picker = Y.lp.app.picker.create;
+ Y.lp.app.picker.create = function(vocabulary, my_config) {
+ Y.Assert.areSame('ValidPersonOrTeam', vocabulary);
+ // On link click, simulate the save action.
+ link.on('click', function() {
+ picker_shown = true;
+ my_config.save(subscriber);
+ });
+ };
+
+ loader._setupSubscribeSomeoneElse();
+
+ // Show the picker and simulate the save action.
+ link.simulate('click');
+
+ Y.Assert.isTrue(picker_shown);
+ Y.Assert.isTrue(subscribe_done);
+
+ // Restore original methods.
+ module.SubscribersLoader.prototype._subscribePersonURI =
+ old_method;
+ Y.lp.app.picker.create = old_create_picker;
+ },
+
+ test_setupSubscribeSomeoneElse_failure: function() {
+ // When fetching a person as returned by the picker fails
+ // error message is shown.
+
+ // Initialize the loader with no subscribe-someone-else link.
+ var loader = setUpLoader(this.root);
+
+ // Mock LP client that always returns a person-like object.
+ var subscriber = { name: "user", "can_edit": true,
+ self_link: "/~user",
+ api_uri: "/~user" };
+ loader.lp_client = {
+ get: function(uri, conf) {
+ conf.on.failure(99, { status: 500,
+ statusText: "BOOM" });
+ }
+ };
+ var expected_error_msg = "500 (BOOM)\n" +
+ "Couldn't get subscriber details from the " +
+ "server, so they have not been subscribed.\n";
+ var received_error_msg;
+
+ // Mock display_error to ensure it's called.
+ var old_display_error = Y.lp.app.errors.display_error;
+ Y.lp.app.errors.display_error = function(animate, msg) {
+ Y.Assert.isFalse(animate);
+ received_error_msg = msg;
+ };
+
+ loader.subscribe_someone_else_link = '#sub-someone-else-link';
+ var link = Y.Node.create('<a />').
+ set('id', 'sub-someone-else-link');
+ this.root.appendChild(link);
+
+ // Mock the picker creation as well.
+ var old_create_picker = Y.lp.app.picker.create;
+ Y.lp.app.picker.create = function(vocabulary, my_config) {
+ Y.Assert.areSame('ValidPersonOrTeam', vocabulary);
+ // On link click, simulate the save action.
+ link.on('click', function() {
+ my_config.save(subscriber);
+ });
+ };
+
+ loader._setupSubscribeSomeoneElse();
+
+ // Show the picker and simulate the save action.
+ link.simulate('click');
+
+ // display_error was called with the appropriate error message.
+ Y.Assert.areSame(expected_error_msg, received_error_msg);
+
+ // Restore original methods.
+ Y.lp.app.errors.display_error = old_display_error;
+ Y.lp.app.picker.create = old_create_picker;
+ }
+ }));
+
+ /**
+ * Test SubscribersLoader helper method to update the "subscribe" link
+ * attrs.
+ */
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersLoader() _updateSubscribeMeLink test',
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ var link = Y.Node.create('<a />').set('id', 'sub-me-link');
+ this.root.appendChild(link);
+
+ var config = {
+ subscribe_me_link: '#sub-me-link',
+ subscribed_help_text: "Subscribed help",
+ unsubscribed_help_text: "Unsubscribed help"
+ };
+ this.loader = setUpLoader(this.root, config);
+ this.loader._setupSubscribeMe();
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ },
+
+ test_update_link_when_subscribed: function() {
+ this.loader._updateSubscribeMeLink(true);
+ var link = Y.one('#sub-me-link');
+ Y.Assert.areEqual('Unsubscribe', link.get('text'));
+ Y.Assert.areEqual('Subscribed help', link.get('title'));
+ Y.Assert.isTrue(link.hasClass('remove'));
+ },
+
+ test_update_link_when_unsubscribed: function() {
+ this.loader._updateSubscribeMeLink(false);
+ var link = Y.one('#sub-me-link');
+ Y.Assert.areEqual('Subscribe', link.get('text'));
+ Y.Assert.areEqual('Unsubscribed help', link.get('title'));
+ Y.Assert.isTrue(link.hasClass('add'));
+ }
+ }));
+
+ /**
+ * Test SubscribersLoader subscribe-me functionality.
+ */
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersLoader() subscribe-me test',
+
+ _should: {
+ error: {
+ test_setupSubscribeMe_error:
+ new Error("No link matching CSS selector " +
+ "'#sub-not-found-me-link' " +
+ "for subscribing me found.")
+ }
+ },
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ var link = Y.Node.create('<a />').set('id', 'sub-me-link');
+ this.root.appendChild(link);
+
+ // Monkey-patch animation duration to make the tests quicker.
+ this.anim_duration = Y.lp.anim.flash_in.defaults.duration;
+ Y.lp.anim.flash_in.defaults.duration = 0;
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ Y.lp.anim.flash_in.defaults.duration = this.anim_duration;
+ },
+
+ _setUpLoaderWithSubscribeMeLink: function(setup_config) {
+ var config = {
+ subscribe_me_link: '#sub-me-link'
+ };
+ if (Y.Lang.isValue(setup_config)) {
+ setup_config = Y.mix(config, setup_config);
+ } else {
+ setup_config = config;
+ }
+ return setUpLoader(this.root, setup_config);
+ },
+
+ test_constructor_calls_setup: function() {
+ // When subscribe_me_link is passed in the constructor,
+ // link identified by that CSS selector is set perform the subscribe
+ // operation by calling _setupSubscribeMe.
+
+ var setup_called = false;
+ // Replace the original method to ensure it's getting called.
+ var old_method =
+ module.SubscribersLoader.prototype._setupSubscribeMe;
+ module.SubscribersLoader.prototype._setupSubscribeMe =
+ function() {
+ setup_called = true;
+ };
+
+ var config = {
+ lp_client: {
+ get: function(uri, conf) {
+ conf.on.success([]);
+ }
+ }
+ };
+ this._setUpLoaderWithSubscribeMeLink(config);
+
+ Y.Assert.isTrue(setup_called);
+
+ // Restore original method.
+ module.SubscribersLoader.prototype._setupSubscribeMe =
+ old_method;
+ },
+
+ test_setupSubscribeMe_error: function() {
+ // When link is not found in the page, exception is raised.
+
+ // Initialize the loader with no subscribe-me link.
+ var loader = setUpLoader(this.root);
+ loader.subscribe_me_link = '#sub-not-found-me-link';
+ loader._setupSubscribeMe();
+ },
+
+ test_setupSubscribeMe_not_logged_in: function() {
+ // When user is not logged in (LP.links.me undefined),
+ // it silently does nothing.
+
+ // Initialize the loader and make sure the user is not logged in.
+ var loader = this._setUpLoaderWithSubscribeMeLink();
+ window.LP.links.me = undefined;
+ loader._setupSubscribeMe();
+ // Nothing happens, no js-action class is added to link.
+ Y.Assert.isFalse(Y.one(loader.subscribe_me_link)
+ .hasClass('js-action'));
+ },
+
+ test_subscribeMe: function() {
+ // When the current logged in user is not already subscribed, the
+ // _setupSubscribeMe ties in a link with the save
+ // handler that calls _subscribePersonURI with the
+ // current logged in person URI as the parameter.
+
+ var update_link_done = false;
+ var old_update_method =
+ module.SubscribersLoader.prototype._updateSubscribeMeLink;
+ module.SubscribersLoader.prototype._updateSubscribeMeLink =
+ function(is_subscribed) {
+ Y.Assert.isFalse(is_subscribed);
+ update_link_done = true;
+ };
+
+ var config = {
+ lp_client: {
+ get: function(uri, conf) {
+ conf.on.success([]);
+ }
+ }
+ };
+
+ var loader = this._setUpLoaderWithSubscribeMeLink(config);
+ // The loader should not have had the _unsubscribe_me callback set.
+ Y.Assert.isUndefined(loader._unsubscribe_me);
+ // The "subscribe" link should be correctly updated.
+ Y.Assert.isTrue(update_link_done);
+
+ window.LP.links.me = "/~user";
+ // Mock _subscribePersonURI method to ensure it's called.
+ var subscribe_done = false;
+ var old_method =
+ module.SubscribersLoader.prototype._subscribePersonURI;
+ module.SubscribersLoader.prototype._subscribePersonURI =
+ function(person_uri) {
+ Y.Assert.isNotNull(
+ person_uri.match("/~user$"));
+ subscribe_done = true;
+ };
+ var activity_started = false;
+ var old_start = module.SubscribersList.prototype.startActivity;
+ module.SubscribersList.prototype.startActivity =
+ function(text) {
+ Y.Assert.areEqual(text, "Subscribing...");
+ activity_started = true;
+ };
+
+ loader._setupSubscribeMe();
+
+ // Simulate the subscribe action.
+ var link = Y.one('#sub-me-link');
+ link.simulate('click');
+
+ Y.Assert.isTrue(subscribe_done);
+ Y.Assert.isTrue(activity_started, 'activity was not started');
+
+ // Restore original methods.
+ module.SubscribersLoader.prototype._subscribePersonURI =
+ old_method;
+ module.SubscribersLoader.prototype._updateSubscribeMeLink =
+ old_update_method;
+ module.SubscribersList.prototype.startActivity = old_start;
+ },
+
+ test_unsubscribeMe: function() {
+ // When the current logged in user is already subscribed, the
+ // _setupSubscribeMe ties in a link with the save
+ // handler that calls the relevant unsubscribe callback.
+
+ // Mock the unsubscribe callback method to ensure it's called.
+ var unsubscribe_done = false;
+ var old_callback_method =
+ module.SubscribersLoader.prototype._getUnsubscribeCallback;
+ module.SubscribersLoader.prototype._getUnsubscribeCallback =
+ function() {
+ return function(subscribers_list, subscriber) {
+ Y.Assert.isNotNull(
+ subscriber.self_link.match('/~viewer$'));
+ unsubscribe_done = true;
+ };
+ };
+ var update_link_done = false;
+ var old_update_method =
+ module.SubscribersLoader.prototype._updateSubscribeMeLink;
+ module.SubscribersLoader.prototype._updateSubscribeMeLink =
+ function(is_subscribed) {
+ Y.Assert.isTrue(is_subscribed);
+ update_link_done = true;
+ };
+
+ var config = {
+ lp_client: {
+ get: function(uri, conf) {
+ var me = {
+ 'self_link': '/~viewer'};
+ var record = {
+ 'subscriber': me,
+ 'subscription_level': 'Direct'};
+ conf.on.success([record]);
+ }
+ }
+ };
+ var loader = this._setUpLoaderWithSubscribeMeLink(config);
+
+ // The loader should have had the _unsubscribe_me callback set.
+ Y.Assert.isFunction(loader._unsubscribe_me);
+ // The "subscribe" link should be correctly updated.
+ Y.Assert.isTrue(update_link_done);
+
+ var link = Y.one('#sub-me-link');
+ // Simulate the subscribe action.
+ link.simulate('click');
+
+ Y.Assert.isTrue(unsubscribe_done);
+
+ // Restore original methods.
+ module.SubscribersLoader.prototype._getUnsubscribeCallback =
+ old_callback_method;
+ module.SubscribersLoader.prototype._updateSubscribeMeLink =
+ old_update_method;
+ },
+
+ test_setupSubscribeMe_failure: function() {
+ // When fetching the details for the current logged in user fails
+ // an error message is shown.
+
+ var config = {
+ lp_client: {
+ get: function(uri, conf) {
+ if (uri==='/base/+details') {
+ conf.on.success([]);
+ } else {
+ conf.on.failure(99, { status: 500,
+ statusText: "BOOM" });
+ }
+ }
+ }
+ };
+ var loader = this._setUpLoaderWithSubscribeMeLink(config);
+
+ var expected_error_msg = "500 (BOOM)\n" +
+ "Couldn't get subscriber details from the " +
+ "server, so they have not been subscribed.\n";
+ var received_error_msg;
+
+ // Mock display_error to ensure it's called.
+ var old_display_error = Y.lp.app.errors.display_error;
+ Y.lp.app.errors.display_error = function(animate, msg) {
+ Y.Assert.isFalse(animate);
+ received_error_msg = msg;
+ };
+
+ loader._setupSubscribeMe();
+
+ // Simulate the subscribe action.
+ var link = Y.one('#sub-me-link');
+ link.simulate('click');
+
+ // display_error was called with the appropriate error message.
+ Y.Assert.areSame(expected_error_msg, received_error_msg);
+
+ // Restore original methods.
+ Y.lp.app.errors.display_error = old_display_error;
+ }
+ }));
+
+ /**
+ * Test SubscribersLoader _subscribe functionality.
+ */
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersLoader() _subscribe',
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ // Monkey-patch animation duration to make the tests quicker.
+ this.anim_duration = Y.lp.anim.flash_in.defaults.duration;
+ Y.lp.anim.flash_in.defaults.duration = 0;
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ Y.lp.anim.flash_in.defaults.duration = this.anim_duration;
+ },
+
+ test_subscribePersonURI: function() {
+ // _subscribePersonURI retrieves the details for the specified
+ // person URI from the server and calls _subscribe().
+
+ var loader = setUpLoader(this.root);
+
+ // Mock LP client that always returns a person-like object.
+ var subscriber = { name: "user", self_link: "/~user"};
+ loader.lp_client = {
+ get: function(uri, conf) {
+ subscriber.api_uri = uri;
+ conf.on.success(subscriber);
+ }
+ };
+
+ // Mock _subscribe method to ensure it's called.
+ var subscribe_done = false;
+ var old_method =
+ module.SubscribersLoader.prototype._subscribe;
+ module.SubscribersLoader.prototype._subscribe =
+ function(person) {
+ Y.Assert.areSame(person, subscriber);
+ subscribe_done = true;
+ };
+
+ loader._subscribePersonURI("/~user");
+ Y.Assert.isTrue(subscribe_done);
+
+ // Restore original methods.
+ module.SubscribersLoader.prototype._subscribe = old_method;
+ },
+
+ test_subscribe: function() {
+ // _subscribe method takes a Person object as returned
+ // by the API, and adds that subscriber at 'Level1' level.
+
+ var subscriber = { self_link: "/~user" };
+
+ // Mock-up addSubscriber method to ensure subscriber is added.
+ var subscriber_added = false;
+ var old_addSub = module.SubscribersList.prototype.addSubscriber;
+ module.SubscribersList.prototype.addSubscriber = function(
+ my_subscriber, level) {
+ Y.Assert.areSame(subscriber, my_subscriber);
+ subscriber_added = true;
+ };
+
+ // Mock-up indicateSubscriberActivity to ensure it's called.
+ var activity_on = false;
+ var old_indicate =
+ module.SubscribersList.prototype.indicateSubscriberActivity;
+ module.SubscribersList.prototype.indicateSubscriberActivity =
+ function(my_subscriber) {
+ Y.Assert.areSame(subscriber, my_subscriber);
+ activity_on = true;
+ };
+
+ // Initialize the loader.
+ var loader = setUpLoader(this.root);
+
+ // Mock lp_client which records the call.
+ var received_method, received_uri, received_params;
+ loader.lp_client = {
+ named_post: function(uri, method, conf) {
+ received_uri = uri;
+ received_method = method;
+ received_params = conf.parameters;
+ }
+ };
+
+ // Wrap subscriber like an API-returned value.
+ var person = {
+ getAttrs: function() {
+ return subscriber;
+ }
+ };
+
+ loader._subscribe(person);
+
+ Y.Assert.isTrue(subscriber_added);
+ Y.Assert.isTrue(activity_on);
+
+ Y.Assert.areEqual('subscribe', received_method);
+ Y.Assert.areEqual(loader.context.self_link, received_uri);
+ Y.Assert.areEqual(subscriber.self_link, received_params.person);
+
+ // Restore original methods.
+ module.SubscribersList.prototype.addSubscriber = old_addSub;
+ module.SubscribersList.prototype.indicateSubscriberActivity =
+ old_indicate;
+ },
+
+ test_subscribe_success_with_list_update: function() {
+ // When subscribing someone such that the subscribers list should be
+ // updated, check that the correct start/stop progress indication
+ // calls are used ie stopSubscriberActivity is called indicating
+ // success, and addUnsubscribeAction is called with the correct
+ // parameters.
+
+ var subscriber = { name: "user", self_link: "/~user" };
+
+ // Initialize the loader.
+ var loader = setUpLoader(this.root);
+ loader.subscribers_list.addSubscriber(subscriber, 'Default');
+
+ // Mock-up addUnsubscribeAction method to ensure it's called with
+ // the right parameters. We need to stub the
+ // _getUnsubscribeCallback result so we can check the
+ // unsubscribe_callback.
+ var unsubscribe_callback = function() {};
+ // Save old methods for restoring later.
+ var old_getUnsub = module.SubscribersLoader.prototype
+ ._getUnsubscribeCallback;
+
+ // Make _getUnsubscribeCallback return the new callback.
+ module.SubscribersLoader.prototype._getUnsubscribeCallback =
+ function() {
+ return unsubscribe_callback;
+ };
+
+ var unsubscribe_link_added = false;
+ var old_unsubscribe_action =
+ module.SubscribersList.prototype.addUnsubscribeAction;
+ module.SubscribersList.prototype.addUnsubscribeAction =
+ function(my_subscriber, callback) {
+ Y.Assert.areSame(subscriber, my_subscriber);
+ Y.Assert.areEqual(unsubscribe_callback, callback);
+ unsubscribe_link_added = true;
+ };
+
+ // Mock-up stopSubscriberActivity to ensure it's called.
+ var activity_on = true;
+ var old_indicate =
+ module.SubscribersList.prototype.stopSubscriberActivity;
+ module.SubscribersList.prototype.stopSubscriberActivity =
+ function(my_subscriber, success) {
+ Y.Assert.areSame(subscriber, my_subscriber);
+ Y.Assert.isTrue(success);
+ activity_on = false;
+ };
+
+ // Mock lp_client which calls the success handler.
+ loader.lp_client = {
+ named_post: function(uri, method, conf) {
+ conf.on.success();
+ }
+ };
+
+ // Wrap subscriber like an API-returned value.
+ var person = {
+ getAttrs: function() {
+ return subscriber;
+ }
+ };
+
+ loader._subscribe(person, 'Level1');
+
+ Y.Assert.isTrue(unsubscribe_link_added);
+ Y.Assert.isFalse(activity_on);
+
+ // Restore original methods.
+ module.SubscribersList.prototype.addUnsubscribeAction =
+ old_unsubscribe_action;
+ module.SubscribersLoader.prototype._getUnsubscribeCallback =
+ old_getUnsub;
+ module.SubscribersList.prototype.stopSubscriberActivity =
+ old_indicate;
+
+ },
+
+ test_subscribe_success_without_list_update: function() {
+ // When subscribing someone such that the subscribers list should
+ // not updated, check that the correct stop progress indication
+ // call is used ie stopActivity is called indicating success.
+
+ var subscriber = { name: "user", self_link: "/~user" };
+
+ // Initialize the loader.
+ var loader = setUpLoader(this.root, {display_me_in_list: false});
+ loader.subscribers_list.addSubscriber(subscriber, 'Default');
+ window.LP.links.me = "/~user";
+
+ // Mock-up stopActivity to ensure it's called.
+ var activity_stopped = false;
+ var old_stop = module.SubscribersList.prototype.stopActivity;
+ module.SubscribersList.prototype.stopActivity =
+ function() {
+ activity_stopped = true;
+ };
+
+ // Mock lp_client which calls the success handler.
+ loader.lp_client = {
+ named_post: function(uri, method, conf) {
+ conf.on.success();
+ }
+ };
+
+ // Wrap subscriber like an API-returned value.
+ var person = {
+ getAttrs: function() {
+ return subscriber;
+ }
+ };
+
+ loader._subscribe(person, 'Level1');
+ Y.Assert.isTrue(activity_stopped, 'activity was not stopped');
+
+ // Restore original methods.
+ module.SubscribersList.prototype.stopActivity = old_stop;
+ },
+
+ test_subscribe_failure: function() {
+ // When subscribing fails, stopSubscriberActivity
+ // is called indicating failure and it calls removeSubscriber
+ // from the callback when animation completes.
+ // Error is shown as well.
+
+ var subscriber = { name: "user", self_link: "/~user",
+ display_name: "User Name" };
+
+ // Initialize the loader.
+ var loader = setUpLoader(this.root);
+ loader.subscribers_list.addSubscriber(subscriber, 'Default');
+
+ // Mock-up removeSubscriber to ensure it's called.
+ var remove_called = false;
+ var old_remove =
+ module.SubscribersList.prototype.removeSubscriber;
+ module.SubscribersList.prototype.removeSubscriber =
+ function(my_subscriber) {
+ Y.Assert.areSame(subscriber, my_subscriber);
+ remove_called = true;
+ };
+
+ // Ensure display_error is called.
+ var old_error_method = Y.lp.app.errors.display_error;
+ var received_error;
+ Y.lp.app.errors.display_error = function(anim, text) {
+ received_error = text;
+ };
+
+ // Mock lp_client which calls the failure handler.
+ loader.lp_client = {
+ named_post: function(uri, method, conf) {
+ conf.on.failure(99, { status: 500,
+ statusText: "BOOM" });
+ }
+ };
+
+ // Wrap subscriber like an API-returned value.
+ var person = {
+ getAttrs: function() {
+ return subscriber;
+ }
+ };
+
+ loader._subscribe(person, 'Level1');
+
+ Y.Assert.areSame('500 (BOOM). Failed to subscribe User Name.',
+ received_error);
+
+ // Remove function is only called after animation completes.
+ this.wait(function() {
+ Y.Assert.isTrue(remove_called);
+ }, 50);
+
+ // Restore original methods.
+ module.SubscribersList.prototype.removeSubscriber = old_remove;
+ Y.lp.app.errors.display_error = old_error_method;
+
+ }
+ }));
+
+ /**
+ * Re-test several resetNoSubscribers() tests that need config options
+ * merging (LP Bug 837290)
+ */
+ tests.suite.add(new Y.Test.Case({
+ name: 'SubscribersLoader.SubscribersList.resetNoSubscribers() re-test',
+
+ setUp: function() {
+ this.root = Y.Node.create('<div />');
+ Y.one('body').appendChild(this.root);
+ },
+
+ tearDown: function() {
+ this.root.remove();
+ },
+
+ test_no_subscribers: function() {
+ // When resetNoSubscribers() is called on an empty
+ // SubscribersList, indication of no subscribers is added.
+ // In addition, this checks that the default configuration options
+ // have been correctly merged without SubscribersLoader()
+ var loader = setUpLoader(this.root);
+ var subscribers_list = loader.subscribers_list;
+ subscribers_list.resetNoSubscribers();
+ var no_subs_nodes = this.root.all(
+ '.no-subscribers-indicator');
+ Y.Assert.areEqual(1, no_subs_nodes.size());
+ Y.Assert.areEqual('No other subscribers.',
+ no_subs_nodes.item(0).get('text'));
+ },
+
+ test_no_subscribers_no_levels: function() {
+ // When resetNoSubscribers() is called on an empty
+ // SubscribersList, indication of no subscribers is added. If there
+ // are no subscriber_levels, a different message is displayed.
+ // In addition, this checks that the default configuration options
+ // have been correctly merged without SubscribersLoader()
+ var loader = setUpLoader(this.root);
+ var subscribers_list = loader.subscribers_list;
+ subscribers_list.subscriber_levels = [];
+ subscribers_list.resetNoSubscribers();
+ var no_subs_nodes = this.root.all(
+ '.no-subscribers-indicator');
+ Y.Assert.areEqual(1, no_subs_nodes.size());
+ Y.Assert.areEqual('No subscribers.',
+ no_subs_nodes.item(0).get('text'));
+ }
+ }));
+
+}, '0.1', {
+ 'requires': ['test', 'console',
+ 'lp.app.subscribers.subscribers_list', 'node', 'event',
+ 'node-event-simulate', 'dump']
});
+
+
+
+
=== modified file 'lib/lp/app/javascript/testing/tests/test_mockio.html'
--- lib/lp/app/javascript/testing/tests/test_mockio.html 2011-08-23 08:35:54 +0000
+++ lib/lp/app/javascript/testing/tests/test_mockio.html 2012-02-07 20:25:28 +0000
@@ -1,21 +1,47 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd";>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd";>
+<!--
+Copyright 2012 Canonical Ltd. This software is licensed under the
+GNU Affero General Public License version 3 (see the file LICENSE).
+-->
+
<html>
<head>
- <title>Launchpad lp.testing.mockio module</title>
-
- <!-- YUI and test setup -->
- <script type="text/javascript"
- src="../../../../../canonical/launchpad/icing/yui/yui/yui.js">
- </script>
- <link rel="stylesheet" href="../test.css" />
- <script type="text/javascript" src="../testrunner.js"></script>
-
- <!-- The module under test -->
- <script type="text/javascript" src="../mockio.js"></script>
-
- <!-- The test suite -->
- <script type="text/javascript" src="test_mockio.js"></script>
-</head>
-<body class="yui3-skin-sam">
-</body>
+ <title>Test mockio</title>
+
+ <!-- YUI and test setup -->
+ <script type="text/javascript"
+ src="../../../../../../build/js/yui/yui/yui.js">
+ </script>
+ <link rel="stylesheet"
+ href="../../../../../../build/js/yui/console/assets/console-core.css" />
+ <link rel="stylesheet"
+ href="../../../../../../build/js/yui/console/assets/skins/sam/console.css" />
+ <link rel="stylesheet"
+ href="../../../../../../build/js/yui/test/assets/skins/sam/test.css" />
+
+ <script type="text/javascript"
+ src="../../../../../../build/js/lp/app/testing/testrunner.js"></script>
+
+ <link rel="stylesheet" href="../../../../app/javascript/testing/test.css" />
+
+ <!-- Dependencies -->
+ <!-- <script type="text/javascript" src="../../../../../../build/js/lp/..."></script> -->
+
+ <!-- The module under test. -->
+ <script type="text/javascript" src="../mockio.js"></script>
+
+ <!-- Any css assert for this module. -->
+ <!-- <link rel="stylesheet" href="../assets/mockio-core.css" /> -->
+
+ <!-- The test suite. -->
+ <script type="text/javascript" src="test_mockio.js"></script>
+
+ </head>
+ <body class="yui3-skin-sam">
+ <ul id="suites">
+ <!-- <li>lp.large_indicator.test</li> -->
+ <li>lp.testing.mockio.test</li>
+ </ul>
+ </body>
</html>
=== modified file 'lib/lp/app/javascript/testing/tests/test_mockio.js'
--- lib/lp/app/javascript/testing/tests/test_mockio.js 2011-08-24 15:25:06 +0000
+++ lib/lp/app/javascript/testing/tests/test_mockio.js 2012-02-07 20:25:28 +0000
@@ -1,193 +1,201 @@
-/* Copyright (c) 2011, Canonical Ltd. All rights reserved. */
-
-YUI().use('test', 'console', 'node-event-simulate',
- 'lp.testing.mockio', 'lp.testing.runner', function(Y) {
-
-var suite = new Y.Test.Suite("lp.testing.mockio Tests");
-
-var module = Y.lp.testing.mockio;
-
-var make_call_recorder = function() {
- var recorder;
- recorder = function() {
- recorder.call_count += 1;
- recorder.args = arguments;
+/* Copyright (c) 2012, Canonical Ltd. All rights reserved. */
+
+YUI.add('lp.testing.mockio.test', function (Y) {
+
+ var tests = Y.namespace('lp.testing.mockio.test');
+ var module = Y.lp.testing.mockio;
+ tests.suite = new Y.Test.Suite('mockio Tests');
+
+ var make_call_recorder = function() {
+ var recorder;
+ recorder = function() {
+ recorder.call_count += 1;
+ recorder.args = arguments;
+ };
+ recorder.call_count = 0;
+ recorder.args = null;
+ return recorder;
};
- recorder.call_count = 0;
- recorder.args = null;
- return recorder;
-};
-
-suite.add(new Y.Test.Case({
- name: "lp.testing.mokio.MockIo",
-
- test_url: "https://launchpad.dev/test/url";,
-
- setUp: function() {
- // Initialize call_count on recorders.
- this.test_config = {
- on: {
- start: make_call_recorder(),
- complete: make_call_recorder(),
- success: make_call_recorder(),
- failure: make_call_recorder()
- },
- context: {marker: "context"},
- 'arguments': ["arguments"]
- };
- },
-
- _make_mockio: function() {
- var mockio = new module.MockIo();
- mockio.io(this.test_url, this.test_config);
- return mockio;
- },
-
- test_respond_success: function() {
- // The success handler is called on success.
- var mockio = this._make_mockio();
- mockio.respond({status: 200});
- Y.Assert.areEqual(1, this.test_config.on.start.call_count);
- Y.Assert.areEqual(1, this.test_config.on.complete.call_count);
- Y.Assert.areEqual(1, this.test_config.on.success.call_count);
- Y.Assert.areEqual(0, this.test_config.on.failure.call_count);
- },
-
- test_respond_failure: function() {
- // The failure handler is called on failure.
- var mockio = this._make_mockio();
- mockio.respond({status: 500});
- Y.Assert.areEqual(1, this.test_config.on.start.call_count);
- Y.Assert.areEqual(1, this.test_config.on.complete.call_count);
- Y.Assert.areEqual(0, this.test_config.on.success.call_count);
- Y.Assert.areEqual(1, this.test_config.on.failure.call_count);
- },
-
- test_multiple_requests: function() {
- // Multiple requests are stored.
- var mockio = new module.MockIo();
- mockio.io(this.test_url, this.test_config);
- mockio.io(this.test_url, this.test_config);
- Y.Assert.areEqual(2, mockio.requests.length);
- },
-
- test_last_request: function() {
- // The last request is available through last_request.
- var mockio = new module.MockIo();
- mockio.io("Request 1", this.test_config);
- mockio.io("Request 2", this.test_config);
- Y.Assert.areEqual("Request 2", mockio.last_request.url);
- },
-
- test_status: function() {
- // The status is passed to the handler.
- var mockio = this._make_mockio();
- var expected_status = 503;
- mockio.respond({status: expected_status});
- Y.Assert.areEqual(
- expected_status, this.test_config.on.failure.args[1].status);
- },
-
- test_statusText: function() {
- // The statusText is passed to the handler.
- var mockio = this._make_mockio();
- var expected_status_text = "All is well";
- mockio.respond({statusText: expected_status_text});
- Y.Assert.areEqual(
- expected_status_text,
- this.test_config.on.success.args[1].statusText);
- },
-
- test_responseText: function() {
- // The responseText is passed to the handler.
- var mockio = this._make_mockio();
- var expected_response_text = "myresponse";
- mockio.respond({responseText: expected_response_text});
- Y.Assert.areEqual(
- expected_response_text,
- this.test_config.on.success.args[1].responseText);
- },
-
- test_responseHeader: function() {
- // A response header is passed to the handler.
- var mockio = this._make_mockio();
- var response = new Y.lp.testing.mockio.MockHttpResponse();
- var expected_header_key = "X-My-Header",
- expected_header_val = "MyHeaderValue",
- response_headers = {};
- response.setResponseHeader(expected_header_key, expected_header_val);
- mockio.respond(response);
- var headers = this.test_config.on.success.args[1].responseHeaders;
- Y.Assert.areEqual(expected_header_val, headers[expected_header_key]);
- },
-
- test_success_helper: function() {
- // The success helper creates a successful response.
- var mockio = this._make_mockio(),
- response_text = "Success!";
- mockio.success({responseText: response_text});
- Y.Assert.areEqual(1, this.test_config.on.success.call_count);
- Y.Assert.areEqual(0, this.test_config.on.failure.call_count);
- Y.Assert.areEqual(
- response_text, mockio.last_request.response.responseText);
- },
-
- test_success_helper__own_status: function() {
- // The failure can define its own non-4xx or non-5xx status.
- var mockio = this._make_mockio(),
- status = 302;
- mockio.success({status: status});
- Y.Assert.areEqual(1, this.test_config.on.success.call_count);
- Y.Assert.areEqual(0, this.test_config.on.failure.call_count);
- Y.Assert.areEqual(status, mockio.last_request.response.status);
- },
-
- test_success_helper__status_override: function() {
- // A status that is 4xx or 5xx is overridden to be 200.
- // This is to guard against foot shooting.
- var mockio = this._make_mockio(),
- own_status = 500,
- real_status = 200;
- mockio.success({status: own_status});
- Y.Assert.areEqual(1, this.test_config.on.success.call_count);
- Y.Assert.areEqual(0, this.test_config.on.failure.call_count);
- Y.Assert.areEqual(real_status, mockio.last_request.response.status);
- },
-
- test_failure_helper: function() {
- // The failure helper creates a failed response.
- var mockio = this._make_mockio(),
- response_text = "Failure!";
- mockio.failure({responseText: response_text});
- Y.Assert.areEqual(0, this.test_config.on.success.call_count);
- Y.Assert.areEqual(1, this.test_config.on.failure.call_count);
- Y.Assert.areEqual(
- response_text, mockio.last_request.response.responseText);
- },
-
- test_failure_helper__own_status: function() {
- // The failure can define its own 4xx or 5xx status.
- var mockio = this._make_mockio(),
- status = 404;
- mockio.failure({status: status});
- Y.Assert.areEqual(0, this.test_config.on.success.call_count);
- Y.Assert.areEqual(1, this.test_config.on.failure.call_count);
- Y.Assert.areEqual(status, mockio.last_request.response.status);
- },
-
- test_failure_helper__status_override: function() {
- // A status that is not 4xx or 5xx is overridden to be 500.
- // This is to guard against foot shooting.
- var mockio = this._make_mockio(),
- own_status = 200,
- real_status = 500;
- mockio.failure({status: own_status});
- Y.Assert.areEqual(0, this.test_config.on.success.call_count);
- Y.Assert.areEqual(1, this.test_config.on.failure.call_count);
- Y.Assert.areEqual(real_status, mockio.last_request.response.status);
- }
-}));
-
-Y.lp.testing.Runner.run(suite);
-
+
+ tests.suite.add(new Y.Test.Case({
+ name: 'mockio_tests',
+
+ test_url: "https://launchpad.dev/test/url";,
+
+ setUp: function() {
+ // Initialize call_count on recorders.
+ this.test_config = {
+ on: {
+ start: make_call_recorder(),
+ complete: make_call_recorder(),
+ success: make_call_recorder(),
+ failure: make_call_recorder()
+ },
+ context: {marker: "context"},
+ 'arguments': ["arguments"]
+ };
+ },
+
+ _make_mockio: function() {
+ var mockio = new module.MockIo();
+ mockio.io(this.test_url, this.test_config);
+ return mockio;
+ },
+
+ test_library_exists: function () {
+ Y.Assert.isObject(Y.lp.testing.mockio,
+ "We should be able to locate the lp.testing.mockio module");
+ },
+
+ test_respond_success: function() {
+ // The success handler is called on success.
+ var mockio = this._make_mockio();
+ mockio.respond({status: 200});
+ Y.Assert.areEqual(1, this.test_config.on.start.call_count);
+ Y.Assert.areEqual(1, this.test_config.on.complete.call_count);
+ Y.Assert.areEqual(1, this.test_config.on.success.call_count);
+ Y.Assert.areEqual(0, this.test_config.on.failure.call_count);
+ },
+
+ test_respond_failure: function() {
+ // The failure handler is called on failure.
+ var mockio = this._make_mockio();
+ mockio.respond({status: 500});
+ Y.Assert.areEqual(1, this.test_config.on.start.call_count);
+ Y.Assert.areEqual(1, this.test_config.on.complete.call_count);
+ Y.Assert.areEqual(0, this.test_config.on.success.call_count);
+ Y.Assert.areEqual(1, this.test_config.on.failure.call_count);
+ },
+
+ test_multiple_requests: function() {
+ // Multiple requests are stored.
+ var mockio = new module.MockIo();
+ mockio.io(this.test_url, this.test_config);
+ mockio.io(this.test_url, this.test_config);
+ Y.Assert.areEqual(2, mockio.requests.length);
+ },
+
+ test_last_request: function() {
+ // The last request is available through last_request.
+ var mockio = new module.MockIo();
+ mockio.io("Request 1", this.test_config);
+ mockio.io("Request 2", this.test_config);
+ Y.Assert.areEqual("Request 2", mockio.last_request.url);
+ },
+
+ test_status: function() {
+ // The status is passed to the handler.
+ var mockio = this._make_mockio();
+ var expected_status = 503;
+ mockio.respond({status: expected_status});
+ Y.Assert.areEqual(
+ expected_status, this.test_config.on.failure.args[1].status);
+ },
+
+ test_statusText: function() {
+ // The statusText is passed to the handler.
+ var mockio = this._make_mockio();
+ var expected_status_text = "All is well";
+ mockio.respond({statusText: expected_status_text});
+ Y.Assert.areEqual(
+ expected_status_text,
+ this.test_config.on.success.args[1].statusText);
+ },
+
+ test_responseText: function() {
+ // The responseText is passed to the handler.
+ var mockio = this._make_mockio();
+ var expected_response_text = "myresponse";
+ mockio.respond({responseText: expected_response_text});
+ Y.Assert.areEqual(
+ expected_response_text,
+ this.test_config.on.success.args[1].responseText);
+ },
+
+ test_responseHeader: function() {
+ // A response header is passed to the handler.
+ var mockio = this._make_mockio();
+ var response = new Y.lp.testing.mockio.MockHttpResponse();
+ var expected_header_key = "X-My-Header",
+ expected_header_val = "MyHeaderValue",
+ response_headers = {};
+ response.setResponseHeader(
+ expected_header_key,
+ expected_header_val);
+ mockio.respond(response);
+ var headers = this.test_config.on.success.args[1].responseHeaders;
+ Y.Assert.areEqual(
+ expected_header_val,
+ headers[expected_header_key]);
+ },
+
+ test_success_helper: function() {
+ // The success helper creates a successful response.
+ var mockio = this._make_mockio(),
+ response_text = "Success!";
+ mockio.success({responseText: response_text});
+ Y.Assert.areEqual(1, this.test_config.on.success.call_count);
+ Y.Assert.areEqual(0, this.test_config.on.failure.call_count);
+ Y.Assert.areEqual(
+ response_text, mockio.last_request.response.responseText);
+ },
+
+ test_success_helper__own_status: function() {
+ // The failure can define its own non-4xx or non-5xx status.
+ var mockio = this._make_mockio(),
+ status = 302;
+ mockio.success({status: status});
+ Y.Assert.areEqual(1, this.test_config.on.success.call_count);
+ Y.Assert.areEqual(0, this.test_config.on.failure.call_count);
+ Y.Assert.areEqual(status, mockio.last_request.response.status);
+ },
+
+ test_success_helper__status_override: function() {
+ // A status that is 4xx or 5xx is overridden to be 200.
+ // This is to guard against foot shooting.
+ var mockio = this._make_mockio(),
+ own_status = 500,
+ real_status = 200;
+ mockio.success({status: own_status});
+ Y.Assert.areEqual(1, this.test_config.on.success.call_count);
+ Y.Assert.areEqual(0, this.test_config.on.failure.call_count);
+ Y.Assert.areEqual(real_status, mockio.last_request.response.status);
+ },
+
+ test_failure_helper: function() {
+ // The failure helper creates a failed response.
+ var mockio = this._make_mockio(),
+ response_text = "Failure!";
+ mockio.failure({responseText: response_text});
+ Y.Assert.areEqual(0, this.test_config.on.success.call_count);
+ Y.Assert.areEqual(1, this.test_config.on.failure.call_count);
+ Y.Assert.areEqual(
+ response_text, mockio.last_request.response.responseText);
+ },
+
+ test_failure_helper__own_status: function() {
+ // The failure can define its own 4xx or 5xx status.
+ var mockio = this._make_mockio(),
+ status = 404;
+ mockio.failure({status: status});
+ Y.Assert.areEqual(0, this.test_config.on.success.call_count);
+ Y.Assert.areEqual(1, this.test_config.on.failure.call_count);
+ Y.Assert.areEqual(status, mockio.last_request.response.status);
+ },
+
+ test_failure_helper__status_override: function() {
+ // A status that is not 4xx or 5xx is overridden to be 500.
+ // This is to guard against foot shooting.
+ var mockio = this._make_mockio(),
+ own_status = 200,
+ real_status = 500;
+ mockio.failure({status: own_status});
+ Y.Assert.areEqual(0, this.test_config.on.success.call_count);
+ Y.Assert.areEqual(1, this.test_config.on.failure.call_count);
+ Y.Assert.areEqual(real_status, mockio.last_request.response.status);
+ }
+ }));
+
+}, '0.1', {
+ 'requires': ['test', 'console', 'lp.testing.mockio', 'node-event-simulate']
});
=== modified file 'lib/lp/app/javascript/tests/test_ajax_batch_navigator.html'
--- lib/lp/app/javascript/tests/test_ajax_batch_navigator.html 2011-10-12 13:34:51 +0000
+++ lib/lp/app/javascript/tests/test_ajax_batch_navigator.html 2012-02-07 20:25:28 +0000
@@ -1,32 +1,58 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd";>
+<!--
+Copyright 2012 Canonical Ltd. This software is licensed under the
+GNU Affero General Public License version 3 (see the file LICENSE).
+-->
+
<html>
<head>
- <title>Ajax Batch Navigator</title>
-
- <!-- YUI and test setup -->
- <script type="text/javascript"
- src="../../../../canonical/launchpad/icing/yui/yui/yui.js">
- </script>
- <link rel="stylesheet" href="../../../app/javascript/testing/test.css" />
- <script type="text/javascript"
- src="../../../app/javascript/testing/testrunner.js"></script>
-
- <script type="text/javascript" src="../client.js"></script>
- <script type="text/javascript" src="../errors.js"></script>
- <script type="text/javascript" src="../lp.js"></script>
-
- <!-- Other dependencies -->
- <script type="text/javascript" src="../testing/mockio.js"></script>
-
- <!-- The module under test -->
- <script type="text/javascript" src="../ajax_batch_navigator.js"></script>
-
- <!-- The test suite -->
- <script type="text/javascript" src="test_ajax_batch_navigator.js"></script>
- </head>
- <body class="yui3-skin-sam">
- <!-- The example markup required by the script to run -->
- <div class="test-hook">
- </div>
-
- </body>
+ <title>Test ajax_batch_navigator</title>
+
+ <!-- YUI and test setup -->
+ <script type="text/javascript"
+ src="../../../../../build/js/yui/yui/yui.js">
+ </script>
+ <link rel="stylesheet"
+ href="../../../../../build/js/yui/console/assets/console-core.css" />
+ <link rel="stylesheet"
+ href="../../../../../build/js/yui/console/assets/skins/sam/console.css" />
+ <link rel="stylesheet"
+ href="../../../../../build/js/yui/test/assets/skins/sam/test.css" />
+
+ <script type="text/javascript"
+ src="../../../../../build/js/lp/app/testing/testrunner.js"></script>
+
+ <link rel="stylesheet" href="../../../app/javascript/testing/test.css" />
+
+ <!-- Dependencies -->
+ <script type="text/javascript"
+ src="../../../../../build/js/lp/app/client.js"></script>
+ <script type="text/javascript"
+ src="../../../../../build/js/lp/app/errors.js"></script>
+ <script type="text/javascript"
+ src="../../../../../build/js/lp/app/lp.js"></script>
+ <script type="text/javascript"
+ src="../../../../../build/js/lp/app/testing/mockio.js"></script>
+
+ <!-- The module under test. -->
+ <script type="text/javascript" src="../ajax_batch_navigator.js"></script>
+
+ <!-- Any css assert for this module. -->
+ <!-- <link rel="stylesheet" href="../assets/ajax_batch_navigator-core.css" /> -->
+
+ <!-- The test suite. -->
+ <script type="text/javascript" src="test_ajax_batch_navigator.js"></script>
+
+ </head>
+ <body class="yui3-skin-sam">
+ <ul id="suites">
+ <!-- <li>lp.large_indicator.test</li> -->
+ <li>lp.app.batchnavigator.test</li>
+ </ul>
+
+ <!-- The example markup required by the script to run -->
+ <div class="test-hook">
+ </div>
+ </body>
</html>
=== modified file 'lib/lp/app/javascript/tests/test_ajax_batch_navigator.js'
--- lib/lp/app/javascript/tests/test_ajax_batch_navigator.js 2012-01-11 13:10:45 +0000
+++ lib/lp/app/javascript/tests/test_ajax_batch_navigator.js 2012-02-07 20:25:28 +0000
@@ -1,13 +1,10 @@
-/* Copyright 2011 Canonical Ltd. This software is licensed under the
- * GNU Affero General Public License version 3 (see the file LICENSE).
- */
-
-YUI().use('lp.testing.runner', 'lp.testing.mockio', 'base', 'test', 'console',
- 'node', 'node-event-simulate', 'lp.app.batchnavigator',
- function(Y) {
-
- var suite = new Y.Test.Suite("lp.app.batchnavigator Tests");
+/* Copyright (c) 2012, Canonical Ltd. All rights reserved. */
+
+YUI.add('lp.app.batchnavigator.test', function (Y) {
+
+ var tests = Y.namespace('lp.app.batchnavigator.test');
var module = Y.lp.app.batchnavigator;
+ tests.suite = new Y.Test.Suite('batchnavigator Tests');
var BatchNavigatorTestMixin = {
@@ -97,85 +94,91 @@
}
};
- suite.add(new Y.Test.Case(
+ tests.suite.add(new Y.Test.Case(
Y.merge(BatchNavigatorTestMixin, {
- name: 'batchnavigator',
-
- test_navigator_construction: function() {
- this.makeNavigator(this.makeNavigatorHooks());
- },
-
- _test_enabled_link_click: function(link_type, view_url) {
- var mockio = new Y.lp.testing.mockio.MockIo();
- this.makeNavigator(
- this.makeNavigatorHooks(),
- {io_provider: mockio,
- config: {
- batch_request_value: 'foobar',
- view_link: view_url}});
- Y.one('#batch-links a.' + link_type).simulate('click');
- mockio.success({
- responseText: '<p>Batch content</p>',
- responseHeaders: {'Content-Type': 'text/html'}});
-
- // The URL has the batch_request parameter added.
- var expected_link;
- if (view_url !== undefined) {
- expected_link = 'http://foo/+somewhere';
- } else {
- expected_link = 'http://' + link_type + '/';
+ name: 'batchnavigator',
+
+ test_library_exists: function () {
+ Y.Assert.isObject(Y.lp.app.batchnavigator,
+ "We should be able to locate the lp.app.batchnavigator");
+ },
+
+ test_navigator_construction: function() {
+ this.makeNavigator(this.makeNavigatorHooks());
+ },
+
+ _test_enabled_link_click: function(link_type, view_url) {
+ var mockio = new Y.lp.testing.mockio.MockIo();
+ this.makeNavigator(
+ this.makeNavigatorHooks(),
+ {io_provider: mockio,
+ config: {
+ batch_request_value: 'foobar',
+ view_link: view_url}});
+ Y.one('#batch-links a.' + link_type).simulate('click');
+ mockio.success({
+ responseText: '<p>Batch content</p>',
+ responseHeaders: {'Content-Type': 'text/html'}});
+
+ // The URL has the batch_request parameter added.
+ var expected_link;
+ if (view_url !== undefined) {
+ expected_link = 'http://foo/+somewhere';
+ } else {
+ expected_link = 'http://' + link_type + '/';
+ }
+ expected_link += '?memo=0&batch_request=foobar';
+ Y.Assert.areEqual(expected_link, mockio.last_request.url);
+ // The content is rendered.
+ Y.Assert.areEqual(
+ '<p>Batch content</p>',
+ this.findRootTag().getContent());
+ },
+
+ // The following link tests check that the enabled navigation
+ // links work as expected. We test the 'next' and 'last' links.
+ // The 'first' and 'previous' links are not enabled.
+
+ test_next_link: function() {
+ this._test_enabled_link_click('next');
+ },
+
+ test_last_link: function() {
+ this._test_enabled_link_click('last');
+ },
+
+ // We an specify a different URL to use to fetch the batch data
+ // from.
+ test_link_with_view_url: function() {
+ this._test_enabled_link_click('last', '+somewhere');
+ },
+
+ test_show_spinner: function() {
+ var navigator = this.makeNavigator(this.makeNavigatorHooks());
+ navigator.showSpinner();
+ Y.Assert.isFalse(navigator.links_active);
+ Y.Assert.isTrue(
+ this.findRootTag().all('.spinner').size() > 0);
+ this.findRootTag().all('a', function(link) {
+ Y.Assert.isTrue(link.hasClass('inactive'));
+ });
+ },
+
+ test_hide_spinner: function() {
+ var navigator = this.makeNavigator(this.makeNavigatorHooks());
+ navigator.showSpinner();
+ navigator.hideSpinner();
+ Y.Assert.isTrue(navigator.links_active);
+ Y.Assert.isFalse(
+ this.findRootTag().all('.spinner').size() > 0);
+ this.findRootTag().all('a', function(link) {
+ Y.Assert.isFalse(link.hasClass('inactive'));
+ });
}
- expected_link += '?memo=0&batch_request=foobar';
- Y.Assert.areEqual(expected_link, mockio.last_request.url);
- // The content is rendered.
- Y.Assert.areEqual(
- '<p>Batch content</p>',
- this.findRootTag().getContent());
- },
-
- // The following link tests check that the enabled navigation links
- // work as expected. We test the 'next' and 'last' links. The 'first'
- // and 'previous' links are not enabled.
-
- test_next_link: function() {
- this._test_enabled_link_click('next');
- },
-
- test_last_link: function() {
- this._test_enabled_link_click('last');
- },
-
- // We an specify a different URL to use to fetch the batch data from.
- test_link_with_view_url: function() {
- this._test_enabled_link_click('last', '+somewhere');
- },
-
- test_show_spinner: function() {
- var navigator = this.makeNavigator(this.makeNavigatorHooks());
- navigator.showSpinner();
- Y.Assert.isFalse(navigator.links_active);
- Y.Assert.isTrue(
- this.findRootTag().all('.spinner').size() > 0);
- this.findRootTag().all('a', function(link) {
- Y.Assert.isTrue(link.hasClass('inactive'));
- });
- },
-
- test_hide_spinner: function() {
- var navigator = this.makeNavigator(this.makeNavigatorHooks());
- navigator.showSpinner();
- navigator.hideSpinner();
- Y.Assert.isTrue(navigator.links_active);
- Y.Assert.isFalse(
- this.findRootTag().all('.spinner').size() > 0);
- this.findRootTag().all('a', function(link) {
- Y.Assert.isFalse(link.hasClass('inactive'));
- });
- }
- })));
-
- Y.lp.testing.Runner.run(suite);
-
+ })
+ ));
+}, '0.1', {
+ 'requires': ['test', 'console', 'lp.testing.runner', 'lp.testing.mockio',
+ 'base', 'node', 'node-event-simulate', 'lp.app.batchnavigator']
});
-
=== modified file 'lib/lp/app/javascript/tests/test_beta_notification.html'
--- lib/lp/app/javascript/tests/test_beta_notification.html 2012-01-11 15:26:10 +0000
+++ lib/lp/app/javascript/tests/test_beta_notification.html 2012-02-07 20:25:28 +0000
@@ -1,25 +1,50 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd";>
+<!--
+Copyright 2012 Canonical Ltd. This software is licensed under the
+GNU Affero General Public License version 3 (see the file LICENSE).
+-->
+
<html>
<head>
- <title>Launchpad Beta Feature Notifications</title>
-
- <!-- YUI and test setup -->
- <script type="text/javascript"
- src="../../../../canonical/launchpad/icing/yui/yui/yui.js">
- </script>
- <link rel="stylesheet" href="../../../app/javascript/testing/test.css" />
- <script type="text/javascript"
- src="../../../app/javascript/testing/testrunner.js"></script>
- <script type="text/javascript"
- src="../../../contrib/javascript/lp.mustache.js"></script>
-
- <!-- The module under test. -->
- <script type="text/javascript" src="../beta-notification.js"></script>
-
- <!-- The test suite. -->
- <script type="text/javascript" src="test_beta_notification.js"></script>
- </head>
- <body class="yui3-skin-sam">
- <!-- The example markup required by the script to run. -->
- <div id="maincontent"> </div>
- </body>
+ <title>Test beta-notification</title>
+
+ <!-- YUI and test setup -->
+ <script type="text/javascript"
+ src="../../../../../build/js/yui/yui/yui.js">
+ </script>
+ <link rel="stylesheet"
+ href="../../../../../build/js/yui/console/assets/console-core.css" />
+ <link rel="stylesheet"
+ href="../../../../../build/js/yui/console/assets/skins/sam/console.css" />
+ <link rel="stylesheet"
+ href="../../../../../build/js/yui/test/assets/skins/sam/test.css" />
+
+ <script type="text/javascript"
+ src="../../../../../build/js/lp/app/testing/testrunner.js"></script>
+
+ <link rel="stylesheet" href="../../../app/javascript/testing/test.css" />
+
+ <!-- Dependencies -->
+ <script type="text/javascript"
+ src="../../../../../build/js/lp/lp.mustache.js"></script>
+
+ <!-- The module under test. -->
+ <script type="text/javascript" src="../beta-notification.js"></script>
+
+ <!-- Any css assert for this module. -->
+ <!-- <link rel="stylesheet" href="../assets/beta-notification-core.css" /> -->
+
+ <!-- The test suite. -->
+ <script type="text/javascript" src="test_beta_notification.js"></script>
+
+ </head>
+ <body class="yui3-skin-sam">
+ <ul id="suites">
+ <!-- <li>lp.large_indicator.test</li> -->
+ <li>lp.app.beta_notification.test</li>
+ </ul>
+ <!-- The example markup required by the script to run. -->
+ <div id="maincontent"></div>
+ </body>
</html>
=== modified file 'lib/lp/app/javascript/tests/test_beta_notification.js'
--- lib/lp/app/javascript/tests/test_beta_notification.js 2011-11-17 20:21:03 +0000
+++ lib/lp/app/javascript/tests/test_beta_notification.js 2012-02-07 20:25:28 +0000
@@ -1,17 +1,15 @@
-/* Copyright 2011 Canonical Ltd. This software is licensed under the
- * GNU Affero General Public License version 3 (see the file LICENSE).
- */
+/* Copyright (c) 2012, Canonical Ltd. All rights reserved. */
// Set the "enabled" variable, normally set by base-layout-macros.
// This must be a global variable for the code being tested to work.
var privacy_notification_enabled = true;
-YUI().use('lp.testing.runner', 'test', 'console', 'node',
- 'lp.app.beta_features', 'node-event-simulate', function(Y) {
-
- var suite = new Y.Test.Suite("lp.app.beta_notification Tests");
-
- suite.add(new Y.Test.Case({
+YUI.add('lp.app.beta_notification.test', function (Y) {
+
+ var tests = Y.namespace('lp.app.beta_notification.test');
+ tests.suite = new Y.Test.Suite('beta_notification Tests');
+
+ tests.suite.add(new Y.Test.Case({
name: 'beta-notification',
_reset_container: function () {
@@ -39,6 +37,11 @@
};
},
+ test_library_exists: function () {
+ Y.Assert.isObject(Y.lp.app.beta_features,
+ "We should be able to locate the lp.app.beta_features module");
+ },
+
test_beta_banner_one_beta_feature: function() {
LP.cache.related_features = {
'': {
@@ -139,8 +142,11 @@
},
400);
}
+
+
}));
- Y.lp.testing.Runner.run(suite);
+}, '0.1', {
+ 'requires': ['test', 'console', 'lp.beta_notification', 'node',
+ 'lp.app.beta_features', 'node-event-simulate']
});
-
Follow ups
