Clean up temporary home directory to make tests more robust (backport #3146) (#3150)

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

* Clean up temporary home directory to make tests more robust

Signed-off-by: Addisu Z. Taddese <[email protected]>

* Remove expectation that auto_default.log will exist

This file only exists if the GUI has run. Since each test now starts
with a clean ".gz" directory, this file will not exist when this test
runs.

Signed-off-by: Addisu Z. Taddese <[email protected]>

---------

Signed-off-by: Addisu Z. Taddese <[email protected]>
(cherry picked from commit 83a6331)

# Conflicts:
#	test/integration/log_system.cc

* Resolve merege conflict

Signed-off-by: Arjo Chakravarty <[email protected]>

---------

Signed-off-by: Arjo Chakravarty <[email protected]>
Co-authored-by: Addisu Z. Taddese <[email protected]>
Co-authored-by: Arjo Chakravarty <[email protected]>

Author: 3 people

test/helpers/EnvTestFixture.hh

@@ -47,6 +47,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(IGN_HOMEDIR, this->realHome.c_str()));
   }

test/integration/log_system.cc

@@ -326,12 +326,6 @@ TEST_F(LogSystemTest, IGN_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(IGN_HOMEDIR, homeOrig);
-  std::string homeFake = common::joinPaths(this->logsDir, "default");
-  EXPECT_TRUE(common::setenv(IGN_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 `.ignition` directory
@@ -353,11 +347,8 @@ TEST_F(LogSystemTest, IGN_UTILS_TEST_DISABLED_ON_WIN32(LogDefaults))
     Server recordServer(recordServerConfig);
     recordServer.Run(true, 200, false);
   }
-
   // We should expect to see "auto_default.log"  and "state.tlog"
   EXPECT_FALSE(ignLogDirectory().empty());
-  EXPECT_TRUE(common::exists(
-        common::joinPaths(ignLogDirectory(), "auto_default.log")));
   EXPECT_TRUE(common::exists(
         common::joinPaths(ignLogDirectory(), "state.tlog")));
 
@@ -375,7 +366,7 @@ TEST_F(LogSystemTest, IGN_UTILS_TEST_DISABLED_ON_WIN32(LogDefaults))
   // should be recorded here.
 
   // Store number of files before running
-  auto logPath = common::joinPaths(homeFake.c_str(), ".ignition", "gazebo",
+  auto logPath = common::joinPaths(this->kFakeHome, ".ignition", "gazebo",
       "log");
   int nEntries = entryCount(logPath);
   std::vector<std::string> entriesBefore;
@@ -415,9 +406,6 @@ TEST_F(LogSystemTest, IGN_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(IGN_HOMEDIR, homeOrig.c_str()));
 }
 
 /////////////////////////////////////////////////