Add msw tests for gh-api-client #1663
Merged
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
This adds some really simple tests for the `gh-api-client` file to ensure that we can use msw mocks in pure tests.
charisk
reviewed
Oct 27, 2022
extensions/ql-vscode/test/pure-tests/remote-queries/gh-api/gh-api-client.test.ts
Outdated
Show resolved
Hide resolved
charisk
reviewed
Oct 27, 2022
| it('returns the variant analysis', async () => { | ||
| await loadScenario('problem-query-success'); | ||
|
|
||
| const result = await getVariantAnalysis(mockCredentials, 557804416, 146); |
Contributor
There was a problem hiding this comment.
What do you think about getting these ids from the scenario data instead of hard-coding in a test as well? I'm not sure if that would be super ugly so happy to be told no :)
Member
Author
There was a problem hiding this comment.
I've implemented it and I don't think it's ugly, but I did have to change how the tsconfig.json for tests was loaded.
This splits the mock GitHub API server class into two parts: one for the interactive, VSCode parts and one for the non-VSCode parts. This allows us to use the non-VSCode part in tests.
charisk
approved these changes
Oct 28, 2022
Contributor
charisk
left a comment
charisk
left a comment
There was a problem hiding this comment.
LGTM, just a suggestion left around test data usage. Happy to leave that for another day too.
This will change the pure tests Mocha setup to actually use the `tsconfig.json` located in the `test` directory. Before, it was using the root-level `tsconfig.json`. To ensure we are still using mostly the same settings, this will extend the `test/tsconfig.json` from the root-level `tsconfig.json`.
This will check that the data returned matches the data in the JSON files, rather than checking against constants/magic values.
charisk
approved these changes
Oct 28, 2022
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 adds some really simple tests for the
gh-api-clientfile to ensure that we can use msw mocks in pure tests.Checklist
ready-for-doc-reviewlabel there.