gapic-generator 0.6.1 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b063888cabf4893087dcefa274cb8ab5a9469a762fc3dbb34af2e143cb1bcce4
-  data.tar.gz: 589dc9fdf67d63dc25fe62537783e6305e4441f51b5caa2c94a5b1a161e71ab7
+  metadata.gz: 23b2c33b7bbae1c69924aa5c4df7ce43324ba16cee3e581aa353cb4ddf961ec3
+  data.tar.gz: ec1125f2cf0614188c1106039c4f562602e3dff6ec574d96d0bca0b5fa904ec2
 SHA512:
-  metadata.gz: 07a03fd0adcc1640a37fa334883838aee76c124d2e5380a00d540751b3740e1b0f13d82a981ab35297c095df38620a0895bf4bb7bb5dbf1421c659e71cd92e85
-  data.tar.gz: 10269fc5c70542e1ae9ee1471eb6365c1669c741aa1ac03dbaf3b652cec2aee14801717589d1c45febc554b280cd8cd178ac19e02b1224b2692d1e98324142f6
+  metadata.gz: bbb0b136b92843f0859bd8f65b8cbf3a64e5d1e52af69aec02975fdb99ab584918152ffd00f71dc1dc4e333bb617a0975228e0f269a357c749e06b2e73b07854
+  data.tar.gz: 1b5481f342bc4aef038f5c2cf9fd71fb032192e7c644129f9165b59eec30137d8b75c172b679d36d2edf8740af0ee7fbf458c84a55dd180237122c7eba74461d

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Release History for gapic-generator
 
+### 0.6.6 / 2020-08-05
+
+* Use numeric error codes rather than strings in generated retry configs.
+
+### 0.6.5 / 2020-07-16
+
+* Examples in auth, rakefile, and readme should pick a non-common service.
+* Emit a warning if common_services config references a nonexistent service.
+
+### 0.6.4 / 2020-07-13
+
+* Fix rubocop warning on a generated multi-path helper if it could take no arguments.
+* Run the rubocop file formatting step without caching.
+* Fix an issue where generating a service with no options would fail.
+
+### 0.6.3 / 2020-06-27
+
+* Fixes for generated tests for some cases involving proto maps.
+* Fix a Ruby 2.7 keyword arguments warning in generated tests.
+* Clean up bundler references in gemspecs and Gemfiles.
+
+### 0.6.2 / 2020-06-18
+
+* Support for the proto3_optional
+* Fixed an issue where tests for the oneof fields were not generating correctly
+* Removed ruby <2.5 pin for the protobuf dependency since new protobuf supports it again
+* Generated libraries now depend on gapic-common 0.3
+
 ### 0.6.1 / 2020-06-16
 
 * Add auto-generated disclaimer to generated tests.

data/gem_templates/entrypoint.erb

@@ -16,6 +16,7 @@ done
 
 mkdir -p /workspace/out/lib
 exec grpc_tools_ruby_protoc \
+        --experimental_allow_proto3_optional=1 \
         --proto_path=/workspace/common-protos/ --proto_path=/workspace/in/ \
         --ruby_out=/workspace/out/lib \
         --grpc_out=/workspace/out/lib \

data/gem_templates/gemspec.erb

@@ -29,7 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "protobuf", "~> 3.8"
   spec.add_dependency "rubocop", "~> 0.61"
 
-  spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-focus", "~> 1.0"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/gapic/file_formatter.rb

@@ -39,7 +39,7 @@ module Gapic
           write_file dir, file
         end
 
-        system "rubocop -x #{dir} -o #{dir}/rubocop.out -c #{configuration}"
+        system "rubocop --cache false -x #{dir} -o #{dir}/rubocop.out -c #{configuration}"
 
         files.each do |file|
           read_file dir, file

data/lib/gapic/generator/version.rb

@@ -16,6 +16,6 @@
 
 module Gapic
   module Generator
