count failed attempts on server and verify it matches the expected count, document retry defaults

Author: GlenTiki

README.md

@@ -58,7 +58,17 @@ Start an anger instance against a given target.
     * `auth`: A `Function` or `Object` passed to the nes client for authentication. If a `Function`, it is passed the `client` and `index` of that client as params. Must return the auth object options. If an `Object`, it must be passed the auth object options. [auth object reference.][nes-auth]
     * `identifier`: A function used to map some payload response data to a requests uid.
     * `trigger`: A function which is passed a nes client to emit a message to the server for testing. Must return some uid of a message sent.
-    * `retryOpts`: An object which is passed to [try-again](try-again) to achieve exponential backoff for retries. [Check the  try-again docs for reference on how to use it.](try-again)
+    * `retryOpts`: An object which is passed to [try-again](try-again) to achieve exponential backoff for retries. [Check the  try-again docs for reference on how to use it.](try-again). Default values below:
+      ```js
+      {
+        retries: 8,
+        max: 10000,
+        jitter: 0.2,
+        factor: 2,
+        min: 100
+      }
+      ```
+
 
 **Returns** an instance/event emitter for tracking progress, etc.
 

test/authServer.js

@@ -11,6 +11,7 @@ function build (cb) {
   })
 
   server.count = 0
+  server.failedCount = 0
 
   server.register([Basic, Nes], function (err) {
     if (err) { throw err }
@@ -32,6 +33,7 @@ function build (cb) {
     var validate = function (request, username, password, callback) {
       var user = server.users[username]
       if (!user) {
+        server.failedCount++
         return callback(null, false)
       }
       server.users[username].signin++

test/failed-auth.test.js

@@ -4,7 +4,7 @@ const test = require('tap').test
 const anger = require('..')
 
 test('failed auth', { timeout: 3000 }, (t) => {
-  t.plan(2)
+  t.plan(3)
 
   require('./authServer')((err, server) => {
     t.error(err)
@@ -18,7 +18,7 @@ test('failed auth', { timeout: 3000 }, (t) => {
       senders: 1,
       connections: 10,
       identifier: (payload) => payload.meta.id,
-      auth: { headers: { authorization: 'Basic failing' } },
+      auth: { headers: { authorization: `Basic ${new Buffer('jane:jane').toString('base64')}` } },
       requests: 1,
       responses: 10,
       trigger: (sender) => {
@@ -38,6 +38,7 @@ test('failed auth', { timeout: 3000 }, (t) => {
 
     instance.on('error', (err) => {
       t.ok(err, 'error happened')
+      t.equal(server.failedCount, 10)
     })
 
     instance.on('end', () => {