Yet another round of fixes

Signed-off-by: Alina Buzachis <abuzachis@redhat.com>

Author: alinabuzachis

changelogs/fragments/202030630-amazon_cloud_fixes.yml

@@ -1,4 +1,4 @@
 bugfixes:
-  - "amazon.cloud - Add the original option name as an alias to avoid issues when snake cased option names are not correctly reversed to the original CamelCase."
+  - "amazon.cloud - Add the original option name as an alias to avoid issues when snake cased option names are not correctly reversed to CamelCase."
   - "amazon.cloud - Update cleanup documentation function."
   - "amazon.cloud - Add some temporary workarounds for 'AWS::RDS::DBInstance' resource."

plugins/action/generate_cloud_modules.py

@@ -470,7 +470,9 @@ def gen_mutually_exclusive(schema: Dict) -> List:
     primary_idenfifier = schema.get("primaryIdentifier", [])
     entries: List = []
 
-    _primary_idenfifier = [camel_to_snake(id, alias=False) for id in primary_idenfifier]
+    _primary_idenfifier = [
+        camel_to_snake(id.split("/")[-1], alias=False) for id in primary_idenfifier
+    ]
 
     if len(_primary_idenfifier) > 1:
         entries.append([tuple(_primary_idenfifier), "identifier"])
@@ -480,19 +482,20 @@ def gen_mutually_exclusive(schema: Dict) -> List:
 
 def ensure_all_identifiers_defined(schema: Dict) -> str:
     primary_idenfifier = schema.get("primaryIdentifier", [])
+    _primary_idenfifier = [item.split("/")[-1] for item in primary_idenfifier]
     new_content: str = "if state in ('present', 'absent', 'get', 'describe') and module.params.get('identifier') is None:\n"
     new_content += 8 * " "
     new_content += (
-        f"if not module.params.get('{camel_to_snake(primary_idenfifier[0], alias=False)}')"
+        f"if not module.params.get('{camel_to_snake(_primary_idenfifier[0])}')"
         + " ".join(
             map(
-                lambda x: f" or not module.params.get('{camel_to_snake(x, alias=False)}')",
-                primary_idenfifier[1:],
+                lambda x: f" or not module.params.get('{camel_to_snake(x)}')",
+                _primary_idenfifier[1:],
             )
         )
     )
     new_content += ":\n" + 12 * " "
-    new_content += "module.fail_json(f'You must specify all the {*[camel_to_snake(id, alias=False) for id in identifier], } identifiers.')\n"
+    new_content += f'module.fail_json("You must specify all the {*[camel_to_snake(id) for id in _primary_idenfifier], } identifiers.")\n'
 
     return new_content
 
@@ -522,7 +525,7 @@ def gen_required_if(schema: Union[List, Dict]) -> List:
         states = ["absent", "get"]
 
         _primary_idenfifier = [
-            camel_to_snake(id, alias=False) for id in primary_idenfifier
+            camel_to_snake(id.split("/")[-1], alias=False) for id in primary_idenfifier
         ]
 
         # For compound primary identifiers consisting of multiple resource properties strung together,
@@ -1253,7 +1256,7 @@ def generate_amazon_cloud(args: Iterable, role_path: str):
     meta_dir = pathlib.Path(args.get("target_dir") + "/meta")
     meta_dir.mkdir(parents=True, exist_ok=True)
     yaml_dict = {
-        "requires_ansible": """>=2.12.0""",
+        "requires_ansible": """>=2.13.0""",
         "action_groups": {"aws": []},
         "plugin_routing": {"modules": {}},
     }

plugins/action/generate_cloud_schema.py

@@ -24,38 +24,15 @@ class Schema(TypedDict):
     definitions: Optional[Dict]
     required: Optional[List]
     primaryIdentifier: List
-    # Resource properties that can be returned by a read or list request, but can't be set by the user.
     readOnlyProperties: Optional[List]
-    # Resource properties that can be specified by the user only during resource creation.
     createOnlyProperties: Optional[List]
