blender/tests/gtests/blenlib/BLI_path_util_test.cc

/* Apache License, Version 2.0 */

#include "testing/testing.h"

extern "C" {
#include "BLI_fileops.h"
#include "BLI_path_util.h"
#include "BLI_string.h"
#include "../../../source/blender/imbuf/IMB_imbuf.h"

#ifdef _WIN32
#  include "../../../source/blender/blenkernel/BKE_global.h"
#endif

}

/* -------------------------------------------------------------------- */
/* stubs */

extern "C" {

#if _WIN32
Global G = {0};
#endif

const char *GHOST_getUserDir(int version, const char *versionstr);
const char *GHOST_getSystemDir(int version, const char *versionstr);
#ifdef __linux__
char *zLhm65070058860608_br_find_exe(const char *default_exe);
#endif

const char *GHOST_getUserDir(int version, const char *versionstr)
{
	return "/home/user";
}

const char *GHOST_getSystemDir(int version, const char *versionstr)
{
	return "/system/path";
}

struct ImBuf;
void IMB_freeImBuf(struct ImBuf *ibuf) {}
struct ImBuf *IMB_dupImBuf(const ImBuf *ibuf) {return NULL;}

#ifdef __linux__
char *zLhm65070058860608_br_find_exe(const char *default_exe)
{
	return NULL;
}
#endif

}


/* -------------------------------------------------------------------- */
/* tests */

/* BLI_cleanup_path */
#ifndef _WIN32
TEST(path_util, Clean)
{
	/* "/./" -> "/" */
	{
		char path[FILE_MAX] = "/a/./b/./c/./";
		BLI_cleanup_path(NULL, path);
		EXPECT_STREQ("/a/b/c/", path);
	}

	{
		char path[FILE_MAX] = "/./././";
		BLI_cleanup_path(NULL, path);
		EXPECT_STREQ("/", path);
	}

	{
		char path[FILE_MAX] = "/a/./././b/";
		BLI_cleanup_path(NULL, path);
		EXPECT_STREQ("/a/b/", path);
	}

	/* "//" -> "/" */
	{
		char path[FILE_MAX] = "a////";
		BLI_cleanup_path(NULL, path);
		EXPECT_STREQ("a/", path);
	}

	if (0)  /* FIXME */
	{
		char path[FILE_MAX] = "./a////";
		BLI_cleanup_path(NULL, path);
		EXPECT_STREQ("./a/", path);
	}

	/* "foo/bar/../" -> "foo/" */
	{
		char path[FILE_MAX] = "/a/b/c/../../../";
		BLI_cleanup_path(NULL, path);
		EXPECT_STREQ("/", path);
	}

	{
		char path[FILE_MAX] = "/a/../a/b/../b/c/../c/";
		BLI_cleanup_path(NULL, path);
		EXPECT_STREQ("/a/b/c/", path);
	}

	{
		char path[FILE_MAX] = "//../";
		BLI_cleanup_path("/a/b/c/", path);
		EXPECT_STREQ("/a/b/", path);
	}
}
#endif


#define AT_INDEX(str_input, index_input, str_expect) \
	{ \
		char path[] = str_input; \
		const char *expect = str_expect; \
		int index_output, len_output; \
		const bool ret = BLI_path_name_at_index(path, index_input, &index_output, &len_output); \
		if (expect == NULL) { \
			EXPECT_EQ(ret, false); \
		} \
		else { \
			EXPECT_EQ(ret, true); \
			EXPECT_EQ(strlen(expect), len_output); \
			path[index_output + len_output] = '\0'; \
			EXPECT_STREQ(&path[index_output], expect); \
		} \
	}((void)0)

