Change archive command to sketch archive

Author: silvanocerza

cli/cli.go

@@ -21,7 +21,6 @@ import (
 	"os"
 	"strings"
 
-	"github.com/arduino/arduino-cli/cli/archive"
 	"github.com/arduino/arduino-cli/cli/board"
 	"github.com/arduino/arduino-cli/cli/burnbootloader"
 	"github.com/arduino/arduino-cli/cli/cache"
@@ -80,7 +79,6 @@ func NewCommand() *cobra.Command {
 
 // this is here only for testing
 func createCliCommandTree(cmd *cobra.Command) {
-	cmd.AddCommand(archive.NewCommand())
 	cmd.AddCommand(board.NewCommand())
 	cmd.AddCommand(cache.NewCommand())
 	cmd.AddCommand(compile.NewCommand())

cli/archive/archive.go cli/sketch/archive.gocli/archive/archive.go renamed to cli/sketch/archive.go

@@ -13,24 +13,24 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to license@arduino.cc.
 
-package archive
+package sketch
 
 import (
 	"context"
 	"os"
 
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
-	"github.com/arduino/arduino-cli/commands"
+	"github.com/arduino/arduino-cli/commands/sketch"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
 var includeBuildDir bool
 
-// NewCommand creates a new `archive` command
-func NewCommand() *cobra.Command {
+// initArchiveCommand creates a new `archive` command
+func initArchiveCommand() *cobra.Command {
 	command := &cobra.Command{
 		Use:   "archive <sketchPath> <archivePath>",
 		Short: "Creates a zip file containing all sketch files.",
@@ -51,7 +51,7 @@ func NewCommand() *cobra.Command {
 }
 
 func runArchiveCommand(cmd *cobra.Command, args []string) {
-	logrus.Info("Executing `arduino archive`")
+	logrus.Info("Executing `arduino sketch archive`")
 
 	sketchPath := ""
 	if len(args) >= 1 {
@@ -63,7 +63,7 @@ func runArchiveCommand(cmd *cobra.Command, args []string) {
 		archivePath = args[1]
 	}
 
-	_, err := commands.ArchiveSketch(context.Background(),
+	_, err := sketch.ArchiveSketch(context.Background(),
 		&rpc.ArchiveSketchReq{
 			SketchPath:      sketchPath,
 			ArchivePath:     archivePath,

cli/sketch/sketch.go

@@ -31,6 +31,7 @@ func NewCommand() *cobra.Command {
 	}
 
 	cmd.AddCommand(initNewCommand())
+	cmd.AddCommand(initArchiveCommand())
 
 	return cmd
 }

commands/daemon/daemon.go

@@ -26,6 +26,7 @@ import (
 	"github.com/arduino/arduino-cli/commands/compile"
 	"github.com/arduino/arduino-cli/commands/core"
 	"github.com/arduino/arduino-cli/commands/lib"
+	"github.com/arduino/arduino-cli/commands/sketch"
 	"github.com/arduino/arduino-cli/commands/upload"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
 )
@@ -340,5 +341,5 @@ func (s *ArduinoCoreServerImpl) LibraryList(ctx context.Context, req *rpc.Librar
 
 // ArchiveSketch FIXMEDOC
 func (s *ArduinoCoreServerImpl) ArchiveSketch(ctx context.Context, req *rpc.ArchiveSketchReq) (*rpc.ArchiveSketchResp, error) {
-	return commands.ArchiveSketch(ctx, req)
+	return sketch.ArchiveSketch(ctx, req)
 }

commands/instances.go

@@ -16,17 +16,12 @@
 package commands
 
 import (
-	"archive/zip"
 	"context"
 	"errors"
 	"fmt"
-	"io"
 	"io/ioutil"
 	"net/url"
-	"os"
 	"path"
-	"path/filepath"
-	"strings"
 
 	"github.com/arduino/arduino-cli/arduino/builder"
 	"github.com/arduino/arduino-cli/arduino/cores"
@@ -707,151 +702,3 @@ func LoadSketch(ctx context.Context, req *rpc.LoadSketchReq) (*rpc.LoadSketchRes
 		AdditionalFiles:  additionalFiles,
 	}, nil
 }
-
-// ArchiveSketch FIXMEDOC
-func ArchiveSketch(ctx context.Context, req *rpc.ArchiveSketchReq) (*rpc.ArchiveSketchResp, error) {
-	// sketchName is the name of the sketch without extension, for example "MySketch"
-	var sketchName string
-
-	sketchPath := paths.New(req.SketchPath)
-	if sketchPath == nil {
-		sketchPath = paths.New(".")
-	}
-
-	sketchPath, err := sketchPath.Clean().Abs()
-	if err != nil {
-		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")
-	}
-
-	// Checks if it's really a sketch
-	if sketchPath.NotExist() {
-		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, err = archivePath.Clean().Abs()
-	if err != nil {
-		return nil, fmt.Errorf("Error getting absolute archive path %v", err)
-	}
-
-	// Makes archivePath point to a zip file
-	if archivePath.IsDir() {
-		archivePath = archivePath.Join(sketchName + ".zip")
-	} else if archivePath.Ext() == "" {
-		archivePath = paths.New(archivePath.String() + ".zip")
-	}
-
-	if archivePath.Exist() {
-		return nil, fmt.Errorf("archive already exists")
-	}
-
-	archive, err := os.Create(archivePath.Clean().String())
-	if err != nil {
-		return nil, fmt.Errorf("Error creating archive: %v", err)
-	}
-	defer archive.Close()
-
-	zipWriter := zip.NewWriter(archive)
-	defer zipWriter.Close()
-
-	filesToZip, err := getSketchContent(sketchPath.Parent())
-	if err != nil {
-		return nil, fmt.Errorf("Error retrieving sketch files: %v", err)
-	}
-
-	for _, f := range filesToZip {
-
-		if !req.IncludeBuildDir {
-			filePath, err := sketchPath.Parent().Parent().RelTo(f)
-			if err != nil {
-				return nil, fmt.Errorf("Error calculating relative file path: %v", err)
-			}
-
-			// Skips build folder
-			if strings.HasPrefix(filePath.String(), sketchName+string(filepath.Separator)+"build") {
-				continue
-			}
-		}
-
-		// 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())
-		if err != nil {
-			return nil, fmt.Errorf("Error adding file to archive: %v", err)
-		}
-	}
-
-	return &rpc.ArchiveSketchResp{}, nil
-}
-
-// Recursively retrieves all files in the sketch folder
-func getSketchContent(sketchFolder *paths.Path) (paths.PathList, error) {
-	sketchFiles, err := sketchFolder.ReadDir()
-	if err != nil {
-		return nil, err
-	}
-	for _, f := range sketchFiles {
-		if f.IsDir() {
-			files, err := getSketchContent(f)
-			if err != nil {
-				return nil, err
-			}
-
-			sketchFiles = append(sketchFiles, files...)
-		}
-	}
-	finalFiles := paths.PathList{}
-	for _, f := range sketchFiles {
-		if f.IsNotDir() {
-			finalFiles = append(finalFiles, f)
-		}
-	}
-	return finalFiles, nil
-}
-
-// Adds a single file to an existing zip file
-func addFileToSketchArchive(zipWriter *zip.Writer, filePath, sketchPath *paths.Path) error {
-	f, err := filePath.Open()
-	if err != nil {
-		return err
-	}
-	defer f.Close()
-
-	info, err := f.Stat()
-	if err != nil {
-		return err
-	}
-
-	header, err := zip.FileInfoHeader(info)
-	if err != nil {
-		return err
-	}
-
-	filePath, err = sketchPath.RelTo(filePath)
-	if err != nil {
-		return err
-	}
-
-	header.Name = filePath.String()
-	header.Method = zip.Deflate
-
-	writer, err := zipWriter.CreateHeader(header)
-	if err != nil {
-		return err
-	}
-
-	_, err = io.Copy(writer, f)
-	return err
-}