Code/UnitTests/FoundationTest/IO/FileSystemTest.cpp - dev - redgpu/ezEngine

Code/UnitTests/FoundationTest/IO/FileSystemTest.cpp
366 строк13 KB
Jan Krassnigg
Further refactor of platform specific code (2) (#1416)
25 окт 2024, 17:01
25 окт 2024, 17:01b3eeda7
#include <FoundationTest/FoundationTestPCH.h>

#include <Foundation/IO/FileSystem/DataDirTypeFolder.h>
#include <Foundation/IO/FileSystem/FileReader.h>
#include <Foundation/IO/FileSystem/FileSystem.h>
#include <Foundation/IO/FileSystem/FileWriter.h>

#if EZ_ENABLED(EZ_SUPPORTS_LONG_PATHS)
#  define LongPath                                                                                                                                   \
    "AVeryLongSubFolderPathNameThatShouldExceedThePathLengthLimitOnPlatformsLikeWindowsWhereOnly260CharactersAreAllowedOhNoesIStillNeedMoreThisIsNo" \
    "tLongEnoughAaaaaaaaaaaaaaahhhhStillTooShortAaaaaaaaaaaaaaaaaaaaaahImBoredNow"
#else
#  define LongPath "AShortPathBecaueThisPlatformDoesntSupportLongOnes"
#endif

EZ_CREATE_SIMPLE_TEST(IO, FileSystem)
{
  ezStringBuilder sFileContent = "Lyrics to Taste The Cake:\n\
Turret: Who's there?\n\
Turret: Is anyone there?\n\
Turret: I see you.\n\
\n\
Chell rises from a stasis inside of a glass box\n\
She isn't greeted by faces,\n\
Only concrete and clocks.\n\
...";

  ezStringBuilder szOutputFolder = ezTestFramework::GetInstance()->GetAbsOutputPath();
  szOutputFolder.MakeCleanPath();

  ezStringBuilder sOutputFolderResolved;
  ezFileSystem::ResolveSpecialDirectory(szOutputFolder, sOutputFolderResolved).IgnoreResult();

  ezStringBuilder sOutputFolder1 = szOutputFolder;
  sOutputFolder1.AppendPath("IO", "SubFolder");
  ezStringBuilder sOutputFolder1Resolved;
  ezFileSystem::ResolveSpecialDirectory(sOutputFolder1, sOutputFolder1Resolved).IgnoreResult();

  ezStringBuilder sOutputFolder2 = szOutputFolder;
  sOutputFolder2.AppendPath("IO", "SubFolder2");
  ezStringBuilder sOutputFolder2Resolved;
  ezFileSystem::ResolveSpecialDirectory(sOutputFolder2, sOutputFolder2Resolved).IgnoreResult();

  EZ_TEST_BLOCK(ezTestBlock::Enabled, "Setup Data Dirs")
  {
    // adding the same factory three times would actually not make a difference
    ezFileSystem::RegisterDataDirectoryFactory(ezDataDirectory::FolderType::Factory);
    ezFileSystem::RegisterDataDirectoryFactory(ezDataDirectory::FolderType::Factory);
    ezFileSystem::RegisterDataDirectoryFactory(ezDataDirectory::FolderType::Factory);

    // ezFileSystem::ClearAllDataDirectoryFactories();

    ezFileSystem::RegisterDataDirectoryFactory(ezDataDirectory::FolderType::Factory);

    // for absolute paths
    EZ_TEST_BOOL(ezFileSystem::AddDataDirectory("", "", ":", ezDataDirUsage::AllowWrites) == EZ_SUCCESS);
    EZ_TEST_BOOL(ezFileSystem::AddDataDirectory(szOutputFolder, "Clear", "output", ezDataDirUsage::AllowWrites) == EZ_SUCCESS);

    ezStringBuilder sTempFile = sOutputFolder1Resolved;
    sTempFile.AppendPath(LongPath);
    sTempFile.AppendPath("Temp.tmp");

    ezFileWriter TempFile;
    EZ_TEST_BOOL(TempFile.Open(sTempFile) == EZ_SUCCESS);
    TempFile.Close();

    sTempFile = sOutputFolder2Resolved;
    sTempFile.AppendPath("Temp.tmp");

    EZ_TEST_BOOL(TempFile.Open(sTempFile) == EZ_SUCCESS);
    TempFile.Close();

    EZ_TEST_BOOL(ezFileSystem::AddDataDirectory(sOutputFolder1, "Clear", "output1", ezDataDirUsage::AllowWrites) == EZ_SUCCESS);
    EZ_TEST_BOOL(ezFileSystem::AddDataDirectory(sOutputFolder2, "Clear") == EZ_SUCCESS);

    EZ_TEST_BOOL(ezFileSystem::AddDataDirectory(sOutputFolder2, "Remove", "output2", ezDataDirUsage::AllowWrites) == EZ_SUCCESS);
    EZ_TEST_BOOL(ezFileSystem::AddDataDirectory(sOutputFolder1, "Remove") == EZ_SUCCESS);
    EZ_TEST_BOOL(ezFileSystem::AddDataDirectory(sOutputFolder2, "Remove") == EZ_SUCCESS);

    EZ_TEST_INT(ezFileSystem::RemoveDataDirectoryGroup("Remove"), 3);

    EZ_TEST_BOOL(ezFileSystem::AddDataDirectory(sOutputFolder2, "Remove", "output2", ezDataDirUsage::AllowWrites) == EZ_SUCCESS);
    EZ_TEST_BOOL(ezFileSystem::AddDataDirectory(sOutputFolder1, "Remove") == EZ_SUCCESS);
    EZ_TEST_BOOL(ezFileSystem::AddDataDirectory(sOutputFolder2, "Remove") == EZ_SUCCESS);

    ezFileSystem::ClearAllDataDirectories();

    EZ_TEST_INT(ezFileSystem::RemoveDataDirectoryGroup("Remove"), 0);
    EZ_TEST_INT(ezFileSystem::RemoveDataDirectoryGroup("Clear"), 0);

    EZ_TEST_BOOL(ezFileSystem::AddDataDirectory(sOutputFolder1, "", "output1", ezDataDirUsage::AllowWrites) == EZ_SUCCESS);
    EZ_TEST_BOOL(ezFileSystem::AddDataDirectory(sOutputFolder2) == EZ_SUCCESS);
  }

  EZ_TEST_BLOCK(ezTestBlock::Enabled, "Add / Remove Data Dirs")
  {
    EZ_TEST_BOOL(ezFileSystem::AddDataDirectory("", "xyz-rooted", "xyz", ezDataDirUsage::AllowWrites) == EZ_SUCCESS);

    EZ_TEST_BOOL(ezFileSystem::FindDataDirectoryWithRoot("xyz") != nullptr);

    EZ_TEST_BOOL(ezFileSystem::RemoveDataDirectory("xyz") == true);

    EZ_TEST_BOOL(ezFileSystem::FindDataDirectoryWithRoot("xyz") == nullptr);

    EZ_TEST_BOOL(ezFileSystem::RemoveDataDirectory("xyz") == false);
  }

  EZ_TEST_BLOCK(ezTestBlock::Enabled, "Write File")
  {
    ezFileWriter FileOut;

    ezStringBuilder sAbs = sOutputFolder1Resolved;
    sAbs.AppendPath("FileSystemTest.txt");

    EZ_TEST_BOOL(FileOut.Open(":output1/FileSystemTest.txt") == EZ_SUCCESS);

    EZ_TEST_STRING(FileOut.GetFilePathRelative(), "FileSystemTest.txt");
    EZ_TEST_STRING(FileOut.GetFilePathAbsolute(), sAbs);

    EZ_TEST_INT(FileOut.GetFileSize(), 0);

    EZ_TEST_BOOL(FileOut.WriteBytes(sFileContent.GetData(), sFileContent.GetElementCount()) == EZ_SUCCESS);

    FileOut.Flush().IgnoreResult();
    EZ_TEST_INT(FileOut.GetFileSize(), sFileContent.GetElementCount());

    FileOut.Close();
  }

  EZ_TEST_BLOCK(ezTestBlock::Enabled, "Read File")
  {
    ezFileReader FileIn;

    ezStringBuilder sAbs = sOutputFolder1Resolved;
    sAbs.AppendPath("FileSystemTest.txt");

    EZ_TEST_BOOL(FileIn.Open("FileSystemTest.txt") == EZ_SUCCESS);

    EZ_TEST_STRING(FileIn.GetFilePathRelative(), "FileSystemTest.txt");
    EZ_TEST_STRING(FileIn.GetFilePathAbsolute(), sAbs);

    EZ_TEST_INT(FileIn.GetFileSize(), sFileContent.GetElementCount());

    char szTemp[1024 * 2];
    EZ_TEST_INT(FileIn.ReadBytes(szTemp, 1024 * 2), sFileContent.GetElementCount());

    EZ_TEST_BOOL(ezMemoryUtils::IsEqual(szTemp, sFileContent.GetData(), sFileContent.GetElementCount()));

    FileIn.Close();
  }

#if EZ_DISABLED(EZ_SUPPORTS_UNRESTRICTED_FILE_ACCESS)

  EZ_TEST_BLOCK(ezTestBlock::Enabled, "Read File (Absolute Path)")
  {
    ezFileReader FileIn;

    ezStringBuilder sAbs = sOutputFolder1Resolved;
    sAbs.AppendPath("FileSystemTest.txt");

    EZ_TEST_BOOL(FileIn.Open(sAbs) == EZ_SUCCESS);

    EZ_TEST_STRING(FileIn.GetFilePathRelative(), "FileSystemTest.txt");
    EZ_TEST_STRING(FileIn.GetFilePathAbsolute(), sAbs);

    EZ_TEST_INT(FileIn.GetFileSize(), sFileContent.GetElementCount());

    char szTemp[1024 * 2];
    EZ_TEST_INT(FileIn.ReadBytes(szTemp, 1024 * 2), sFileContent.GetElementCount());

    EZ_TEST_BOOL(ezMemoryUtils::IsEqual(szTemp, sFileContent.GetData(), sFileContent.GetElementCount()));

    FileIn.Close();
  }

#endif

  EZ_TEST_BLOCK(ezTestBlock::Enabled, "Delete File / Exists File")
  {
    {
      EZ_TEST_BOOL(ezFileSystem::ExistsFile(":output1/FileSystemTest.txt"));
      ezFileSystem::DeleteFile(":output1/FileSystemTest.txt");
      EZ_TEST_BOOL(!ezFileSystem::ExistsFile("FileSystemTest.txt"));

      ezFileReader FileIn;
      EZ_TEST_BOOL(FileIn.Open("FileSystemTest.txt") == EZ_FAILURE);
    }

    // very long path names
    {
      ezStringBuilder sTempFile = ":output1";
      sTempFile.AppendPath(LongPath);
      sTempFile.AppendPath("Temp.tmp");

      ezFileWriter TempFile;
      EZ_TEST_BOOL(TempFile.Open(sTempFile) == EZ_SUCCESS);
      TempFile.Close();

      EZ_TEST_BOOL(ezFileSystem::ExistsFile(sTempFile));
      ezFileSystem::DeleteFile(sTempFile);
      EZ_TEST_BOOL(!ezFileSystem::ExistsFile(sTempFile));

      ezFileReader FileIn;
      EZ_TEST_BOOL(FileIn.Open("FileSystemTest.txt") == EZ_FAILURE);
    }
  }

  EZ_TEST_BLOCK(ezTestBlock::Enabled, "GetFileStats")
  {
    const char* szPath = ":output1/" LongPath "/FileSystemTest.txt";

    // Create file
    {
      ezFileWriter FileOut;
      ezStringBuilder sAbs = sOutputFolder1Resolved;
      sAbs.AppendPath("FileSystemTest.txt");
      EZ_TEST_BOOL(FileOut.Open(szPath) == EZ_SUCCESS);
      FileOut.WriteBytes("Test", 4).IgnoreResult();
    }

    ezFileStats stat;

    EZ_TEST_BOOL(ezFileSystem::GetFileStats(szPath, stat).Succeeded());

    EZ_TEST_BOOL(!stat.m_bIsDirectory);
    EZ_TEST_STRING(stat.m_sName, "FileSystemTest.txt");
    EZ_TEST_INT(stat.m_uiFileSize, 4);

    ezFileSystem::DeleteFile(szPath);
    EZ_TEST_BOOL(ezFileSystem::GetFileStats(szPath, stat).Failed());
  }

  EZ_TEST_BLOCK(ezTestBlock::Enabled, "ResolvePath")
  {
    ezStringBuilder sRel, sAbs;

    EZ_TEST_BOOL(ezFileSystem::ResolvePath(":output1/FileSystemTest2.txt", &sAbs, &sRel) == EZ_SUCCESS);

    ezStringBuilder sExpectedAbs = sOutputFolder1Resolved;
    sExpectedAbs.AppendPath("FileSystemTest2.txt");

    EZ_TEST_STRING(sAbs, sExpectedAbs);
    EZ_TEST_STRING(sRel, "FileSystemTest2.txt");

    // create a file in the second dir
    {
      EZ_TEST_BOOL(ezFileSystem::AddDataDirectory(sOutputFolder2, "Remove", "output2", ezDataDirUsage::AllowWrites) == EZ_SUCCESS);

      {
        ezFileWriter FileOut;
        EZ_TEST_BOOL(FileOut.Open(":output2/FileSystemTest2.txt") == EZ_SUCCESS);
      }

      EZ_TEST_INT(ezFileSystem::RemoveDataDirectoryGroup("Remove"), 1);
    }

    // find the path to an existing file
    {
      EZ_TEST_BOOL(ezFileSystem::ResolvePath("FileSystemTest2.txt", &sAbs, &sRel) == EZ_SUCCESS);

      sExpectedAbs = sOutputFolder2Resolved;
      sExpectedAbs.AppendPath("FileSystemTest2.txt");

      EZ_TEST_STRING(sAbs, sExpectedAbs);
      EZ_TEST_STRING(sRel, "FileSystemTest2.txt");
    }

    // find where we would write the file to (ignoring existing files)
    {
      EZ_TEST_BOOL(ezFileSystem::ResolvePath(":output1/FileSystemTest2.txt", &sAbs, &sRel) == EZ_SUCCESS);

      sExpectedAbs = sOutputFolder1Resolved;
      sExpectedAbs.AppendPath("FileSystemTest2.txt");

      EZ_TEST_STRING(sAbs, sExpectedAbs);
      EZ_TEST_STRING(sRel, "FileSystemTest2.txt");
    }

    // find where we would write the file to (ignoring existing files)
    {
      EZ_TEST_BOOL(ezFileSystem::ResolvePath(":output1/SubSub/FileSystemTest2.txt", &sAbs, &sRel) == EZ_SUCCESS);

      sExpectedAbs = sOutputFolder1Resolved;
      sExpectedAbs.AppendPath("SubSub/FileSystemTest2.txt");

      EZ_TEST_STRING(sAbs, sExpectedAbs);
      EZ_TEST_STRING(sRel, "SubSub/FileSystemTest2.txt");
    }

    ezFileSystem::DeleteFile(":output1/FileSystemTest2.txt");
    ezFileSystem::DeleteFile(":output2/FileSystemTest2.txt");
  }

  EZ_TEST_BLOCK(ezTestBlock::Enabled, "FindFolderWithSubPath")
  {
    EZ_TEST_BOOL(ezFileSystem::AddDataDirectory(szOutputFolder, "remove", "toplevel", ezDataDirUsage::AllowWrites) == EZ_SUCCESS);
    EZ_TEST_BOOL(ezFileSystem::AddDataDirectory(sOutputFolder2, "remove", "output2", ezDataDirUsage::AllowWrites) == EZ_SUCCESS);

    ezStringBuilder StartPath;
    ezStringBuilder SubPath;
    ezStringBuilder result, expected;

    // make sure this exists
    {
      ezFileWriter FileOut;
      EZ_TEST_BOOL(FileOut.Open(":output2/FileSystemTest2.txt") == EZ_SUCCESS);
    }

    {
      StartPath.Set(sOutputFolder1Resolved, "/SubSub", "/Irrelevant");
      SubPath.Set("DoesNotExist");

      EZ_TEST_BOOL(ezFileSystem::FindFolderWithSubPath(result, StartPath, SubPath).Failed());
    }

    {
      StartPath.Set(sOutputFolder1Resolved, "/SubSub", "/Irrelevant");
      SubPath.Set("SubFolder2");
      expected.Set(sOutputFolderResolved, "/IO/");

      EZ_TEST_BOOL(ezFileSystem::FindFolderWithSubPath(result, StartPath, SubPath).Succeeded());
      EZ_TEST_STRING(result, expected);
    }

    {
      StartPath.Set(sOutputFolder1Resolved, "/SubSub");
      SubPath.Set("IO/SubFolder2");
      expected.Set(sOutputFolderResolved, "/");

      EZ_TEST_BOOL(ezFileSystem::FindFolderWithSubPath(result, StartPath, SubPath).Succeeded());
      EZ_TEST_STRING(result, expected);
    }

    {
      StartPath.Set(sOutputFolder1Resolved, "/SubSub");
      SubPath.Set("IO/SubFolder2");
      expected.Set(sOutputFolderResolved, "/");

      EZ_TEST_BOOL(ezFileSystem::FindFolderWithSubPath(result, StartPath, SubPath).Succeeded());
      EZ_TEST_STRING(result, expected);
    }

    {
      StartPath.Set(sOutputFolder1Resolved, "/SubSub", "/Irrelevant");
      SubPath.Set("SubFolder2/FileSystemTest2.txt");
      expected.Set(sOutputFolderResolved, "/IO/");

      EZ_TEST_BOOL(ezFileSystem::FindFolderWithSubPath(result, StartPath, SubPath).Succeeded());
      EZ_TEST_STRING(result, expected);
    }

    {
      StartPath.Set(":toplevel/IO/SubFolder");
      SubPath.Set("IO/SubFolder2");
      expected.Set(":toplevel/");

      EZ_TEST_BOOL(ezFileSystem::FindFolderWithSubPath(result, StartPath, SubPath).Succeeded());
      EZ_TEST_STRING(result, expected);
    }

    ezFileSystem::DeleteFile(":output1/FileSystemTest2.txt");
    ezFileSystem::DeleteFile(":output2/FileSystemTest2.txt");

    ezFileSystem::RemoveDataDirectoryGroup("remove");
  }
}