/* BLI_path_name_at_index */
TEST(path_util, NameAtIndex_Single)
{
	AT_INDEX("/a", 0, "a");
	AT_INDEX("/a/", 0, "a");
	AT_INDEX("a/", 0, "a");
	AT_INDEX("//a//", 0, "a");
	AT_INDEX("a/b", 0, "a");

	AT_INDEX("/a", 1, NULL);
	AT_INDEX("/a/", 1, NULL);
	AT_INDEX("a/", 1, NULL);
	AT_INDEX("//a//", 1, NULL);
}
TEST(path_util, NameAtIndex_SingleNeg)
{
	AT_INDEX("/a", -1, "a");
	AT_INDEX("/a/", -1, "a");
	AT_INDEX("a/", -1, "a");
	AT_INDEX("//a//", -1, "a");
	AT_INDEX("a/b", -1, "b");

	AT_INDEX("/a", -2, NULL);
	AT_INDEX("/a/", -2, NULL);
	AT_INDEX("a/", -2, NULL);
	AT_INDEX("//a//", -2, NULL);
}

TEST(path_util, NameAtIndex_Double)
{
	AT_INDEX("/ab", 0, "ab");
	AT_INDEX("/ab/", 0, "ab");
	AT_INDEX("ab/", 0, "ab");
	AT_INDEX("//ab//", 0, "ab");
	AT_INDEX("ab/c", 0, "ab");

	AT_INDEX("/ab", 1, NULL);
	AT_INDEX("/ab/", 1, NULL);
	AT_INDEX("ab/", 1, NULL);
	AT_INDEX("//ab//", 1, NULL);
}

TEST(path_util, NameAtIndex_DoublNeg)
{
	AT_INDEX("/ab", -1, "ab");
	AT_INDEX("/ab/", -1, "ab");
	AT_INDEX("ab/", -1, "ab");
	AT_INDEX("//ab//", -1, "ab");
	AT_INDEX("ab/c", -1, "c");

	AT_INDEX("/ab", -2, NULL);
	AT_INDEX("/ab/", -2, NULL);
	AT_INDEX("ab/", -2, NULL);
	AT_INDEX("//ab//", -2, NULL);
}

TEST(path_util, NameAtIndex_Misc)
{
	AT_INDEX("/how/now/brown/cow", 0, "how");
	AT_INDEX("/how/now/brown/cow", 1, "now");
	AT_INDEX("/how/now/brown/cow", 2, "brown");
	AT_INDEX("/how/now/brown/cow", 3, "cow");
	AT_INDEX("/how/now/brown/cow", 4, NULL);
	AT_INDEX("/how/now/brown/cow/", 4, NULL);
}

TEST(path_util, NameAtIndex_MiscNeg)
{
	AT_INDEX("/how/now/brown/cow", 0, "how");
	AT_INDEX("/how/now/brown/cow", 1, "now");
	AT_INDEX("/how/now/brown/cow", 2, "brown");
	AT_INDEX("/how/now/brown/cow", 3, "cow");
	AT_INDEX("/how/now/brown/cow", 4, NULL);
	AT_INDEX("/how/now/brown/cow/", 4, NULL);
}

TEST(path_util, NameAtIndex_MiscComplex)
{
	AT_INDEX("how//now/brown/cow", 0, "how");
	AT_INDEX("//how///now\\/brown/cow", 1, "now");
	AT_INDEX("/how/now\\//brown\\/cow", 2, "brown");
	AT_INDEX("/how/now/brown/cow//\\", 3, "cow");
	AT_INDEX("/how/now/brown/\\cow", 4, NULL);
	AT_INDEX("how/now/brown/\\cow\\", 4, NULL);
}

TEST(path_util, NameAtIndex_MiscComplexNeg)
{
	AT_INDEX("how//now/brown/cow", -4, "how");
	AT_INDEX("//how///now\\/brown/cow", -3, "now");
	AT_INDEX("/how/now\\//brown\\/cow", -2, "brown");
	AT_INDEX("/how/now/brown/cow//\\", -1, "cow");
	AT_INDEX("/how/now/brown/\\cow", -5, NULL);
	AT_INDEX("how/now/brown/\\cow\\", -5, NULL);
}

TEST(path_util, NameAtIndex_NoneComplex)
{
	AT_INDEX("", 0, NULL);
	AT_INDEX("/", 0, NULL);
	AT_INDEX("//", 0, NULL);
	AT_INDEX("///", 0, NULL);
}

TEST(path_util, NameAtIndex_NoneComplexNeg)
{
	AT_INDEX("", -1, NULL);
	AT_INDEX("/", -1, NULL);
	AT_INDEX("//", -1, NULL);
	AT_INDEX("///", -1, NULL);
}