-    VERSION = "0.6.1"
+    VERSION = "0.6.6"
   end
 end

data/lib/gapic/grpc_service_config/parser.rb

@@ -40,6 +40,31 @@ module Gapic
       MULTIPLIER_JSON_KEY = "backoffMultiplier"
       STATUS_CODES_JSON_KEY = "retryableStatusCodes"
 
+      # See https://grpc.github.io/grpc/core/md_doc_statuscodes.html for a
+      # list of error codes.
+      ERROR_CODE_MAPPING = [
+        "OK",
+        "CANCELLED",
+        "UNKNOWN",
+        "INVALID_ARGUMENT",
+        "DEADLINE_EXCEEDED",
+        "NOT_FOUND",
+        "ALREADY_EXISTS",
+        "PERMISSION_DENIED",
+        "RESOURCE_EXHAUSTED",
+        "FAILED_PRECONDITION",
+        "ABORTED",
+        "OUT_OF_RANGE",
+        "UNIMPLEMENTED",
+        "INTERNAL",
+        "UNAVAILABLE",
+        "DATA_LOSS",
+        "UNAUTHENTICATED"
+      ].freeze
+
+      ERROR_STRING_MAPPING = ERROR_CODE_MAPPING.each_with_index.each_with_object({}) do |(str, num), hash|
+        hash[str] = num
+      end.freeze
 
       ##
       # Parses ServiceConfig from a json of a GRPC service config
@@ -146,11 +171,26 @@ module Gapic
         initial_delay_seconds = parse_interval_seconds get(retry_policy_json, INITIAL_DELAY_JSON_KEY)
         max_delay_seconds = parse_interval_seconds get(retry_policy_json, MAX_DELAY_JSON_KEY)
         multiplier = get retry_policy_json, MULTIPLIER_JSON_KEY
-        status_codes = get retry_policy_json, STATUS_CODES_JSON_KEY
+        status_codes = convert_codes get retry_policy_json, STATUS_CODES_JSON_KEY
 
         RetryPolicy.new initial_delay_seconds, max_delay_seconds, multiplier, status_codes
       end
 
+      ##
+      # Interpret input status codes. Convert strings to their associated integer codes.
+      #
+      def self.convert_codes input_codes
+        return nil if input_codes.nil?
+        Array(input_codes).map do |obj|
+          case obj
+          when String
+            ERROR_STRING_MAPPING[obj]
+          when Integer
+            obj
+          end
+        end.compact
+      end
+
       ##
       # Parses time expressed in secondds from the GRPC service config json
       # The time is encoded is a string as float or integer with a letter 's' afterwards
@@ -212,7 +252,7 @@ module Gapic
       end
 
       private_class_method :parse_service_names, :filter_service_method_names, :parse_config,
-                           :parse_retry_policy, :parse_interval_seconds, :valid_float?
+                           :parse_retry_policy, :parse_interval_seconds, :valid_float?, :convert_codes
     end
   end
 end

data/lib/gapic/presenters/field_presenter.rb

@@ -80,6 +80,10 @@ module Gapic
         @field.enum?
       end
 
+      def proto3_optional?
+        @field.proto3_optional?
+      end
+
       def repeated?
         @field.repeated?
       end
@@ -88,6 +92,14 @@ module Gapic
         @field.map?
       end
 
+      def oneof?
+        @field.oneof?
+      end
+
+      def oneof_name
+        @message.oneof_decl[@field.oneof_index].name
+      end
+
       protected
 
       def field_doc_types field, output

data/lib/gapic/presenters/gem_presenter.rb

@@ -48,6 +48,10 @@ module Gapic
         end
       end
 
+      def first_non_common_service
+        services.find { |service| service.common_service_delegate.nil? }
+      end
+
       def proto_files
         @proto_files ||= begin
           files = @api.files
@@ -174,7 +178,7 @@ module Gapic
       end
 
       def dependencies
