sdk/python/tests/test_internal.py

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: Apache-2.0
   4
   5 import re
   6
   7 import pytest
   8
   9 from arvados import _internal
  10
  11 class TestDeprecated:
  12     @staticmethod
  13     @_internal.deprecated('TestVersion', 'arvados.noop')
  14     def noop_func():
  15         """Do nothing
  16
  17         This function returns None.
  18         """
  19
  20     @pytest.mark.parametrize('pattern', [
  21         r'^Do nothing$',
  22         r'^ +.. WARNING:: Deprecated$',
  23         r' removed in Arvados TestVersion\.',
  24         r' Prefer arvados\.noop\b',
  25         r'^ +This function returns None\.$',
  26     ])
  27     def test_docstring(self, pattern):
  28         assert re.search(pattern, self.noop_func.__doc__, re.MULTILINE) is not None
  29
  30     def test_deprecation_warning(self):
  31         with pytest.warns(DeprecationWarning) as check:
  32             self.noop_func()
  33         actual = str(check[0].message)
  34         assert ' removed in Arvados TestVersion.' in actual
  35         assert ' Prefer arvados.noop ' in actual