filesystem_test.cc

Go to the documentation of this file.

#include "filesystem_test.h"

#include <glib.h>
#include <glib/gstdio.h>

#include <unistd.h>
#include <stdlib.h>

#include <glibmm/miscutils.h>
#include <glibmm/fileutils.h>

#include "pbd/file_utils.h"
#include "pbd/pathexpand.h"

#include "test_common.h"

using namespace std;
using namespace PBD;

CPPUNIT_TEST_SUITE_REGISTRATION (FilesystemTest);

namespace {

class PwdReset
{
public:

        PwdReset(const string& new_pwd)
                : m_old_pwd(Glib::get_current_dir()) {
                CPPUNIT_ASSERT (g_chdir (new_pwd.c_str()) == 0);
        }

        ~PwdReset()
        {
                CPPUNIT_ASSERT (g_chdir (m_old_pwd.c_str()) == 0);
        }

private:

        string m_old_pwd;

};

} // anon

void
FilesystemTest::testPathIsWithin ()
{
#ifndef PLATFORM_WINDOWS
        string output_path = test_output_directory ("testPathIsWithin");
        PwdReset pwd_reset(output_path);

        CPPUNIT_ASSERT (g_mkdir_with_parents ("foo/bar/baz", 0755) == 0);

        CPPUNIT_ASSERT (PBD::path_is_within (Glib::build_filename(output_path, "foo/bar/baz"), Glib::build_filename(output_path, "foo/bar/baz")));
        CPPUNIT_ASSERT (PBD::path_is_within (Glib::build_filename(output_path, "foo/bar"),     Glib::build_filename(output_path, "foo/bar/baz")));
        CPPUNIT_ASSERT (PBD::path_is_within (Glib::build_filename(output_path, "foo"),         Glib::build_filename(output_path, "foo/bar/baz")));
        CPPUNIT_ASSERT (PBD::path_is_within (Glib::build_filename(output_path, "foo/bar"),     Glib::build_filename(output_path, "foo/bar/baz")));
        CPPUNIT_ASSERT (PBD::path_is_within (Glib::build_filename(output_path, "foo/bar"),     Glib::build_filename(output_path, "foo/bar")));

        CPPUNIT_ASSERT (PBD::path_is_within (Glib::build_filename(output_path, "foo/bar/baz"), Glib::build_filename(output_path, "frobozz")) == false);

        int const r = symlink ("bar", "foo/jim");
        CPPUNIT_ASSERT (r == 0);

        CPPUNIT_ASSERT (PBD::path_is_within (Glib::build_filename(output_path, "foo/jim/baz"), Glib::build_filename(output_path, "foo/bar/baz")));
        CPPUNIT_ASSERT (PBD::path_is_within (Glib::build_filename(output_path, "foo/jim"),     Glib::build_filename(output_path, "foo/bar/baz")));
        CPPUNIT_ASSERT (PBD::path_is_within (Glib::build_filename(output_path, "foo"),         Glib::build_filename(output_path, "foo/bar/baz")));
        CPPUNIT_ASSERT (PBD::path_is_within (Glib::build_filename(output_path, "foo/jim"),     Glib::build_filename(output_path, "foo/bar/baz")));
        CPPUNIT_ASSERT (PBD::path_is_within (Glib::build_filename(output_path, "foo/jim"),     Glib::build_filename(output_path, "foo/bar")));

        CPPUNIT_ASSERT (PBD::path_is_within (Glib::build_filename(output_path, "foo/jim/baz"), Glib::build_filename(output_path, "frobozz")) == false);
#endif
}

void
FilesystemTest::testCopyFileASCIIFilename ()
{
        string testdata_path;
        CPPUNIT_ASSERT (find_file (test_search_path (), "RosegardenPatchFile.xml", testdata_path));

        string output_path = test_output_directory ("CopyFile");

        output_path = Glib::build_filename (output_path, "RosegardenPatchFile.xml");

        cerr << endl;
        cerr << "CopyFile test output path: " << output_path << endl;

        CPPUNIT_ASSERT (PBD::copy_file (testdata_path, output_path));
}

void
FilesystemTest::testCopyFileUTF8Filename ()
{
        vector<string> i18n_files;

        Searchpath i18n_path(test_search_path());
        i18n_path.add_subdirectory_to_paths("i18n_test");

        PBD::find_files_matching_pattern (i18n_files, i18n_path, "*.tst");

        CPPUNIT_ASSERT (i18n_files.size() == 8);

        cerr << endl;
        cerr << "Copying " << i18n_files.size() << " test files from: "
             << i18n_path.to_string () << endl;

        for (vector<string>::iterator i = i18n_files.begin(); i != i18n_files.end(); ++i) {
                string input_path = *i;
                string output_file = Glib::path_get_basename(*i);
                string output_path = test_output_directory ("CopyFile");
                output_path = Glib::build_filename (output_path, output_file);

                cerr << "Copying test file: " << input_path
                     << " To " << output_path << endl;

                CPPUNIT_ASSERT (PBD::copy_file (input_path, output_path));
        }
}

