[ovsp4rt] Implement Client class (work in progress) #674
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Implemented the `Context` class, to provide an abstract interface to the P4Runtime server. - Modified ovsp4rt.cc to use the `Context` object instead of the `OvsP4rtSession` object. In addition to simplifying the code, the `Context` object should allow us to mock the P4Runtime server for unit testing. Signed-off-by: Derek Foster <[email protected]>
ffoulkes
added
tests
- Made each public C API function a wrapper around a C++ function that accepts the Context object and one of its parameters. This makes it possible to inject a test double. Signed-off-by: Derek Foster <[email protected]>
Signed-off-by: Derek Foster <[email protected]>
Signed-off-by: Derek Foster <[email protected]>
Signed-off-by: Derek Foster <[email protected]>
Signed-off-by: Derek Foster <[email protected]>
ffoulkes
changed the title
- Converted most of the GetEntry functions to HaveEntry predicates, to stress the difference between testing for the existence of an entry and retrieving its contents. Signed-off-by: Derek Foster <[email protected]>
Signed-off-by: Derek Foster <[email protected]>
- Defined a virtual destructor. - Made the methods virtual. - Added internal documentation. Signed-off-by: Derek Foster <[email protected]>
Signed-off-by: Derek Foster <[email protected]>
ffoulkes
changed the title
Signed-off-by: Derek Foster <[email protected]>
- Enabled the BUILD_CLIENT cmake option in the development branch. Signed-off-by: Derek Foster <[email protected]>
- Added missing include directory and link libraries when building ovsp4rt_client object library. Signed-off-by: Derek Foster <[email protected]>
- Fixed compile errors when building the Client library. - Fixed link errors when building ovsp4rt with the Client and Journal libraries. - Removed the session() method from the Client class. Signed-off-by: Derek Foster <[email protected]>
- Changed `client` parameter type from `Client` to `ClientInterface`, to support dependency injection. Signed-off-by: Derek Foster <[email protected]>
- Moved the C API wrapper functions to a separate source file, to allow a substitute front end to be used for testing. Signed-off-by: Derek Foster <[email protected]>
Signed-off-by: Derek Foster <[email protected]>
- Created JournalClient, a subclass of Client that is instrumented to record interactions between OVS and the P4Runtime server. - Created a variant of the public API that uses JournalClient objects. Signed-off-by: Derek Foster <[email protected]>
- Renamed ovsp4rt_c_api.cc to ovsp4rt_standard_api.cc and ovsp4rt_cc_api.h to ovsp4rt_internal_api.h, to make their purpose clearer. Signed-off-by: Derek Foster <[email protected]>
- Noted instances where we ignore errors without explanation. Signed-off-by: Derek Foster <[email protected]>
ffoulkes
added a commit
that referenced
this pull request
Dec 26, 2024
- Moved the C API wrapper functions to a separate source file. This makes it possible to substitute a different implementation of the API, for testing. Extracted from PR #674. Works with an updated version of ovsp4rt.cc that has not been committed. Currently excluded from the build. Signed-off-by: Derek Foster <[email protected]>
This was referenced Dec 26, 2024
ffoulkes
added a commit
that referenced
this pull request
Dec 26, 2024
- Created a variant of the public API that uses JournalClient objects. Extracted from PR #674. Works with several files that have not yet been committed, or that are being committed separately. Currently excluded from the build. Signed-off-by: Derek Foster <[email protected]>
- Restored the original names of the GetEntry functions, and reimplemented the HavEntry predicates as wrappers around the GetEntry functions. Signed-off-by: Derek Foster <[email protected]>
- Added methods to the Journal class to record P4Runtime server requests and responses. Signed-off-by: Derek Foster <[email protected]>
Signed-off-by: Derek Foster <[email protected]>
Signed-off-by: Derek Foster <[email protected]>
ffoulkes
added a commit
that referenced
this pull request
Jan 1, 2025
- Moved the C API wrapper functions to a separate source file. This makes it possible to substitute a different implementation of the API, for testing. Extracted from PR #674. Works with an updated version of ovsp4rt.cc that has not been committed. Currently excluded from the build. Signed-off-by: Derek Foster <[email protected]>
ffoulkes
added a commit
that referenced
this pull request
Jan 1, 2025
- Created a variant of the public API that uses JournalClient objects. Extracted from PR #674. Works with several files that have not yet been committed, or that are being committed separately. Currently excluded from the build. Signed-off-by: Derek Foster <[email protected]>
Signed-off-by: Derek Foster <[email protected]>
Signed-off-by: Derek Foster <[email protected]>
Signed-off-by: Derek Foster <[email protected]>
Signed-off-by: Derek Foster <[email protected]>
|
Superseded by PR #727. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Superseded by PR #727. Retaining this PR for reference.
This is a project to improve the testability of ovsp4rt. See issue #701 for details.
Modified ovsp4rt.cc to use a
Clientobject instead of anOvsP4rtSessionobject to communicate with the P4Runtime server.Made each public C API function a wrapper around a C++ function that accepts a Client object as a parameter. This allows a unit test to replace the object with a test double (e.g. a mock).
Moved the C API functions to another file, separating the user interface from the implementation. This allows a substitute front end to be used for testing.
Implemented
HaveEntrypredicates as wrappers around theGetEntryfunctions. Modified the code to use the predicates when the purpose of the read request is to test for the existence of an entry.Note
The
BUILD_CLIENTcmake option is enabled by default in this branch. We cannot compile the modified version ofovsp4rt.ccwithout it.