feat!: key rename cli command #9601

technicallyty · 2021-06-28T22:53:13Z

Description

this PR adds a new function to the keyring interface, as well as a CLI command to rename a key in the keyring

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

confirmed the correct type prefix in the PR title
confirmed ! in the type prefix if API or client breaking change
confirmed all author checklist items have been addressed
reviewed state machine logic
reviewed API design and naming
reviewed documentation is accurate
reviewed tests and test coverage
manually tested (if applicable)

codecov · 2021-06-29T00:29:21Z

Codecov Report

Merging #9601 (4edd229) into master (0027111) will increase coverage by 27.94%.
The diff coverage is 63.79%.

❗ Current head 4edd229 differs from pull request most recent head c21bd5f. Consider uploading reports for the commit c21bd5f to get more accurate results

@@             Coverage Diff             @@
##           master    #9601       +/-   ##
===========================================
+ Coverage   35.48%   63.42%   +27.94%     
===========================================
  Files         332      574      +242     
  Lines       32620    37648     +5028     
===========================================
+ Hits        11575    23880    +12305     
+ Misses      19819    11900     -7919     
- Partials     1226     1868      +642

Impacted Files	Coverage Δ
client/keys/types.go	`100.00% <ø> (+100.00%)`	⬆️
client/query.go	`16.98% <ø> (ø)`
client/rpc/block.go	`0.00% <ø> (ø)`
client/rpc/status.go	`67.74% <ø> (ø)`
client/rpc/validators.go	`0.00% <ø> (ø)`
client/test_helpers.go	`0.00% <ø> (ø)`
client/tx/factory.go	`27.00% <ø> (ø)`
client/tx/legacy.go	`68.42% <ø> (ø)`
client/tx/tx.go	`40.83% <ø> (ø)`
client/utils.go	`41.93% <ø> (-41.40%)`	⬇️
... and 686 more

likhita-809

left some nits and also could you resolve the conflicts ?

CHANGELOG.md

client/keys/rename.go

crypto/keyring/keyring_test.go

ryanchristo

Manually tested. Seems to be working without issues. A couple comments.

crypto/keyring/keyring.go

ryanchristo · 2021-06-30T19:14:02Z

crypto/keyring/keyring_test.go

@@ -1153,6 +1153,52 @@ func TestBackendConfigConstructors(t *testing.T) {
 	require.Equal(t, "keyring-test", backend.PassPrefix)
 }

+func TestRenameKey(t *testing.T) {


For each test, should we check more than just an error? Should we also check whether each key does or does not exist within the keyring after renaming?

Should we also check whether each key does or does not exist within the keyring after renaming?

this is already checked on L1175 and L1182-L1183

Within this test, rename is called three times at the end without checking the specific error thrown or what keys exist after each failed attempt. I was thinking the extra checks would be added to the failed attempts. At the least, I think we should check to make sure we are receiving the expected error and not just any error.

refactored the tests. should be a bit more concise. let me know if its missing anything please!

Nice! I like the direction with adding test cases. I'm not sure if it's necessary given that the only parameter for each test case is the run function and there is no overlap with the key names you are using so creating a new keyring for each test case might not be necessary but I also think it's ok to leave it as is.

Co-authored-by: likhita-809 <[email protected]>

crypto/keyring/keyring.go

alexanderbez · 2021-07-06T11:36:16Z

crypto/keyring/keyring.go

+		return errors.New(fmt.Sprintf("rename failed: %s already exists in the keyring", newName))
+	}
+
+	passPhrase := "temp"


nit: this should be a private const

yup that makes much more sense - moved it to the other private const vars

Co-authored-by: Aleksandr Bezobchuk <[email protected]>

ryanchristo · 2021-07-06T19:27:01Z

crypto/keyring/keyring.go

+	err = ks.Delete(oldName)
+	if err != nil {
+		return err
+	}


Should this be called after ImportPrivKey? What happens if ImportPrivKey fails? The account is deleted and no new account is created.

so import will actually fail if you delete last, cause import doesn't allow same pubkeys. some solutions i can think of:

dump the key information in a recovery file

update the ImportPrivKey method to allow keys with same pubkeys, but different keyring names

thoughts?

If the name is the primary index, I think it's OK to go with (2).

alright, changed the write behavior to allow duplicate keys, as long as the names are different.

ryanchristo

tACK. No necessary changes but I left a few comments.

CHANGELOG.md

crypto/keyring/keyring.go

crypto/keyring/keyring_test.go

ryanchristo · 2021-07-08T17:28:35Z

crypto/keyring/keyring_test.go

@@ -1153,6 +1153,52 @@ func TestBackendConfigConstructors(t *testing.T) {
 	require.Equal(t, "keyring-test", backend.PassPrefix)
 }

