Merge pull request #165 from cloudify-incubator/RND-704-generic-deprecation-warning

add support for deprecation decorator

Author: EarthmanT

CHANGELOG.txt

@@ -1,4 +1,5 @@
 releases:
+  v0.0.122: add deprecation_warning decorator.
   v0.0.121: obfuscation_keywords kw arg in obfuscate_passwords.
   v0.0.120: Upgrade Kubernetes 26.1.0.
   v0.0.119: fix issue in plugin properties after 7.0.0 GA.

cloudify_common_sdk/__version__.py

@@ -1 +1 @@
-version = '0.0.121'
+version = '0.0.122'

cloudify_common_sdk/deprecation.py

@@ -0,0 +1,87 @@
+# Copyright (c) 2018 - 2023 Cloudify Platform Ltd. 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.
+
+from functools import wraps
+
+from cloudify import ctx
+from cfy_lint.yamllint_ext.rules.constants import (
+    deprecated_node_types,
+    deprecated_relationship_types
+)
+try:
+    from cloudify.constants import RELATIONSHIP_INSTANCE, NODE_INSTANCE
+except ImportError:
+    NODE_INSTANCE = 'node-instance'
+    RELATIONSHIP_INSTANCE = 'relationship-instance'
+
+
+def deprecation_warning(func):
+    @wraps(func)
+    def inner(*args, **kwargs):
+        check_deprecated_node_type()
+        check_deprecated_relationship()
+        return func(*args, **kwargs)
+    return inner
+
+
+def check_deprecated_relationship():
+    if ctx.type == RELATIONSHIP_INSTANCE:
+        for rel in ctx.source.instance.relationships:
+            if rel.target.node.id == ctx.target.node.id:
+                new_rel_type = deprecated_relationship_types.get(rel.type)
+                if new_rel_type:
+                    log_deprecation(rel.type, new_rel_type, 'relationship')
+        source_node_type = deprecated_node_types.get(
+            ctx.source.node.type)
+        target_node_type = deprecated_node_types.get(
+            ctx.target.node.type)
+        if source_node_type:
+            log_deprecation(
+                ctx.source.node.type,
+                source_node_type,
+                'source node')
+        if target_node_type:
+            log_deprecation(
+                ctx.target.node.type,
+                target_node_type,
+                'target node')
+    else:
+        for rel in ctx.instance.relationships:
+            new_rel_type = deprecated_relationship_types.get(rel.type)
+            if new_rel_type:
+                log_deprecation(
+                    rel.type,
+                    new_rel_type,
+                    'relationship'
+                )
+
+
+def check_deprecated_node_type():
+    if ctx.type != NODE_INSTANCE:
+        return
+    new_node_type = deprecated_node_types.get(ctx.node.type)
+    if new_node_type:
+        log_deprecation(ctx.node.type, new_node_type)
+
+
+def log_deprecation(old_type, new_type, rel_or_node=None):
+    rel_or_node = rel_or_node or 'node'
+    ctx.logger.error(
+        'The {rel_or_node} type {old_type} is deprecated, '
+        'please update your blueprint to use {new_type}'.format(
+            rel_or_node=rel_or_node,
+            old_type=old_type,
+            new_type=new_type,
+        )
+    )

cloudify_common_sdk/tests/test_deprecation.py

