test: add detailed descriptor tests

Author: FoyonaCZY

tests/code-generation/proto/descriptor.proto

@@ -0,0 +1,118 @@
+syntax = "proto3";
+
+package descriptor;
+
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/any.proto";
+import "google/protobuf/descriptor.proto";
+
+option java_package = "com.example.codegen";
+option go_package = "github.com/cloudwego/volo/tests/codegen;codegen";
+
+// Define custom options to test descriptor options retrieval
+extend google.protobuf.MessageOptions {
+  // Custom message-level option
+  string my_msg_option = 51234;
+}
+
+extend google.protobuf.FieldOptions {
+  // Custom field-level option to mark sensitive fields
+  bool redacted = 51235;
+}
+
+// Top-level message containing nested messages, enums, map, oneof, reserved, etc.
+message Outer {
+  // Nested message
+  message Inner {
+    // Nested enum
+    enum State {
+      UNKNOWN = 0;
+      STARTED = 1;
+      FINISHED = 2;
+    }
+
+    State state = 1;
+    repeated string labels = 2;
+    map<string, int32> counts = 3;
+
+    // oneof example: only one field can be set at a time
+    oneof payload {
+      bytes raw = 4;
+      Nested nested = 5;
+    }
+
+    // Further nesting
+    message Nested {
+      string name = 1 [(redacted) = true];
+      google.protobuf.Timestamp created = 2;
+    }
+  }
+
+  repeated Inner inners = 1;
+  OuterAlt alt = 2;
+
+  // Reserved field number range for testing descriptor reserved field info
+  reserved 100 to 199;
+}
+
+// Message with deprecated option
+message OuterAlt {
+  option deprecated = true;
+  int32 id = 1;
+  google.protobuf.Any meta = 2;
+  repeated ServiceReference services = 3;
+}
+
+message ServiceReference {
+  string name = 1;
+  string endpoint = 2;
+  map<string, string> labels = 3;
+}
+
+// Top-level enum
+enum GlobalEnum {
+  GE_UNKNOWN = 0;
+  GE_ALPHA = 1;
+  GE_BETA = 2;
+  GE_GAMMA = 3;
+}
+
+// Service with multiple RPC types to test service descriptor (including streaming)
+service ComplexService {
+  // Standard Unary rpc
+  rpc UnaryGet (Request) returns (Response);
+
+  // Server streaming
+  rpc ServerStream (Request) returns (stream Response);
+
+  // Client streaming
+  rpc ClientStream (stream Request) returns (Response);
+}
+
+// Request/Response messages combining various field types
+message Request {
+  string query = 1;
+  GlobalEnum filter = 2;
+  repeated int64 ids = 3;
+  map<string, Outer.Inner> by_name = 4;
+
+  oneof payload {
+    bytes raw = 10;
+    google.protobuf.Any any = 11;
+  }
+}
+
+message Response {
+  int32 code = 1;
+  string message = 2;
+  repeated google.protobuf.Timestamp events = 3;
+}
+
+// Example message using defined options to test extension descriptor visibility
+message OptionedMessage {
+  option (my_msg_option) = "optioned";
+  string note = 1 [(redacted) = false];
+}
+
+// File-level comments to test SourceCodeInfo extraction (comments become part of descriptor)
+// End of descriptor.proto

tests/code-generation/src/lib.rs

@@ -3,8 +3,10 @@ mod r#gen {
     include!(concat!(env!("OUT_DIR"), "/proto_service_a_gen.rs"));
     include!(concat!(env!("OUT_DIR"), "/proto_service_b_gen.rs"));
     include!(concat!(env!("OUT_DIR"), "/proto_service_c_gen.rs"));
+    include!(concat!(env!("OUT_DIR"), "/descriptor_gen.rs"));
 }
 
+pub use descriptor_gen::descriptor;
 pub use r#gen::*;
 pub use proto_service_a_gen::*;
 pub use proto_service_b_gen::*;