#undef AT_INDEX

#define JOIN(str_expect, out_size, ...) \
	{ \
		const char *expect = str_expect; \
		char result[(out_size) + 1024]; \
		/* check we don't write past the last byte */ \
		result[out_size] = '\0'; \
		BLI_path_join(result, out_size, __VA_ARGS__, NULL); \
		/* simplify expected string */ \
		BLI_str_replace_char(result, '\\', '/'); \
		EXPECT_STREQ(result, expect); \
		EXPECT_EQ(result[out_size], '\0'); \
	} ((void)0)

/* BLI_path_join */
TEST(path_util, JoinNop)
{
	JOIN("", 100, "");
	JOIN("", 100, "", "");
	JOIN("", 100, "", "", "");
	JOIN("/", 100, "/", "", "");
	JOIN("/", 100, "/", "/");
	JOIN("/", 100, "/", "", "/");
	JOIN("/", 100, "/", "", "/", "");
}

TEST(path_util, JoinSingle)
{
	JOIN("test", 100, "test");
	JOIN("", 100, "");
	JOIN("a", 100, "a");
	JOIN("/a", 100, "/a");
	JOIN("a/", 100, "a/");
	JOIN("/a/", 100, "/a/");
	JOIN("/a/", 100, "/a//");
	JOIN("//a/", 100, "//a//");
}

TEST(path_util, JoinTriple)
{
	JOIN("/a/b/c", 100, "/a", "b", "c");
	JOIN("/a/b/c", 100, "/a/", "/b/", "/c");
	JOIN("/a/b/c", 100, "/a/b/", "/c");
	JOIN("/a/b/c", 100, "/a/b/c");
	JOIN("/a/b/c", 100, "/", "a/b/c");

	JOIN("/a/b/c/", 100, "/a/", "/b/", "/c/");
	JOIN("/a/b/c/", 100, "/a/b/c/");
	JOIN("/a/b/c/", 100, "/a/b/", "/c/");
	JOIN("/a/b/c/", 100, "/a/b/c", "/");
	JOIN("/a/b/c/", 100, "/", "a/b/c", "/");
}

TEST(path_util, JoinTruncateShort)
{
	JOIN("", 1, "/");
	JOIN("/", 2, "/");
	JOIN("a", 2, "", "aa");
	JOIN("a", 2, "", "a/");
	JOIN("a/b", 4, "a", "bc");
	JOIN("ab/", 4, "ab", "c");
	JOIN("/a/", 4, "/a", "b");
	JOIN("/a/", 4, "/a/", "b/");
	JOIN("/a/", 4, "/a", "/b/");
	JOIN("/a/", 4, "/", "a/b/");
	JOIN("//a", 4, "//", "a/b/");

	JOIN("/a/b", 5, "/a", "b", "c");
}

TEST(path_util, JoinTruncateLong)
{
	JOIN("", 1, "//", "//longer", "path");
	JOIN("/", 2, "//", "//longer", "path");
	JOIN("//", 3, "//", "//longer", "path");
	JOIN("//l", 4, "//", "//longer", "path");
	/* snip */
	JOIN("//longe", 8, "//", "//longer", "path");
	JOIN("//longer", 9, "//", "//longer", "path");
	JOIN("//longer/", 10, "//", "//longer", "path");
	JOIN("//longer/p", 11, "//", "//longer", "path");
	JOIN("//longer/pa", 12, "//", "//longer", "path");
	JOIN("//longer/pat", 13, "//", "//longer", "path");
	JOIN("//longer/path", 14, "//", "//longer", "path"); // not truncated
	JOIN("//longer/path", 14, "//", "//longer", "path/");
	JOIN("//longer/path/", 15, "//", "//longer", "path/"); // not truncated
	JOIN("//longer/path/", 15, "//", "//longer", "path/", "trunc");
	JOIN("//longer/path/t", 16, "//", "//longer", "path/", "trunc");
}

