Rearrange compile tests to share the same environment

Author: MatteoPologruto

internal/integrationtest/compile/compile_part_1_test.go

@@ -63,6 +63,8 @@ func TestCompile(t *testing.T) {
 		{"OnlyCompilationDatabaseFlag", compileOnlyCompilationDatabaseFlag},
 		{"UsingPlatformLocalTxt", compileUsingPlatformLocalTxt},
 		{"UsingBoardsLocalTxt", compileUsingBoardsLocalTxt},
+		{"WithInvalidBuildOptionJson", compileWithInvalidBuildOptionJson},
+		{"WithRelativeBuildPath", compileWithRelativeBuildPath},
 	}.Run(t, env, cli)
 }
 
@@ -711,3 +713,64 @@ func compileUsingBoardsLocalTxt(t *testing.T, env *integrationtest.Environment,
 	_, _, err = cli.Run("compile", "--clean", "-b", fqbn, sketchPath.String())
 	require.NoError(t, err)
 }
+
+func compileWithInvalidBuildOptionJson(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
+	sketchName := "CompileInvalidBuildOptionsJson"
+	sketchPath := cli.SketchbookDir().Join(sketchName)
+	defer sketchPath.RemoveAll()
+	fqbn := "arduino:avr:uno"
+
+	// Create a test sketch
+	_, _, err := cli.Run("sketch", "new", sketchPath.String())
+	require.NoError(t, err)
+
+	// Get the build directory
+	md5 := md5.Sum(([]byte(sketchPath.String())))
+	sketchPathMd5 := strings.ToUpper(hex.EncodeToString(md5[:]))
+	require.NotEmpty(t, sketchPathMd5)
+	buildDir := paths.TempDir().Join("arduino-sketch-" + sketchPathMd5)
+
+	_, _, err = cli.Run("compile", "-b", fqbn, sketchPath.String(), "--verbose")
+	require.NoError(t, err)
+
+	// Breaks the build.options.json file
+	buildOptionsJson := buildDir.Join("build.options.json")
+	err = buildOptionsJson.WriteFile([]byte("invalid json"))
+	require.NoError(t, err)
+
+	_, _, err = cli.Run("compile", "-b", fqbn, sketchPath.String(), "--verbose")
+	require.NoError(t, err)
+}
+
+func compileWithRelativeBuildPath(t *testing.T, env *integrationtest.Environment, cli *integrationtest.ArduinoCLI) {
+	sketchName := "sketch_simple"
+	sketchPath := cli.CopySketch(sketchName)
+	defer sketchPath.RemoveAll()
+	fqbn := "arduino:avr:uno"
+
+	buildPath := paths.New("..").Join("build_path")
+	newWorkingDir := cli.SketchbookDir().Join("working_dir")
+	err := newWorkingDir.Mkdir()
+	require.NoError(t, err)
+	defer newWorkingDir.RemoveAll()
+	cli.SetWorkingDir(newWorkingDir)
+	_, _, err = cli.Run("compile", "-b", fqbn, "--build-path", buildPath.String(), sketchPath.String(), "-v")
+	require.NoError(t, err)
+	cli.SetWorkingDir(env.RootDir())
+
+	absoluteBuildPath := cli.SketchbookDir().Join("build_path")
+	builtFiles, err := absoluteBuildPath.ReadDir()
+	require.NoError(t, err)
+	require.Contains(t, builtFiles[8].String(), sketchName+".ino.eep")
+	require.Contains(t, builtFiles[9].String(), sketchName+".ino.elf")
+	require.Contains(t, builtFiles[10].String(), sketchName+".ino.hex")
+	require.Contains(t, builtFiles[11].String(), sketchName+".ino.with_bootloader.bin")
+	require.Contains(t, builtFiles[12].String(), sketchName+".ino.with_bootloader.hex")
+	require.Contains(t, builtFiles[0].String(), "build.options.json")
+	require.Contains(t, builtFiles[1].String(), "compile_commands.json")
+	require.Contains(t, builtFiles[2].String(), "core")
+	require.Contains(t, builtFiles[3].String(), "includes.cache")
+	require.Contains(t, builtFiles[4].String(), "libraries")
+	require.Contains(t, builtFiles[6].String(), "preproc")
+	require.Contains(t, builtFiles[7].String(), "sketch")
+}

