Skip to content

Commit 1b24ba9

Browse files
committed
Fix inclusion of new test scripts section
Signed-off-by: Pierre R. Mai <pmai@pmsf.de>
1 parent 9a1b2f6 commit 1b24ba9

1 file changed

Lines changed: 15 additions & 16 deletions

File tree

content/contributing/test_scripts.adoc

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,69 +2,68 @@ ifndef::include-only-once[]
22
:root-path: ../
33
include::{root-path}_config.adoc[]
44
endif::[]
5-
6-
# Test scripts
5+
= Test scripts
76

87
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.
98
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.
109
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.
1110
Through these automated tests, the project aims to maintain high quality in coding and documentation standards, facilitating a more reliable and efficient development process.
1211

13-
## `\\__init__.py`
12+
== `\\__init__.py`
1413

1514
This script indicates the use of the directory as a Python Package, allowing Python to consider the directory as part of a module.
1615

17-
## `test_comment_type.py`
16+
== `test_comment_type.py`
1817

1918
Automates the administration of comment standards.
2019
It locates all `.proto` files using the glob module and includes different test cases inherited from `unittest.TestCase`.
2120
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.
2221

23-
## `test_doxygen_output.py`
22+
== `test_doxygen_output.py`
2423

2524
Validates the output of Doxygen documentation files to ensure the absence of errors or issues in documentation syntax or Doxygen's interpretation of comments.
2625
It checks for hash characters `(#)`, slash triplets `(///)`, and backslash triplets `(\\\)` that might indicate documentation errors, maintaining the quality of Doxygen-generated HTML documentation.
2726

28-
## `test_invalid_comment.py`
27+
== `test_invalid_comment.py`
2928

3029
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.
3130

32-
## `test_invalid_enum.py`
31+
== `test_invalid_enum.py`
3332

3433
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.
3534

36-
## `test_invalid_html.py`
35+
== `test_invalid_html.py`
3736

3837
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.
3938

40-
## `test_invalid_message.py`
39+
== `test_invalid_message.py`
4140

4241
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.
4342

44-
## `test_invalid_punctuation.py`
43+
== `test_invalid_punctuation.py`
4544

4645
Aims to ensure the absence of double underscores `(__)` in `.proto` files, indicating a formatting error when such punctuation is found.
4746

48-
## `test_invalid_tabs.py`
47+
== `test_invalid_tabs.py`
4948

5049
Prohibits the use of tab characters for indentation or alignment in `.proto` files, considering their use a formatting error.
5150

52-
## `test_newline.py`
51+
== `test_newline.py`
5352

5453
Ensures that all Protocol Buffer `(.proto)` files end with a newline character `(\n)`, maintaining code quality and interoperability across different environments.
5554

56-
## `test_non_ascii.py`
55+
== `test_non_ascii.py`
5756

5857
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.
5958

60-
## `test_osi_trace.py`
59+
== `test_osi_trace.py`
6160

6261
Serves as a unit test for the `OSITrace` class, ensuring correct processing of OSI SensorView messages and their conversion into a human-readable format.
6362

64-
## `test_rules.py`
63+
== `test_rules.py`
6564

6665
Ensures compliance with specific rules for Protocol Buffer `(.proto)` files as defined in a YAML configuration file `(rules.yml)`, checking for rule violations and providing feedback for corrections.
6766

68-
## `test_units.py`
67+
== `test_units.py`
6968

7069
Validates the syntax of unit documentation within Protocol Buffer (.proto) files, ensuring that units are documented correctly according to the specified syntax without any enclosing brackets or braces.

0 commit comments

Comments
 (0)