Add test coverage for rmw_init_options API. #385
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,239 @@ | ||
| // Copyright 2020 Open Source Robotics Foundation, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| #include "gtest/gtest.h" | ||
|
|
||
| #include "rcutils/allocator.h" | ||
| #include "rcutils/strdup.h" | ||
| #include "rmw/init_options.h" | ||
| #include "rmw/security_options.h" | ||
| #include "rmw/types.h" | ||
|
|
||
| #include "osrf_testing_tools_cpp/scope_exit.hpp" | ||
|
|
||
| #include "rmw_fastrtps_shared_cpp/rmw_init.hpp" | ||
|
|
||
| using rmw_fastrtps_shared_cpp::rmw_init_options_init; | ||
| using rmw_fastrtps_shared_cpp::rmw_init_options_copy; | ||
| using rmw_fastrtps_shared_cpp::rmw_init_options_fini; | ||
|
|
||
| TEST(RMWInitOptionsTest, init_w_invalid_args_fails) { | ||
| rcutils_allocator_t allocator = rcutils_get_default_allocator(); | ||
| // Cannot initialize a null options instance. | ||
| EXPECT_EQ( | ||
| RMW_RET_INVALID_ARGUMENT, | ||
| rmw_init_options_init("some_identifier", nullptr, allocator)); | ||
| rcutils_reset_error(); | ||
|
|
||
| rmw_init_options_t options = rmw_get_zero_initialized_init_options(); | ||
| rcutils_allocator_t invalid_allocator = rcutils_get_zero_initialized_allocator(); | ||
| // Cannot initialize using an invalid allocator. | ||
| EXPECT_EQ( | ||
| RMW_RET_INVALID_ARGUMENT, | ||
| rmw_init_options_init("some_identifier", &options, invalid_allocator)); | ||
| rcutils_reset_error(); | ||
| } | ||
|
|
||
|
|
||
| TEST(RMWInitOptionsTest, init_twice_fails) { | ||
| rmw_init_options_t options = rmw_get_zero_initialized_init_options(); | ||
| rcutils_allocator_t allocator = rcutils_get_default_allocator(); | ||
|
|
||
| ASSERT_EQ(RMW_RET_OK, rmw_init_options_init("some_identifier", &options, allocator)) << | ||
| rcutils_get_error_string().str; | ||
| OSRF_TESTING_TOOLS_CPP_SCOPE_EXIT( | ||
| { | ||
| rcutils_reset_error(); | ||
| EXPECT_EQ(RMW_RET_OK, rmw_init_options_fini("some_identifier", &options)) << | ||
| rcutils_get_error_string().str; | ||
| rcutils_reset_error(); | ||
| }); | ||
|
|
||
| EXPECT_EQ( | ||
| RMW_RET_INVALID_ARGUMENT, | ||
| rmw_init_options_init("some_identifier", &options, allocator)); | ||
| rcutils_reset_error(); | ||
| } | ||
|
|
||
|
|
||
| TEST(RMWInitOptionsTest, init) { | ||
| rmw_init_options_t options = rmw_get_zero_initialized_init_options(); | ||
| rcutils_allocator_t allocator = rcutils_get_default_allocator(); | ||
|
|
||
| ASSERT_EQ(RMW_RET_OK, rmw_init_options_init("some_identifier", &options, allocator)) << | ||
| rcutils_get_error_string().str; | ||
| OSRF_TESTING_TOOLS_CPP_SCOPE_EXIT( | ||
| { | ||
| rcutils_reset_error(); | ||
| EXPECT_EQ(RMW_RET_OK, rmw_init_options_fini("some_identifier", &options)) << | ||
| rcutils_get_error_string().str; | ||
| rcutils_reset_error(); | ||
| }); | ||
|
|
||
| EXPECT_EQ("some_identifier", options.implementation_identifier); | ||
| } | ||
|
|
||
|
|
||
| TEST(RMWInitOptionsTest, copy_w_invalid_args_fails) { | ||
| rcutils_allocator_t allocator = rcutils_get_default_allocator(); | ||
| rmw_init_options_t not_initialized_options = rmw_get_zero_initialized_init_options(); | ||
| rmw_init_options_t initialized_options = rmw_get_zero_initialized_init_options(); | ||
|
|
||
| ASSERT_EQ( | ||
| RMW_RET_OK, | ||
| rmw_init_options_init( | ||
| "some_identifier", | ||
| &initialized_options, | ||
| allocator)) << | ||
| rcutils_get_error_string().str; | ||
| OSRF_TESTING_TOOLS_CPP_SCOPE_EXIT( | ||
| { | ||
| rcutils_reset_error(); | ||
| EXPECT_EQ(RMW_RET_OK, rmw_init_options_fini("some_identifier", &initialized_options)) << | ||
| rcutils_get_error_string().str; | ||
| rcutils_reset_error(); | ||
| }); | ||
|
|
||
| // Cannot copy from a null options instance. | ||
| EXPECT_EQ( | ||
| RMW_RET_INVALID_ARGUMENT, | ||
| rmw_init_options_copy( | ||
| "some_identifier", | ||
| nullptr, | ||
| ¬_initialized_options)); | ||
| rcutils_reset_error(); | ||
|
|
||
| // Cannot copy to a null options instance. | ||
| EXPECT_EQ( | ||
| RMW_RET_INVALID_ARGUMENT, | ||
| rmw_init_options_copy( | ||
| "some_identifier", | ||
| &initialized_options, | ||
| nullptr)); | ||
| rcutils_reset_error(); | ||
|
|
||
| // Cannot copy an options instance if implementation identifiers do not match. | ||
| EXPECT_EQ( | ||
| RMW_RET_INCORRECT_RMW_IMPLEMENTATION, | ||
| rmw_init_options_copy( | ||
| "another_identifier", | ||
| &initialized_options, | ||
| ¬_initialized_options)); | ||
| rcutils_reset_error(); | ||
|
|
||
| // Cannot copy to an already initialized options instance. | ||
| EXPECT_EQ( | ||
| RMW_RET_INVALID_ARGUMENT, rmw_init_options_copy( | ||
| "some_identifier", | ||
| &initialized_options, | ||
| &initialized_options)); | ||
| rcutils_reset_error(); | ||
| } | ||
|
|
||
|
|
||
| TEST(RMWInitOptionsTest, copy) { | ||
| rcutils_allocator_t allocator = rcutils_get_default_allocator(); | ||
| rmw_init_options_t preset_options = rmw_get_zero_initialized_init_options(); | ||
|
|
||
| rcutils_reset_error(); | ||
| ASSERT_EQ(RMW_RET_OK, rmw_init_options_init("some_identifier", &preset_options, allocator)) << | ||
| rcutils_get_error_string().str; | ||
| OSRF_TESTING_TOOLS_CPP_SCOPE_EXIT( | ||
| { | ||
| rcutils_reset_error(); | ||
| EXPECT_EQ(RMW_RET_OK, rmw_init_options_fini("some_identifier", &preset_options)) << | ||
| rcutils_get_error_string().str; | ||
| rcutils_reset_error(); | ||
| }); | ||
| preset_options.instance_id = 23lu; | ||
| preset_options.enclave = rcutils_strdup("/test", allocator); | ||
| ASSERT_TRUE(preset_options.enclave != nullptr); | ||
| preset_options.security_options.security_root_path = rcutils_strdup("/root", allocator); | ||
| ASSERT_TRUE(preset_options.security_options.security_root_path != nullptr); | ||
|
|
||
| rmw_init_options_t options = rmw_get_zero_initialized_init_options(); | ||
| ASSERT_EQ(RMW_RET_OK, rmw_init_options_copy("some_identifier", &preset_options, &options)) << | ||
| rcutils_get_error_string().str; | ||
|
|
||
| OSRF_TESTING_TOOLS_CPP_SCOPE_EXIT( | ||
| { | ||
| rcutils_reset_error(); | ||
| EXPECT_EQ(RMW_RET_OK, rmw_init_options_fini("some_identifier", &options)) << | ||
| rcutils_get_error_string().str; | ||
| rcutils_reset_error(); | ||
| }); | ||
| EXPECT_EQ(23lu, options.instance_id); | ||
| EXPECT_STREQ("/test", options.enclave); | ||
| EXPECT_STREQ("/root", options.security_options.security_root_path); | ||
| } | ||
|
|
||
| static void * failing_allocate(size_t size, void * state) | ||
|
There was a problem hiding this comment. You definitely don't need to change this here, but one thing I learned while writing failing_allocators like this, is that you can just define the function without parameter names to avoid unused variable errors. There was a problem hiding this comment. I've learned not to do that because of compiler warnings. My memory may be failing me here though. There was a problem hiding this comment. Oh funny! I sometimes see compiler warnings when cast to void. |
||
| { | ||
| (void)size; | ||
| (void)state; | ||
| return NULL; | ||
| } | ||
|
|
||
| TEST(RMWInitOptionsTest, bad_alloc_on_copy) { | ||
| rcutils_allocator_t failing_allocator = rcutils_get_default_allocator(); | ||
| failing_allocator.allocate = failing_allocate; | ||
|
|
||
| rmw_init_options_t preset_options = rmw_get_zero_initialized_init_options(); | ||
| ASSERT_EQ( | ||
| RMW_RET_OK, | ||
| rmw_init_options_init("some_identifier", &preset_options, failing_allocator)) << | ||
| rcutils_get_error_string().str; | ||
| OSRF_TESTING_TOOLS_CPP_SCOPE_EXIT( | ||
| { | ||
| rcutils_reset_error(); | ||
| EXPECT_EQ(RMW_RET_OK, rmw_init_options_fini("some_identifier", &preset_options)) << | ||
| rcutils_get_error_string().str; | ||
| rcutils_reset_error(); | ||
| }); | ||
| preset_options.enclave = rcutils_strdup("/test", rcutils_get_default_allocator()); | ||
| ASSERT_TRUE(preset_options.enclave != nullptr); | ||
|
|
||
| rmw_init_options_t options = rmw_get_zero_initialized_init_options(); | ||
| EXPECT_EQ( | ||
| RMW_RET_BAD_ALLOC, | ||
| rmw_init_options_copy("some_identifier", &preset_options, &options)); | ||
| } | ||
|
|
||
| TEST(RMWInitOptionsTest, fini_w_invalid_args_fails) { | ||
| // Cannot finalize a null options instance. | ||
| EXPECT_EQ(RMW_RET_INVALID_ARGUMENT, rmw_init_options_fini("some_identifier", nullptr)); | ||
| rcutils_reset_error(); | ||
|
|
||
| rmw_init_options_t options = rmw_get_zero_initialized_init_options(); | ||
| // Cannot finalize an options instance that has not been initialized. | ||
| EXPECT_EQ(RMW_RET_INVALID_ARGUMENT, rmw_init_options_fini("some_identifier", &options)); | ||
| rcutils_reset_error(); | ||
|
|
||
| rcutils_allocator_t allocator = rcutils_get_default_allocator(); | ||
| ASSERT_EQ(RMW_RET_OK, rmw_init_options_init("some_identifier", &options, allocator)) << | ||
| rcutils_get_error_string().str; | ||
| OSRF_TESTING_TOOLS_CPP_SCOPE_EXIT( | ||
| { | ||
| rcutils_reset_error(); | ||
| EXPECT_EQ(RMW_RET_OK, rmw_init_options_fini("some_identifier", &options)) << | ||
| rcutils_get_error_string().str; | ||
| rcutils_reset_error(); | ||
| }); | ||
|
|
||
| // Cannot finalize an options instance if implementation identifiers do not match. | ||
| EXPECT_EQ( | ||
| RMW_RET_INCORRECT_RMW_IMPLEMENTATION, | ||
| rmw_init_options_fini("another_identifier", &options)); | ||
| rcutils_reset_error(); | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For expected failure cases here and below, can you add a short comment describing what error you're trying to catch?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See c879be7