[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 07/25] qapi/expr.py: Check type of union and alternate 'data' memb
From: |
Markus Armbruster |
Subject: |
[PULL 07/25] qapi/expr.py: Check type of union and alternate 'data' member |
Date: |
Fri, 30 Apr 2021 13:48:20 +0200 |
From: John Snow <jsnow@redhat.com>
Prior to this commit, specifying a non-object value here causes the QAPI
parser to crash in expr.py with a stack trace with (likely) an
AttributeError when we attempt to call that value's items() method.
This member needs to be an object (Dict), and not anything else. Add a
check for this with a nicer error message, and formalize that check with
new test cases that exercise that error.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-Id: <20210421182032.3521476-8-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
scripts/qapi/expr.py | 7 +++++++
tests/qapi-schema/alternate-data-invalid.err | 2 ++
tests/qapi-schema/alternate-data-invalid.json | 4 ++++
tests/qapi-schema/alternate-data-invalid.out | 0
tests/qapi-schema/meson.build | 2 ++
tests/qapi-schema/union-invalid-data.err | 2 ++
tests/qapi-schema/union-invalid-data.json | 6 ++++++
tests/qapi-schema/union-invalid-data.out | 0
8 files changed, 23 insertions(+)
create mode 100644 tests/qapi-schema/alternate-data-invalid.err
create mode 100644 tests/qapi-schema/alternate-data-invalid.json
create mode 100644 tests/qapi-schema/alternate-data-invalid.out
create mode 100644 tests/qapi-schema/union-invalid-data.err
create mode 100644 tests/qapi-schema/union-invalid-data.json
create mode 100644 tests/qapi-schema/union-invalid-data.out
diff --git a/scripts/qapi/expr.py b/scripts/qapi/expr.py
index c0d18dcc01..03624bdf3f 100644
--- a/scripts/qapi/expr.py
+++ b/scripts/qapi/expr.py
@@ -283,6 +283,9 @@ def check_union(expr, info):
raise QAPISemError(info, "'discriminator' requires 'base'")
check_name_is_str(discriminator, info, "'discriminator'")
+ if not isinstance(members, dict):
+ raise QAPISemError(info, "'data' must be an object")
+
for (key, value) in members.items():
source = "'data' member '%s'" % key
if discriminator is None:
@@ -298,6 +301,10 @@ def check_alternate(expr, info):
if not members:
raise QAPISemError(info, "'data' must not be empty")
+
+ if not isinstance(members, dict):
+ raise QAPISemError(info, "'data' must be an object")
+
for (key, value) in members.items():
source = "'data' member '%s'" % key
check_name_lower(key, info, source)
diff --git a/tests/qapi-schema/alternate-data-invalid.err
b/tests/qapi-schema/alternate-data-invalid.err
new file mode 100644
index 0000000000..55f1033aef
--- /dev/null
+++ b/tests/qapi-schema/alternate-data-invalid.err
@@ -0,0 +1,2 @@
+alternate-data-invalid.json: In alternate 'Alt':
+alternate-data-invalid.json:2: 'data' must be an object
diff --git a/tests/qapi-schema/alternate-data-invalid.json
b/tests/qapi-schema/alternate-data-invalid.json
new file mode 100644
index 0000000000..7d5d905581
--- /dev/null
+++ b/tests/qapi-schema/alternate-data-invalid.json
@@ -0,0 +1,4 @@
+# Alternate type requires an object for 'data'
+{ 'alternate': 'Alt',
+ 'data': ['rubbish', 'nonsense']
+}
diff --git a/tests/qapi-schema/alternate-data-invalid.out
b/tests/qapi-schema/alternate-data-invalid.out
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/tests/qapi-schema/meson.build b/tests/qapi-schema/meson.build
index 8ba6917132..d7163e6601 100644
--- a/tests/qapi-schema/meson.build
+++ b/tests/qapi-schema/meson.build
@@ -14,6 +14,7 @@ schemas = [
'alternate-conflict-string.json',
'alternate-conflict-bool-string.json',
'alternate-conflict-num-string.json',
+ 'alternate-data-invalid.json',
'alternate-empty.json',
'alternate-invalid-dict.json',
'alternate-nested.json',
@@ -192,6 +193,7 @@ schemas = [
'union-clash-branches.json',
'union-empty.json',
'union-invalid-base.json',
+ 'union-invalid-data.json',
'union-optional-branch.json',
'union-unknown.json',
'unknown-escape.json',
diff --git a/tests/qapi-schema/union-invalid-data.err
b/tests/qapi-schema/union-invalid-data.err
new file mode 100644
index 0000000000..e26cf769a3
--- /dev/null
+++ b/tests/qapi-schema/union-invalid-data.err
@@ -0,0 +1,2 @@
+union-invalid-data.json: In union 'TestUnion':
+union-invalid-data.json:2: 'data' must be an object
diff --git a/tests/qapi-schema/union-invalid-data.json
b/tests/qapi-schema/union-invalid-data.json
new file mode 100644
index 0000000000..395ba24d39
--- /dev/null
+++ b/tests/qapi-schema/union-invalid-data.json
@@ -0,0 +1,6 @@
+# the union data type must be an object.
+{ 'union': 'TestUnion',
+ 'base': 'int',
+ 'discriminator': 'int',
+ 'data': ['rubbish', 'nonsense']
+}
diff --git a/tests/qapi-schema/union-invalid-data.out
b/tests/qapi-schema/union-invalid-data.out
new file mode 100644
index 0000000000..e69de29bb2
--
2.26.3
- [PULL 01/25] qapi/expr: Comment cleanup, (continued)
- [PULL 01/25] qapi/expr: Comment cleanup, Markus Armbruster, 2021/04/30
- [PULL 16/25] qapi/expr.py: Use tuples instead of lists for static data, Markus Armbruster, 2021/04/30
- [PULL 05/25] qapi/expr.py: Add assertion for union type 'check_dict', Markus Armbruster, 2021/04/30
- [PULL 25/25] qapi/error.py: enable mypy checks, Markus Armbruster, 2021/04/30
- [PULL 19/25] qapi/error: Use Python3-style super(), Markus Armbruster, 2021/04/30
- [PULL 23/25] qapi/error.py: enable pylint checks, Markus Armbruster, 2021/04/30
- [PULL 20/25] qapi/error: Make QAPISourceError 'col' parameter optional, Markus Armbruster, 2021/04/30
- [PULL 22/25] qapi/error.py: move QAPIParseError to parser.py, Markus Armbruster, 2021/04/30
- [PULL 24/25] qapi/error: Add type hints, Markus Armbruster, 2021/04/30
- [PULL 02/25] qapi/expr.py: Remove 'info' argument from nested check_if_str, Markus Armbruster, 2021/04/30
- [PULL 07/25] qapi/expr.py: Check type of union and alternate 'data' member,
Markus Armbruster <=
- [PULL 15/25] qapi/expr.py: Add docstrings, Markus Armbruster, 2021/04/30
- [PULL 17/25] qapi/expr: Update authorship and copyright information, Markus Armbruster, 2021/04/30
- [PULL 21/25] qapi/error: assert QAPISourceInfo is not None, Markus Armbruster, 2021/04/30
- [PULL 18/25] qapi/error: Repurpose QAPIError as an abstract base exception class, Markus Armbruster, 2021/04/30
- Re: [PULL 00/25] QAPI patches patches for 2021-04-30, Peter Maydell, 2021/04/30