Add tests loading Sketch with symlinks

silvanocerza · silvanocerza · commit 69ef64b179b3 · 2021-07-12T17:30:33.000+02:00
diff --git a/arduino/sketch/sketch_test.go b/arduino/sketch/sketch_test.go
@@ -300,3 +300,39 @@ func TestCheckForPdeFiles(t *testing.T) {
 	require.Len(t, files, 1)
 	require.Equal(t, sketchPath.Parent().Join("SketchMultipleMainFiles.pde"), files[0])
 }
+
+func TestNewSketchWithSymlink(t *testing.T) {
+	sketchPath, _ := paths.New("testdata", "SketchWithSymlink").Abs()
+	mainFilePath := sketchPath.Join("SketchWithSymlink.ino")
+	helperFilePath := sketchPath.Join("some_folder", "helper.h")
+	helperFileSymlinkPath := sketchPath.Join("src", "helper.h")
+	srcPath := sketchPath.Join("src")
+
+	// Create a symlink in the Sketch folder
+	os.Symlink(sketchPath.Join("some_folder").String(), srcPath.String())
+	defer srcPath.Remove()
+
+	sketch, err := New(sketchPath)
+	require.NoError(t, err)
+	require.NotNil(t, sketch)
+	require.True(t, sketch.MainFile.EquivalentTo(mainFilePath))
+	require.True(t, sketch.FullPath.EquivalentTo(sketchPath))
+	require.Equal(t, sketch.OtherSketchFiles.Len(), 0)
+	require.Equal(t, sketch.AdditionalFiles.Len(), 2)
+	require.True(t, sketch.AdditionalFiles.Contains(helperFilePath))
+	require.True(t, sketch.AdditionalFiles.Contains(helperFileSymlinkPath))
+	require.Equal(t, sketch.RootFolderFiles.Len(), 0)
+}
+
+func TestNewSketchWithSymlinkLoop(t *testing.T) {
+	sketchPath, _ := paths.New("testdata", "SketchWithSymlinkLoop").Abs()
+	someSymlinkPath := sketchPath.Join("some_folder", "some_symlink")
+
+	// Create a recursive Sketch symlink
+	os.Symlink(sketchPath.String(), someSymlinkPath.String())
+	defer someSymlinkPath.Remove()
+
+	sketch, err := New(sketchPath)
+	require.Error(t, err)
+	require.Nil(t, sketch)
+}
diff --git a/arduino/sketch/testdata/SketchWithSymlink/SketchWithSymlink.ino b/arduino/sketch/testdata/SketchWithSymlink/SketchWithSymlink.ino
@@ -0,0 +1,2 @@
+void setup() { }
+void loop() { }
diff --git a/arduino/sketch/testdata/SketchWithSymlink/some_folder/helper.h b/arduino/sketch/testdata/SketchWithSymlink/some_folder/helper.h
diff --git a/arduino/sketch/testdata/SketchWithSymlinkLoop/SketchWithSymlinkLoop.ino b/arduino/sketch/testdata/SketchWithSymlinkLoop/SketchWithSymlinkLoop.ino
@@ -0,0 +1,2 @@
+void setup() { }
+void loop() { }
diff --git a/arduino/sketch/testdata/SketchWithSymlinkLoop/some_folder/helper.h b/arduino/sketch/testdata/SketchWithSymlinkLoop/some_folder/helper.h
diff --git a/docsgen/go.mod b/docsgen/go.mod
@@ -6,5 +6,6 @@ replace github.com/arduino/arduino-cli => ../
 
 require (
 	github.com/arduino/arduino-cli v0.0.0
+	github.com/arduino/go-paths-helper v1.6.1 // indirect
 	github.com/spf13/cobra v1.0.1-0.20200710201246-675ae5f5a98c
 )
diff --git a/docsgen/go.sum b/docsgen/go.sum
@@ -16,6 +16,8 @@ github.com/arduino/go-paths-helper v1.0.1/go.mod h1:HpxtKph+g238EJHq4geEPv9p+gl3
 github.com/arduino/go-paths-helper v1.2.0/go.mod h1:HpxtKph+g238EJHq4geEPv9p+gl3v5YYu35Yb+w31Ck=
 github.com/arduino/go-paths-helper v1.6.0 h1:S7/d7DqB9XlnvF9KrgSiGmo2oWKmYW6O/DTjj3Bijx4=
 github.com/arduino/go-paths-helper v1.6.0/go.mod h1:V82BWgAAp4IbmlybxQdk9Bpkz8M4Qyx+RAFKaG9NuvU=
