settings_user_groups.js: Add 100% node test coverage.

frontend_tests/node_tests/settings_user_groups.js

@@ -5,7 +5,13 @@ set_global('i18n', global.stub_i18n);
 
 var noop = function () {};
 
+var pills = {
+    pill: {},
+};
 set_global('channel', {});
+set_global('templates', {});
+set_global('blueslip', {});
+set_global('typeahead_helper', {});
 set_global('user_groups', {
     get_user_group_from_id: noop,
     remove: noop,
@@ -14,15 +20,229 @@ set_global('user_groups', {
 set_global('ui_report', {});
 set_global('people', {
     my_current_user_id: noop,
+    get_realm_persons: noop,
 });
 
-(function test_set_up() {
+(function test_populate_user_groups() {
-    var populate_user_groups_called = false;
+    var realm_user_group = {
-    settings_user_groups.populate_user_groups = function () {
+        id: 1,
-        populate_user_groups_called = true;
+        name: 'Mobile',
+        description: 'All mobile people',
+        members: [2, 4],
     };
+    var iago = {
+        email: 'iago@zulip.com',
+        user_id: 2,
+        full_name: 'Iago',
+    };
+    var alice = {
+        email: 'alice@example.com',
+        user_id: 31,
+        full_name: 'Alice',
+    };
+    var bob = {
+        email: 'bob@example.com',
+        user_id: 32,
+        full_name: 'Bob',
+    };
+
+    user_groups.get_realm_user_groups = function () {
+        return [realm_user_group];
+    };
+    var templates_render_called = false;
+    var fake_rendered_temp = $.create('fake_admin_user_group_list_template_rendered');
+    templates.render = function (template, args) {
+        assert.equal(template, 'admin_user_group_list');
+        assert.equal(args.user_group.id, 1);
+        assert.equal(args.user_group.name, 'Mobile');
+        assert.equal(args.user_group.description, 'All mobile people');
+        templates_render_called = true;
+        return fake_rendered_temp;
+    };
+
+    var user_groups_list_append_called = false;
+    $('#user-groups').append = function (rendered_temp) {
+        assert.equal(rendered_temp, fake_rendered_temp);
+        user_groups_list_append_called = true;
+    };
+
+    var get_person_from_user_id_called = false;
+    var blueslip_warn_called = false;
+    people.get_person_from_user_id = function (user_id) {
+        if (user_id === iago.user_id) {
+            return iago;
+        }
+        assert.equal(user_id, 4);
+        blueslip.warn = function (err_msg) {
+            assert.equal(err_msg, 'Unknown user ID 4 in members of user group Mobile');
+            blueslip_warn_called = true;
+        };
+        get_person_from_user_id_called = true;
+    };
+
+    var pill_container_stub = $('.pill-container[data-group-pills="Mobile"]');
+    pills.pill.append = function (name, id) {
+        if (this.all_pills === undefined) {
+            this.all_pills = {};
+        }
+        assert.equal(this.all_pills[id], undefined);
+        this.all_pills[id] = name;
+    };
+    pills.keys = function () {
+        return _.map(Object.keys(pills.pill.all_pills),
+            function (strnum) {
+                return parseInt(strnum, 10);
+            });
+    };
+
+    function input_pill_stub(pill_container) {
+        assert.equal(pill_container, pill_container_stub);
+        return pills;
+    }
+    var input_field_stub = $.create('fake-input-field');
+    pill_container_stub.children = function () {
+        return input_field_stub;
+    };
+
+    var input_typeahead_called = false;
+    var sibling_context = {};
+    var fade_to_called = false;
+    var fade_out_called = false;
+    input_field_stub.typeahead = function (config) {
+        assert.equal(config.items, 5);
+        assert(config.fixed);
+        assert(config.dropup);
+        assert(config.stopAdvance);
+        assert.equal(typeof(config.source), 'function');
+        assert.equal(typeof(config.highlighter), 'function');
+        assert.equal(typeof(config.matcher), 'function');
+        assert.equal(typeof(config.sorter), 'function');
+        assert.equal(typeof(config.updater), 'function');
+
+        (function test_highlighter() {
+            var fake_person = $.create('fake-person');
+            typeahead_helper.render_person = function () {
+                return fake_person;
+            };
+            assert.equal(config.highlighter(), fake_person);
+        }());
+
+        var fake_context = {
+            query: 'ali',
+        };
+
+        (function test_matcher() {
+            /* Here the query doesn't begin with an '@' because typeahead is triggered
+            by the '@' sign and thus removed in the query. */
+            var result = config.matcher.call(fake_context, iago);
+            assert(!result);
+
+            result = config.matcher.call(fake_context, alice);
+            assert(result);
+        }());
+
+        (function test_sorter() {
+            var sort_recipientbox_typeahead_called = false;
+            typeahead_helper.sort_recipientbox_typeahead = function () {
+                sort_recipientbox_typeahead_called = true;
+            };
+            config.sorter.call(fake_context);
+            assert(sort_recipientbox_typeahead_called);
+        }());
+
+        (function test_updater() {
+            input_field_stub.text('@ali');
+            user_groups.get_user_group_from_id = function () {
+                return realm_user_group;
+            };
+            pill_container_stub.siblings = function (sel) {
+                assert.equal(sel, '.save-member-changes');
+                return sibling_context;
+            };
+            config.updater(alice);
+            assert.equal(input_field_stub.text(), '');
+            assert.equal(pill_container_stub
+                .siblings('.save-member-changes')
+                .css('display'), 'inline-block');
+        }());
+        assert(fade_to_called);
+        assert(!fade_out_called);
+        input_typeahead_called = true;
+    };
+
+    sibling_context.display_val = 'none';
+    sibling_context.fadeOut = function () {
+        fade_out_called = true;
+    };
+    sibling_context.fadeTo = function () {
+        fade_to_called = true;
+    };
+    sibling_context.css = function (prop) {
+        if (typeof(prop)  === 'string') {
+            assert.equal(prop, 'display');
+            return this.display_val;
+        }
+        assert.equal(typeof(prop), 'object');
+        assert.equal(prop.display, 'inline-block');
+        assert.equal(prop.opacity, '0');
+        this.display_val = 'inline-block';
+        return this;
+    };
+
+    var get_by_email_called = false;
+    people.get_by_email = function (user_email) {
+        get_by_email_called = true;
+        if (user_email === iago.email) {
+            return iago;
+        }
+        if (user_email === bob.email) {
+            return bob;
+        }
+        assert.equal(user_email,
+            'Expected user email to be of Alice or Iago here.');
+    };
+    pills.onPillCreate = function (handler) {
+        assert.equal(typeof(handler), 'function');
+        var reject_called = false;
+        function reject() {
+            reject_called = true;
+        }
+        (function test_rejection_path() {
+            handler(iago.email, reject);
+            assert(get_by_email_called);
+            assert(reject_called);
+        }());
+
+        (function test_success_path() {
+            get_by_email_called = false;
+            reject_called = false;
+            var res = handler(bob.email, reject);
+            assert(get_by_email_called);
+            assert(!reject_called);
+            assert.equal(typeof(res), 'object');
+            assert.equal(res.key, bob.user_id);
+            assert.equal(res.value, bob.full_name);
+        }());
+    };
+
+    pills.onPillRemove = function (handler) {
+        realm_user_group.members = [2, 31];
+        fade_to_called = false;
+        fade_out_called = false;
+        handler();
+        assert(!fade_to_called);
+        assert(fade_out_called);
+    };
+
+    set_global('input_pill', input_pill_stub);
     settings_user_groups.set_up();
-    assert(populate_user_groups_called);
+    assert(templates_render_called);
+    assert(user_groups_list_append_called);
+    assert(get_person_from_user_id_called);
+    assert(blueslip_warn_called);
+    assert(input_typeahead_called);
+
+    // Tests for settings_user_groups.set_up workflow.
     assert.equal(typeof($('.organization').get_on_handler("submit", "form.admin-user-group-form")), 'function');
     assert.equal(typeof($('#user-groups').get_on_handler('click', '.delete')), 'function');
     assert.equal(typeof($('#user-groups').get_on_handler('keypress', '.user-group h4 > span')), 'function');
@@ -30,6 +250,12 @@ set_global('people', {
     assert.equal(typeof($('#user-groups').get_on_handler('click', '.save-group-changes')), 'function');
 }());
 
+(function test_reset() {
+    settings_user_groups.reset();
+    var result = settings_user_groups.populate_user_groups();
+    assert.equal(result, undefined);
+}());
+
 (function test_reload() {
     $('#user-groups').html('Some text');
     var populate_user_groups_called = false;
@@ -59,13 +285,13 @@ set_global('people', {
         fake_this.serializeArray = function () {
             return fake_object_array;
         };
-        channel.post = function (payload) {
+        channel.post = function (opts) {
             var data = {
                 members: '[null]',
             };
             data[fake_object_array[1].name] = fake_object_array[1].value;
-            assert.equal(payload.url, "/json/user_groups/create");
+            assert.equal(opts.url, "/json/user_groups/create");
-            assert.deepEqual(payload.data, data);
+            assert.deepEqual(opts.data, data);
 
             (function test_post_success() {
                 $('#admin-user-group-status').show();
@@ -75,7 +301,7 @@ set_global('people', {
                     assert.equal(ele, $('#admin-user-group-status'));
                 };
 
-                payload.success();
+                opts.success();
 
                 assert(!$('#admin-user-group-status').visible());
                 assert.equal($("form.admin-user-group-form input[type='text']").val(), '');
@@ -94,7 +320,7 @@ set_global('people', {
                 var xhr = {
                     responseText: '{"msg":"fake-msg", "attrib":"val"}',
                 };
-                payload.error(xhr);
+                opts.error(xhr);
 
                 assert(!$('#admin-user-group-status').visible());
             }());
@@ -109,22 +335,22 @@ set_global('people', {
         fake_this.set_parents_result('.user-group', $('.user-group'));
         $('.user-group').attr('id', '1');
 
-        channel.del = function (payload) {
+        channel.del = function (opts) {
             var data = {
                 id: 1,
             };
             var settings_user_groups_reload_called = false;
-            assert.equal(payload.url, "/json/user_groups/1");
+            assert.equal(opts.url, "/json/user_groups/1");
-            assert.deepEqual(payload.data, data);
+            assert.deepEqual(opts.data, data);
 
             settings_user_groups.reload = function () {
                 settings_user_groups_reload_called = true;
             };
-            payload.success();
+            opts.success();
             assert(settings_user_groups_reload_called);
 
             fake_this.text(i18n.t('fake-text'));
-            payload.error();
+            opts.error();
             assert.equal(fake_this.text(), 'translated: Failed!');
         };
 
@@ -225,10 +451,10 @@ set_global('people', {
             return group_data;
         };
 
-        channel.patch = function (payload) {
+        channel.patch = function (opts) {
-            assert.equal(payload.url, "/json/user_groups/3");
+            assert.equal(opts.url, "/json/user_groups/3");
-            assert.equal(payload.data.name, 'translated: mobile');
+            assert.equal(opts.data.name, 'translated: mobile');
-            assert.equal(payload.data.description, 'translated: All mobile members');
+            assert.equal(opts.data.description, 'translated: All mobile members');
 
             (function test_post_success() {
                 fake_this.text(i18n.t('fake-text'));
@@ -243,7 +469,7 @@ set_global('people', {
                     save_btn_fade_out_called = true;
                     func.call(fake_this);
                 };
-                payload.success();
+                opts.success();
                 assert(save_btn_fade_out_called);
                 assert.equal(fake_this.html(), '<i class="fa fa-check" aria-hidden="true"></i>');
                 assert.equal(fake_this.text(), 'translated: Saved!');
@@ -251,7 +477,7 @@ set_global('people', {
 
             (function test_post_error() {
                 fake_this.text(i18n.t('fake-text'));
-                payload.error();
+                opts.error();
                 assert.equal(fake_this.text(), 'translated: Failed!');
             }());
         };
@@ -260,4 +486,67 @@ set_global('people', {
         assert.equal(group_data.name, 'translated: mobile');
         assert.equal(group_data.description, 'translated: All mobile members');
     }());
+
+    (function test_user_groups_click_save_member_changes_triggered() {
+        var handler = $('#user-groups #1').get_on_handler("click", ".save-member-changes");
+        var realm_user_group = {
+            id: 1,
+            name: 'Mobile',
+            description: 'All mobile people',
+            members: [2, 4],
+        };
+        var fake_this = $.create('fake-#user-groups_click_save_member_changes');
+        user_groups.get_user_group_from_id = function (id) {
+            assert.equal(id, 1);
+            return realm_user_group;
+        };
+
+        channel.post = function (opts) {
+            assert.equal(opts.url, "/json/user_groups/1/members");
+            assert.equal(opts.data.add, '[31]');
+            assert.equal(opts.data.delete, '[4]');
+
+            (function test_post_success() {
+                var user_group_remove_called = false;
+                var user_group_add_called = false;
+                user_groups.remove = function (data) {
+                    assert.equal(data.name, 'Mobile');
+                    assert.equal(data.id, 1);
+                    user_group_remove_called = true;
+                };
+                user_groups.add = function (data) {
+                    assert.equal(data.name, 'Mobile');
+                    assert.equal(data.id, 1);
+                    assert.deepEqual(data.members, [2, 31]);
+                    user_group_add_called = true;
+                };
+                fake_this.text(i18n.t('fake-text'));
+                fake_this.delay = function (time) {
+                    assert.equal(time, 200);
+                    return fake_this;
+                };
+                fake_this.html('');
+                var save_btn_fade_out_called = false;
+                fake_this.fadeOut = function (func) {
+                    assert.equal(typeof(func), 'function');
+                    save_btn_fade_out_called = true;
+                    func.call(fake_this);
+                };
+                opts.success();
+                assert(save_btn_fade_out_called);
+                assert(user_group_remove_called);
+                assert(user_group_add_called);
+                assert.equal(fake_this.html(), '<i class="fa fa-check" aria-hidden="true"></i>');
+                assert.equal(fake_this.text(), 'translated: Saved!');
+            }());
+
+            (function test_post_error() {
+                fake_this.text(i18n.t('fake-text'));
+                opts.error();
+                assert.equal(fake_this.text(), 'translated: Failed!');
+            }());
+        };
+
+        handler.call(fake_this);
+    }());
 }());

tools/test-js-with-node

@@ -49,6 +49,7 @@ enforce_fully_covered = {
     'static/js/recent_senders.js',
     'static/js/rtl.js',
     'static/js/search_suggestion.js',
+    'static/js/settings_user_groups.js',
     'static/js/stream_data.js',
     'static/js/stream_events.js',
     'static/js/stream_sort.js',