gapic-generator 0.51.1 → 0.53.0

data/templates/default/service/client/_client.text.erb

@@ -20,6 +20,14 @@ require "securerandom"
 <%= indent service.doc_description(transport: :grpc), "# " %>
 #
 <%- end -%>
+<%- if service.resumable_upload? -%>
+<%- upload_names = service.resumable_upload_methods.map { |upload_method| "`#{upload_method.name}`" }.join ", " -%>
+<%- upload_many = service.resumable_upload_methods.length > 1 -%>
+# <%= upload_names %> <%= upload_many ? "perform resumable uploads: each returns" : "performs a resumable upload: it returns" %> a {::Gapic::ResumableUpload} handle
+# instead of a response, and the per-call `timeout` and retry policy cover only the request that
+# creates the upload session, not the upload itself.
+#
+<%- end -%>
 class <%= service.client_name %>
   # @private
   API_VERSION = "<%= service.api_version %>".freeze
@@ -140,6 +148,16 @@ class <%= service.client_name %>
       config.universe_domain = @config.universe_domain
     end
 
+    <%- end -%>
+    <%- if service.resumable_upload? -%>
+    <%= service.resumable_upload_stub_ivar %> = <%= service.resumable_upload_stub_name_full %>.new(
+      endpoint: @config.endpoint,
+      endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+      universe_domain: @config.universe_domain,
+      credentials: credentials,
+      logger: @config.logger
+    )
+
     <%- end -%>
     @<%= service.stub_name %> = ::Gapic::ServiceStub.new(
       <%= service.proto_service_stub_name_full %>,

data/templates/default/service/client/_config.text.erb

@@ -190,6 +190,14 @@ class Configuration
   <%- method_service.methods.each do |method| -%>
     ##
     # RPC-specific configuration for `<%= method.name %>`
+  <%- if method.resumable_upload? -%>
+    #
+    # `<%= method.name %>` performs a resumable upload, so the `timeout` and `retry_policy`
+    # configured here cover the request that creates the upload session only, not the upload
+    # itself. The whole-upload budget is the `upload_timeout:` argument of
+    # {::Gapic::ResumableUpload#start} and {::Gapic::ResumableUpload#resume}.
+    #
+  <%- end -%>
     # @return [::Gapic::Config::Method]
     #
     attr_reader :<%= method.name %>

data/templates/default/service/client/method/_def.text.erb

@@ -9,15 +9,19 @@
 #
 <%= render partial: "service/client/method/docs/response", locals: { method: method } -%>
 #
+<%- unless method.resumable_upload? -%>
 <%= render partial: "service/client/method/docs/error", locals: { method: method } -%>
 #
+<%- end -%>
 <%= render partial: "service/client/method/docs/snippets", locals: { method: method } -%>
 <%= render partial: "service/client/method/docs/samples", locals: { method: method } -%>
-def <%= method.name %> request, options = nil
+def <%= method.name %> request<%= method.resumable_upload? ? " = {}" : "" %>, options = nil
 <%= indent render(partial: "service/client/method/def/request", locals: { method: method }), 2 %>
 
 <%= indent render(partial: "service/client/method/def/options_defaults", locals: { method: method }), 2 %>
 
 <%= indent render(partial: "service/client/method/def/response", locals: { method: method }), 2 %>
+<%- unless method.resumable_upload? -%>
 <%= render partial: "service/client/method/def/rescue", locals: { method: method } -%>
+<%- end -%>
 end

data/templates/default/service/client/method/def/_options_defaults.text.erb

@@ -8,7 +8,12 @@ metadata = @config.rpcs.<%= method.name %>.metadata.to_h
 # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
 metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
   lib_name: @config.lib_name, lib_version: @config.lib_version,
+<%- if method.resumable_upload? -%>
+  gapic_version: ::<%= method.service.gem.version_name_full %>,
+  transports_version_send: [:rest]
+<%- else -%>
   gapic_version: ::<%= method.service.gem.version_name_full %>
+<%- end -%>
 metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
 metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 <%- if method.routing_params? && !method.client_streaming? -%>

data/templates/default/service/client/method/def/_response.text.erb

@@ -1,5 +1,7 @@
 <%- assert_locals method -%>
-<%- if method.paged? -%>
+<%- if method.resumable_upload? -%>
+<%= render partial: "service/client/method/def/response_resumable_upload", locals: { method: method } -%>
+<%- elsif method.paged? -%>
 <%= render partial: "service/client/method/def/response_paged", locals: { method: method } -%>
 <%- elsif method.rest.nonstandard_lro? -%>
 <%= render partial: "service/client/method/def/response_nonstandard_lro", locals: { method: method } -%>

data/templates/default/service/client/method/def/_response_resumable_upload.text.erb

@@ -0,0 +1,13 @@
+<%- assert_locals method -%>
+<%- error_handler = render(partial: "service/client/method/def/upload_error_handler", locals: { method: method }).strip -%>
+::Gapic::ResumableUpload.new(
+  client_stub_proc:     -> { <%= method.service.resumable_upload_stub_ivar %>.client_stub },
+  initial_request_proc: lambda {
+    <%= method.service.resumable_upload_stub_name_full %>.<%= method.rest.transcoding_helper_name %> request
+  },
+  initial_headers:      options.metadata,
+  start_retry_policy:   ::Gapic::Rest::ResumableUpload.start_retry_policy_for(options),
+  response_type:        <%= method.return_type %>,
+  method_name:          "<%= method.name %>",
+  error_handler:        <%= error_handler %>
+)

data/templates/default/service/client/method/def/_upload_error_handler.text.erb

@@ -0,0 +1,2 @@
+<%- assert_locals method -%>
+nil

data/templates/default/service/client/method/docs/_request_normal.text.erb

@@ -1,4 +1,22 @@
 <%- assert_locals method -%>
+<%- if method.resumable_upload? -%>
+# @overload <%= method.name %>(request = {}, options = nil)
+#   Pass arguments to `<%= method.name %>` via a request object, either of type
+#   {<%= method.request_type %>} or an equivalent Hash.
+#
+#   @param request [<%= method.request_type %>, ::Hash]
+#     A request object representing the call parameters. Optional: it is ignored when the returned
+#     handle is resumed rather than started, because a resumed upload targets a session the server
+#     has already created.
+#   @param options [::Gapic::CallOptions, ::Hash]
+#     Overrides for the initiation request only. The `timeout`, `retry_policy` and `metadata` set
+#     here apply to the single request that creates the upload session, not to the upload as a
+#     whole: an upload still transferring bytes an hour later has long outlived this `timeout`.
+#     To bound the whole upload, pass `upload_timeout:` to {::Gapic::ResumableUpload#start} or
+#     {::Gapic::ResumableUpload#resume}. Chunk transfers are retried by the upload protocol itself,
+#     with the defaults documented on {::Gapic::ResumableUpload}; no call option reaches them.
+#     Optional.
+<%- else -%>
 # @overload <%= method.name %>(request, options = nil)
 #   Pass arguments to `<%= method.name %>` via a request object, either of type
 #   {<%= method.request_type %>} or an equivalent Hash.
@@ -8,6 +26,7 @@
 #     parameters, or to keep all the default parameter values, pass an empty Hash.
 #   @param options [::Gapic::CallOptions, ::Hash]
 #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+<%- end -%>
 <%-if method.arguments.any?-%>
 #
 <%- arg_list = method.arguments.map { |arg| "#{arg.name}: nil"}.join ", " -%>

data/templates/default/service/client/method/docs/_response.text.erb

@@ -1,6 +1,14 @@
 <%- assert_locals method -%>
+<%- if method.resumable_upload? -%>
+# @return [::Gapic::ResumableUpload]
+#   A reusable upload handle. No request is sent and no byte is read from a stream until
+#   {::Gapic::ResumableUpload#start} or {::Gapic::ResumableUpload#resume} is called on it.
+#   Upload failures, including a failed initiation request, are raised by those methods,
+#   not by this one.
+<%- else -%>
 # @yield [response, operation] Access the result along with the RPC operation
 # @yieldparam response [<%= method.doc_response_type %>]
 # @yieldparam operation [::GRPC::ActiveCall::Operation]
 #
 # @return [<%= method.doc_response_type %>]
+<%- end -%>

data/templates/default/service/rest/client/_client.text.erb

@@ -21,6 +21,14 @@ require "securerandom"
 <%= indent service.doc_description(transport: :rest), "# " %>
 #
 <%- end -%>
+<%- if service.resumable_upload? -%>
+<%- upload_names = service.resumable_upload_methods.map { |upload_method| "`#{upload_method.name}`" }.join ", " -%>
+<%- upload_many = service.resumable_upload_methods.length > 1 -%>
+# <%= upload_names %> <%= upload_many ? "perform resumable uploads: each returns" : "performs a resumable upload: it returns" %> a {::Gapic::ResumableUpload} handle
+# instead of a response, and the per-call `timeout` and retry policy cover only the request that
+# creates the upload session, not the upload itself.
+#
+<%- end -%>
 class <%= service.rest.client_name %>
   # @private
   API_VERSION = "<%= service.api_version %>".freeze
@@ -141,6 +149,16 @@ class <%= service.rest.client_name %>
       <%- end -%>
     end
 
+    <%- end -%>
+    <%- if service.resumable_upload? -%>
+    <%= service.resumable_upload_stub_ivar %> = <%= service.resumable_upload_stub_name_full %>.new(
+      endpoint: @config.endpoint,
+      endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+      universe_domain: @config.universe_domain,
+      credentials: credentials,
+      logger: @config.logger
+    )
+
     <%- end -%>
     @<%= service.stub_name %> = <%= service.rest.service_stub_name_full %>.new(
       endpoint: @config.endpoint,

data/templates/default/service/rest/client/_config.text.erb

@@ -162,6 +162,14 @@ class Configuration
   <%- method_service.rest.methods.each do |method| -%>
     ##
     # RPC-specific configuration for `<%= method.name %>`
+  <%- if method.resumable_upload? -%>
+    #
+    # `<%= method.name %>` performs a resumable upload, so the `timeout` and `retry_policy`
+    # configured here cover the request that creates the upload session only, not the upload
+    # itself. The whole-upload budget is the `upload_timeout:` argument of
+    # {::Gapic::ResumableUpload#start} and {::Gapic::ResumableUpload#resume}.
+    #
+  <%- end -%>
     # @return [::Gapic::Config::Method]
     #
     attr_reader :<%= method.name %>

data/templates/default/service/rest/client/method/_def.text.erb

@@ -7,10 +7,12 @@
 <%= render partial: "service/rest/client/method/docs/request", locals: { method: method } -%>
 <%= render partial: "service/rest/client/method/docs/result", locals: { method: method } -%>
 #
+<%- unless method.resumable_upload? -%>
 <%= render partial: "service/rest/client/method/docs/error", locals: { method: method } -%>
 #
+<%- end -%>
 <%= render partial: "service/rest/client/method/docs/snippets", locals: { method: method } -%>
-def <%= method.name %> request, options = nil
+def <%= method.name %> request<%= method.resumable_upload? ? " = {}" : "" %>, options = nil
 <%= indent render(partial: "service/client/method/def/request", locals: { method: method }), 2 %>
 
 <%= indent render(partial: "service/rest/client/method/def/options_defaults", locals: { method: method }), 2 %>
@@ -20,5 +22,7 @@ def <%= method.name %> request, options = nil
 <%- end -%>
 
 <%= indent render(partial: "service/rest/client/method/def/response", locals: { method: method }), 2 %>
+<%- unless method.resumable_upload? -%>
 <%= render partial: "service/rest/client/method/def/rescue", locals: { method: method } -%>
+<%- end -%>
 end

data/templates/default/service/rest/client/method/def/_response.text.erb

@@ -1,5 +1,7 @@
 <%- assert_locals method -%>
-<%- if method.rest.paged? -%>
+<%- if method.resumable_upload? -%>
+<%= render partial: "service/rest/client/method/def/response_resumable_upload", locals: { method: method } -%>
+<%- elsif method.rest.paged? -%>
 <%= render partial: "service/rest/client/method/def/response_paged", locals: { method: method } -%>
 <%- elsif method.rest.nonstandard_lro? -%>
 <%= render partial: "service/rest/client/method/def/response_nonstandard_lro", locals: { method: method } -%>

data/templates/default/service/rest/client/method/def/_response_resumable_upload.text.erb

@@ -0,0 +1,13 @@
+<%- assert_locals method -%>
+<%- error_handler = render(partial: "service/rest/client/method/def/upload_error_handler", locals: { method: method }).strip -%>
+::Gapic::ResumableUpload.new(
+  client_stub_proc:     -> { <%= method.service.resumable_upload_stub_ivar %>.client_stub },
+  initial_request_proc: lambda {
+    <%= method.service.resumable_upload_stub_name_full %>.<%= method.rest.transcoding_helper_name %> request
+  },
+  initial_headers:      options.metadata,
+  start_retry_policy:   ::Gapic::Rest::ResumableUpload.start_retry_policy_for(options),
+  response_type:        <%= method.return_type %>,
+  method_name:          "<%= method.name %>",
+  error_handler:        <%= error_handler %>
+)

data/templates/default/service/rest/client/method/def/_upload_error_handler.text.erb

@@ -0,0 +1,2 @@
+<%- assert_locals method -%>
+nil

data/templates/default/service/rest/client/method/docs/_request.text.erb

@@ -1,4 +1,22 @@
 <%- assert_locals method -%>
+<%- if method.resumable_upload? -%>
+# @overload <%= method.name %>(request = {}, options = nil)
+#   Pass arguments to `<%= method.name %>` via a request object, either of type
+#   {<%= method.request_type %>} or an equivalent Hash.
+#
+#   @param request [<%= method.request_type %>, ::Hash]
+#     A request object representing the call parameters. Optional: it is ignored when the returned
+#     handle is resumed rather than started, because a resumed upload targets a session the server
+#     has already created.
+#   @param options [::Gapic::CallOptions, ::Hash]
+#     Overrides for the initiation request only. The `timeout`, `retry_policy` and `metadata` set
+#     here apply to the single request that creates the upload session, not to the upload as a
+#     whole: an upload still transferring bytes an hour later has long outlived this `timeout`.
+#     To bound the whole upload, pass `upload_timeout:` to {::Gapic::ResumableUpload#start} or
+#     {::Gapic::ResumableUpload#resume}. Chunk transfers are retried by the upload protocol itself,
+#     with the defaults documented on {::Gapic::ResumableUpload}; no call option reaches them.
+#     Optional.
+<%- else -%>
 # @overload <%= method.name %>(request, options = nil)
 #   Pass arguments to `<%= method.name %>` via a request object, either of type
 #   {<%= method.request_type %>} or an equivalent Hash.
@@ -8,6 +26,7 @@
 #     parameters, or to keep all the default parameter values, pass an empty Hash.
 #   @param options [::Gapic::CallOptions, ::Hash]
 #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+<%- end -%>
 <%-if method.arguments.any?-%>
 #
 <%- arg_list = method.arguments.map { |arg| "#{arg.name}: nil"}.join ", " -%>

data/templates/default/service/rest/client/method/docs/_result.text.erb

@@ -1,5 +1,11 @@
 <%- assert_locals method -%>
-<%- if method.server_streaming? -%>
+<%- if method.resumable_upload? -%>
+# @return [::Gapic::ResumableUpload]
+#   A reusable upload handle. No request is sent and no byte is read from a stream until
+#   {::Gapic::ResumableUpload#start} or {::Gapic::ResumableUpload#resume} is called on it.
+#   Upload failures, including a failed initiation request, are raised by those methods,
+#   not by this one.
+<%- elsif method.server_streaming? -%>
 # @return [::Enumerable<<%= method.rest.doc_response_type %>>]
 <%- else -%>
 # @yield [result, operation] Access the result along with the TransportOperation object

data/templates/default/service/rest/service_stub/_service_stub.text.erb

@@ -52,11 +52,11 @@ class <%= service.rest.service_stub_name %>
     stub ? @client_stub.stub_logger : @client_stub.logger
   end
 
-  <%- service.rest.methods.each do |method| -%>
+  <%- service.rest.service_stub_methods.each do |method| -%>
   <%= indent_tail render(partial: "service/rest/service_stub/method/def", locals: { method: method, service_stub_name: service.rest.service_stub_name }), 2 %>
 
   <%- end %>
-  <%- service.rest.methods.each do |method| -%>
+  <%- service.rest.service_stub_methods.each do |method| -%>
   <%= indent_tail render(partial: "service/rest/service_stub/grpc_transcoding_method/def", locals: { method: method }), 2 %>
 
   <%- end %>

data/templates/default/service/rest/service_stub/grpc_transcoding_method/_bindings.text.erb

@@ -0,0 +1,15 @@
+<%- assert_locals method -%>
+<%- method.http_bindings.each do |http_binding| -%>
+.with_bindings(
+  uri_method: :<%= http_binding.verb %>,
+  uri_template: "<%= http_binding.uri_for_transcoding %>",
+<%- if http_binding.body? -%>
+  body: "<%= http_binding.body %>",
+<%- end -%>
+  matches: [
+<%- http_binding.routing_params_transcoder_matches_strings.each do |match_str| -%>
+    <%= match_str %>
+<%- end -%>
+  ]
+)
+<%- end -%>

data/templates/default/service/rest/service_stub/grpc_transcoding_method/_def.text.erb

@@ -19,19 +19,6 @@ def self.<%= method.rest.transcoding_helper_name %> request_pb<%= boverr_str %>
   <%- end %>
   <%- assignment = method.service.rest.is_main_mixin_service? ? "||=" : "=" -%>
   transcoder <%= assignment %> Gapic::Rest::GrpcTranscoder.new
-  <%- method.http_bindings.each do |http_binding| -%>
-                                            .with_bindings(
-                                              uri_method: :<%= http_binding.verb %>,
-                                              uri_template: "<%= http_binding.uri_for_transcoding %>",
-                                            <%- if http_binding.body? -%>
-                                              body: "<%= http_binding.body %>",
-                                            <%- end -%>
-                                              matches: [
-                                            <%- http_binding.routing_params_transcoder_matches_strings.each do |match_str| -%>
-                                                <%= match_str %>
-                                            <%- end -%>
-                                              ]
-                                            )
-  <%- end %>
+<%= indent render(partial: "service/rest/service_stub/grpc_transcoding_method/bindings", locals: { method: method }), 44 %>
   transcoder.transcode request_pb
 end

data/templates/default/service/rest/test/client.text.erb

@@ -9,7 +9,7 @@ require "<%= service.rest.service_require %>"
 class <%= service.rest.client_name_full %>Test < Minitest::Test
 <%= indent render(partial: "service/rest/test/method/setup"), 2 %>
 
-<% service.rest.methods.each do |method| %>
+<% service.rest.methods.reject(&:resumable_upload?).each do |method| %>
 <%= indent render(partial: "service/rest/test/method/#{method.kind}",
                   locals: { method: method }), 2 %>
 

data/templates/default/service/resumable_upload_stub/_resumable_upload_stub.text.erb

@@ -0,0 +1,64 @@
+<%- assert_locals service -%>
+##
+# Resumable upload stub for the <%= service.name %> service.
+#
+# Owns the REST client stub the uploads are performed through, the transcoders that build their
+# initiation requests, and the credentials error that a client unable to perform REST calls has to
+# raise when an upload is attempted.
+#
+# @private
+#
+class <%= service.resumable_upload_stub_name %>
+<%- service.resumable_upload_methods.each do |method| -%>
+  # @private
+  <%= method.upload_url_prefix_const_name %> = "<%= method.upload_url_prefix %>"
+
+<%- end -%>
+  # @private
+  def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
+    # These require statements are intentionally placed here to initialize
+    # the REST modules only when it's required.
+    require "gapic/rest"
+
+    # Uploads travel over REST, and credentials cannot be recovered from a gRPC channel. Rather than
+    # raise while a client is being constructed, which would break every other method on it, the
+    # error is stored and raised when an upload is actually attempted.
+    if defined?(::GRPC::Core::Channel) &&
+       (credentials.is_a?(::GRPC::Core::Channel) || credentials.is_a?(::GRPC::Core::ChannelCredentials))
+      @credentials_error = ::ArgumentError.new(
+        "Resumable uploads are performed over REST and cannot use a gRPC channel as credentials, " \
+        "because credentials cannot be recovered from a channel. Construct the client with Google " \
+        "OAuth credentials (a keyfile path, a Hash, or a Google::Auth::Credentials instance) to use " \
+        "resumable upload methods."
+      )
+      return
+    end
+
+    @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
+                                                 endpoint_template: endpoint_template,
+                                                 universe_domain: universe_domain,
+                                                 credentials: credentials,
+                                                 numeric_enums: false,
+                                                 service_name: self.class,
+                                                 raise_faraday_errors: false,
+                                                 logger: logger
+  end
+
+  ##
+  # @private
+  #
+  # The REST client stub the uploads are performed through.
+  #
+  # @return [::Gapic::Rest::ClientStub]
+  #
+  # @raise [::ArgumentError] if this client cannot perform REST calls.
+  #
+  def client_stub
+    raise @credentials_error if @credentials_error
+    @client_stub
+  end
+<%- service.resumable_upload_methods.each do |method| -%>
+
+  <%= indent_tail render(partial: "service/resumable_upload_stub/transcoding_method", locals: { method: method, service: service }), 2 %>
+<%- end -%>
+end

data/templates/default/service/resumable_upload_stub/_transcoding_method.text.erb

@@ -0,0 +1,22 @@
+<%- assert_locals method, service -%>
+##
+# @private
+#
+# GRPC transcoding helper method for the <%= method.name %> resumable upload initiation request.
+#
+# The upload itself is not transcoded: only the request that creates the upload session is, and the
+# verb is discarded because initiation is always a POST. Query string parameters are folded into the
+# URL, since the upload sends the initiation request with no separate parameters.
+#
+# @param request_pb [<%= method.request_type %>]
+#   A request object representing the call parameters. Required.
+# @return [Array(String, [String, nil])]
+#   Uri, Body
+def self.<%= method.rest.transcoding_helper_name %> request_pb
+  transcoder = ::Gapic::Rest::GrpcTranscoder.new
+<%= indent render(partial: "service/rest/service_stub/grpc_transcoding_method/bindings", locals: { method: method }), 46 %>
+  _verb, uri, query_string_params, body = transcoder.transcode request_pb
+  uri = "/#{<%= method.upload_url_prefix_const_name %>}#{uri}"
+  uri = "#{uri}?#{query_string_params.join '&'}" if query_string_params.any?
+  [uri, body]
+end

data/templates/default/service/resumable_upload_stub.text.erb

@@ -0,0 +1,6 @@
+<%- assert_locals service -%>
+<%= render partial: "service/resumable_upload_stub/resumable_upload_stub",
+           layout: "layouts/ruby",
+           locals: { service: service,
+                     namespace: service.service_name_full }
+%>

data/templates/default/service/test/client.text.erb

@@ -10,7 +10,7 @@ require "<%= service.service_require %>"
 class <%= service.client_name_full %>Test < Minitest::Test
 <%= indent render(partial: "service/test/method/setup"), 2 %>
 
-<% service.methods.each do |method| %>
+<% service.methods.reject(&:resumable_upload?).each do |method| %>
 <%= indent render(partial: "service/test/method/#{method.kind}",
                   locals: { method: method }), 2 %>
 

data/templates/default/service/test/resumable_upload.text.erb

@@ -0,0 +1,132 @@
+<%- assert_locals service -%>
+<%= render partial: "shared/header" %>
+require "helper"
+
+require "gapic/rest"
+<%- if service.generate_grpc_clients? -%>
+require "gapic/grpc/service_stub"
+<%- end -%>
+
+require "<%= service.proto_service_require %>"
+<%- if service.generate_grpc_clients? -%>
+require "<%= service.service_require %>"
+<%- end -%>
+<%- if service.generate_rest_clients? -%>
+require "<%= service.rest.service_require %>"
+<%- end -%>
+
+class <%= service.service_name_full %>::ResumableUploadTest < Minitest::Test
+  ##
+  # Stands in for the transport stub a client builds in its constructor. An upload method sends
+  # nothing, so this only has to satisfy the constructor.
+  #
+  class ClientStub
+    def endpoint
+      "endpoint.example.com"
+    end
+
+    def universe_domain
+      "example.com"
+    end
+
+    def stub_logger
+      nil
+    end
+
+    def logger
+      nil
+    end
+  end
+<%- service.resumable_upload_methods.each do |method| -%>
+<%- fields = method.fields_with_first_oneof -%>
+<%- prefix_const = "#{service.resumable_upload_stub_name_full}::#{method.upload_url_prefix_const_name}" -%>
+
+  def test_transcode_<%= method.name %>_request
+    request = <%= method.request_type %>.new
+
+    # The transcoder is stubbed so the test pins the upload-specific post-processing (prefix,
+    # query-string folding, [uri, body] shape) independently of the method's path template.
+    transcoder = Gapic::Rest::GrpcTranscoder.new
+    transcoder.stub :transcode, [:post, "/transcoded/path", ["foo=bar", "baz=qux"], "{\"body\":true}"] do
+      Gapic::Rest::GrpcTranscoder.stub :new, transcoder do
+        uri, body = <%= service.resumable_upload_stub_name_full %>.<%= method.rest.transcoding_helper_name %> request
+
+        assert_equal "/#{<%= prefix_const %>}/transcoded/path?foo=bar&baz=qux", uri
+        assert_equal "{\"body\":true}", body
+      end
+    end
+  end
+<%- if service.generate_grpc_clients? -%>
+
+  def test_<%= method.name %>
+    <%- fields.each do |field| -%>
+    <%= field.value_name %> = <%= field.default_value %>
+    <%- end -%>
+
+    client = nil
+    Gapic::ServiceStub.stub :new, ClientStub.new do
+      client = <%= service.client_name_full %>.new do |config|
+        config.credentials = :this_channel_is_insecure
+      end
+    end
+
+    upload = client.<%= method.name %> <%= method.request_type %>.new(<%= fields.map(&:as_kwarg).join ", " %>)
+
+    # The call builds a handle and sends nothing. The upload only begins on #start or #resume.
+    assert_kind_of ::Gapic::ResumableUpload, upload
+    assert_nil upload.resume_handle
+    refute upload.resumable?
+    refute upload.running?
+  end
+
+  def test_<%= method.name %>_channel_credentials
+    <%- fields.each do |field| -%>
+    <%= field.value_name %> = <%= field.default_value %>
+    <%- end -%>
+    grpc_channel = GRPC::Core::Channel.new "localhost:8888", nil, :this_channel_is_insecure
+
+    client = nil
+    Gapic::ServiceStub.stub :new, ClientStub.new do
+      client = <%= service.client_name_full %>.new do |config|
+        config.credentials = grpc_channel
+      end
+    end
+
+    upload = client.<%= method.name %> <%= method.request_type %>.new(<%= fields.map(&:as_kwarg).join ", " %>)
+
+    assert_kind_of ::Gapic::ResumableUpload, upload
+
+    # Uploads travel over REST and cannot use a channel as credentials. The error surfaces here,
+    # rather than at construction, and before the stream is touched.
+    stream = StringIO.new "resumable upload test payload"
+    assert_raises ::ArgumentError do
+      upload.start stream: stream, content_type: "application/octet-stream"
+    end
+    assert_equal 0, stream.pos
+  end
+<%- end -%>
+<%- if service.generate_rest_clients? -%>
+
+  def test_<%= method.name %>_rest
+    <%- fields.each do |field| -%>
+    <%= field.value_name %> = <%= field.default_value %>
+    <%- end -%>
+
+    client = nil
+    Gapic::Rest::ClientStub.stub :new, ClientStub.new do
+      client = <%= service.rest.client_name_full %>.new do |config|
+        config.credentials = :dummy_value
+      end
+    end
+
+    upload = client.<%= method.name %> <%= method.request_type %>.new(<%= fields.map(&:as_kwarg).join ", " %>)
+
+    # The call builds a handle and sends nothing. The upload only begins on #start or #resume.
+    assert_kind_of ::Gapic::ResumableUpload, upload
+    assert_nil upload.resume_handle
+    refute upload.resumable?
+    refute upload.running?
+  end
+<%- end -%>
+<%- end -%>
+end