+func TestRenameKey(t *testing.T) {


Nice! I like the direction with adding test cases. I'm not sure if it's necessary given that the only parameter for each test case is the run function and there is no overlap with the key names you are using so creating a new keyring for each test case might not be necessary but I also think it's ok to leave it as is.

crypto/keyring/keyring_test.go

Co-authored-by: Ryan Christoffersen <[email protected]>

likhita-809

lgtm

technicallyty · 2021-07-09T15:22:26Z

the change request is blocking merge @alexanderbez, could you re-review when you have time?

technicallyty · 2021-07-13T15:13:40Z

@alexanderbez ping - still blocked 🙈

technicallyty added 2 commits June 28, 2021 15:41

added key renaming

238dbe2

add cli cmds

46762a6

technicallyty requested review from aaronc and alexanderbez as code owners June 28, 2021 22:53

github-actions bot added C:CLI C:Keys Keybase, KMS and HSMs labels Jun 28, 2021

technicallyty added 4 commits June 28, 2021 15:54

changelog

950752a

gofmt

4368e14

move changelog

8283b67

fix root_test

9acfb00

amaury1093 assigned likhita-809 Jun 29, 2021

likhita-809 reviewed Jun 30, 2021

View reviewed changes

clevinson assigned ryanchristo Jun 30, 2021

ryanchristo reviewed Jun 30, 2021

View reviewed changes

technicallyty and others added 3 commits July 5, 2021 08:57

Apply suggestions from code review

16b6632

Co-authored-by: likhita-809 <[email protected]>

Merge branch 'master' into ty/9407-rename_keys_cli

ec01a52

add equality function

26ec3a5

alexanderbez suggested changes Jul 6, 2021

View reviewed changes

technicallyty and others added 2 commits July 6, 2021 07:58

Update crypto/keyring/keyring.go

9a2ba38

Co-authored-by: Aleksandr Bezobchuk <[email protected]>

move passphrase to const defs

2c7395b

technicallyty requested review from alexanderbez, likhita-809 and ryanchristo July 6, 2021 16:37

technicallyty mentioned this pull request Jul 6, 2021

gaiad UX issues #9407

Closed

20 tasks

ryanchristo reviewed Jul 6, 2021

View reviewed changes

technicallyty added 4 commits July 6, 2021 13:29

refactor test

588c082

allow duplicate keys as long as names are different

ed51363

Merge branch 'master' into ty/9407-rename_keys_cli

8d464aa

lint

fc19867

ryanchristo approved these changes Jul 8, 2021

View reviewed changes

technicallyty and others added 2 commits July 8, 2021 12:15

Update CHANGELOG.md

c6aed98

Co-authored-by: Ryan Christoffersen <[email protected]>

Update crypto/keyring/keyring.go

3c1e9b9

Co-authored-by: Ryan Christoffersen <[email protected]>

likhita-809 approved these changes Jul 9, 2021

View reviewed changes

Merge branch 'master' into ty/9407-rename_keys_cli

4044320

technicallyty added the A:automerge Automatically merge PR once all prerequisites pass. label Jul 9, 2021

mergify bot added 8 commits July 10, 2021 02:53

Merge branch 'master' into ty/9407-rename_keys_cli

e4d2a3f

Merge branch 'master' into ty/9407-rename_keys_cli

2d563b2

Merge branch 'master' into ty/9407-rename_keys_cli

1a9347c

Merge branch 'master' into ty/9407-rename_keys_cli

102169b

Merge branch 'master' into ty/9407-rename_keys_cli

e3cca96

Merge branch 'master' into ty/9407-rename_keys_cli

3865a9e

Merge branch 'master' into ty/9407-rename_keys_cli

aae59f9

Merge branch 'master' into ty/9407-rename_keys_cli

e6f8508

alexanderbez approved these changes Jul 16, 2021

View reviewed changes

mergify bot and others added 2 commits July 17, 2021 00:40

Merge branch 'master' into ty/9407-rename_keys_cli

e5e35f6

Merge branch 'master' into ty/9407-rename_keys_cli

4edd229

technicallyty changed the title ~~feat: key rename cli command~~ feat!: key rename cli command Jul 18, 2021

Merge branch 'master' into ty/9407-rename_keys_cli

c21bd5f

technicallyty added A:automerge Automatically merge PR once all prerequisites pass. and removed A:automerge Automatically merge PR once all prerequisites pass. labels Jul 19, 2021

mergify bot merged commit 57d21fa into master Jul 19, 2021

mergify bot deleted the ty/9407-rename_keys_cli branch July 19, 2021 15:20

julienrbrt mentioned this pull request Apr 19, 2022

Add ability to rename keys through the CLI #1755

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: key rename cli command #9601

feat!: key rename cli command #9601

technicallyty commented Jun 28, 2021 •

edited by ryanchristo

Loading

codecov bot commented Jun 29, 2021 •

edited

Loading

likhita-809 left a comment •

edited

Loading

ryanchristo left a comment

ryanchristo Jun 30, 2021

technicallyty Jul 5, 2021 •

edited

Loading

ryanchristo Jul 6, 2021

technicallyty Jul 6, 2021

ryanchristo Jul 8, 2021

alexanderbez Jul 6, 2021

technicallyty Jul 6, 2021

ryanchristo Jul 6, 2021

technicallyty Jul 6, 2021

alexanderbez Jul 6, 2021

technicallyty Jul 6, 2021

ryanchristo left a comment

ryanchristo Jul 8, 2021

likhita-809 left a comment

technicallyty commented Jul 9, 2021

technicallyty commented Jul 13, 2021

feat!: key rename cli command #9601

feat!: key rename cli command #9601

Conversation

technicallyty commented Jun 28, 2021 • edited by ryanchristo Loading

Description

Author Checklist

Reviewers Checklist

codecov bot commented Jun 29, 2021 • edited Loading

Codecov Report

likhita-809 left a comment • edited Loading

Choose a reason for hiding this comment

ryanchristo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

technicallyty Jul 5, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ryanchristo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

likhita-809 left a comment

Choose a reason for hiding this comment

technicallyty commented Jul 9, 2021

technicallyty commented Jul 13, 2021

technicallyty commented Jun 28, 2021 •

edited by ryanchristo

Loading

codecov bot commented Jun 29, 2021 •

edited

Loading

likhita-809 left a comment •

edited

Loading

technicallyty Jul 5, 2021 •

edited

Loading