Use sinon's sandbox API

Create a sandbox in a global `beforeEach` callback, and restore it in a global `afterEach` callback. Inject the methods into the tap `Test` object so that they are accessible via `t.spy`, `t.stub`, etc., and use those exclusively.

This ensures that a stubbed or spied global method (e.g. `util.warnOnce`) does not linger beyond a single test case.

test/README.md

@@ -16,3 +16,9 @@ There are two test suites associated with Mapbox GL JS
  - **You should only test the return values and global side effects of methods.** You should not not test internal behavior, such as that another method is called with particular arguments. This ensures that method implementations may change without causing test failures.
  - **You must not make network requests in test cases.** This rule holds in cases when result isn't used or is expected to fail. You may use `window.useFakeXMLHttpRequest` and `window.server` per the [Sinon API](http://sinonjs.org/docs/#server) to simulate network requests. This ensures that tests are reliable, able to be run in an isolated environment, and performant.
  - **You should use clear [input space partitioning](http://crystal.uta.edu/~ylei/cse4321/data/isp.pdf) schemes.** Look for edge cases! This ensures that tests suites are comprehensive and easy to understand.
+
+## Spies, Stubs, and Mocks
+
+The test object is augmented with methods from Sinon.js for [spies](http://sinonjs.org/docs/#spies), [stubs](http://sinonjs.org/docs/#stubs), and [mocks](http://sinonjs.org/docs/#mocks). For example, to use Sinon's spy API, call `t.spy(...)` within a test.
+
+The test framework is set up such that spies, stubs, and mocks on global objects are restored at the end of each test.

test/js/data/bucket.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var Bucket = require('../../../js/data/bucket');
 var util = require('../../../js/util/util');
 var StyleLayer = require('../../../js/style/style_layer');

test/js/data/buffer.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var Buffer = require('../../../js/data/buffer');
 var StructArrayType = require('../../../js/util/struct_array');
 

test/js/data/fill_bucket.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var fs = require('fs');
 var Protobuf = require('pbf');
 var VectorTile = require('vector-tile').VectorTile;

test/js/data/line_bucket.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var fs = require('fs');
 var path = require('path');
 var Protobuf = require('pbf');

test/js/data/load_geometry.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var fs = require('fs');
 var path = require('path');
 var Protobuf = require('pbf');

test/js/data/symbol_bucket.test.js

@@ -1,7 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
-var sinon = require('sinon');
+var test = require('mapbox-gl-js-test').test;
 var fs = require('fs');
 var path = require('path');
 var Protobuf = require('pbf');
@@ -81,7 +80,7 @@ test('SymbolBucket', function(t) {
 test('SymbolBucket integer overflow', function(t) {
     var bucket = bucketSetup();
     var numWarnings = 0;
-    sinon.stub(util, 'warnOnce', function(warning) {
+    t.stub(util, 'warnOnce', function(warning) {
         if (warning.includes('Too many symbols being rendered in a tile.') || warning.includes('Too many glyphs being rendered in a tile.')) numWarnings++;
     });
     // save correct value of MAX_QUADS

test/js/geo/coordinate.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var Coordinate = require('../../../js/geo/coordinate');
 
 test('Coordinate', function(t) {

test/js/geo/lng_lat.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var LngLat = require('../../../js/geo/lng_lat');
 
 test('LngLat', function(t) {

test/js/geo/lng_lat_bounds.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var LngLat = require('../../../js/geo/lng_lat');
 var LngLatBounds = require('../../../js/geo/lng_lat_bounds');
 

test/js/geo/transform.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var Point = require('point-geometry');
 var Transform = require('../../../js/geo/transform');
 var TileCoord = require('../../../js/source/tile_coord');

test/js/mapbox-gl.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var proxyquire = require('proxyquire');
 var mapboxgl = require('../../js/mapbox-gl');
 

test/js/source/geojson_source.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var Tile = require('../../../js/source/tile');
 var TileCoord = require('../../../js/source/tile_coord');
 var GeoJSONSource = require('../../../js/source/geojson_source');

test/js/source/geojson_wrapper.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var Wrapper = require('../../../js/source/geojson_wrapper');
 
 test('geojsonwrapper', function(t) {

test/js/source/query_features.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var QueryFeatures = require('../../../js/source/query_features.js');
 var SourceCache = require('../../../js/source/source_cache.js');
 

test/js/source/source_cache.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var SourceCache = require('../../../js/source/source_cache');
 var Source = require('../../../js/source/source');
 var TileCoord = require('../../../js/source/tile_coord');

test/js/source/tile.test.js

@@ -1,13 +1,12 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var Tile = require('../../../js/source/tile');
 var GeoJSONWrapper = require('../../../js/source/geojson_wrapper');
 var TileCoord = require('../../../js/source/tile_coord');
 var fs = require('fs');
 var path = require('path');
 var vtpbf = require('vt-pbf');
-var sinon = require('sinon');
 var FeatureIndex = require('../../../js/data/feature_index');
 var CollisionTile = require('../../../js/symbol/collision_tile');
 var CollisionBoxArray = require('../../../js/symbol/collision_box');
@@ -82,7 +81,7 @@ test('querySourceFeatures', function(t) {
     t.test('loadVectorData unloads existing data before overwriting it', function(t) {
         var tile = new Tile(new TileCoord(1, 1, 1));
         tile.state = 'loaded';
-        sinon.stub(tile, 'unloadVectorData');
+        t.stub(tile, 'unloadVectorData');
         var painter = {};
 
         tile.loadVectorData(null, painter);

test/js/source/tile_coord.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var TileCoord = require('../../../js/source/tile_coord');
 
 test('TileCoord', function(t) {

test/js/source/vector_tile_source.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var VectorTileSource = require('../../../js/source/vector_tile_source');
 var TileCoord = require('../../../js/source/tile_coord');
 var window = require('../../../js/util/window');

test/js/source/vector_tile_worker_source.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var VectorTileWorkerSource = require('../../../js/source/vector_tile_worker_source');
 
 var styleLayers = {

test/js/source/worker.test.js

@@ -2,7 +2,7 @@
 
 /* jshint -W079 */
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var Worker = require('../../../js/source/worker');
 var window = require('../../../js/util/window');
 

test/js/source/worker_tile.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var WorkerTile = require('../../../js/source/worker_tile');
 var Wrapper = require('../../../js/source/geojson_wrapper');
 var TileCoord = require('../../../js/source/tile_coord');

test/js/style/animation_loop.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var AnimationLoop = require('../../../js/style/animation_loop');
 
 test('animationloop', function(t) {

test/js/style/light.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var Light = require('../../../js/style/light');
 var spec = require('../../../js/style/style_spec').$root.light;
 

test/js/style/style.test.js

@@ -1,7 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
-var sinon = require('sinon');
+var test = require('mapbox-gl-js-test').test;
 var proxyquire = require('proxyquire');
 var Style = require('../../../js/style/style');
 var SourceCache = require('../../../js/source/source_cache');
@@ -186,7 +185,7 @@ test('Style#_remove', function(t) {
 
         style.on('style.load', function () {
             var sourceCache = style.sourceCaches['source-id'];
-            sinon.spy(sourceCache, 'clearTiles');
+            t.spy(sourceCache, 'clearTiles');
             style._remove();
             t.ok(sourceCache.clearTiles.calledOnce);
             t.end();
@@ -461,7 +460,7 @@ test('Style#removeSource', function(t) {
 
         style.on('style.load', function () {
             var sourceCache = style.sourceCaches['source-id'];
-            sinon.spy(sourceCache, 'clearTiles');
+            t.spy(sourceCache, 'clearTiles');
             style.removeSource('source-id');
             t.ok(sourceCache.clearTiles.calledOnce);
             t.end();
@@ -1137,7 +1136,7 @@ test('Style#queryRenderedFeatures', function(t) {
 
         t.test('fires an error if layer included in params does not exist on the style', function(t) {
             var errors = 0;
-            sinon.stub(style, 'fire', function(type, data) {
+            t.stub(style, 'fire', function(type, data) {
                 if (data.error && data.error.includes('does not exist in the map\'s style and cannot be queried for features.')) errors++;
             });
             style.queryRenderedFeatures([{column: 1, row: 1, zoom: 1}], {layers:['merp']});
@@ -1161,10 +1160,10 @@ test('Style defers expensive methods', function(t) {
         style.update();
 
         // spies to track defered methods
-        sinon.spy(style, 'fire');
-        sinon.spy(style, '_reloadSource');
-        sinon.spy(style, '_updateWorkerLayers');
-        sinon.spy(style, '_groupLayers');
+        t.spy(style, 'fire');
+        t.spy(style, '_reloadSource');
+        t.spy(style, '_updateWorkerLayers');
+        t.spy(style, '_groupLayers');
 
         style.addLayer({ id: 'first', type: 'symbol', source: 'streets' });
         style.addLayer({ id: 'second', type: 'symbol', source: 'streets' });
@@ -1219,7 +1218,7 @@ test('Style#query*Features', function(t) {
             }]
         });
 
-        onError = sinon.spy();
+        onError = t.spy();
 
         style.on('error', onError)
             .on('style.load', function() {

test/js/style/style_declaration.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var StyleDeclaration = require('../../../js/style/style_declaration');
 
 test('StyleDeclaration', function(t) {

test/js/style/style_layer.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var StyleLayer = require('../../../js/style/style_layer');
 var FillStyleLayer = require('../../../js/style/style_layer/fill_style_layer');
 var util = require('../../../js/util/util');

test/js/symbol/anchor.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var Anchor = require('../../../js/symbol/anchor');
 
 test('Anchor', function(t) {

test/js/symbol/check_max_angle.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var Point = require('point-geometry');
 var checkMaxAngle = require('../../../js/symbol/check_max_angle');
 var Anchor = require('../../../js/symbol/anchor');

test/js/symbol/collision_feature.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var CollisionFeature = require('../../../js/symbol/collision_feature');
 var Anchor = require('../../../js/symbol/anchor');
 var Point = require('point-geometry');

test/js/symbol/get_anchors.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var Point = require('point-geometry');
 var getAnchors = require('../../../js/symbol/get_anchors');
 

test/js/symbol/mergelines.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var mergeLines = require('../../../js/symbol/mergelines');
 var Point = require('point-geometry');
 

test/js/symbol/quads.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 
 var getIconQuads = require('../../../js/symbol/quads').getIconQuads;
 var Anchor = require('../../../js/symbol/anchor');

test/js/symbol/resolve_text.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var resolveText = require('../../../js/symbol/resolve_text');
 
 function mockFeature(obj) {

test/js/symbol/shaping.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var fs = require('fs');
 var path = require('path');
 var shaping = require('../../../js/symbol/shaping');

test/js/ui/camera.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var Camera = require('../../../js/ui/camera');
 var Evented = require('../../../js/util/evented');
 var Transform = require('../../../js/geo/transform');

test/js/ui/control/attribution.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var window = require('../../../../js/util/window');
 var Map = require('../../../../js/ui/map');
 var AttributionControl = require('../../../../js/ui/control/attribution_control');

test/js/ui/hash.test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var test = require('tap').test;
+var test = require('mapbox-gl-js-test').test;
 var Hash = require('../../../js/ui/hash');
 var window = require('../../../js/util/window');
 var Map = require('../../../js/ui/map');