thodg/libgit2/tests/config/global.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/config/global.c

• #include "clar_libgit2.h"
  #include "futils.h"
  
  void test_config_global__initialize(void)
  {
  	git_str path = GIT_STR_INIT;
  
  	cl_git_pass(git_futils_mkdir_r("home", 0777));
  	cl_git_pass(git_path_prettify(&path, "home", NULL));
  	cl_git_pass(git_libgit2_opts(
  		GIT_OPT_SET_SEARCH_PATH, GIT_CONFIG_LEVEL_GLOBAL, path.ptr));
  
  	cl_git_pass(git_futils_mkdir_r("xdg/git", 0777));
  	cl_git_pass(git_path_prettify(&path, "xdg/git", NULL));
  	cl_git_pass(git_libgit2_opts(
  		GIT_OPT_SET_SEARCH_PATH, GIT_CONFIG_LEVEL_XDG, path.ptr));
  
  	cl_git_pass(git_futils_mkdir_r("etc", 0777));
  	cl_git_pass(git_path_prettify(&path, "etc", NULL));
  	cl_git_pass(git_libgit2_opts(
  		GIT_OPT_SET_SEARCH_PATH, GIT_CONFIG_LEVEL_SYSTEM, path.ptr));
  
  	git_str_dispose(&path);
  }
  
  void test_config_global__cleanup(void)
  {
  	cl_sandbox_set_search_path_defaults();
  	cl_git_pass(git_futils_rmdir_r("home", NULL, GIT_RMDIR_REMOVE_FILES));
  	cl_git_pass(git_futils_rmdir_r("xdg", NULL, GIT_RMDIR_REMOVE_FILES));
  	cl_git_pass(git_futils_rmdir_r("etc", NULL, GIT_RMDIR_REMOVE_FILES));
  }
  
  void test_config_global__open_global(void)
  {
  	git_config *cfg, *global, *selected, *dummy;
  	int32_t value;
  
  	cl_git_mkfile("home/.gitconfig", "[global]\n  test = 4567\n");
  
  	cl_git_pass(git_config_open_default(&cfg));
  	cl_git_pass(git_config_get_int32(&value, cfg, "global.test"));
  	cl_assert_equal_i(4567, value);
  
  	cl_git_pass(git_config_open_level(&global, cfg, GIT_CONFIG_LEVEL_GLOBAL));
  	cl_git_pass(git_config_get_int32(&value, global, "global.test"));
  	cl_assert_equal_i(4567, value);
  
  	cl_git_fail(git_config_open_level(&dummy, cfg, GIT_CONFIG_LEVEL_XDG));
  
  	cl_git_pass(git_config_open_global(&selected, cfg));
  	cl_git_pass(git_config_get_int32(&value, selected, "global.test"));
  	cl_assert_equal_i(4567, value);
  
  	git_config_free(selected);
  	git_config_free(global);
  	git_config_free(cfg);
  }
  
  void test_config_global__open_symlinked_global(void)
  {
  #ifndef GIT_WIN32
  	git_config *cfg;
  	int32_t value;
  
  	cl_git_mkfile("home/.gitconfig.linked", "[global]\n  test = 4567\n");
  	cl_must_pass(symlink(".gitconfig.linked", "home/.gitconfig"));
  
  	cl_git_pass(git_config_open_default(&cfg));
  	cl_git_pass(git_config_get_int32(&value, cfg, "global.test"));
  	cl_assert_equal_i(4567, value);
  
  	git_config_free(cfg);
  #endif
  }
  
  void test_config_global__lock_missing_global_config(void)
  {
  	git_config *cfg;
  	git_config_entry *entry;
  	git_transaction *transaction;
  
  	(void)p_unlink("home/.gitconfig"); /* No global config */
  
  	cl_git_pass(git_config_open_default(&cfg));
  	cl_git_pass(git_config_lock(&transaction, cfg));
  	cl_git_pass(git_config_set_string(cfg, "assertion.fail", "boom"));
  	cl_git_pass(git_transaction_commit(transaction));
  	git_transaction_free(transaction);
  
  	/* cfg is updated */
  	cl_git_pass(git_config_get_entry(&entry, cfg, "assertion.fail"));
  	cl_assert_equal_s("boom", entry->value);
  
  	git_config_entry_free(entry);
  	git_config_free(cfg);
  
  	/* We can reread the new value from the global config */
  	cl_git_pass(git_config_open_default(&cfg));
  	cl_git_pass(git_config_get_entry(&entry, cfg, "assertion.fail"));
  	cl_assert_equal_s("boom", entry->value);
  
  	git_config_entry_free(entry);
  	git_config_free(cfg);
  }
  
  void test_config_global__open_xdg(void)
  {
  	git_config *cfg, *xdg, *selected;
  	const char *str = "teststring";
  	const char *key = "this.variable";
  	git_buf buf = {0};
  
  	cl_git_mkfile("xdg/git/config", "# XDG config\n[core]\n  test = 1\n");
  
  	cl_git_pass(git_config_open_default(&cfg));
  	cl_git_pass(git_config_open_level(&xdg, cfg, GIT_CONFIG_LEVEL_XDG));
  	cl_git_pass(git_config_open_global(&selected, cfg));
  
  	cl_git_pass(git_config_set_string(xdg, key, str));
  	cl_git_pass(git_config_get_string_buf(&buf, selected, key));
  	cl_assert_equal_s(str, buf.ptr);
  
  	git_buf_dispose(&buf);
  	git_config_free(selected);
  	git_config_free(xdg);
  	git_config_free(cfg);
  }
  
  void test_config_global__open_programdata(void)
  {
  	git_config *cfg;
  	git_repository *repo;
  	git_buf dir_path = GIT_BUF_INIT;
  	git_str config_path = GIT_STR_INIT;
  	git_buf var_contents = GIT_BUF_INIT;
  
  	if (cl_is_env_set("GITTEST_INVASIVE_FS_STRUCTURE"))
  		cl_skip();
  
  	cl_git_pass(git_libgit2_opts(GIT_OPT_GET_SEARCH_PATH,
  		GIT_CONFIG_LEVEL_PROGRAMDATA, &dir_path));
  
  	if (!git_path_isdir(dir_path.ptr))
  		cl_git_pass(p_mkdir(dir_path.ptr, 0777));
  
  	cl_git_pass(git_str_joinpath(&config_path, dir_path.ptr, "config"));
  
  	cl_git_pass(git_config_open_ondisk(&cfg, config_path.ptr));
  	cl_git_pass(git_config_set_string(cfg, "programdata.var", "even higher level"));
  
  	git_str_dispose(&config_path);
  	git_config_free(cfg);
  
  	git_config_open_default(&cfg);
  	cl_git_pass(git_config_get_string_buf(&var_contents, cfg, "programdata.var"));
  	cl_assert_equal_s("even higher level", var_contents.ptr);
  
  	git_config_free(cfg);
  	git_buf_dispose(&var_contents);
  
  	cl_git_pass(git_repository_init(&repo, "./foo.git", true));
  	cl_git_pass(git_repository_config(&cfg, repo));
  	cl_git_pass(git_config_get_string_buf(&var_contents, cfg, "programdata.var"));
  	cl_assert_equal_s("even higher level", var_contents.ptr);
  
  	git_config_free(cfg);
  	git_buf_dispose(&dir_path);
  	git_buf_dispose(&var_contents);
  	git_repository_free(repo);
  	cl_fixture_cleanup("./foo.git");
  }
  

Download