-        deps = { "gapic-common" => "~> 0.2" }
+        deps = { "gapic-common" => "~> 0.3" }
         deps["grpc-google-iam-v1"] = [">= 0.6.10", "< 2.0"] if iam_dependency?
         extra_deps = gem_config :extra_dependencies
         deps.merge! extra_deps if extra_deps

data/lib/gapic/presenters/method_presenter.rb

@@ -92,6 +92,11 @@ module Gapic
         have_oneof = []
 
         @method.input.fields.each do |field|
+          unless field.oneof?
+            selected_fields << field
+            next
+          end
+
           idx = field.oneof_index
           selected_fields << field unless have_oneof.include? idx
           have_oneof << idx

data/lib/gapic/presenters/service_presenter.rb

@@ -203,7 +203,8 @@ module Gapic
       def client_scopes
         common_service_delegate&.client_scopes ||
           @service.scopes ||
-          default_config(:oauth_scopes)
+          default_config(:oauth_scopes) ||
+          []
       end
 
       def credentials_name

data/lib/gapic/runner.rb

@@ -48,8 +48,10 @@ module Gapic
       output_files = generator.new(api).generate
 
       # Create and write the response
-      Google::Protobuf::Compiler::CodeGeneratorResponse.new \
+      response = Google::Protobuf::Compiler::CodeGeneratorResponse.new \
         file: output_files
+      response.supported_features = Google::Protobuf::Compiler::CodeGeneratorResponse::FEATURE_PROTO3_OPTIONAL
+      response
     end
 
     # Run protoc generation.

data/lib/gapic/schema/api.rb

@@ -44,14 +44,18 @@ module Gapic
       #
       # @param request [Google::Protobuf::Compiler::CodeGeneratorRequest]
       #   The request object.
-      def initialize request
+      # @param error_output [IO] An IO to write any errors/warnings to.
+      # @param configuration [Hash] Optional override of configuration.
+      def initialize request, error_output: STDERR, configuration: nil
         @request = request
         loader = Loader.new
         @files = request.proto_file.map do |fd|
           loader.load_file fd, request.file_to_generate.include?(fd.name)
         end
         @files.each { |f| f.parent = self }
+        @configuration = configuration
         @resource_types = analyze_resources
+        sanity_checks error_output
       end
 
       def containing_api
@@ -295,6 +299,18 @@ module Gapic
 
       private
 
+      # Perform a variety of sanity checks on the data, and prints errors to
+      # the given output as appropriate.
+      #
+      # @param output [IO] Stream to write outputs to.
+      def sanity_checks output
+        addrs = services.map { |service| service.address.join "." }
+        configuration[:common_services]&.each do |k, v|
+          output.puts "WARNING: configured common service #{k} is not present" unless addrs.include? k
+          output.puts "WARNING: configured common service delegate #{v} is not present" unless addrs.include? v
+        end
+      end
+
       # Does a pre-analysis of all resources defined in the job. This has
       # two effects:
       # * Side effect: each resource has its parent_resources field set.

data/lib/gapic/schema/wrappers.rb

@@ -655,6 +655,15 @@ module Gapic
         field_behavior.include? Google::Api::FieldBehavior::OPTIONAL
       end
 
+      # Denotes a field as a part of oneof.
+      # oneof_index is an int field so it'll be 0 by default for every field
+      # and an index in the message's oneof table for the oneof fields
+      # but since the indexes in the message's oneof table start with 0 as well
+      # we need this to determine whether the field is a part of the oneof
+      def oneof?
+        @descriptor.field? :oneof_index
+      end
+
       # Denotes a field as required. This indicates that the field **must** be
       # provided as part of the request, and failure to do so will cause an
       # error (usually `INVALID_ARGUMENT`).
@@ -731,7 +740,8 @@ module Gapic
         :default_value,
         :oneof_index,
         :json_name,
