[DRAFT] API: implement APIs from the new specification #296
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
* Implement some of the new APIs described in [1] and add some functions that were intended for internal use to the public header files. * Implement/change unit tests related to the changes. * Introduce some unit tests written in C using the cmocka framework. The idea is to make it easier to catch runtime problems like memory errors. One can just build the tests with -fsanitize=address or run them with valgrind to check for problems. The new files will not be compiled by default, the new option -Dunit_testing=true must be used during the meson setup step. * Integrate the new tests with the meson build configuration. * Add a .gcovr file to exclude the new tests from the coverage test. It a future commit we might just move the new tests directory to another place. [1] - https://discourse.ubuntu.com/t/spec-api-and-bindings-definition-for-libnetplan/29106
Add back two symbols removed in previous commit as aliases to avoid changes in the ABI.
* generate.c: free the options context allocated at the start of the main
function.
* openvswitch.c: make sure the GString "cmds" is free'd before the
function returns.
* parse.c: free the temporary list "values" before the function
returns.
* types.c: in this particular case we g_strdup both key and value
strings when inserting them in the hash table in
parse.c:handle_generic_map(). Calling the destructor for both of
them will make sure all the memory is free'd. When using
free_hashtable_with_destructor in the future we'll need to make
sure both key and value are not poiting to the same place to avoid
a double free.
* parse.c: parsed_defs is set to NULL preventing
netplan_parser_reset() to free the memory allocated for the
hash table. Not setting it to NULL is safe because all the data is moved to
another hash table, leaving parsed_defs with no elements. Not
nullifying parsed_defs here allows netplan_parser_reset() to free
it.
Definitions used by other public header files were
moved to a new types.h file. The new file was included where it's needed
and it shouldn't break external consumers.
Also:
* Add new netplan_error functions with tests
* Enable cmocka unittests during coverage test
Add the new header file to the meson install list. Move the new members in the struct netplan_net_definition to the end of the struct to avoid breaking the ABI.
|
I will close this PR in favor of a clean one. |
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.
[1] - https://discourse.ubuntu.com/t/spec-api-and-bindings-definition-for-libnetplan/29106
Description
It's a work in progress, some APIs were not implemented yet.
Checklist
make checksuccessfully.make check-coverage).