thodg/libgit2/tests/submodule/escape.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/submodule/escape.c

• #include "clar_libgit2.h"
  #include "posix.h"
  #include "path.h"
  #include "submodule_helpers.h"
  #include "futils.h"
  #include "repository.h"
  
  static git_repository *g_repo = NULL;
  
  void test_submodule_escape__cleanup(void)
  {
  	cl_git_sandbox_cleanup();
  }
  
  #define EVIL_SM_NAME "../../modules/evil"
  #define EVIL_SM_NAME_WINDOWS "..\\\\..\\\\modules\\\\evil"
  #define EVIL_SM_NAME_WINDOWS_UNESC "..\\..\\modules\\evil"
  
  static int find_evil(git_submodule *sm, const char *name, void *payload)
  {
  	int *foundit = (int *) payload;
  
  	GIT_UNUSED(sm);
  
  	if (!git__strcmp(EVIL_SM_NAME, name) ||
  	    !git__strcmp(EVIL_SM_NAME_WINDOWS_UNESC, name))
  		*foundit = true;
  
  	return 0;
  }
  
  void test_submodule_escape__from_gitdir(void)
  {
  	int foundit;
  	git_submodule *sm;
  	git_str buf = GIT_STR_INIT;
  	unsigned int sm_location;
  
  	g_repo = setup_fixture_submodule_simple();
  
  	cl_git_pass(git_str_joinpath(&buf, git_repository_workdir(g_repo), ".gitmodules"));
  	cl_git_rewritefile(buf.ptr,
  			   "[submodule \"" EVIL_SM_NAME "\"]\n"
  			   "    path = testrepo\n"
  			   "    url = ../testrepo.git\n");
  	git_str_dispose(&buf);
  
  	/* Find it all the different ways we know about it */
  	foundit = 0;
  	cl_git_pass(git_submodule_foreach(g_repo, find_evil, &foundit));
  	cl_assert_equal_i(0, foundit);
  	cl_git_fail_with(GIT_ENOTFOUND, git_submodule_lookup(&sm, g_repo, EVIL_SM_NAME));
  	/*
  	 * We do know about this as it's in the index and HEAD, but the data is
  	 * incomplete as there is no configured data for it (we pretend it
  	 * doesn't exist). This leaves us with an odd situation but it's
  	 * consistent with what we would do if we did add a submodule with no
  	 * configuration.
  	 */
  	cl_git_pass(git_submodule_lookup(&sm, g_repo, "testrepo"));
  	cl_git_pass(git_submodule_location(&sm_location, sm));
  	cl_assert_equal_i(GIT_SUBMODULE_STATUS_IN_INDEX | GIT_SUBMODULE_STATUS_IN_HEAD, sm_location);
  	git_submodule_free(sm);
  }
  
  void test_submodule_escape__from_gitdir_windows(void)
  {
  	int foundit;
  	git_submodule *sm;
  	git_str buf = GIT_STR_INIT;
  	unsigned int sm_location;
  
  	g_repo = setup_fixture_submodule_simple();
  
  	cl_git_pass(git_str_joinpath(&buf, git_repository_workdir(g_repo), ".gitmodules"));
  	cl_git_rewritefile(buf.ptr,
  			   "[submodule \"" EVIL_SM_NAME_WINDOWS "\"]\n"
  			   "    path = testrepo\n"
  			   "    url = ../testrepo.git\n");
  	git_str_dispose(&buf);
  
  	/* Find it all the different ways we know about it */
  	foundit = 0;
  	cl_git_pass(git_submodule_foreach(g_repo, find_evil, &foundit));
  	cl_assert_equal_i(0, foundit);
  	cl_git_fail_with(GIT_ENOTFOUND, git_submodule_lookup(&sm, g_repo, EVIL_SM_NAME_WINDOWS_UNESC));
  	/*
  	 * We do know about this as it's in the index and HEAD, but the data is
  	 * incomplete as there is no configured data for it (we pretend it
  	 * doesn't exist). This leaves us with an odd situation but it's
  	 * consistent with what we would do if we did add a submodule with no
  	 * configuration.
  	 */
  	cl_git_pass(git_submodule_lookup(&sm, g_repo, "testrepo"));
  	cl_git_pass(git_submodule_location(&sm_location, sm));
  	cl_assert_equal_i(GIT_SUBMODULE_STATUS_IN_INDEX | GIT_SUBMODULE_STATUS_IN_HEAD, sm_location);
  	git_submodule_free(sm);
  }
  

Download