Skip to content

Test SVG image size in test-export #944

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 21, 2016
Merged

Test SVG image size in test-export #944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ad7d882
tasks: handle image server request width & height specs
etpinard Sep 15, 2016
8828380
tasks: update comment in export test
etpinard Sep 15, 2016
1e61ed6
tasks: use image-size to check svg file size in export test
etpinard Sep 15, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@
"fuse.js": "^2.2.0",
"glob": "^7.0.0",
"gzip-size": "^3.0.0",
"image-size": "^0.5.0",
"jasmine-core": "^2.4.1",
"karma": "^1.1.0",
"karma-browserify": "^5.0.1",
Expand Down
3 changes: 3 additions & 0 deletions test/image/assets/get_image_request_options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ module.exports = function getRequestOpts(specs) {
scale: specs.scale || DEFAULT_SCALE
};

if(specs.width) body.width = specs.width;
if(specs.height) body.height = specs.height;

return {
method: 'POST',
url: constants.testContainerUrl,
Expand Down
36 changes: 29 additions & 7 deletions test/image/export_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
var fs = require('fs');
var sizeOf = require('image-size');

var getMockList = require('./assets/get_mock_list');
var getRequestOpts = require('./assets/get_image_request_options');
Expand All @@ -9,14 +10,21 @@ var request = require('request');
var test = require('tape');

// image formats to test
//
// N.B. 'png' is tested in `npm run test-image, no need to duplicate here
// TODO figure why 'jpeg' and 'webp' lead to errors
//
// N.B. 'jpeg' and 'webp' lead to errors because of the image server code
// is looking for Plotly.Color which isn't exposed anymore
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'];

// minimum satisfactory file size
// return dimensions [in px]
var WIDTH = 700;
var HEIGHT = 500;

// minimum satisfactory file size [in bytes]
var MIN_SIZE = 100;

/**
Expand Down Expand Up @@ -69,18 +77,32 @@ function runInBatch(mockList) {
// The tests below determine whether the images are properly
// exported by (only) checking the file size of the generated images.
function testExport(mockName, format, t) {
var requestOpts = getRequestOpts({ mockName: mockName, format: format }),
var specs = {
mockName: mockName,
format: format,
width: WIDTH,
height: HEIGHT
};

var requestOpts = getRequestOpts(specs),
imagePaths = getImagePaths(mockName, format),
saveImageStream = fs.createWriteStream(imagePaths.test);

function checkExport(err) {
if(err) throw err;

fs.stat(imagePaths.test, function(err, stats) {
var didExport = stats.size > MIN_SIZE;
var didExport;

t.ok(didExport, mockName + ' should be properly exported as a ' + format);
});
if(format === 'svg') {
var dims = sizeOf(imagePaths.test);
didExport = (dims.width === WIDTH) && (dims.height === HEIGHT);
}
else {
var stats = fs.statSync(imagePaths.test);
didExport = stats.size > MIN_SIZE;
}

t.ok(didExport, mockName + ' should be properly exported as a ' + format);
}

request(requestOpts)
Expand Down