tests: simplify dummy socket timeout servers

The dummy socket servers used in functional tests for checking the
connection timeout, in particular, for the multi-host scenario, have a
somewhat complicated implementation. The resulting setup is overwhelming
and seems to be causing some synchronicity issues in the test harness.

These issues are, at times, observable when checking if the elapsed time
whilst trying to connect to the server is, in fact, above or equal to
the sum of all the reported connection timeouts.

This patch simplifies the dummy server setup and inverts the
timestamp-based checks to compare the elapsed time during each test to
the timeout itself, instead of simply comparing raw timestamps, which
are not easy to understand when the assertions fail.

Change-Id: I96ed9a4ab06eca9545a6f1b2ce4a922c42892537

Author: ruiquelhas

test/fixtures/destroyServerSocket.js

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) 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';
+
+module.exports = function (server) {
+    return new Promise((resolve, reject) => {
+        // If the server is not listening, there is nothing to do.
+        if (!server.listening) {
+            return resolve();
+        }
+
+        // Make sure the server does not accept any new connections.
+        server.close(err => {
+            if (err) {
+                return reject(err);
+            }
+
+            return resolve();
+        });
+
+        // The callback on "close" is only called after all
+        // connections are closed, so we need to make sure that
+        // happens.
+        server.emit('close');
+    });
+};

test/fixtures/index.js

@@ -38,6 +38,7 @@ module.exports = {
     createSchema: require('./createSchema'),
     createUser: require('./createUser'),
     deregisterService: require('./deregisterService'),
+    destroyServerSocket: require('./destroyServerSocket'),
     dropSchema: require('./dropSchema'),
     dropUser: require('./dropUser'),
     getIPv4Address: require('./getIPv4Address'),

test/functional/default/connection/timeout.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2020, 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
@@ -35,6 +35,7 @@
 const config = require('../../../config');
 const errors = require('../../../../lib/constants/errors');
 const expect = require('chai').expect;
+const fixtures = require('../../../fixtures');
 const mysqlx = require('../../../../');
 const net = require('net');
 const os = require('os');
@@ -93,25 +94,10 @@ describe('connecting to servers with a given timeout', () => {
 
         beforeEach('create fake server', () => {
             server = net.createServer();
-
-            server.on('connection', socket => {
-                server.on('close', () => socket.destroy());
-                socket.pause();
-            });
         });
 
-        afterEach('close fake server', done => {
-            // If the server is not listening, there is nothing to do.
-            if (!server.listening) {
-                return done();
-            }
-
-            // Make sure the server does not accept any new connections.
-            server.close(done);
-            // The callback on "close" is only called after all
-            // connections are closed, so we need to make sure that
-            // happens.
-            server.emit('close');
+        afterEach('close fake server', () => {
+            return fixtures.destroyServerSocket(server);
         });
 
         context('using a Unix socket', () => {
@@ -255,51 +241,10 @@ describe('connecting to servers with a given timeout', () => {
         beforeEach('create fake servers', () => {
             primary = net.createServer();
             secondary = net.createServer();
-
-            [primary, secondary].forEach(server => {
-                server.on('connection', socket => {
-                    primary.on('close', () => socket.destroy());
-                    socket.pause();
-                });
-            });
         });
 
-        afterEach('close fake servers', done => {
-            // If the servers are not listening, there is nothing to do.
-            if (!secondary.listening && !primary.listening) {
-                return done();
-            }
-
-            // If only the primary is listening.
-            if (!secondary.listening) {
-                // We prevent it from accepting new connections.
-                primary.close(done);
-                // And close the existing ones.
-                primary.emit('close');
-                return;
-            }
-
-            // By this point both the primary and secondary should be
-            // listening.
-            secondary.close(err => {
-                if (!err) {
-                    return primary.close(done);
-                }
-
-                // Even if there is an error, we should try to close
-                // the primary as well.
-                return primary.close(err => {
-                    if (err) {
-                        return done(err);
-                    }
-
-                    return done(err);
-                });
-            });
-
-            [primary, secondary].forEach(server => {
-                server.emit('close');
-            });
+        afterEach('close fake servers', () => {
+            return Promise.all([fixtures.destroyServerSocket(primary), fixtures.destroyServerSocket(secondary)]);
         });
 
         context('using a Unix socket', () => {
@@ -331,8 +276,9 @@ describe('connecting to servers with a given timeout', () => {
                             return expect.fail();
                         })
                         .catch(err => {
+                            const elapsedTime = Date.now() - beforeTest;
                             // The timeout check restarts for each endpoint.
-                            expect(Date.now()).to.be.at.least(beforeTest + connectTimeout * 2);
+                            expect(elapsedTime).to.be.at.least(connectTimeout * timeoutConfig.endpoints.length);
                             return expect(err.message).to.equal(error);
                         });
                 });
@@ -354,8 +300,9 @@ describe('connecting to servers with a given timeout', () => {
                             return expect.fail();
                         })
                         .catch(err => {
+                            const elapsedTime = Date.now() - beforeTest;
                             // The timeout check restarts for each endpoint.
-                            expect(Date.now()).to.be.at.least(beforeTest + connectTimeout * 2);
+                            expect(elapsedTime).to.be.at.least(connectTimeout * timeoutConfig.endpoints.length);
                             return expect(err.message).to.equal(error);
                         });
                 });
@@ -421,8 +368,9 @@ describe('connecting to servers with a given timeout', () => {
                             return expect.fail();
                         })
                         .catch(err => {
+                            const elapsedTime = Date.now() - beforeTest;
                             // The timeout check restarts for each endpoint.
-                            expect(Date.now()).to.be.at.least(beforeTest + connectTimeout * 2);
+                            expect(elapsedTime).to.be.at.least(connectTimeout * timeoutConfig.endpoints.length);
                             return expect(err.message).to.equal(error);
                         });
                 });
@@ -440,8 +388,9 @@ describe('connecting to servers with a given timeout', () => {
                             return expect.fail();
                         })
                         .catch(err => {
+                            const elapsedTime = Date.now() - beforeTest;
                             // The timeout check restarts for each endpoint.
-                            expect(Date.now()).to.be.at.least(beforeTest + connectTimeout * 2);
+                            expect(elapsedTime).to.be.at.least(connectTimeout * timeoutConfig.endpoints.length);
                             return expect(err.message).to.equal(error);
                         });
                 });