Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add Fibonacci test for actions #316

Merged
merged 5 commits into from
Dec 7, 2018
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 61 additions & 5 deletions test_communication/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,25 @@ if(BUILD_TESTING)

set(message_files "")
set(service_files "")
set(action_files "")
foreach(interface_file ${interface_files})
get_filename_component(interface_ns "${interface_file}" DIRECTORY)
get_filename_component(interface_ns "${interface_ns}" NAME)
if(interface_ns STREQUAL "action")
continue()
endif()
string_ends_with("${interface_file}" ".msg" is_message)
if(is_message AND interface_ns STREQUAL "msg")
list(APPEND message_files "${interface_file}")
continue()
endif()
string_ends_with("${interface_file}" ".srv" is_service)
if(is_service)
if(is_service AND interface_ns STREQUAL "srv")
list(APPEND service_files "${interface_file}")
continue()
endif()
string_ends_with("${interface_file}" ".idl" is_action)
if(is_action AND interface_ns STREQUAL "action")
list(APPEND action_files "${interface_file}")
continue()
endif()
endforeach()

set(other_message_files
Expand Down Expand Up @@ -113,7 +116,9 @@ if(BUILD_TESTING)
rosidl_target_interfaces(${target}
${PROJECT_NAME} "rosidl_typesupport_cpp")
ament_target_dependencies(${target}
"rclcpp")
"rclcpp"
"rclcpp_action"
)
endfunction()

function(custom_test_c target)
Expand Down Expand Up @@ -226,6 +231,45 @@ if(BUILD_TESTING)
)
endif()
endforeach()

# test action client / server
# Note: taking same exclusions as services since actions use services too
# set(SKIP_TEST "")

# TODO(wjwwood): actions do not support python
if(client_library1 STREQUAL "rclpy" OR client_library2 STREQUAL "rclpy")
set(SKIP_TEST "SKIP_TEST")
endif()

set(ACTION_CLIENT_RMW ${rmw_implementation1})
set(ACTION_SERVER_RMW ${rmw_implementation2})
foreach(action_file ${action_files})
get_filename_component(TEST_ACTION_TYPE "${action_file}" NAME_WE)
set(test_suffix "__${TEST_ACTION_TYPE}${suffix}")
configure_file(
test/test_action_client_server.py.in
test_action_client_server${test_suffix}.py.configured
@ONLY
)
file(GENERATE
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/test_action_client_server${test_suffix}_$<CONFIG>.py"
INPUT "${CMAKE_CURRENT_BINARY_DIR}/test_action_client_server${test_suffix}.py.configured"
)

ament_add_pytest_test(test_action_client_server${test_suffix}
"${CMAKE_CURRENT_BINARY_DIR}/test_action_client_server${test_suffix}_$<CONFIG>.py"
PYTHON_EXECUTABLE "${_PYTHON_EXECUTABLE}"
APPEND_LIBRARY_DIRS "${append_library_dirs}"
TIMEOUT 30
${SKIP_TEST})
if(TEST test_action_client_server${test_suffix})
set_tests_properties(
test_action_client_server${test_suffix}
PROPERTIES DEPENDS
"test_action_client_cpp__${rmw_implementation1};test_action_server_cpp__${rmw_implementation2}"
)
endif()
endforeach()
endmacro()

macro(configure_template _client_library1 _client_library2)
Expand All @@ -236,6 +280,8 @@ if(BUILD_TESTING)
set(TEST_SUBSCRIBER_RCL "${_client_library2}")
set(TEST_REQUESTER_RCL "${_client_library1}")
set(TEST_REPLIER_RCL "${_client_library2}")
set(TEST_ACTION_CLIENT_RCL "${_client_library1}")
set(TEST_ACTION_SERVER_RCL "${_client_library2}")

if(_client_library1 STREQUAL _client_library2)
set(suffix "__${_client_library1}")
Expand All @@ -254,17 +300,21 @@ if(BUILD_TESTING)
if(_client_library1 STREQUAL "rclpy")
set(TEST_PUBLISHER_EXECUTABLE "${CMAKE_CURRENT_SOURCE_DIR}/test/publisher_py.py")
set(TEST_REQUESTER_EXECUTABLE "${CMAKE_CURRENT_SOURCE_DIR}/test/requester_py.py")
# TODO(wjwwood): actions do not support python
elseif(_client_library1 STREQUAL "rclcpp")
set(TEST_PUBLISHER_EXECUTABLE "$<TARGET_FILE:test_publisher_cpp>")
set(TEST_REQUESTER_EXECUTABLE "$<TARGET_FILE:test_requester_cpp>")
set(TEST_ACTION_CLIENT_EXECUTABLE "$<TARGET_FILE:test_action_client_cpp>")
endif()

