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

Basic support for Jest runner #335

Merged
merged 20 commits into from
Oct 17, 2017
Merged

Basic support for Jest runner #335

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
d5d93cc
Add basic jest runner support
Oct 11, 2017
ba08fba
Adjust Jest documentation
Oct 11, 2017
8bf5abd
Add missing --runInBand flag to jest command
Oct 11, 2017
bcb0174
Use process.env instead of process.argv (not supported in Jest)
Oct 13, 2017
9157bb0
Merge branch 'master' into feature/support-jest-runner
Kureev Oct 13, 2017
efe3b39
Adjust tests to the new env approach
Oct 13, 2017
c3c0077
Adjust indentation in package.json
Oct 13, 2017
92a1c49
Add process.env to child process
Kureev Oct 14, 2017
14d6965
Support runner option in detox config
Kureev Oct 15, 2017
256af2b
Update Guide.Jest to document a new way of changing runner
Kureev Oct 15, 2017
afcfc0e
Revert mocha.opts change (not a part of the scope)
Kureev Oct 15, 2017
8fde423
Revert formatting changes (not a part of the scope)
Kureev Oct 15, 2017
8c9dc3b
Use alternative flow to handle env variables
Oct 16, 2017
8092625
Support argv and priorotize them over env vars
Oct 16, 2017
dc45bc2
Cleanup detox-test.js
Kureev Oct 16, 2017
63b4519
Setup debug-synchronization value
Kureev Oct 16, 2017
35e0f65
Fix runner problem
Kureev Oct 17, 2017
3803b47
Reset example.xcodeproj
Kureev Oct 17, 2017
21690b8
Merge branch 'master' into feature/support-jest-runner
Kureev Oct 17, 2017
5fcfa4a
Remove constant override
Kureev Oct 17, 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
68 changes: 33 additions & 35 deletions detox/local-cli/detox-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,44 +27,42 @@ if (program.runner) {
runner = program.runner;
}

let command;
const {
configuration,
loglevel,
cleanup,
reuse,
debugSynchronization,
artifactsLocation
} = program;
function runMocha() {
const loglevel = program.loglevel ? `--loglevel ${program.loglevel}` : '';
const configuration = program.configuration ? `--configuration ${program.configuration}` : '';
const cleanup = program.cleanup ? `--cleanup` : '';
const reuse = program.reuse ? `--reuse` : '';
const artifactsLocation = program.artifactsLocation ? `--artifacts-location ${program.artifactsLocation}` : '';
const command = `node_modules/.bin/${program.runner} ${testFolder} --opts ${testFolder}/${program.runnerConfig} ${configuration} ${loglevel} ${cleanup} ${reuse} ${debugSynchronization} ${artifactsLocation}`;

console.log(command);
cp.execSync(command, {stdio: 'inherit'});
}

function runJest() {
const command = `node_modules/.bin/${runner} ${testFolder} --runInBand`;
console.log(command);
cp.execSync(command, {
stdio: 'inherit',
env: {
...process.env,
configuration: program.configuration,
loglevel: program.loglevel,
cleanup: program.cleanup,
reuse: program.reuse,
debugSynchronization: program.debugSynchronization,
artifactsLocation: program.artifactsLocation
}
});
}

