Merge pull request #9307 from Dentomologist/add-deleted-file-missing-warning-flag

Add File::Delete and File::DeleteDir warning flags
This commit is contained in:
Léo Lam 2020-12-11 02:06:28 +01:00 committed by GitHub
commit 2e63cc8313
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 130 additions and 5 deletions

View File

@ -135,7 +135,7 @@ bool IsFile(const std::string& path)
// Deletes a given filename, return true on success // Deletes a given filename, return true on success
// Doesn't supports deleting a directory // Doesn't supports deleting a directory
bool Delete(const std::string& filename) bool Delete(const std::string& filename, IfAbsentBehavior behavior)
{ {
INFO_LOG_FMT(COMMON, "Delete: file {}", filename); INFO_LOG_FMT(COMMON, "Delete: file {}", filename);
@ -154,7 +154,10 @@ bool Delete(const std::string& filename)
// Return true because we care about the file not being there, not the actual delete. // Return true because we care about the file not being there, not the actual delete.
if (!file_info.Exists()) if (!file_info.Exists())
{ {
WARN_LOG_FMT(COMMON, "Delete: {} does not exist", filename); if (behavior == IfAbsentBehavior::ConsoleWarning)
{
WARN_LOG_FMT(COMMON, "Delete: {} does not exist", filename);
}
return true; return true;
} }
@ -253,10 +256,20 @@ bool CreateFullPath(const std::string& fullPath)
} }
// Deletes a directory filename, returns true on success // Deletes a directory filename, returns true on success
bool DeleteDir(const std::string& filename) bool DeleteDir(const std::string& filename, IfAbsentBehavior behavior)
{ {
INFO_LOG_FMT(COMMON, "DeleteDir: directory {}", filename); INFO_LOG_FMT(COMMON, "DeleteDir: directory {}", filename);
// Return true because we care about the directory not being there, not the actual delete.
if (!File::Exists(filename))
{
if (behavior == IfAbsentBehavior::ConsoleWarning)
{
WARN_LOG_FMT(COMMON, "DeleteDir: {} does not exist", filename);
}
return true;
}
// check if a directory // check if a directory
if (!IsDirectory(filename)) if (!IsDirectory(filename))
{ {

View File

@ -136,12 +136,20 @@ bool CreateDir(const std::string& filename);
// Creates the full path of fullPath returns true on success // Creates the full path of fullPath returns true on success
bool CreateFullPath(const std::string& fullPath); bool CreateFullPath(const std::string& fullPath);
enum class IfAbsentBehavior
{
ConsoleWarning,
NoConsoleWarning
};
// Deletes a given filename, return true on success // Deletes a given filename, return true on success
// Doesn't supports deleting a directory // Doesn't supports deleting a directory
bool Delete(const std::string& filename); bool Delete(const std::string& filename,
IfAbsentBehavior behavior = IfAbsentBehavior::ConsoleWarning);
// Deletes a directory filename, returns true on success // Deletes a directory filename, returns true on success
bool DeleteDir(const std::string& filename); bool DeleteDir(const std::string& filename,
IfAbsentBehavior behavior = IfAbsentBehavior::ConsoleWarning);
// renames file srcFilename to destFilename, returns true on success // renames file srcFilename to destFilename, returns true on success
bool Rename(const std::string& srcFilename, const std::string& destFilename); bool Rename(const std::string& srcFilename, const std::string& destFilename);

View File

@ -0,0 +1,103 @@
// Copyright 2020 Dolphin Emulator Project
// Licensed under GPLv2+
// Refer to the license.txt file included.
#include <array>
#include <gtest/gtest.h>
#include "Common/FileUtil.h"
class FileUtilTest : public testing::Test
{
protected:
FileUtilTest()
: m_parent_directory(File::CreateTempDir()), m_file_path(m_parent_directory + "/file.txt"),
m_directory_path(m_parent_directory + "/dir"),
m_invalid_path(m_parent_directory + "/invalid.txt")
{
}
~FileUtilTest() override
{
if (!m_parent_directory.empty())
{
File::DeleteDirRecursively(m_parent_directory);
}
}
void SetUp()
{
if (m_parent_directory.empty())
{
FAIL();
}
}
constexpr static std::array<File::IfAbsentBehavior, 2> s_warning_behaviors = {
File::IfAbsentBehavior::ConsoleWarning,
File::IfAbsentBehavior::NoConsoleWarning,
};
const std::string m_parent_directory;
const std::string m_file_path;
const std::string m_directory_path;
const std::string m_invalid_path;
};
static void DeleteShouldNotRemoveDirectory(const std::string& path, File::IfAbsentBehavior behavior)
{
File::CreateDir(path);
EXPECT_FALSE(File::Delete(path, behavior));
File::DeleteDir(path, behavior);
}
static void DeleteShouldRemoveFile(const std::string& path, File::IfAbsentBehavior behavior)
{
File::CreateEmptyFile(path);
EXPECT_TRUE(File::Delete(path, behavior));
}
static void DeleteShouldReturnTrueForInvalidPath(const std::string& path,
File::IfAbsentBehavior behavior)
{
EXPECT_TRUE(File::Delete(path, behavior));
}
static void DeleteDirShouldRemoveDirectory(const std::string& path, File::IfAbsentBehavior behavior)
{
File::CreateDir(path);
EXPECT_TRUE(File::DeleteDir(path, behavior));
}
static void DeleteDirShouldNotRemoveFile(const std::string& path, File::IfAbsentBehavior behavior)
{
File::CreateEmptyFile(path);
EXPECT_FALSE(File::DeleteDir(path, behavior));
File::Delete(path, behavior);
}
static void DeleteDirShouldReturnTrueForInvalidPath(const std::string& path,
File::IfAbsentBehavior behavior)
{
EXPECT_TRUE(File::DeleteDir(path, behavior));
}
TEST_F(FileUtilTest, Delete)
{
for (const auto behavior : s_warning_behaviors)
{
DeleteShouldNotRemoveDirectory(m_directory_path, behavior);
DeleteShouldRemoveFile(m_file_path, behavior);
DeleteShouldReturnTrueForInvalidPath(m_invalid_path, behavior);
}
}
TEST_F(FileUtilTest, DeleteDir)
{
for (const auto behavior : s_warning_behaviors)
{
DeleteDirShouldRemoveDirectory(m_directory_path, behavior);
DeleteDirShouldNotRemoveFile(m_file_path, behavior);
DeleteDirShouldReturnTrueForInvalidPath(m_invalid_path, behavior);
}
}

View File

@ -68,6 +68,7 @@
<ClCompile Include="Core\IOS\FS\FileSystemTest.cpp" /> <ClCompile Include="Core\IOS\FS\FileSystemTest.cpp" />
<ClCompile Include="Core\MMIOTest.cpp" /> <ClCompile Include="Core\MMIOTest.cpp" />
<ClCompile Include="Core\PageFaultTest.cpp" /> <ClCompile Include="Core\PageFaultTest.cpp" />
<ClCompile Include="FileUtil.cpp" />
<ClCompile Include="VideoCommon\VertexLoaderTest.cpp" /> <ClCompile Include="VideoCommon\VertexLoaderTest.cpp" />
<ClCompile Include="StubHost.cpp" /> <ClCompile Include="StubHost.cpp" />
</ItemGroup> </ItemGroup>