4.4 Test scripts
The following collection of test scripts is designed to automate the validation and enforcement of coding standards, documentation quality, and specific syntactical conventions within a software development project. These scripts cover a broad spectrum of checks, from Python package initialization, adherence to comment standards, and validation of Doxygen documentation output, to ensuring the integrity of Protocol Buffer (.proto) files. Each script focuses on a specific aspect of the code or documentation, automating the process of identifying common errors, enforcing naming conventions, and ensuring that documentation is both accurate and adheres to defined standards. Through these automated tests, the project aims to maintain high quality in coding and documentation standards, facilitating a more reliable and efficient development process.
4.4.1. __init__.py
This script indicates the use of the directory as a Python Package, allowing Python to consider the directory as part of a module.
4.4.2. test_comment_type.py
Automates the administration of comment standards.
It locates all .proto files using the glob module and includes different test cases inherited from unittest.TestCase.
These test cases perform checks on the comment description’s brevity, length, and existence. Additionally, it includes a utility method convert for transforming camel case names into uppercase snake case, ensuring high documentation and coding standards in Protocol Buffer Files.
4.4.3. test_doxygen_output.py
Validates the output of Doxygen documentation files to ensure the absence of errors or issues in documentation syntax or Doxygen’s interpretation of comments.
It checks for hash characters (#), slash triplets (///), and backslash triplets (\\\) that might indicate documentation errors, maintaining the quality of Doxygen-generated HTML documentation.
4.4.4. test_invalid_comment.py
Ensures the integrity of comments within Protocol buffer files, checking for the use of more than two consecutive forward slashes (///) and block comment delimiters (/* and */), which are not supported in Protocol Buffers syntax.
4.4.5. test_invalid_enum.py
Checks .proto files for issues related to enum naming and usage, verifying that enum names follow a PascalCase naming convention and that enum types are in uppercase, ensuring adherence to naming conventions.
4.4.6. test_invalid_html.py
Validates the use of HTML and Doxygen-specific comment syntax within .proto files, checking for incorrect usage of slashes (/,\), hash (#) characters, @ symbols outside of htmlonly sections, and ensuring that every htmlonly section is properly closed.
4.4.7. test_invalid_message.py
Defines tests for common issues in .proto files, such as naming conventions and field definitions, ensuring that message names, field names, and nested message types adhere to specified naming conventions and that fields specify their multiplicity correctly.
4.4.8. test_invalid_punctuation.py
Aims to ensure the absence of double underscores (__) in .proto files, indicating a formatting error when such punctuation is found.
4.4.9. test_invalid_tabs.py
Prohibits the use of tab characters for indentation or alignment in .proto files, considering their use a formatting error.
4.4.10. test_newline.py
Ensures that all Protocol Buffer (.proto) files end with a newline character (\n), maintaining code quality and interoperability across different environments.
4.4.11. test_non_ascii.py
Ensures that Protocol Buffer (.proto) files do not contain non-ASCII characters, checking for the presence of special characters outside the ASCII set (eg. ä,ü,ö etc.) and failing the test if any are found.
4.4.12. test_osi_trace.py
Serves as a unit test for the OSITrace class, ensuring correct processing of OSI SensorView messages and their conversion into a human-readable format.