Adding a best option to clip to copy a password of the best match

[lerignoux]

if only one matching entry exists

I added an option to do a best effort search when doing a clip.

For instance if I have an entry ****/paypal/account and do a keepassxc-cli clip -b db.kdbx payp it will search for a matching entry and clip it if it's unique. This make the search for a password much faster even if you dont know the exact name/case ...

Type of change

• ✅ New feature (non-breaking change which adds functionality)

Description and Context

I will use the cli exclusively to copy my passwords but it is difficult to remember the exact name we use for the key and slow to find it back. If you know you have a gmail for instance entry it helps you to clip it even with an approximate title.
on failure to find a single one it will display all matching entries enabling you to specify the right one.
Fixes #4270 that I opened on it

Screenshots

Testing strategy

Try to call clip without the -b option, it should keep the previous behavior:

• find the entry on matching name
• do not find the entry if not exactly matching an entry
  Call clip -b and some sub string of your entries. it should
• echo the matching entry and clip the password if a unique entry is found
• display the list of matching entries otherwise

I didn't see any tests on the CLI, and I doubt adding unit tests on this is relevant.

Checklist:

• ✅ I have read the CONTRIBUTING document.
• ✅ My code follows the code style of this project.
• ✅ All new and existing tests passed.
• ✅ I have compiled and verified my code with -DWITH_ASAN=ON.
• ✅ My change requires a change to the documentation, and I have updated it accordingly. -> I didnt found documentation on the cli. Could you confirm that no documentation change is needed ?
• ✅ I have added tests to cover my changes. -> It seems additional tests are not needed. Please tell me if you see something I could add

[lerignoux]

Hello

I didn't found documentation or tests on the CLI to update. Could you confirm that it's ok ?

[lerignoux]

The MacOS build fails because of ssh connection issue. It does not seem related to my changes.
I do not found how to restart the build

[louib]

Hi @lerignoux ! Thanks for the PR.

There is a manpage for the CLI located in docs/man/ which would need to be updated with the new option.

Tests for the CLI are located in tests/TestCli.cpp and I think it's definitely worth it to add tests for the new option.

Displaying which entry was used is a nice touch 👍

[lerignoux]

Hi @lerignoux ! Thanks for the PR.

There is a manpage for the CLI located in docs/man/ which would need to be updated with the new option.

Tests for the CLI are located in tests/TestCli.cpp and I think it's definitely worth it to add tests for the new option.

Displaying which entry was used is a nice touch +1

Hello

Thank you @louib for the info. I updated the manual and tests.

Though I don't manage to run the cli test on my machine. tests seem to run well but the cli test is not run.
I saw the errors on TeamCity, to fix them I should add an entry to the test Database (to properly test the option) though I am not sure how to open and edit it.
do you know the test DB password ?

[lerignoux]

@louib would you have any info about my previous commit ? i would like to add a fixture to the test DB to add a relevant test for this new feature.

Cheers

[louib]

@lerignoux for the CLI tests to run, you need to configure the project with -DWITH_GUI_TESTS=ON (this is because the CLI depends on QT's GUI library, which is something we're trying to fix).

The password of the test database must be somewhere in the tests/TestCli.cpp file, but IIRC it's a

[lerignoux]

Yeah thanks a lot @louib it's much easier when I can run the tests directly :p
Managed to clean everything.

tell me if I can do anything else !

[droidmonkey]

This is super slick, love it!