-
Notifications
You must be signed in to change notification settings - Fork 10.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CSHARP] Add base_namespace experimental option to C# plugin (#32636)
Added `base_namespace` experimental option to `grpc_csharp_plugin` as this has been requested several times by people not using `Grpc.Tools` to generate their code - see #28663 Notes: - it should not be used with `Grpc.Tools`. That has a different way of handling duplicate proto file names in different directories. Using this option will break those builds. It can only be used on the `protoc` command line. - it uses common code with the `base_namespace` option for C# in `protoc`, which unfortunately has a slightly different name mangling algorithm for converting proto file names to C# camel case names. This only affects files with punctation or numbers in the name. This should not matter unless you are expecting specific file names - See https://protobuf.dev/reference/csharp/csharp-generated/#compiler_options for an explanation of this option
- Loading branch information
1 parent
d1dda5c
commit d534b4a
Showing
6 changed files
with
208 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
37 changes: 37 additions & 0 deletions
37
test/csharp/codegen/basenamespace/proto/namespacetest.proto
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
// 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. | ||
|
||
syntax = "proto3"; | ||
|
||
package test.csharp.codegen.basenamespace.test; | ||
|
||
option csharp_namespace = "Example.V1.CodegenTest"; | ||
|
||
// The greeting service definition. | ||
service Greeter { | ||
// Sends a greeting | ||
rpc SayHello (HelloRequest) returns (HelloReply) {} | ||
|
||
rpc SayHelloStreamReply (HelloRequest) returns (stream HelloReply) {} | ||
} | ||
|
||
// The request message containing the user's name. | ||
message HelloRequest { | ||
string name = 1; | ||
} | ||
|
||
// The response message containing the greetings | ||
message HelloReply { | ||
string message = 1; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
#!/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=basenamespace | ||
|
||
# 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 specifying the base_namespace options | ||
$PROTOC \ | ||
--plugin=protoc-gen-grpc-csharp=$PLUGIN \ | ||
--csharp_out=${PROTO_OUT} \ | ||
--grpc-csharp_out=${PROTO_OUT} \ | ||
--csharp_opt=base_namespace=Example \ | ||
--grpc-csharp_opt=base_namespace=Example \ | ||
-I ${DATA_DIR}/proto \ | ||
${DATA_DIR}/proto/namespacetest.proto | ||
|
||
# log the files generated | ||
ls -lR ./proto_out | ||
|
||
# Verify the output files exist in the right location. | ||
# The base_namespace option does not change the generated code just | ||
# the location of the files. Contents are not checked in this test. | ||
|
||
# The C# namespace option in the proto file of "Example.V1.CodegenTest" | ||
# combined with the command line options above should mean the generated files | ||
# are created in the output directory "V1/CodegenTest" | ||
|
||
# First file is generated by protoc. | ||
[ -e ${PROTO_OUT}/V1/CodegenTest/Namespacetest.cs ] || { | ||
echo >&2 "missing generated output, expecting V1/CodegenTest/Namespacetest.cs" | ||
exit 1 | ||
} | ||
|
||
# Second file is generated by the plugin. | ||
[ -e ${PROTO_OUT}/V1/CodegenTest/NamespacetestGrpc.cs ] || { | ||
echo >&2 "missing generated output, expecting V1/CodegenTest/NamespacetestGrpc.cs" | ||
exit 1 | ||
} | ||
|
||
# Run again without the base_namespace options to check the files are created | ||
# in the root of the output directory | ||
|
||
rm -rf ${PROTO_OUT} | ||
mkdir -p ${PROTO_OUT} | ||
|
||
$PROTOC \ | ||
--plugin=protoc-gen-grpc-csharp=$PLUGIN \ | ||
--csharp_out=${PROTO_OUT} \ | ||
--grpc-csharp_out=${PROTO_OUT} \ | ||
-I ${DATA_DIR}/proto \ | ||
${DATA_DIR}/proto/namespacetest.proto | ||
|
||
ls -lR ./proto_out | ||
|
||
[ -e ${PROTO_OUT}/Namespacetest.cs ] || { | ||
echo >&2 "missing generated output, expecting Namespacetest.cs" | ||
exit 1 | ||
} | ||
|
||
[ -e ${PROTO_OUT}/NamespacetestGrpc.cs ] || { | ||
echo >&2 "missing generated output, expecting NamespacetestGrpc.cs" | ||
exit 1 | ||
} | ||
|
||
# Run one extra command to clear $? before exiting the script to prevent | ||
# failing even when tests pass. | ||
echo "Plugin test: ${TESTNAME}: passed." |