Skip to content
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

Jump to bottom

Message in the error logs when xsltproc is not found #7301

Merged
merged 11 commits into from
Sep 22, 2021
Merged

Message in the error logs when xsltproc is not found #7301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ba0bad9
Add clear message in the error logs when xsltproc is not found
mrsarm Sep 8, 2021
b1c6692
Change message of xsltproc error
mrsarm Sep 9, 2021
b484add
Update unknown error message
mrsarm Sep 9, 2021
912c220
Refactor runTest method
mrsarm Sep 9, 2021
96238e7
Refactor...
mrsarm Sep 16, 2021
7df149d
Rollback object comprehension syntax used
mrsarm Sep 16, 2021
925477e
Typos
mrsarm Sep 16, 2021
cd3fa13
Fix typos
mrsarm Sep 16, 2021
f5e72d2
Different ways to check errors on xsltproc regarding the OS
mrsarm Sep 21, 2021
0dc8ab5
Style change just to re-run flaky test again
mrsarm Sep 21, 2021
3be87ad
Typo change just to re-run flaky test again
mrsarm Sep 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 24 additions & 3 deletions api/src/services/generate-xform.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,38 @@ const MEDIA_SRC_ATTR = ' data-media-src="';

const FORM_STYLESHEET = path.join(__dirname, '../xsl/openrosa2html5form.xsl');
const MODEL_STYLESHEET = path.join(__dirname, '../../node_modules/enketo-xslt/xsl/openrosa2xmlmodel.xsl');
const XSLTPROC_CMD = 'xsltproc';

const stdinErrorHandler = function (xsltproc, err, reject) {
xsltproc.stdin.end();
if (err.code === 'EPIPE') {
const errMsg = `Unable to continue execution, check that '${XSLTPROC_CMD}' command is available.`;
logger.error(errMsg);
return reject(new Error(errMsg));
}
logger.error(err);
return reject(new Error(`Unknown Error: An error occurred when executing '${XSLTPROC_CMD}' command`));
};

