mirror of https://github.com/mongodb/mongo
117 lines
4.0 KiB
Python
Executable File
117 lines
4.0 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
#
|
|
# Copyright (C) 2024-present MongoDB, Inc.
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the Server Side Public License, version 1,
|
|
# as published by MongoDB, Inc.
|
|
#
|
|
# 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
|
|
# Server Side Public License for more details.
|
|
#
|
|
# You should have received a copy of the Server Side Public License
|
|
# along with this program. If not, see
|
|
# <http://www.mongodb.com/licensing/server-side-public-license>.
|
|
#
|
|
# As a special exception, the copyright holders give permission to link the
|
|
# code of portions of this program with the OpenSSL library under certain
|
|
# conditions as described in each individual source file and distribute
|
|
# linked combinations including the program with the OpenSSL library. You
|
|
# must comply with the Server Side Public License in all respects for
|
|
# all of the code used other than as permitted herein. If you modify file(s)
|
|
# with this exception, you may extend this exception to your version of the
|
|
# file(s), but you are not obligated to do so. If you do not wish to do so,
|
|
# delete this exception statement from your version. If you delete this
|
|
# exception statement from all source files in the program, then also delete
|
|
# it in the license file.
|
|
#
|
|
"""
|
|
Test cases for IDL Schema validation.
|
|
|
|
This file exists to verify that all of the IDL files validates against the IDL Schema.
|
|
"""
|
|
|
|
import os
|
|
import unittest
|
|
|
|
import yaml
|
|
from jsonschema import SchemaError, ValidationError, validate
|
|
|
|
# import package so that it works regardless of whether we run as a module or file
|
|
if __package__ is None:
|
|
import sys
|
|
|
|
sys.path.append(os.path.dirname(os.path.abspath(__file__)))
|
|
import testcase
|
|
else:
|
|
from . import testcase
|
|
|
|
|
|
class TestJSONSchema(testcase.IDLTestcase):
|
|
"""Test the IDL Generator."""
|
|
|
|
@property
|
|
def _base_dir(self):
|
|
"""Get the path to the project folder."""
|
|
base_dir = os.path.dirname(
|
|
os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
|
)
|
|
return base_dir
|
|
|
|
@property
|
|
def _src_dir(self):
|
|
"""Get the path to the src folder."""
|
|
return os.path.join(
|
|
self._base_dir,
|
|
"src",
|
|
)
|
|
|
|
@property
|
|
def _idl_src_dir(self):
|
|
"""Get the path to the src/mongo/idl folder."""
|
|
return os.path.join(self._src_dir, "mongo", "idl")
|
|
|
|
@property
|
|
def _idl_buildscripts_dir(self):
|
|
"""Get the path to the buildscripts/idl folder."""
|
|
return os.path.join(self._base_dir, "buildscripts", "idl")
|
|
|
|
def load_yaml_file(self, file_path):
|
|
with open(file_path, "r", encoding="utf8") as f:
|
|
return yaml.safe_load(f)
|
|
|
|
def validate_yaml_file(self, file_path, schema):
|
|
"""Validate a JSON file against a given schema."""
|
|
try:
|
|
data = self.load_yaml_file(file_path)
|
|
validate(instance=data, schema=schema)
|
|
except (ValidationError, SchemaError) as e:
|
|
print(f"{file_path}: Validation error - {e.message}")
|
|
return False
|
|
except Exception as e:
|
|
print(f"{file_path}: Unexpected error - {e}")
|
|
raise
|
|
return True
|
|
|
|
def test_validate_all_idl_files(self):
|
|
"""Validate all .idl files in a directory against a given schema."""
|
|
idl_schema = self.load_yaml_file(os.path.join(self._idl_buildscripts_dir, "idl_schema.yml"))
|
|
|
|
# We assert on this boolean after all the tests are checked.
|
|
success = True
|
|
|
|
for root, _, files in os.walk(self._base_dir):
|
|
for file in files:
|
|
if file.endswith(".idl"):
|
|
abs_file_path = os.path.join(root, file)
|
|
success = success and self.validate_yaml_file(abs_file_path, idl_schema)
|
|
|
|
if not success:
|
|
self.fail("JSON Schema validation failed for at least one file")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|