Added a method to provide plugin information that is included in artifact zip (#167)

Co-authored-by: Omkar Hegde <[email protected]>

Author: priyap286

.pre-commit-config.yaml

@@ -49,13 +49,14 @@ repos:
   - id: bandit
     files: ^(src|python)/
 - repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v0.711
+  rev: v0.790
   hooks:
   - id: mypy
     files: ^src/
     args:
     - --strict
     - --implicit-reexport
+    - --no-warn-unused-ignores # https://github.com/python/mypy/issues/8823, https://github.com/python/mypy/issues/8990
 - repo: local
   hooks:
   - id: pylint-local

python/rpdk/python/codegen.py

@@ -5,6 +5,7 @@
 from pathlib import PurePosixPath
 from subprocess import PIPE, CalledProcessError, run as subprocess_run  # nosec
 from tempfile import TemporaryFile
+from typing import Dict
 
 import docker
 from docker.errors import APIError, ContainerError, ImageLoadError
@@ -15,6 +16,7 @@
 from rpdk.core.jsonutils.resolver import ContainerType, resolve_models
 from rpdk.core.plugin_base import LanguagePlugin
 
+from . import __version__
 from .resolver import contains_model, translate_type
 
 LOG = logging.getLogger(__name__)
@@ -169,6 +171,12 @@ def generate(self, project):
 
         LOG.debug("Generate complete")
 
+    # pylint: disable=unused-argument
+    # the argument "project" is not used here but is used in codegen.py of other plugins
+    # this method is called in cloudformation-cli/src/rpdk/core/project.py
+    def get_plugin_information(self, project) -> Dict:
+        return self._get_plugin_information()
+
     def _pre_package(self, build_path):
         f = TemporaryFile("w+b")  # pylint: disable=R1732
 
@@ -233,6 +241,10 @@ def _make_pip_command(base_path):
             str(base_path / "build"),
         ]
 
+    @staticmethod
+    def _get_plugin_information() -> Dict:
+        return {"plugin-tool-version": __version__, "plugin-name": "python"}
+
     @classmethod
     def _docker_build(cls, external_path):
         internal_path = PurePosixPath("/project")

src/cloudformation_cli_python_lib/recast.py

@@ -1,3 +1,4 @@
+import sys
 import typing
 from typing import Any, Dict, List, Mapping, Set
 
@@ -14,7 +15,7 @@ def recast_object(
     if not isinstance(json_data, dict):
         raise InvalidRequest(f"Can only parse dict items, not {type(json_data)}")
     # if type is Any, we leave it as is
-    if cls == typing.Any:
+    if cls is typing.Any:
         return
     for k, v in json_data.items():
         if isinstance(v, dict):
@@ -35,7 +36,7 @@ def recast_object(
 
 def _recast_lists(cls: Any, k: str, v: List[Any], classes: Dict[str, Any]) -> List[Any]:
     # Leave as is if type is Any
-    if cls == typing.Any:
+    if cls is typing.Any:
         return v
     if "__dataclass_fields__" not in dir(cls):
         pass
@@ -64,7 +65,7 @@ def cast_sequence_item(cls: Any, k: str, item: Any, classes: Dict[str, Any]) ->
 
 
 def _recast_primitive(cls: Any, k: str, v: Any) -> Any:
-    if cls == typing.Any:
+    if cls is typing.Any:
         # If the type is Any, we cannot guess what the original type was, so we leave
         # it as a string
         return v
@@ -126,6 +127,6 @@ def get_forward_ref_type() -> Any:
     # ignoring mypy on the import as it catches (_)ForwardRef as invalid, use for
     # introspection is valid:
     # https://docs.python.org/3/library/typing.html#typing.ForwardRef
-    if "ForwardRef" in dir(typing):
-        return typing.ForwardRef  # type: ignore
-    return typing._ForwardRef  # type: ignore
+    if sys.version_info < (3, 7):
+        return typing._ForwardRef  # type: ignore
+    return typing.ForwardRef

tests/lib/recast_test.py

@@ -148,10 +148,15 @@ class SevenType:
 
 
 def test_get_forward_ref_type():
-    with patch("cloudformation_cli_python_lib.recast.typing") as mock_typing:
-        mock_typing.ForwardRef = "3.7+"
-        assert get_forward_ref_type() == "3.7+"
-    with patch("cloudformation_cli_python_lib.recast.typing") as mock_typing:
-        mock_typing._ForwardRef = "3.6"
-        get_forward_ref_type()
-        assert get_forward_ref_type() == "3.6"
+    with patch("cloudformation_cli_python_lib.recast.sys") as mock_sys:
+        mock_sys.version_info = (3, 7)
+        with patch("cloudformation_cli_python_lib.recast.typing") as mock_typing:
+            mock_typing.ForwardRef = "3.7+"
+            assert get_forward_ref_type() == "3.7+"
+
+    with patch("cloudformation_cli_python_lib.recast.sys") as mock_sys:
+        mock_sys.version_info = (3, 6)
+        with patch("cloudformation_cli_python_lib.recast.typing") as mock_typing:
+            mock_typing._ForwardRef = "3.6"
+            get_forward_ref_type()
+            assert get_forward_ref_type() == "3.6"

tests/plugin/codegen_test.py

@@ -14,6 +14,7 @@
 from requests.exceptions import ConnectionError as RequestsConnectionError
 from rpdk.core.exceptions import DownstreamError
 from rpdk.core.project import Project
+from rpdk.python.__init__ import __version__
 from rpdk.python.codegen import (
     SUPPORT_LIB_NAME,
     SUPPORT_LIB_PKG,
@@ -289,6 +290,13 @@ def test__docker_build_good_path(plugin, tmp_path):
     )
 
 
+def test_get_plugin_information(project):
+    plugin_information = project._plugin.get_plugin_information(project)
+
+    assert plugin_information["plugin-tool-version"] == __version__
+    assert plugin_information["plugin-name"] == "python"
+
+
 @pytest.mark.parametrize(
     "exception",
     [