blob: 7f8513597887d841684aa068f742198404df8942 [file] [log] [blame]
kjellander@webrtc.org7951e812011-10-13 12:24:41 +00001/*
phoglund@webrtc.org9d9ad882012-02-07 16:16:52 +00002 * Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
kjellander@webrtc.org7951e812011-10-13 12:24:41 +00003 *
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.org4d8cd9d2011-11-09 11:24:14 +000010
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020011#include "test/testsupport/fileutils.h"
kjellander@webrtc.org5b97b122011-12-08 07:42:18 +000012
pbos@webrtc.org12dc1a32013-08-05 16:22:53 +000013#include <stdio.h>
14
alessiob00b16f42017-06-01 03:29:40 -070015#include <fstream>
16#include <iostream>
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +000017#include <list>
18#include <string>
19
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020020#include "api/optional.h"
21#include "rtc_base/checks.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020022#include "test/gtest.h"
kjellander@webrtc.org7951e812011-10-13 12:24:41 +000023
24#ifdef WIN32
phoglund@webrtc.org9d9ad882012-02-07 16:16:52 +000025#define chdir _chdir
kjellander@webrtc.org4d8cd9d2011-11-09 11:24:14 +000026static const char* kPathDelimiter = "\\";
kjellander@webrtc.org7951e812011-10-13 12:24:41 +000027#else
kjellander@webrtc.org4d8cd9d2011-11-09 11:24:14 +000028static const char* kPathDelimiter = "/";
kjellander@webrtc.org7951e812011-10-13 12:24:41 +000029#endif
30
alessiob00b16f42017-06-01 03:29:40 -070031static const char kTestName[] = "fileutils_unittest";
32static const char kExtension[] = "tmp";
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +000033
kjellander@webrtc.org7951e812011-10-13 12:24:41 +000034namespace webrtc {
alessiob00b16f42017-06-01 03:29:40 -070035namespace test {
36
37namespace {
38
39// Remove files and directories in a directory non-recursively and writes the
40// number of deleted items in |num_deleted_entries|.
41void 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
59void 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.org7951e812011-10-13 12:24:41 +000066
kjellander@webrtc.org4d8cd9d2011-11-09 11:24:14 +000067// 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.org4ed4f242011-12-05 16:31:12 +000070class FileUtilsTest : public testing::Test {
kjellander@webrtc.org4d8cd9d2011-11-09 11:24:14 +000071 protected:
72 FileUtilsTest() {
kjellander@webrtc.org4d8cd9d2011-11-09 11:24:14 +000073 }
ehmaldonado37535bf2016-12-05 06:42:45 -080074 ~FileUtilsTest() override {}
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +000075 // Runs before the first test
76 static void SetUpTestCase() {
77 original_working_dir_ = webrtc::test::WorkingDir();
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +000078 }
ehmaldonado37535bf2016-12-05 06:42:45 -080079 void SetUp() override {
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +000080 ASSERT_EQ(chdir(original_working_dir_.c_str()), 0);
kjellander@webrtc.org4d8cd9d2011-11-09 11:24:14 +000081 }
ehmaldonado37535bf2016-12-05 06:42:45 -080082 void TearDown() override {
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +000083 ASSERT_EQ(chdir(original_working_dir_.c_str()), 0);
84 }
kjellander@webrtc.org4d8cd9d2011-11-09 11:24:14 +000085 private:
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +000086 static std::string original_working_dir_;
kjellander@webrtc.org4d8cd9d2011-11-09 11:24:14 +000087};
88
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +000089std::string FileUtilsTest::original_working_dir_ = "";
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +000090
ehmaldonadod661e9c2016-11-22 10:42:59 -080091// Tests that the project output dir path is returned for the default working
kjellander@webrtc.org4d8cd9d2011-11-09 11:24:14 +000092// directory that is automatically set when the test executable is launched.
kjellander@webrtc.org7951e812011-10-13 12:24:41 +000093// The test is not fully testing the implementation, since we cannot be sure
94// of where the executable was launched from.
kthelgason5d682ca2017-01-10 03:00:41 -080095#if defined(WEBRTC_ANDROID) || defined(WEBRTC_IOS)
Peter Boströme2976c82016-01-04 22:44:05 +010096#define MAYBE_OutputPathFromUnchangedWorkingDir \
97 DISABLED_OutputPathFromUnchangedWorkingDir
98#else
99#define MAYBE_OutputPathFromUnchangedWorkingDir \
100 OutputPathFromUnchangedWorkingDir
101#endif
102TEST_F(FileUtilsTest, MAYBE_OutputPathFromUnchangedWorkingDir) {
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +0000103 std::string path = webrtc::test::OutputPath();
kjellander@webrtc.org4d8cd9d2011-11-09 11:24:14 +0000104 std::string expected_end = "out";
105 expected_end = kPathDelimiter + expected_end + kPathDelimiter;
kjellander@webrtc.org7951e812011-10-13 12:24:41 +0000106 ASSERT_EQ(path.length() - expected_end.length(), path.find(expected_end));
107}
108
kjellander@webrtc.org7951e812011-10-13 12:24:41 +0000109// Tests with current working directory set to a directory higher up in the
kjellander@webrtc.org193600b2012-10-17 04:39:44 +0000110// directory tree than the project root dir.
kthelgason5d682ca2017-01-10 03:00:41 -0800111#if defined(WEBRTC_ANDROID) || defined(WIN32) || defined(WEBRTC_IOS)
Peter Boströme2976c82016-01-04 22:44:05 +0100112#define MAYBE_OutputPathFromRootWorkingDir DISABLED_OutputPathFromRootWorkingDir
113#else
114#define MAYBE_OutputPathFromRootWorkingDir OutputPathFromRootWorkingDir
115#endif
116TEST_F(FileUtilsTest, MAYBE_OutputPathFromRootWorkingDir) {
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +0000117 ASSERT_EQ(0, chdir(kPathDelimiter));
118 ASSERT_EQ("./", webrtc::test::OutputPath());
kjellander@webrtc.org4d8cd9d2011-11-09 11:24:14 +0000119}
120
kjellander@webrtc.org72fd3392014-11-05 06:28:50 +0000121TEST_F(FileUtilsTest, TempFilename) {
kjellander@webrtc.org7de47bc2014-04-16 08:04:26 +0000122 std::string temp_filename = webrtc::test::TempFilename(
123 webrtc::test::OutputPath(), "TempFilenameTest");
kjellander@webrtc.org72fd3392014-11-05 06:28:50 +0000124 ASSERT_TRUE(webrtc::test::FileExists(temp_filename))
125 << "Couldn't find file: " << temp_filename;
kjellander@webrtc.org7de47bc2014-04-16 08:04:26 +0000126 remove(temp_filename.c_str());
127}
128
Artem Titove62f6002018-03-19 15:40:00 +0100129TEST_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.org4ed4f242011-12-05 16:31:12 +0000142// Only tests that the code executes
kthelgason5d682ca2017-01-10 03:00:41 -0800143#if defined(WEBRTC_IOS)
144#define MAYBE_CreateDir DISABLED_CreateDir
145#else
146#define MAYBE_CreateDir CreateDir
147#endif
148TEST_F(FileUtilsTest, MAYBE_CreateDir) {
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +0000149 std::string directory = "fileutils-unittest-empty-dir";
150 // Make sure it's removed if a previous test has failed:
pbos@webrtc.org12dc1a32013-08-05 16:22:53 +0000151 remove(directory.c_str());
kjellander@webrtc.org7de47bc2014-04-16 08:04:26 +0000152 ASSERT_TRUE(webrtc::test::CreateDir(directory));
pbos@webrtc.org12dc1a32013-08-05 16:22:53 +0000153 remove(directory.c_str());
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +0000154}
155
156TEST_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.org5b97b122011-12-08 07:42:18 +0000160 ASSERT_GT(working_dir.length(), 0u);
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +0000161}
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.
167TEST_F(FileUtilsTest, ResourcePathReturnsValue) {
168 std::string resource = webrtc::test::ResourcePath(kTestName, kExtension);
kjellander@webrtc.org5b97b122011-12-08 07:42:18 +0000169 ASSERT_GT(resource.find(kTestName), 0u);
170 ASSERT_GT(resource.find(kExtension), 0u);
kjellander@webrtc.org193600b2012-10-17 04:39:44 +0000171}
172
173TEST_F(FileUtilsTest, ResourcePathFromRootWorkingDir) {
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +0000174 ASSERT_EQ(0, chdir(kPathDelimiter));
kjellander@webrtc.org193600b2012-10-17 04:39:44 +0000175 std::string resource = webrtc::test::ResourcePath(kTestName, kExtension);
kthelgason5d682ca2017-01-10 03:00:41 -0800176#if !defined(WEBRTC_IOS)
kjellander@webrtc.org193600b2012-10-17 04:39:44 +0000177 ASSERT_NE(resource.find("resources"), std::string::npos);
kthelgason5d682ca2017-01-10 03:00:41 -0800178#endif
kjellander@webrtc.org193600b2012-10-17 04:39:44 +0000179 ASSERT_GT(resource.find(kTestName), 0u);
180 ASSERT_GT(resource.find(kExtension), 0u);
kjellander@webrtc.org4ed4f242011-12-05 16:31:12 +0000181}
182
kjellander@webrtc.org5b97b122011-12-08 07:42:18 +0000183TEST_F(FileUtilsTest, GetFileSizeExistingFile) {
kjellander@webrtc.orge794c362014-09-29 11:47:28 +0000184 // 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.org5b97b122011-12-08 07:42:18 +0000194}
195
196TEST_F(FileUtilsTest, GetFileSizeNonExistingFile) {
197 ASSERT_EQ(0u, webrtc::test::GetFileSize("non-existing-file.tmp"));
198}
199
alessiobe49fede2017-03-15 06:04:59 -0700200TEST_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
alessiob00b16f42017-06-01 03:29:40 -0700220TEST_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.org7951e812011-10-13 12:24:41 +0000252} // namespace webrtc