mongo/buildscripts/idl/tests/test_parser.py

1099 lines
30 KiB
Python

#!/usr/bin/env python2
# Copyright (C) 2017 MongoDB Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License, version 3,
# as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
"""Test cases for IDL parser."""
# pylint: disable=too-many-lines
from __future__ import absolute_import, print_function, unicode_literals
import textwrap
import unittest
# import package so that it works regardless of whether we run as a module or file
if __package__ is None:
import sys
from os import path
sys.path.append(path.dirname(path.abspath(__file__)))
from context import idl
import testcase
else:
from .context import idl
from . import testcase
class TestParser(testcase.IDLTestcase):
# pylint: disable=too-many-public-methods
"""Test the IDL parser only."""
def test_empty(self):
# type: () -> None
"""Test an empty document works."""
self.assert_parse("")
def test_root_negative(self):
# type: () -> None
"""Test unknown root scalar fails."""
self.assert_parse_fail(
textwrap.dedent("""
fake:
cpp_namespace: 'foo'
"""), idl.errors.ERROR_ID_UNKNOWN_ROOT)
def test_global_positive(self):
# type: () -> None
"""Postive global tests."""
# cpp_namespace alone
self.assert_parse(textwrap.dedent("""
global:
cpp_namespace: 'foo'"""))
# cpp_includes scalar
self.assert_parse(textwrap.dedent("""
global:
cpp_includes: 'foo'"""))
# cpp_includes list
self.assert_parse(
textwrap.dedent("""
global:
cpp_includes:
- 'bar'
- 'foo'"""))
def test_global_negative(self):
# type: () -> None
"""Negative global tests."""
# Global is a scalar
self.assert_parse_fail(
textwrap.dedent("""
global: foo
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# Duplicate globals
self.assert_parse_fail(
textwrap.dedent("""
global:
cpp_namespace: 'foo'
global:
cpp_namespace: 'bar'
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
# Duplicate cpp_namespace
self.assert_parse_fail(
textwrap.dedent("""
global:
cpp_namespace: 'foo'
cpp_namespace: 'foo'"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
# Duplicate cpp_includes
self.assert_parse_fail(
textwrap.dedent("""
global:
cpp_includes: 'foo'
cpp_includes: 'foo'"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
# cpp_namespace as a sequence
self.assert_parse_fail(
textwrap.dedent("""
global:
cpp_namespace:
- 'foo'
- 'bar'"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# cpp_namespace as a map
self.assert_parse_fail(
textwrap.dedent("""
global:
cpp_namespace:
name: 'foo'"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# cpp_includes as a map
self.assert_parse_fail(
textwrap.dedent("""
global:
cpp_includes:
inc1: 'foo'"""), idl.errors.ERROR_ID_IS_NODE_TYPE_SCALAR_OR_SEQUENCE)
# cpp_includes as a sequence of tuples
self.assert_parse_fail(
textwrap.dedent("""
global:
cpp_includes:
- inc1: 'foo'"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# Unknown scalar
self.assert_parse_fail(
textwrap.dedent("""
global:
bar: 'foo'
"""), idl.errors.ERROR_ID_UNKNOWN_NODE)
def test_type_positive(self):
# type: () -> None
"""Positive type test cases."""
# Test all positive fields works
self.assert_parse(
textwrap.dedent("""
types:
foo:
description: foo
cpp_type: foo
bson_serialization_type: foo
serializer: foo
deserializer: foo
default: foo
bindata_subtype: foo
"""))
# Test sequence of bson serialization types
self.assert_parse(
textwrap.dedent("""
types:
foo:
description: foo
cpp_type: foo
bson_serialization_type:
- foo
- bar
"""))
def test_type_negative(self):
# type: () -> None
"""Negative type test cases."""
# Test duplicate types
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
description: test
cpp_type: foo
bson_serialization_type: int
types:
bar:
description: test
cpp_type: foo
bson_serialization_type: int
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
# Test scalar fails
self.assert_parse_fail(
textwrap.dedent("""
types:
foo: 'bar'"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# Test unknown field
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
bogus: foo
description: test
cpp_type: foo
bson_serialization_type:
"""), idl.errors.ERROR_ID_UNKNOWN_NODE)
# test duplicate field
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
description: foo
description: test
cpp_type: foo
bson_serialization_type:
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
# test list instead of scalar
self.assert_parse_fail(
textwrap.dedent("""
types:
- foo:
"""), idl.errors.ERROR_ID_IS_NODE_TYPE, multiple=True)
# test list instead of scalar
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
- bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE, multiple=True)
# test map instead of scalar
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
description:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE, multiple=True)
# test missing bson_serialization_type field
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
description: foo
cpp_type: foo
"""), idl.errors.ERROR_ID_MISSING_REQUIRED_FIELD)
# test missing cpp_type field
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
description: foo
bson_serialization_type: foo
"""), idl.errors.ERROR_ID_MISSING_REQUIRED_FIELD)
def test_struct_positive(self):
# type: () -> None
"""Positive struct test cases."""
# All fields with true for bools
self.assert_parse(
textwrap.dedent("""
structs:
foo:
description: foo
strict: true
immutable: true
inline_chained_structs: true
generate_comparison_operators: true
fields:
foo: bar
"""))
# All fields with false for bools
self.assert_parse(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
immutable: false
inline_chained_structs: false
generate_comparison_operators: false
fields:
foo: bar
"""))
def test_struct_negative(self):
# type: () -> None
"""Negative struct test cases."""
# Struct as a scalar
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo: foo
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# Missing fields
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
strict: true
"""), idl.errors.ERROR_ID_EMPTY_FIELDS)
# unknown field
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
foo: bar
fields:
foo: bar
"""), idl.errors.ERROR_ID_UNKNOWN_NODE)
# strict is a bool
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
strict: bar
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# immutable is a bool
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
immutable: bar
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# inline_chained_structs is a bool
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
inline_chained_structs: bar
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# generate_comparison_operators is a bool
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
generate_comparison_operators: bar
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# cpp_name is not allowed
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
cpp_name: bar
fields:
foo: bar
"""), idl.errors.ERROR_ID_UNKNOWN_NODE)
def test_field_positive(self):
# type: () -> None
"""Positive field test cases."""
# Test short types
self.assert_parse(
textwrap.dedent("""
structs:
foo:
description: foo
fields:
foo: short
"""))
# Test all fields
self.assert_parse(
textwrap.dedent("""
structs:
foo:
description: foo
fields:
foo:
type: foo
description: foo
optional: true
ignore: true
cpp_name: bar
comparison_order: 3
"""))
# Test false bools
self.assert_parse(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
fields:
foo:
type: string
optional: false
ignore: false
"""))
def test_field_negative(self):
# type: () -> None
"""Negative field test cases."""
# Test duplicate fields
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
fields:
foo: short
foo: int
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
# Test bad bool
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
fields:
foo:
type: string
optional: bar
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# Test bad bool
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
fields:
foo:
type: string
ignore: bar
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# Test bad int scalar
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
fields:
foo:
type: string
comparison_order:
- a
- b
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# Test bad int
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
fields:
foo:
type: string
comparison_order: 3.14159
"""), idl.errors.ERROR_ID_IS_NODE_VALID_INT)
# Test bad negative int
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo:
description: foo
strict: false
fields:
foo:
type: string
comparison_order: -1
"""), idl.errors.ERROR_ID_IS_NODE_VALID_NON_NEGATIVE_INT)
def test_name_collisions_negative(self):
# type: () -> None
"""Negative tests for type collisions."""
# Struct after type
self.assert_parse_fail(
textwrap.dedent("""
types:
foo1:
description: foo
cpp_type: foo
bson_serialization_type: string
serializer: foo
deserializer: foo
default: foo
structs:
foo1:
description: foo
strict: true
fields:
foo: string
"""), idl.errors.ERROR_ID_DUPLICATE_SYMBOL)
# Type after struct
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo1:
description: foo
strict: true
fields:
foo: string
types:
foo1:
description: foo
cpp_type: foo
bson_serialization_type: string
serializer: foo
deserializer: foo
default: foo
"""), idl.errors.ERROR_ID_DUPLICATE_SYMBOL)
def test_chained_type_positive(self):
# type: () -> None
"""Positive parser chaining test cases."""
self.assert_parse(
textwrap.dedent("""
structs:
foo1:
description: foo
chained_types:
foo1: alias
foo2: alias
"""))
def test_chained_type_negative(self):
# type: () -> None
"""Negative parser chaining test cases."""
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo1:
description: foo
chained_types: foo1
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo1:
description: foo
chained_types:
- foo1
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# Duplicate chained types
self.assert_parse_fail(
textwrap.dedent("""
structs:
bar1:
description: foo
strict: false
chained_types:
foo1: alias
foo1: alias
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
def test_chained_struct_positive(self):
# type: () -> None
"""Positive parser chaining test cases."""
self.assert_parse(
textwrap.dedent("""
structs:
foo1:
description: foo
chained_structs:
foo1: foo1_cpp
foo2: foo2_cpp
"""))
def test_chained_struct_negative(self):
# type: () -> None
"""Negative parser chaining test cases."""
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo1:
description: foo
chained_structs: foo1
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
self.assert_parse_fail(
textwrap.dedent("""
structs:
foo1:
description: foo
chained_structs:
- foo1
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# Duplicate chained structs
self.assert_parse_fail(
textwrap.dedent("""
structs:
bar1:
description: foo
strict: true
chained_structs:
chained: alias
chained: alias
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
def test_enum_positive(self):
# type: () -> None
"""Positive enum test cases."""
# Test all positive fields works
self.assert_parse(
textwrap.dedent("""
enums:
foo:
description: foo
type: foo
values:
v1: 0
"""))
def test_enum_negative(self):
# type: () -> None
"""Negative enum test cases."""
# Test duplicate enums
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
description: test
type: int
values:
v1: 0
foo:
description: test
type: int
values:
v1: 0
"""), idl.errors.ERROR_ID_DUPLICATE_SYMBOL)
# Test scalar fails
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo: 'bar'"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# Test unknown field
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
bogus: foo
description: foo
type: foo
values:
v1: 0
"""), idl.errors.ERROR_ID_UNKNOWN_NODE)
# test duplicate field
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
description: foo
description: test
type: foo
values:
v1: 0
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
# test list instead of scalar
self.assert_parse_fail(
textwrap.dedent("""
enums:
- foo:
"""), idl.errors.ERROR_ID_IS_NODE_TYPE, multiple=True)
# test list instead of scalar
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
- bar
"""), idl.errors.ERROR_ID_IS_NODE_TYPE, multiple=True)
# test missing type field
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
description: foo
values:
v1: 0
"""), idl.errors.ERROR_ID_MISSING_REQUIRED_FIELD)
# test missing values field
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
description: foo
type: foo
"""), idl.errors.ERROR_ID_BAD_EMPTY_ENUM)
# Test no values
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
description: foo
type: int
"""), idl.errors.ERROR_ID_BAD_EMPTY_ENUM)
# Name collision with types
self.assert_parse_fail(
textwrap.dedent("""
types:
foo:
description: foo
cpp_type: foo
bson_serialization_type: string
serializer: foo
deserializer: foo
default: foo
enums:
foo:
description: foo
type: foo
values:
v1: 0
"""), idl.errors.ERROR_ID_DUPLICATE_SYMBOL)
# Name collision with structs
self.assert_parse_fail(
textwrap.dedent("""
types:
string:
description: foo
cpp_type: foo
bson_serialization_type: string
serializer: foo
deserializer: foo
default: foo
structs:
foo:
description: foo
strict: true
fields:
foo: string
enums:
foo:
description: foo
type: foo
values:
v1: 0
"""), idl.errors.ERROR_ID_DUPLICATE_SYMBOL)
# Test int - duplicate names
self.assert_parse_fail(
textwrap.dedent("""
enums:
foo:
description: foo
type: int
values:
v1: 0
v1: 1
"""), idl.errors.ERROR_ID_DUPLICATE_NODE)
def test_command_positive(self):
# type: () -> None
"""Positive command test cases."""
# All fields with true for bools
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
strict: true
namespace: ignored
immutable: true
inline_chained_structs: true
generate_comparison_operators: true
cpp_name: foo
fields:
foo: bar
"""))
# All fields with false for bools
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
strict: false
namespace: ignored
immutable: false
inline_chained_structs: false
generate_comparison_operators: false
fields:
foo: bar
"""))
# Namespace ignored
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
namespace: ignored
fields:
foo: bar
"""))
# Namespace concatenate_with_db
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
namespace: concatenate_with_db
fields:
foo: bar
"""))
# No fields
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
namespace: ignored
strict: true
"""))
def test_command_negative(self):
# type: () -> None
"""Negative command test cases."""
# Command as a scalar
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo: foo
"""), idl.errors.ERROR_ID_IS_NODE_TYPE)
# unknown field
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
namespace: ignored
foo: bar
fields:
foo: bar
"""), idl.errors.ERROR_ID_UNKNOWN_NODE)
# strict is a bool
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
strict: bar
namespace: ignored
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
# Namespace is required
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
fields:
foo: bar
"""), idl.errors.ERROR_ID_MISSING_REQUIRED_FIELD)
# Namespace is wrong
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
namespace: foo
fields:
foo: bar
"""), idl.errors.ERROR_ID_BAD_COMMAND_NAMESPACE)
# Setup some common types
test_preamble = textwrap.dedent("""
types:
string:
description: foo
cpp_type: foo
bson_serialization_type: string
serializer: foo
deserializer: foo
default: foo
""")
# Commands and structs with same name
self.assert_parse_fail(test_preamble + textwrap.dedent("""
commands:
foo:
description: foo
namespace: ignored
fields:
foo: string
structs:
foo:
description: foo
fields:
foo: foo
"""), idl.errors.ERROR_ID_DUPLICATE_SYMBOL)
# Commands and types with same name
self.assert_parse_fail(test_preamble + textwrap.dedent("""
commands:
string:
description: foo
namespace: ignored
strict: true
fields:
foo: string
"""), idl.errors.ERROR_ID_DUPLICATE_SYMBOL)
# Namespace concatenate_with_db
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
namespace: concatenate_with_db
type: foobar
fields:
foo: bar
"""), idl.errors.ERROR_ID_IS_COMMAND_TYPE_EXTRANEOUS)
def test_command_doc_sequence_positive(self):
# type: () -> None
"""Positive supports_doc_sequence test cases."""
# pylint: disable=invalid-name
# supports_doc_sequence can be false
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
namespace: ignored
fields:
foo:
type: bar
supports_doc_sequence: false
"""))
# supports_doc_sequence can be true
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
namespace: ignored
fields:
foo:
type: bar
supports_doc_sequence: true
"""))
def test_command_doc_sequence_negative(self):
# type: () -> None
"""Negative supports_doc_sequence test cases."""
# pylint: disable=invalid-name
# supports_doc_sequence must be a bool
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
namespace: ignored
fields:
foo:
type: bar
supports_doc_sequence: foo
"""), idl.errors.ERROR_ID_IS_NODE_VALID_BOOL)
def test_command_type_positive(self):
# type: () -> None
"""Positive command custom type test cases."""
# string
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
strict: true
namespace: type
type: string
fields:
foo: bar
"""))
# array of string
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
strict: true
namespace: type
type: array<string>
fields:
foo: bar
"""))
# no fields
self.assert_parse(
textwrap.dedent("""
commands:
foo:
description: foo
strict: true
namespace: type
type: string
"""))
def test_command_type_negative(self):
# type: () -> None
"""Negative command type test cases."""
# supports_doc_sequence must be a bool
self.assert_parse_fail(
textwrap.dedent("""
commands:
foo:
description: foo
namespace: type
fields:
foo: bar
"""), idl.errors.ERROR_ID_MISSING_REQUIRED_FIELD)
if __name__ == '__main__':
unittest.main()