internal/integrationtest/compile/compile_part_4_test.go

@@ -261,42 +261,6 @@ func TestCompileWithConflictingLibrariesInclude(t *testing.T) {
 	require.Contains(t, string(stdout), expectedOutput[0]+"\n"+expectedOutput[1]+"\n"+expectedOutput[2]+"\n")
 }
 
-func TestCompileWithInvalidBuildOptionJson(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:avr@1.8.3")
-	require.NoError(t, err)
-
-	sketchName := "CompileInvalidBuildOptionsJson"
-	sketchPath := cli.SketchbookDir().Join(sketchName)
-	fqbn := "arduino:avr:uno"
-
-	// Create a test sketch
-	_, _, err = cli.Run("sketch", "new", sketchPath.String())
-	require.NoError(t, err)
-
-	// Get the build directory
-	md5 := md5.Sum(([]byte(sketchPath.String())))
-	sketchPathMd5 := strings.ToUpper(hex.EncodeToString(md5[:]))
-	require.NotEmpty(t, sketchPathMd5)
-	buildDir := paths.TempDir().Join("arduino-sketch-" + sketchPathMd5)
-
-	_, _, err = cli.Run("compile", "-b", fqbn, sketchPath.String(), "--verbose")
-	require.NoError(t, err)
-
-	// Breaks the build.options.json file
-	buildOptionsJson := buildDir.Join("build.options.json")
-	err = buildOptionsJson.WriteFile([]byte("invalid json"))
-	require.NoError(t, err)
-
-	_, _, err = cli.Run("compile", "-b", fqbn, sketchPath.String(), "--verbose")
-	require.NoError(t, err)
-}
-
 func TestCompileWithEsp32BundledLibraries(t *testing.T) {
 	// Some esp cores have have bundled libraries that are optimize for that architecture,
 	// it might happen that if the user has a library with the same name installed conflicts
@@ -449,46 +413,6 @@ func TestCompileSketchWithIppFileInclude(t *testing.T) {
 	require.NoError(t, err)
 }
 
-func TestCompileWithRelativeBuildPath(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:avr@1.8.3")
-	require.NoError(t, err)
-
-	sketchName := "sketch_simple"
-	sketchPath := cli.CopySketch(sketchName)
-	fqbn := "arduino:avr:uno"
-
-	buildPath := paths.New("..").Join("build_path")
-	workingDir := cli.SketchbookDir().Join("working_dir")
-	err = workingDir.Mkdir()
-	require.NoError(t, err)
-	cli.SetWorkingDir(workingDir)
-	_, _, err = cli.Run("compile", "-b", fqbn, "--build-path", buildPath.String(), sketchPath.String(), "-v")
-	require.NoError(t, err)
-	cli.SetWorkingDir(env.RootDir())
-
-	absoluteBuildPath := cli.SketchbookDir().Join("build_path")
-	builtFiles, err := absoluteBuildPath.ReadDir()
-	require.NoError(t, err)
-	require.Contains(t, builtFiles[8].String(), sketchName+".ino.eep")
-	require.Contains(t, builtFiles[9].String(), sketchName+".ino.elf")
-	require.Contains(t, builtFiles[10].String(), sketchName+".ino.hex")
-	require.Contains(t, builtFiles[11].String(), sketchName+".ino.with_bootloader.bin")
-	require.Contains(t, builtFiles[12].String(), sketchName+".ino.with_bootloader.hex")
-	require.Contains(t, builtFiles[0].String(), "build.options.json")
-	require.Contains(t, builtFiles[1].String(), "compile_commands.json")
-	require.Contains(t, builtFiles[2].String(), "core")
-	require.Contains(t, builtFiles[3].String(), "includes.cache")
-	require.Contains(t, builtFiles[4].String(), "libraries")
-	require.Contains(t, builtFiles[6].String(), "preproc")
-	require.Contains(t, builtFiles[7].String(), "sketch")
-}
-
 func TestCompileWithoutUploadAndFqbn(t *testing.T) {
 	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
 	defer env.CleanUp()