kjellander@webrtc.org | 7951e81 | 2011-10-13 12:24:41 +0000 | [diff] [blame] | 1 | /* |
phoglund@webrtc.org | 9d9ad88 | 2012-02-07 16:16:52 +0000 | [diff] [blame] | 2 | * Copyright (c) 2012 The WebRTC project authors. All Rights Reserved. |
kjellander@webrtc.org | 7951e81 | 2011-10-13 12:24:41 +0000 | [diff] [blame] | 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license |
| 5 | * that can be found in the LICENSE file in the root of the source |
| 6 | * tree. An additional intellectual property rights grant can be found |
| 7 | * in the file PATENTS. All contributing project authors may |
| 8 | * be found in the AUTHORS file in the root of the source tree. |
| 9 | */ |
kjellander@webrtc.org | 4d8cd9d | 2011-11-09 11:24:14 +0000 | [diff] [blame] | 10 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 11 | #include "test/testsupport/fileutils.h" |
kjellander@webrtc.org | 5b97b12 | 2011-12-08 07:42:18 +0000 | [diff] [blame] | 12 | |
pbos@webrtc.org | 12dc1a3 | 2013-08-05 16:22:53 +0000 | [diff] [blame] | 13 | #include <stdio.h> |
| 14 | |
alessiob | 00b16f4 | 2017-06-01 03:29:40 -0700 | [diff] [blame] | 15 | #include <fstream> |
| 16 | #include <iostream> |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 17 | #include <list> |
| 18 | #include <string> |
| 19 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 20 | #include "api/optional.h" |
| 21 | #include "rtc_base/checks.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 22 | #include "test/gtest.h" |
kjellander@webrtc.org | 7951e81 | 2011-10-13 12:24:41 +0000 | [diff] [blame] | 23 | |
| 24 | #ifdef WIN32 |
phoglund@webrtc.org | 9d9ad88 | 2012-02-07 16:16:52 +0000 | [diff] [blame] | 25 | #define chdir _chdir |
kjellander@webrtc.org | 4d8cd9d | 2011-11-09 11:24:14 +0000 | [diff] [blame] | 26 | static const char* kPathDelimiter = "\\"; |
kjellander@webrtc.org | 7951e81 | 2011-10-13 12:24:41 +0000 | [diff] [blame] | 27 | #else |
kjellander@webrtc.org | 4d8cd9d | 2011-11-09 11:24:14 +0000 | [diff] [blame] | 28 | static const char* kPathDelimiter = "/"; |
kjellander@webrtc.org | 7951e81 | 2011-10-13 12:24:41 +0000 | [diff] [blame] | 29 | #endif |
| 30 | |
alessiob | 00b16f4 | 2017-06-01 03:29:40 -0700 | [diff] [blame] | 31 | static const char kTestName[] = "fileutils_unittest"; |
| 32 | static const char kExtension[] = "tmp"; |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 33 | |
kjellander@webrtc.org | 7951e81 | 2011-10-13 12:24:41 +0000 | [diff] [blame] | 34 | namespace webrtc { |
alessiob | 00b16f4 | 2017-06-01 03:29:40 -0700 | [diff] [blame] | 35 | namespace test { |
| 36 | |
| 37 | namespace { |
| 38 | |
| 39 | // Remove files and directories in a directory non-recursively and writes the |
| 40 | // number of deleted items in |num_deleted_entries|. |
| 41 | void CleanDir(const std::string& dir, size_t* num_deleted_entries) { |
| 42 | RTC_DCHECK(num_deleted_entries); |
| 43 | *num_deleted_entries = 0; |
| 44 | rtc::Optional<std::vector<std::string>> dir_content = ReadDirectory(dir); |
| 45 | EXPECT_TRUE(dir_content); |
| 46 | for (const auto& entry : *dir_content) { |
| 47 | if (DirExists(entry)) { |
| 48 | EXPECT_TRUE(RemoveDir(entry)); |
| 49 | (*num_deleted_entries)++; |
| 50 | } else if (FileExists(entry)) { |
| 51 | EXPECT_TRUE(RemoveFile(entry)); |
| 52 | (*num_deleted_entries)++; |
| 53 | } else { |
| 54 | FAIL(); |
| 55 | } |
| 56 | } |
| 57 | } |
| 58 | |
| 59 | void WriteStringInFile(const std::string& what, const std::string& file_path) { |
| 60 | std::ofstream out(file_path); |
| 61 | out << what; |
| 62 | out.close(); |
| 63 | } |
| 64 | |
| 65 | } // namespace |
kjellander@webrtc.org | 7951e81 | 2011-10-13 12:24:41 +0000 | [diff] [blame] | 66 | |
kjellander@webrtc.org | 4d8cd9d | 2011-11-09 11:24:14 +0000 | [diff] [blame] | 67 | // Test fixture to restore the working directory between each test, since some |
| 68 | // of them change it with chdir during execution (not restored by the |
| 69 | // gtest framework). |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 70 | class FileUtilsTest : public testing::Test { |
kjellander@webrtc.org | 4d8cd9d | 2011-11-09 11:24:14 +0000 | [diff] [blame] | 71 | protected: |
| 72 | FileUtilsTest() { |
kjellander@webrtc.org | 4d8cd9d | 2011-11-09 11:24:14 +0000 | [diff] [blame] | 73 | } |
ehmaldonado | 37535bf | 2016-12-05 06:42:45 -0800 | [diff] [blame] | 74 | ~FileUtilsTest() override {} |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 75 | // Runs before the first test |
| 76 | static void SetUpTestCase() { |
| 77 | original_working_dir_ = webrtc::test::WorkingDir(); |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 78 | } |
ehmaldonado | 37535bf | 2016-12-05 06:42:45 -0800 | [diff] [blame] | 79 | void SetUp() override { |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 80 | ASSERT_EQ(chdir(original_working_dir_.c_str()), 0); |
kjellander@webrtc.org | 4d8cd9d | 2011-11-09 11:24:14 +0000 | [diff] [blame] | 81 | } |
ehmaldonado | 37535bf | 2016-12-05 06:42:45 -0800 | [diff] [blame] | 82 | void TearDown() override { |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 83 | ASSERT_EQ(chdir(original_working_dir_.c_str()), 0); |
| 84 | } |
kjellander@webrtc.org | 4d8cd9d | 2011-11-09 11:24:14 +0000 | [diff] [blame] | 85 | private: |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 86 | static std::string original_working_dir_; |
kjellander@webrtc.org | 4d8cd9d | 2011-11-09 11:24:14 +0000 | [diff] [blame] | 87 | }; |
| 88 | |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 89 | std::string FileUtilsTest::original_working_dir_ = ""; |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 90 | |
ehmaldonado | d661e9c | 2016-11-22 10:42:59 -0800 | [diff] [blame] | 91 | // Tests that the project output dir path is returned for the default working |
kjellander@webrtc.org | 4d8cd9d | 2011-11-09 11:24:14 +0000 | [diff] [blame] | 92 | // directory that is automatically set when the test executable is launched. |
kjellander@webrtc.org | 7951e81 | 2011-10-13 12:24:41 +0000 | [diff] [blame] | 93 | // The test is not fully testing the implementation, since we cannot be sure |
| 94 | // of where the executable was launched from. |
kthelgason | 5d682ca | 2017-01-10 03:00:41 -0800 | [diff] [blame] | 95 | #if defined(WEBRTC_ANDROID) || defined(WEBRTC_IOS) |
Peter Boström | e2976c8 | 2016-01-04 22:44:05 +0100 | [diff] [blame] | 96 | #define MAYBE_OutputPathFromUnchangedWorkingDir \ |
| 97 | DISABLED_OutputPathFromUnchangedWorkingDir |
| 98 | #else |
| 99 | #define MAYBE_OutputPathFromUnchangedWorkingDir \ |
| 100 | OutputPathFromUnchangedWorkingDir |
| 101 | #endif |
| 102 | TEST_F(FileUtilsTest, MAYBE_OutputPathFromUnchangedWorkingDir) { |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 103 | std::string path = webrtc::test::OutputPath(); |
kjellander@webrtc.org | 4d8cd9d | 2011-11-09 11:24:14 +0000 | [diff] [blame] | 104 | std::string expected_end = "out"; |
| 105 | expected_end = kPathDelimiter + expected_end + kPathDelimiter; |
kjellander@webrtc.org | 7951e81 | 2011-10-13 12:24:41 +0000 | [diff] [blame] | 106 | ASSERT_EQ(path.length() - expected_end.length(), path.find(expected_end)); |
| 107 | } |
| 108 | |
kjellander@webrtc.org | 7951e81 | 2011-10-13 12:24:41 +0000 | [diff] [blame] | 109 | // Tests with current working directory set to a directory higher up in the |
kjellander@webrtc.org | 193600b | 2012-10-17 04:39:44 +0000 | [diff] [blame] | 110 | // directory tree than the project root dir. |
kthelgason | 5d682ca | 2017-01-10 03:00:41 -0800 | [diff] [blame] | 111 | #if defined(WEBRTC_ANDROID) || defined(WIN32) || defined(WEBRTC_IOS) |
Peter Boström | e2976c8 | 2016-01-04 22:44:05 +0100 | [diff] [blame] | 112 | #define MAYBE_OutputPathFromRootWorkingDir DISABLED_OutputPathFromRootWorkingDir |
| 113 | #else |
| 114 | #define MAYBE_OutputPathFromRootWorkingDir OutputPathFromRootWorkingDir |
| 115 | #endif |
| 116 | TEST_F(FileUtilsTest, MAYBE_OutputPathFromRootWorkingDir) { |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 117 | ASSERT_EQ(0, chdir(kPathDelimiter)); |
| 118 | ASSERT_EQ("./", webrtc::test::OutputPath()); |
kjellander@webrtc.org | 4d8cd9d | 2011-11-09 11:24:14 +0000 | [diff] [blame] | 119 | } |
| 120 | |
kjellander@webrtc.org | 72fd339 | 2014-11-05 06:28:50 +0000 | [diff] [blame] | 121 | TEST_F(FileUtilsTest, TempFilename) { |
kjellander@webrtc.org | 7de47bc | 2014-04-16 08:04:26 +0000 | [diff] [blame] | 122 | std::string temp_filename = webrtc::test::TempFilename( |
| 123 | webrtc::test::OutputPath(), "TempFilenameTest"); |
kjellander@webrtc.org | 72fd339 | 2014-11-05 06:28:50 +0000 | [diff] [blame] | 124 | ASSERT_TRUE(webrtc::test::FileExists(temp_filename)) |
| 125 | << "Couldn't find file: " << temp_filename; |
kjellander@webrtc.org | 7de47bc | 2014-04-16 08:04:26 +0000 | [diff] [blame] | 126 | remove(temp_filename.c_str()); |
| 127 | } |
| 128 | |
Artem Titov | e62f600 | 2018-03-19 15:40:00 +0100 | [diff] [blame] | 129 | TEST_F(FileUtilsTest, GenerateTempFilename) { |
| 130 | std::string temp_filename = webrtc::test::GenerateTempFilename( |
| 131 | webrtc::test::OutputPath(), "TempFilenameTest"); |
| 132 | ASSERT_FALSE(webrtc::test::FileExists(temp_filename)) |
| 133 | << "File exists: " << temp_filename; |
| 134 | FILE* file = fopen(temp_filename.c_str(), "wb"); |
| 135 | ASSERT_TRUE(file != NULL) << "Failed to open file: " << temp_filename; |
| 136 | ASSERT_GT(fprintf(file, "%s", "Dummy data"), 0) |
| 137 | << "Failed to write to file: " << temp_filename; |
| 138 | fclose(file); |
| 139 | remove(temp_filename.c_str()); |
| 140 | } |
| 141 | |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 142 | // Only tests that the code executes |
kthelgason | 5d682ca | 2017-01-10 03:00:41 -0800 | [diff] [blame] | 143 | #if defined(WEBRTC_IOS) |
| 144 | #define MAYBE_CreateDir DISABLED_CreateDir |
| 145 | #else |
| 146 | #define MAYBE_CreateDir CreateDir |
| 147 | #endif |
| 148 | TEST_F(FileUtilsTest, MAYBE_CreateDir) { |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 149 | std::string directory = "fileutils-unittest-empty-dir"; |
| 150 | // Make sure it's removed if a previous test has failed: |
pbos@webrtc.org | 12dc1a3 | 2013-08-05 16:22:53 +0000 | [diff] [blame] | 151 | remove(directory.c_str()); |
kjellander@webrtc.org | 7de47bc | 2014-04-16 08:04:26 +0000 | [diff] [blame] | 152 | ASSERT_TRUE(webrtc::test::CreateDir(directory)); |
pbos@webrtc.org | 12dc1a3 | 2013-08-05 16:22:53 +0000 | [diff] [blame] | 153 | remove(directory.c_str()); |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 154 | } |
| 155 | |
| 156 | TEST_F(FileUtilsTest, WorkingDirReturnsValue) { |
| 157 | // Hard to cover all platforms. Just test that it returns something without |
| 158 | // crashing: |
| 159 | std::string working_dir = webrtc::test::WorkingDir(); |
kjellander@webrtc.org | 5b97b12 | 2011-12-08 07:42:18 +0000 | [diff] [blame] | 160 | ASSERT_GT(working_dir.length(), 0u); |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 161 | } |
| 162 | |
| 163 | // Due to multiple platforms, it is hard to make a complete test for |
| 164 | // ResourcePath. Manual testing has been performed by removing files and |
| 165 | // verified the result confirms with the specified documentation for the |
| 166 | // function. |
| 167 | TEST_F(FileUtilsTest, ResourcePathReturnsValue) { |
| 168 | std::string resource = webrtc::test::ResourcePath(kTestName, kExtension); |
kjellander@webrtc.org | 5b97b12 | 2011-12-08 07:42:18 +0000 | [diff] [blame] | 169 | ASSERT_GT(resource.find(kTestName), 0u); |
| 170 | ASSERT_GT(resource.find(kExtension), 0u); |
kjellander@webrtc.org | 193600b | 2012-10-17 04:39:44 +0000 | [diff] [blame] | 171 | } |
| 172 | |
| 173 | TEST_F(FileUtilsTest, ResourcePathFromRootWorkingDir) { |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 174 | ASSERT_EQ(0, chdir(kPathDelimiter)); |
kjellander@webrtc.org | 193600b | 2012-10-17 04:39:44 +0000 | [diff] [blame] | 175 | std::string resource = webrtc::test::ResourcePath(kTestName, kExtension); |
kthelgason | 5d682ca | 2017-01-10 03:00:41 -0800 | [diff] [blame] | 176 | #if !defined(WEBRTC_IOS) |
kjellander@webrtc.org | 193600b | 2012-10-17 04:39:44 +0000 | [diff] [blame] | 177 | ASSERT_NE(resource.find("resources"), std::string::npos); |
kthelgason | 5d682ca | 2017-01-10 03:00:41 -0800 | [diff] [blame] | 178 | #endif |
kjellander@webrtc.org | 193600b | 2012-10-17 04:39:44 +0000 | [diff] [blame] | 179 | ASSERT_GT(resource.find(kTestName), 0u); |
| 180 | ASSERT_GT(resource.find(kExtension), 0u); |
kjellander@webrtc.org | 4ed4f24 | 2011-12-05 16:31:12 +0000 | [diff] [blame] | 181 | } |
| 182 | |
kjellander@webrtc.org | 5b97b12 | 2011-12-08 07:42:18 +0000 | [diff] [blame] | 183 | TEST_F(FileUtilsTest, GetFileSizeExistingFile) { |
kjellander@webrtc.org | e794c36 | 2014-09-29 11:47:28 +0000 | [diff] [blame] | 184 | // Create a file with some dummy data in. |
| 185 | std::string temp_filename = webrtc::test::TempFilename( |
| 186 | webrtc::test::OutputPath(), "fileutils_unittest"); |
| 187 | FILE* file = fopen(temp_filename.c_str(), "wb"); |
| 188 | ASSERT_TRUE(file != NULL) << "Failed to open file: " << temp_filename; |
| 189 | ASSERT_GT(fprintf(file, "%s", "Dummy data"), 0) << |
| 190 | "Failed to write to file: " << temp_filename; |
| 191 | fclose(file); |
| 192 | ASSERT_GT(webrtc::test::GetFileSize(std::string(temp_filename.c_str())), 0u); |
| 193 | remove(temp_filename.c_str()); |
kjellander@webrtc.org | 5b97b12 | 2011-12-08 07:42:18 +0000 | [diff] [blame] | 194 | } |
| 195 | |
| 196 | TEST_F(FileUtilsTest, GetFileSizeNonExistingFile) { |
| 197 | ASSERT_EQ(0u, webrtc::test::GetFileSize("non-existing-file.tmp")); |
| 198 | } |
| 199 | |
alessiob | e49fede | 2017-03-15 06:04:59 -0700 | [diff] [blame] | 200 | TEST_F(FileUtilsTest, DirExists) { |
| 201 | // Check that an existing directory is recognized as such. |
| 202 | ASSERT_TRUE(webrtc::test::DirExists(webrtc::test::OutputPath())) |
| 203 | << "Existing directory not found"; |
| 204 | |
| 205 | // Check that a non-existing directory is recognized as such. |
| 206 | std::string directory = "direxists-unittest-non_existing-dir"; |
| 207 | ASSERT_FALSE(webrtc::test::DirExists(directory)) |
| 208 | << "Non-existing directory found"; |
| 209 | |
| 210 | // Check that an existing file is not recognized as an existing directory. |
| 211 | std::string temp_filename = webrtc::test::TempFilename( |
| 212 | webrtc::test::OutputPath(), "TempFilenameTest"); |
| 213 | ASSERT_TRUE(webrtc::test::FileExists(temp_filename)) |
| 214 | << "Couldn't find file: " << temp_filename; |
| 215 | ASSERT_FALSE(webrtc::test::DirExists(temp_filename)) |
| 216 | << "Existing file recognized as existing directory"; |
| 217 | remove(temp_filename.c_str()); |
| 218 | } |
| 219 | |
alessiob | 00b16f4 | 2017-06-01 03:29:40 -0700 | [diff] [blame] | 220 | TEST_F(FileUtilsTest, WriteReadDeleteFilesAndDirs) { |
| 221 | size_t num_deleted_entries; |
| 222 | |
| 223 | // Create an empty temporary directory for this test. |
| 224 | const std::string temp_directory = |
| 225 | OutputPath() + "TempFileUtilsTestReadDirectory" + kPathDelimiter; |
| 226 | CreateDir(temp_directory); |
| 227 | EXPECT_NO_FATAL_FAILURE(CleanDir(temp_directory, &num_deleted_entries)); |
| 228 | EXPECT_TRUE(DirExists(temp_directory)); |
| 229 | |
| 230 | // Add a file. |
| 231 | const std::string temp_filename = temp_directory + "TempFilenameTest"; |
| 232 | WriteStringInFile("test\n", temp_filename); |
| 233 | EXPECT_TRUE(FileExists(temp_filename)); |
| 234 | |
| 235 | // Add an empty directory. |
| 236 | const std::string temp_subdir = temp_directory + "subdir" + kPathDelimiter; |
| 237 | EXPECT_TRUE(CreateDir(temp_subdir)); |
| 238 | EXPECT_TRUE(DirExists(temp_subdir)); |
| 239 | |
| 240 | // Checks. |
| 241 | rtc::Optional<std::vector<std::string>> dir_content = |
| 242 | ReadDirectory(temp_directory); |
| 243 | EXPECT_TRUE(dir_content); |
| 244 | EXPECT_EQ(2u, dir_content->size()); |
| 245 | EXPECT_NO_FATAL_FAILURE(CleanDir(temp_directory, &num_deleted_entries)); |
| 246 | EXPECT_EQ(2u, num_deleted_entries); |
| 247 | EXPECT_TRUE(RemoveDir(temp_directory)); |
| 248 | EXPECT_FALSE(DirExists(temp_directory)); |
| 249 | } |
| 250 | |
| 251 | } // namespace test |
kjellander@webrtc.org | 7951e81 | 2011-10-13 12:24:41 +0000 | [diff] [blame] | 252 | } // namespace webrtc |