impl(generator): handle deprecated services

Author: scotthart

generator/internal/client_generator.cc

@@ -75,6 +75,7 @@ Status ClientGenerator::GenerateHeader() {
 
   // includes
   HeaderPrint("\n");
+
   HeaderLocalIncludes(
       {HasGenerateGrpcTransport() ? vars("connection_header_path")
                                   : vars("connection_rest_header_path"),

generator/internal/service_code_generator.cc

@@ -293,12 +293,13 @@ VarsDictionary ServiceCodeGenerator::MergeServiceAndMethodVars(
 
 void ServiceCodeGenerator::HeaderLocalIncludes(
     std::vector<std::string> const& local_includes) {
-  GenerateLocalIncludes(header_, local_includes);
+  GenerateLocalIncludes(header_, local_includes, FileType::kHeaderFile,
+                        IsDeprecated());
 }
 
 void ServiceCodeGenerator::CcLocalIncludes(
     std::vector<std::string> const& local_includes) {
-  GenerateLocalIncludes(cc_, local_includes, FileType::kCcFile);
+  GenerateLocalIncludes(cc_, local_includes, FileType::kCcFile, IsDeprecated());
 }
 
 void ServiceCodeGenerator::HeaderSystemIncludes(
@@ -384,7 +385,14 @@ void ServiceCodeGenerator::CcPrintMethod(
 }
 
 void ServiceCodeGenerator::GenerateLocalIncludes(
-    Printer& p, std::vector<std::string> local_includes, FileType file_type) {
+    Printer& p, std::vector<std::string> local_includes, FileType file_type,
+    bool is_deprecated) {
+  if (is_deprecated) {
+    p.Print(
+        "#include "
+        "\"google/cloud/internal/disable_deprecation_warnings.inc\"\n");
+  }
+
   if (file_type == FileType::kCcFile) {
     std::sort(local_includes.begin() + 1, local_includes.end());
   } else {
@@ -507,6 +515,10 @@ std::vector<MixinMethod> const& ServiceCodeGenerator::MixinMethods() const {
   return mixin_methods_;
 }
 
+bool ServiceCodeGenerator::IsDeprecated() const {
+  return service_descriptor_->options().deprecated();
+}
+
 }  // namespace generator_internal
 }  // namespace cloud
 }  // namespace google

generator/internal/service_code_generator.h

@@ -237,13 +237,19 @@ class ServiceCodeGenerator : public GeneratorInterface {
 
   std::vector<MixinMethod> const& MixinMethods() const;
 
+  /**
+   * If the service is defined with `option deprecated = true;`.
+   * @return
+   */
+  bool IsDeprecated() const;
+
  private:
   void SetMethods();
 
   enum class FileType { kHeaderFile, kCcFile };
   static void GenerateLocalIncludes(Printer& p,
                                     std::vector<std::string> local_includes,
-                                    FileType file_type = FileType::kHeaderFile);
+                                    FileType file_type, bool is_deprecated);
   static void GenerateSystemIncludes(Printer& p,
                                      std::vector<std::string> system_includes);
 

generator/internal/service_code_generator_test.cc

@@ -63,6 +63,7 @@ class TestGenerator : public ServiceCodeGenerator {
   using ServiceCodeGenerator::HasPaginatedMethod;
   using ServiceCodeGenerator::HasStreamingReadMethod;
   using ServiceCodeGenerator::HasStreamingWriteMethod;
+  using ServiceCodeGenerator::IsDeprecated;
   using ServiceCodeGenerator::IsDiscoveryDocumentProto;
   using ServiceCodeGenerator::IsExperimental;
   using ServiceCodeGenerator::MethodSignatureWellKnownProtobufTypeIncludes;
@@ -1011,6 +1012,55 @@ TEST(PredicateUtilsTest, IsDiscoveryDocumentProto) {
   EXPECT_FALSE(g3.IsDiscoveryDocumentProto());
 }
 
+TEST(ServiceCodeGeneratorTest, IsDeprecated) {
+  auto constexpr kServiceProto = R"""(
+syntax = "proto3";
+
+// This service that is deprecated.
+service DeprecatedService {
+  option deprecated = true;
+}
+
+// This service that is NOT deprecated.
+service NonDeprecatedService {
+}
+
+)""";
+
+  generator_testing::FakeSourceTree source_tree(
+      std::map<std::string, std::string>{
+          {"google/cloud/foo/service.proto", kServiceProto}});
+  google::protobuf::compiler::SourceTreeDescriptorDatabase source_tree_db(
+      &source_tree);
+  google::protobuf::SimpleDescriptorDatabase simple_db;
+  FileDescriptorProto file_proto;
+  // we need descriptor.proto to be accessible by the pool
+  // since our test file imports it
+  FileDescriptorProto::descriptor()->file()->CopyTo(&file_proto);
+  simple_db.Add(file_proto);
+  google::protobuf::MergedDescriptorDatabase merged_db(&simple_db,
+                                                       &source_tree_db);
+  generator_testing::ErrorCollector collector;
+  DescriptorPool pool(&merged_db, &collector);
+
+  FileDescriptor const* service_file_descriptor =
+      pool.FindFileByName("google/cloud/foo/service.proto");
+
+  auto generator_context = std::make_unique<MockGeneratorContext>();
+  EXPECT_CALL(*generator_context, Open("header_path"))
+      .Times(2)
+      .WillRepeatedly(
+          [](std::string const&) { return new MockZeroCopyOutputStream(); });
+
+  TestGenerator deprecated_service(service_file_descriptor->service(0),
+                                   generator_context.get());
+  EXPECT_TRUE(deprecated_service.IsDeprecated());
+
+  TestGenerator non_deprecated_service(service_file_descriptor->service(1),
+                                       generator_context.get());
+  EXPECT_FALSE(non_deprecated_service.IsDeprecated());
+}
+
 }  // namespace
 }  // namespace generator_internal
 }  // namespace cloud