-    # Resource properties that can be specified by the user, but can't be returned by a read or list request.
-    # Write-only properties are often used to contain passwords, secrets, or other sensitive data.
-    writeOnlyProperties: Optional[List]
-    # Resource properties that have been deprecated by the underlying service provider.
-    # These properties are still accepted in create and update operations.
-    # However they may be ignored, or converted to a consistent model on application.
-    # Deprecated properties are not guaranteed to be returned by read operations.
-    deprecatedProperties: Optional[List]
     taggable: Optional[bool]
     handlers: Optional[Dict]
 
 
 def generate_schema(raw_content) -> Dict:
     json_content = json.loads(raw_content)
     schema: Dict[str, Schema] = json_content
-
-    for key, value in schema.items():
-        if key not in ("anyOf", "oneOf"):
-            if isinstance(value, list):
-                elems = []
-                for v in value:
-                    if isinstance(v, list):
-                        elems.extend([p.split("/")[-1].strip() for p in v])
-                    else:
-                        elems.append(v.split("/")[-1].strip())
-
-                schema[key] = elems
-
     return schema
 
 

plugins/plugin_utils/cloud_utils/generator.py

@@ -141,16 +141,13 @@ def replace_keys(self, options: Iterable, definitions: Iterable):
         """Sanitize module's options and replace $ref with the correspoding parameters"""
         dict_copy = copy.copy(options)
         for key in dict_copy.keys():
-            # The 'AWS::RDS::DBInstance' template has a bug for Port option which is classified as
-            # createOnlyProperties, writeOnlyProperties and a readOnlyProperties, but it can be set
-            # and it should not be filtered out from the documentation. This is a temporary workaround.
-            if self.type_name != "AWS::RDS::DBInstance":
-                if (
-                    key in self.read_only_properties
-                    and key not in self.primary_identifier
-                ):
-                    options.pop(key)
-                    continue
+            key_path = f"/properties/{key}"
+            if (
+                key_path in self.read_only_properties
+                and key_path not in self.primary_identifier
+            ):
+                options.pop(key)
+                continue
 
             item = options[key]
 
@@ -231,6 +228,31 @@ def cleanup_required(self, a_dict: Iterable):
 
             self.cleanup_required(a_dict[k])
 
+    def cleanup_readonly_properties(self):
+        options = copy.deepcopy(self.options)
+
+        def _cleanup_readonly_properties(nested_dict, key_list):
+            if not key_list:
+                return nested_dict
+            key = key_list[0]
+            if key in nested_dict:
+                if len(key_list) == 1:
+                    return nested_dict.pop(key, None)
+                else:
+                    return _cleanup_readonly_properties(
+                        nested_dict[key]["suboptions"], key_list[1:]
+                    )
+            else:
+                return None
+
+        for item in self.read_only_properties:
+            opt = item.split("/")
+            _cleanup_readonly_properties(options, opt[2:])
+            # Remove option entirely if all the suboptions have been removed
+            if options.get(opt[2]) and options.pop(opt[2]).get("suboptions", {}) == {}:
+                options.pop(opt[2])
+        return options
+
     def preprocess(self) -> Iterable:
         list_of_keys_to_remove = [
             "additionalProperties",
@@ -252,9 +274,9 @@ def preprocess(self) -> Iterable:
             "maxProperties",
             "anyOf",
         ]
-
         self.replace_keys(self.options, self.definitions)
         self.cleanup_required(self.options)
+        self.options = self.cleanup_readonly_properties()
         sanitized_options: Iterable = camel_to_snake(
             scrub_keys(self.options, list_of_keys_to_remove)
         )
@@ -302,8 +324,6 @@ def generate_documentation(
     docs.options = module.schema.get("properties", {})
     docs.definitions = module.schema.get("definitions", {})
 
-    docs.type_name = module.schema.get("typeName")
-
     # Properties defined as required must be specified in the desired state during resource creation
     docs.required = module.schema.get("required", [])
 

roles/module_openapi_cloud/templates/module_directory/amazon_cloud/default_module.j2

@@ -48,7 +48,7 @@ def main():
             module.params["tags"]
         )
 
-    # Use the alis from argument_spec as key and avoid snake_to_camel conversions
+    # Use the alias from argument_spec as key and avoid snake_to_camel conversions
     params_to_set = map_key_to_alias(_params_to_set, argument_spec)
 
     # Ignore createOnlyProperties that can be set only during resource creation