Migrate TestCompileAndUploadComboWithCustomBuildPath from test_upload.py to upload_test.go

Author: MatteoPologruto

internal/integrationtest/upload/upload_test.go

@@ -250,3 +250,50 @@ func TestCompileAndUploadCombo(t *testing.T) {
 		runTest(sketchMainFile.String())
 	}
 }
+
+func TestCompileAndUploadComboWithCustomBuildPath(t *testing.T) {
+	if os.Getenv("CI") != "" {
+		t.Skip("VMs have no serial ports")
+	}
+
+	env, cli := integrationtest.CreateArduinoCLIWithEnvironment(t)
+	defer env.CleanUp()
+
+	// Init the environment explicitly
+	_, _, err := cli.Run("core", "update-index")
+	require.NoError(t, err)
+
+	// Create a test sketch
+	sketchName := "CompileAndUploadCustomBuildPathIntegrationTest"
+	sketchPath := cli.SketchbookDir().Join(sketchName)
+	_, _, err = cli.Run("sketch", "new", sketchPath.String())
+	require.NoError(t, err)
+
+	// Build sketch for each detected board
+	for _, board := range detectedBoards(t, cli) {
+		fqbnNormalized := strings.ReplaceAll(board.fqbn, ":", "-")
+		logFileName := fqbnNormalized + "-compile.log"
+		logFilePath := cli.SketchbookDir().Join(logFileName)
+
+		_, _, err = cli.Run("core", "install", board.core)
+		require.NoError(t, err)
+
+		waitForBoard(t, cli)
+
+		buildPath := cli.SketchbookDir().Join("test_dir", fqbnNormalized, "build_dir")
+		_, _, err := cli.Run("compile", "-b", board.fqbn, "--upload", "-p", board.address, "--build-path", buildPath.String(),
+			sketchPath.String(), "--log-format", "json", "--log-file", logFilePath.String(), "--log-level", "trace")
+		require.NoError(t, err)
+		logJson, err := logFilePath.ReadFile()
+		require.NoError(t, err)
+
+		// check from the logs if the bin file were uploaded on the current board
+		logJson = []byte("[" + strings.ReplaceAll(strings.TrimSuffix(string(logJson), "\n"), "\n", ",") + "]")
+		traces := requirejson.Parse(t, logJson).Query("[ .[] | select(.level==\"trace\") | .msg ]").String()
+		traces = strings.ReplaceAll(traces, "\\\\", "\\")
+		require.Contains(t, traces, "Compile "+sketchPath.String()+" for "+board.fqbn+" started")
+		require.Contains(t, traces, "Compile "+sketchName+" for "+board.fqbn+" successful")
+		require.Contains(t, traces, "Upload "+sketchPath.String()+" on "+board.fqbn+" started")
+		require.Contains(t, traces, "Upload successful")
+	}
+}

test/test_upload.py

@@ -42,53 +42,6 @@ def test_upload_after_attach(run_command, data_dir, detected_boards):
         assert run_command(["upload", sketch_path])
 
 
-def test_compile_and_upload_combo_with_custom_build_path(run_command, data_dir, detected_boards, wait_for_board):
-    # Init the environment explicitly
-    run_command(["core", "update-index"])
-
-    # Install required core(s)
-    run_command(["core", "install", "arduino:avr@1.8.3"])
-    run_command(["core", "install", "arduino:samd@1.8.6"])
-
-    sketch_name = "CompileAndUploadCustomBuildPathIntegrationTest"
-    sketch_path = Path(data_dir, sketch_name)
-    assert run_command(["sketch", "new", sketch_path])
-
-    for board in detected_boards:
-        fqbn_normalized = board.fqbn.replace(":", "-")
-        log_file_name = f"{fqbn_normalized}-compile.log"
-        log_file = Path(data_dir, log_file_name)
-        command_log_flags = ["--log-format", "json", "--log-file", log_file, "--log-level", "trace"]
-
-        wait_for_board()
-
-        build_path = Path(data_dir, "test_dir", fqbn_normalized, "build_dir")
-        result = run_command(
-            [
-                "compile",
-                "-b",
-                board.fqbn,
-                "--upload",
-                "-p",
-                board.address,
-                "--build-path",
-                build_path,
-                sketch_path,
-            ]
-            + command_log_flags
-        )
-        print(result.stderr)
-        assert result.ok
-
-        # check from the logs if the bin file were uploaded on the current board
-        log_json = open(log_file, "r")
-        traces = parse_json_traces(log_json.readlines())
-        assert f"Compile {sketch_path} for {board.fqbn} started" in traces
-        assert f"Compile {sketch_name} for {board.fqbn} successful" in traces
-        assert f"Upload {sketch_path} on {board.fqbn} started" in traces
-        assert "Upload successful" in traces
-
-
 def test_compile_and_upload_combo_sketch_with_pde_extension(run_command, data_dir, detected_boards, wait_for_board):
     assert run_command(["update"])