chore: change where mocks are generated #88
Merged
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
Codecov ReportAttention: Patch coverage is
|
alanshaw
approved these changes
Jan 15, 2025
volmedo
added a commit
that referenced
this pull request
Jan 16, 2025
Resolves storacha/project-tracking#171 Adds tests for the main `IndexingService.Query` function. The happy path test is useful to understand the behavior of the service fetching the different types of claims. **Note for reviewers:** the PR is not as big as it seems. I changed some interfaces dealing with `url.URL` to use `*url.URL`, which makes client code a bit more readable and is more idiomatic. A lot of files were touched just to update the type of the parameter/variable. ## Considerations I think the happy path test is the most valuable. I also added some basic tests for error conditions in the main dependencies. I thought of adding a test confirming the function filters non-relevant claims, but that is implemented by the `providerindex` package and tested there. Please let me know if you think I'm missing any other interesting tests. ## Known issues The addition of `MockProviderIndex` causes an import cycle in the tests of the `providerindex` package. These tests import the `mocks` package and the new mock imports the `providerindex` package to implement the mock. I think the best solution would be to change the mock generation configuration so that mocks are created in the same package as the interfaces they are mocking. That would avoid the cycle while allowing tests to live in the same package as the functions they are testing (which in turn enables testing non-exported members). I'll take care of that in a separate PR (#88).
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
#87 required the introduction of
MockProviderIndex, which imports theproviderindexpackage. At the same time, the tests in theproviderindexpackage itself import themockspackage, where all mocks are generated currently. This causes an import cycle. More import cycles can be created in the future as we generate mocks for other interfaces.There are two ways of implementing a future-proof solution for these cycles:
I decided to go with the second option in this case cause it allows the most flexibility when writing tests. That implied changing mock generation configuration, moving mocks around and updating the imports in test files using them.