@mysql/xdevapi/test/unit/DevAPI/TableOrdering.js

MySQL Connector/Node.js - A Node.js driver for MySQL using the X Protocol and X DevAPI.

/*
 * Copyright (c) 2019, 2022, Oracle and/or its affiliates.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2.0, as
 * published by the Free Software Foundation.
 *
 * This program is also distributed with certain software (including
 * but not limited to OpenSSL) that is licensed under separate terms,
 * as designated in a particular file or component or in included license
 * documentation.  The authors of MySQL hereby grant you an
 * additional permission to link the program and your derivative works
 * with the separately licensed software that they have included with
 * MySQL.
 *
 * Without limiting anything contained in the foregoing, this file,
 * which is part of MySQL Connector/Node.js, is also subject to the
 * Universal FOSS Exception, version 1.0, a copy of which can be found at
 * http://oss.oracle.com/licenses/universal-foss-exception.
 *
 * 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, version 2.0, 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 St, Fifth Floor, Boston, MA 02110-1301  USA
 */

'use strict';

/* eslint-env node, mocha */

const dataModel = require('../../../lib/Protocol/Stubs/mysqlx_crud_pb').DataModel.TABLE;
const expect = require('chai').expect;
const td = require('testdouble');

// subject under test needs to be reloaded with test doubles
let TableOrdering = require('../../../lib/DevAPI/TableOrdering');

describe('TableOrdering mixin', () => {
    let SortExprStr;

    beforeEach('replace dependencies with test doubles', () => {
        SortExprStr = td.replace('../../../lib/DevAPI/SortExprStr');
        // reload module with the replacements
        TableOrdering = require('../../../lib/DevAPI/TableOrdering');
    });

    afterEach('restore original dependencies', () => {
        td.reset();
    });

    context('orderBy()', () => {
        it('appends parsed order expressions in table mode provided as multiple arguments to the statement order list', () => {
            const forceRestart = td.function();
            const getValue = td.function();
            const orderList = ['foo'];
            const sortExprStrs = ['bar', 'baz'];
            const sortExprs = ['qux', 'quux'];
            const expected = [...orderList, ...sortExprs];
            // Adds order expressions beforehand to ensure those are not removed.
            const statement = TableOrdering({ orderList, preparable: { forceRestart } });

            td.when(SortExprStr({ dataModel, value: sortExprStrs[0] })).thenReturn({ getValue });
            td.when(SortExprStr({ dataModel, value: sortExprStrs[1] })).thenReturn({ getValue });
            td.when(getValue()).thenReturn(sortExprs[1]);
            td.when(getValue(), { times: 1 }).thenReturn(sortExprs[0]);

            statement.orderBy(sortExprStrs[0], sortExprStrs[1]);

            // If it is a prepared statement, it needs to be prepared again
            // because the boundaries have changed.
            expect(td.explain(forceRestart).callCount).to.equal(1);

            expect(orderList).to.deep.equal(expected);
        });

        it('appends parsed order expressions provided as an array to the statement order list', () => {
            const forceRestart = td.function();
            const getValue = td.function();
            const orderList = ['foo'];
            const sortExprStrs = ['bar', 'baz'];
            const sortExprs = ['qux', 'quux'];
            const expected = [...orderList, ...sortExprs];
            // Adds order expressions beforehand to ensure those are not removed.
            const statement = TableOrdering({ orderList, preparable: { forceRestart } });

            td.when(SortExprStr({ dataModel, value: sortExprStrs[0] })).thenReturn({ getValue });
            td.when(SortExprStr({ dataModel, value: sortExprStrs[1] })).thenReturn({ getValue });
            td.when(getValue()).thenReturn(sortExprs[1]);
            td.when(getValue(), { times: 1 }).thenReturn(sortExprs[0]);

            statement.orderBy(sortExprStrs);

            // If it is a prepared statement, it needs to be prepared again
            // because the boundaries have changed.
            expect(td.explain(forceRestart).callCount).to.equal(1);

            expect(orderList).to.deep.equal(expected);
        });
    });
});