Refactor tests: let setupProxy take unix socket as well as TCP socket options.

Author: dometto

lib/testutil.js

@@ -3,7 +3,7 @@
 import http from "node:http";
 import https from "node:https";
 import { WebSocketServer } from "ws";
-import { ConfigurableProxy } from "./configproxy.js";
+import { ConfigurableProxy, parseListenOptions } from "./configproxy.js";
 import { defaultLogger } from "./log.js";
 
 var servers = [];
@@ -87,14 +87,16 @@ export function addTargets(proxy, paths, port) {
   });
 }
 
-export function setupProxy(port, options, paths) {
+export function setupProxy(listenOptions, options, paths) {
   options = options || {};
   options.authToken = "secret";
   options.log = defaultLogger({ level: "error" });
-
+  var listen = parseListenOptions(listenOptions);
+  var port = listen.port || 8000;
+  var ip = listen.ip;
   var proxy = new ConfigurableProxy(options);
   proxy._setup_timestamp = new Date(new Date().getTime() - 60000);
-  var ip = "127.0.0.1";
+
   var countdown = 2;
   var resolvePromise;
 
@@ -134,10 +136,10 @@ export function setupProxy(port, options, paths) {
   proxy.proxyServer.on("listening", onlisten);
 
   addTargets(proxy, paths || ["/"], port + 2).then(function () {
-    proxy.proxyServer.listen(port, ip);
-    proxy.apiServer.listen(port + 1, ip);
+    proxy.proxyServer.listen(...listen.proxyTarget);
+    proxy.apiServer.listen(...listen.apiTarget);
     if (options.enableMetrics) {
-      proxy.metricsServer.listen(port + 3, ip);
+      proxy.metricsServer.listen(...listen.metricsTarget);
     }
   });
   return p;

test/api_spec.js

@@ -8,15 +8,19 @@ log.remove(log.transports.Console);
 
 describe("API Tests", function () {
   var port = 8902;
-  var apiPort = port + 1;
+  var listenOptions = {
+    port: port,
+    apiPort: 8903,
+    ip: '127.0.0.1'
+  };
   var proxy;
-  var apiUrl = "http://127.0.0.1:" + apiPort + "/api/routes";
+  var apiUrl = "http://" + listenOptions.ip + ":" + listenOptions.apiPort + "/api/routes";
 
   var r;
 
   beforeEach(function (callback) {
     util
-      .setupProxy(port)
+      .setupProxy(listenOptions)
       .then(function (newProxy) {
         proxy = newProxy;
       })

test/proxy_spec.js

@@ -13,14 +13,18 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 describe("Proxy Tests", function () {
   var port = 8902;
+  var listenOptions = {
+    port: port,
+    ip: '127.0.0.1'
+  };
   var testPort = port + 10;
   var proxy;
-  var proxyUrl = "http://127.0.0.1:" + port;
+  var proxyUrl = "http://" + listenOptions.ip + ":" + port;
   var hostTest = "test.localhost.jovyan.org";
   var hostUrl = "http://" + hostTest + ":" + port;
 
   beforeEach(function (callback) {
-    util.setupProxy(port).then(function (newProxy) {
+    util.setupProxy(listenOptions).then(function (newProxy) {
       proxy = newProxy;
       callback();
     });
@@ -338,10 +342,12 @@ describe("Proxy Tests", function () {
   });
 
   it("custom error target", function (done) {
-    var proxyPort = 55550;
+    var listenOptions = {
+      port: 55550
+    };
     util
-      .setupProxy(proxyPort, { errorTarget: "http://127.0.0.1:55565" }, [])
-      .then(() => fetch("http://127.0.0.1:" + proxyPort + "/foo/bar"))
+      .setupProxy(listenOptions, { errorTarget: "http://127.0.0.1:55565" }, [])
+      .then(() => fetch("http://127.0.0.1:" + listenOptions.port + "/foo/bar"))
       .then((res) => {
         expect(res.status).toEqual(404);
         expect(res.headers.get("content-type")).toEqual("text/plain");
@@ -405,10 +411,12 @@ describe("Proxy Tests", function () {
   });
 
   it("backend error", function (done) {
-    var proxyPort = 55550;
+    var listenOptions = {
+      port: 55550
+    };
     util
-      .setupProxy(proxyPort, { errorTarget: "http://127.0.0.1:55565" }, [])
-      .then(() => fetch("http://127.0.0.1:" + proxyPort + "/%"))
+      .setupProxy(listenOptions, { errorTarget: "http://127.0.0.1:55565" }, [])
+      .then(() => fetch("http://127.0.0.1:" + listenOptions.port + "/%"))
       .then((res) => {
         expect(res.status).toEqual(500);
         expect(res.headers.get("content-type")).toEqual("text/plain");
@@ -433,7 +441,9 @@ describe("Proxy Tests", function () {
   });
 
   it("Redirect location with rewriting", function (done) {
-    var proxyPort = 55556;
+    var listenOptions = {
+      port: 55556
+    };
     var options = {
       protocolRewrite: "https",
       autoRewrite: true,
@@ -442,10 +452,10 @@ describe("Proxy Tests", function () {
     // where the backend server redirects us.
     // Note that http-proxy requires (logically) the redirection to be to the same (internal) host.
     var redirectTo = "https://127.0.0.1:" + testPort + "/whatever";
-    var expectedRedirect = "https://127.0.0.1:" + proxyPort + "/whatever";
+    var expectedRedirect = "https://127.0.0.1:" + listenOptions.port + "/whatever";
 
     util
-      .setupProxy(proxyPort, options, [])
+      .setupProxy(listenOptions, options, [])
       .then((proxy) =>
         util.addTargetRedirecting(
           proxy,
@@ -456,7 +466,7 @@ describe("Proxy Tests", function () {
         )
       )
       .then(() =>
-        fetch("http://127.0.0.1:" + proxyPort + "/external/urlpath/", { redirect: "manual" })
+        fetch("http://127.0.0.1:" + listenOptions.port + "/external/urlpath/", { redirect: "manual" })
       )
       .then((res) => {
         expect(res.status).toEqual(301);
@@ -483,8 +493,10 @@ describe("Proxy Tests", function () {
       done();
       return;
     }
-    var proxyPort = 55556;
-    var testPort = proxyPort + 20;
+    var listenOptions = {
+      port: 55556
+    };
+    var testPort = listenOptions.port + 20;
     var options = {
       clientSsl: {
         key: fs.readFileSync(path.resolve(__dirname, "ssl/proxy-client/proxy-client.key")),
@@ -494,7 +506,7 @@ describe("Proxy Tests", function () {
     };
 
     util
-      .setupProxy(proxyPort, options, [])
+      .setupProxy(listenOptions, options, [])
       .then((proxy) =>
         util.addTarget(proxy, "/backend/", testPort, false, null, {
           key: fs.readFileSync(path.resolve(__dirname, "ssl/backend/backend.key")),
@@ -503,7 +515,7 @@ describe("Proxy Tests", function () {
           requestCert: true,
         })
       )
-      .then(() => fetch("http://127.0.0.1:" + proxyPort + "/backend/urlpath/"))
+      .then(() => fetch("http://127.0.0.1:" + listenOptions.port + "/backend/urlpath/"))
       .then((res) => {
         expect(res.status).toEqual(200);
       })