Archive command now works with sketches containing .pde files

Author: silvanocerza

cli/sketch/archive.go

@@ -19,10 +19,12 @@ 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/commands/sketch"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
+	"github.com/arduino/go-paths-helper"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
@@ -53,11 +55,19 @@ func initArchiveCommand() *cobra.Command {
 func runArchiveCommand(cmd *cobra.Command, args []string) {
 	logrus.Info("Executing `arduino sketch archive`")
 
-	sketchPath := ""
+	sketchPath := "."
 	if len(args) >= 1 {
 		sketchPath = args[0]
 	}
 
+	// .pde files are still supported but deprecated, this warning urges the user to rename them
+	if files := sketches.CheckForPdeFiles(paths.New(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)
+		}
+	}
+
 	archivePath := ""
 	if len(args) == 2 {
 		archivePath = args[1]

commands/sketch/archive.go

@@ -23,8 +23,10 @@ import (
 	"path/filepath"
 	"strings"
 
+	"github.com/arduino/arduino-cli/arduino/globals"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
 	paths "github.com/arduino/go-paths-helper"
+	"github.com/pkg/errors"
 )
 
 // ArchiveSketch FIXMEDOC
@@ -42,22 +44,38 @@ func ArchiveSketch(ctx context.Context, req *rpc.ArchiveSketchReq) (*rpc.Archive
 		return nil, fmt.Errorf("Error getting absolute sketch path %v", err)
 	}
 
-	// Get the sketch name and make sketchPath point to the ino file
-	if sketchPath.IsDir() {
-		sketchName = sketchPath.Base()
-		sketchPath = sketchPath.Join(sketchName + ".ino")
-	} else if sketchPath.Ext() == ".ino" {
-		sketchName = strings.TrimSuffix(sketchPath.Base(), ".ino")
+	// Make sketchPath point to the sketch folder
+	if sketchPath.IsNotDir() {
+		sketchPath = sketchPath.Parent()
+	}
+
+	sketchName = sketchPath.Base()
+
+	// sketchMainFile is the path to the sketch main file
+	var sketchMainFile *paths.Path
+
+	for ext := range globals.MainFileValidExtensions {
+		candidateSketchMainFile := sketchPath.Join(sketchPath.Base() + ext)
+		if candidateSketchMainFile.Exist() {
+			if sketchMainFile == nil {
+				sketchMainFile = candidateSketchMainFile
+			} else {
+				return nil, errors.Errorf("multiple main sketch files found (%v, %v)",
+					sketchMainFile,
+					candidateSketchMainFile,
+				)
+			}
+		}
 	}
 
 	// Checks if it's really a sketch
-	if sketchPath.NotExist() {
+	if sketchMainFile == nil {
 		return nil, fmt.Errorf("specified path is not a sketch: %v", sketchPath.String())
 	}
 
 	archivePath := paths.New(req.ArchivePath)
 	if archivePath == nil {
-		archivePath = sketchPath.Parent().Parent()
+		archivePath = sketchPath.Parent()
 	}
 
 	archivePath, err = archivePath.Clean().Abs()
@@ -76,7 +94,7 @@ func ArchiveSketch(ctx context.Context, req *rpc.ArchiveSketchReq) (*rpc.Archive
 		return nil, fmt.Errorf("archive already exists")
 	}
 
-	filesToZip, err := sketchPath.Parent().ReadDirRecursive()
+	filesToZip, err := sketchPath.ReadDirRecursive()
 	if err != nil {
 		return nil, fmt.Errorf("Error retrieving sketch files: %v", err)
 	}
@@ -94,7 +112,7 @@ func ArchiveSketch(ctx context.Context, req *rpc.ArchiveSketchReq) (*rpc.Archive
 	for _, f := range filesToZip {
 
 		if !req.IncludeBuildDir {
-			filePath, err := sketchPath.Parent().Parent().RelTo(f)
+			filePath, err := sketchPath.Parent().RelTo(f)
 			if err != nil {
 				return nil, fmt.Errorf("Error calculating relative file path: %v", err)
 			}
@@ -107,7 +125,7 @@ func ArchiveSketch(ctx context.Context, req *rpc.ArchiveSketchReq) (*rpc.Archive
 
 		// We get the parent path since we want the archive to unpack as a folder.
 		// If we don't do this the archive would contain all the sketch files as top level.
-		err = addFileToSketchArchive(zipWriter, f, sketchPath.Parent().Parent())
+		err = addFileToSketchArchive(zipWriter, f, sketchPath.Parent())
 		if err != nil {
 			return nil, fmt.Errorf("Error adding file to archive: %v", err)
 		}

test/test_sketch.py

@@ -818,3 +818,31 @@ def test_sketch_archive_absolute_sketch_path_with_absolute_zip_path_and_name_wit
     verify_zip_contains_sketch_including_build_dir(archive_files)
 
     archive.close()
+
+
+def test_sketch_archive_with_pde_main_file(run_command, copy_sketch, working_dir):
+    sketch_name = "sketch_pde_main_file"
+    sketch_dir = copy_sketch(sketch_name)
+    sketch_file = Path(sketch_dir, f"{sketch_name}.pde")
+    res = run_command("sketch archive", sketch_dir)
+    assert res.ok
+    assert "Sketches with .pde extension are deprecated, please rename the following files to .ino" in res.stderr
+    assert str(sketch_file.relative_to(sketch_dir)) in res.stderr
+
+    archive = zipfile.ZipFile(f"{working_dir}/{sketch_name}.zip")
+    archive_files = archive.namelist()
+
+    assert f"{sketch_name}/{sketch_name}.pde" in archive_files
+
+    archive.close()
+
+
+def test_sketch_archive_with_multiple_main_files(run_command, copy_sketch, working_dir):
+    sketch_name = "sketch_multiple_main_files"
+    sketch_dir = copy_sketch(sketch_name)
+    sketch_file = Path(sketch_dir, f"{sketch_name}.pde")
+    res = run_command("sketch archive", sketch_dir)
+    assert res.failed
+    assert "Sketches with .pde extension are deprecated, please rename the following files to .ino" in res.stderr
+    assert str(sketch_file.relative_to(sketch_dir)) in res.stderr
+    assert "Error archiving: multiple main sketch files found" in res.stderr

test/testdata/sketch_multiple_main_files/sketch_multiple_main_files.ino

@@ -0,0 +1,3 @@
+void setup() { }
+
+void loop() { }

test/testdata/sketch_multiple_main_files/sketch_multiple_main_files.pde

@@ -0,0 +1,3 @@
+void setup() { }
+
+void loop() { }

test/testdata/sketch_pde_main_file/sketch_pde_main_file.pde

@@ -0,0 +1,3 @@
+void setup() { }
+
+void loop() { }