Upload command now works with sketches and builds from .pde files

Author: silvanocerza

cli/upload/upload.go

@@ -19,6 +19,7 @@ import (
 	"context"
 	"os"
 
+	"github.com/arduino/arduino-cli/arduino/sketches"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/instance"
@@ -83,6 +84,14 @@ func run(command *cobra.Command, args []string) {
 	}
 	sketchPath := initSketchPath(path)
 
+	// .pde files are still supported but deprecated, this warning urges the user to rename them
+	if files := sketches.CheckForPdeFiles(sketchPath); len(files) > 0 {
+		feedback.Error("Sketches with .pde extension are deprecated, please rename the following files to .ino:")
+		for _, f := range files {
+			feedback.Error(f)
+		}
+	}
+
 	if _, err := upload.Upload(context.Background(), &rpc.UploadReq{
 		Instance:   instance,
 		Fqbn:       fqbn,

commands/upload/upload.go

@@ -26,6 +26,7 @@ import (
 	bldr "github.com/arduino/arduino-cli/arduino/builder"
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
+	"github.com/arduino/arduino-cli/arduino/globals"
 	"github.com/arduino/arduino-cli/arduino/serialutils"
 	"github.com/arduino/arduino-cli/arduino/sketches"
 	"github.com/arduino/arduino-cli/commands"
@@ -452,7 +453,7 @@ func determineBuildPathAndSketchName(importFile, importDir string, sketch *sketc
 
 	// Case 4: only sketch specified. In this case we use the generated build path
 	// and the given sketch name.
-	return bldr.GenBuildPath(sketch.FullPath), sketch.Name + ".ino", nil
+	return bldr.GenBuildPath(sketch.FullPath), sketch.Name + sketch.MainFileExtension, nil
 }
 
 func detectSketchNameFromBuildPath(buildPath *paths.Path) (string, error) {
@@ -462,11 +463,13 @@ func detectSketchNameFromBuildPath(buildPath *paths.Path) (string, error) {
 	}
 
 	if absBuildPath, err := buildPath.Abs(); err == nil {
-		candidateName := absBuildPath.Base() + ".ino"
-		f := files.Clone()
-		f.FilterPrefix(candidateName + ".")
-		if f.Len() > 0 {
-			return candidateName, nil
+		for ext := range globals.MainFileValidExtensions {
+			candidateName := absBuildPath.Base() + ext
+			f := files.Clone()
+			f.FilterPrefix(candidateName + ".")
+			if f.Len() > 0 {
+				return candidateName, nil
+			}
 		}
 	}
 
@@ -479,7 +482,7 @@ func detectSketchNameFromBuildPath(buildPath *paths.Path) (string, error) {
 
 		// Sometimes we may have particular files like:
 		// Blink.ino.with_bootloader.bin
-		if filepath.Ext(name) != ".ino" {
+		if _, ok := globals.MainFileValidExtensions[filepath.Ext(name)]; !ok {
 			// just ignore those files
 			continue
 		}

test/test_upload.py

@@ -13,6 +13,9 @@
 # software without disclosing the source code of your own applications. To purchase
 # a commercial license, send an email to [email protected].
 import os
+import hashlib
+import tempfile
+import shutil
 from pathlib import Path
 
 import pytest
@@ -195,3 +198,143 @@ def test_compile_and_upload_combo_with_custom_build_path(run_command, data_dir,
         assert f"Compile {sketch_name} for {board.fqbn} successful" in traces
         assert f"Upload {sketch_path} on {board.fqbn} started" in traces
         assert "Upload successful" in traces
+
+
+def test_compile_and_upload_combo_sketch_with_pde_extension(run_command, data_dir, detected_boards, wait_for_board):
+    assert run_command("update")
+
+    sketch_name = "CompileAndUploadPdeSketch"
+    sketch_path = Path(data_dir, sketch_name)
+
+    # Create a test sketch
+    assert run_command(f"sketch new {sketch_path}")
+
+    # Renames sketch file to pde
+    sketch_file = Path(sketch_path, f"{sketch_name}.ino").rename(sketch_path / f"{sketch_name}.pde")
+
+    for board in detected_boards:
+        # Install core
+        core = ":".join(board.fqbn.split(":")[:2])
+        assert run_command(f"core install {core}")
+
+        # Build sketch and upload from folder
+        wait_for_board()
+        res = run_command(f"compile --clean -b {board.fqbn} -u -p {board.address} {sketch_path}")
+        assert res.ok
+        assert "Sketches with .pde extension are deprecated, please rename the following files to .ino" in res.stderr
+        assert str(sketch_file) in res.stderr
+
+        # Build sketch and upload from file
+        wait_for_board()
+        res = run_command(f"compile --clean -b {board.fqbn} -u -p {board.address} {sketch_file}")
+        assert res.ok
+        assert "Sketches with .pde extension are deprecated, please rename the following files to .ino" in res.stderr
+        assert str(sketch_file) in res.stderr
+
+
+def test_upload_sketch_with_pde_extension(run_command, data_dir, detected_boards, wait_for_board):
+    assert run_command("update")
+
+    sketch_name = "UploadPdeSketch"
+    sketch_path = Path(data_dir, sketch_name)
+
+    # Create a test sketch
+    assert run_command(f"sketch new {sketch_path}")
+
+    # Renames sketch file to pde
+    sketch_file = Path(sketch_path, f"{sketch_name}.ino").rename(sketch_path / f"{sketch_name}.pde")
+
+    for board in detected_boards:
+        # Install core
+        core = ":".join(board.fqbn.split(":")[:2])
+        assert run_command(f"core install {core}")
+
+        # Compile sketch first
+        assert run_command(f"compile --clean -b {board.fqbn} {sketch_path}")
+
+        # Upload from sketch folder
+        wait_for_board()
+        assert run_command(f"upload -b {board.fqbn} -p {board.address} {sketch_path}")
+
+        # Upload from sketch file
+        wait_for_board()
+        assert run_command(f"upload -b {board.fqbn} -p {board.address} {sketch_file}")
+
+        # Upload from build folder
+        sketch_path_md5 = hashlib.md5(bytes(sketch_path)).hexdigest().upper()
+        build_dir = Path(tempfile.gettempdir(), f"arduino-sketch-{sketch_path_md5}")
+        wait_for_board()
+        res = run_command(f"upload -b {board.fqbn} -p {board.address} --input-dir {build_dir}")
+        assert (
+            "Sketches with .pde extension are deprecated, please rename the following files to .ino:" not in res.stderr
+        )
+
+        # Upload from binary file
+        wait_for_board()
+        # We don't need a specific file when using the --input-file flag to upload since
+        # it's just used to calculate the directory, so it's enough to get a random file
+        # that's inside that directory
+        binary_file = next(build_dir.glob(f"{sketch_name}.pde.*"))
+        res = run_command(f"upload -b {board.fqbn} -p {board.address} --input-file {binary_file}")
+        assert (
+            "Sketches with .pde extension are deprecated, please rename the following files to .ino:" not in res.stderr
+        )
+
+
+def test_upload_with_input_dir_containing_multiple_binaries(run_command, data_dir, detected_boards, wait_for_board):
+    # This tests verifies the behaviour outlined in this issue:
+    # https://github.com/arduino/arduino-cli/issues/765#issuecomment-699678646
+    assert run_command("update")
+
+    # Create a two different sketches
+    sketch_one_name = "UploadMultipleBinariesSketchOne"
+    sketch_one_path = Path(data_dir, sketch_one_name)
+    assert run_command(f"sketch new {sketch_one_path}")
+
+    sketch_two_name = "UploadMultipleBinariesSketchTwo"
+    sketch_two_path = Path(data_dir, sketch_two_name)
+    assert run_command(f"sketch new {sketch_two_path}")
+
+    for board in detected_boards:
+        # Install core
+        core = ":".join(board.fqbn.split(":")[:2])
+        assert run_command(f"core install {core}")
+
+        # Compile both sketches and copy binaries in the same directory same build directory
+        assert run_command(f"compile --clean -b {board.fqbn} {sketch_one_path}")
+        assert run_command(f"compile --clean -b {board.fqbn} {sketch_two_path}")
+
+        sketch_path_md5 = hashlib.md5(bytes(sketch_one_path)).hexdigest().upper()
+        build_dir_one = Path(tempfile.gettempdir(), f"arduino-sketch-{sketch_path_md5}")
+
+        sketch_path_md5 = hashlib.md5(bytes(sketch_two_path)).hexdigest().upper()
+        build_dir_two = Path(tempfile.gettempdir(), f"arduino-sketch-{sketch_path_md5}")
+
+        # Copy binaries to same folder
+        binaries_dir = Path(data_dir, "build", "BuiltBinaries")
+        shutil.copytree(build_dir_one, binaries_dir, dirs_exist_ok=True)
+        shutil.copytree(build_dir_two, binaries_dir, dirs_exist_ok=True)
+
+        wait_for_board()
+        # Verifies upload fails because multiple binaries are found
+        res = run_command(f"upload -b {board.fqbn} -p {board.address} --input-dir {binaries_dir}")
+        assert res.failed
+        assert (
+            "Error during Upload: "
+            + "retrieving build artifacts: "
+            + "autodetect build artifact: "
+            + "multiple build artifacts found:"
+            in res.stderr
+        )
+
+        # Copy binaries to folder with same name of a sketch
+        binaries_dir = Path(data_dir, "build", "UploadMultipleBinariesSketchOne")
+        shutil.copytree(build_dir_one, binaries_dir, dirs_exist_ok=True)
+        shutil.copytree(build_dir_two, binaries_dir, dirs_exist_ok=True)
+
+        wait_for_board()
+        # Verifies upload is successful using the binaries with the same name of the containing folder
+        res = run_command(f"upload -b {board.fqbn} -p {board.address} --input-dir {binaries_dir}")
+        assert (
+            "Sketches with .pde extension are deprecated, please rename the following files to .ino:" not in res.stderr
+        )