@@ -14,7 +16,7 @@ pub use proto_service_c_gen::*;
 mod tests {
     use pilota::{
         LinkedBytes,
-        pb::{EncodeLengthContext, Message, descriptor_getter::ItemDescriptorGetter},
+        pb::{EncodeLengthContext, Message, descriptor_getter::*},
     };
 
     use super::*;
@@ -55,8 +57,6 @@ mod tests {
         let minimal_request = service_c::MinimalRequest::decode(buf.concat().freeze())
             .expect("decode to service C failed");
 
-        println!("Minimal Request: {:?}", minimal_request);
-
         assert_eq!(minimal_request.request_id, "req-123");
         assert_eq!(minimal_request.user_id, "user-456");
         assert_eq!(minimal_request.field_c, "data_for_c");
@@ -190,20 +190,58 @@ mod tests {
 
     #[test]
     fn test_get_descriptor_proto() {
-        let desc = service_a::FullRequest::get_descriptor_proto().unwrap();
-        assert_eq!(desc.name(), "FullRequest");
-
-        // nested oneof
-        let nested_oneof_desc =
-            service_a::full_request::NestedOneof::get_descriptor_proto().unwrap();
-        assert_eq!(nested_oneof_desc.name(), "nested_oneof");
-
-        // unused message should not be generated
-        let file_desc = service_a::file_descriptor_proto_service_a();
-        assert!(
-            file_desc
-                .get_message_descriptor_proto("NotNeeded")
-                .is_none()
-        );
+        // Test nested message types
+        let desc = descriptor::Outer::get_descriptor_proto().unwrap();
+        assert_eq!(desc.name(), "Outer");
+        let inner = descriptor::outer::Inner::get_descriptor_proto().unwrap();
+        assert_eq!(inner.name(), "Inner");
+        let nested = descriptor::outer::inner::Nested::get_descriptor_proto().unwrap();
+        assert_eq!(nested.name(), "Nested");
+
+        // Test top-level message types
+        let outer_alt = descriptor::OuterAlt::get_descriptor_proto().unwrap();
+        assert_eq!(outer_alt.name(), "OuterAlt");
+        let opt = outer_alt.options.as_ref().unwrap(); // should be deprecated
+        assert_eq!(opt.deprecated.unwrap(), true);
+        let service_ref = descriptor::ServiceReference::get_descriptor_proto().unwrap();
+        assert_eq!(service_ref.name(), "ServiceReference");
+        let request = descriptor::Request::get_descriptor_proto().unwrap();
+        assert_eq!(request.name(), "Request");
+        let response = descriptor::Response::get_descriptor_proto().unwrap();
+        assert_eq!(response.name(), "Response");
+        let optioned = descriptor::OptionedMessage::get_descriptor_proto().unwrap();
+        assert_eq!(optioned.name(), "OptionedMessage");
+
+        // Test enum types
+        let global_enum = descriptor::GlobalEnum::get_descriptor_proto().unwrap();
+        assert_eq!(global_enum.name(), "GlobalEnum");
+        let state_enum = descriptor::outer::inner::State::get_descriptor_proto().unwrap();
+        assert_eq!(state_enum.name(), "State");
+
+        // Test map types
+        let map = request.get_field_descriptor_proto("by_name").unwrap();
+        assert_eq!(map.name(), "by_name");
+
+        // Test service types
+        let file = descriptor::file_descriptor_proto_descriptor();
+        let service = file.get_service_descriptor_proto("ComplexService").unwrap();
+        assert_eq!(service.name(), "ComplexService");
+        for method in &service.method {
+            match method.name() {
+                "UnaryGet" => {
+                    assert_eq!(method.input_type, Some(".descriptor.Request".into()));
+                    assert_eq!(method.output_type, Some(".descriptor.Response".into()));
+                }
+                "ServerStream" => {
+                    assert_eq!(method.input_type, Some(".descriptor.Request".into()));
+                    assert_eq!(method.output_type, Some(".descriptor.Response".into()));
+                }
+                "ClientStream" => {
+                    assert_eq!(method.input_type, Some(".descriptor.Request".into()));
+                    assert_eq!(method.output_type, Some(".descriptor.Response".into()));
+                }
+                _ => panic!("unexpected method name {}", method.name()),
+            }
+        }
     }
 }

tests/code-generation/volo.yml

@@ -34,6 +34,19 @@ entries:
           path: proto/service_c.proto
           includes:
             - proto
+
+  proto:
+    filename: descriptor_gen.rs
+    protocol: protobuf
+    touch_all: true
+    with_descriptor: true
+    services:
+      - idl:
+          source: local
+          path: proto/descriptor.proto
+          includes:
+            - proto
+
   thrift:
     filename: thrift_gen.rs
     protocol: thrift