Add filesystem code unit tests (bug #23216)

This is somewhat incomplete, but already covers most core functionality
and helped uncover an important bug in the BFS implementation (see
commit 1c927c8).

Most notably, normalize_path() isn't tested yet, as well as corner cases
with empty strings and get_wml_location().

data/test/test/filesystem/enum/A1.cfg

@@ -0,0 +1 @@
+

data/test/test/filesystem/enum/A2.cfg

@@ -0,0 +1 @@
+

data/test/test/filesystem/enum/A3.cfg

@@ -0,0 +1 @@
+

data/test/test/filesystem/enum/B1.cfg

@@ -0,0 +1 @@
+

data/test/test/filesystem/enum/B2.cfg

@@ -0,0 +1 @@
+

data/test/test/filesystem/enum/B3.cfg

@@ -0,0 +1 @@
+

data/test/test/filesystem/enum/_final.cfg

@@ -0,0 +1 @@
+

data/test/test/filesystem/enum/_initial.cfg

@@ -0,0 +1 @@
+

src/CMakeLists.txt

@@ -1433,6 +1433,7 @@ if(ENABLE_TESTS)
 		tests/test_commandline_options.cpp
 		tests/test_config.cpp
 		tests/test_config_cache.cpp
+		tests/test_filesystem.cpp
 		tests/test_formula_ai.cpp
 		tests/test_formula_function.cpp
 		tests/test_image_modifications.cpp

src/SConscript

@@ -736,6 +736,7 @@ test_sources = Split("""
     tests/test_addons.cpp
     tests/test_commandline_options.cpp
     tests/test_config.cpp
+    tests/test_filesystem.cpp
     tests/test_formula_ai.cpp
     tests/test_formula_function.cpp
     tests/test_image_modifications.cpp

src/tests/test_filesystem.cpp

@@ -0,0 +1,196 @@
+/*
+   Copyright (C) 2015 by Ignacio R. Morelle <shadowm2006@gmail.com>
+   Part of the Battle for Wesnoth Project http://www.wesnoth.org/
+
+   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.
+
+   See the COPYING file for more details.
+*/
+
+#include <boost/test/unit_test.hpp>
+#include "filesystem.hpp"
+#include "game_config.hpp"
+
+#include <boost/assign/list_of.hpp>
+#include <boost/foreach.hpp>
+
+using boost::assign::list_of;
+
+#include <iostream>
+
+#if 0
+namespace {
+
+template<typename T>
+void dump(const T& v)
+{
+	for(typename T::const_iterator k = v.begin(); k != v.end(); ++k) {
+		std::cerr << " * " << *k << '\n';
+	}
+}
+
+}
+#endif
+
+BOOST_AUTO_TEST_SUITE( filesystem ) // implicit namespace filesystem
+
+const std::string& gamedata = game_config::path;
+
+BOOST_AUTO_TEST_CASE( test_fs_game_path_reverse_engineering )
+{
+	const std::string maincfg = "_main.cfg";
+
+	std::string gamedata_rev = get_wml_location("_main.cfg");
+
+	const size_t strip_len = (maincfg + "/data/").length();
+	BOOST_REQUIRE(gamedata_rev.length() > strip_len);
+	gamedata_rev.resize(gamedata_rev.length() - strip_len);
+
+	BOOST_CHECK_EQUAL( gamedata_rev, gamedata );
+}
+
+BOOST_AUTO_TEST_CASE( test_fs_base )
+{
+	BOOST_CHECK( is_directory("/") );
+	BOOST_CHECK( is_directory("/.") );
+	BOOST_CHECK( is_directory("/./././.") );
+	BOOST_CHECK( is_directory("/..") );
+
+	BOOST_CHECK( is_directory(".") );
+	BOOST_CHECK( is_directory("..") );
+	BOOST_CHECK( is_directory("./././.") );
+
+	BOOST_CHECK( is_directory(gamedata + "/data/core/../../data/././../data/././core") );
+
+	BOOST_CHECK( file_exists("/") );
+	BOOST_CHECK( file_exists("/.") );
+	BOOST_CHECK( file_exists("/./././.") );
+	BOOST_CHECK( file_exists("/..") );
+
+	BOOST_CHECK_EQUAL( base_name("foo/bar/baz.cfg"), "baz.cfg" );
+	// FIXME: BFS gives "." for this, Unix basename gives "bar"!
+	//BOOST_CHECK_EQUAL( base_name("foo/bar/"), "bar" );
+	BOOST_CHECK_EQUAL( base_name("foo/bar"), "bar" );
+	BOOST_CHECK_EQUAL( base_name("/"), "/" );
+	BOOST_CHECK_EQUAL( base_name(""), "" );
+
+	BOOST_CHECK_EQUAL( directory_name("foo/bar/baz.cfg"), "foo/bar" );
+	BOOST_CHECK_EQUAL( directory_name("foo/bar/"), "foo/bar" );
+	BOOST_CHECK_EQUAL( directory_name("foo/bar"), "foo" );
+	BOOST_CHECK_EQUAL( directory_name("/"), "" );
+	BOOST_CHECK_EQUAL( directory_name(""), "" );
+
+	// TODO normalize_path
+
+	//BOOST_CHECK_EQUAL( normalize_path(gamedata + "/data/core/../../data/././../data/././core"),
+	//                   gamedata + "/data/core" );
+}
+
+BOOST_AUTO_TEST_CASE( test_fs_enum )
+{
+	const std::string path = "data/test/test/filesystem/enum";
+
+	const std::vector<std::string> expected_filenames = list_of
+		("_initial.cfg")
+		("A1.cfg")
+		("A2.cfg")
+		("A3.cfg")
+		("B1.cfg")
+		("B2.cfg")
+		("B3.cfg")
+		("_final.cfg");
+	const std::vector<std::string> expected_dirnames = list_of
+		("D1")
+		("D2")
+		("D3");
+
+	std::vector<std::string> files, dirs;
+	std::vector<std::string> expected_filepaths, expected_dirpaths;
+
+	BOOST_FOREACH(const std::string& n, expected_filenames) {
+		expected_filepaths.push_back(gamedata + "/" + path + "/" + n);
+	}
+
+	BOOST_FOREACH(const std::string& n, expected_dirnames) {
+		expected_dirpaths.push_back(gamedata + "/" + path + "/" + n);
+	}
+
+	// FIXME: get_files_in_dir with mode == FILE_NAME_ONLY will fail to reorder
+	//        entries because the sorting code looks for forward slashes.
+	//        This affects both the BFS-based and legacy implementations.
+	get_files_in_dir(path, &files, &dirs, ENTIRE_FILE_PATH, NO_FILTER, DO_REORDER);
+
+	BOOST_CHECK( files == expected_filepaths );
+	BOOST_CHECK( dirs  == expected_dirpaths  );
+}
+
+BOOST_AUTO_TEST_CASE( test_fs_binary_path )
+{
+	BOOST_CHECK_EQUAL( get_binary_dir_location("images", "."), gamedata + "/images/." );
+
+	BOOST_CHECK_EQUAL( get_binary_file_location("images", "././././././"),
+	                   gamedata + "/images/././././././" );
+
+	BOOST_CHECK_EQUAL( get_binary_file_location("images", "wesnoth-icon.png"),
+	                   gamedata + "/data/core/images/wesnoth-icon.png" );
+
+	BOOST_CHECK_EQUAL( get_binary_file_location("music", "silence.ogg"),
+	                   gamedata + "/data/core/music/silence.ogg" );
+
+	BOOST_CHECK_EQUAL( get_binary_file_location("sounds", "explosion.ogg"),
+	                   gamedata + "/data/core/sounds/explosion.ogg" );
+
+	BOOST_CHECK_EQUAL( get_independent_image_path("wesnoth-icon.png"),
+	                   "data/core/images/wesnoth-icon.png" );
+
+	// Inexistent paths are resolved empty.
+	BOOST_CHECK( get_binary_dir_location("images", "").empty() );
+	BOOST_CHECK( get_binary_dir_location("inexistent_resource_type", "").empty() );
+	BOOST_CHECK( get_binary_file_location("image", "wesnoth-icon.png").empty() );
+	BOOST_CHECK( get_binary_file_location("images", "bunnies_and_ponies_and_rainbows_oh_em_gee.psd").empty() );
+	BOOST_CHECK( get_binary_file_location("music", "this_track_does_not_exist.aiff").empty() );
+	BOOST_CHECK( get_binary_file_location("sounds", "rude_noises.aiff").empty() );
+	BOOST_CHECK( get_independent_image_path("dopefish.txt").empty() );
+}
+
+BOOST_AUTO_TEST_CASE( test_fs_wml_path )
+{
+	BOOST_CHECK_EQUAL( get_wml_location("_main.cfg"), gamedata + "/data/_main.cfg" );
+	BOOST_CHECK_EQUAL( get_wml_location("core/_main.cfg"), gamedata + "/data/core/_main.cfg" );
+	BOOST_CHECK_EQUAL( get_wml_location("."), gamedata + "/data/." );
+
+	// Inexistent paths are resolved empty.
+	BOOST_CHECK( get_wml_location("why_would_anyone_ever_name_a_file_like_this").empty() );
+}
+
+BOOST_AUTO_TEST_CASE( test_fs_fluff )
+{
+	BOOST_CHECK( ends_with("foobarbazbat", "bazbat") );
+
+	BOOST_CHECK( looks_like_pbl("foo.pbl") );
+	BOOST_CHECK( looks_like_pbl("FOO.PBL") );
+	BOOST_CHECK( looks_like_pbl("Foo.Pbl") );
+	BOOST_CHECK( !looks_like_pbl("foo.pbl.cfg") );
+
+	BOOST_CHECK( is_gzip_file("foo.gz") );
+	BOOST_CHECK( !is_gzip_file("foo.gz.bz2") );
+	BOOST_CHECK( is_bzip2_file("foo.bz2") );
+	BOOST_CHECK( !is_bzip2_file("foo.bz2.gz") );
+
+	BOOST_CHECK( is_compressed_file("foo.gz") );
+	BOOST_CHECK( is_compressed_file("foo.bz2") );
+	BOOST_CHECK( !is_compressed_file("foo.txt") );
+
+	// FIXME: Is this even intended?
+	BOOST_CHECK( !is_gzip_file("foo.GZ") );
+	BOOST_CHECK( !is_bzip2_file("foo.BZ2") );
+	BOOST_CHECK( !is_compressed_file("foo.GZ") );
+	BOOST_CHECK( !is_compressed_file("foo.BZ2") );
+}
+
+BOOST_AUTO_TEST_SUITE_END()