Use consistent working directory for running the tests.

This changes the test suite to always be run from a consistent working
directory, avoiding having per-test workarounds like done on the PCH
tests.

Author: tritao

modules/gmake/tests/cpp/test_make_pch.lua

@@ -17,7 +17,6 @@
 
 	local wks, prj
 	function suite.setup()
-		os.chdir(_TESTS_DIR)
 		wks, prj = test.createWorkspace()
 	end
 
@@ -71,15 +70,32 @@
 
 
 --
--- The PCH can be specified relative the an includes search path.
+-- The PCH can be specified relative to the includes search path.
 --
 
-	function suite.pch_searchesIncludeDirs()
+	function suite.pch_searchesIncludeDirs_location()
 		pchheader "premake.h"
-		includedirs { "../../../src/host" }
+		includedirs { "src/host" }
 		prepareVars()
 		test.capture [[
-  PCH = ../../../src/host/premake.h
+  PCH = src/host/premake.h
+		]]
+	end
+
+
+--
+-- The PCH can be specified relative to the includes search path.
+-- Due to the location being different from _MAIN_SCRIPT_DIR,
+-- the specified PCH path should be relative to the location.
+
+
+	function suite.findsPCH_onIncludeDirs()
+		location "MyProject"
+		pchheader "premake.h"
+		includedirs { "src/host" }
+		prepareVars()
+		test.capture [[
+  PCH = ../src/host/premake.h
 		]]
 	end
 
@@ -123,20 +139,3 @@ $(OBJECTS): | $(OBJDIR)
 endif
 		]]
 	end
-
-
-
-	--
-	-- If the header is located on one of the include file
-	-- search directories, it should get found automatically.
-	--
-
-		function suite.findsPCH_onIncludeDirs()
-			location "MyProject"
-			pchheader "premake.h"
-			includedirs { "../../../src/host" }
-			prepareVars()
-			test.capture [[
-  PCH = ../../../../src/host/premake.h
-			]]
-		end

modules/gmake2/tests/test_gmake2_pch.lua

@@ -20,7 +20,6 @@
 
 	local wks, prj
 	function suite.setup()
-		os.chdir(_TESTS_DIR)
 		gmake2.cpp.initialize()
 		wks, prj = test.createWorkspace()
 	end
@@ -95,15 +94,30 @@ GCH = $(PCH_PLACEHOLDER).gch
 
 
 --
--- The PCH can be specified relative the an includes search path.
+-- The PCH can be specified relative to the includes search path.
 --
 
 	function suite.pch_searchesIncludeDirs()
 		pchheader "premake.h"
-		includedirs { "../../../src/host" }
+		includedirs { "src/host" }
 		prepareVars()
 		test.capture [[
-PCH = ../../../src/host/premake.h
+PCH = src/host/premake.h
+		]]
+	end
+
+--
+-- The PCH can be specified relative to the includes search path.
+-- Due to the location being different from _MAIN_SCRIPT_DIR,
+-- the specified PCH path should be relative to the location.
+
+	function suite.pch_searchesIncludeDirs_location()
+		location "MyProject"
+		pchheader "premake.h"
+		includedirs { "src/host" }
+		prepareVars()
+		test.capture [[
+PCH = ../src/host/premake.h
 		]]
 	end
 
@@ -160,23 +174,6 @@ endif
 		]]
 	end
 
-
-
-	--
-	-- If the header is located on one of the include file
-	-- search directories, it should get found automatically.
-	--
-
-		function suite.findsPCH_onIncludeDirs()
-			location "MyProject"
-			pchheader "premake.h"
-			includedirs { "../../../src/host" }
-			prepareVars()
-			test.capture [[
-PCH = ../../../../src/host/premake.h
-			]]
-		end
-
 --
 -- If the header is located on one of the include file
 -- search directories, it should get found automatically.

modules/self-test/test_runner.lua

@@ -84,6 +84,10 @@
 
 	function _.runTest(test)
 		_.log(term.lightGreen, "[ RUN      ]", string.format(" %s.%s", test.suiteName, test.testName))
+
+		-- Provide a consistent working directory to the tests.
+		os.chdir(_MAIN_SCRIPT_DIR)
+
 		local startTime = os.clock()
 		local cwd = os.getcwd()
 		local hooks = _.installTestingHooks()
@@ -105,7 +109,6 @@
 		err = err or terr
 
 		_.removeTestingHooks(hooks)
-		os.chdir(cwd)
 
 		if ok then
 			_.log(term.lightGreen, "[       OK ]", string.format(" %s.%s (%.0f ms)", test.suiteName, test.testName, (os.clock() - startTime) * 1000))