Code coverage report for nock/lib/back.js

Statements: 94.06% (95 / 101)      Branches: 76.92% (20 / 26)      Functions: 100% (21 / 21)      Lines: 94.06% (95 / 101)      Ignored: none     

All files » nock/lib/ » back.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314    1 1   1 1 1 1 1   1   1   1 1                                                 1 12 1         11 10 10     11   11       11 11     11   11                     1       2 2 2 2         1                           1       9 9 9   9         2   2 2                           1       9 9 9 9 9         7     7   7 4         4     7         7 4   4 1     4 4   4 4                   1       2 2 2 2 2         1                           1 11     4       11 5 5   5 5   5 5       11           1 10 10                         1 10       10           1 4 3                     1                               1 11       11 11   11 11           1 1 1   1  
'use strict';
 
var nock = require('./scope');
var recorder = require('./recorder');
 
var format = require('util').format;
var mkdirp = require('mkdirp');
var path = require('path');
var expect = require('chai').expect;
var debug = require('debug')('nock.back');
 
var _mode = null;
 
var fs;
 
try {
  fs = require('fs');
} catch(err) {
  // do nothing, probably in browser
}
 
 
 
/**
 * nock the current function with the fixture given
 *
 * @param {string}   fixtureName  - the name of the fixture, e.x. 'foo.json'
 * @param {object}   options      - [optional], extra options for nock with, e.x. { assert: true }
 * @param {function} nockedFn     - the callback function to be executed with the given fixture being loaded,
 *                                  the function will be called with { scopes: loaded_nocks || [] } set as this
 *
 *
 * List of options:
 *
 * @param {function} before       - a preprocessing function, gets called before nock.define
 * @param {function} after        - a postprocessing function, gets called after nock.define
 * @param {function} afterRecord  - a postprocessing function, gets called after recording. Is passed the array
 *                                  of scopes recorded and should return the array scopes to save to the fixture
 
 *
 */
function Back (fixtureName, options, nockedFn) {
  if(!Back.fixtures) {
    throw new Error(  'Back requires nock.back.fixtures to be set\n' +
                      'Ex:\n' +
                      '\trequire(nock).back.fixtures = \'/path/to/fixures/\'');
  }
 
  if( arguments.length === 2 ) {
    nockedFn = options;
    options = {};
  }
 
  _mode.setup();
 
  var fixture = path.join(Back.fixtures, fixtureName)
    , context = _mode.start(fixture, options);
 
 
  var nockDone = function () {
    _mode.finish(fixture, options, context);
  };
 
  debug('context:', context);
 
  nockedFn.call(context, nockDone);
}
 
 
 
 
/*******************************************************************************
*                                    Modes                                     *
*******************************************************************************/
 
 
var wild = {
 
 
  setup: function () {
    nock.cleanAll();
    recorder.restore();
    nock.activate();
    nock.enableNetConnect();
  },
 
 
  start: function () {
    return load(); //don't load anything but get correct context
  },
 
 
  finish: function () {
    //nothing to do
  }
 
 
};
 
 
 
 
var dryrun = {
 
 
  setup: function () {
    recorder.restore();
    nock.cleanAll();
    nock.activate();
    //  We have to explicitly enable net connectivity as by default it's off.
    nock.enableNetConnect();
  },
 
 
  start: function (fixture, options) {
    var contexts = load(fixture, options);
 
    nock.enableNetConnect();
    return contexts;
  },
 
 
  finish: function () {
    //nothing to do
  }
 
 
};
 
 
 
 
var record = {
 
 
  setup: function () {
    recorder.restore();
    recorder.clear();
    nock.cleanAll();
    nock.activate();
    nock.disableNetConnect();
  },
 
 
  start: function (fixture, options) {
    Iif (! fs) {
      throw new Error('no fs');
    }
    var context = load(fixture, options);
 
    if( !context.isLoaded ) {
      recorder.record({
        dont_print: true,
        output_objects: true
      });
 
      context.isRecording = true;
    }
 
    return context;
  },
 
 
  finish: function (fixture, options, context) {
    if( context.isRecording ) {
      var outputs = recorder.outputs();
 
      if( typeof options.afterRecord === 'function' ) {
        outputs = options.afterRecord(outputs);
      }
 
      outputs = JSON.stringify(outputs, null, 4);
      debug('recorder outputs:', outputs);
 
      mkdirp.sync(path.dirname(fixture));
      fs.writeFileSync(fixture, outputs);
    }
  }
 
 
};
 
 
 
 
var lockdown = {
 
 
  setup: function () {
    recorder.restore();
    recorder.clear();
    nock.cleanAll();
    nock.activate();
    nock.disableNetConnect();
  },
 
 
  start: function (fixture, options) {
    return load(fixture, options);
  },
 
 
  finish: function () {
    //nothing to do
  }
 
 
};
 
 
 
 
function load (fixture, options) {
  var context = {
    scopes : [],
    assertScopesFinished: function () {
      assertScopes(this.scopes, fixture);
    }
  };
 
  if( fixture && fixtureExists(fixture) ) {
    var scopes = nock.loadDefs(fixture);
    applyHook(scopes, options.before);
 
    scopes = nock.define(scopes);
    applyHook(scopes, options.after);
 
    context.scopes = scopes;
    context.isLoaded = true;
  }
 
 
  return context;
}
 
 
 
 
function applyHook(scopes, fn) {
  Eif( !fn ) {
    return;
  }
 
  if( typeof fn !== 'function' ) {
    throw new Error ('processing hooks must be a function');
  }
 
  scopes.forEach(fn);
}
 
 
 
 
function fixtureExists(fixture) {
  Iif (! fs) {
    throw new Error('no fs');
  }
 
  return fs.existsSync(fixture);
}
 
 
 
 
function assertScopes (scopes, fixture) {
  scopes.forEach(function (scope) {
    expect( scope.isDone() )
    .to.be.equal(
      true,
      format('%j was not used, consider removing %s to rerecord fixture', scope.pendingMocks(), fixture)
    );
  });
}
 
 
 
 
var Modes = {
 
  wild: wild, //all requests go out to the internet, dont replay anything, doesnt record anything
 
  dryrun: dryrun, //use recorded nocks, allow http calls, doesnt record anything, useful for writing new tests (default)
 
  record: record, //use recorded nocks, record new nocks
 
  lockdown: lockdown, //use recorded nocks, disables all http calls even when not nocked, doesnt record
 
};
 
 
 
 
 
Back.setMode = function(mode) {
  Iif( !Modes.hasOwnProperty(mode) ) {
    throw new Error ('some usage error');
  }
 
  Back.currentMode = mode;
  debug('New nock back mode:', Back.currentMode);
 
  _mode = Modes[mode];
  _mode.setup();
};
 
 
 
 
Back.fixtures = null;
Back.currentMode = null;
Back.setMode(process.env.NOCK_BACK_MODE || 'dryrun');
 
module.exports = exports = Back;