@@ -0,0 +1,107 @@
+# Copyright (c) 2018 - 2023 Cloudify Platform Ltd. 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.
+
+import mock
+import unittest
+from cloudify_common_sdk.deprecation import (
+    log_deprecation,
+    deprecation_warning,
+    check_deprecated_node_type,
+    check_deprecated_relationship,
+)
+
+
+@mock.patch('cloudify.state.current_ctx.get_ctx')
+class TestDeprecation(unittest.TestCase):
+
+    def test_log_deprecation(self, mock_get_ctx, *_):
+        expected = 'The baz type foo is deprecated, ' \
+                   'please update your blueprint to use bar'
+        mock_ctx = mock.Mock()
+        mock_ctx.logger = mock.Mock()
+        mock_get_ctx.return_value = mock_ctx
+        log_deprecation(
+            'foo', 'bar', 'baz')
+        mock_ctx.logger.error.assert_called_with(expected)
+
+    @mock.patch('cloudify_common_sdk.deprecation.deprecated_node_types')
+    @mock.patch('cloudify_common_sdk.deprecation.log_deprecation')
+    def test_check_deprecated_node_type(
+            self, mock_log, mock_deprecated, mock_get_ctx, *__):
+        mock_deprecated.get.return_value = 'bar'
+
+        mock_ctx = mock.Mock()
+        mock_ctx.type = 'node-instance'
+        mock_ctx.logger = mock.Mock()
+
+        mock_ctx.node = mock.Mock(type='foo')
+        mock_get_ctx.return_value = mock_ctx
+        check_deprecated_node_type()
+        mock_log.assert_called_with('foo', 'bar')
+
+    @mock.patch(
+        'cloudify_common_sdk.deprecation.deprecated_relationship_types')
+    @mock.patch('cloudify_common_sdk.deprecation.log_deprecation')
+    def test_check_deprecated_relationship(
+            self, mock_log, mock_deprecated, mock_get_ctx, *__):
+        mock_deprecated.get.return_value = 'bar'
+
+        mock_node_ctx = mock.Mock(type='foo', id='qux')
+
+        mock_rel = mock.Mock()
+        mock_rel.type = 'foo'
+        mock_rel.target = mock.Mock(node=mock_node_ctx)
+        mock_instance_ctx = mock.Mock(relationships=[mock_rel])
+
+        mock_source = mock.Mock()
+        mock_source.instance = mock_instance_ctx
+        mock_target = mock.Mock(node=mock_node_ctx)
+
+        mock_ctx = mock.Mock()
+        mock_ctx.type = 'relationship-instance'
+        mock_ctx.logger = mock.Mock()
+
+        mock_ctx.target = mock_target
+        mock_ctx.source = mock_source
+
+        mock_get_ctx.return_value = mock_ctx
+        check_deprecated_relationship()
+        mock_log.assert_called_with('foo', 'bar', 'relationship')
+
+    @mock.patch(
+        'cloudify_common_sdk.deprecation.check_deprecated_node_type')
+    @mock.patch(
+        'cloudify_common_sdk.deprecation.check_deprecated_relationship')
+    def test_decorator(self, mock_a, mock_b, *_):
+
+        @deprecation_warning
+        def foo(*args, **kwargs):
+            for v in args:
+                v('foo')
+            for k, v in kwargs.items():
+                v(k)
+
+        args = [mock.Mock(), mock.Mock()]
+        kwargs = {
+            'a': mock.Mock(),
+            'b': mock.Mock()
+        }
+
+        foo(*args, **kwargs)
+        for v in args:
+            v.assert_called_with('foo')
+        for k, v in kwargs.items():
+            v.assert_called_with(k)
+        mock_a.assert_called_once()
+        mock_b.assert_called_once()

setup.py

@@ -58,6 +58,7 @@ def get_version():
         'xmltodict',   # rest
         "gitdb>=0.6.4",  # shared download resource
         "GitPython",  # shared download resource
+        "cfy-lint>=0.0.31",
         'psutil',
         'packaging',
         'kubernetes==v26.1.0',

tox.ini

@@ -19,7 +19,8 @@ whitelist_externals = bash
 commands =
     pytest -vv -s cloudify_kubernetes_sdk/tests/
     pytest -vv -s cloudify_common_sdk/tests/test_cli_tool_base.py
-    nosetests -v -s --ignore-files="test_cli_tool_base\.py" --cover-html \
+    pytest -vv -s cloudify_common_sdk/tests/test_deprecation.py
+    nosetests -v -s --ignore-files="test_cli_tool_base\.py"  --ignore-files="test_deprecation\.py" --cover-html \
         --with-coverage \
         --cover-package=cloudify_common_sdk \
         --cover-package=cloudify_rest_sdk \