path: root/net-libs/grpc/grpc-1.75.1.ebuild

# Copyright 1999-2025 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2

EAPI=8

CMAKE_IN_SOURCE_BUILD=1
PYTHON_COMPAT=( python3_{11..13} )
inherit cmake flag-o-matic python-any-r1

MY_PV="${PV//_pre/-pre}"

DESCRIPTION="Modern open source high performance RPC framework"
HOMEPAGE="https://grpc.io"

ENVOY_API_COMMIT="4de3c74cf21a9958c1cf26d8993c55c6e0d28b49"
GOOGLEAPIS_COMMIT="fe8ba054ad4f7eca946c2d14a63c3f07c0b586a0"
XDS_COMMIT="3a472e524827f72d1ad621c4983dd5af54c46776"
PROTOC_GEN_VALIDATE_COMMIT="7b06248484ceeaa947e93ca2747eccf336a88ecc"

SRC_URI="
	https://github.com/${PN}/${PN}/archive/v${MY_PV}.tar.gz -> ${P}.gh.tar.gz
	test? (
		https://github.com/envoyproxy/data-plane-api/archive/${ENVOY_API_COMMIT}.tar.gz
		-> envoi-api-${ENVOY_API_COMMIT}.tar.gz
		https://github.com/googleapis/googleapis/archive/${GOOGLEAPIS_COMMIT}.tar.gz
		-> googleapis-${GOOGLEAPIS_COMMIT}.tar.gz
		https://github.com/cncf/xds/archive/${XDS_COMMIT}.tar.gz
		-> xds-${XDS_COMMIT}.tar.gz
		https://github.com/bufbuild/protoc-gen-validate/archive/${PROTOC_GEN_VALIDATE_COMMIT}.tar.gz
		-> protoc-gen-validate-${PROTOC_GEN_VALIDATE_COMMIT}.tar.gz
	)
"

S="${WORKDIR}/${PN}-${MY_PV}"
LICENSE="Apache-2.0"

# NOTE
# format is 0/${CORE_SOVERSION//./}.${CPP_SOVERSION//./} , check top level CMakeLists.txt
SLOT="0/50.$(ver_rs 1-2 '' "$(ver_cut 1-2)")"

KEYWORDS="~alpha ~amd64 ~arm ~arm64 ~loong ~ppc64 ~riscv ~x86"
IUSE="doc examples test systemd"
RESTRICT="!test? ( test )"

# look for submodule versions in third_party dir
RDEPEND="
	>=dev-cpp/abseil-cpp-20250127:=
	>=dev-libs/re2-0.2022.04.01:=
	>=dev-libs/openssl-1.1.1:0=[-bindist(-)]
	>=dev-libs/protobuf-31.1:=
	dev-libs/xxhash
	>=net-dns/c-ares-1.19.1:=
	virtual/zlib:=
	systemd? ( sys-apps/systemd:= )
"
DEPEND="
	${RDEPEND}
	test? (
		dev-cpp/benchmark
		dev-cpp/gflags
		dev-cpp/gtest
	)
