thodg/libgit2/tests/stream/deprecated.c

• Show log

  Commit

• Hash : c6184f0c
  Author :
  Date : 2020-06-08T21:07:36
  

  tree-wide: do not compile deprecated functions with hard deprecation When compiling libgit2 with -DDEPRECATE_HARD, we add a preprocessor definition `GIT_DEPRECATE_HARD` which causes the "git2/deprecated.h" header to be empty. As a result, no function declarations are made available to callers, but the implementations are still available to link against. This has the problem that function declarations also aren't visible to the implementations, meaning that the symbol's visibility will not be set up correctly. As a result, the resulting library may not expose those deprecated symbols at all on some platforms and thus cause linking errors. Fix the issue by conditionally compiling deprecated functions, only. While it becomes impossible to link against such a library in case one uses deprecated functions, distributors of libgit2 aren't expected to pass -DDEPRECATE_HARD anyway. Instead, users of libgit2 should manually define GIT_DEPRECATE_HARD to hide deprecated functions. Using "real" hard deprecation still makes sense in the context of CI to test we don't use deprecated symbols ourselves and in case a dependant uses libgit2 in a vendored way and knows it won't ever use any of the deprecated symbols anyway.

Download

• tests/stream/deprecated.c

• #include "clar_libgit2.h"
  #include "git2/sys/stream.h"
  #include "streams/tls.h"
  #include "streams/socket.h"
  #include "stream.h"
  
  void test_stream_deprecated__cleanup(void)
  {
  	cl_git_pass(git_stream_register(GIT_STREAM_TLS | GIT_STREAM_STANDARD, NULL));
  }
  
  #ifndef GIT_DEPRECATE_HARD
  static git_stream test_stream;
  static int ctor_called;
  
  static int test_stream_init(git_stream **out, const char *host, const char *port)
  {
  	GIT_UNUSED(host);
  	GIT_UNUSED(port);
  
  	ctor_called = 1;
  	*out = &test_stream;
  
  	return 0;
  }
  #endif
  
  void test_stream_deprecated__register_tls(void)
  {
  #ifndef GIT_DEPRECATE_HARD
  	git_stream *stream;
  	int error;
  
  	ctor_called = 0;
  	cl_git_pass(git_stream_register_tls(test_stream_init));
  	cl_git_pass(git_tls_stream_new(&stream, "localhost", "443"));
  	cl_assert_equal_i(1, ctor_called);
  	cl_assert_equal_p(&test_stream, stream);
  
  	ctor_called = 0;
  	stream = NULL;
  	cl_git_pass(git_stream_register_tls(NULL));
  	error = git_tls_stream_new(&stream, "localhost", "443");
  
  	/*
  	 * We don't have TLS support enabled, or we're on Windows,
  	 * which has no arbitrary TLS stream support.
  	 */
  #if defined(GIT_WIN32) || !defined(GIT_HTTPS)
  	cl_git_fail_with(-1, error);
  #else
  	cl_git_pass(error);
  #endif
  
  	cl_assert_equal_i(0, ctor_called);
  	cl_assert(&test_stream != stream);
  
  	git_stream_free(stream);
  #endif
  }
  

Download