mirror of
https://github.com/php-win-ext/grpc.git
synced 2026-03-24 17:12:19 +01:00
83cdbfff8c
Apply Obsolete attribute to deprecated services and methods in C# generated code Fix for https://github.com/grpc/grpc/issues/28597 - Deprecated support for enums and enum values is already fixed by https://github.com/protocolbuffers/protobuf/pull/10520 but this is not yet released. It is fixed in Protocol Buffers v22.0-rc1 but the gRPC repo currently has 21.12 as the protocol buffers submodule. - Deprecated support for messages and fields already exists in the protocol buffers compiler. The fix in this PR adds `Obsolete` attribute to classes and methods for deprecated services and methods within services. e.g. ``` service Greeter { option deprecated=true; // service level deprecated // Sends a greeting rpc SayHello (HelloRequest) returns (HelloReply) { option deprecated=true; // method level deprecated } } ``` I couldn't find any protocol buffers plugin tests to update. Tested locally.
116 lines
3.8 KiB
Bash
Executable File
116 lines
3.8 KiB
Bash
Executable File
#!/bin/bash
|
|
# Copyright 2023 gRPC authors.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
# Run this script via bazel test
|
|
# It expects that protoc and grpc_csharp_plugin have already been built.
|
|
|
|
# Simple test - compare generated output to expected files
|
|
|
|
set -x
|
|
|
|
TESTNAME=deprecated
|
|
|
|
# protoc and grpc_csharp_plugin binaries are supplied as "data" in bazel
|
|
PROTOC=./external/com_google_protobuf/protoc
|
|
PLUGIN=./src/compiler/grpc_csharp_plugin
|
|
|
|
# where to find the test data
|
|
DATA_DIR=./test/csharp/codegen/${TESTNAME}
|
|
|
|
# output directory for the generated files
|
|
PROTO_OUT=./proto_out
|
|
rm -rf ${PROTO_OUT}
|
|
mkdir -p ${PROTO_OUT}
|
|
|
|
# run protoc and the plugin
|
|
$PROTOC \
|
|
--plugin=protoc-gen-grpc=$PLUGIN \
|
|
--csharp_out=${PROTO_OUT} \
|
|
--grpc_out=${PROTO_OUT} \
|
|
-I ${DATA_DIR}/proto \
|
|
${DATA_DIR}/proto/depnothing.proto \
|
|
${DATA_DIR}/proto/depservice.proto \
|
|
${DATA_DIR}/proto/depmethod.proto
|
|
|
|
# log the files generated
|
|
ls -l ./proto_out
|
|
|
|
# Rather than doing a diff against a known file, just using grep to
|
|
# check for some of the code changes when "deprecated" is specified.
|
|
# This isn't bullet proof but does avoid tests breaking when other
|
|
# codegen changes are made.
|
|
|
|
# For depnothing.proto there should zero "ObsoleteAttribute" found
|
|
nmatches=$(grep -c ObsoleteAttribute ${PROTO_OUT}/DepnothingGrpc.cs)
|
|
if [ "$nmatches" -ne 0 ]
|
|
then
|
|
echo >&2 "Unexpected ObsoleteAttribute in DepnothingGrpc.cs"
|
|
exit 1
|
|
fi
|
|
|
|
# For depservice.proto need to check ObsoleteAttribute added to three classes.
|
|
# First check ObsoleteAttribute exists in output
|
|
nmatches=$(grep -c ObsoleteAttribute ${PROTO_OUT}/DepserviceGrpc.cs)
|
|
if [ "$nmatches" -eq 0 ]
|
|
then
|
|
echo >&2 "Missing ObsoleteAttribute in DepserviceGrpc.cs"
|
|
exit 1
|
|
fi
|
|
|
|
# capture context after ObsoleteAttribute for further checking
|
|
CTX=$(grep -A 2 ObsoleteAttribute ${PROTO_OUT}/DepserviceGrpc.cs)
|
|
|
|
# Check ObsoleteAttribute before class GreeterServiceLevelDep
|
|
nmatches=$(echo "$CTX" | grep -c "class GreeterServiceLevelDep$" )
|
|
if [ "$nmatches" -ne 1 ]
|
|
then
|
|
echo >&2 "Missing ObsoleteAttribute on class GreeterServiceLevelDep"
|
|
exit 1
|
|
fi
|
|
# Check ObsoleteAttribute before class GreeterServiceLevelDepBase
|
|
nmatches=$(echo "$CTX" | grep -c "class GreeterServiceLevelDepBase$" )
|
|
if [ "$nmatches" -ne 1 ]
|
|
then
|
|
echo >&2 "Missing ObsoleteAttribute on class GreeterServiceLevelDepBase"
|
|
exit 1
|
|
fi
|
|
# Check ObsoleteAttribute before class GreeterServiceLevelDepClient
|
|
nmatches=$(echo "$CTX" | grep -c "class GreeterServiceLevelDepClient" )
|
|
if [ "$nmatches" -ne 1 ]
|
|
then
|
|
echo >&2 "Missing ObsoleteAttribute on class GreeterServiceLevelDepClient"
|
|
exit 1
|
|
fi
|
|
|
|
# For depmethod.proto need to check ObsoleteAttribute added in five places for SayHello method.
|
|
# Check ObsoleteAttribute exists in output
|
|
nmatches=$(grep -c ObsoleteAttribute ${PROTO_OUT}/DepmethodGrpc.cs)
|
|
if [ "$nmatches" -eq 0 ]
|
|
then
|
|
echo >&2 "Missing ObsoleteAttribute in DepmethodGrpc.cs"
|
|
exit 1
|
|
fi
|
|
# Check ObsoleteAttribute before SayHello methods
|
|
nmatches=$(grep -A 2 ObsoleteAttribute ${PROTO_OUT}/DepmethodGrpc.cs | grep -c SayHello)
|
|
if [ "$nmatches" -ne 5 ]
|
|
then
|
|
echo >&2 "Missing ObsoleteAttribute on SayHello method"
|
|
exit 1
|
|
fi
|
|
|
|
# Run one extra command to clear $? before exiting the script to prevent
|
|
# failing even when tests pass.
|
|
echo "Plugin test: ${TESTNAME}: passed."
|