test(bug): In TestKeyManagement, test GetByAddress after replacing a key with the same name #2684
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
…key with the same name. See the PR. Signed-off-by: Jeff Thompson <jeff@thefirst.org>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2684 +/- ##
==========================================
+ Coverage 60.11% 60.15% +0.03%
==========================================
Files 560 561 +1
Lines 74918 74999 +81
==========================================
+ Hits 45039 45114 +75
- Misses 26504 26507 +3
- Partials 3375 3378 +3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Merged
6 tasks
|
A possible fix for the bug demonstrated in this PR is #2685, so I set this PR to Draft. If that PR is merged, then we can close this PR. |
thehowl
pushed a commit
that referenced
this pull request
Oct 22, 2024
…remove the lookup by the old address (#2685) This PR fixes the bug demonstrated in #2684 : * In `dbKeybase.writeInfo`, add an `error` return and propagate this to all callers (`writeLocalKey`, etc.) . We need `writeInfo` to do some database integrity checks, so it needs to be able to return an error. * Update `dbKeybase.writeInfo` as suggested in [#2684](#2684) . If an existing name entry is being replaced with new `Info`, then remove the "lookup by address" entry for the existing address. * In `TestKeyManagement`, add a test similar to [#2684](#2684) , except that after using `CreateAccount` with the same name, expect `GetByAddress` to fail for the obsolete address and its (non-existing) public key. (This test passes.) <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [x] Added references to related issues and PRs - [x] Provided any useful hints for running manual tests </details> Signed-off-by: Jeff Thompson <jeff@thefirst.org>
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 PR demonstrates a bug.
TestKeyManagementcreates a key named "n2" withInfo"i2". This PR addsGetByAddressand confirms that the public key in the retrievedInfomatches the original public key. So good so far. Then the test callsCreateAccountto replace the entry for the same name with a new key (address). It callsGetByAddresswith the original address, which successfully returnsInfo.Expected: The public key in the
Infoshould correspond to the address that it is fetched by.Actual: The test fails because the public key doesn't match. (The "lookup by address" entry maps to the name "n2" but now that name entry has new
Info.To run the test:
Discussion:
CreateAccountis allowed to replace the entry for a name with newInfo(new address), but it leaves the existing "lookup by address" entry untouched. This creates the possibility ofGetByAddressreturning a public key which doesn't correspond to that address. This can cause problems with attempting to use the key, expecting it to match the address. A possible solution: When replacing a name entry with newInfo, remove the "lookup by address" entry for the existing address.GetByAddresswith the old address should fail.