Merge pull request #307 from plotly/test-non-pdf-exports

Test non-png exports

Author: etpinard

circle.yml

@@ -20,6 +20,7 @@ dependencies:
 test:
   override:
     - sudo lxc-attach -n "$(docker inspect --format '{{.Id}}' mytestbed)" -- bash -c "cd /var/www/streambed/image_server/plotly.js && node test/image/compare_pixels_test.js"
+    - sudo lxc-attach -n "$(docker inspect --format '{{.Id}}' mytestbed)" -- bash -c "cd /var/www/streambed/image_server/plotly.js && node test/image/export_test.js"
     - npm run citest-jasmine
     - npm run test-bundle
     - npm run test-syntax

package.json

@@ -31,6 +31,7 @@
     "test-jasmine": "karma start test/jasmine/karma.conf.js",
     "citest-jasmine": "karma start test/jasmine/karma.ciconf.js",
     "test-image": "./tasks/test_image.sh",
+    "test-export": "./tasks/test_export.sh",
     "test-syntax": "node test/syntax_test.js",
     "test-bundle": "node tasks/test_bundle.js",
     "test": "npm run citest-jasmine && npm run test-image && npm run test-syntax && npm run test-bundle",

tasks/test_export.sh

@@ -0,0 +1,20 @@
+#! /bin/bash
+#
+# TODO adapt this for Windows
+#
+# ===============================================================================
+
+CONTAINER_NAME="imagetest"  # same as in docker-compose.yml
+
+# create/run/start docker container with:
+#   $ docker-compose up -d
+
+CMD=(
+    "cd /var/www/streambed/image_server/plotly.js &&"
+    "cp -f test/image/index.html ../server_app/index.html &&"
+    "supervisorctl restart nw1 && "
+    "wget --server-response --spider --tries=8 --retry-connrefused http://localhost:9010/ping &&"
+    "node test/image/export_test.js $1"
+)
+
+docker exec -i $CONTAINER_NAME /bin/bash -c "${CMD[*]}"

test/image/export_test.js

@@ -0,0 +1,105 @@
+var fs = require('fs');
+var path = require('path');
+
+var request = require('request');
+var test = require('tape');
+
+var constants = require('../../tasks/util/constants');
+var getOptions = require('../../tasks/util/get_image_request_options');
+
+var userFileName = process.argv[2];
+
+/**
+ * Image formats to test
+ *
+ * N.B. 'png' is tested in `compare_pixels_test.js`
+ *
+ * TODO figure why 'jpeg' and 'webp' lead to errors
+ *
+ */
+var FORMATS = ['svg', 'pdf', 'eps'];
+
+/**
+ * The tests below determine whether the images are properly
+ * exported by (only) checking the file size of the generated images.
+ *
+ * MIN_SIZE is the minimum satisfactory file size.
+ */
+var MIN_SIZE = 100;
+
+
+// make artifact folder
+if(!fs.existsSync(constants.pathToTestImages)) {
+    fs.mkdirSync(constants.pathToTestImages);
+}
+
+if(!userFileName) runAll();
+else {
+
+    if(path.extname(userFileName) !== '.json') {
+        throw new Error('user-specified mock must end with \'.json\'');
+    }
+
+    runSingle(userFileName);
+}
+
+function runAll() {
+    test('testing export formats', function(t) {
+
+        // non-exhaustive list of mocks to test
+        var fileNames = [
+            '0.json',
+            'geo_first.json',
+            'gl3d_z-range.json'
+        ];
+
+        t.plan(fileNames.length * FORMATS.length);
+
+        fileNames.forEach(function(fileName) {
+            testExports(fileName, t);
+        });
+    });
+}
+
+function runSingle(userFileName) {
+    test('testing export for: ' + userFileName, function(t) {
+        t.plan(FORMATS.length);
+
+        testExports(userFileName, t);
+    });
+}
+
+function testExports(fileName, t) {
+    FORMATS.forEach(function(format) {
+        testExport(fileName, format, t);
+    });
+}
+
+function testExport(fileName, format, t) {
+    var figure = require(path.join(constants.pathToTestImageMocks, fileName));
+    var bodyMock = {
+        figure: figure,
+        format: format,
+        scale: 1
+    };
+
+    var imageFileName = fileName.split('.')[0] + '.' + format;
+    var savedImagePath = path.join(constants.pathToTestImages, imageFileName);
+    var savedImageStream = fs.createWriteStream(savedImagePath);
+
+    var options = getOptions(bodyMock, 'http://localhost:9010/');
+
+    function checkExport(err) {
+        if(err) throw err;
+
+        fs.stat(savedImagePath, function(err, stats) {
+            var didExport = stats.size > MIN_SIZE;
+
+            t.ok(didExport, imageFileName + ' should be properly exported');
+        });
+    }
+
+    request(options)
+        .pipe(savedImageStream)
+        .on('close', checkExport);
+}