switch (runner) {
case 'mocha':
const loglevel = program.loglevel ? `--loglevel ${program.loglevel}` : ''; +let runner = config.runner || 'mocha';
const configuration = program.configuration ? `--configuration ${program.configuration}` : '';
const cleanup = program.cleanup ? `--cleanup` : '';
const reuse = program.reuse ? `--reuse` : '';
const artifactsLocation = program.artifactsLocation ? `--artifacts-location ${program.artifactsLocation}` : '';
command = `node_modules/.bin/${program.runner} ${testFolder} --opts ${testFolder}/${program.runnerConfig} ${configuration} ${loglevel} ${cleanup} ${reuse} ${debugSynchronization} ${artifactsLocation}`;

console.log(command);
cp.execSync(command, { stdio: 'inherit' });
runMocha();
break;
case 'jest':
Copy link
Contributor

Choose a reason for hiding this comment

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

What about passing detox command line args? Will those work?

Copy link
Contributor Author

@Kureev Kureev Oct 11, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

We can think of a way doing this. Although, in this version I wasn't aiming to provide this. If this is mandatory, we can discuss the approach

Sorry, misread your comment. What do you mean by "detox cli args"? Can you make an example?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think it is, the feature is not 100% usable without it.

Copy link
Contributor

Choose a reason for hiding this comment

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

detox test --configuration ios.sim.release
detox test --loglevel verbose
detox test --debug-synchronization

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Which flags are important?
In the previous version there were no recommendations regarding flags so kept it out of scope. However, I'm fine adding important flags to make jest support even better 💪 .

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rotemmiz what is the goal?

  • tests can access CLI arguments
    or
  • detox can access CLI arguments

If we talk about the second one, then it already works like this (commander parses arguments before passing them to test runner)

Copy link
Contributor

Choose a reason for hiding this comment

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

You're right, but we execute a child process and these argument are not being passed into it.
cp.execSync(command, {stdio: 'inherit'});
We probably just need to pass them on...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, now I see. Indeed, we just need to pass arguments to the child process. Then there will be no point in passing all these flags in the command itself

Copy link
Contributor Author

@Kureev Kureev Oct 11, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

Seems like jest doesn't support allow custom CLI parameters. The only approach I see is to use environment vars.

Using ENV vars will imply changes on the mocha part and the way test cases gets parameters overall.

UPD: I can update argparse library and CLI so instead of additional flags it'll create one-time ENV variables. For user it'll be still the same, all mapping will happen under the hood.

Copy link
Contributor

Choose a reason for hiding this comment

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

Nice idea @Kureev, thank you so much for your efforts here 👍

runJest();
break;
case 'jest':
command = `node_modules/.bin/${runner} ${testFolder} --runInBand`;
console.log(command);
cp.execSync(command, {
stdio: 'inherit',
env: {
...process.env,
configuration,
loglevel,
cleanup,
reuse,
debugSynchronization,
artifactsLocation
}
});
break;
default:
default:
throw new Error(`${runner} is not supported in detox cli tools. You can still run your tests with the runner's own cli tool`);
}
8 changes: 4 additions & 4 deletions detox/test/ios/example.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -975,7 +975,7 @@
buildSettings = {
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
DEAD_CODE_STRIPPING = NO;
DEVELOPMENT_TEAM = "";
DEVELOPMENT_TEAM = J966JLDEF9;
INFOPLIST_FILE = example/Info.plist;
IPHONEOS_DEPLOYMENT_TARGET = 9.0;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
Copy link
Contributor

Choose a reason for hiding this comment

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

Was that added in purpose?

Expand All @@ -992,7 +992,7 @@
isa = XCBuildConfiguration;
buildSettings = {
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
DEVELOPMENT_TEAM = "";
DEVELOPMENT_TEAM = J966JLDEF9;
INFOPLIST_FILE = example/Info.plist;
IPHONEOS_DEPLOYMENT_TARGET = 9.0;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
Expand All @@ -1010,7 +1010,7 @@
buildSettings = {
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
DEAD_CODE_STRIPPING = NO;
DEVELOPMENT_TEAM = "";
DEVELOPMENT_TEAM = J966JLDEF9;
INFOPLIST_FILE = "$(SRCROOT)/example/Info.plist";
IPHONEOS_DEPLOYMENT_TARGET = 9.0;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
Expand All @@ -1027,7 +1027,7 @@
isa = XCBuildConfiguration;
buildSettings = {
ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
DEVELOPMENT_TEAM = "";
DEVELOPMENT_TEAM = J966JLDEF9;
INFOPLIST_FILE = "$(SRCROOT)/example/Info.plist";
IPHONEOS_DEPLOYMENT_TARGET = 9.0;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks";
Expand Down