-        :options
+        :options,
+        :proto3_optional?
       )
     end
 

data/lib/google/protobuf/compiler/plugin.pb.rb

@@ -1,7 +1,8 @@
 # encoding: utf-8
 
 ##
-# This file is auto-generated. DO NOT EDIT!
+# This file was auto-generated initially but now is hand-edited to add support 
+# for response features and proto3_optional
 #
 require 'protobuf'
 
@@ -54,6 +55,8 @@ module Google
       end
 
       class CodeGeneratorResponse
+        FEATURE_PROTO3_OPTIONAL = 1
+
         class File
           optional :string, :name, 1
           optional :string, :insertion_point, 2
@@ -61,6 +64,7 @@ module Google
         end
 
         optional :string, :error, 1
+        optional :int32, :supported_features, 2
         repeated ::Google::Protobuf::Compiler::CodeGeneratorResponse::File, :file, 15
       end
 

data/lib/google/protobuf/descriptor.pb.rb

@@ -190,6 +190,7 @@ module Google
       optional :int32, :oneof_index, 9
       optional :string, :json_name, 10
       optional ::Google::Protobuf::FieldOptions, :options, 8
+      optional :bool, :proto3_optional, 17
     end
 
     class OneofDescriptorProto

data/templates/default/gem/gemfile.erb

@@ -2,6 +2,3 @@
 source "https://rubygems.org"
 
 gemspec
-
-# google-protobuf 3.12.0 requires Ruby 2.5 or later, so pin to 3.11 on older Rubies
-gem "google-protobuf", (RUBY_VERSION < "2.5" ? "~> 3.11.4" : "~> 3.12")

data/templates/default/gem/readme.erb