+github.com/arduino/go-paths-helper v1.6.1 h1:lha+/BuuBsx0qTZ3gy6IO1kU23lObWdQ/UItkzVWQ+0=
+github.com/arduino/go-paths-helper v1.6.1/go.mod h1:V82BWgAAp4IbmlybxQdk9Bpkz8M4Qyx+RAFKaG9NuvU=
 github.com/arduino/go-properties-orderedmap v1.3.0 h1:4No/vQopB36e7WUIk6H6TxiSEJPiMrVOCZylYmua39o=
 github.com/arduino/go-properties-orderedmap v1.3.0/go.mod h1:DKjD2VXY/NZmlingh4lSFMEYCVubfeArCsGPGDwb2yk=
 github.com/arduino/go-properties-orderedmap v1.5.0 h1:istmr13qQN3nneuU3lsqlMvI6jqB3u8QUfVU1tX/t/8=
diff --git a/go.mod b/go.mod
@@ -4,7 +4,7 @@ go 1.14
 
 require (
 	github.com/arduino/board-discovery v0.0.0-20180823133458-1ba29327fb0c
-	github.com/arduino/go-paths-helper v1.6.0
+	github.com/arduino/go-paths-helper v1.6.1
 	github.com/arduino/go-properties-orderedmap v1.5.0
 	github.com/arduino/go-timeutils v0.0.0-20171220113728-d1dd9e313b1b
 	github.com/arduino/go-win32-utils v0.0.0-20180330194947-ed041402e83b
diff --git a/go.sum b/go.sum
@@ -20,6 +20,8 @@ github.com/arduino/go-paths-helper v1.5.0 h1:RVo189hD+GhUS1rQ3gixwK1nSbvVR8MGIGa
 github.com/arduino/go-paths-helper v1.5.0/go.mod h1:V82BWgAAp4IbmlybxQdk9Bpkz8M4Qyx+RAFKaG9NuvU=
 github.com/arduino/go-paths-helper v1.6.0 h1:S7/d7DqB9XlnvF9KrgSiGmo2oWKmYW6O/DTjj3Bijx4=
 github.com/arduino/go-paths-helper v1.6.0/go.mod h1:V82BWgAAp4IbmlybxQdk9Bpkz8M4Qyx+RAFKaG9NuvU=
+github.com/arduino/go-paths-helper v1.6.1 h1:lha+/BuuBsx0qTZ3gy6IO1kU23lObWdQ/UItkzVWQ+0=
+github.com/arduino/go-paths-helper v1.6.1/go.mod h1:V82BWgAAp4IbmlybxQdk9Bpkz8M4Qyx+RAFKaG9NuvU=
 github.com/arduino/go-properties-orderedmap v1.3.0 h1:4No/vQopB36e7WUIk6H6TxiSEJPiMrVOCZylYmua39o=
 github.com/arduino/go-properties-orderedmap v1.3.0/go.mod h1:DKjD2VXY/NZmlingh4lSFMEYCVubfeArCsGPGDwb2yk=
 github.com/arduino/go-properties-orderedmap v1.5.0 h1:istmr13qQN3nneuU3lsqlMvI6jqB3u8QUfVU1tX/t/8=

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+void setup() { }`
	`2`	`+void loop() { }`
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,6 @@ replace github.com/arduino/arduino-cli => ../`
`6`	`6`
`7`	`7`	`require (`
`8`	`8`	`github.com/arduino/arduino-cli v0.0.0`
	`9`	`+ github.com/arduino/go-paths-helper v1.6.1 // indirect`
`9`	`10`	`github.com/spf13/cobra v1.0.1-0.20200710201246-675ae5f5a98c`
`10`	`11`	`)`
-Original file line number
+Diff line change
 require (
 	github.com/arduino/board-discovery v0.0.0-20180823133458-1ba29327fb0c
 -	github.com/arduino/go-paths-helper v1.6.0
 +	github.com/arduino/go-paths-helper v1.6.1
 	github.com/arduino/go-properties-orderedmap v1.5.0
 	github.com/arduino/go-timeutils v0.0.0-20171220113728-d1dd9e313b1b
 	github.com/arduino/go-win32-utils v0.0.0-20180330194947-ed041402e83b