internal tests launch executable on every test run

[matthiaskrgr]

There is something strange in the cargo tests.
On every run, it launches a third party program (calibre) to open some documents.
To reproduce, run cargo test workspace_open in the cargo repo.
The behavior is caused by these tests:

doc::doc_workspace_open_different_library_and_package_names
doc::doc_workspace_open_binary
doc::doc_workspace_open_binary_and_library

This is annoying when running the test suit because I have to close 3 windows after every run.

[matthiaskrgr]

Probably caused by cargo doc --open

cargo/tests/testsuite/doc.rs

Line 991 in 9ab347d

p.cargo("doc --all --open")

cc @dwijnand

[dwijnand]

I touched that line last for test suite cleanup reasons, @debris is the original author (#5024).

Perhaps this behaviour is due to the change to --open in #5888 by @Seeker14491?

[Seeker14491]

I see the problem.

cargo/tests/testsuite/doc.rs

Lines 1028 to 1032 in 9ab347d

	p.cargo("doc --open")
	.env("BROWSER", "echo")
	.with_stderr_contains("[..] Documenting foo v0.1.0 ([..])")
	.with_stderr_contains("[..] CWD/target/doc/foolib/index.html")
	.run();

We set the BROWSER environment variable to echo, which would previously override what program cargo doc --open would use to open the generated docs. This behavior was removed with my changes in #5888; the xdg-open script is always used now, and completely handles finding a program. xdg-open does look at the BROWSER environment variable, but only as a fallback.

A note: the previous behavior of the BROWSER override was not implemented on Windows or Mac, which is why these tests all have the cfg

cargo/tests/testsuite/doc.rs

Line 1007 in 9ab347d

#[cfg(not(any(target_os = "windows", target_os = "macos")))]

I'm not sure what the best way to fix these tests would be. Even if the override were implemented, it really wouldn't be testing the normal operation of the --open flag, which is opening in the user's default browser.

[jonas-schievink]

I just hit this too. I was really irritated when the test suite suddenly opened Firefox.

[ehuss]

There is more discussion at #6064. I think cargo should be using the BROWSER env var if it is set.