void
FilesystemTest::testFindFilesMatchingPattern ()
{
        vector<string> patch_files;

        PBD::find_files_matching_pattern (patch_files, test_search_path (), "*PatchFile*");

        CPPUNIT_ASSERT(test_search_path ().size() == 1);

        CPPUNIT_ASSERT(patch_files.size() == 2);
}

string
create_test_directory (std::string test_dir)
{
        vector<string> test_files;
        vector<string> i18n_files;

        Searchpath spath(test_search_path());
        PBD::get_files (test_files, spath);

        spath.add_subdirectory_to_paths("i18n_test");

        PBD::get_files (i18n_files, spath);

        string output_dir = test_output_directory (test_dir);

        CPPUNIT_ASSERT (test_search_path().size () != 0);

        string test_dir_path = test_search_path()[0];

        cerr << endl;
        cerr << "Copying " << test_files.size() << " test files from: "
             << test_dir_path << " to " << output_dir << endl;

        CPPUNIT_ASSERT (test_files.size() != 0);

        PBD::copy_files (test_dir_path, output_dir);

        vector<string> copied_files;

        PBD::get_files (copied_files, output_dir);

        CPPUNIT_ASSERT (copied_files.size() == test_files.size());

        string subdir_path = Glib::build_filename (output_dir, "subdir");

        CPPUNIT_ASSERT (g_mkdir_with_parents (subdir_path.c_str(), 0755) == 0);

        cerr << endl;
        cerr << "Copying " << i18n_files.size() << " i18n test files to: "
             << subdir_path << endl;

        for (vector<string>::iterator i = i18n_files.begin(); i != i18n_files.end(); ++i) {
                string input_filepath = *i;
                string output_filename = Glib::path_get_basename(*i);
                string output_filepath = Glib::build_filename (subdir_path, output_filename);

                CPPUNIT_ASSERT (PBD::copy_file (input_filepath, output_filepath));
        }

        copied_files.clear();
        PBD::get_files (copied_files, subdir_path);

        CPPUNIT_ASSERT (copied_files.size() == i18n_files.size());

        return output_dir;
}

void
FilesystemTest::testClearDirectory ()
{
        string output_dir_path = create_test_directory ("ClearDirectory");

        vector<string> files_in_output_dir;

        PBD::get_paths (files_in_output_dir, output_dir_path, true, true);

        size_t removed_file_size = 0;
        vector<string> removed_files;

        CPPUNIT_ASSERT (PBD::clear_directory (output_dir_path, &removed_file_size, &removed_files) ==0);

        cerr << "Removed " << removed_files.size() << " files of total size: "
             << removed_file_size << endl;

        CPPUNIT_ASSERT (removed_files.size () == files_in_output_dir.size ());

        string subdir_path = Glib::build_filename (output_dir_path, "subdir");

        // make sure the directory structure is still there
        CPPUNIT_ASSERT (Glib::file_test (subdir_path, Glib::FILE_TEST_IS_DIR));
}

void
FilesystemTest::testRemoveDirectory ()
{
        string output_dir_path = create_test_directory ("RemoveDirectory");

        vector<string> files_in_output_dir;

        PBD::get_paths (files_in_output_dir, output_dir_path, false, true);

        CPPUNIT_ASSERT (files_in_output_dir.size () != 0);

        PBD::remove_directory (output_dir_path);

        // doesn't actually remove directory though...just contents
        CPPUNIT_ASSERT (Glib::file_test (output_dir_path, Glib::FILE_TEST_IS_DIR));

        files_in_output_dir.clear ();

        PBD::get_paths (files_in_output_dir, output_dir_path, false, true);

        CPPUNIT_ASSERT (files_in_output_dir.size () == 0);
}

void
FilesystemTest::testCanonicalPath ()
{
#ifndef PLATFORM_WINDOWS
        string top_dir = test_output_directory ("testCanonicalPath");
        PwdReset pwd_reset(top_dir);

        string pwd = Glib::get_current_dir ();

        CPPUNIT_ASSERT (!pwd.empty());
        CPPUNIT_ASSERT (pwd == top_dir);

        CPPUNIT_ASSERT (g_mkdir ("gtk2_ardour", 0755) == 0);
        CPPUNIT_ASSERT (g_mkdir_with_parents ("libs/pbd/test", 0755) == 0);

        const char* relative_path = "./gtk2_ardour/../libs/pbd/test";
        string canonical_path = PBD::canonical_path (relative_path);
        // no expansion expected in this case
        string expanded_path = PBD::path_expand (relative_path);
        string expected_path = top_dir + string("/libs/pbd/test");

        CPPUNIT_ASSERT (canonical_path == expected_path);
        CPPUNIT_ASSERT (expanded_path == expected_path);
#endif
}