thodg/libgit2/tests/core/env.c

• Show log

  Commit

• Hash : f0e693b1
  Author :
  Date : 2021-09-07T17:53:49
  

  str: introduce `git_str` for internal, `git_buf` is external libgit2 has two distinct requirements that were previously solved by `git_buf`. We require: 1. A general purpose string class that provides a number of utility APIs for manipulating data (eg, concatenating, truncating, etc). 2. A structure that we can use to return strings to callers that they can take ownership of. By using a single class (`git_buf`) for both of these purposes, we have confused the API to the point that refactorings are difficult and reasoning about correctness is also difficult. Move the utility class `git_buf` to be called `git_str`: this represents its general purpose, as an internal string buffer class. The name also is an homage to Junio Hamano ("gitstr"). The public API remains `git_buf`, and has a much smaller footprint. It is generally only used as an "out" param with strict requirements that follow the documentation. (Exceptions exist for some legacy APIs to avoid breaking callers unnecessarily.) Utility functions exist to convert a user-specified `git_buf` to a `git_str` so that we can call internal functions, then converting it back again.

Download

• tests/core/env.c

• #include "clar_libgit2.h"
  #include "futils.h"
  #include "sysdir.h"
  #include "path.h"
  
  #ifdef GIT_WIN32
  #define NUM_VARS 5
  static const char *env_vars[NUM_VARS] = {
  	"HOME", "HOMEDRIVE", "HOMEPATH", "USERPROFILE", "PROGRAMFILES"
  };
  #else
  #define NUM_VARS 1
  static const char *env_vars[NUM_VARS] = { "HOME" };
  #endif
  
  static char *env_save[NUM_VARS];
  
  static char *home_values[] = {
  	"fake_home",
  	"f\xc3\xa1ke_h\xc3\xb5me", /* all in latin-1 supplement */
  	"f\xc4\x80ke_\xc4\xa4ome", /* latin extended */
  	"f\xce\xb1\xce\xba\xce\xb5_h\xce\xbfm\xce\xad",  /* having fun with greek */
  	"fa\xe0" "\xb8" "\x87" "e_\xe0" "\xb8" "\x99" "ome", /* thai characters */
  	"f\xe1\x9c\x80ke_\xe1\x9c\x91ome", /* tagalog characters */
  	"\xe1\xb8\x9f\xe1\xba\xa2" "ke_ho" "\xe1" "\xb9" "\x81" "e", /* latin extended additional */
  	"\xf0\x9f\x98\x98\xf0\x9f\x98\x82", /* emoticons */
  	NULL
  };
  
  void test_core_env__initialize(void)
  {
  	int i;
  	for (i = 0; i < NUM_VARS; ++i)
  		env_save[i] = cl_getenv(env_vars[i]);
  }
  
  static void set_global_search_path_from_env(void)
  {
  	cl_git_pass(git_sysdir_set(GIT_SYSDIR_GLOBAL, NULL));
  }
  
  static void set_system_search_path_from_env(void)
  {
  	cl_git_pass(git_sysdir_set(GIT_SYSDIR_SYSTEM, NULL));
  }
  
  void test_core_env__cleanup(void)
  {
  	int i;
  	char **val;
  
  	for (i = 0; i < NUM_VARS; ++i) {
  		cl_setenv(env_vars[i], env_save[i]);
  		git__free(env_save[i]);
  		env_save[i] = NULL;
  	}
  
  	/* these will probably have already been cleaned up, but if a test
  	 * fails, then it's probably good to try and clear out these dirs
  	 */
  	for (val = home_values; *val != NULL; val++) {
  		if (**val != '\0')
  			(void)p_rmdir(*val);
  	}
  
  	cl_sandbox_set_search_path_defaults();
  }
  
  static void setenv_and_check(const char *name, const char *value)
  {
  	char *check;
  
  	cl_git_pass(cl_setenv(name, value));
  	check = cl_getenv(name);
  
  	if (value)
  		cl_assert_equal_s(value, check);
  	else
  		cl_assert(check == NULL);
  
  	git__free(check);
  }
  
  void test_core_env__0(void)
  {
  	git_str path = GIT_STR_INIT, found = GIT_STR_INIT;
  	char testfile[16], tidx = '0';
  	char **val;
  	const char *testname = "testfile";
  	size_t testlen = strlen(testname);
  
  	strncpy(testfile, testname, sizeof(testfile));
  	cl_assert_equal_s(testname, testfile);
  
  	for (val = home_values; *val != NULL; val++) {
  
  		/* if we can't make the directory, let's just assume
  		 * we are on a filesystem that doesn't support the
  		 * characters in question and skip this test...
  		 */
  		if (p_mkdir(*val, 0777) != 0) {
  			*val = ""; /* mark as not created */
  			continue;
  		}
  
  		cl_git_pass(git_path_prettify(&path, *val, NULL));
  
  		/* vary testfile name in each directory so accidentally leaving
  		 * an environment variable set from a previous iteration won't
  		 * accidentally make this test pass...
  		 */
  		testfile[testlen] = tidx++;
  		cl_git_pass(git_str_joinpath(&path, path.ptr, testfile));
  		cl_git_mkfile(path.ptr, "find me");
  		git_str_rtruncate_at_char(&path, '/');
  
  		cl_assert_equal_i(
  			GIT_ENOTFOUND, git_sysdir_find_global_file(&found, testfile));
  
  		setenv_and_check("HOME", path.ptr);
  		set_global_search_path_from_env();
  
  		cl_git_pass(git_sysdir_find_global_file(&found, testfile));
  
  		cl_setenv("HOME", env_save[0]);
  		set_global_search_path_from_env();
  
  		cl_assert_equal_i(
  			GIT_ENOTFOUND, git_sysdir_find_global_file(&found, testfile));
  
  #ifdef GIT_WIN32
  		setenv_and_check("HOMEDRIVE", NULL);
  		setenv_and_check("HOMEPATH", NULL);
  		setenv_and_check("USERPROFILE", path.ptr);
  		set_global_search_path_from_env();
  
  		cl_git_pass(git_sysdir_find_global_file(&found, testfile));
  
  		{
  			int root = git_path_root(path.ptr);
  			char old;
  
  			if (root >= 0) {
  				setenv_and_check("USERPROFILE", NULL);
  				set_global_search_path_from_env();
  
  				cl_assert_equal_i(
  					GIT_ENOTFOUND, git_sysdir_find_global_file(&found, testfile));
  
  				old = path.ptr[root];
  				path.ptr[root] = '\0';
  				setenv_and_check("HOMEDRIVE", path.ptr);
  				path.ptr[root] = old;
  				setenv_and_check("HOMEPATH", &path.ptr[root]);
  				set_global_search_path_from_env();
  
  				cl_git_pass(git_sysdir_find_global_file(&found, testfile));
  			}
  		}
  #endif
  
  		(void)p_rmdir(*val);
  	}
  
  	git_str_dispose(&path);
  	git_str_dispose(&found);
  }
  
  
  void test_core_env__1(void)
  {
  	git_str path = GIT_STR_INIT;
  
  	cl_assert_equal_i(
  		GIT_ENOTFOUND, git_sysdir_find_global_file(&path, "nonexistentfile"));
  
  	cl_git_pass(cl_setenv("HOME", "doesnotexist"));
  #ifdef GIT_WIN32
  	cl_git_pass(cl_setenv("HOMEPATH", "doesnotexist"));
  	cl_git_pass(cl_setenv("USERPROFILE", "doesnotexist"));
  #endif
  	set_global_search_path_from_env();
  
  	cl_assert_equal_i(
  		GIT_ENOTFOUND, git_sysdir_find_global_file(&path, "nonexistentfile"));
  
  	cl_git_pass(cl_setenv("HOME", NULL));
  #ifdef GIT_WIN32
  	cl_git_pass(cl_setenv("HOMEPATH", NULL));
  	cl_git_pass(cl_setenv("USERPROFILE", NULL));
  #endif
  	set_global_search_path_from_env();
  	set_system_search_path_from_env();
  
  	cl_assert_equal_i(
  		GIT_ENOTFOUND, git_sysdir_find_global_file(&path, "nonexistentfile"));
  
  	cl_assert_equal_i(
  		GIT_ENOTFOUND, git_sysdir_find_system_file(&path, "nonexistentfile"));
  
  #ifdef GIT_WIN32
  	cl_git_pass(cl_setenv("PROGRAMFILES", NULL));
  	set_system_search_path_from_env();
  
  	cl_assert_equal_i(
  		GIT_ENOTFOUND, git_sysdir_find_system_file(&path, "nonexistentfile"));
  #endif
  
  	git_str_dispose(&path);
  }
  
  static void check_global_searchpath(
  	const char *path, int position, const char *file, git_str *temp)
  {
  	git_str out = GIT_STR_INIT;
  
  	/* build and set new path */
  	if (position < 0)
  		cl_git_pass(git_str_join(temp, GIT_PATH_LIST_SEPARATOR, path, "$PATH"));
  	else if (position > 0)
  		cl_git_pass(git_str_join(temp, GIT_PATH_LIST_SEPARATOR, "$PATH", path));
  	else
  		cl_git_pass(git_str_sets(temp, path));
  
  	cl_git_pass(git_libgit2_opts(
  		GIT_OPT_SET_SEARCH_PATH, GIT_CONFIG_LEVEL_GLOBAL, temp->ptr));
  
  	/* get path and make sure $PATH expansion worked */
  	cl_git_pass(git_libgit2_opts(
  		GIT_OPT_GET_SEARCH_PATH, GIT_CONFIG_LEVEL_GLOBAL, &out));
  
  	if (position < 0)
  		cl_assert(git__prefixcmp(out.ptr, path) == 0);
  	else if (position > 0)
  		cl_assert(git__suffixcmp(out.ptr, path) == 0);
  	else
  		cl_assert_equal_s(out.ptr, path);
  
  	/* find file using new path */
  	cl_git_pass(git_sysdir_find_global_file(temp, file));
  
  	/* reset path and confirm file not found */
  	cl_git_pass(git_libgit2_opts(
  		GIT_OPT_SET_SEARCH_PATH, GIT_CONFIG_LEVEL_GLOBAL, NULL));
  	cl_assert_equal_i(
  		GIT_ENOTFOUND, git_sysdir_find_global_file(temp, file));
  
  	git_str_dispose(&out);
  }
  
  void test_core_env__2(void)
  {
  	git_str path = GIT_STR_INIT, found = GIT_STR_INIT;
  	char testfile[16], tidx = '0';
  	char **val;
  	const char *testname = "alternate";
  	size_t testlen = strlen(testname);
  
  	strncpy(testfile, testname, sizeof(testfile));
  	cl_assert_equal_s(testname, testfile);
  
  	for (val = home_values; *val != NULL; val++) {
  
  		/* if we can't make the directory, let's just assume
  		 * we are on a filesystem that doesn't support the
  		 * characters in question and skip this test...
  		 */
  		if (p_mkdir(*val, 0777) != 0 && errno != EEXIST) {
  			*val = ""; /* mark as not created */
  			continue;
  		}
  
  		cl_git_pass(git_path_prettify(&path, *val, NULL));
  
  		/* vary testfile name so any sloppiness is resetting variables or
  		 * deleting files won't accidentally make a test pass.
  		 */
  		testfile[testlen] = tidx++;
  		cl_git_pass(git_str_joinpath(&path, path.ptr, testfile));
  		cl_git_mkfile(path.ptr, "find me");
  		git_str_rtruncate_at_char(&path, '/');
  
  		/* default should be NOTFOUND */
  		cl_assert_equal_i(
  			GIT_ENOTFOUND, git_sysdir_find_global_file(&found, testfile));
  
  		/* try plain, append $PATH, and prepend $PATH */
  		check_global_searchpath(path.ptr,  0, testfile, &found);
  		check_global_searchpath(path.ptr, -1, testfile, &found);
  		check_global_searchpath(path.ptr,  1, testfile, &found);
  
  		/* cleanup */
  		cl_git_pass(git_str_joinpath(&path, path.ptr, testfile));
  		(void)p_unlink(path.ptr);
  		(void)p_rmdir(*val);
  	}
  
  	git_str_dispose(&path);
  	git_str_dispose(&found);
  }
  
  void test_core_env__substitution(void)
  {
    git_str buf = GIT_STR_INIT, expected = GIT_STR_INIT;
  
    /* Set it to something non-default so we have controllable values */
    cl_git_pass(git_libgit2_opts(GIT_OPT_SET_SEARCH_PATH, GIT_CONFIG_LEVEL_GLOBAL, "/tmp/a"));
    cl_git_pass(git_libgit2_opts(GIT_OPT_GET_SEARCH_PATH, GIT_CONFIG_LEVEL_GLOBAL, &buf));
    cl_assert_equal_s("/tmp/a", buf.ptr);
  
    git_str_clear(&buf);
    cl_git_pass(git_str_join(&buf, GIT_PATH_LIST_SEPARATOR, "$PATH", "/tmp/b"));
    cl_git_pass(git_libgit2_opts(GIT_OPT_SET_SEARCH_PATH, GIT_CONFIG_LEVEL_GLOBAL, buf.ptr));
    cl_git_pass(git_libgit2_opts(GIT_OPT_GET_SEARCH_PATH, GIT_CONFIG_LEVEL_GLOBAL, &buf));
  
    cl_git_pass(git_str_join(&expected, GIT_PATH_LIST_SEPARATOR, "/tmp/a", "/tmp/b"));
    cl_assert_equal_s(expected.ptr, buf.ptr);
  
    git_str_dispose(&expected);
    git_str_dispose(&buf);
  }
  

Download