Skip to content

Cleanup unit test temp folders #455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DanRStevens merged 9 commits into from
Aug 10, 2026
Merged

Cleanup unit test temp folders #455

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
accf72a
Create fewer test files in `DirectoryDoesNotExist` test
DanRStevens Aug 10, 2026
bf0175d
Inline and remove now single use `WriteToNewDirectory` helper
DanRStevens Aug 10, 2026
d00c9a4
Split success and failure test cases
DanRStevens Aug 10, 2026
39d66bf
Add assertion for file existing in create test
DanRStevens Aug 10, 2026
f76940c
Use a different folder name between test cases
DanRStevens Aug 10, 2026
4158a1f
Test for existence/non-existence of folder in test cases
DanRStevens Aug 10, 2026
0a83706
Cleanup temp folder as well as the file
DanRStevens Aug 10, 2026
ee68db0
Cleanup folder in `PermissionChecks` test case
DanRStevens Aug 10, 2026
b85782d
Rename created folders to make tests independent
DanRStevens Aug 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions OP2UtilityTest/Stream/FileWriter.test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@

using namespace OP2Utility;

void WriteToNewDirectory(const std::string& path);

TEST(FileWriterOpenMode, BadFlagCombinations) {
using OpenMode = Stream::FileWriter::OpenMode;
Expand Down Expand Up @@ -58,12 +57,14 @@ TEST(FileWriterOpenMode, PermissionChecks) {
ASSERT_THROW(Stream::FileWriter writer(filename, OpenMode::CanOpenNew), std::runtime_error);

// Try to open new file in new directory with permission
const std::string directoryAndFilename("NewDirectory/OpenModePermissionChecks.temp");
const std::string folder{"NewDirectoryPermissionChecks/"};
const std::string directoryAndFilename(folder + "OpenModePermissionChecks.temp");
ASSERT_NO_THROW(Stream::FileWriter writer(directoryAndFilename, OpenMode::CanOpenNew));

// Cleanup temporary file
XFile::DeletePath(filename);
XFile::DeletePath(directoryAndFilename);
XFile::DeletePath(folder);
}


Expand All @@ -83,20 +84,25 @@ TEST(FileWriter, InvalidFilename) {
EXPECT_THROW(Stream::FileWriter fileWriter("data"), std::runtime_error);
}

TEST(FileWriter, DirectoryDoesNotExist) {
WriteToNewDirectory("../NewDirectory/TestFile.temp");
WriteToNewDirectory("./NewDirectory/TestFile.temp");
WriteToNewDirectory("NewDirectory/TestFile.temp");
}
TEST(FileWriter, DirectoryDoesNotExistFail) {
const std::string folder{"NewDirectoryNotCreated/"};
const std::string path{folder + "TestFile.temp"};

// Will delete the path after testing creation
void WriteToNewDirectory(const std::string& path)
{
// New directory should not be created when writer cannot create new files
EXPECT_THROW(Stream::FileWriter writer(path, Stream::FileWriter::OpenMode::CanOpenExisting), std::runtime_error);
EXPECT_FALSE(XFile::PathExists(folder));
EXPECT_FALSE(XFile::PathExists(path));
}

TEST(FileWriter, DirectoryDoesNotExistCreate) {
const std::string folder{"NewDirectoryCreated/"};
const std::string path{folder + "TestFile.temp"};

EXPECT_NO_THROW(Stream::FileWriter writer(path));
EXPECT_TRUE(XFile::PathExists(folder));
EXPECT_TRUE(XFile::PathExists(path));

// Delete the path after testing creation
XFile::DeletePath(path);
XFile::DeletePath(folder);
}