tao-test/app/taoQtiTest/views/js/test/markForReview/test.js

/**
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; under version 2
 * of the License (non-upgradable).
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2015 (original work) Open Assessment Technologies SA ;
 */
/**
 * @author Jean-Sébastien Conan <jean-sebastien.conan@vesperiagroup.com>
 */
define([

    'jquery',
    'lodash',
    'taoQtiTest/testRunner/actionBar/markForReview'
], function($, _, markForReview) {
    'use strict';

    // global mock for button config
    var configMock = {
        label: 'Mark for review',
        icon: 'anchor',
        hook: 'taoQtiTest/testRunner/actionBar/markForReview'
    };

    QUnit.module('markForReview');

    QUnit.test('module', function(assert) {
        assert.equal(typeof markForReview, 'object', 'The markForReview module exposes an object');
    });

    var markForReviewApi = [
        {name: 'init', title: 'init'},
        {name: 'clear', title: 'clear'},
        {name: 'render', title: 'render'},
        {name: 'bindTo', title: 'bindTo'},
        {name: 'bindEvents', title: 'bindEvents'},
        {name: 'unbindEvents', title: 'unbindEvents'},
        {name: 'isVisible', title: 'isVisible'},
        {name: 'hasMenu', title: 'hasMenu'},
        {name: 'isMenuOpen', title: 'isMenuOpen'},
        {name: 'closeMenu', title: 'closeMenu'},
        {name: 'openMenu', title: 'openMenu'},
        {name: 'toggleMenu', title: 'toggleMenu'},
        {name: 'setActive', title: 'setActive'},
        {name: 'trigger', title: 'trigger'},
        {name: 'on', title: 'on'},
        {name: 'off', title: 'off'},
        {name: 'setup', title: 'setup'},
        {name: 'action', title: 'action'},
        {name: 'menuAction', title: 'menuAction'}
    ];

    QUnit
        .cases.init(markForReviewApi)
        .test('API ', function(data, assert) {
            assert.equal(typeof markForReview[data.name], 'function', 'The markForReview module exposes a "' + data.title + '" function');
        });

    QUnit.test('button enabled/disabled', function(assert) {
        var testContextMock = {
            reviewScreen: false,
            considerProgress: true,
            navigatorMap: [],
            categories: []
        };

        testContextMock.reviewScreen = true;
        markForReview.init('markForReview', configMock, testContextMock, {});
        assert.ok(!markForReview.isVisible(), 'The markForReview button is not visible when the test taker screen is enabled and the right itemRef category is not set');

        testContextMock.reviewScreen = false;
        markForReview.init('markForReview', configMock, testContextMock, {});
        assert.ok(!markForReview.isVisible(), 'The markForReview button is not visible when the test taker screen is disabled and the right itemRef category is not set');

        //Add special category to enable markForReview
        testContextMock.categories.push('x-tao-option-markReview');

        testContextMock.reviewScreen = true;
        markForReview.init('markForReview', configMock, testContextMock, {});
        assert.ok(markForReview.isVisible(), 'The markForReview button is visible when the test taker screen is enabled and the right itemRef category is set');

        testContextMock.reviewScreen = false;
        markForReview.init('markForReview', configMock, testContextMock, {});
        assert.ok(!markForReview.isVisible(), 'The markForReview button is not visible when the test taker screen is disabled and the right itemRef category is set');
    });

    QUnit.test('button install/uninstall', function(assert) {
        var ready = assert.async();
        var callExpected = true;
        var testRunnerMock = {
            markForReview: function() {
                if (callExpected) {
                    assert.ok(true, 'The button must trigger a call to markForReview');
                    ready();
                } else {
                    assert.ok(false, 'The button must not trigger a call to markForReview');
                }
            }
        };

        var testContextMock = {
            reviewScreen: true,
            considerProgress: true,
            navigatorMap: []
        };

        var $container = $('#mark-for-review-1');
        var $btn;

        markForReview.init('markForReview', configMock, testContextMock, testRunnerMock);
        $btn = markForReview.render();
        $container.append($btn);

        $btn.click();

        markForReview.clear();

        var ready = assert.async();
        _.defer(function() {
            assert.ok(true, 'The button is uninstalled and did not trigger a call to markForReview');
            ready();
        }, 100);
        $btn.click();
    });

    QUnit.test('button active/idle', function(assert) {
        var testRunnerMock = {
            markForReview: function() {}
        };

        var testContextMock = {
            reviewScreen: true,
            considerProgress: true,
            navigatorMap: [],
            itemFlagged: true
        };

        var $container = $('#mark-for-review-2');
        var $btn;

        markForReview.init('markForReview', configMock, testContextMock, testRunnerMock);
        $btn = markForReview.render();
        $container.append($btn);

        assert.ok($btn.hasClass('active'), 'The markForReview button is activated when the current item is flagged');

        $container = $('#mark-for-review-3');

        testContextMock.itemFlagged = false;
        markForReview.init('markForReview', configMock, testContextMock, testRunnerMock);
        $btn = markForReview.render();
        $container.append($btn);

        assert.ok(!$btn.hasClass('active'), 'The markForReview button is idled when the current item is not flagged');
    });

    QUnit.test('button click', function(assert) {
        var expectedFlag = true;
        var expectedPosition = 1;
        var ready = assert.async(4);

        var testRunnerMock = {
            markForReview: function(flag, itemPosition) {
                assert.equal(flag, expectedFlag, 'The markForReview button must call the markForReview action with the right flag state');
                assert.equal(itemPosition, expectedPosition, 'The markForReview button must call the markForReview action with the right item position');
                assert.equal(!$btn.hasClass('active'), flag, 'The markForReview button is active when the current item is flagged, or idle when the current item is not flagged');
                ready();
            }
        };

        var testContextMock = {
            reviewScreen: true,
            considerProgress: true,
            navigatorMap: [],
            itemFlagged: false,
            itemPosition: 1
        };

        var $container = $('#mark-for-review-4');
        var $btn;

        markForReview.init('markForReview', configMock, testContextMock, testRunnerMock);
        $btn = markForReview.render();
        $container.append($btn);

        assert.ok(!$btn.hasClass('active'), 'The markForReview button is idled when the current item is not flagged');

        $btn.click();

        expectedFlag = false;
        $btn.click();

        expectedFlag = true;
        expectedPosition = 2;
        testContextMock.itemPosition = 2;
        $btn.click();

        expectedFlag = false;
        $btn.click();
    });

});