if(_client_library2 STREQUAL "rclpy")
set(TEST_SUBSCRIBER_EXECUTABLE "${CMAKE_CURRENT_SOURCE_DIR}/test/subscriber_py.py")
set(TEST_REPLIER_EXECUTABLE "${CMAKE_CURRENT_SOURCE_DIR}/test/replier_py.py")
# TODO(wjwwood): actions do not support python
elseif(_client_library2 STREQUAL "rclcpp")
set(TEST_SUBSCRIBER_EXECUTABLE "$<TARGET_FILE:test_subscriber_cpp>")
set(TEST_REPLIER_EXECUTABLE "$<TARGET_FILE:test_replier_cpp>")
set(TEST_ACTION_SERVER_EXECUTABLE "$<TARGET_FILE:test_action_server_cpp>")
endif()
endmacro()

Expand Down Expand Up @@ -298,6 +348,11 @@ if(BUILD_TESTING)
"test/test_requester.cpp")
custom_executable(test_replier_cpp
"test/test_replier.cpp")
# executables action client / server
custom_executable(test_action_client_cpp
"test/test_action_client.cpp")
custom_executable(test_action_server_cpp
"test/test_action_server.cpp")

macro(targets)
custom_test_c(test_messages_c
Expand Down Expand Up @@ -380,6 +435,7 @@ if(BUILD_TESTING)
add_dependencies(${target_name} ${PROJECT_NAME})
ament_target_dependencies(${target_name}
"rclcpp"
"rclcpp_action"
"rmw"
"rosidl_typesupport_c"
"rosidl_typesupport_cpp"
Expand Down
1 change: 1 addition & 0 deletions test_communication/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
<test_depend>osrf_testing_tools_cpp</test_depend>
<test_depend>rcl</test_depend>
<test_depend>rclcpp</test_depend>
<test_depend>rclcpp_action</test_depend>
<test_depend>rclpy</test_depend>
<test_depend>rmw_implementation</test_depend>
<test_depend>rmw_implementation_cmake</test_depend>
Expand Down
193 changes: 193 additions & 0 deletions test_communication/test/test_action_client.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,193 @@
// Copyright 2018 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 <chrono>
#include <functional>
#include <string>
#include <vector>

#include "rclcpp/exceptions.hpp"
#include "rclcpp/scope_exit.hpp"
#include "rclcpp/rclcpp.hpp"
#include "rclcpp_action/rclcpp_action.hpp"

#include "test_msgs/action/fibonacci.hpp"

using namespace std::chrono_literals;

template<typename ActionT>
struct ActionClientTest
{
typename ActionT::Goal goal;
std::function<bool(typename ActionT::Result::SharedPtr)> result_is_valid;
std::function<bool(typename ActionT::Feedback::ConstSharedPtr)> feedback_is_valid;
};

template<typename ActionT>
int
send_goals(
rclcpp::Node::SharedPtr node,
const std::string & action_type_name,
const std::vector<ActionClientTest<ActionT>> & goal_tests)
{
auto action_client =
rclcpp_action::create_client<ActionT>(node, "test/action/" + action_type_name);
auto logger = node->get_logger();

if (!action_client->wait_for_action_server(20s)) {
RCLCPP_ERROR(logger, "requester service not available after waiting");
return 1;
}

size_t test_index = 0;
bool invalid_feedback = false;
auto start = std::chrono::steady_clock::now();
RCLCPP_SCOPE_EXIT({
auto end = std::chrono::steady_clock::now();
std::chrono::duration<float> diff = (end - start);
RCLCPP_INFO(logger, "sent goals for %f seconds\n", diff.count());
});

while (rclcpp::ok() && test_index < goal_tests.size()) {
RCLCPP_INFO(logger, "sending goal #%zu", test_index + 1);

// on feedback, check the feedback is valid
auto feedback_callback =
[&](auto, const auto & feedback) {
RCLCPP_INFO(logger, "received feedback");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will the test pass if no feedback is received? I guess it has to, no way to make sure feedback is received before the result.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I wasn't asserting that at all. I just wanted to make sure that if feedback is sent it is valid. I could keep a counter, but I'm not sure if all the feedback would be received before the result or not, and if not how I could wait for all the feedback even after the result.

I'd consider this a good improvement on the test if we could find a good way to do it.

if (!goal_tests[test_index].feedback_is_valid(feedback)) {
RCLCPP_ERROR(logger, "invalid feedback");
invalid_feedback = true;
}
};

// send the request
auto goal_handle_future =
action_client->async_send_goal(goal_tests[test_index].goal, feedback_callback);

using rclcpp::executor::FutureReturnCode;
// wait for the sent goal to be accepted
auto status = rclcpp::spin_until_future_complete(node, goal_handle_future, 1000s);
if (status != FutureReturnCode::SUCCESS) {
RCLCPP_ERROR(logger, "send goal call failed");
return 1;
}

// wait for the result (feedback may be received in the meantime)
auto result_future = goal_handle_future.get()->async_result();
status = rclcpp::spin_until_future_complete(node, result_future, 1000s);
if (status != FutureReturnCode::SUCCESS) {
RCLCPP_ERROR(logger, "failed to receive a goal result in time");
return 1;
}

if (!goal_tests[test_index].result_is_valid(result_future.get().response)) {
RCLCPP_ERROR(logger, "invalid goal result");
return 1;
}
RCLCPP_INFO(logger, "received goal #%zu of %zu", test_index + 1, goal_tests.size());
test_index++;
}

if (test_index != goal_tests.size()) {
return 1;
}

if (invalid_feedback) {
return 1;
}

return 0;
}

std::vector<ActionClientTest<test_msgs::action::Fibonacci>>
generate_fibonacci_goal_tests()
{
std::vector<ActionClientTest<test_msgs::action::Fibonacci>> result;

constexpr size_t order = 10;
static_assert(order > 0, "order needs to be non-zero");

std::vector<int32_t> valid_fibo_seq;
valid_fibo_seq.push_back(0);
valid_fibo_seq.push_back(1);
for (size_t i = 1; i < order; ++i) {
valid_fibo_seq.push_back(valid_fibo_seq[i] + valid_fibo_seq[i - 1]);
}

{
ActionClientTest<test_msgs::action::Fibonacci> test;
size_t order = 10;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wjwwood hiding above's variable?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that was intentional, the idea being each scoped section would make their own order, but I guess I could use different names here.

test.goal.order = order;
test.result_is_valid =
[order, valid_fibo_seq](auto result) -> bool {
if (result->sequence.size() != (order + 1)) {
fprintf(stderr, "result sequence not equal to goal order\n");
return false;
}
for (size_t i = 0; i < order; ++i) {
if (valid_fibo_seq[i] != result->sequence[i]) {
fprintf(
stderr,
"result sequence not correct, expected %d but got %d for order %zu\n",
valid_fibo_seq[i], result->sequence[i], i);
return false;
}
}
return true;
};
test.feedback_is_valid =
[order, valid_fibo_seq](auto feedback) -> bool {
if (feedback->sequence.size() > (order + 1)) {
fprintf(stderr, "feedback sequence greater than the goal order\n");
return false;
}
for (size_t i = 0; i < feedback->sequence.size(); ++i) {
if (valid_fibo_seq[i] != feedback->sequence[i]) {
fprintf(
stderr,
"feedback sequence not correct, expected %d but got %d for order %zu\n",
valid_fibo_seq[i], feedback->sequence[i], i);
return false;
}
}
return true;
};
result.push_back(test);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wjwwood only one test?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes.

}

return result;
}

int main(int argc, char ** argv)
{
rclcpp::init(argc, argv);
if (argc != 3) {
fprintf(stderr, "Wrong number of arguments, pass an action type and a namespace\n");
return 1;
}

std::string action = argv[1];
std::string namespace_ = argv[2];
auto node = rclcpp::Node::make_shared("test_action_client_" + action, namespace_);

int rc;
if (action == "Fibonacci") {
rc = send_goals<test_msgs::action::Fibonacci>(node, action, generate_fibonacci_goal_tests());
} else {
fprintf(stderr, "Unknown action type '%s'\n", action.c_str());
return 1;
}
return rc;
}
56 changes: 56 additions & 0 deletions test_communication/test/test_action_client_server.py.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# generated from test_communication/test/test_action_client_server.py.in

import os
import sys
import time

from launch.legacy import LaunchDescriptor
from launch.legacy.exit_handler import primary_exit_handler
from launch.legacy.launcher import DefaultLauncher


def test_action_client_server():
namespace = '/test_time_%s' % time.strftime('%H_%M_%S', time.gmtime())

ld = LaunchDescriptor()
action_client_cmd = ['@TEST_ACTION_CLIENT_EXECUTABLE@', '@TEST_ACTION_TYPE@', namespace]
action_server_cmd = ['@TEST_ACTION_SERVER_EXECUTABLE@', '@TEST_ACTION_TYPE@', namespace]

action_server_env = dict(os.environ)
action_client_env = dict(os.environ)

if '@TEST_ACTION_SERVER_RCL@' == 'rclpy':
action_server_cmd.insert(0, sys.executable)
action_server_env['PYTHONUNBUFFERED'] = '1'
if '@TEST_ACTION_CLIENT_RCL@' == 'rclpy':
action_client_cmd.insert(0, sys.executable)
action_client_env['PYTHONUNBUFFERED'] = '1'

action_server_env['RCL_ASSERT_RMW_ID_MATCHES'] = '@ACTION_SERVER_RMW@'
action_server_env['RMW_IMPLEMENTATION'] = '@ACTION_SERVER_RMW@'
ld.add_process(
cmd=action_server_cmd,
name='test_action_server',
env=action_server_env,
)

action_client_env['RCL_ASSERT_RMW_ID_MATCHES'] = '@ACTION_CLIENT_RMW@'
action_client_env['RMW_IMPLEMENTATION'] = '@ACTION_CLIENT_RMW@'
ld.add_process(
cmd=action_client_cmd,
name='test_action_client',
env=action_client_env,
exit_handler=primary_exit_handler,
)

launcher = DefaultLauncher()
launcher.add_launch_descriptor(ld)
rc = launcher.launch()

assert rc == 0, \
"The launch file failed with exit code '" + str(rc) + "'. " \
'May be the action client did not receive any completed goals from the action server?'


if __name__ == '__main__':
test_action_client_server()
Loading