test: reduce usage of get-port dependency (#5848)

Author: watson

integration-tests/appsec/data-collection.spec.js

@@ -1,7 +1,6 @@
 'use strict'
 
 const { assert } = require('chai')
-const getPort = require('get-port')
 const path = require('path')
 const Axios = require('axios')
 
@@ -12,16 +11,12 @@ const {
 } = require('../helpers')
 
 describe('ASM Data collection', () => {
-  let axios, sandbox, cwd, appPort, appFile, agent, proc
+  let axios, sandbox, cwd, appFile, agent, proc
 
   before(async () => {
     sandbox = await createSandbox(['express'])
-    appPort = await getPort()
     cwd = sandbox.folder
     appFile = path.join(cwd, 'appsec/data-collection/index.js')
-    axios = Axios.create({
-      baseURL: `http://localhost:${appPort}`
-    })
   })
 
   after(async () => {
@@ -33,7 +28,6 @@ describe('ASM Data collection', () => {
       agent = await new FakeAgent().start()
 
       const env = {
-        APP_PORT: appPort,
         DD_TRACE_AGENT_PORT: agent.port,
         DD_APPSEC_ENABLED: true,
         DD_APPSEC_RULES: path.join(cwd, 'appsec', 'data-collection', 'data-collection-rules.json')
@@ -46,6 +40,7 @@ describe('ASM Data collection', () => {
       }
 
       proc = await spawnProc(appFile, { cwd, env, execArgv: [] })
+      axios = Axios.create({ baseURL: proc.url })
     })
 
     afterEach(async () => {

integration-tests/appsec/data-collection/index.js

@@ -7,7 +7,6 @@ tracer.init({
 const express = require('express')
 
 const app = express()
-const port = process.env.APP_PORT || 3000
 
 app.get('/', (req, res) => {
   // Content headers
@@ -22,6 +21,6 @@ app.get('/', (req, res) => {
   res.end('end')
 })
 
-app.listen(port, () => {
-  process.send({ port })
+const server = app.listen(process.env.APP_PORT || 0, () => {
+  process.send?.({ port: server.address().port })
 })

integration-tests/appsec/esm-app/index.mjs

@@ -6,7 +6,6 @@ import Module from 'node:module'
 import './worker.mjs'
 
 const app = express()
-const port = process.env.APP_PORT || 3000
 
 app.get('/cmdi-vulnerable', (req, res) => {
   childProcess.execSync(`ls ${req.query.args}`)
@@ -16,8 +15,8 @@ app.get('/cmdi-vulnerable', (req, res) => {
 
 app.use('/more', (await import('./more.mjs')).default)
 
-app.listen(port, () => {
-  process.send({ port })
+const server = app.listen(process.env.APP_PORT || 0, () => {
+  process.send?.({ port: server.address().port })
 })
 
 Module.register('./custom-noop-hooks.mjs', {

integration-tests/appsec/esm-security-controls/index.mjs

@@ -7,7 +7,6 @@ import sanitizeDefault from './sanitizer-default.mjs'
 import { validate, validateNotConfigured } from './validator.mjs'
 
 const app = express()
-const port = process.env.APP_PORT || 3000
 
 app.get('/cmdi-s-secure', (req, res) => {
   const command = sanitize(req.query.command)
@@ -64,6 +63,6 @@ app.get('/cmdi-iv-secure', (req, res) => {
   res.end()
 })
 
-app.listen(port, () => {
-  process.send({ port })
+const server = app.listen(process.env.APP_PORT || 0, () => {
+  process.send?.({ port: server.address().port })
 })

integration-tests/appsec/graphql.spec.js

@@ -1,6 +1,5 @@
 'use strict'
 
-const getPort = require('get-port')
 const { assert } = require('chai')
 const path = require('path')
 const axios = require('axios')
@@ -12,22 +11,20 @@ const {
 } = require('../helpers')
 
 describe('graphql', () => {
-  let sandbox, cwd, agent, webFile, proc, appPort
+  let sandbox, cwd, agent, webFile, proc
 
   before(async function () {
     sandbox = await createSandbox(['@apollo/server', 'graphql', 'koalas'])
     cwd = sandbox.folder
     webFile = path.join(cwd, 'graphql/index.js')
-    appPort = await getPort()
   })
 
   beforeEach(async () => {
     agent = await new FakeAgent().start()
     proc = await spawnProc(webFile, {
       cwd,
       env: {
-        AGENT_PORT: agent.port,
-        APP_PORT: appPort
+        AGENT_PORT: agent.port
       }
     })
   })
@@ -54,7 +51,7 @@ describe('graphql', () => {
     })
 
     await axios({
-      url: `http://localhost:${appPort}/graphql`,
+      url: `${proc.url}/graphql`,
       method: 'post',
       headers: {
         'Content-type': 'application/json'
@@ -116,7 +113,7 @@ describe('graphql', () => {
     })
 
     await axios({
-      url: `http://localhost:${appPort}/graphql`,
+      url: `${proc.url}/graphql`,
       method: 'post',
       headers: {
         'Content-type': 'application/json'

integration-tests/appsec/iast.esm-security-controls.spec.js

@@ -2,23 +2,17 @@
 
 const { createSandbox, spawnProc, FakeAgent } = require('../helpers')
 const path = require('path')
-const getPort = require('get-port')
 const Axios = require('axios')
 const { assert } = require('chai')
 
 describe('ESM Security controls', () => {
-  let axios, sandbox, cwd, appPort, appFile, agent, proc
+  let axios, sandbox, cwd, appFile, agent, proc
 
   before(async function () {
     this.timeout(process.platform === 'win32' ? 90000 : 30000)
     sandbox = await createSandbox(['express@4']) // TODO: Remove pinning once our tests support Express v5
-    appPort = await getPort()
     cwd = sandbox.folder
     appFile = path.join(cwd, 'appsec', 'esm-security-controls', 'index.mjs')
-
-    axios = Axios.create({
-      baseURL: `http://localhost:${appPort}`
-    })
   })
 
   after(async function () {
@@ -34,7 +28,6 @@ describe('ESM Security controls', () => {
       cwd,
       env: {
         DD_TRACE_AGENT_PORT: agent.port,
-        APP_PORT: appPort,
         DD_IAST_ENABLED: 'true',
         DD_IAST_REQUEST_SAMPLING: '100',
         // eslint-disable-next-line no-multi-str
@@ -45,6 +38,8 @@ describe('ESM Security controls', () => {
         NODE_OPTIONS: nodeOptions
       }
     })
+
+    axios = Axios.create({ baseURL: proc.url })
   })
 
   afterEach(async () => {

integration-tests/appsec/iast.esm.spec.js

@@ -2,23 +2,17 @@
 
 const { createSandbox, spawnProc, FakeAgent } = require('../helpers')
 const path = require('path')
-const getPort = require('get-port')
 const Axios = require('axios')
 const { assert } = require('chai')
 
 describe('ESM', () => {
-  let axios, sandbox, cwd, appPort, appFile, agent, proc
+  let axios, sandbox, cwd, appFile, agent, proc
 
   before(async function () {
     this.timeout(process.platform === 'win32' ? 90000 : 30000)
     sandbox = await createSandbox(['express'])
-    appPort = await getPort()
     cwd = sandbox.folder
     appFile = path.join(cwd, 'appsec', 'esm-app', 'index.mjs')
-
-    axios = Axios.create({
-      baseURL: `http://localhost:${appPort}`
-    })
   })
 
   after(async function () {
@@ -39,12 +33,13 @@ describe('ESM', () => {
           cwd,
           env: {
             DD_TRACE_AGENT_PORT: agent.port,
-            APP_PORT: appPort,
             DD_IAST_ENABLED: 'true',
             DD_IAST_REQUEST_SAMPLING: '100',
             NODE_OPTIONS: nodeOptions
           }
         })
+
+        axios = Axios.create({ baseURL: proc.url })
       })
 
       afterEach(async () => {

integration-tests/appsec/index.spec.js

@@ -1,27 +1,22 @@
 'use strict'
 
-const getPort = require('get-port')
 const path = require('path')
 const Axios = require('axios')
 const { assert } = require('chai')
 const msgpack = require('@msgpack/msgpack')
 const { createSandbox, FakeAgent, spawnProc } = require('../helpers')
 
 describe('RASP', () => {
-  let axios, sandbox, cwd, appPort, appFile, agent, proc, stdioHandler
+  let axios, sandbox, cwd, appFile, agent, proc, stdioHandler
 
   function stdOutputHandler (data) {
     stdioHandler && stdioHandler(data)
   }
 
   before(async () => {
     sandbox = await createSandbox(['express', 'axios'])
-    appPort = await getPort()
     cwd = sandbox.folder
     appFile = path.join(cwd, 'appsec/rasp/index.js')
-    axios = Axios.create({
-      baseURL: `http://localhost:${appPort}`
-    })
   })
 
   after(async () => {
@@ -40,13 +35,13 @@ describe('RASP', () => {
         execArgv,
         env: {
           DD_TRACE_AGENT_PORT: agent.port,
-          APP_PORT: appPort,
           DD_APPSEC_ENABLED: true,
           DD_APPSEC_RASP_ENABLED: true,
           DD_APPSEC_RULES: path.join(cwd, 'appsec/rasp/rasp_rules.json'),
           DD_APPSEC_RASP_COLLECT_REQUEST_BODY: collectRequestBody
         }
       }, stdOutputHandler, stdOutputHandler)
+      axios = Axios.create({ baseURL: proc.url })
     })
 
     afterEach(async () => {

integration-tests/debugger/re-evaluation.spec.js

@@ -1,14 +1,11 @@
 'use strict'
 
-const { EOL } = require('node:os')
-const { spawn } = require('node:child_process')
 const { randomUUID } = require('node:crypto')
 const assert = require('node:assert')
 
-const getPort = require('get-port')
 const Axios = require('axios')
 
-const { createSandbox, FakeAgent, assertObjectContains } = require('../helpers')
+const { createSandbox, FakeAgent, assertObjectContains, spawnProc } = require('../helpers')
 const { generateProbeConfig } = require('../../packages/dd-trace/test/debugger/devtools_client/utils')
 
 // A race condition exists where the tracer receives a probe via RC, before Node.js has had a chance to load all the JS
@@ -50,48 +47,22 @@ describe('Dynamic Instrumentation Probe Re-Evaluation', function () {
 
   function genTestsForSourceFile (sourceFile) {
     return function () {
-      let rcConfig, appPort, agent, proc, axios
+      let rcConfig, agent, proc, axios
 
       beforeEach(async function () {
         rcConfig = {
           product: 'LIVE_DEBUGGING',
           id: `logProbe_${randomUUID()}`,
           config: generateProbeConfig({ sourceFile, line: 4 })
         }
-        appPort = await getPort()
         agent = await new FakeAgent().start()
-        proc = spawn(
-          process.execPath,
-          ['--import', 'dd-trace/initialize.mjs', sourceFile],
-          {
-            cwd: sandbox.folder,
-            env: {
-              APP_PORT: appPort,
-              DD_DYNAMIC_INSTRUMENTATION_ENABLED: true,
-              DD_TRACE_AGENT_PORT: agent.port,
-              DD_TRACE_DEBUG: process.env.DD_TRACE_DEBUG // inherit to make debugging the sandbox easier
-            }
-          }
-        )
-        proc
-          .on('exit', (code) => {
-            if (code !== 0) {
-              throw new Error(`Child process exited with code ${code}`)
-            }
-          })
-          .on('error', (error) => {
-            throw error
-          })
-        proc.stdout.on('data', log.bind(null, '[child process stdout]'))
-        proc.stderr.on('data', log.bind(null, '[child process stderr]'))
-        axios = Axios.create({
-          baseURL: `http://localhost:${appPort}`
-        })
+        proc = undefined
       })
 
       afterEach(async function () {
         proc?.kill(0)
         await agent?.stop()
+        axios = undefined
       })
 
       for (let attempt = 1; attempt <= 5; attempt++) {
@@ -138,13 +109,24 @@ describe('Dynamic Instrumentation Probe Re-Evaluation', function () {
           })
 
           agent.addRemoteConfig(rcConfig)
+
+          spawnProc(sourceFile, {
+            cwd: sandbox.folder,
+            env: {
+              NODE_OPTIONS: '--import dd-trace/initialize.mjs',
+              DD_DYNAMIC_INSTRUMENTATION_ENABLED: 'true',
+              DD_TRACE_AGENT_PORT: agent.port,
+              DD_TRACE_DEBUG: process.env.DD_TRACE_DEBUG, // inherit to make debugging the sandbox easier
+              DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS: 0.1
+            }
+          }).then(_proc => {
+            proc = _proc
+            // Possible race condition, in case axios.get() is called in the test before it's created here. But we have
+            // to start the test quickly in order to test the re-evaluation of the probe.
+            axios = Axios.create({ baseURL: proc.url })
+          })
         })
       }
     }
   }
 })
-
-function log (prefix, data) {
-  const msg = data.toString().trim().split(EOL).map((line) => `${prefix} ${line}`).join(EOL)
-  console.log(msg) // eslint-disable-line no-console
-}

integration-tests/debugger/source-map-support.spec.js

@@ -17,7 +17,7 @@ describe('Dynamic Instrumentation', function () {
         t.agent.on('debugger-input', ({ payload: [{ debugger: { snapshot: { probe: { location } } } }] }) => {
           assert.deepEqual(location, {
             file: 'target-app/source-map-support/typescript.ts',
-            lines: ['10']
+            lines: ['11']
           })
           done()
         })