@mysql/xdevapi/test/unit/Protocol/OutboundHandlers/Session.js

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

/*
 * Copyright (c) 2020, 2021, 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 expect = require('chai').expect;
const td = require('testdouble');

// subject under test needs to be reloaded with replacement fakes
let session = require('../../../../lib/Protocol/OutboundHandlers/Session');

describe('Mysqlx.Session outbound handler', () => {
    let authenticateStart, authenticateContinue, close, info, logger, reset;

    beforeEach('create fakes', () => {
        authenticateStart = td.replace('../../../../lib/Protocol/Wrappers/Messages/Session/AuthenticateStart');
        authenticateContinue = td.replace('../../../../lib/Protocol/Wrappers/Messages/Session/AuthenticateContinue');
        close = td.replace('../../../../lib/Protocol/Wrappers/Messages/Session/Close');
        reset = td.replace('../../../../lib/Protocol/Wrappers/Messages/Session/Reset');
        logger = td.replace('../../../../lib/logger');

        info = td.function();
        td.when(logger('protocol:outbound:Mysqlx.Session')).thenReturn({ info });

        session = require('../../../../lib/Protocol/OutboundHandlers/Session');
    });

    afterEach('reset fakes', () => {
        td.reset();
    });

    it('serializes and logs Mysqlx.Session.AuthenticateStart messages', () => {
        const message = { serialize: td.function() };

        td.when(authenticateStart.create('foo', 'bar')).thenReturn(message);
        td.when(message.serialize()).thenReturn('baz');

        expect(session.encodeAuthenticateStart('foo', 'bar')).to.equal('baz');
        expect(td.explain(info).callCount).to.equal(1);
        expect(td.explain(info).calls[0].args[0]).to.equal('AuthenticateStart');
        expect(td.explain(info).calls[0].args[1]).to.deep.equal(message);
    });

    it('serializes and logs Mysqlx.Session.AuthenticateContinue messages', () => {
        const message = { serialize: td.function() };

        td.when(authenticateContinue.create('foo')).thenReturn(message);
        td.when(message.serialize()).thenReturn('bar');

        expect(session.encodeAuthenticateContinue('foo')).to.equal('bar');
        expect(td.explain(info).callCount).to.equal(1);
        expect(td.explain(info).calls[0].args[0]).to.equal('AuthenticateContinue');
        expect(td.explain(info).calls[0].args[1]).to.deep.equal(message);
    });

    it('serializes and logs Mysqlx.Session.Close messages', () => {
        const message = { serialize: td.function() };

        td.when(close.create()).thenReturn(message);
        td.when(message.serialize()).thenReturn('foo');

        expect(session.encodeClose()).to.equal('foo');
        expect(td.explain(info).callCount).to.equal(1);
        expect(td.explain(info).calls[0].args[0]).to.equal('Close');
        expect(td.explain(info).calls[0].args[1]).to.deep.equal(message);
    });

    it('serializes and logs Mysqlx.Session.Reset messages keeping the connection open by default', () => {
        const message = { serialize: td.function() };

        td.when(reset.create(true)).thenReturn(message);
        td.when(message.serialize()).thenReturn('foo');

        expect(session.encodeReset()).to.equal('foo');
        expect(td.explain(info).callCount).to.equal(1);
        expect(td.explain(info).calls[0].args[0]).to.equal('Reset');
        expect(td.explain(info).calls[0].args[1]).to.deep.equal(message);
    });

    it('serializes and logs Mysqlx.Session.Reset messages closing the connection', () => {
        const message = { serialize: td.function() };

        td.when(reset.create(false)).thenReturn(message);
        td.when(message.serialize()).thenReturn('foo');

        expect(session.encodeReset({ keepOpen: false })).to.equal('foo');
        expect(td.explain(info).callCount).to.equal(1);
        expect(td.explain(info).calls[0].args[0]).to.equal('Reset');
        expect(td.explain(info).calls[0].args[1]).to.deep.equal(message);
    });
});