Long addition (#328)

Support long types via format in jsonschema. Resource provider authors can now specify a `format` key in their integer schemas to determine if the code generated variable for the property will be of type Long (`int64`) or Integer(`int32`). Will default to Integer.

Author: John Tompkins

README.md

@@ -23,6 +23,26 @@ pip3 install cloudformation-cli-java-plugin
 
 Refer to the [CloudFormation CLI User Guide](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html) for the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli) for usage instructions.
 
+### Alternate Type Formats
+The `format` keyword can be specified on primitive types defined in a resource provider's schema to allow the CloudFormation CLI Java Plugin to generate more than the defaults for primitive types. Consult the table below for what formats are available and defaults for various types. The `default` value is used if omitted:
+
+| JSON Schema Type | Format value | Generated variable type  |
+| ---- | ----------- | ---------------------- |
+| boolean | `default` | [Boolean](https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html)|
+| integer | `default`, `int32` | [Integer](https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html)|
+| integer | `int64` | [Long](https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html)|
+| number | `default` | [Double](https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html)|
+| string | `default` | [String](https://docs.oracle.com/javase/8/docs/api/java/lang/String.html)|
+
+For example, the below schema for a property would generate a variable of type `Long`.
+```
+{
+    "type": "integer",
+    "format": "int64"
+}
+```
+
+
 Development
 -----------
 

python/rpdk/java/resolver.py

@@ -1,27 +1,44 @@
-from rpdk.core.jsonutils.resolver import UNDEFINED, ContainerType
+import logging
+
+from rpdk.core.jsonutils.resolver import FORMAT_DEFAULT, UNDEFINED, ContainerType
+
+LOG = logging.getLogger(__name__)
 
 PRIMITIVE_TYPES = {
-    "string": "String",
-    "integer": "Integer",
-    "boolean": "Boolean",
-    "number": "Double",
-    UNDEFINED: "Object",
+    "string": {"default": "String"},
+    "integer": {"default": "Integer", "int32": "Integer", "int64": "Long"},
+    "boolean": {"default": "Boolean"},
+    "number": {"default": "Double"},
+    UNDEFINED: {"default": "Object"},
 }
 
 
 def translate_type(resolved_type):
     if resolved_type.container == ContainerType.MODEL:
         return resolved_type.type
     if resolved_type.container == ContainerType.PRIMITIVE:
-        return PRIMITIVE_TYPES[resolved_type.type]
+        try:
+            primitive_format = PRIMITIVE_TYPES[resolved_type.type][
+                resolved_type.type_format
+            ]
+        except KeyError:
+            primitive_format = PRIMITIVE_TYPES[resolved_type.type][FORMAT_DEFAULT]
+            LOG.error(
+                "Could not find specified format '%s' for type '%s'. "
+                "Defaulting to '%s'",
+                resolved_type.type_format,
+                resolved_type.type,
+                primitive_format,
+            )
+        return primitive_format
 
     if resolved_type.container == ContainerType.MULTIPLE:
         return "Object"
 
     item_type = translate_type(resolved_type.type)
 
     if resolved_type.container == ContainerType.DICT:
-        key_type = PRIMITIVE_TYPES["string"]
+        key_type = PRIMITIVE_TYPES["string"]["default"]
         return f"Map<{key_type}, {item_type}>"
     if resolved_type.container == ContainerType.LIST:
         return f"List<{item_type}>"

setup.py

@@ -36,7 +36,7 @@ def find_version(*file_paths):
     # package_data -> use MANIFEST.in instead
     include_package_data=True,
     zip_safe=True,
-    install_requires=["cloudformation-cli>=0.1.4,<0.2"],
+    install_requires=["cloudformation-cli>=0.1.14,<0.2"],
     python_requires=">=3.6",
     entry_points={"rpdk.v1.languages": ["java = rpdk.java.codegen:JavaLanguagePlugin"]},
     license="Apache License 2.0",

tests/test_resolver.py

@@ -3,8 +3,19 @@
 from rpdk.java.resolver import PRIMITIVE_TYPES, translate_type
 
 RESOLVED_TYPES = [
-    (ResolvedType(ContainerType.PRIMITIVE, item_type), native_type)
-    for item_type, native_type in PRIMITIVE_TYPES.items()
+    (ResolvedType(ContainerType.PRIMITIVE, item_type), formats["default"])
+    for item_type, formats in PRIMITIVE_TYPES.items()
+]
+
+RESOLVED_INTEGER_FORMATS = [
+    (
+        ResolvedType(ContainerType.PRIMITIVE, "integer", "int64"),
+        PRIMITIVE_TYPES["integer"]["int64"],
+    ),
+    (
+        ResolvedType(ContainerType.PRIMITIVE, "integer", "int32"),
+        PRIMITIVE_TYPES["integer"]["int32"],
+    ),
 ]
 
 
@@ -45,3 +56,13 @@ def test_translate_type_set(resolved_type, native_type):
 def test_translate_type_unknown(resolved_type, _java_type):
     with pytest.raises(ValueError):
         translate_type(ResolvedType("foo", resolved_type))
+
+
+@pytest.mark.parametrize("resolved_type,java_type", RESOLVED_INTEGER_FORMATS)
+def test_translate_type_integer_formats(resolved_type, java_type):
+    assert translate_type(resolved_type) == java_type
+
+
+def test_translate_type_unavailable_format():
+    resolved_type = ResolvedType(ContainerType.PRIMITIVE, "integer", "int128")
+    assert translate_type(resolved_type) == PRIMITIVE_TYPES["integer"]["default"]