Add test for debug recipe generation

Author: rsora

commands/debug/debug.go

@@ -25,6 +25,7 @@ import (
 	"time"
 
 	"github.com/arduino/arduino-cli/arduino/cores"
+	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
 	"github.com/arduino/arduino-cli/arduino/sketches"
 	"github.com/arduino/arduino-cli/commands"
 	"github.com/arduino/go-paths-helper"
@@ -44,7 +45,8 @@ import (
 func Debug(ctx context.Context, req *dbg.DebugConfigReq, inStream io.Reader, out io.Writer) (*dbg.DebugResp, error) {
 
 	// get tool commandLine from core recipe
-	commandLine, err := getCommandLine(req)
+	pm := commands.GetPackageManager(req.GetInstance().GetId())
+	commandLine, err := getCommandLine(req, pm)
 	if err != nil {
 		return nil, fmt.Errorf("cannot get command line for tool: %s", err)
 	}
@@ -90,7 +92,7 @@ func Debug(ctx context.Context, req *dbg.DebugConfigReq, inStream io.Reader, out
 }
 
 // getCommandLine compose a debug command represented by a core recipe
-func getCommandLine(req *dbg.DebugConfigReq) ([]string, error) {
+func getCommandLine(req *dbg.DebugConfigReq, pm *packagemanager.PackageManager) ([]string, error) {
 	// TODO: make a generic function to extract sketch from request
 	// and remove duplication in commands/compile.go
 	if req.GetSketchPath() == "" {
@@ -120,8 +122,6 @@ func getCommandLine(req *dbg.DebugConfigReq) ([]string, error) {
 		return nil, fmt.Errorf("incorrect FQBN: %s", err)
 	}
 
-	pm := commands.GetPackageManager(req.GetInstance().GetId())
-
 	// Find target board and board properties
 	_, _, board, boardProperties, _, err := pm.ResolveFQBN(fqbn)
 	if err != nil {

commands/debug/debug_test.go

@@ -0,0 +1,86 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to license@arduino.cc.
+
+package debug
+
+import (
+	"fmt"
+	"github.com/arduino/arduino-cli/arduino/cores/packagemanager"
+	rpc "github.com/arduino/arduino-cli/rpc/common"
+	dbg "github.com/arduino/arduino-cli/rpc/debug"
+	"github.com/arduino/go-paths-helper"
+	"github.com/stretchr/testify/assert"
+	"strings"
+	"testing"
+)
+
+var customHardware = paths.New("testdata", "custom_hardware")
+var dataDir = paths.New("testdata", "data_dir", "packages")
+var sketch = "hello"
+var sketchPath = paths.New("testdata", sketch).String()
+
+func TestGetCommandLine(t *testing.T) {
+	pm := packagemanager.NewPackageManager(nil, nil, nil, nil)
+	pm.LoadHardwareFromDirectory(customHardware)
+	pm.LoadHardwareFromDirectory(dataDir)
+
+	req := &dbg.DebugConfigReq{
+		Instance:   &rpc.Instance{Id: 1},
+		Fqbn:       "arduino-test:samd:arduino_zero_edbg",
+		SketchPath: sketchPath,
+		Port:       "none",
+	}
+	packageName := strings.Split(req.Fqbn, ":")[0]
+	processor := strings.Split(req.Fqbn, ":")[1]
+	boardFamily := "arduino_zero"
+
+	goldCommand := []string{
+		fmt.Sprintf("%s/%s/tools/arm-none-eabi-gcc/7-2017q4/bin//arm-none-eabi-gdb", dataDir, packageName),
+		fmt.Sprintf("-ex"),
+		fmt.Sprintf("target extended-remote | %s/%s/tools/openocd/0.10.0-arduino7/bin/openocd", dataDir, packageName) + " " +
+			fmt.Sprintf("-s \"%s/%s/tools/openocd/0.10.0-arduino7/share/openocd/scripts/\"", dataDir, packageName) + " " +
+			fmt.Sprintf("--file \"%s/%s/%s/variants/%s/openocd_scripts/arduino_zero.cfg\" -c \"gdb_port pipe\" -c \"telnet_port 0\" -c init -c halt", customHardware, packageName, processor, boardFamily),
+		fmt.Sprintf("%s/%s.%s.elf", sketchPath, sketch, strings.ReplaceAll(req.Fqbn, ":", ".")),
+	}
+
+	command, err := getCommandLine(req, pm)
+	assert.Nil(t, err)
+	assert.Equal(t, goldCommand, command)
+
+	// for other samd boards
+	req2 := &dbg.DebugConfigReq{
+		Instance:   &rpc.Instance{Id: 1},
+		Fqbn:       "arduino-test:samd:mkr1000",
+		SketchPath: sketchPath,
+		Port:       "none",
+	}
+	packageName2 := strings.Split(req2.Fqbn, ":")[0]
+	processor2 := strings.Split(req2.Fqbn, ":")[1]
+	name2 := strings.Split(req2.Fqbn, ":")[2]
+
+	goldCommand2 := []string{
+		fmt.Sprintf("%s/%s/tools/arm-none-eabi-gcc/7-2017q4/bin//arm-none-eabi-gdb", dataDir, packageName2),
+		fmt.Sprintf("-ex"),
+		fmt.Sprintf("target extended-remote | %s/%s/tools/openocd/0.10.0-arduino7/bin/openocd", dataDir, packageName2) + " " +
+			fmt.Sprintf("-s \"%s/%s/tools/openocd/0.10.0-arduino7/share/openocd/scripts/\"", dataDir, packageName2) + " " +
+			fmt.Sprintf("--file \"%s/%s/%s/variants/%s/openocd_scripts/arduino_zero.cfg\" -c \"gdb_port pipe\" -c \"telnet_port 0\" -c init -c halt", customHardware, packageName2, processor2, name2),
+		fmt.Sprintf("%s/%s.%s.elf", sketchPath, sketch, strings.ReplaceAll(req2.Fqbn, ":", ".")),
+	}
+
+	command2, err := getCommandLine(req2, pm)
+	assert.Nil(t, err)
+	assert.Equal(t, goldCommand2, command2)
+
+}

commands/debug/testdata/.gitignore

@@ -0,0 +1 @@
+!arduino

commands/debug/testdata/custom_hardware/arduino-test/samd/boards.txt

@@ -0,0 +1,114 @@
+# Copyright (c) 2014-2017 Arduino LLC.  All right reserved.
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+# See the GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+# Arduino Zero (Prorgamming Port)
+# ---------------------------------------
+arduino_zero_edbg.name=Arduino Zero (Programming Port)
+arduino_zero_edbg.vid.0=0x03eb
+arduino_zero_edbg.pid.0=0x2157
+
+arduino_zero_edbg.debug.tool=gdb
+arduino_zero_edbg.upload.tool=openocd
+arduino_zero_edbg.upload.protocol=sam-ba
+arduino_zero_edbg.upload.maximum_size=262144
+arduino_zero_edbg.upload.use_1200bps_touch=false
+arduino_zero_edbg.upload.wait_for_upload_port=false
+arduino_zero_edbg.upload.native_usb=false
+arduino_zero_edbg.build.mcu=cortex-m0plus
+arduino_zero_edbg.build.f_cpu=48000000L
+arduino_zero_edbg.build.usb_product="Arduino Zero"
+arduino_zero_edbg.build.usb_manufacturer="Arduino LLC"
+arduino_zero_edbg.build.board=SAMD_ZERO
+arduino_zero_edbg.build.core=arduino
+arduino_zero_edbg.build.extra_flags=-D__SAMD21G18A__ {build.usb_flags}
+arduino_zero_edbg.build.ldscript=linker_scripts/gcc/flash_with_bootloader.ld
+arduino_zero_edbg.build.openocdscript=openocd_scripts/arduino_zero.cfg
+arduino_zero_edbg.build.variant=arduino_zero
+arduino_zero_edbg.build.variant_system_lib=
+arduino_zero_edbg.build.vid=0x2341
+arduino_zero_edbg.build.pid=0x804d
+arduino_zero_edbg.bootloader.tool=openocd
+arduino_zero_edbg.bootloader.file=zero/samd21_sam_ba.bin
+
+# Arduino MKR1000
+# -----------------------
+mkr1000.name=Arduino MKR1000
+mkr1000.vid.0=0x2341
+mkr1000.pid.0=0x804e
+mkr1000.vid.1=0x2341
+mkr1000.pid.1=0x004e
+mkr1000.vid.2=0x2341
+mkr1000.pid.2=0x824e
+mkr1000.vid.3=0x2341
+mkr1000.pid.3=0x024e
+
+mkr1000.debug.tool=gdb
+mkr1000.upload.tool=bossac
+mkr1000.upload.protocol=sam-ba
+mkr1000.upload.maximum_size=262144
+mkr1000.upload.use_1200bps_touch=true
+mkr1000.upload.wait_for_upload_port=true
+mkr1000.upload.native_usb=true
+mkr1000.build.mcu=cortex-m0plus
+mkr1000.build.f_cpu=48000000L
+mkr1000.build.usb_product="Arduino MKR1000"
+mkr1000.build.usb_manufacturer="Arduino LLC"
+mkr1000.build.board=SAMD_MKR1000
+mkr1000.build.core=arduino
+mkr1000.build.extra_flags=-DUSE_ARDUINO_MKR_PIN_LAYOUT -D__SAMD21G18A__ {build.usb_flags}
+mkr1000.build.ldscript=linker_scripts/gcc/flash_with_bootloader.ld
+mkr1000.build.openocdscript=openocd_scripts/arduino_zero.cfg
+mkr1000.build.variant=mkr1000
+mkr1000.build.vid=0x2341
+mkr1000.build.pid=0x804e
+mkr1000.bootloader.tool=openocd
+mkr1000.bootloader.file=mkr1000/samd21_sam_ba_arduino_mkr1000.bin
+
+# Arduino Tian (with) Bootloader
+# ------------------------------
+tian.name=Arduino Tian
+tian.upload.via_ssh=true
+tian.vid.0=0x10C4
+tian.pid.0=0xEA70
+tian.descriptor.0=Enhanced Com Port
+
+tian.upload.tool=avrdude
+#tian.upload.protocol=stk500v2
+tian.upload.protocol=wiring
+tian.upload.maximum_size=262144
+tian.upload.use_1200bps_touch=true
+tian.upload.wait_for_upload_port=true
+tian.upload.native_usb=true
+tian.upload.speed=57600
+tian.build.mcu=cortex-m0plus
+tian.build.f_cpu=48000000L
+tian.build.usb_product="Arduino Tian"
+tian.build.board=SAMD_TIAN
+tian.build.core=arduino
+tian.build.extra_flags=-D__SAMD21G18A__ -mthumb {build.usb_flags}
+tian.build.ldscript=linker_scripts/gcc/flash_with_bootloader.ld
+tian.build.openocdscript=openocd_scripts/arduino_zero.cfg
+tian.build.variant=arduino_mzero
+tian.build.variant_system_lib=
+tian.build.vid=0x2a03
+tian.build.pid=0x8052
+tian.build.preferred_out_format=hex
+tian.bootloader.size=0x4000
+tian.build.emu.mcu=atmega2560
+tian.bootloader.tool=openocd-withbootsize
+tian.bootloader.low_fuses=0xff
+tian.bootloader.file=sofia/Sofia_Tian_151118.hex
+tian.drivers=SiliconLabs-CP2105/Silicon Labs VCP Driver.pkg