TEST(path_util, JoinComplex)
{
	JOIN("/a/b/c/d/e/f/g/", 100, "/", "\\a/b", "//////c/d", "", "e\\\\", "f", "g//");
	JOIN("/aa/bb/cc/dd/ee/ff/gg/", 100, "/", "\\aa/bb", "//////cc/dd", "", "ee\\\\", "ff", "gg//");
	JOIN("1/2/3/", 100, "1", "////////", "", "2", "3\\");
}

#undef JOIN

/* BLI_path_frame */
TEST(path_util, Frame)
{
	bool ret;

	{
		char path[FILE_MAX] = "";
		ret = BLI_path_frame(path, 123, 1);
		EXPECT_EQ(ret, 1);
		EXPECT_STREQ("123", path);
	}

	{
		char path[FILE_MAX] = "";
		ret = BLI_path_frame(path, 123, 12);
		EXPECT_EQ(ret, 1);
		EXPECT_STREQ("000000000123", path);
	}

	{
		char path[FILE_MAX] = "test_";
		ret = BLI_path_frame(path, 123, 1);
		EXPECT_EQ(ret, 1);
		EXPECT_STREQ("test_123", path);
	}

	{
		char path[FILE_MAX] = "test_";
		ret = BLI_path_frame(path, 1, 12);
		EXPECT_EQ(ret, 1);
		EXPECT_STREQ("test_000000000001", path);
	}

	{
		char path[FILE_MAX] = "test_############";
		ret = BLI_path_frame(path, 1, 0);
		EXPECT_EQ(ret, 1);
		EXPECT_STREQ("test_000000000001", path);
	}

	{
		char path[FILE_MAX] = "test_#_#_middle";
		ret = BLI_path_frame(path, 123, 0);
		EXPECT_EQ(ret, 1);
		EXPECT_STREQ("test_#_123_middle", path);
	}

	/* intentionally fail */
	{
		char path[FILE_MAX] = "";
		ret = BLI_path_frame(path, 123, 0);
		EXPECT_EQ(ret, 0);
		EXPECT_STREQ("", path);
	}

	{
		char path[FILE_MAX] = "test_middle";
		ret = BLI_path_frame(path, 123, 0);
		EXPECT_EQ(ret, 0);
		EXPECT_STREQ("test_middle", path);
	}
}

/* BLI_split_dirfile */
TEST(path_util, SplitDirfile)
{
	{
		const char *path = "";
		char dir[FILE_MAX], file[FILE_MAX];
		BLI_split_dirfile(path, dir, file, sizeof(dir), sizeof(file));
		EXPECT_STREQ("", dir);
		EXPECT_STREQ("", file);
	}

	{
		const char *path = "/";
		char dir[FILE_MAX], file[FILE_MAX];
		BLI_split_dirfile(path, dir, file, sizeof(dir), sizeof(file));
		EXPECT_STREQ("/", dir);
		EXPECT_STREQ("", file);
	}

	{
		const char *path = "fileonly";
		char dir[FILE_MAX], file[FILE_MAX];
		BLI_split_dirfile(path, dir, file, sizeof(dir), sizeof(file));
		EXPECT_STREQ("", dir);
		EXPECT_STREQ("fileonly", file);
	}

	{
		const char *path = "dironly/";
		char dir[FILE_MAX], file[FILE_MAX];
		BLI_split_dirfile(path, dir, file, sizeof(dir), sizeof(file));
		EXPECT_STREQ("dironly/", dir);
		EXPECT_STREQ("", file);
	}

	{
		const char *path = "/a/b";
		char dir[FILE_MAX], file[FILE_MAX];
		BLI_split_dirfile(path, dir, file, sizeof(dir), sizeof(file));
		EXPECT_STREQ("/a/", dir);
		EXPECT_STREQ("b", file);
	}

	{
		const char *path = "/dirtoobig/filetoobig";
		char dir[5], file[5];
		BLI_split_dirfile(path, dir, file, sizeof(dir), sizeof(file));
		EXPECT_STREQ("/dir", dir);
		EXPECT_STREQ("file", file);

		BLI_split_dirfile(path, dir, file, 1, 1);
		EXPECT_STREQ("", dir);
		EXPECT_STREQ("", file);
	}
}