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

test cli steps parsing #1833

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

test cli steps parsing #1833

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f6949c9
make utility to read stdout and stderr
daemon1024 Mar 7, 2021
73b4937
test cli steps parsing
daemon1024 Mar 7, 2021
a8ae036
Merge branch 'main' into daemon1024/cli-test-suite-1747
jywarren Mar 12, 2021
f5a6cea
modify read log util and make a single test pass by adding blocking code
daemon1024 Mar 12, 2021
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
28 changes: 28 additions & 0 deletions test/cli/steps.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
const test = require('tape');
const cli = require('../../src/cli');
const stdout = require('./util/readConsole').stdout;
const stderr = require('./util/readConsole').stderr;
Copy link
Member

Choose a reason for hiding this comment

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

This all looks ok, compared to

image-sequencer/test/cli/saveSequence.js

Lines 1 to 2 in 3b8181a

const test = require('tape');
const cli = require('../../src/cli');


test('testing steps parsing', async function (t) {
Copy link
Member

Choose a reason for hiding this comment

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

Is it worth running it without async first to just see if the issue is related just to that?

Copy link
Member

Choose a reason for hiding this comment

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

and we're sure tape does async? I believe tape is pretty minimal so it may be worth looking in the tape docs.

Also, i notice the package.json config pipes the output to tape-spec, do we need to do that? Just wondering if you've tried that. Trying to get as close to the existing version as we can to diagnose the issues.

Copy link
Member

Choose a reason for hiding this comment

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

image-sequencer/package.json

Line 15 in 3b8181a

"test-cli": "node test/cli/*.js | tap-spec",

Copy link
Member Author

Choose a reason for hiding this comment

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

Is it worth running it without async first to just see if the issue is related just to that?

and we're sure tape does async?

Tape works in async though it still fails, apparently cli function doesn't return a promise so there's no point of async/await anyway.

i notice the package.json config pipes the output to tape-spec, do we need to do that?

It's just a prettified/formatted output of the tape report, it shouldn't interfere with the output. But I tried it out without it and I am still facing same issues :(


t.plan(2);

let out = stdout.read();
await cli([
'node', 'test',
'-i', 'examples/images/test.png',
'-s', 'invert',
]);
out.restore();
t.false(out.output.includes('Added Step "invert"'), 'Steps parsed successfully');


let err = stderr.read();
await cli([
'node', 'test',
'-i', 'examples/images/test.png',
'-s', 'invalidStep',
]);
err.restore();
t.equal(err.output, 'Please ensure all steps are valid.');
});
24 changes: 24 additions & 0 deletions test/cli/util/readConsole.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
function ReadLog(stream) {
this._stream = stream;
}

ReadLog.prototype.read = function(options) {

let output = [];
let stream = this._stream;

let originalStreamWrite = stream.write;
stream.write = function(string) {
output.push(string);
};

return {
output: output,
restore: function() {
stream.write = originalStreamWrite;
}
};
};

exports.stdout = new ReadLog(process.stdout);
exports.stderr = new ReadLog(process.stderr);