Handle inappropriate null output from arduino-cli core list when no platforms are installed
#311
Conversation
This file contains hidden or 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
…no platforms are installed
A regression was introduced in the 1.0.0 release of Arduino CLI. When no platforms are installed, `arduino-cli core list
--format json` now returns `null` instead of the appropriate value of an empty array.
Previously the code for parsing the output was written under the assumption of the logical behavior of the command
always outputting an array, even if an empty array. This code could not correctly handle the output produced by Arduino
CLI >=1.0.0, resulting in a spurious failure of the action:
```
Traceback (most recent call last):
File "/home/runner/work/_actions/arduino/compile-sketches/main/compilesketches/compilesketches.py", line 1709, in <module>
main() # pragma: no cover
^^^^^^
File "/home/runner/work/_actions/arduino/compile-sketches/main/compilesketches/compilesketches.py", line 63, in main
compile_sketches.compile_sketches()
File "/home/runner/work/_actions/arduino/compile-sketches/main/compilesketches/compilesketches.py", line 219, in compile_sketches
self.install_platforms()
File "/home/runner/work/_actions/arduino/compile-sketches/main/compilesketches/compilesketches.py", line 337, in install_platforms
self.install_platforms_from_repository(platform_list=platform_list.repository)
File "/home/runner/work/_actions/arduino/compile-sketches/main/compilesketches/compilesketches.py", line 629, in install_platforms_from_repository
destination_path = self.get_platform_installation_path(platform=platform)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/home/runner/work/_actions/arduino/compile-sketches/main/compilesketches/compilesketches.py", line 562, in get_platform_installation_path
for installed_platform in installed_platform_list:
TypeError: 'NoneType' object is not iterable
```
In order to work around the Arduino CLI bug, code is added to handle the case where the value is `null` (`None` when
converted to a Python data type) instead of an array.
3 tasks
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.
A regression was introduced in the 1.0.0 release of Arduino CLI (arduino/arduino-cli#2690). When no platforms are installed,
arduino-cli core list --format jsonnow returnsnullinstead of the appropriate value of an empty array.Previously the code for parsing the output was written under the assumption of the logical behavior of the command always outputting an array, even if an empty array. This code could not correctly handle the output produced by Arduino CLI >=1.0.0, resulting in a spurious failure of the action (#310):
In order to work around the Arduino CLI bug, code is added to handle the case where the value is
null(Nonewhen converted to a Python data type) instead of an array.Fixes #310