@@ -16,7 +16,7 @@ $ gem install <%= gem.name %>
 
 ```ruby
 require "<%= gem.entrypoint_require %>"
-<%- service = gem.packages.first&.services.first -%>
+<%- service = gem.first_non_common_service -%>
 <%- method = service&.methods.first -%>
 <%- if service && method -%>
 

data/templates/default/service/client/resource/_multi.erb

@@ -13,7 +13,11 @@ def <%= resource.path_helper %> **args
 <%- last_pattern_index = resource.patterns.count - 1 -%>
 <%- resource.patterns.each_with_index do |pattern, index| -%>
 <%- comma = last_pattern_index == index ? "" : "," -%>
+<%- if pattern.formal_arguments.empty? -%>
+    <%= pattern.arguments_key.inspect %> => (proc do
+<%- else -%>
     <%= pattern.arguments_key.inspect %> => (proc do |<%= pattern.formal_arguments %>|
+<%- end -%>
 <%= indent render(partial: "service/client/resource/def", locals: { pattern: pattern }), 6 %>
     end)<%= comma %>
 <%- end -%>

data/templates/default/service/test/method/_bidi.erb

@@ -86,13 +86,21 @@ def test_<%= method.name %>
       request.to_a.each do |r|
         assert_kind_of <%= method.request_type %>, r
         <%- fields.each do |field| -%>
-        <%- if field.message? && field.repeated? -%>
-        assert_kind_of <%= field.type_name_full %>, request.<%= field.name %>.first
+        <%- if field.message? && field.repeated? && !field.map? -%>
+        assert_kind_of <%= field.type_name_full %>, r.<%= field.name %>.first
+        <%- elsif field.map? -%>
+        assert_equal(<%= field.default_value %>, r.<%= field.name %>.to_h)
         <%- elsif field.message? -%>
         assert_equal Gapic::Protobuf.coerce(<%= field.default_value %>, to: <%= field.type_name_full %>), r.<%= field.name %>
         <%- else -%>
         assert_equal <%= field.default_value %>, r.<%= field.name %>
         <%- end -%>
+        <%- if field.oneof? && !field.proto3_optional? -%>
+        assert_equal :<%= field.name %>, r.<%= field.oneof_name %>
+        <%- end -%>
+        <%- if field.proto3_optional? -%>
+        assert r.has_<%= field.name %>?
+        <%- end -%>
         <%- end -%>
       end
     end

data/templates/default/service/test/method/_client.erb

@@ -70,13 +70,21 @@ def test_<%= method.name %>
       request.to_a.each do |r|
         assert_kind_of <%= method.request_type %>, r
         <%- fields.each do |field| -%>
-        <%- if field.message? && field.repeated? -%>
-        assert_kind_of <%= field.type_name_full %>, request.<%= field.name %>.first
+        <%- if field.message? && field.repeated? && !field.map? -%>
+        assert_kind_of <%= field.type_name_full %>, r.<%= field.name %>.first
+        <%- elsif field.map? -%>
+        assert_equal(<%= field.default_value %>, r.<%= field.name %>.to_h)
         <%- elsif field.message? -%>
         assert_equal Gapic::Protobuf.coerce(<%= field.default_value %>, to: <%= field.type_name_full %>), r.<%= field.name %>
         <%- else -%>
         assert_equal <%= field.default_value %>, r.<%= field.name %>
         <%- end -%>
+        <%- if field.oneof? && !field.proto3_optional? -%>
+        assert_equal :<%= field.name %>, r.<%= field.oneof_name %>
+        <%- end -%>
+        <%- if field.proto3_optional? -%>
+        assert r.has_<%= field.name %>?
+        <%- end -%>
         <%- end -%>
       end
     end

data/templates/default/service/test/method/_normal.erb

@@ -26,6 +26,12 @@ def test_<%= method.name %>
     <%- else -%>
     assert_equal <%= field.default_value %>, request.<%= field.name %>
     <%- end -%>
+    <%- if field.oneof? && !field.proto3_optional? -%>
+    assert_equal :<%= field.name %>, request.<%= field.oneof_name %>
+    <%- end -%>
+    <%- if field.proto3_optional? -%>
+    assert request.has_<%= field.name %>?
+    <%- end -%>
     <%- end -%>
     refute_nil options
   end

data/templates/default/service/test/method/_server.erb

@@ -17,13 +17,21 @@ def test_<%= method.name %>
     assert_equal :<%= method.name %>, name
     assert_kind_of <%= method.request_type %>, request
     <%- fields.each do |field| -%>
-    <%- if field.message? && field.repeated? -%>
+    <%- if field.message? && field.repeated? && !field.map? -%>
     assert_kind_of <%= field.type_name_full %>, request.<%= field.name %>.first
+    <%- elsif field.map? -%>
+    assert_equal(<%= field.default_value %>, request.<%= field.name %>.to_h)
     <%- elsif field.message? -%>
     assert_equal Gapic::Protobuf.coerce(<%= field.default_value %>, to: <%= field.type_name_full %>), request.<%= field.name %>
     <%- else -%>
     assert_equal <%= field.default_value %>, request.<%= field.name %>
     <%- end -%>
+    <%- if field.oneof? && !field.proto3_optional? -%>
+    assert_equal :<%= field.name %>, request.<%= field.oneof_name %>
+    <%- end -%>
+    <%- if field.proto3_optional? -%>
+    assert request.has_<%= field.name %>?
+    <%- end -%>
     <%- end -%>
     refute_nil options
   end

data/templates/default/service/test/method/_setup.erb

@@ -9,10 +9,10 @@ class ClientStub
     @requests = []
   end
 
-  def call_rpc *args
+  def call_rpc *args, **kwargs
     @call_rpc_count += 1
 
-    @requests << @block&.call(*args)
+    @requests << @block&.call(*args, **kwargs)
 
     yield @response, @operation if block_given?
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gapic-generator
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.6
 platform: ruby
 authors:
 - Ernest Landrito
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-18 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -40,20 +40,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -74,14 +60,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: 1.30.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: 1.30.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement