# 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.

"""Test code for the Face layer of RPC Framework."""

import abc
import unittest

# test_interfaces is referenced from specification in this module.
from grpc.framework.interfaces.face import face
from tests.unit.framework.common import test_constants
from tests.unit.framework.common import test_control
from tests.unit.framework.common import test_coverage
from tests.unit.framework.interfaces.face import _3069_test_constant
from tests.unit.framework.interfaces.face import _digest
from tests.unit.framework.interfaces.face import _receiver
from tests.unit.framework.interfaces.face import _stock_service
from tests.unit.framework.interfaces.face import test_interfaces  # pylint: disable=unused-import


class TestCase(test_coverage.Coverage, unittest.TestCase):
  """A test of the Face layer of RPC Framework.

  Concrete subclasses must have an "implementation" attribute of type
  test_interfaces.Implementation and an "invoker_constructor" attribute of type
  _invocation.InvokerConstructor.
  """
  __metaclass__ = abc.ABCMeta

  NAME = 'EventInvocationSynchronousEventServiceTest'

  def setUp(self):
    """See unittest.TestCase.setUp for full specification.

    Overriding implementations must call this implementation.
    """
    self._control = test_control.PauseFailControl()
    self._digest = _digest.digest(
        _stock_service.STOCK_TEST_SERVICE, self._control, None)

    generic_stub, dynamic_stubs, self._memo = self.implementation.instantiate(
        self._digest.methods, self._digest.event_method_implementations, None)
    self._invoker = self.invoker_constructor.construct_invoker(
        generic_stub, dynamic_stubs, self._digest.methods)

  def tearDown(self):
    """See unittest.TestCase.tearDown for full specification.

    Overriding implementations must call this implementation.
    """
    self._invoker = None
    self.implementation.destantiate(self._memo)

  def testSuccessfulUnaryRequestUnaryResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.unary_unary_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        request = test_messages.request()
        receiver = _receiver.Receiver()

        self._invoker.event(group, method)(
            request, receiver, receiver.abort, test_constants.LONG_TIMEOUT)
        receiver.block_until_terminated()
        response = receiver.unary_response()

        test_messages.verify(request, response, self)

  def testSuccessfulUnaryRequestStreamResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.unary_stream_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        request = test_messages.request()
        receiver = _receiver.Receiver()

        self._invoker.event(group, method)(
            request, receiver, receiver.abort, test_constants.LONG_TIMEOUT)
        receiver.block_until_terminated()
        responses = receiver.stream_responses()

        test_messages.verify(request, responses, self)

  def testSuccessfulStreamRequestUnaryResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.stream_unary_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        requests = test_messages.requests()
        receiver = _receiver.Receiver()

        call_consumer = self._invoker.event(group, method)(
            receiver, receiver.abort, test_constants.LONG_TIMEOUT)
        for request in requests:
          call_consumer.consume(request)
        call_consumer.terminate()
        receiver.block_until_terminated()
        response = receiver.unary_response()

        test_messages.verify(requests, response, self)

  def testSuccessfulStreamRequestStreamResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.stream_stream_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        requests = test_messages.requests()
        receiver = _receiver.Receiver()

        call_consumer = self._invoker.event(group, method)(
            receiver, receiver.abort, test_constants.LONG_TIMEOUT)
        for request in requests:
          call_consumer.consume(request)
        call_consumer.terminate()
        receiver.block_until_terminated()
        responses = receiver.stream_responses()

        test_messages.verify(requests, responses, self)

  def testSequentialInvocations(self):
    # pylint: disable=cell-var-from-loop
    for (group, method), test_messages_sequence in (
        self._digest.unary_unary_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        first_request = test_messages.request()
        second_request = test_messages.request()
        second_receiver = _receiver.Receiver()

        def make_second_invocation():
          self._invoker.event(group, method)(
              second_request, second_receiver, second_receiver.abort,
              test_constants.LONG_TIMEOUT)

        class FirstReceiver(_receiver.Receiver):

          def complete(self, terminal_metadata, code, details):
            super(FirstReceiver, self).complete(
                terminal_metadata, code, details)
            make_second_invocation()

        first_receiver = FirstReceiver()

        self._invoker.event(group, method)(
            first_request, first_receiver, first_receiver.abort,
            test_constants.LONG_TIMEOUT)
        second_receiver.block_until_terminated()

        first_response = first_receiver.unary_response()
        second_response = second_receiver.unary_response()
        test_messages.verify(first_request, first_response, self)
        test_messages.verify(second_request, second_response, self)

  def testParallelInvocations(self):
    for (group, method), test_messages_sequence in (
        self._digest.unary_unary_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        first_request = test_messages.request()
        first_receiver = _receiver.Receiver()
        second_request = test_messages.request()
        second_receiver = _receiver.Receiver()

        self._invoker.event(group, method)(
            first_request, first_receiver, first_receiver.abort,
            test_constants.LONG_TIMEOUT)
        self._invoker.event(group, method)(
            second_request, second_receiver, second_receiver.abort,
            test_constants.LONG_TIMEOUT)
        first_receiver.block_until_terminated()
        second_receiver.block_until_terminated()

        first_response = first_receiver.unary_response()
        second_response = second_receiver.unary_response()
        test_messages.verify(first_request, first_response, self)
        test_messages.verify(second_request, second_response, self)

  @unittest.skip('TODO(nathaniel): implement.')
  def testWaitingForSomeButNotAllParallelInvocations(self):
    raise NotImplementedError()

  def testCancelledUnaryRequestUnaryResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.unary_unary_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        request = test_messages.request()
        receiver = _receiver.Receiver()

        with self._control.pause():
          call = self._invoker.event(group, method)(
              request, receiver, receiver.abort, test_constants.LONG_TIMEOUT)
          call.cancel()
          receiver.block_until_terminated()

        self.assertIs(face.Abortion.Kind.CANCELLED, receiver.abortion().kind)

  def testCancelledUnaryRequestStreamResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.unary_stream_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        request = test_messages.request()
        receiver = _receiver.Receiver()

        call = self._invoker.event(group, method)(
            request, receiver, receiver.abort, test_constants.LONG_TIMEOUT)
        call.cancel()
        receiver.block_until_terminated()

        self.assertIs(face.Abortion.Kind.CANCELLED, receiver.abortion().kind)

  def testCancelledStreamRequestUnaryResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.stream_unary_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        requests = test_messages.requests()
        receiver = _receiver.Receiver()

        call_consumer = self._invoker.event(group, method)(
            receiver, receiver.abort, test_constants.LONG_TIMEOUT)
        for request in requests:
          call_consumer.consume(request)
        call_consumer.cancel()
        receiver.block_until_terminated()

        self.assertIs(face.Abortion.Kind.CANCELLED, receiver.abortion().kind)

  def testCancelledStreamRequestStreamResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.stream_stream_messages_sequences.iteritems()):
      for unused_test_messages in test_messages_sequence:
        receiver = _receiver.Receiver()

        call_consumer = self._invoker.event(group, method)(
            receiver, receiver.abort, test_constants.LONG_TIMEOUT)
        call_consumer.cancel()
        receiver.block_until_terminated()

        self.assertIs(face.Abortion.Kind.CANCELLED, receiver.abortion().kind)

  def testExpiredUnaryRequestUnaryResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.unary_unary_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        request = test_messages.request()
        receiver = _receiver.Receiver()

        with self._control.pause():
          self._invoker.event(group, method)(
              request, receiver, receiver.abort,
              _3069_test_constant.REALLY_SHORT_TIMEOUT)
          receiver.block_until_terminated()

        self.assertIs(face.Abortion.Kind.EXPIRED, receiver.abortion().kind)

  def testExpiredUnaryRequestStreamResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.unary_stream_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        request = test_messages.request()
        receiver = _receiver.Receiver()

        with self._control.pause():
          self._invoker.event(group, method)(
              request, receiver, receiver.abort,
              _3069_test_constant.REALLY_SHORT_TIMEOUT)
          receiver.block_until_terminated()

        self.assertIs(face.Abortion.Kind.EXPIRED, receiver.abortion().kind)

  def testExpiredStreamRequestUnaryResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.stream_unary_messages_sequences.iteritems()):
      for unused_test_messages in test_messages_sequence:
        receiver = _receiver.Receiver()

        self._invoker.event(group, method)(
            receiver, receiver.abort, _3069_test_constant.REALLY_SHORT_TIMEOUT)
        receiver.block_until_terminated()

        self.assertIs(face.Abortion.Kind.EXPIRED, receiver.abortion().kind)

  def testExpiredStreamRequestStreamResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.stream_stream_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        requests = test_messages.requests()
        receiver = _receiver.Receiver()

        call_consumer = self._invoker.event(group, method)(
            receiver, receiver.abort, _3069_test_constant.REALLY_SHORT_TIMEOUT)
        for request in requests:
          call_consumer.consume(request)
        receiver.block_until_terminated()

        self.assertIs(face.Abortion.Kind.EXPIRED, receiver.abortion().kind)

  def testFailedUnaryRequestUnaryResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.unary_unary_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        request = test_messages.request()
        receiver = _receiver.Receiver()

        with self._control.fail():
          self._invoker.event(group, method)(
              request, receiver, receiver.abort, test_constants.LONG_TIMEOUT)
          receiver.block_until_terminated()

        self.assertIs(
            face.Abortion.Kind.REMOTE_FAILURE, receiver.abortion().kind)

  def testFailedUnaryRequestStreamResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.unary_stream_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        request = test_messages.request()
        receiver = _receiver.Receiver()

        with self._control.fail():
          self._invoker.event(group, method)(
              request, receiver, receiver.abort, test_constants.LONG_TIMEOUT)
          receiver.block_until_terminated()

        self.assertIs(
            face.Abortion.Kind.REMOTE_FAILURE, receiver.abortion().kind)

  def testFailedStreamRequestUnaryResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.stream_unary_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        requests = test_messages.requests()
        receiver = _receiver.Receiver()

        with self._control.fail():
          call_consumer = self._invoker.event(group, method)(
              receiver, receiver.abort, test_constants.LONG_TIMEOUT)
          for request in requests:
            call_consumer.consume(request)
          call_consumer.terminate()
          receiver.block_until_terminated()

        self.assertIs(
            face.Abortion.Kind.REMOTE_FAILURE, receiver.abortion().kind)

  def testFailedStreamRequestStreamResponse(self):
    for (group, method), test_messages_sequence in (
        self._digest.stream_stream_messages_sequences.iteritems()):
      for test_messages in test_messages_sequence:
        requests = test_messages.requests()
        receiver = _receiver.Receiver()

        with self._control.fail():
          call_consumer = self._invoker.event(group, method)(
              receiver, receiver.abort, test_constants.LONG_TIMEOUT)
          for request in requests:
            call_consumer.consume(request)
          call_consumer.terminate()
          receiver.block_until_terminated()

        self.assertIs(
            face.Abortion.Kind.REMOTE_FAILURE, receiver.abortion().kind)