const transform = (formXml, stylesheet) => {
return new Promise((resolve, reject) => {
const xsltproc = childProcess.spawn('xsltproc', [ stylesheet, '-' ]);
const xsltproc = childProcess.spawn(XSLTPROC_CMD, [ stylesheet, '-' ]);
let stdout = '';
let stderr = '';
xsltproc.stdout.on('data', data => stdout += data);
xsltproc.stderr.on('data', data => stderr += data);
xsltproc.stdin.setEncoding('utf-8');
xsltproc.stdin.write(formXml);
xsltproc.stdin.end();
xsltproc.stdin.on('error', err => {
// Errors related with spawned processes and stdin are handled here on OSX
return stdinErrorHandler(xsltproc, err, reject);
});
try {
xsltproc.stdin.write(formXml);
xsltproc.stdin.end();
} catch (err) {
// Errors related with spawned processes and stdin are handled here on *nix
return stdinErrorHandler(xsltproc, err, reject);
}
xsltproc.on('close', (code, signal) => {
if (code !== 0 || signal || stderr.length) {
let errorMsg = `Error transforming xml. xsltproc returned code "${code}", and signal "${signal}"`;
Expand Down
156 changes: 117 additions & 39 deletions api/tests/mocha/services/generate-xform.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const { promisify } = require('util');
const readFile = promisify(require('fs').readFile);
const { join } = require('path');
const { expect } = require('chai');
const { assert, expect } = require('chai');
const sinon = require('sinon');
const childProcess = require('child_process');
const db = require('../../../src/db');
Expand Down Expand Up @@ -30,6 +30,25 @@ describe('generate-xform service', () => {

describe('generate', () => {

let spawned;

beforeEach(() => {
// The base for a successful spawned process
spawned = {
stdout: { on: sinon.stub() },
stderr: { on: sinon.stub() },
stdin: {
setEncoding: sinon.stub(),
write: sinon.stub(),
end: sinon.stub(),
on: sinon.stub(),
},
on: sinon.stub()
};
});

afterEach(sinon.restore);

const read = (dirname, filename) => {
return readFile(join(__dirname, 'xforms', dirname, filename), 'utf8');
};
Expand All @@ -45,24 +64,17 @@ describe('generate-xform service', () => {
});
};

const runTest = (dirname, err) => {
const spawned = {
stdout: { on: sinon.stub() },
stderr: { on: sinon.stub() },
stdin: {
setEncoding: sinon.stub(),
write: sinon.stub(),
end: sinon.stub()
},
on: sinon.stub()
};
const runTest = (dirname, spawned, stdErr, errIn, successClose = true) => {
sinon.stub(childProcess, 'spawn').returns(spawned);
return setup(dirname).then(files => {
const generate = service.generate(files.xform);
if (err) {
spawned.stderr.on.args[0][1](err);
if (stdErr) {
spawned.stderr.on.args[0][1](stdErr);
spawned.on.args[0][1](100);
} else if (errIn) {
spawned.stdin.on.args[0][1](errIn);
spawned.on.args[0][1](100);
} else {
} else if (successClose) {
latin-panda marked this conversation as resolved.
Show resolved Hide resolved
// child process outputs then closes with code 0
spawned.stdout.on.args[0][1](files.givenForm);
spawned.on.args[0][1](0);
Expand All @@ -76,28 +88,94 @@ describe('generate-xform service', () => {
});
};

it('generates form and model', () => runTest('simple'));
it('should generate form and model', () => runTest('simple', spawned));

it('replaces multimedia src elements', () => runTest('multimedia'));
it('should replace multimedia src elements', () => runTest('multimedia', spawned));

it('correctly replaces models with nested "</root>" - #5971', () => runTest('nested-root'));
it('should correctly replaces models with nested "</root>" - #5971', () => runTest('nested-root', spawned));

it('errors if child process errors', done => {
runTest('simple', 'some error')
.then(() => done(new Error('expected error to be thrown')))
.catch(err => {
expect(err.message).to.equal(
'Error transforming xml. xsltproc returned code "100", and signal "undefined". ' +
'xsltproc stderr output:\nsome error'
);
done();
});
it('should fail when child process errors', async () => {
try {
await runTest('simple', spawned, 'some error');
assert.fail('expected error to be thrown');
latin-panda marked this conversation as resolved.
Show resolved Hide resolved
} catch (err) {
expect(err.message).to.equal(
'Error transforming xml. xsltproc returned code "100", and signal "undefined". ' +
'xsltproc stderr output:\nsome error'
);
}
});

it('should fail when xsltproc command not found', async () => {
try {
const writeErr = new Error('Error: write EPIPE');
writeErr.code = 'EPIPE';
const spawnedEpipe = {
latin-panda marked this conversation as resolved.
Show resolved Hide resolved
stdout: { on: sinon.stub() },
stderr: { on: sinon.stub() },
stdin: {
setEncoding: sinon.stub(),
write: sinon.stub().throws(writeErr),
end: sinon.stub(),
on: sinon.stub(),
},
on: sinon.stub()
};
await runTest('simple', spawnedEpipe, null, null, false);
assert.fail('expected error to be thrown');
} catch (err) {
expect(err.message).to.equal(
'Unable to continue execution, check that \'xsltproc\' command is available.');
}
});

it('should fail when xsltproc command not found also in OSX', async () => {
try {
const writeErr = new Error('Error: unknown');
const spawnedEpipe = {
stdout: { on: sinon.stub() },
stderr: { on: sinon.stub() },
stdin: {
setEncoding: sinon.stub(),
write: sinon.stub(),
end: sinon.stub(),
on: sinon.stub()
},
on: sinon.stub()
};
await runTest('simple', spawnedEpipe, null, writeErr, null, false);
assert.fail('expected error to be thrown');
} catch (err) {
expect(err.message).to.equal(
'Unknown Error: An error occurred when executing \'xsltproc\' command');
}
});

it('should fail when xsltproc raises unknown exception', async () => {
try {
latin-panda marked this conversation as resolved.
Show resolved Hide resolved
const spawnedUnknownWriteErr = {
stdout: { on: sinon.stub() },
stderr: { on: sinon.stub() },
stdin: {
setEncoding: sinon.stub(),
write: sinon.stub().throws('mystery error'),
end: sinon.stub(),
on: sinon.stub(),
},
on: sinon.stub()
};
await runTest('simple', spawnedUnknownWriteErr, null, null, false);
assert.fail('expected error to be thrown');
} catch (err) {
expect(err.message).to.equal(
'Unknown Error: An error occurred when executing \'xsltproc\' command');
}
});
});

describe('update', () => {

it('errors if no form found', done => {
it('should fail when no form found', done => {
sinon.stub(db.medic, 'get').rejects('boom');
service.update('form:missing')
.then(() => done(new Error('expected error to be thrown')))
Expand All @@ -109,7 +187,7 @@ describe('generate-xform service', () => {
});
});

it('does nothing if doc does not have form attachment', () => {
it('should do nothing when doc does not have form attachment', () => {
sinon.stub(db.medic, 'get').resolves({ _attachments: { image: {} } });
sinon.stub(db.medic, 'put');
return service.update('form:exists').then(() => {
Expand All @@ -118,7 +196,7 @@ describe('generate-xform service', () => {
});
});

it('does nothing if the attachments are up to date', () => {
it('should do nothing when the attachments are up to date', () => {
const formXml = '<my-xml/>';
const currentForm = '<html/>';
const currentModel = '<xml/>';
Expand All @@ -136,7 +214,7 @@ describe('generate-xform service', () => {
});
});

it('updates doc if attachments do not exist', () => {
it('should update doc when attachments do not exist', () => {
const formXml = '<my-xml/>';
const newForm = '<html><title>Hello</title></html>';
const newModel = '<instance><multimedia/></instance>';
Expand All @@ -151,7 +229,7 @@ describe('generate-xform service', () => {
});
});

it('updates doc if attachments have changed', () => {
it('should update doc when attachments have changed', () => {
const formXml = '<my-xml/>';
const currentForm = '<html/>';
const newForm = '<html><title>Hello</title></html>';
Expand Down Expand Up @@ -188,7 +266,7 @@ describe('generate-xform service', () => {
}
};

it('handles no forms', () => {
it('should handle no forms', () => {
sinon.stub(db.medic, 'query').resolves({ rows: [] });
sinon.stub(db.medic, 'bulkDocs');
return service.updateAll().then(() => {
Expand All @@ -197,7 +275,7 @@ describe('generate-xform service', () => {
});
});

it('ignores json forms', () => {
it('should ignore json forms', () => {
sinon.stub(db.medic, 'query').resolves({ rows: [ JSON_FORM_ROW ] });
sinon.stub(db.medic, 'bulkDocs');
return service.updateAll().then(() => {
Expand All @@ -206,7 +284,7 @@ describe('generate-xform service', () => {
});
});

it('ignores collect forms', () => {
it('should ignore collect forms', () => {
sinon.stub(db.medic, 'query').resolves({ rows: [ COLLECT_FORM_ROW ] });
sinon.stub(db.medic, 'bulkDocs');
return service.updateAll().then(() => {
Expand All @@ -215,7 +293,7 @@ describe('generate-xform service', () => {
});
});

it('does nothing if no forms have changed', () => {
it('should do nothing when no forms have changed', () => {
const formXml = '<my-xml/>';
const currentForm = '<html/>';
const currentModel = '<xml/>';
Expand All @@ -234,7 +312,7 @@ describe('generate-xform service', () => {
});
});

it('throws if not all updated successfully', done => {
it('should throw when not all updated successfully', done => {
const formXml = '<my-xml/>';
const currentForm = '<html/>';
const newForm = '<html><title>Hello</title></html>';
Expand Down Expand Up @@ -262,7 +340,7 @@ describe('generate-xform service', () => {
});
});

it('saves all updated forms', () => {
it('should save all updated forms', () => {
const formXml = '<my-xml/>';
const currentForm = '<html/>';
const newForm = '<html><title>Hello</title></html>';
Expand Down