Skip to content

Better image test logs #1569

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 4 commits into from
Apr 7, 2017
Merged

Better image test logs #1569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7a492cf
generalize docker-run cmd
etpinard Apr 3, 2017
3ebe797
robustify error handling in px comparison test
etpinard Apr 7, 2017
d58a7b5
add info about 'Allow edits from maintainers' option in PR template
etpinard Apr 7, 2017
b55e411
; :rage:
etpinard Apr 7, 2017
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
7 changes: 4 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ Developers are strongly encouraged to first make a PR to their own plotly.js for

Before opening a pull request, developer should:

- `git rebase` their local branch off the latest `master`
- make sure to **not** `git add` the `dist/` folder (the `dist/` is updated only on verion bumps)
- write an overview of what the PR attempts to do.
- `git rebase` their local branch off the latest `master`,
- make sure to **not** `git add` the `dist/` folder (the `dist/` is updated only on verion bumps),
- write an overview of what the PR attempts to do,
- select the _Allow edits from maintainers_ option (see this [article](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) for more details).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/


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 to keep track of updates. Therefore, if required, please `git merge master` into your PR branch instead of `git rebase master`.
2 changes: 1 addition & 1 deletion tasks/util/container_commands.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ containerCommands.dockerRun = [
'--name', constants.testContainerName,
'-v', constants.pathToRoot + ':' + constants.testContainerHome,
'-p', constants.testContainerPort + ':' + constants.testContainerPort,
'plotly/testbed:latest'
constants.testContainerImage
].join(' ');

containerCommands.getRunCmd = function(isCI, commands) {
Expand Down
20 changes: 16 additions & 4 deletions test/image/compare_pixels_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,10 @@ function comparePixels(mockName, cb) {
imagePaths = getImagePaths(mockName),
saveImageStream = fs.createWriteStream(imagePaths.test);

function log(msg) {
process.stdout.write('Error for', mockName + ':', msg);
}

function checkImage() {

// baseline image must be generated first
Expand Down Expand Up @@ -253,8 +257,8 @@ function comparePixels(mockName, cb) {
function onEqualityCheck(err, isEqual) {
if(err) {
common.touch(imagePaths.diff);
console.error(err);
return;
log(err);
return cb(false, mockName);
}
if(isEqual) {
fs.unlinkSync(imagePaths.diff);
Expand All @@ -266,12 +270,20 @@ function comparePixels(mockName, cb) {
// 525 means a plotly.js error
function onResponse(response) {
if(+response.statusCode === 525) {
console.error('plotly.js error while generating', mockName);
cb(false, mockName);
log('plotly.js error');
return cb(false, mockName);
}
}

// this catches connection errors
// e.g. when the image server blows up
function onError(err) {
log(err);
return cb(false, mockName);
}

request(requestOpts)
.on('error', onError)
.on('response', onResponse)
.pipe(saveImageStream)
.on('close', checkImage);
Expand Down