tests: fix IPv6 functional tests with IPv4 host

ruiquelhas · ruiquelhas · commit 15ed85ebd494 · 2022-04-21T16:03:46.000+01:00
Functional tests for IPv6 connections use a wrappper over the core
Node.js "dns.lookup()" API. This utility operates by resolving a
hostname to its corresponding IPv6 address. By default, the test
harness injects a hostname based on the value of the MYSQLX_HOST
environment variable, or by omission "localhost".

Although "localhost" works fine, assigning an IPv4 address to the
MYSQLX_HOST is also a common practice, and "dns.lookup()" is incapable
to resolve an IPv4 address to its corresponding IPv6 address. This
causes the IPv6 connection tests to fail.

This patch addresses this issue and updates the test suite alongside
the IPv6 address resolution utility to be able to work with both
common hostnames and IPv4 addresses.

Change-Id: I1037e6e3914b9dadfa1d7ba3d8433117a602db8d
diff --git a/test/fixtures/getIPv4Address.js b/test/fixtures/getIPv4Address.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 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
@@ -30,17 +30,12 @@
 
 'use strict';
 
-const dns = require('dns');
+const dns = require('dns').promises;
 
-module.exports = function (host) {
-    return new Promise(resolve => {
-        dns.lookup(host, { family: 4 }, (err, address) => {
-            if (err) {
-                // ignore errors
-                return resolve();
-            }
-
-            resolve(address);
-        });
-    });
+module.exports = function ({ host } = {}) {
+    return dns.lookup(host, { family: 4 })
+        .then(({ address }) => address)
+        // Ultimately, if the IPv4 address cannot be obtained, it should be
+        // "undefined".
+        .catch(() => undefined);
 };
diff --git a/test/fixtures/getIPv6Address.js b/test/fixtures/getIPv6Address.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
@@ -30,17 +30,30 @@
 
 'use strict';
 
-const dns = require('dns');
+const dns = require('dns').promises;
+const getIPv4Address = require('./getIPv4Address');
 
-module.exports = function (host) {
-    return new Promise(resolve => {
-        dns.lookup(host, { family: 6 }, (err, address) => {
-            if (err) {
-                // ignore errors
-                return resolve();
-            }
-
-            resolve(address);
-        });
-    });
+module.exports = function ({ host, port } = {}) {
+    // The host can be a common name, IPv4 or IPv6 address.
+    // "dns.lookup()"" does not work with IP addresses, so we first need to
+    // ensure we use the resolved common name instead.
+    // So, we can start by retrieving the IPv4 address.
+    return getIPv4Address({ host })
+        .then(address => {
+            // Then we use the IPv4 address to obtain the common name.
+            return dns.lookupService(address, port);
+        })
+        .then(({ hostname }) => {
+            // We can then use the common name to finally obtain any available
+            // IPv6 address. Of course, if the original host is already
+            // provided as a common name, there is one extra step involved,
+            // but, at least, we tried our best to obtain an address.
+            return dns.lookup(hostname, { family: 6 });
+        })
+        .then(({ address }) => {
+            return address;
+        })
+        // Ultimately, if the IPv6 address cannot be obtained, it should be
+        // "undefined".
+        .catch(() => undefined);
 };
diff --git a/test/functional/default/connection/dns-srv.js b/test/functional/default/connection/dns-srv.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
@@ -78,7 +78,7 @@ describe('connecting to the MySQL server using DNS SRV', () => {
         }];
 
         beforeEach('setup fake DNS server in the current host', () => {
-            return fixtures.getIPv4Address(os.hostname())
+            return fixtures.getIPv4Address({ host: os.hostname() })
                 .then(host => {
                     return fixtures.createRecordServer({ host, service: baseConfig.host, records });
                 })
@@ -121,7 +121,7 @@ describe('connecting to the MySQL server using DNS SRV', () => {
         let originalServers, fakeServer;
 
         beforeEach('setup fake DNS server in the current host', () => {
-            return fixtures.getIPv4Address(os.hostname())
+            return fixtures.getIPv4Address({ host: os.hostname() })
                 .then(host => {
                     return fixtures.createRecordServer({ host, service: baseConfig.host, records: [] });
                 })
diff --git a/test/functional/default/connection/ipv6.js b/test/functional/default/connection/ipv6.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
@@ -43,7 +43,7 @@ describe('connecting to the MySQL server using IPv6', () => {
     const baseConfig = { schema: undefined, socket: undefined };
 
     beforeEach('resolve IPv6 address', () => {
-        return fixtures.getIPv6Address(config.host)
+        return fixtures.getIPv6Address({ host: config.host, port: config.port })
             .then(address => {
                 host = address;
             });
diff --git a/test/functional/extended/connection/dns-srv.js b/test/functional/extended/connection/dns-srv.js
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2021, 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
@@ -49,7 +49,7 @@ describe('connecting to the MySQL server using DNS SRV', () => {
 
             return mysqlx.getSession(`mysqlx+srv://${srvConfig.user}:${srvConfig.password}@${srvConfig.host}`)
                 .then(session => {
-                    return fixtures.getIPv4Address(session.inspect().host)
+                    return fixtures.getIPv4Address({ host: session.inspect().host })
                         .then(address => {
                             expect(address).to.equal(endpoint.address);
                             return session.close();
@@ -71,7 +71,7 @@ describe('connecting to the MySQL server using DNS SRV', () => {
 
                 return mysqlx.getSession(srvConfig)
                     .then(session => {
-                        return fixtures.getIPv4Address(session.inspect().host)
+                        return fixtures.getIPv4Address({ host: session.inspect().host })
                             .then(address => {
                                 expect(address).to.equal(endpoints[0].address);
                                 return session.close();
@@ -84,7 +84,7 @@ describe('connecting to the MySQL server using DNS SRV', () => {
                         return mysqlx.getSession(srvConfig);
                     })
                     .then(session => {
-                        return fixtures.getIPv4Address(session.inspect().host)
+                        return fixtures.getIPv4Address({ host: session.inspect().host })
                             .then(address => {
                                 expect(address).to.equal(endpoints[1].address);
                                 return session.close();
@@ -97,7 +97,7 @@ describe('connecting to the MySQL server using DNS SRV', () => {
                         return mysqlx.getSession(srvConfig);
                     })
                     .then(session => {
-                        return fixtures.getIPv4Address(session.inspect().host)
+                        return fixtures.getIPv4Address({ host: session.inspect().host })
                             .then(address => {
                                 expect(address).to.equal(endpoints[0].address);
                                 return session.close();
@@ -124,7 +124,7 @@ describe('connecting to the MySQL server using DNS SRV', () => {
 
                 return pool.getSession()
                     .then(session => {
-                        return fixtures.getIPv4Address(session.inspect().host);
+                        return fixtures.getIPv4Address({ host: session.inspect().host });
                     })
                     .then(address => {
                         expect(address).to.equal(endpoints[0].address);
@@ -136,7 +136,7 @@ describe('connecting to the MySQL server using DNS SRV', () => {
                         return pool.getSession();
                     })
                     .then(session => {
-                        return fixtures.getIPv4Address(session.inspect().host);
+                        return fixtures.getIPv4Address({ host: session.inspect().host });
                     })
                     .then(address => {
                         expect(address).to.equal(endpoints[1].address);
@@ -148,7 +148,7 @@ describe('connecting to the MySQL server using DNS SRV', () => {
                         return pool.getSession();
                     })
                     .then(session => {
-                        return fixtures.getIPv4Address(session.inspect().host);
+                        return fixtures.getIPv4Address({ host: session.inspect().host });
                     })
                     .then(address => {
                         expect(address).to.equal(endpoints[0].address);
diff --git a/test/functional/extended/connection/failures.js b/test/functional/extended/connection/failures.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
@@ -198,7 +198,7 @@ describe('connection failures', () => {
                         return expect.fail();
                     })
                     .catch(err => {
-                        return fixtures.getIPv4Address(serverShutdownConfig.host)
+                        return fixtures.getIPv4Address({ host: serverShutdownConfig.host })
                             .then(address => {
                                 expect(err.code).to.equal('ECONNREFUSED');
                                 expect(err.address).to.equal(address);
