def test_launchfile(self):
"""Test launchfile formatting"""
launchfile = ds.launchfile.LaunchFile("example_launch")
my_arg = ds.parameter.LaunchArgument("arg_name",
description="This is a launch argument.",
default_value=1.5,
var_name=False)
my_arg.filename = "example_launch.launch"
my_arg.line_number = 1
launchfile.add_argument(my_arg)
formatter = mdformatter.MarkdownFormatter()
formatted_string = launchfile.to_string(1, formatter)
expected_string = r'''# example_launch
## Arguments
* "**arg_name**" (default: 1.5)
This is a launch argument.
'''
self.assertEqual(formatted_string, expected_string)
# Test empty launchfile
launchfile = ds.launchfile.LaunchFile("empty_launch")
formatter = mdformatter.MarkdownFormatter()
formatted_string = launchfile.to_string(1, formatter)
expected_string = r'''# empty_launch
No arguments for this launch file found. You can add a description by hand, if you like.
'''
self.assertEqual(formatted_string, expected_string)
def test_subscribers(self):
"""Test formatting of Topic objects"""
# Default entry
my_topic = ds.topic.Topic("topic_name",
description="This is a fancy topic",
datatype="std_msgs/Bool",
var_name=False)
formatter = mdformatter.MarkdownFormatter()
formatted_string = my_topic.to_string(1, formatter)
expected_string = r'''"**topic_name**" ([std_msgs/Bool](http://docs.ros.org/api/std_msgs/html/msg/Bool.html))
This is a fancy topic
'''
self.assertEqual(formatted_string, expected_string)
# Custom datatype
my_topic = ds.topic.Topic("topic_name",
description="This is a fancy topic",
datatype="my_own_msgs/Imaginary",
var_name=False)
formatter = mdformatter.MarkdownFormatter()
formatted_string = my_topic.to_string(1, formatter)
expected_string = r'''"**topic_name**" (my_own_msgs/Imaginary)
This is a fancy topic
'''
self.assertEqual(formatted_string, expected_string)
# Symbol name
my_topic = ds.topic.Topic("topic_name",
description="This is a fancy topic",
datatype="std_msgs/Bool",
var_name=True)
formatter = mdformatter.MarkdownFormatter()
formatted_string = my_topic.to_string(1, formatter)
expected_string = r'''"Symbol: **topic_name**" ([std_msgs/Bool](http://docs.ros.org/api/std_msgs/html/msg/Bool.html))
This is a fancy topic
'''
self.assertEqual(formatted_string, expected_string)
# No description
my_topic = ds.topic.Topic("topic_name",
description=None,
datatype="std_msgs/Bool",
var_name=True)
my_topic.line_number = 1
my_topic.code = r""" self.pub = rospy.Publisher(topic_name)"""
formatter = mdformatter.MarkdownFormatter()
formatted_string = my_topic.to_string(1, formatter)
expected_string = r'''"Symbol: **topic_name**" ([std_msgs/Bool](http://docs.ros.org/api/std_msgs/html/msg/Bool.html))
Please add description. See line number: 1
self.pub = rospy.Publisher(topic_name)
'''
self.assertEqual(formatted_string, expected_string)
def test_bold(self):
"""Test bold formatting"""
formatter = mdformatter.MarkdownFormatter()
text = "test_text"
expected_string = "**test_text**"
self.assertEqual(formatter.bold(text), expected_string)
def test_text(self):
"""Test bold formatting"""
formatter = mdformatter.MarkdownFormatter()
text = "test_text"
expected_string = "test_text\n"
self.assertEqual(formatter.text(text), expected_string)
expected_string = "test_text"
self.assertEqual(formatter.text(text, False), expected_string)
def test_launch_arguments(self):
"""Test formatting of paramter objects"""
# Default entry
my_arg = ds.parameter.LaunchArgument(
"arg_name",
description="This is a launch argument.",
default_value=1.5,
var_name=False)
formatter = mdformatter.MarkdownFormatter()
formatted_string = my_arg.to_string(1, formatter)
expected_string = r'''# arg_name (default: 1.5)
This is a launch argument.
'''
self.assertEqual(formatted_string, expected_string)
# No description
my_arg = ds.parameter.LaunchArgument("arg_name",
description=None,
default_value=1.5,
var_name=False)
my_arg.filename = "test_launch.launch"
my_arg.line_number = 1
formatter = mdformatter.MarkdownFormatter()
formatted_string = my_arg.to_string(1, formatter)
expected_string = r'''# arg_name (default: 1.5)
Please add description. See file "test_launch.launch".
'''
self.assertEqual(formatted_string, expected_string)
# Test no line
my_arg = ds.parameter.LaunchArgument("param_string",
default_value=None,
description=None,
var_name=False)
formatter = mdformatter.MarkdownFormatter()
with self.assertRaises(RuntimeError):
formatted_string = my_arg.to_string(1, formatter)
def test_as_list(self):
"""Test formatting of a text as list item"""
formatter = mdformatter.MarkdownFormatter()
text = """first line
second line
third line"""
as_list_str = formatter.as_list_item(1, text)
expected_string = """ * first line
second line
third line"""
assert expected_string == as_list_str
def test_node(self):
"""Test node formatting"""
node = ds.node.Node("test_node", "This is some imaginary node")
my_param = ds.parameter.Parameter("param_name",
description="This is a parameter",
default_value=1.5,
var_name=False)
node.add_parameter(my_param)
my_topic = ds.topic.Topic("topic_name",
description="This is a fancy topic",
datatype="std_msgs/Bool",
var_name=False)
node.add_subscriber(my_topic)
formatter = mdformatter.MarkdownFormatter()
formatted_string = node.to_string(2, formatter)
expected_raw = r'''## test_node
This is some imaginary node
### Parameters
#### param_name (default: 1.5)
This is a parameter
### Subscribed topics
#### topic_name ([std_msgs/Bool](http://docs.ros.org/api/std_msgs/html/msg/Bool.html))
This is a fancy topic
'''
replacements = {
'parameters': ds.KEYS['parameter'],
'subscribers': ds.KEYS['subscriber'],
'my_param': my_param.to_string(3, formatter),
'my_topic': my_topic.to_string(3, formatter)
}
expected_string = expected_raw.format(**replacements)
assert formatted_string == expected_string
def test_parameters(self):
"""Test formatting of paramter objects"""
my_param = ds.parameter.Parameter("param_name",
description="This is a parameter",
default_value=1.5,
var_name=False)
formatter = mdformatter.MarkdownFormatter()
formatted_string = my_param.to_string(1, formatter)
expected_string = r'''# param_name (default: 1.5)
This is a parameter
'''
self.assertEqual(formatted_string, expected_string)
my_param = ds.parameter.Parameter("param_name_2",
description="This is a parameter",
var_name=False)
formatter = mdformatter.MarkdownFormatter()
formatted_string = my_param.to_string(1, formatter)
expected_string = r'''# param_name_2 (Required)
This is a parameter
'''
self.assertEqual(formatted_string, expected_string)
my_param = ds.parameter.Parameter("param_name_sym",
description="This is a symbol",
var_name=True)
formatter = mdformatter.MarkdownFormatter()
formatted_string = my_param.to_string(1, formatter)
expected_string = r'''# Symbol: param_name_sym (Required)
This is a symbol
'''
self.assertEqual(formatted_string, expected_string)
my_param = ds.parameter.Parameter("param_string",
default_value="hello",
description="This is a symbol",
var_name=True)
formatter = mdformatter.MarkdownFormatter()
formatted_string = my_param.to_string(1, formatter)
expected_string = r'''# Symbol: param_string (default: "hello")
This is a symbol
'''
self.assertEqual(formatted_string, expected_string)
my_param = ds.parameter.Parameter("param_string",
default_value="hello",
description=None,
var_name=False)
my_param.code = r""" param_string = rospy.param("~param_string", default("hello"))"""
my_param.line_number = 1
# Test default description
formatter = mdformatter.MarkdownFormatter()
formatted_string = my_param.to_string(1, formatter)
expected_string = r'''# param_string (default: "hello")
Please add description. See line number: 1
param_string = rospy.param("~param_string", default("hello"))
'''
assert formatted_string == expected_string
# Test no code
my_param = ds.parameter.Parameter("param_string",
default_value="hello",
description=None,
var_name=False)
formatter = mdformatter.MarkdownFormatter()
with self.assertRaises(RuntimeError):
formatted_string = my_param.to_string(1, formatter)
