Fix resolution of library names when checking for upgrades

[stonehippo]

Please check if the PR fulfills these requirements

• The PR has no duplicates (please search among the Pull Requests
  before creating one)
• The PR follows
  our contributing guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)
• UPGRADING.md has been updated with a migration guide (for breaking changes)

• What kind of change does this PR introduce?

This change resolves #1041, where packages that have upgrades based on library_index.json do not show up as upgradable with using the arduino-cli lib commands.

• What is the current behavior?

When using the arduino-cli lib commands to check for or apply updates, packages that have spaces in the name in the index are not shown as upgradable.

• What is the new behavior?

The overall behavior is unchanged and commands remain as currently implemented and documented. However, the resolution of packages that have spaces in the names now works, so commands such as arduino-cli lib list --updatable will now show all upgradable packages.

• Does this PR introduce a breaking change, and is
  titled accordingly?

No

• Other information:

---

See how to contribute

[CLAassistant]

All committers have signed the CLA.

[per1234]

It might make sense to mark those libraries as "legacy" to declare that they have to be upgraded manually

They are already marked as such in the [*].library.is_legacy field of the machine readable output:

$ arduino-cli version
arduino-cli.exe  Version: git-snapshot Commit: d4d1fa91 Date: 2022-05-10T02:50:00Z

$ export ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL="true"

$ arduino-cli lib install --git-url https://github.com/arduino/HMC5983
--git-url and --zip-path flags allow installing untrusted files, use it at your own risk.
Enumerating objects: 9, done.
Counting objects: 100% (9/9), done.
Compressing objects: 100% (7/7), done.
Total 9 (delta 0), reused 6 (delta 0), pack-reused 0
Library installed

$ arduino-cli lib list --format json
[
  {
    "library": {
      "name": "HMC5983",
      "architectures": [
        "*"
      ],
      "install_dir": "E:\\deleteme\\arduino-cli\\directories\\user\\libraries\\HMC5983",
      "source_dir": "e:\\deleteme\\arduino-cli\\directories\\user\\libraries\\HMC5983",
      "is_legacy": true,
      "location": 1,
      "examples": [
        "E:\\deleteme\\arduino-cli\\directories\\user\\libraries\\HMC5983\\examples\\single_read"
      ],
      "provides_includes": [
        "HMC5983.h"
      ]
    }
  }
]

Of course the average user will be using the text format output, but I'm not sure how much of a concern it is in reality since the libraries using that ancient format are not very common these days and when they are used it is likely no update will available.

if they're in the index but still not conforming to the 1.5 spec

1.5 format is a requirement for inclusion in the index, so there are no "legacy" format libraries in the index.

Note that the uninstall command uses a different resolving mechanism and will uninstall libraries based on their real names or directory names. It may also make sense to use this resolving mechanism in place of what I have here, but I'll leave that to reviewers to weigh in on.

Thanks for pointing that out. I am against it. In my opinion, there should be one and only one name for each library, which is always used when referring to the library in the Arduino CLI output and in the commands. So I think the way you chose to make lib upgrade work here is correct.

[per1234]

Thanks @stonehippo!

This PR fixes only one of several of the symptoms of an unintuitive and flawed approach to handling names of installed libraries. However, it does indeed fix that symptom and thus is a valuable contribution by making the behavior of Arduino CLI less buggy in this respect.

So I am in support of merging this, even though the big picture is that the entire local library name system needs to be reworked from the root of the problem in the design of github.com/arduino/arduino-cli/arduino/libraries.Library on up.

I'll give a little time in case other maintainers want to review before merging.

[stonehippo]

Thanks, @per1234. I agree re the current system. It's really hard to make definitive calls about the state of a user's installed libraries vs the index. You're right that this is only a patch over the symptoms, but it's going to take some collective work to reconcile the deeper issue.