Improve integration tests for pushing Jenkins statuses #222
Conversation
This file contains hidden or 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
The previous approach of testing if network requests had been sent from the bot, via nock scopes, didn't test more then one network request. That's because we tested all scoped in a one-liner like this; ```js prCommitsScope.done() && scope.done() ``` It turns out that the above will not invoke the second `scope.done()`, meaning only the first nock scope (read: outgoing network request) was asserted. By going away from that one-liner and invoking one by one on each line, tests starts to explode. A fix to the bot's source will come in the next commit.
These changes are primarily done so we can get more reliable integration tests. Previously the incoming requests was responded to, before we knew whether or not the Jenkins status has been successfully pushed to GitHub. That makes it challenging to know when we can assert what we want to verify in integration tests, as we don't know when the entire operation has finished. Although the previous approach did what it should in practise when run in production, it should be just as important to have reliable tests that we can rely on when doing changes going forward.
phillipj
commented
Mar 21, 2019
Will be squased into 28d8a86 before merged to master.
As it's way more intuitive to have those outgoing HTTP request assertions alongside other assertions, than as part of the test tear down process.
refack
approved these changes
Mar 24, 2019
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.
This is a precursor to fixing #212.
These changes are primarily done so we can get more reliable integration tests. Previously the incoming requests was responded to, before we knew whether or not the Jenkins status has been successfully pushed to GitHub.
That makes it challenging to know when we can assert what we want to verify in integration tests, as we don't know when the entire operation has finished.
Although the previous approach worked in practise when run in production, it should be just as important to have reliable tests that we can rely on when doing changes going forward.
/cc @nodejs/github-bot