Automatic Library Installation from depends field in library.properties

[aliphys]

This PR addresses the limitation described by @per1234 in arduino-libraries/Arduino_UnifiedStorage#30 (review)

The addition of such a capability, where the action parses the library.properties file and then automatically installs the libraries found there, has been proposed but the feature was not implemented so far.

Currently, the compile-sketches action is unable to read dependancies from the depends field. I have documented this issue in #204 .

• 🔍 Identify if library.properties is included in the sketch directory
• ⛏️ Extract the library names from the depends key using re (limitation: only with ',' deliminator)
• 🔧 Modified install_libraries_from_library_manager() function to install identified libraries
• 🎉 With this PR, there should be no need to seperately specify libraries in the workflow .yml file cc @sebromero

[codecov-commenter]

Codecov Report

❌ Patch coverage is 98.24561% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 99.75%. Comparing base (57751ec) to head (5fa7818).
⚠️ Report is 435 commits behind head on main.

Files with missing lines	Patch %	Lines
compilesketches/compilesketches.py	94.44%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #205      +/-   ##
==========================================
- Coverage   99.81%   99.75%   -0.06%     
==========================================
  Files           2        2              
  Lines        1608     1665      +57     
==========================================
+ Hits         1605     1661      +56     
- Misses          3        4       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[aliphys]

@per1234 Can you approve this PR?

[per1234]

Please add unit test coverage for the added code.

[aliphys]

• 🧪 Added unit tests
  • For get_dependencies_from_properties_file -> test_get_dependencies_from_properties_file_with_dependencies, test_get_dependencies_from_properties_file_without_dependencies and test_get_dependencies_from_properties_file_no_depends_key
  • For get_library_dependencies -> test_get_library_dependencies_with_properties_file and test_get_library_dependencies_without_properties_file
• ✅ Linter and Formatting Approved by workflow

[aliphys]

There is an error in one workflow, which I don't think is related to this PR.

[2024-02-06T13:41:02.366Z] ['error'] There was an error running the uploader: Error uploading to [https://codecov.io:](https://codecov.io/) Error: There was an error fetching the storage URL during POST: 503 - upstream connect error or disconnect/reset before headers. reset reason: connection failure
Error: Codecov: Failed to properly upload: The process '/home/runner/work/_actions/codecov/codecov-action/v3/dist/codecov' failed with exit code 255

[CLAassistant]

All committers have signed the CLA.

[2bndy5]

Some issues with this:

1. GITHUB_REPOSITORY env var does not point to a path, rather it only describes the project/repository in the form owner-name/repo-name. I think you were expecting something more like GITHUB_WORKSPACE, but that assumes the repo is not checked out in a sub-path of GITHUB_WORKSPACE.
2. This block is only triggered when installing a library from the lib manager (e.g. - name: Adafruit BusIO). Installing a local lib's deps here doesn't really make sense.
3. You can drop the for loop here and just lib_install_cmd.extend(dependencies) instead. If filtering deps is desirable then it would look like:

   for dep in deps:
       if dep not in lib_install_cmd:
           lib_install_cmd.append(dep)
   
   # or as a one-liner
   lib_install_cmd.extend([dep for dep in deps if dep not in lib_install_cmd])

   Not sure how/if this passed python linters. Use list.append() for a single item or list.extend() to append multiple items from a iterable sequence. extend()-ing a str may result in each char of the string becoming a separate item.
4. This block happens after lib_install_cmd is already passed to self.run_arduino_cli_command() (see line just above this block). I highly doubt this proposal would have any behavioral impact (desirable or otherwise).

Note

FYI, I am adamantly against auto-installing the checked-out repo's deps without an explicit opt-in mechanism. See my rationality in #204 (comment)