add pretest task:

etpinard · etpinard · commit 15616b004ba0 · 2016-06-08T10:53:26.000-04:00
- puts environment varialbe MAPBOX_ACCESS_TOKEN into
  test ready json file and Plotly.setPlotConfig wrapper.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,10 +14,10 @@ Implementation questions should be asked on
 community.plot.ly (tagged [`plotly-js`](http://community.plot.ly/c/plotly-js)) or on Stack Overflow (tagged
 [`plotly`](https://stackoverflow.com/questions/tagged/plotly)).
 
-Comments on GitHub issues or pull requests should add content to the discussions. 
-Approbation comments such as *+1* or *I would like this feature to be implemented as well* 
-will be deleted by the maintainers. Please use 
-[GitHub reactions](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) 
+Comments on GitHub issues or pull requests should add content to the discussions.
+Approbation comments such as *+1* or *I would like this feature to be implemented as well*
+will be deleted by the maintainers. Please use
+[GitHub reactions](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments)
 instead.
 
 ## Making pull requests
@@ -28,11 +28,11 @@ pull request is deemed satisfactory, the developer will be asked to make a pull
 request to the main plotly.js repo and may be asked to squash some commits
 before doing so.
 
-Developers should `git rebase` their local branch off the latest `master` before 
+Developers should `git rebase` their local branch off the latest `master` before
 opening a pull request.
 
 Note that it is forbidden to force push (i.e. `git push -f`) to remote branches
-associated with opened pull requests. Force pushes make it hard for maintainers 
+associated with opened pull requests. Force pushes make it hard for maintainers
 to keep track of updates. Therefore, if required, please
 `git merge master` into your PR branch instead of `git rebase master`.
 
@@ -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
 
diff --git a/circle.yml b/circle.yml
@@ -15,6 +15,7 @@ dependencies:
     - docker pull plotly/testbed:latest
   post:
     - npm run cibuild
+    - npm run pretest
     - docker run -d --name mytestbed -v $PWD:/var/www/streambed/image_server/plotly.js -p 9010:9010 plotly/testbed:latest
     - sudo lxc-attach -n "$(docker inspect --format '{{.Id}}' mytestbed)" -- bash -c "cp -f /var/www/streambed/image_server/plotly.js/test/image/index.html /var/www/streambed/image_server/server_app/index.html"
     - wget --server-response --spider --tries=8 --retry-connrefused http://localhost:9010/ping
diff --git a/package.json b/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",
diff --git a/tasks/pretest.js b/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: process.env.MAPBOX_ACCESS_TOKEN
+}, 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: \'' + process.env.MAPBOX_ACCESS_TOKEN + '\'',
+    '});',
+    ''
+].join('\n');
+
+fs.writeFile(constants.pathToSetPlotConfig, setPlotConfig, function(err) {
+    if(err) throw err;
+});
diff --git a/tasks/util/constants.js b/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,
