add 'pretest' tasks,

- that setups build files containing mapbox crendentials
  so that test runners can load them seamlessly.

Author: etpinard

CONTRIBUTING.md

@@ -157,6 +157,18 @@ which shows the baseline image, the generated image, the diff and the json mocks
 
 To view the results of a run on CircleCI, download the `build/test_images/` and `build/test_images_diff/` artifacts into your local repo and then run `npm run start-image_viewer`.
 
+### Note on testing our `mapbox-gl` integration
+
+Creating `mapbox-gl` graphs requires an
+[`accessToken`](https://www.mapbox.com/help/define-access-token/). To make sure
+that mapbox image and jasmine tests run properly, locate your Mapbox access
+token and run:
+
+
+```bash
+export MAPBOX_ACCESS_TOKEN="<your access token>" && npm run pretest
+```
+
 
 ## Repo organization
 

package.json

@@ -29,6 +29,7 @@
     "watch": "node tasks/watch_plotly.js",
     "lint": "eslint . || true",
     "lint-fix": "eslint . --fix",
+    "pretest": "node tasks/pretest.js",
     "test-jasmine": "karma start test/jasmine/karma.conf.js",
     "citest-jasmine": "karma start test/jasmine/karma.ciconf.js",
     "test-image": "./tasks/test_image.sh",

tasks/pretest.js

@@ -0,0 +1,38 @@
+var fs = require('fs');
+var constants = require('./util/constants');
+var mapboxAccessToken = process.env.MAPBOX_ACCESS_TOKEN;
+
+
+if(!mapboxAccessToken) {
+    throw new Error([
+        'MAPBOX_ACCESS_TOKEN not found!!!',
+        'Please export your mapbox access token into and try again.'
+    ].join('\n'));
+}
+
+// Create a credentials json file,
+// to be required in jasmine test suites and test dashboard
+var credentials = JSON.stringify({
+    MAPBOX_ACCESS_TOKEN: mapboxAccessToken
+}, null, 2);
+
+fs.writeFile(constants.pathToCredentials, credentials, function(err) {
+    if(err) throw err;
+});
+
+// Create a 'set plot config' file,
+// to be included in the image test index
+var setPlotConfig = [
+    '\'use strict\';',
+    '',
+    '/* global Plotly:false */',
+    '',
+    'Plotly.setPlotConfig({',
+    '    mapboxAccessToken: \'' + mapboxAccessToken + '\'',
+    '});',
+    ''
+].join('\n');
+
+fs.writeFile(constants.pathToSetPlotConfig, setPlotConfig, function(err) {
+    if(err) throw err;
+});

tasks/util/constants.js

@@ -51,6 +51,9 @@ module.exports = {
     pathToJasmineTests: path.join(pathToRoot, 'test/jasmine/tests'),
     pathToJasmineBundleTests: path.join(pathToRoot, 'test/jasmine/bundle_tests'),
 
+    pathToCredentials: path.join(pathToBuild, 'credentials.json'),
+    pathToSetPlotConfig: path.join(pathToBuild, 'set_plot_config.js'),
+
     uglifyOptions: {
         fromString: true,
         mangle: true,

tasks/util/shortcut_paths.js

@@ -11,7 +11,8 @@ var constants = require('./constants');
 var shortcutsConfig = {
     '@src': constants.pathToSrc,
     '@lib': constants.pathToLib,
-    '@mocks': constants.pathToTestImageMocks
+    '@mocks': constants.pathToTestImageMocks,
+    '@build': constants.pathToBuild
 };
 
 module.exports = transformTools.makeRequireTransform('requireTransform',