-
Notifications
You must be signed in to change notification settings - Fork 73
Automated tests should be cleaned up / documented #454
Copy link
Copy link
Open
Description
The organization in the tests folder could be cleaned up / renamed for better organization. In my opinion, it is not obvious what tests are run during a build. Posting here for comment by anyone who has historical knowledge on the creation of these tests. (Note that this issue is not intended to discuss any expansion of tests -- I am mainly focusing on current organization/structure)
This is my understanding:
tests/AutoTests- Executed during the
Run CI Testsstep of thebuild_release_artifacts.ymlworkflow- Called using the
run_testfunction oftests/run_tests.py
- Called using the
- Mainly tests that the examples are functional, but also does some functional tests of abort, cancellation, and service not defined tests.
- Does not use the generation tool at all -- relies on pre-generated code, either in the
examplesfolder or in thetests/AutoTestsfolder.
- Executed during the
tests/CMakeTests- Executed during build of the DLL/shared library, called from
CMakeLists.txt - Tests that exported DLL functions match a known signature
- Executed during build of the DLL/shared library, called from
tests/Deprecated- Not used. Was deprecated when the
New_ATSwas used. - Could be deleted.
- Not used. Was deprecated when the
tests/New_ATS- Executed during the
Run New Testing Suite's Testsstep of thebuild_release_artifacts.ymlworkflow- Called using the
tests/New_ATS/pylib/run_tests.pyfile
- Called using the
- Mainly tests overall server generation and functionality using Python-based gRPC clients.
- Documented in
tests/New_ATS/README.md
- Executed during the
tests/gRPC_ATS- Not used? This seems like another deprecated ATS.
- Could be called using the
run_all_testsfunction oftests/run_tests.py, but nothing calls this. - Only mentioned in
docs/Testing.md - Could be deleted? (Does this ATS provide any additional functionality that the
New ATSdoesn't provide?)
For better documentation/maintainability, I feel that:
- Deprecated code/folders should be deleted (git history will keep them around if needed).
New_ATSshould be renamed toATS(or some name without "new") - I feel like this only leads down the road toNewest Newer New ATSduring a future revision 😀- If we have multiple "test suites" (like
AutoTestsandNew_ATS), each folder should have arun_tests.pyfile which executes their respective tests in that folder. To me, it's confusing that the top-leveltests/run_tests.pyonly runs theAutoTeststests and thattests/New_ATS/pylib/run_tests.pyexecutes theNew_ATStests.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels