  -n, --upload-from-build-path   Optional, use binaries produced in build path for uploading.      --build-path string        Optional, specify build path (can be used with --upload-from-build-path).

With-n, --upload-from-build-path the CLI will upload binaries from the build path.
--build-path force a custom build-path instead of the build-path autogenerated by the CLI.

The new behaviour is now the default if chained compile + upload (compile -u) is used.

What is the current behavior?
Currently:

arduino-cli compile -u ... will produce the binaries in the sketch folder will use them for the upload.
arduino-cli compile -n -u ... will not work (because the-n/--dry-run will not copy binaries in the sketch folder and consequently the upload will fail.

What is the new behavior?
After the patch

arduino-cli compile -u ... will produce the binaries in the sketch folder but for the upload the binaries in the build path will be used for the upload. This shouldfixUpload build path is different than output build path #641 at least for the chained build+upload.
arduino-cli compile -n -u ... will now work, it will upload without creating the binaries in the sketch folder (because the-n/--dry-run will not copy binaries in the sketch folder but the upload will use the binaries from the build-path 👍 ).

Does this PR introduce a breaking change?
It should not.

cmaglie added9 commits

April 23, 2020 16:49

Upgrade go-properites-map to 1.1.0

d46c94e

Renamed variable uploadToolPattern → uploadToolName

ac21bf6

removed useless variables

2c9900b

moved uploadProperties.ExpandPropsInString after proper check

95814a4

fixed typo

4646964

Explicitly set build-path in compile command

0a05d7f

upload now can use build path to retrieve build artifacts

34a468a

Added trace logs in upload command

75e0f37

Added --build-path and --upload-from-build-path flags in upload command

53a25fa

cmaglie self-assigned this

Apr 24, 2020

cmaglie requested a review fromrsora

April 24, 2020 12:10

cmaglie added this to the0.11.0 milestone

Apr 24, 2020

cmaglie changed the title~~Upload fix~~Allow upload using binaries from build-path

Apr 24, 2020

cmaglie marked this pull request as draft

April 24, 2020 15:52

Copy link

Contributor

rsora commentedApr 24, 2020•
edited
Loading

After going through your code and a bit of discussion with@cmaglie here my considerations:

TL;DR: with#655 nad this PR, we are basically trying to solve a "Core configuration" problem, rather than a CLI problem

This is our context:

The CLIupload functionality is built upon the so called Java IDE "Export" functionality, that copies artifact to upload on the board in the sketch path
The Java IDE instead, during the upload phase, uses the so called "sketch build path" as the place for upload artifact searching, and does not use the export path for upload purposes
Being the "Export" functionality a secondary Java IDE feature and not well documented at cores specification level, we a percentage of community cores (~20%) that do not implement correctly the "Export" (that means: mismatch between upload recipe file extension and export recipe file extension in most cases)

So, it seems that we have the following strategies to solve this issue in the CLI:

Ask to community cores to fix their export misconfiguration (and hope we get all the fixes merged in a reasonable amount of time) without changing the CLI behavior
Solve the problem merging this PR, maintaining the "Export" folder as the default upload artifact path, and giving the user flags for search in the build path for artifacts
Change the default CLI behavior, using the "build path" folder as the default upload artifact path. We can provide a--export flag for the compile to explicitly call for it
Ignore the "Export" configuration completely, and by default export all build artifacts generated in the build folder as<sketch_name>.ino.* without changing CLI behavior

Actually I believe that 4 could be the best strategy because:

In 2-step compile + upload scenario, even if the compile uses different build path via flag, the upload command is not affected, as every artifact will be "exported" regardless of the core configuration
In a combo compile --upload scenario ther is no need to pass anything to the "upload" invocation
after having the CLI completely merged in the Java IDE, we can ask to community to "clean" their cores from export configurations, without worrying too much if te PRs will be merged in time or not.

@cmaglie WDYT?