"
BDEPEND="
	${RDEPEND}
	virtual/pkgconfig
	test? (
		net-misc/curl
		$(python_gen_any_dep '
			dev-python/twisted[${PYTHON_USEDEP}]
			dev-python/pyyaml[${PYTHON_USEDEP}]
			dev-python/cffi[${PYTHON_USEDEP}]
			dev-python/six[${PYTHON_USEDEP}]
		')
	)
"

PATCHES=(
	"${FILESDIR}/${PN}-1.71.0-system-gtest.patch"
	"${FILESDIR}/${PN}-1.74.1-fix-missing-__stop_linkarr_upb_AllExts.patch"
)

python_check_deps() {
	if use test; then
		python_has_version -b "dev-python/twisted[${PYTHON_USEDEP}]" &&
		python_has_version -b "dev-python/pyyaml[${PYTHON_USEDEP}]" &&
		python_has_version -b "dev-python/cffi[${PYTHON_USEDEP}]" &&
		python_has_version -b "dev-python/six[${PYTHON_USEDEP}]"
	fi
}

soversion_check() {
	local core_sover cpp_sover
	# extract quoted number. line we check looks like this: 'set(gRPC_CPP_SOVERSION    "1.37")'
	core_sover="$(grep 'set(gRPC_CORE_SOVERSION ' CMakeLists.txt  | sed '/.*\"\(.*\)\".*/ s//\1/')"
	cpp_sover="$(grep 'set(gRPC_CPP_SOVERSION ' CMakeLists.txt  | sed '/.*\"\(.*\)\".*/ s//\1/')"
	# remove dots, e.g. 1.37 -> 137
	core_sover="${core_sover//./}"
	cpp_sover="${cpp_sover//./}"
	[[ ${core_sover} -eq $(ver_cut 2 "${SLOT}") ]] || die "fix core sublot! should be ${core_sover}"
	[[ ${cpp_sover} -eq $(ver_cut 3 "${SLOT}") ]] || die "fix cpp sublot! should be ${cpp_sover}"
}

src_prepare() {
	soversion_check

	if use test; then
		rmdir third_party/envoy-api || die
		ln -frs "${WORKDIR}/data-plane-api-${ENVOY_API_COMMIT}" third_party/envoy-api || die
		rmdir third_party/googleapis || die
		ln -frs "${WORKDIR}/googleapis-${GOOGLEAPIS_COMMIT}" third_party/googleapis || die
		rmdir third_party/xds || die
		ln -frs "${WORKDIR}/xds-${XDS_COMMIT}" third_party/xds || die
		rmdir third_party/protoc-gen-validate || die
		ln -frs "${WORKDIR}/protoc-gen-validate-${PROTOC_GEN_VALIDATE_COMMIT}" third_party/protoc-gen-validate || die

		sed "/gmock_main.cc/d" -i CMakeLists.txt || die

		# These extra libs are defined as dependencies of the vendored gtest,
		# which is a dependency of the unit tests, therefore they are normally
		# implicitly picked up and linked to the test binaries.  However removing
		# the vendored gtest to use the system one also removes these dependencies,
		# so we have to redeclare them as dependencies of the test binaries individually.
		local extra_libs=(
			"GTest::gtest"
			"GTest::gmock_main"
			"\${_gRPC_RE2_LIBRARIES}"
			"absl::flat_hash_set"
			"absl::failure_signal_handler"
			"absl::stacktrace"
			"absl::symbolize"
			"absl::flags"
			"absl::flags_parse"
			"absl::flags_reflection"
			"absl::flags_usage"
			"absl::strings"
			"absl::any"
			"absl::optional"
			"absl::variant"
		)
		: "$(echo "${extra_libs[@]}" | "${EPYTHON}" -c 'import sys;print("\\n\\1".join(sys.stdin.read().split()))')"
		local rstring="${_}"
		sed -i -E "s/( +)gtest/\1${rstring}/g" "CMakeLists.txt" || die

		# Integrate tests with ctest rather than the custom test framework.
		# Formatted with dev-python/black.
		"${EPYTHON}" - >> "${S}/CMakeLists.txt" <<-EOF
			import json, pathlib

			print("if(gRPC_BUILD_TESTS)")
			for line in [
			  json.dumps([t["name"], "./" + t["name"], *t["args"]]).translate(
			    str.maketrans(dict.fromkeys("[],", None))
			  )
			  for t in json.loads(
			    pathlib.Path("tools/run_tests/generated/tests.json").read_text()
			  )
			    if "linux" in t["platforms"] and not t["flaky"] and not t.get("boringssl", False)
			]:
			  print(f"  add_test({line})")
			print("endif()")
		EOF

		# Weird path issue. All tests except these two assume they are running from top-level src
		# This is caused by running add_test from the top-level src dir. So WORKING_DIR becomes $S
		# sed -i -E "s/lslash != nullptr/false/" "test/core/util/http_client/httpcli_test_util.cc" || die
		# So we make it output to cmake/build as the code expects and run it from there.
		cat >> "${S}/CMakeLists.txt" <<- EOF || die
		if(gRPC_BUILD_TESTS)
		  set_target_properties(httpcli_test httpscli_test PROPERTIES RUNTIME_OUTPUT_DIRECTORY "\${CMAKE_CURRENT_BINARY_DIR}/cmake/build")
		  set_tests_properties(httpcli_test httpscli_test PROPERTIES WORKING_DIRECTORY "\${CMAKE_CURRENT_BINARY_DIR}/cmake/build")
		endif()
		EOF

		mkdir "${S}/cmake/build" || die

		# Respect EPYTHON when testing, don't touch installed files otherwise
		python_fix_shebang --force "${S}"

		# NOTE doesn't apply if we don't replace gtest/abseil libs
		eapply "${FILESDIR}/${PN}-1.71.0-fix-already-registered.patch"
	fi

	# Called via system() by some of the C++ sources, respect EPYTHON
	sed -i -E "s#for p in #for p in \"${EPYTHON}\"#" "tools/distrib/python_wrapper.sh" || die

	cmake_src_prepare

	# un-hardcode libdir
	sed -i "s@/lib@/$(get_libdir)@" cmake/pkg-config-template.pc.in || die

# 	# suppress network access, package builds fine without the submodules
# 	mkdir "${S}/third_party/opencensus-proto/src" || die
}

src_configure() {
	# https://github.com/grpc/grpc/issues/29652
	filter-lto

	local mycmakeargs=(
		-DgRPC_DOWNLOAD_ARCHIVES="no"
		-DgRPC_INSTALL="yes"
		-DgRPC_INSTALL_CMAKEDIR="$(get_libdir)/cmake/${PN}"
		-DgRPC_INSTALL_LIBDIR="$(get_libdir)"

		-DgRPC_ABSL_PROVIDER="package"
		-DgRPC_CARES_PROVIDER="package"
		-DgRPC_PROTOBUF_PROVIDER="package"
		-DgRPC_RE2_PROVIDER="package"
		-DgRPC_SSL_PROVIDER="package"
		-DgRPC_ZLIB_PROVIDER="package"

		-DgRPC_BUILD_TESTS="$(usex test)"
		-DgRPC_USE_SYSTEMD="$(usex systemd ON OFF)" # Checks via STREQUAL
	)

	if use test; then
		mycmakeargs+=(
			-DgRPC_BENCHMARK_PROVIDER="package"
		)
	fi

	cmake_src_configure
}

src_test() {
	prlimit --nofile=4096 --pid=$$

	# This is normally done with start_port_server.py, but this forks and exits,
	# while we need to capture the pid, so run it ourselves
	"${EPYTHON}" "tools/run_tests/python_utils/port_server.py" \
		-p 32766 -l "${T}/port_server.log" &
	local port_server_pid="${!}"

	# Reimplementation of what start_port_server.py does with curl
	curl --retry 9999 --retry-all-errors --retry-max-time 120 \
		--fail --silent --output /dev/null "http://localhost:32766/get" || die

	CMAKE_SKIP_TESTS=(
		"^httpcli_test$"
		# CallCommandWithTimeoutDeadlineSet has a timeout set to 5000.25 seconds
		^grpc_tool_test$

		# Needs network access
		^posix_event_engine_native_dns_test$
		^posix_event_engine_test$
		^resolve_address_using_ares_resolver_test$
		^resolve_address_using_native_resolver_test$

		# TODO Needs SPIFFE
		"^spiffe_bundle_map_end2end_test$"

		^xds_listener_resource_type_test$

		# 954185
		'^server_test$'

		# skipped via GTEST_FILTER
		'^xds_audit_logger_registry_test$'
		'^xds_common_types_test$'
		'^xds_http_filters_test$'
		'^xds_lb_policy_registry_test$'
		'^xds_route_config_resource_type_test$'
	)

	use amd64 && CMAKE_SKIP_TESTS+=(
		^examine_stack_test$ # fails on amd64 only
		^stack_tracer_test$ # fails on amd64 only
	)

	use alpha && CMAKE_SKIP_TESTS+=(
		^endpoint_pair_test$ # fails on alpha
		^event_poller_posix_test$ # fails on alpha
		^tcp_posix_test$ # fails on alpha
	)

	# TODO make this test specific
	local GTEST_SKIP_TESTS=(
		xds_audit_logger_registry_test
		XdsAuditLoggerRegistryTest.InvalidThirdPartyLoggerConfig
		XdsAuditLoggerRegistryTest.ValidThirdPartyLogger

		# xds_common_types_test
		ExtractXdsExtensionTest.TypedStruct
		ExtractXdsExtensionTest.TypedStructJsonConversion
		ExtractXdsExtensionTest.TypedStructTypeUrlMissing
		ExtractXdsExtensionTest.TypedStructTypeUrlNoSlash
		ExtractXdsExtensionTest.TypedStructTypeUrlNothingAfterSlash
		ExtractXdsExtensionTest.TypedStructWithInvalidProtobufStruct
		ExtractXdsExtensionTest.UdpaTypedStruct

		# xds_http_filters_test
		"XdsFaultFilter/XdsFaultInjectionFilterConfigTest.BasicConfig/*"
		"XdsFaultFilter/XdsFaultInjectionFilterConfigTest.HeaderAbortAndDelay/*"
		"XdsRbacFilter/XdsRbacFilterConfigTest.AllPermissionTypes/*"
		"XdsRbacFilter/XdsRbacFilterConfigTest.AllPrincipalTypes/*"
		"XdsRbacFilter/XdsRbacFilterConfigTest.AuditLoggingOptionsIgnoredWithFeatureDisabled/*"
		"XdsRbacFilter/XdsRbacFilterConfigTest.AuditLoggingOptions/*"
		"XdsRbacFilter/XdsRbacFilterConfigTest.InvalidAuditLoggerConfig/*"
		"XdsRbacFilter/XdsRbacFilterConfigTest.InvalidFieldsInPolicy/*"
		"XdsRbacFilter/XdsRbacFilterConfigTest.InvalidHeaderMatchers/*"
		"XdsRbacFilter/XdsRbacFilterConfigTest.InvalidStringMatchers/*"
		"XdsRbacFilter/XdsRbacFilterConfigTest.InvalidPermissionAndPrincipal/*"
		"XdsStatefulSessionFilter/XdsStatefulSessionFilterConfigTest.MinimalConfig/*"
		"XdsStatefulSessionFilter/XdsStatefulSessionFilterConfigTest.PathAndTtl/*"
		"XdsStatefulSessionFilter/XdsStatefulSessionFilterConfigTest.CookieNameNotPresent/*"
		"XdsStatefulSessionFilter/XdsStatefulSessionFilterConfigTest.InvalidTtl/*"
		"XdsStatefulSessionFilter/XdsStatefulSessionFilterConfigTest.TypedStructSessionState/*"

		# xds_lb_policy_registry_test
		CustomPolicy.Basic
		WrrLocality.UnsupportedChildPolicyTypeSkipped
		XdsLbPolicyRegistryTest.ErrorExtractingExtension
		XdsLbPolicyRegistryTest.MaxRecursion

		# xds_route_config_resource_type_test
		RlsTest.Basic
		RlsTest.DuplicateClusterSpecifierPluginNames
		RlsTest.InvalidGrpcLbPolicyConfig
		RlsTest.NotUsedInAllVirtualHosts
		RlsTest.PluginDefinedButNotUsed
		"RouteMatchTest.*"
		"MaxStreamDurationTest.*"
		VirtualHostTest.BadDomainPattern
		VirtualHostTest.MultipleVirtualHosts
		VirtualHostTest.NoDomainsSpecified
		XdsRouteConfigTest.MinimumValidConfig
		RetryPolicyOverrideTest.RoutePolicyOverridesVhostPolicy
	)

	local -x GTEST_FILTER
	[[ -n ${GTEST_SKIP_TESTS[*]} ]] && GTEST_FILTER+="-$( IFS=':'; echo "${GTEST_SKIP_TESTS[*]}")"

	# BUG this should be nonfatal and we kill the server even when tests fail
	nonfatal \
	cmake_src_test
	local ret=$?

	einfo "stopping start_port_server.py at PID ${port_server_pid}"
	kill "${port_server_pid}" || die

	[[ ${ret} -ne 0 ]] && die "cmake_src_test failed"
}

src_install() {
	cmake_src_install

	if use examples; then
		find examples -name '.gitignore' -delete || die
		dodoc -r examples
		docompress -x "/usr/share/doc/${PF}/examples"
	fi

	if use doc; then
		find doc -name '.gitignore' -delete || die
		local DOCS=( AUTHORS CONCEPTS.md README.md TROUBLESHOOTING.md doc/. )
	fi

	einstalldocs
}