From 947fa3bad3833187d0559ffff633137fcf823507 Mon Sep 17 00:00:00 2001
From: Felix Fontein <felix@fontein.de>
Date: Tue, 5 May 2020 18:38:10 +0200
Subject: [PATCH] ansible-test validate-modules: don't allow arbitrary lists
 and dicts for 'default', 'sample' and 'example' (#69287)

* Don't allow arbitrary lists and dicts for 'default', 'sample' and 'example'.

* Add changelog.

* Make compile with Python 2.
---
 ...e-test-validate-default-sample-example.yml |  2 ++
 .../validate_modules/schema.py                | 21 +++++++++++++------
 2 files changed, 17 insertions(+), 6 deletions(-)
 create mode 100644 changelogs/fragments/69287-ansible-test-validate-default-sample-example.yml

diff --git a/changelogs/fragments/69287-ansible-test-validate-default-sample-example.yml b/changelogs/fragments/69287-ansible-test-validate-default-sample-example.yml
new file mode 100644
index 00000000000..540a9ff7bdc
--- /dev/null
+++ b/changelogs/fragments/69287-ansible-test-validate-default-sample-example.yml
@@ -0,0 +1,2 @@
+minor_changes:
+- "ansible-test - improve module validation so that ``default``, ``sample`` and ``example`` contain JSON values and not arbitrary YAML values, like ``datetime`` objects or dictionaries with non-string keys."
diff --git a/test/lib/ansible_test/_data/sanity/validate-modules/validate_modules/schema.py b/test/lib/ansible_test/_data/sanity/validate-modules/validate_modules/schema.py
index 7f7bc566f16..d88f9d7d7be 100644
--- a/test/lib/ansible_test/_data/sanity/validate-modules/validate_modules/schema.py
+++ b/test/lib/ansible_test/_data/sanity/validate-modules/validate_modules/schema.py
@@ -147,6 +147,15 @@ def ansible_module_kwargs_schema():
     return Schema(schema)
 
 
+json_value = Schema(Any(
+    None,
+    int,
+    float,
+    [Self],
+    *(list({str_type: Self} for str_type in string_types) + list(string_types))
+))
+
+
 suboption_schema = Schema(
     {
         Required('description'): Any(list_string_types, *string_types),
@@ -154,7 +163,7 @@ suboption_schema = Schema(
         'choices': list,
         'aliases': Any(list_string_types),
         'version_added': Any(float, *string_types),
-        'default': Any(None, float, int, bool, list, dict, *string_types),
+        'default': json_value,
         # Note: Types are strings, not literal bools, such as True or False
         'type': Any(None, 'bits', 'bool', 'bytes', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'raw', 'sid', 'str'),
         # in case of type='list' elements define type of individual item in list
@@ -176,7 +185,7 @@ option_schema = Schema(
         'choices': list,
         'aliases': Any(list_string_types),
         'version_added': Any(float, *string_types),
-        'default': Any(None, float, int, bool, list, dict, *string_types),
+        'default': json_value,
         'suboptions': Any(None, *list_dict_suboption_schema),
         # Note: Types are strings, not literal bools, such as True or False
         'type': Any(None, 'bits', 'bool', 'bytes', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'raw', 'sid', 'str'),
@@ -211,8 +220,8 @@ return_contains_schema = Any(
                 'returned': Any(*string_types),  # only returned on top level
                 Required('type'): Any('bool', 'complex', 'dict', 'float', 'int', 'list', 'str'),
                 'version_added': Any(float, *string_types),
-                'sample': Any(None, list, dict, int, float, *string_types),
-                'example': Any(None, list, dict, int, float, *string_types),
+                'sample': json_value,
+                'example': json_value,
                 'contains': Any(None, *list({str_type: Self} for str_type in string_types)),
                 # in case of type='list' elements define type of individual item in list
                 'elements': Any(None, 'bits', 'bool', 'bytes', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'raw', 'sid', 'str'),
@@ -236,8 +245,8 @@ return_schema = Any(
                     Required('returned'): Any(*string_types),
                     Required('type'): Any('bool', 'complex', 'dict', 'float', 'int', 'list', 'str'),
                     'version_added': Any(float, *string_types),
-                    'sample': Any(None, list, dict, int, float, *string_types),
-                    'example': Any(None, list, dict, int, float, *string_types),
+                    'sample': json_value,
+                    'example': json_value,
                     'contains': Any(None, *list_dict_return_contains_schema),
                     # in case of type='list' elements define type of individual item in list
                     'elements': Any(None, 'bits', 'bool', 'bytes', 'dict', 'float', 'int', 'json', 'jsonarg', 'list', 'path', 'raw', 'sid', 'str'),