Merge pull request #1037 from plotly/gl2d-tests

gl2d image tests (finally)

Author: etpinard

circle.yml

@@ -21,6 +21,7 @@ dependencies:
 test:
   override:
     - npm run test-image
+    - npm run test-image-gl2d
     - npm run test-export
     - npm run citest-jasmine
     - npm run test-bundle

package.json

@@ -35,6 +35,7 @@
     "test-jasmine": "karma start test/jasmine/karma.conf.js",
     "citest-jasmine": "karma start test/jasmine/karma.ciconf.js",
     "test-image": "node tasks/test_image.js",
+    "test-image-gl2d": "node tasks/test_image.js gl2d_* --queue",
     "test-export": "node tasks/test_export.js",
     "test-syntax": "node tasks/test_syntax.js",
     "test-bundle": "node tasks/test_bundle.js",

test/image/baselines/gl2d_10.png

@@ -51,15 +51,33 @@ var QUEUE_WAIT = 10;
 var pattern = process.argv[2];
 var mockList = getMockList(pattern);
 var isInQueue = (process.argv[3] === '--queue');
+var isCI = process.env.CIRCLECI;
 
 if(mockList.length === 0) {
     throw new Error('No mocks found with pattern ' + pattern);
 }
 
 // filter out untestable mocks if no pattern is specified
 if(!pattern) {
-    console.log('Filtering out untestable mocks\n');
+    console.log('Filtering out untestable mocks:');
     mockList = mockList.filter(untestableFilter);
+    console.log('\n');
+}
+
+// gl2d have limited image-test support
+if(pattern === 'gl2d_*') {
+
+    if(!isInQueue) {
+        console.log('WARN: Running gl2d image tests in batch may lead to unwanted results\n');
+    }
+
+    if(isCI) {
+        console.log('Filtering out multiple-subplot gl2d mocks:');
+        mockList = mockList
+            .filter(untestableGL2DonCIfilter)
+            .sort(sortForGL2DonCI);
+        console.log('\n');
+    }
 }
 
 // main
@@ -81,18 +99,64 @@ else {
  *
  */
 function untestableFilter(mockName) {
-    return !(
+    var cond = !(
         mockName === 'font-wishlist' ||
         mockName.indexOf('gl2d_') !== -1 ||
         mockName.indexOf('mapbox_') !== -1
     );
+
+    if(!cond) console.log(' -', mockName);
+
+    return cond;
+}
+
+/* gl2d mocks that have multiple subplots
+ * can't be generated properly on CircleCI
+ * at the moment.
+ *
+ * For more info see:
+ * https://github.com/plotly/plotly.js/pull/980
+ *
+ */
+function untestableGL2DonCIfilter(mockName) {
+    var cond = [
+        'gl2d_multiple_subplots',
+        'gl2d_simple_inset',
+        'gl2d_stacked_coupled_subplots',
+        'gl2d_stacked_subplots'
+    ].indexOf(mockName) === -1;
+
+    if(!cond) console.log(' -', mockName);
+
+    return cond;
+}
+
+/* gl2d pointcloud mock(s) must be tested first
+ * on CircleCI in order to work; sort them here.
+ *
+ * Pointcloud relies on gl-shader@4.2.1 whereas
+ * other gl2d trace modules rely on gl-shader@4.2.0,
+ * we suspect that the lone gl context on CircleCI is
+ * having issues with dealing with the two different
+ * gl-shader versions.
+ *
+ * More info here:
+ * https://github.com/plotly/plotly.js/pull/1037
+ */
+function sortForGL2DonCI(a, b) {
+    var root = 'gl2d_pointcloud',
+        ai = a.indexOf(root),
+        bi = b.indexOf(root);
+
+    if(ai < bi) return 1;
+    if(ai > bi) return -1;
+
+    return 0;
 }
 
 function runInBatch(mockList) {
     var running = 0;
 
-    // remove mapbox mocks if circle ci
-
     test('testing mocks in batch', function(t) {
         t.plan(mockList.length);
 

test/image/baselines/gl2d_12.png

@@ -18,7 +18,9 @@ var test = require('tape');
 var FORMATS = ['svg', 'pdf', 'eps'];
 
 // non-exhaustive list of mocks to test
-var DEFAULT_LIST = ['0', 'geo_first', 'gl3d_z-range', 'text_export', 'layout_image'];
+var DEFAULT_LIST = [
+    '0', 'geo_first', 'gl3d_z-range', 'text_export', 'layout_image', 'gl2d_12'
+];
 
 // return dimensions [in px]
 var WIDTH = 700;