In PR's, exclusively run the designated service tests e.g. [cran discord] #1111
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
paulmelnikow
added
bug
paulmelnikow
changed the title
|
I added |
paulmelnikow
changed the title
Daniel15
approved these changes
Oct 1, 2017
There was a problem hiding this comment.
This looks good. However, the build failed. Is it related?
Error: 403 Forbidden
at Error (native)
at fetch.then.res (/home/travis/build/badges/shields/service-tests/runner/pull-request-services-cli.js:36:15)
at process._tickCallback (internal/process/next_tick.js:109:7)
| // easier to reason about and much easier to debug on a dev machine. | ||
| // 3. Getting "pipefail" to work cross platform with an npm script seems tricky. | ||
| // Relying on npm scripts is safer. Using "pre" makes it impossible to run | ||
| // the second step without the first. |
There was a problem hiding this comment.
I love these comments. Very useful.
|
The build failure is only tangentially related. This is only one part of solving #979. 403 Forbidden error is what happens when the test runner tries to fetch the PR metadata. Thanks for the review! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The intended behavior of the bracketed [github], [bower], [discord] service names in the pull request title is to trigger the designated service tests. That way, affected services can be proven working during code review, without needing to run tests on a dev machine, nor running all the slow (and flaky) service tests.
Example pull request titles:
The observed behavior is that, whenever bracketed service names are provided, all of the service tests run.
This is due to a Mocha limitation, which is that exclusive tests (
it.onlyanddescribe.only) can only be applied synchronously. In other words, if we try to fetch the PR title and then add exclusive tests in the callback, all the tests will run anyway. This is true even when using_mocha --delay, as we are, and is true whether I userequestornode-fetch.Undoubtedly this could be fixed, though it's not worth it. The problem is obscure and therefore low priority for Mocha, which is quite backlogged.
And, there is an easy workaround, which is to generate the list of services to test in a separate process.
The pull request script test:services:pr is now split into two parts. First the :prepare script infers the pull request context, fetches the PR title, and writes the list of affected services to a file. Then the :run script reads the list of affected services and runs the appropriate tests.
In addition to sidestepping the Mocha bug, this setup makes it easier to reason about and debug these two steps of the test runner on a dev machine, and since I can't get pipefail to work – and want to be able to run the steps separately – I'm not using Node's built in
prescripts.Overall, separating these concerns this makes the test runner easier to reason about.