eclipse-iceoryx / eclipse-iceoryx/iceoryx
Automatic tests for API stability
- Dominant language
- C++
- Stars
- 2.2k
- Forks
- 492
- Avg merge
- 18h 57m
- Merged PRs (30d)
- 1
Description
How do we verify the API stability since it is not tested at all at the moment. One approach would be to write a simple cpp file which uses every function and method available in the public API. If the file does not compile we have an API change and with the git history of the file we even know first hand how the user code which uses iceoryx has to be adapted.
If we have proven the stability of the API we can prove the ABI stability with a setup of three applications: sender, receiver and roudi. Each of the applications is using iceoryx as a shared library once with the newest and once with the oldest minor version. Then we run a mixed setup and everything should work fine.
_Originally posted by @elfenpiff in https://github.com/eclipse-iceoryx/iceoryx/pull/918#discussion_r700942141_
Contributor guide
Research direction
Start by defining the public API surface that the proposed simple C++ compatibility file must exercise; the issue names no existing files or tests. Then investigate how iceoryx builds shared libraries and how sender, receiver, and RouDi applications can run against newest and oldest minor versions. Done means automated API and mixed-version ABI checks are established.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- backend-api-design, testing-qa
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100