aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/python/grpcio/tests/unit/framework/interfaces/face/_invocation.py
blob: ac487bed4f928f063b05071079f0554558f25632 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# Copyright 2015, Google Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following disclaimer
# in the documentation and/or other materials provided with the
# distribution.
#     * Neither the name of Google Inc. nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

"""Coverage across the Face layer's generic-to-dynamic range for invocation."""

import abc

import six

from grpc.framework.common import cardinality

_CARDINALITY_TO_GENERIC_BLOCKING_BEHAVIOR = {
    cardinality.Cardinality.UNARY_UNARY: 'blocking_unary_unary',
    cardinality.Cardinality.UNARY_STREAM: 'inline_unary_stream',
    cardinality.Cardinality.STREAM_UNARY: 'blocking_stream_unary',
    cardinality.Cardinality.STREAM_STREAM: 'inline_stream_stream',
}

_CARDINALITY_TO_GENERIC_FUTURE_BEHAVIOR = {
    cardinality.Cardinality.UNARY_UNARY: 'future_unary_unary',
    cardinality.Cardinality.UNARY_STREAM: 'inline_unary_stream',
    cardinality.Cardinality.STREAM_UNARY: 'future_stream_unary',
    cardinality.Cardinality.STREAM_STREAM: 'inline_stream_stream',
}

_CARDINALITY_TO_GENERIC_EVENT_BEHAVIOR = {
    cardinality.Cardinality.UNARY_UNARY: 'event_unary_unary',
    cardinality.Cardinality.UNARY_STREAM: 'event_unary_stream',
    cardinality.Cardinality.STREAM_UNARY: 'event_stream_unary',
    cardinality.Cardinality.STREAM_STREAM: 'event_stream_stream',
}

_CARDINALITY_TO_MULTI_CALLABLE_ATTRIBUTE = {
    cardinality.Cardinality.UNARY_UNARY: 'unary_unary',
    cardinality.Cardinality.UNARY_STREAM: 'unary_stream',
    cardinality.Cardinality.STREAM_UNARY: 'stream_unary',
    cardinality.Cardinality.STREAM_STREAM: 'stream_stream',
}


class Invoker(six.with_metaclass(abc.ABCMeta)):
  """A type used to invoke test RPCs."""

  @abc.abstractmethod
  def blocking(self, group, name):
    """Invokes an RPC with blocking control flow."""
    raise NotImplementedError()

  @abc.abstractmethod
  def future(self, group, name):
    """Invokes an RPC with future control flow."""
    raise NotImplementedError()

  @abc.abstractmethod
  def event(self, group, name):
    """Invokes an RPC with event control flow."""
    raise NotImplementedError()


class InvokerConstructor(six.with_metaclass(abc.ABCMeta)):
  """A type used to create Invokers."""

  @abc.abstractmethod
  def name(self):
    """Specifies the name of the Invoker constructed by this object."""
    raise NotImplementedError()

  @abc.abstractmethod
  def construct_invoker(self, generic_stub, dynamic_stubs, methods):
    """Constructs an Invoker for the given stubs and methods."""
    raise NotImplementedError()


class _GenericInvoker(Invoker):

  def __init__(self, generic_stub, methods):
    self._stub = generic_stub
    self._methods = methods

  def _behavior(self, group, name, cardinality_to_generic_method):
    method_cardinality = self._methods[group, name].cardinality()
    behavior = getattr(
        self._stub, cardinality_to_generic_method[method_cardinality])
    return lambda *args, **kwargs: behavior(group, name, *args, **kwargs)

  def blocking(self, group, name):
    return self._behavior(
        group, name, _CARDINALITY_TO_GENERIC_BLOCKING_BEHAVIOR)

  def future(self, group, name):
    return self._behavior(group, name, _CARDINALITY_TO_GENERIC_FUTURE_BEHAVIOR)

  def event(self, group, name):
    return self._behavior(group, name, _CARDINALITY_TO_GENERIC_EVENT_BEHAVIOR)


class _GenericInvokerConstructor(InvokerConstructor):

  def name(self):
    return 'GenericInvoker'

  def construct_invoker(self, generic_stub, dynamic_stub, methods):
    return _GenericInvoker(generic_stub, methods)


class _MultiCallableInvoker(Invoker):

  def __init__(self, generic_stub, methods):
    self._stub = generic_stub
    self._methods = methods

  def _multi_callable(self, group, name):
    method_cardinality = self._methods[group, name].cardinality()
    behavior = getattr(
        self._stub,
        _CARDINALITY_TO_MULTI_CALLABLE_ATTRIBUTE[method_cardinality])
    return behavior(group, name)

  def blocking(self, group, name):
    return self._multi_callable(group, name)

  def future(self, group, name):
    method_cardinality = self._methods[group, name].cardinality()
    behavior = getattr(
        self._stub,
        _CARDINALITY_TO_MULTI_CALLABLE_ATTRIBUTE[method_cardinality])
    if method_cardinality in (
        cardinality.Cardinality.UNARY_UNARY,
        cardinality.Cardinality.STREAM_UNARY):
      return behavior(group, name).future
    else:
      return behavior(group, name)

  def event(self, group, name):
    return self._multi_callable(group, name).event


class _MultiCallableInvokerConstructor(InvokerConstructor):

  def name(self):
    return 'MultiCallableInvoker'

  def construct_invoker(self, generic_stub, dynamic_stub, methods):
    return _MultiCallableInvoker(generic_stub, methods)


class _DynamicInvoker(Invoker):

  def __init__(self, dynamic_stubs, methods):
    self._stubs = dynamic_stubs
    self._methods = methods

  def blocking(self, group, name):
    return getattr(self._stubs[group], name)

  def future(self, group, name):
    if self._methods[group, name].cardinality() in (
        cardinality.Cardinality.UNARY_UNARY,
        cardinality.Cardinality.STREAM_UNARY):
      return getattr(self._stubs[group], name).future
    else:
      return getattr(self._stubs[group], name)

  def event(self, group, name):
    return getattr(self._stubs[group], name).event


class _DynamicInvokerConstructor(InvokerConstructor):

  def name(self):
    return 'DynamicInvoker'

  def construct_invoker(self, generic_stub, dynamic_stubs, methods):
    return _DynamicInvoker(dynamic_stubs, methods)


def invoker_constructors():
  """Creates a sequence of InvokerConstructors to use in tests of RPCs.

  Returns:
    A sequence of InvokerConstructors.
  """
  return (
      _GenericInvokerConstructor(),
      _MultiCallableInvokerConstructor(),
      _DynamicInvokerConstructor(),
  )