Use subtests to manually install library once

Author: MatteoPologruto

internal/integrationtest/compile/compile_part_4_test.go

@@ -28,63 +28,42 @@ import (
 	"gopkg.in/src-d/go-git.v4/plumbing"
 )
 
-func TestCompileManuallyInstalledPlatformUsingBoardsLocalTxt(t *testing.T) {
+func TestCompilePart4(t *testing.T) {
 	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
 	defer env.CleanUp()
 
 	_, _, err := cli.Run("update")
 	require.NoError(t, err)
 
-	sketchName := "CompileSketchManuallyInstalledPlatformUsingBoardsLocalTxt"
-	sketchPath := cli.SketchbookDir().Join(sketchName)
-	fqbn := "arduino-beta-development:avr:nessuno"
-	_, _, err = cli.Run("sketch", "new", sketchPath.String())
+	_, _, err = cli.Run("core", "install", "arduino:[email protected]")
 	require.NoError(t, err)
 
-	// Manually installs a core in sketchbooks hardware folder
-	gitUrl := "https://github.com/arduino/ArduinoCore-avr.git"
-	repoDir := cli.SketchbookDir().Join("hardware", "arduino-beta-development", "avr")
-	_, err = git.PlainClone(repoDir.String(), false, &git.CloneOptions{
+	// Manually installs a library
+	gitUrl := "https://github.com/arduino-libraries/WiFi101.git"
+	libPath := cli.SketchbookDir().Join("my-libraries", "WiFi101")
+	_, err = git.PlainClone(libPath.String(), false, &git.CloneOptions{
 		URL:           gitUrl,
-		ReferenceName: plumbing.NewTagReferenceName("1.8.3"),
+		ReferenceName: plumbing.NewTagReferenceName("0.16.1"),
 	})
 	require.NoError(t, err)
 
-	// Installs also the same core via CLI so all the necessary tools are installed
-	_, _, err = cli.Run("core", "install", "arduino:[email protected]")
-	require.NoError(t, err)
-
-	// Verifies compilation fails because board doesn't exist
-	_, stderr, err := cli.Run("compile", "--clean", "-b", fqbn, sketchPath.String())
-	require.Error(t, err)
-	require.Contains(t, string(stderr), "Error during build: Error resolving FQBN: board arduino-beta-development:avr:nessuno not found")
-
-	// Use custom boards.local.txt with made arduino:avr:nessuno board
-	boardsLocalTxt := repoDir.Join("boards.local.txt")
-	wd, err := paths.Getwd()
-	require.NoError(t, err)
-	err = wd.Parent().Join("testdata", "boards.local.txt").CopyTo(boardsLocalTxt)
-	require.NoError(t, err)
-
-	_, _, err = cli.Run("compile", "--clean", "-b", fqbn, sketchPath.String())
-	require.NoError(t, err)
+	integrationtest.CLISubtests{
+		{"WithLibrary", compileWithLibrary},
+		{"WithLibraryPriority", compileWithLibraryPriority},
+		{"WithDifferentLibrary", recompileWithDifferentLibrary},
+	}.Run(t, env, cli)
 }
 
-func TestCompileWithLibrary(t *testing.T) {
-	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
-	defer env.CleanUp()
-
-	_, _, err := cli.Run("update")
-	require.NoError(t, err)
-
-	_, _, err = cli.Run("core", "install", "arduino:[email protected]")
-	require.NoError(t, err)
-
+func compileWithLibrary(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
 	sketchName := "CompileSketchWithWiFi101Dependency"
 	sketchPath := cli.SketchbookDir().Join(sketchName)
+	defer sketchPath.RemoveAll()
 	fqbn := "arduino:avr:uno"
+
+	libPath := cli.SketchbookDir().Join("my-libraries", "WiFi101")
+
 	// Create new sketch and add library include
-	_, _, err = cli.Run("sketch", "new", sketchPath.String())
+	_, _, err := cli.Run("sketch", "new", sketchPath.String())
 	require.NoError(t, err)
 	sketchFile := sketchPath.Join(sketchName + ".ino")
 	lines, err := sketchFile.ReadFileAsLines()
@@ -97,46 +76,23 @@ func TestCompileWithLibrary(t *testing.T) {
 	err = sketchFile.WriteFile(data)
 	require.NoError(t, err)
 
-	// Manually installs a library
-	gitUrl := "https://github.com/arduino-libraries/WiFi101.git"
-	libPath := cli.SketchbookDir().Join("my-libraries", "WiFi101")
-	_, err = git.PlainClone(libPath.String(), false, &git.CloneOptions{
-		URL:           gitUrl,
-		ReferenceName: plumbing.NewTagReferenceName("0.16.1"),
-	})
-	require.NoError(t, err)
-
 	stdout, _, err := cli.Run("compile", "-b", fqbn, sketchPath.String(), "--library", libPath.String(), "-v")
 	require.NoError(t, err)
 	require.Contains(t, string(stdout), "WiFi101")
 }
 
-func TestCompileWithLibraryPriority(t *testing.T) {
-	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
-	defer env.CleanUp()
-
-	_, _, err := cli.Run("update")
-	require.NoError(t, err)
-
-	_, _, err = cli.Run("core", "install", "arduino:[email protected]")
-	require.NoError(t, err)
-
+func compileWithLibraryPriority(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
 	sketchName := "CompileSketchWithLibraryPriority"
 	sketchPath := cli.SketchbookDir().Join(sketchName)
+	defer sketchPath.RemoveAll()
 	fqbn := "arduino:avr:uno"
 
-	// Manually installs a library
-	gitUrl := "https://github.com/arduino-libraries/WiFi101.git"
 	manuallyInstalledLibPath := cli.SketchbookDir().Join("my-libraries", "WiFi101")
-	_, err = git.PlainClone(manuallyInstalledLibPath.String(), false, &git.CloneOptions{
-		URL:           gitUrl,
-		ReferenceName: plumbing.NewTagReferenceName("0.16.1"),
-	})
-	require.NoError(t, err)
 
 	// Install the same library we installed manually
-	_, _, err = cli.Run("lib", "install", "WiFi101")
+	_, _, err := cli.Run("lib", "install", "WiFi101")
 	require.NoError(t, err)
+	defer cli.SketchbookDir().Join("libraries").RemoveAll()
 
 	// Create new sketch and add library include
 	_, _, err = cli.Run("sketch", "new", sketchPath.String())
@@ -163,32 +119,18 @@ func TestCompileWithLibraryPriority(t *testing.T) {
 	require.Contains(t, string(stdout), expectedOutput[0]+"\n"+expectedOutput[1]+"\n"+expectedOutput[2]+"\n")
 }
 
-func TestRecompileWithDifferentLibrary(t *testing.T) {
-	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
-	defer env.CleanUp()
-
-	_, _, err := cli.Run("update")
-	require.NoError(t, err)
-
-	_, _, err = cli.Run("core", "install", "arduino:[email protected]")
-	require.NoError(t, err)
-
+func recompileWithDifferentLibrary(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
 	sketchName := "RecompileCompileSketchWithDifferentLibrary"
 	sketchPath := cli.SketchbookDir().Join(sketchName)
+	defer sketchPath.RemoveAll()
 	fqbn := "arduino:avr:uno"
 
 	// Install library
-	_, _, err = cli.Run("lib", "install", "WiFi101")
+	_, _, err := cli.Run("lib", "install", "WiFi101")
 	require.NoError(t, err)
+	defer cli.SketchbookDir().Join("libraries").RemoveAll()
 
-	// Manually installs a library
-	gitUrl := "https://github.com/arduino-libraries/WiFi101.git"
 	manuallyInstalledLibPath := cli.SketchbookDir().Join("my-libraries", "WiFi101")
-	_, err = git.PlainClone(manuallyInstalledLibPath.String(), false, &git.CloneOptions{
-		URL:           gitUrl,
-		ReferenceName: plumbing.NewTagReferenceName("0.16.1"),
-	})
-	require.NoError(t, err)
 
 	// Create new sketch and add library include
 	_, _, err = cli.Run("sketch", "new", sketchPath.String())
@@ -221,6 +163,48 @@ func TestRecompileWithDifferentLibrary(t *testing.T) {
 	require.NotContains(t, string(stdout), "Using previously compiled file: "+objPath.String())
 }
 
+func TestCompileManuallyInstalledPlatformUsingBoardsLocalTxt(t *testing.T) {
+	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
+	defer env.CleanUp()
+
+	_, _, err := cli.Run("update")
+	require.NoError(t, err)
+
+	sketchName := "CompileSketchManuallyInstalledPlatformUsingBoardsLocalTxt"
+	sketchPath := cli.SketchbookDir().Join(sketchName)
+	fqbn := "arduino-beta-development:avr:nessuno"
+	_, _, err = cli.Run("sketch", "new", sketchPath.String())
+	require.NoError(t, err)
+
+	// Manually installs a core in sketchbooks hardware folder
+	gitUrl := "https://github.com/arduino/ArduinoCore-avr.git"
+	repoDir := cli.SketchbookDir().Join("hardware", "arduino-beta-development", "avr")
+	_, err = git.PlainClone(repoDir.String(), false, &git.CloneOptions{
+		URL:           gitUrl,
+		ReferenceName: plumbing.NewTagReferenceName("1.8.3"),
+	})
+	require.NoError(t, err)
+
+	// Installs also the same core via CLI so all the necessary tools are installed
+	_, _, err = cli.Run("core", "install", "arduino:[email protected]")
+	require.NoError(t, err)
+
+	// Verifies compilation fails because board doesn't exist
+	_, stderr, err := cli.Run("compile", "--clean", "-b", fqbn, sketchPath.String())
+	require.Error(t, err)
+	require.Contains(t, string(stderr), "Error during build: Error resolving FQBN: board arduino-beta-development:avr:nessuno not found")
+
+	// Use custom boards.local.txt with made arduino:avr:nessuno board
+	boardsLocalTxt := repoDir.Join("boards.local.txt")
+	wd, err := paths.Getwd()
+	require.NoError(t, err)
+	err = wd.Parent().Join("testdata", "boards.local.txt").CopyTo(boardsLocalTxt)
+	require.NoError(t, err)
+
+	_, _, err = cli.Run("compile", "--clean", "-b", fqbn, sketchPath.String())
+	require.NoError(t, err)
+}
+
 func TestCompileWithConflictingLibrariesInclude(t *testing.T) {
 	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
 	defer env.CleanUp()