From 94e12bdad85c03e9891c408eec7ca008a8cc2224 Mon Sep 17 00:00:00 2001
From: Olivier Gregoire <olivier.gregoire@savoirfairelinux.com>
Date: Wed, 30 Aug 2017 17:13:17 -0400
Subject: [PATCH] test: add file_utils unit-tests
[GR: adapt for coding-rules]
[GR: adapt for better temporary dir/file and fix readDirector test]
Change-Id: I11d854f59032ca7855308a82ac8c3e6b679fbe02
Reviewed-by: Olivier Soldano <olivier.soldano@savoirfairelinux.com>
---
test/unitTest/Makefile.am | 6 +
test/unitTest/fileutils/testFileutils.cpp | 187 ++++++++++++++++++++++
2 files changed, 193 insertions(+)
create mode 100644 test/unitTest/fileutils/testFileutils.cpp
diff --git a/test/unitTest/Makefile.am b/test/unitTest/Makefile.am
index c21560802c..8125878d05 100644
--- a/test/unitTest/Makefile.am
+++ b/test/unitTest/Makefile.am
@@ -25,6 +25,12 @@ ut_base64_SOURCES = base64/base64.cpp
check_PROGRAMS += ut_map_utils
ut_map_utils_SOURCES = map_utils/testMap_utils.cpp
+#
+# fileutils
+#
+check_PROGRAMS += ut_fileutils
+ut_fileutils_SOURCES = fileutils/testFileutils.cpp
+
#
# smartools
#
diff --git a/test/unitTest/fileutils/testFileutils.cpp b/test/unitTest/fileutils/testFileutils.cpp
new file mode 100644
index 0000000000..fedc27d676
--- /dev/null
+++ b/test/unitTest/fileutils/testFileutils.cpp
@@ -0,0 +1,187 @@
+/*
+ * Copyright (C) 2017 Savoir-Faire Linux Inc.
+ * Author: Olivier Gregoire <olivier.gregoire@savoirfairelinux.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include <cppunit/TestAssert.h>
+#include <cppunit/TestFixture.h>
+#include <cppunit/extensions/HelperMacros.h>
+
+#include "../../test_runner.h"
+#include "fileutils.h"
+
+#include "dring.h"
+
+#include <string>
+#include <iostream>
+#include <cstdlib>
+#include <unistd.h>
+
+namespace ring { namespace fileutils { namespace test {
+
+class FileutilsTest : public CppUnit::TestFixture {
+public:
+ static std::string name() { return "fileutils"; }
+
+ void setUp();
+ void tearDown();
+
+private:
+ void testCheckDir();
+ void testPath();
+ void testReadDirectory();
+ void testLoadFile();
+ void testIsDirectoryWritable();
+ void testGetCleanPath();
+ void testFullPath();
+
+ CPPUNIT_TEST_SUITE(FileutilsTest);
+ CPPUNIT_TEST(testCheckDir);
+ CPPUNIT_TEST(testPath);
+ CPPUNIT_TEST(testReadDirectory);
+ CPPUNIT_TEST(testLoadFile);
+ CPPUNIT_TEST(testIsDirectoryWritable);
+ CPPUNIT_TEST(testGetCleanPath);
+ CPPUNIT_TEST(testFullPath);
+ CPPUNIT_TEST_SUITE_END();
+
+ static constexpr auto tmpFileName = "temp_file";
+
+ std::string TEST_PATH;
+ std::string NON_EXISTANT_PATH_BASE;
+ std::string NON_EXISTANT_PATH;
+ std::string EXISTANT_FILE;
+};
+
+CPPUNIT_TEST_SUITE_NAMED_REGISTRATION(FileutilsTest, FileutilsTest::name());
+
+void
+FileutilsTest::setUp()
+{
+ char template_name[] = {"ring_unit_tests_XXXXXX"};
+
+ // Generate a temporary directory with a file inside
+ auto directory = mkdtemp(template_name);
+ CPPUNIT_ASSERT(directory);
+
+ TEST_PATH = directory;
+ EXISTANT_FILE = TEST_PATH + DIR_SEPARATOR_STR + tmpFileName;
+ NON_EXISTANT_PATH_BASE = TEST_PATH + DIR_SEPARATOR_STR + "not_existing_path";
+ NON_EXISTANT_PATH = NON_EXISTANT_PATH_BASE + DIR_SEPARATOR_STR + "test";
+
+ auto* fd = fopen(EXISTANT_FILE.c_str(), "w");
+ fwrite("RING", 1, 4, fd);
+ fclose(fd);
+}
+
+void
+FileutilsTest::tearDown()
+{
+ unlink(EXISTANT_FILE.c_str());
+ rmdir(TEST_PATH.c_str());
+}
+
+void
+FileutilsTest::testCheckDir()
+{
+ // check existed directory
+ CPPUNIT_ASSERT(check_dir(get_home_dir().c_str()));
+ CPPUNIT_ASSERT(check_dir(get_config_dir().c_str()));
+ CPPUNIT_ASSERT(check_dir(get_data_dir().c_str()));
+ CPPUNIT_ASSERT(check_dir(get_cache_dir().c_str()));
+ // check non-existent directory
+ CPPUNIT_ASSERT(!isDirectory(NON_EXISTANT_PATH));
+ CPPUNIT_ASSERT(check_dir(NON_EXISTANT_PATH.c_str()));
+ CPPUNIT_ASSERT(isDirectory(NON_EXISTANT_PATH));
+ CPPUNIT_ASSERT(removeAll(NON_EXISTANT_PATH_BASE) == 0);
+ CPPUNIT_ASSERT(!isDirectory(NON_EXISTANT_PATH_BASE));
+ //remove an non existant directory
+ CPPUNIT_ASSERT(removeAll(NON_EXISTANT_PATH_BASE) == -1);
+}
+
+void
+FileutilsTest::testPath()
+{
+ CPPUNIT_ASSERT(!isPathRelative(get_home_dir()));
+ CPPUNIT_ASSERT(isPathRelative("relativePath"));
+ CPPUNIT_ASSERT(!isFile(get_home_dir()));
+ CPPUNIT_ASSERT(isFile(EXISTANT_FILE));
+ CPPUNIT_ASSERT(!isDirectory(EXISTANT_FILE));
+ CPPUNIT_ASSERT(isDirectory(TEST_PATH));
+}
+
+void
+FileutilsTest::testReadDirectory()
+{
+ CPPUNIT_ASSERT(recursive_mkdir(TEST_PATH + DIR_SEPARATOR_STR + "readDirectory" + DIR_SEPARATOR_STR + "test1"));
+ CPPUNIT_ASSERT(recursive_mkdir(TEST_PATH + DIR_SEPARATOR_STR + "readDirectory" + DIR_SEPARATOR_STR + "test2"));
+ auto dirs = readDirectory(TEST_PATH + DIR_SEPARATOR_STR + "readDirectory");
+ CPPUNIT_ASSERT(dirs.size() == 2);
+ CPPUNIT_ASSERT(
+ (dirs.at(0).compare("test1") == 0 && dirs.at(1).compare("test2") == 0)
+ || (dirs.at(1).compare("test1") == 0 && dirs.at(0).compare("test2") == 0));
+ CPPUNIT_ASSERT(removeAll(TEST_PATH + DIR_SEPARATOR_STR + "readDirectory") == 0);
+}
+
+void
+FileutilsTest::testLoadFile()
+{
+ auto file = loadFile(EXISTANT_FILE);
+ CPPUNIT_ASSERT(file.size() == 4);
+ CPPUNIT_ASSERT(file.at(0) == 'R');
+ CPPUNIT_ASSERT(file.at(1) == 'I');
+ CPPUNIT_ASSERT(file.at(2) == 'N');
+ CPPUNIT_ASSERT(file.at(3) == 'G');
+}
+
+void
+FileutilsTest::testIsDirectoryWritable()
+{
+ CPPUNIT_ASSERT(recursive_mkdir(NON_EXISTANT_PATH_BASE));
+ CPPUNIT_ASSERT(isDirectoryWritable(NON_EXISTANT_PATH_BASE));
+ CPPUNIT_ASSERT(removeAll(NON_EXISTANT_PATH_BASE) == 0);
+ // Create directory with permission: read by owner
+ CPPUNIT_ASSERT(recursive_mkdir(NON_EXISTANT_PATH_BASE, 0400));
+ CPPUNIT_ASSERT(!isDirectoryWritable(NON_EXISTANT_PATH_BASE));
+ CPPUNIT_ASSERT(removeAll(NON_EXISTANT_PATH_BASE) == 0);
+}
+
+void
+FileutilsTest::testGetCleanPath()
+{
+ //empty base
+ CPPUNIT_ASSERT(getCleanPath("", NON_EXISTANT_PATH).compare(NON_EXISTANT_PATH) == 0);
+ //the base is not contain in the path
+ CPPUNIT_ASSERT(getCleanPath(NON_EXISTANT_PATH, NON_EXISTANT_PATH_BASE).compare(NON_EXISTANT_PATH_BASE) == 0);
+ //the method is use correctly
+ CPPUNIT_ASSERT(getCleanPath(NON_EXISTANT_PATH_BASE, NON_EXISTANT_PATH).compare("test") == 0);
+}
+
+void
+FileutilsTest::testFullPath()
+{
+ //empty base
+ CPPUNIT_ASSERT(getFullPath("", "relativePath").compare("relativePath") == 0);
+ //the path is not relative
+ CPPUNIT_ASSERT(getFullPath(NON_EXISTANT_PATH_BASE, "/tmp").compare("/tmp") == 0);
+ //the method is use correctly
+ CPPUNIT_ASSERT(getFullPath(NON_EXISTANT_PATH_BASE, "test").compare(NON_EXISTANT_PATH) == 0);
+}
+
+}}} // namespace ring::test::fileutils
+
+RING_TEST_RUNNER(ring::fileutils::test::FileutilsTest::name());
--
GitLab