Skip to content

Clean up temporary home directory to make tests more robust #3146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 23, 2025
+4 −13
Merged

Clean up temporary home directory to make tests more robust #3146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7d94b9
Clean up temporary home directory to make tests more robust
azeey Oct 23, 2025
aac799e
Remove expectation that auto_default.log will exist
azeey Oct 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions test/helpers/EnvTestFixture.hh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ class InternalFixture : public TestType
// Documentation inherited
protected: void TearDown() override
{
// Clean up fake home directory so that subsequent tests run on a clean slate.
common::removeAll(this->kFakeHome);
// Restore $HOME
EXPECT_TRUE(common::setenv(GZ_HOMEDIR, this->realHome.c_str()));
}
Expand Down
15 changes: 2 additions & 13 deletions test/integration/log_system.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,12 +331,6 @@ TEST_F(LogSystemTest, GZ_UTILS_TEST_DISABLED_ON_WIN32(LogDefaults))
std::string(PROJECT_SOURCE_PATH), "test", "worlds",
"log_record_dbl_pendulum.sdf");

// Change environment variable so that test files aren't written to $HOME
std::string homeOrig;
common::env(GZ_HOMEDIR, homeOrig);
std::string homeFake = common::joinPaths(this->logsDir, "default");
EXPECT_TRUE(common::setenv(GZ_HOMEDIR, homeFake.c_str()));

// Test case 1:
// No path specified on command line. This does not go through
// gz.cc, recording should take place in the `.gz` directory
Expand All @@ -359,10 +353,8 @@ TEST_F(LogSystemTest, GZ_UTILS_TEST_DISABLED_ON_WIN32(LogDefaults))
recordServer.Run(true, 200, false);
}

// We should expect to see "auto_default.log" and "state.tlog"
// We should expect to see "state.tlog"
EXPECT_FALSE(gzLogDirectory().empty());
EXPECT_TRUE(common::exists(
common::joinPaths(gzLogDirectory(), "auto_default.log")));
EXPECT_TRUE(common::exists(
common::joinPaths(gzLogDirectory(), "state.tlog")));

Expand All @@ -380,7 +372,7 @@ TEST_F(LogSystemTest, GZ_UTILS_TEST_DISABLED_ON_WIN32(LogDefaults))
// should be recorded here.

// Store number of files before running
auto logPath = common::joinPaths(homeFake.c_str(), ".gz", "sim",
auto logPath = common::joinPaths(this->kFakeHome, ".gz", "sim",
"log");
int nEntries = entryCount(logPath);
std::vector<std::string> entriesBefore;
Expand Down Expand Up @@ -420,9 +412,6 @@ TEST_F(LogSystemTest, GZ_UTILS_TEST_DISABLED_ON_WIN32(LogDefaults))
// Remove artifacts. Recreate new directory
this->RemoveLogsDir();
#endif

// Revert environment variable after test is done
EXPECT_TRUE(common::setenv(GZ_HOMEDIR, homeOrig.c_str()));
}

/////////////////////////////////////////////////
Expand Down
Loading