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

• #include "clar_libgit2.h"
  #include "describe_helpers.h"
  
  void test_describe_describe__can_describe_against_a_bare_repo(void)
  {
  	git_repository *repo;
  	git_describe_options opts = GIT_DESCRIBE_OPTIONS_INIT;
  	git_describe_format_options fmt_opts = GIT_DESCRIBE_FORMAT_OPTIONS_INIT;
  
  	cl_git_pass(git_repository_open(&repo, cl_fixture("testrepo.git")));
  
  	assert_describe("hard_tag", "HEAD", repo, &opts, &fmt_opts);
  
  	opts.show_commit_oid_as_fallback = 1;
  
  	assert_describe("be3563a*", "HEAD^", repo, &opts, &fmt_opts);
  
  	git_repository_free(repo);
  }
  
  static int delete_cb(git_reference *ref, void *payload)
  {
  	GIT_UNUSED(payload);
  
  	cl_git_pass(git_reference_delete(ref));
  	git_reference_free(ref);
  
  	return 0;
  }
  
  void test_describe_describe__describe_a_repo_with_no_refs(void)
  {
  	git_repository *repo;
  	git_describe_options opts = GIT_DESCRIBE_OPTIONS_INIT;
  	git_str buf = GIT_STR_INIT;
  	git_object *object;
  	git_describe_result *result = NULL;
  
  	repo = cl_git_sandbox_init("testrepo.git");
  	cl_git_pass(git_revparse_single(&object, repo, "HEAD"));
  
  	cl_git_pass(git_reference_foreach(repo, delete_cb, NULL));
  
  	/* Impossible to describe without falling back to OIDs */
  	cl_git_fail(git_describe_commit(&result, object, &opts));
  
  	/* Try again with OID fallbacks */
  	opts.show_commit_oid_as_fallback = 1;
  	cl_git_pass(git_describe_commit(&result, object, &opts));
  
  	git_describe_result_free(result);
  	git_object_free(object);
  	git_str_dispose(&buf);
  	cl_git_sandbox_cleanup();
  }
  

Download