# Copyright 2017 The TensorFlow Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ==============================================================================
"""Unit tests for tf_should_use."""

# pylint: disable=unused-import
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function

import contextlib
import gc
import sys

from tensorflow.python.framework import constant_op
from tensorflow.python.platform import test
from tensorflow.python.platform import tf_logging
from tensorflow.python.util import tf_should_use


@contextlib.contextmanager
def reroute_error():
  """Temporarily reroute errors written to tf_logging.error into `captured`."""
  with test.mock.patch.object(tf_should_use.tf_logging, 'error') as error:
    with test.mock.patch.object(tf_should_use.tf_logging, 'fatal') as fatal:
      yield error, fatal


class TfShouldUseTest(test.TestCase):

  def testAddShouldUseWarningWhenNotUsed(self):
    c = constant_op.constant(0, name='blah0')
    def in_this_function():
      h = tf_should_use._add_should_use_warning(c)
      del h
    with reroute_error() as (error, _):
      in_this_function()
    error.assert_called()
    msg = '\n'.join(error.call_args[0])
    self.assertIn('Object was never used', msg)
    self.assertIn('blah0:0', msg)
    self.assertIn('in_this_function', msg)
    self.assertFalse(gc.garbage)

  def testAddShouldUseFatalWhenNotUsed(self):
    c = constant_op.constant(0, name='blah0')
    def in_this_function():
      h = tf_should_use._add_should_use_warning(c, fatal_error=True)
      del h
    with reroute_error() as (_, fatal):
      in_this_function()
    fatal.assert_called()
    msg = '\n'.join(fatal.call_args[0])
    self.assertIn('Object was never used', msg)
    self.assertIn('blah0:0', msg)
    self.assertIn('in_this_function', msg)
    self.assertFalse(gc.garbage)

  def _testAddShouldUseWarningWhenUsed(self, fn, name):
    c = constant_op.constant(0, name=name)
    with reroute_error() as (error, fatal):
      h = tf_should_use._add_should_use_warning(c)
      fn(h)
      del h
    error.assert_not_called()
    fatal.assert_not_called()

  def testAddShouldUseWarningWhenUsedWithAdd(self):
    def add(h):
      _ = h + 1
    self._testAddShouldUseWarningWhenUsed(add, name='blah_add')
    gc.collect()
    self.assertFalse(gc.garbage)

  def testAddShouldUseWarningWhenUsedWithGetName(self):
    def get_name(h):
      _ = h.name
    self._testAddShouldUseWarningWhenUsed(get_name, name='blah_get_name')
    gc.collect()
    self.assertFalse(gc.garbage)

  def testShouldUseResult(self):
    @tf_should_use.should_use_result
    def return_const(value):
      return constant_op.constant(value, name='blah2')
    with reroute_error() as (error, _):
      return_const(0.0)
    error.assert_called()
    msg = '\n'.join(error.call_args[0])
    self.assertIn('Object was never used', msg)
    self.assertIn('blah2:0', msg)
    self.assertIn('return_const', msg)
    gc.collect()
    self.assertFalse(gc.garbage)

  def testShouldUseResultWhenNotReallyUsed(self):
    @tf_should_use.should_use_result
    def return_const(value):
      return constant_op.constant(value, name='blah3')
    with reroute_error() as (error, _):
      with self.test_session():
        return_const(0.0)
        # Creating another op and executing it does not mark the
        # unused op as being "used".
        v = constant_op.constant(1.0, name='meh')
        v.eval()
    error.assert_called()
    msg = '\n'.join(error.call_args[0])
    self.assertIn('Object was never used', msg)
    self.assertIn('blah3:0', msg)
    self.assertIn('return_const', msg)
    gc.collect()
    self.assertFalse(gc.garbage)

  # Tests that mark_used is available in the API.
  def testMarkUsed(self):
    @tf_should_use.should_use_result
    def return_const(value):
      return constant_op.constant(value, name='blah3')
    with self.test_session():
      return_const(0.0).mark_used()

if __name__ == '__main__':
  test.main()

[(135, 'tensorflow.python.platform.test.main', 'test.main', False, 'from tensorflow.python.platform import test\n'), (35, 'tensorflow.python.platform.test.mock.patch.object', 'test.mock.patch.object', False, 'from tensorflow.python.platform import test\n'), (43, 'tensorflow.python.framework.constant_op.constant', 'constant_op.constant', False, 'from tensorflow.python.framework import constant_op\n'), (57, 'tensorflow.python.framework.constant_op.constant', 'constant_op.constant', False, 'from tensorflow.python.framework import constant_op\n'), (71, 'tensorflow.python.framework.constant_op.constant', 'constant_op.constant', False, 'from tensorflow.python.framework import constant_op\n'), (83, 'gc.collect', 'gc.collect', False, 'import gc\n'), (90, 'gc.collect', 'gc.collect', False, 'import gc\n'), (104, 'gc.collect', 'gc.collect', False, 'import gc\n'), (123, 'gc.collect', 'gc.collect', False, 'import gc\n'), (36, 'tensorflow.python.platform.test.mock.patch.object', 'test.mock.patch.object', False, 'from tensorflow.python.platform import test\n'), (45, 'tensorflow.python.util.tf_should_use._add_should_use_warning', 'tf_should_use._add_should_use_warning', False, 'from tensorflow.python.util import tf_should_use\n'), (59, 'tensorflow.python.util.tf_should_use._add_should_use_warning', 'tf_should_use._add_should_use_warning', False, 'from tensorflow.python.util import tf_should_use\n'), (73, 'tensorflow.python.util.tf_should_use._add_should_use_warning', 'tf_should_use._add_should_use_warning', False, 'from tensorflow.python.util import tf_should_use\n'), (96, 'tensorflow.python.framework.constant_op.constant', 'constant_op.constant', False, 'from tensorflow.python.framework import constant_op\n'), (110, 'tensorflow.python.framework.constant_op.constant', 'constant_op.constant', False, 'from tensorflow.python.framework import constant_op\n'), (130, 'tensorflow.python.framework.constant_op.constant', 'constant_op.constant', False, 'from tensorflow.python.framework import constant_op\n'), (116, 'tensorflow.python.framework.constant_op.constant', 'constant_op.constant', False, 'from tensorflow.python.framework import constant_op\n')]