Implemented support for a root base directory for tests. This root directory is used by the Workspace to "groups" temporary test output files under the same directory.

Author: end2endzone

src/tests/Workspace.cpp

@@ -30,12 +30,13 @@
 
 namespace shellanything
 {
+  std::string Workspace::sRootDirectory;
 
   Workspace::Workspace()
   {
-    std::string temp_dir = ra::filesystem::GetTemporaryDirectoryUtf8();
+    std::string root_dir = (!sRootDirectory.empty() ? sRootDirectory : ra::filesystem::GetTemporaryDirectoryUtf8());
     std::string test_name = ra::testing::GetTestQualifiedName();
-    std::string workspace_dir = temp_dir + "\\" + test_name;
+    std::string workspace_dir = root_dir + "\\" + test_name;
 
     Init(workspace_dir.c_str());
   }
@@ -243,4 +244,14 @@ namespace shellanything
     return source;
   }
 
+  void Workspace::SetPreferedRootDirectoryUtf8(const char* path)
+  {
+    sRootDirectory = path;
+  }
+
+  std::string Workspace::GetPreferedRootDirectoryUtf8()
+  {
+    return sRootDirectory;
+  }
+
 } //namespace shellanything

src/tests/Workspace.h

@@ -95,10 +95,24 @@ namespace shellanything
     /// <returns>Returns the absolute path from the given relative path.</returns>
     std::string GetFullPathUtf8(const char* path) const;
 
+    /// <summary>
+    /// Set the prefered location for a base directory.
+    /// </summary>
+    /// <param name="path">An absolute path to define as the prefered location for a base directory.</param>
+    static void SetPreferedRootDirectoryUtf8(const char* path);
+
+    /// <summary>
+    /// Get the prefered location set for a base directory.
+    /// </summary>
+    /// <param name="path">An absolute path to define as the prefered location for a base directory.</param>
+    /// <returns>Returns the absolute path from the given relative path.</returns>
+    static std::string GetPreferedRootDirectoryUtf8();
+
   private:
     void Init(const char* workspace);
 
   private:
+    static std::string sRootDirectory;
     std::string mWorkspace;
   };
 

src/tests/main.cpp

@@ -36,16 +36,69 @@
 #include "rapidassist/testing.h"
 #include "rapidassist/environment.h"
 #include "rapidassist/cli.h"
-#include "rapidassist/filesystem.h"
+#include "rapidassist/filesystem_utf8.h"
 #include "rapidassist/unicode.h"
+#include "rapidassist/process_utf8.h"
+#include "rapidassist/user_utf8.h"
 
 #include "ArgumentsHandler.h"
 #include "GlogUtils.h"
 #include "SaUtils.h"
 #include "PropertyManager.h"
+#include "Workspace.h"
 
 using namespace ra;
 
+int SetTestPreferedRootDirectory()
+{
+  std::string exec_dir = ra::process::GetCurrentProcessDirUtf8();
+  std::string home_dir = ra::user::GetDocumentsDirectoryUtf8();
+  std::string temp_dir = ra::filesystem::GetTemporaryDirectoryUtf8();
+
+  // Find a suitable write directory
+  std::string writable_dir;
+  if (ra::filesystem::HasDirectoryWriteAccessUtf8(exec_dir.c_str()))
+    writable_dir = exec_dir;
+  else if (ra::filesystem::HasDirectoryWriteAccessUtf8(home_dir.c_str()))
+    writable_dir = home_dir;
+  else if (ra::filesystem::HasDirectoryWriteAccessUtf8(temp_dir.c_str()))
+    writable_dir = temp_dir;
+  else
+  {
+    const char* message = "Failed to find a writable directory to use for tests";
+
+    LOG(ERROR) << message;
+    printf(message);
+    printf("\n");
+
+    return 1;
+  }
+
+  std::string root_dir = writable_dir + ra::filesystem::GetPathSeparatorStr() + "test_workspace";
+
+  // Should we clean root directory first ?
+  if (ra::filesystem::DirectoryExistsUtf8(root_dir.c_str()))
+  {
+    // Directory already exists. Clean it.
+    bool deleted = ra::filesystem::DeleteDirectoryUtf8(root_dir.c_str());
+    if (!deleted)
+    {
+      // hope for the best...
+    }
+  }
+
+  // Create the root directory
+  bool created = ra::filesystem::CreateDirectoryUtf8(root_dir.c_str());
+  if (!created)
+    return 2;
+
+  shellanything::Workspace::SetPreferedRootDirectoryUtf8(root_dir.c_str());
+  printf("Using test directory: '%s'.\n", root_dir.c_str());
+  LOG(INFO) << "Using test directory: '" << root_dir << "'.";
+
+  return 0;
+}
+
 int main(int argc, char** argv)
 {
   // Look for custom command line arguments
@@ -77,6 +130,14 @@ int main(int argc, char** argv)
   pmgr.SetProperty("application.directory", prop_application_directory);
   pmgr.SetProperty("log.directory", prop_log_directory);
 
+  int exit_code = SetTestPreferedRootDirectory();
+  if (exit_code != 0)
+  {
+    // Shutdown Google's logging library.
+    google::ShutdownGoogleLogging();
+    return exit_code;
+  }
+
   LOG(INFO) << "Starting unit tests";
   LOG(INFO) << __FUNCTION__ << "() - BEGIN";