/* Copyright (C) 2019 Mike Fleetwood * * 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 2 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, see . */ /* Test SupportedFileSystems * * Test the derived FileSystem interface classes which call the file system specific * executables via the SupportedFileSystems class. Rather than mocking command execution * and returned output just run real commands, effectively making this integration testing. * * Test case setup determines the file system supported actions using * get_filesystem_support() and individual tests are skipped if a feature is not * supported, just as GParted does for it's actions. * * Each test creates it's own sparse image file and a fresh file system, performs a test * on one FileSystem interface call and deletes the image file. This makes each test * independent and allows them to run as a non-root user, provided the file system command * itself doesn't require root. Errors reported for a failed interface call will include * the GParted OperationDetails, which in turn includes the file system specific command * used and stdout and stderr from it's execution. */ #include "common.h" #include "insertion_operators.h" #include "GParted_Core.h" #include "FileSystem.h" #include "OperationDetail.h" #include "Partition.h" #include "Utils.h" #include "SupportedFileSystems.h" #include "gtest/gtest.h" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace GParted { // Print method for the messages in a Partition object. std::ostream& operator<<(std::ostream& out, const Partition& partition) { const std::vector messages = partition.get_messages(); out << "Partition messages:\n"; for (unsigned int i = 0; i < messages.size(); i++) out << messages[i]; return out; } // Printable file system type which meets the requirements for a Google Test name. // Use GParted's file system names except when they contains any non-alphabetic chars. // Reference: // * Specifying Names for Value-Parameterized Test Parameters // https://github.com/google/googletest/blob/v1.8.x/googletest/docs/advanced.md#specifying-names-for-value-parameterized-test-parameters // "NOTE: test names must be non-empty, unique, and may only contain ASCII // alphanumeric characters. In particular, they should not contain underscores." const std::string test_fsname(FSType fstype) { switch (fstype) { case FS_HFSPLUS: return "hfsplus"; case FS_LINUX_SWAP: return "linuxswap"; case FS_LVM2_PV: return "lvm2pv"; default: break; } return std::string(Utils::get_filesystem_string(fstype)); } // Function callable by INSTANTIATE_TEST_SUITE_P() to get the file system type for // printing as part of the test name. const std::string param_fsname(const ::testing::TestParamInfo& info) { return test_fsname(info.param); } // Google Test 1.8.1 (and earlier) doesn't implement run-time test skipping so implement // our own for GParted run-time detected of unsupported file system features. // Ref: // Skipping tests at runtime with GTEST_SKIP() #1544 // https://github.com/google/googletest/pull/1544 // (Merged after Google Test 1.8.1) #define SKIP_IF_FS_DOESNT_SUPPORT(opt) \ if (s_supported_filesystems->get_fs_support(m_fstype).opt != FS::EXTERNAL) \ { \ std::cout << __FILE__ << ":" << __LINE__ << ": Skip test. " \ << #opt << " not supported or support not found" << std::endl; \ return; \ } #define SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(fstype) \ if (m_fstype == fstype) \ { \ if (getuid() != 0) \ { \ std::cout << __FILE__ << ":" << __LINE__ << ": Skip test. Not root " \ << "to be able to create required loop device" << std::endl; \ return; \ } \ m_require_loopdev = true; \ } #define SKIP_IF_TEST_DISABLED_FOR_FS(fstype) \ if (m_fstype == fstype) \ { \ std::cout << __FILE__ << ":" << __LINE__ << ": Skip test. " \ << "Test disabled for file system" << std::endl; \ return; \ } // Temporarily workaround bugs in mkfs.reiser4 and debugfs.reiser4 which occasionally // create and read a null UUID respectively. #define IGNORE_REISER4_NULL_UUID() \ if (m_fstype == FS_REISER4 && m_partition.uuid.size() == 0) \ { \ std::cout << __FILE__ << ":" << __LINE__ << ": Ignore test " \ << "failure of a null UUID." << std::endl; \ m_partition.uuid = "XXXXXXXXX"; \ } const Byte_Value IMAGESIZE_Default = 320*MEBIBYTE; const Byte_Value IMAGESIZE_Larger = 512*MEBIBYTE; class SupportedFileSystemsTest : public ::testing::TestWithParam { protected: SupportedFileSystemsTest(); virtual void SetUp(); virtual void create_image_file(Byte_Value size = IMAGESIZE_Default); virtual void TearDown(); public: static void SetUpTestCase(); static void TearDownTestCase(); static std::vector get_supported_fstypes(); protected: static void setup_supported_filesystems(); static void teardown_supported_filesystems(); virtual const std::string create_loopdev(const std::string& image_name) const; virtual void detach_loopdev(const std::string& loopdev_name) const; virtual void reload_loopdev_size(const std::string& loopdev_name) const; virtual void reload_partition(); virtual void resize_image(Byte_Value new_size); virtual void shrink_partition(Byte_Value size); static SupportedFileSystems* s_supported_filesystems; // Owning pointer static const char* s_image_name; FSType m_fstype; FileSystem* m_fs_object; // Alias pointer bool m_require_loopdev; std::string m_dev_name; Partition m_partition; OperationDetail m_operation_detail; }; SupportedFileSystems* SupportedFileSystemsTest::s_supported_filesystems = nullptr; const char* SupportedFileSystemsTest::s_image_name = "test_SupportedFileSystems.img"; SupportedFileSystemsTest::SupportedFileSystemsTest() : m_fstype(GetParam()), m_fs_object(nullptr), m_require_loopdev(false), // Initialise top-level operation detail object with description ... m_operation_detail("Operation details:", STATUS_NONE) { } void SupportedFileSystemsTest::SetUp() { ASSERT_TRUE(s_supported_filesystems != nullptr) << __func__ << "(): TEST_BUG: File system interfaces not loaded"; // Lookup file system interface object. m_fs_object = s_supported_filesystems->get_fs_object(m_fstype); ASSERT_TRUE(m_fs_object != nullptr) << __func__ << "(): TEST_BUG: Interface object not found for file system " << test_fsname(m_fstype); } void SupportedFileSystemsTest::create_image_file(Byte_Value size) { // Create new image file to work with. unlink(s_image_name); int fd = open(s_image_name, O_WRONLY|O_CREAT|O_NONBLOCK, 0666); ASSERT_GE(fd, 0) << "Failed to create image file '" << s_image_name << "'. errno=" << errno << "," << strerror(errno); ASSERT_EQ(ftruncate(fd, (off_t)size), 0) << "Failed to set image file '" << s_image_name << "' to size " << size << ". errno=" << errno << "," << strerror(errno); close(fd); m_dev_name = s_image_name; if (m_require_loopdev) m_dev_name = create_loopdev(s_image_name); reload_partition(); } void SupportedFileSystemsTest::TearDown() { if (m_require_loopdev) detach_loopdev(m_dev_name); unlink(s_image_name); m_fs_object = nullptr; } // Common test case initialisation creating the supported file system interface object. void SupportedFileSystemsTest::SetUpTestCase() { setup_supported_filesystems(); } // Common test case teardown destroying the supported file systems interface object. void SupportedFileSystemsTest::TearDownTestCase() { teardown_supported_filesystems(); } std::vector SupportedFileSystemsTest::get_supported_fstypes() { setup_supported_filesystems(); std::vector v; const std::vector& fss = s_supported_filesystems->get_all_fs_support(); for (unsigned int i = 0; i < fss.size(); i++) { if (s_supported_filesystems->supported_filesystem(fss[i].fstype)) v.push_back(fss[i].fstype); } return v; } // Create the supported file system interface object. void SupportedFileSystemsTest::setup_supported_filesystems() { if (s_supported_filesystems == nullptr) { s_supported_filesystems = new SupportedFileSystems(); // Discover available file systems support capabilities, base on available // file system specific tools. s_supported_filesystems->find_supported_filesystems(); } } // Destroy the supported file systems interface object. void SupportedFileSystemsTest::teardown_supported_filesystems() { delete s_supported_filesystems; s_supported_filesystems = nullptr; } // Create loop device over named image file and return the device name. const std::string SupportedFileSystemsTest::create_loopdev(const std::string& image_name) const { Glib::ustring output; Glib::ustring error; Glib::ustring cmd = "losetup --find --show " + Glib::shell_quote(image_name); int exit_status = Utils::execute_command(cmd, output, error, true); if (exit_status != 0) { ADD_FAILURE() << __func__ << "(): Execute: " << cmd << "\n" << error << __func__ << "(): Losetup failed with exit status " << exit_status << "\n" << __func__ << "(): Failed to create required loop device"; return ""; } return Utils::trim_trailing_new_line(output); } // Detach named loop device. void SupportedFileSystemsTest::detach_loopdev(const std::string& loopdev_name) const { Glib::ustring output; Glib::ustring error; Glib::ustring cmd = "losetup --detach " + Glib::shell_quote(loopdev_name); int exit_status = Utils::execute_command(cmd, output, error, true); if (exit_status != 0) { // Report losetup detach error but don't fail the test because of it. std::cout << __func__ << "(): Execute: " << cmd << "\n" << error << __func__ << "(): Losetup failed with exit status " << exit_status << "\n" << __func__ << "(): Failed to detach loop device. Test NOT affected" << std::endl; } } // Instruct loop device to reload the size of the underlying image file. void SupportedFileSystemsTest::reload_loopdev_size(const std::string& loopdev_name) const { Glib::ustring output; Glib::ustring error; Glib::ustring cmd = "losetup --set-capacity " + Glib::shell_quote(loopdev_name); int exit_status = Utils::execute_command(cmd, output, error, true); if (exit_status != 0) { ADD_FAILURE() << __func__ << "(): Execute: " << cmd << "\n" << error << __func__ << "(): Losetup failed with exit status " << exit_status << "\n" << __func__ << "(): Failed to reload loop device size"; } } // (Re)initialise m_partition as a Partition object spanning the whole of the image file // with file system type only. No file system usage, label or UUID. void SupportedFileSystemsTest::reload_partition() { m_partition.Reset(); // Use libparted to get the sector size etc. of the image file. PedDevice* lp_device = ped_device_get(m_dev_name.c_str()); ASSERT_TRUE(lp_device != nullptr); // Prepare partition object spanning whole of the image file. m_partition.set_unpartitioned(m_dev_name, lp_device->path, m_fstype, lp_device->length, lp_device->sector_size, false); ped_device_destroy(lp_device); lp_device = nullptr; } void SupportedFileSystemsTest::resize_image(Byte_Value new_size) { int fd = open(s_image_name, O_WRONLY|O_NONBLOCK); ASSERT_GE(fd, 0) << "Failed to open image file '" << s_image_name << "'. errno=" << errno << "," << strerror(errno); ASSERT_EQ(ftruncate(fd, (off_t)new_size), 0) << "Failed to resize image file '" << s_image_name << "' to size " << new_size << ". errno=" << errno << "," << strerror(errno); close(fd); if (m_require_loopdev) reload_loopdev_size(m_dev_name); } void SupportedFileSystemsTest::shrink_partition(Byte_Value new_size) { ASSERT_LE(new_size, m_partition.get_byte_length()) << __func__ << "(): TEST_BUG: Cannot grow Partition object size"; Sector new_sectors = (new_size + m_partition.sector_size - 1) / m_partition.sector_size; m_partition.sector_end = new_sectors; } TEST_P(SupportedFileSystemsTest, Create) { SKIP_IF_FS_DOESNT_SUPPORT(create); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_LVM2_PV); create_image_file(); // Call create, check for success and print operation details on failure. ASSERT_TRUE(m_fs_object->create(m_partition, m_operation_detail)) << m_operation_detail; } TEST_P(SupportedFileSystemsTest, CreateAndReadUsage) { SKIP_IF_FS_DOESNT_SUPPORT(create); SKIP_IF_FS_DOESNT_SUPPORT(read); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_LVM2_PV); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_NILFS2); create_image_file(); ASSERT_TRUE(m_fs_object->create(m_partition, m_operation_detail)) << m_operation_detail; reload_partition(); m_fs_object->set_used_sectors(m_partition); // Test file system usage is reported correctly. // Used is between 0 and length. EXPECT_LE(0, m_partition.get_sectors_used()); EXPECT_LE(m_partition.get_sectors_used(), m_partition.get_sector_length()); // Unused is between 0 and length. EXPECT_LE(0, m_partition.get_sectors_unused()); EXPECT_LE(m_partition.get_sectors_unused(), m_partition.get_sector_length()); // Unallocated is 0. EXPECT_EQ(m_partition.get_sectors_unallocated(), 0); // Used + unused = length. EXPECT_EQ(m_partition.get_sectors_used() + m_partition.get_sectors_unused(), m_partition.get_sector_length()); // Test messages from read operation are empty or print them. EXPECT_TRUE(m_partition.get_messages().empty()) << m_partition; } TEST_P(SupportedFileSystemsTest, CreateAndReadLabel) { SKIP_IF_FS_DOESNT_SUPPORT(create); SKIP_IF_FS_DOESNT_SUPPORT(read_label); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_LVM2_PV); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_NILFS2); const char* fs_label = "TEST_LABEL"; create_image_file(); m_partition.set_filesystem_label(fs_label); ASSERT_TRUE(m_fs_object->create(m_partition, m_operation_detail)) << m_operation_detail; // Test reading the label is successful. reload_partition(); m_fs_object->read_label(m_partition); EXPECT_STREQ(fs_label, m_partition.get_filesystem_label().c_str()); // Test messages from read operation are empty or print them. EXPECT_TRUE(m_partition.get_messages().empty()) << m_partition; } TEST_P(SupportedFileSystemsTest, CreateAndReadUUID) { SKIP_IF_FS_DOESNT_SUPPORT(create); SKIP_IF_FS_DOESNT_SUPPORT(read_uuid); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_LVM2_PV); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_NILFS2); create_image_file(); ASSERT_TRUE(m_fs_object->create(m_partition, m_operation_detail)) << m_operation_detail; if (m_fstype == FS_JFS) { // Write a new UUID to cause the jfs version to be updated from 1 to 2 so // that jfs_tune can successfully report the UUID of the file system. SKIP_IF_FS_DOESNT_SUPPORT(write_uuid); ASSERT_TRUE(m_fs_object->write_uuid(m_partition, m_operation_detail)) << m_operation_detail; } // Test reading the UUID is successful. reload_partition(); m_fs_object->read_uuid(m_partition); IGNORE_REISER4_NULL_UUID(); EXPECT_GE(m_partition.uuid.size(), 9U); // Test messages from read operation are empty or print them. EXPECT_TRUE(m_partition.get_messages().empty()) << m_partition; } TEST_P(SupportedFileSystemsTest, CreateAndWriteLabel) { SKIP_IF_FS_DOESNT_SUPPORT(create); SKIP_IF_FS_DOESNT_SUPPORT(write_label); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_LVM2_PV); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_NILFS2); create_image_file(); m_partition.set_filesystem_label("FIRST"); ASSERT_TRUE(m_fs_object->create(m_partition, m_operation_detail)) << m_operation_detail; // Test clearing the label is successful. m_partition.set_filesystem_label(""); ASSERT_TRUE(m_fs_object->write_label(m_partition, m_operation_detail)) << m_operation_detail; // Test writing the label is successful. m_partition.set_filesystem_label("SECOND"); ASSERT_TRUE(m_fs_object->write_label(m_partition, m_operation_detail)) << m_operation_detail; } TEST_P(SupportedFileSystemsTest, CreateAndWriteUUID) { SKIP_IF_FS_DOESNT_SUPPORT(create); SKIP_IF_FS_DOESNT_SUPPORT(write_uuid); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_LVM2_PV); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_NILFS2); create_image_file(); ASSERT_TRUE(m_fs_object->create(m_partition, m_operation_detail)) << m_operation_detail; // Test writing a new random UUID is successful. ASSERT_TRUE(m_fs_object->write_uuid(m_partition, m_operation_detail)) << m_operation_detail; } TEST_P(SupportedFileSystemsTest, CreateAndWriteUUIDAndReadLabel) { SKIP_IF_FS_DOESNT_SUPPORT(create); SKIP_IF_FS_DOESNT_SUPPORT(write_uuid); SKIP_IF_FS_DOESNT_SUPPORT(read_label); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_LVM2_PV); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_NILFS2); const char* fs_label = "TEST_LABEL"; create_image_file(); m_partition.set_filesystem_label(fs_label); ASSERT_TRUE(m_fs_object->create(m_partition, m_operation_detail)) << m_operation_detail; // Test writing a new random UUID is successful. ASSERT_TRUE(m_fs_object->write_uuid(m_partition, m_operation_detail)) << m_operation_detail; // Test reading the label is successful and it hasn't changed. reload_partition(); m_fs_object->read_label(m_partition); EXPECT_STREQ(fs_label, m_partition.get_filesystem_label().c_str()); // Test messages from read operation are empty or print them. EXPECT_TRUE(m_partition.get_messages().empty()) << m_partition; } TEST_P(SupportedFileSystemsTest, CreateAndCheck) { SKIP_IF_FS_DOESNT_SUPPORT(create); SKIP_IF_FS_DOESNT_SUPPORT(check); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_LVM2_PV); SKIP_IF_TEST_DISABLED_FOR_FS(FS_MINIX); // FIXME: Enable when util-linux >= 2.27 is available everywhere create_image_file(); ASSERT_TRUE(m_fs_object->create(m_partition, m_operation_detail)) << m_operation_detail; // Test checking the file system is successful. ASSERT_TRUE(m_fs_object->check_repair(m_partition, m_operation_detail)) << m_operation_detail; } TEST_P(SupportedFileSystemsTest, CreateAndRemove) { SKIP_IF_FS_DOESNT_SUPPORT(create); SKIP_IF_FS_DOESNT_SUPPORT(remove); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_LVM2_PV); create_image_file(); ASSERT_TRUE(m_fs_object->create(m_partition, m_operation_detail)) << m_operation_detail; // Test removing the file system is successful. Note that most file systems don't // implement remove so will skip this test. ASSERT_TRUE(m_fs_object->remove(m_partition, m_operation_detail)) << m_operation_detail; } TEST_P(SupportedFileSystemsTest, CreateAndGrow) { SKIP_IF_FS_DOESNT_SUPPORT(create); SKIP_IF_FS_DOESNT_SUPPORT(grow); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_BTRFS); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_JFS); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_LVM2_PV); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_NILFS2); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_XFS); create_image_file(IMAGESIZE_Default); ASSERT_TRUE(m_fs_object->create(m_partition, m_operation_detail)) << m_operation_detail; // Test growing the file system is successful. resize_image(IMAGESIZE_Larger); reload_partition(); ASSERT_TRUE(m_fs_object->resize(m_partition, m_operation_detail, true)) << m_operation_detail; } TEST_P(SupportedFileSystemsTest, CreateAndShrink) { SKIP_IF_FS_DOESNT_SUPPORT(create); SKIP_IF_FS_DOESNT_SUPPORT(shrink); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_BTRFS); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_LVM2_PV); SKIP_IF_NOT_ROOT_FOR_REQUIRED_LOOPDEV_FOR_FS(FS_NILFS2); create_image_file(IMAGESIZE_Larger); ASSERT_TRUE(m_fs_object->create(m_partition, m_operation_detail)) << m_operation_detail; // Test shrinking the file system is successful. shrink_partition(IMAGESIZE_Default); ASSERT_TRUE(m_fs_object->resize(m_partition, m_operation_detail, false)) << m_operation_detail; } // Instantiate the test case so every test is run for the specified file system types. // Reference: // * Google Test, Advanced googletest Topics, How to Write Value-Parameterized Tests // https://github.com/google/googletest/blob/v1.10.x/googletest/docs/advanced.md#how-to-write-value-parameterized-tests INSTANTIATE_TEST_SUITE_P(My, SupportedFileSystemsTest, ::testing::ValuesIn(SupportedFileSystemsTest::get_supported_fstypes()), param_fsname); } // namespace GParted // Custom Google Test main(). // Reference: // * Google Test, Primer, Writing the main() function // https://github.com/google/googletest/blob/master/googletest/docs/primer.md#writing-the-main-function int main(int argc, char** argv) { printf("Running main() from %s\n", __FILE__); GParted::ensure_x11_display(argc, argv); // Initialise threading in GParted to allow FileSystem interface classes to // successfully use Utils:: and Filesystem::execute_command(). Must be before // InitGoogleTest(). GParted::GParted_Core::mainthread = Glib::Thread::self(); Gtk::Main gtk_main = Gtk::Main(); testing::InitGoogleTest(&argc, argv); return RUN_ALL_TESTS(); }