--on-port

README.md

@@ -53,6 +53,10 @@ Available options:
         The amount of requests to make before exiting the benchmark. If set, duration is ignored.
   -S/--socketPath
         A path to a Unix Domain Socket or a Windows Named Pipe. A URL is still required in order to send the correct Host header and path.
+  --on-port
+        Start the command listed after -- on the command line. When it starts listening on a port,
+        start sending requests to that port. A URL is still required in order to send requests to
+        the correct path. The hostname can be omitted, `localhost` will be used by default.
   -m/--method METHOD
         The http method to use. default: 'GET'.
   -t/--timeout NUM

autocannon.js

@@ -6,6 +6,7 @@ const minimist = require('minimist')
 const fs = require('fs')
 const path = require('path')
 const URL = require('url').URL
+const nitm = require('nitm')
 const help = fs.readFileSync(path.join(__dirname, 'help.txt'), 'utf8')
 const run = require('./lib/run')
 const track = require('./lib/progressTracker')
@@ -23,7 +24,7 @@ module.exports.parseArguments = parseArguments
 
 function parseArguments (argvs) {
   const argv = minimist(argvs, {
-    boolean: ['json', 'n', 'help', 'renderLatencyTable', 'renderProgressBar', 'forever', 'idReplacement', 'excludeErrorStats'],
+    boolean: ['json', 'n', 'help', 'renderLatencyTable', 'renderProgressBar', 'forever', 'idReplacement', 'excludeErrorStats', 'onPort'],
     alias: {
       connections: 'c',
       pipelining: 'p',
@@ -32,6 +33,7 @@ function parseArguments (argvs) {
       amount: 'a',
       json: 'j',
       renderLatencyTable: ['l', 'latency'],
+      onPort: 'on-port',
       method: 'm',
       headers: ['H', 'header'],
       body: 'b',
@@ -65,11 +67,16 @@ function parseArguments (argvs) {
       method: 'GET',
       idReplacement: false,
       excludeErrorStats: false
-    }
+    },
+    '--': true
   })
 
   argv.url = argv._[0]
 
+  if (argv.onPort) {
+    argv.spawn = argv['--']
+  }
+
   // support -n to disable the progress bar and results table
   if (argv.n) {
     argv.renderProgressBar = false
@@ -100,7 +107,12 @@ function parseArguments (argvs) {
 
   // check that the URL is valid.
   try {
-    new URL(argv.url) // eslint-disable-line no-new
+    // If --on-port is given, it's acceptable to not have a hostname
+    if (argv.onPort) {
+      new URL(argv.url, 'http://localhost') // eslint-disable-line no-new
+    } else {
+      new URL(argv.url) // eslint-disable-line no-new
+    }
   } catch (err) {
     console.error(err.message)
     console.error('')
@@ -139,9 +151,37 @@ function start (argv) {
     return
   }
 
+  if (argv.onPort) {
+    const proc = nitm(
+      ['-r', require.resolve('./lib/detectPort')],
+      argv.spawn,
+      { stdio: ['ignore', 'inherit', 'inherit', 'pipe'] }
+    )
+
+    proc.stdio[3].once('data', (chunk) => {
+      const port = chunk.toString()
+      const url = new URL(argv.url, `http://localhost:${port}`).href
+      const opts = Object.assign({}, argv, {
+        onPort: false,
+        url: url
+      })
+      runTracker(opts, () => {
+        // `nitm` catches the SIGINT so we write it to a file descriptor
+        // instead of doing proc.kill()
+        proc.stdio[3].write('SIGINT')
+        proc.stdio[3].end()
+      })
+    })
+  } else {
+    runTracker(argv)
+  }
+}
+
+function runTracker (argv, ondone) {
   const tracker = run(argv)
 
   tracker.on('done', (result) => {
+    if (ondone) ondone()
     if (argv.json) {
       console.log(JSON.stringify(result))
     }

help.txt

@@ -15,6 +15,10 @@ Available options:
         The amount of requests to make before exiting the benchmark. If set, duration is ignored.
   -S/--socketPath
         A path to a Unix Domain Socket or a Windows Named Pipe. A URL is still required in order to send the correct Host header and path.
+  --on-port
+        Start the command listed after -- on the command line. When it starts listening on a port,
+        start sending requests to that port. A URL is still required in order to send requests to
+        the correct path. The hostname can be omitted, `localhost` will be used by default.
   -m/--method METHOD
         The http method to use. default: 'GET'.
   -t/--timeout NUM

lib/detectPort.js

@@ -0,0 +1,17 @@
+'use strict'
+
+const onListen = require('on-net-listen')
+const fs = require('fs')
+
+onListen(function (addr) {
+  this.destroy()
+  const port = Buffer.from(addr.port + '')
+  fs.writeSync(3, port, 0, port.length)
+})
+
+// `nitm` catches the SIGINT so we write it to a file descriptor instead
+const stream = fs.createReadStream('/', { fd: 3 })
+process.on('exit', () => stream.close())
+stream.once('data', (chunk) => {
+  if (chunk.toString() === 'SIGINT') process.exit(0)
+})

package.json

@@ -50,6 +50,8 @@
     "http-parser-js": "^0.4.13",
     "hyperid": "^1.4.1",
     "minimist": "^1.2.0",
+    "nitm": "^1.0.2",
+    "on-net-listen": "^1.1.1",
     "pretty-bytes": "^5.1.0",
     "progress": "^2.0.0",
     "reinterval": "^1.1.0",

test/onPort.test.js

@@ -0,0 +1,48 @@
+'use strict'
+
+const t = require('tap')
+const spawn = require('child_process').spawn
+const split = require('split2')
+const autocannon = require.resolve('../autocannon')
+const target = require.resolve('./targetProcess')
+
+const lines = [
+  /Running 1s test @ .*$/,
+  /10 connections.*$/,
+  /$/,
+  /Stat.*Avg.*Stdev.*Max.*$/,
+  /Latency \(ms\).*$/,
+  /Req\/Sec.*$/,
+  /Bytes\/Sec.*$/,
+  /$/,
+  // Ensure that there are more than 0 successful requests
+  /[1-9]\d*.* requests in \d+s, .* read/
+]
+
+t.plan(lines.length * 2)
+
+const child = spawn(autocannon, [
+  '-c', '10',
+  '-d', '1',
+  '--on-port', '/',
+  '--', 'node', target
+], {
+  cwd: __dirname,
+  env: process.env,
+  stdio: ['ignore', 'pipe', 'pipe'],
+  detached: false
+})
+
+t.tearDown(() => {
+  child.kill()
+})
+
+child
+  .stderr
+  .pipe(split())
+  .on('data', (line) => {
+    const regexp = lines.shift()
+    console.error(line)
+    t.ok(regexp, 'we are expecting this line')
+    t.ok(regexp.test(line), 'line matches ' + regexp)
+  })

test/targetProcess.js

@@ -0,0 +1,3 @@
+const server = require('./helper').startServer()
+
+server.ref()