Skip to content

Adds rosidl transform test #26

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

Open
wants to merge 7 commits into
base: streamline-file-generation
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
50 changes: 7 additions & 43 deletions rosidl_adapter_proto/bin/rosidl_adapter_proto
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,8 @@ import sys
import pathlib
import os

from rosidl_cmake import read_generator_arguments
from rosidl_adapter_proto import generate_proto
from rosidl_adapter_proto import compile_proto
from rosidl_adapter_proto.cli import convert_to_proto


def main(argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
Expand All @@ -41,47 +40,12 @@ def main(argv=sys.argv[1:]):
help='Path to the protoc executable')

args = parser.parse_args(argv)

generator_args = read_generator_arguments(args.generator_arguments_file)

# Generate .proto files
rc = generate_proto(args.generator_arguments_file)
if rc:
return rc

# Compile .proto files using protoc
cpp_out_dir = str(pathlib.Path(generator_args["output_dir"] + "/..").resolve())
proto_path_list = [str(pathlib.Path(generator_args["output_dir"] + "/..").resolve())]
proto_files = []
package_name = generator_args["package_name"]

if "additional_files" in generator_args:
proto_path_list += generator_args["additional_files"]

pathlib.Path(cpp_out_dir).mkdir(parents=True, exist_ok=True)

for idl_tuple in generator_args.get('idl_tuples', []):
idl_parts = idl_tuple.rsplit(':', 1)
assert len(idl_parts) == 2
idl_rel_path = pathlib.Path(idl_parts[1])
idl_stem = idl_rel_path.stem
generated_file = os.path.join(
generator_args['output_dir'],
str(idl_rel_path.parent),
idl_stem + ".proto"
)
proto_files.append(str(pathlib.Path(generated_file).resolve()))

# compile proto files with protoc
rc = compile_proto(protoc_path = args.protoc_path,
proto_path_list = proto_path_list,
cpp_out_dir = cpp_out_dir,
proto_files = proto_files,
package_name = package_name
)
try:
convert_to_proto(args.generator_arguments_file, args.protoc_path)
except RuntimeError:
return 1

return rc

return 0

if __name__ == '__main__':
sys.exit(main())
157 changes: 157 additions & 0 deletions rosidl_adapter_proto/rosidl_adapter_proto/cli.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
import argparse
import os
import pathlib
import sys

from ament_index_python import get_package_share_directory

from catkin_pkg.package import package_exists_at
from catkin_pkg.package import parse_package

from rosidl_adapter.action import convert_action_to_idl
from rosidl_adapter.msg import convert_msg_to_idl
from rosidl_adapter.srv import convert_srv_to_idl

from rosidl_cmake import read_generator_arguments

from rosidl_cli.command.helpers import interface_path_as_tuple
from rosidl_cli.command.helpers import legacy_generator_arguments_file
from rosidl_cli.command.translate.extensions import TranslateCommandExtension
from rosidl_cli.command.translate.api import translate

from rosidl_adapter_proto import generate_proto
from rosidl_adapter_proto import compile_proto

def convert_to_proto(generator_arguments_file, protoc_path):
generator_args = read_generator_arguments(generator_arguments_file)

# Generate .proto files
rc = generate_proto(generator_arguments_file)
if rc :
raise RuntimeError

# Compile .proto files using protoc
cpp_out_dir = str(pathlib.Path(generator_args["output_dir"] + "/..").resolve())
proto_path_list = [str(pathlib.Path(generator_args["output_dir"] + "/..").resolve())]
proto_files = []
package_name = generator_args["package_name"]

if "additional_files" in generator_args:
proto_path_list += generator_args["additional_files"]

pathlib.Path(cpp_out_dir).mkdir(parents=True, exist_ok=True)

for idl_tuple in generator_args.get('idl_tuples', []):
idl_parts = idl_tuple.rsplit(':', 1)
assert len(idl_parts) == 2
idl_rel_path = pathlib.Path(idl_parts[1])
idl_stem = idl_rel_path.stem
generated_file = os.path.join(
generator_args['output_dir'],
str(idl_rel_path.parent),
idl_stem + ".proto"
)
proto_files.append(str(pathlib.Path(generated_file).resolve()))

# compile proto files with protoc
rc = compile_proto(protoc_path = protoc_path,
proto_path_list = proto_path_list,
cpp_out_dir = cpp_out_dir,
proto_files = proto_files,
package_name = package_name
)
if rc :
raise RuntimeError

return proto_files


def convert_files_to_idl(extension, conversion_function, argv=sys.argv[1:]):
parser = argparse.ArgumentParser(
description=f'Convert {extension} files to .idl')
parser.add_argument(
'interface_files', nargs='+',
help='The interface files to convert')
args = parser.parse_args(argv)

for interface_file in args.interface_files:
interface_file = pathlib.Path(interface_file)
package_dir = interface_file.parent.absolute()
while (
len(package_dir.parents) and
not package_exists_at(str(package_dir))
):
package_dir = package_dir.parent
if not package_dir.parents:
print(
f"Could not find package for '{interface_file}'",
file=sys.stderr)
continue
warnings = []
pkg = parse_package(package_dir, warnings=warnings)

conversion_function(
package_dir, pkg.name,
interface_file.absolute().relative_to(package_dir),
interface_file.parent)


class TranslateToProto(TranslateCommandExtension):

output_format = 'proto'

def translate(
self,
package_name,
interface_files,
include_paths,
output_path
):

generated_files = []

package_share_path = pathlib.Path(
get_package_share_directory('rosidl_adapter_proto'))
templates_path = package_share_path / 'resource'


idl_interface_files = []
non_idl_interface_files = []
for path in interface_files:
if not path.endswith('.idl'):
non_idl_interface_files.append(path)
else:
idl_interface_files.append(path)
if non_idl_interface_files:
idl_interface_files.extend(translate(
package_name=package_name,
interface_files=non_idl_interface_files,
include_paths=include_paths,
output_format='idl',
output_path=output_path / 'tmp',
))


# Generate code
with legacy_generator_arguments_file(
package_name=package_name,
interface_files=idl_interface_files,
include_paths=include_paths,
templates_path=templates_path,
output_path=output_path
) as path_to_arguments_file:
generated_files.extend(convert_to_proto(path_to_arguments_file, '/usr/bin/protoc'))
return generated_files



class TranslateMsgToProto(TranslateToProto):
input_format = 'msg'


class TranslateSrvToProto(TranslateToProto):
input_format = 'srv'


class TranslateActionToProto(TranslateToProto):
input_format = 'action'
5 changes: 5 additions & 0 deletions rosidl_adapter_proto/setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[options.entry_points]
rosidl_cli.command.translate.extensions =
msg2proto = rosidl_adapter_proto.cli:TranslateMsgToProto
srv2proto = rosidl_adapter_proto.cli:TranslateSrvToProto
action2proto = rosidl_adapter_proto.cli:TranslateActionToProto
30 changes: 30 additions & 0 deletions rosidl_adapter_proto/test/test_rosidl_cli_translate.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import pytest
import os
import pathlib
import shutil
import subprocess

from ament_index_python import get_package_share_directory

def test_ts_files_generation():
build_then_install('/tmp/tr')
files_exists('/tmp/tr')

def build_then_install(output_path):
if os.path.exists(output_path):
shutil.rmtree(output_path)
os.makedirs(output_path)

package_share_path = pathlib.Path(
get_package_share_directory('std_msgs'))

subprocess.run([
'rosidl', 'translate', '-o', output_path, '--from', 'msg', '--to', 'proto', 'std_msgs', './msg/String.msg'
], cwd=package_share_path, check=True)

def files_exists(output_path):
assert pathlib.Path('/tmp/tr/msg/String.pb.cc').exists()
assert pathlib.Path('/tmp/tr/msg/String.pb.h').exists()
assert pathlib.Path('/tmp/tr/msg/String.proto').exists()
assert pathlib.Path('/tmp/tr/tmp/msg/String.idl').exists()

2 changes: 2 additions & 0 deletions rosidl_typesupport_protobuf_c/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ if(BUILD_TESTING)
target_link_libraries(test_wstring_conversion
${PROJECT_NAME})
endif()
find_package(ament_cmake_pytest REQUIRED)
ament_add_pytest_test(test_rosidl_cli_ts_pb_c test/test_rosidl_cli_ts_pb_c.py)
endif()

ament_package(
Expand Down
1 change: 1 addition & 0 deletions rosidl_typesupport_protobuf_c/package.xml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
<exec_depend>rosidl_typesupport_interface</exec_depend>

<test_depend>ament_cmake_gtest</test_depend>
<test_depend>ament_cmake_pytest</test_depend>

<member_of_group>rosidl_typesupport_c_packages</member_of_group>

Expand Down
72 changes: 72 additions & 0 deletions rosidl_typesupport_protobuf_c/rosidl_typesupport_protobuf_c/cli.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
import pathlib

from ament_index_python import get_package_share_directory

from rosidl_cli.command.generate.extensions import GenerateCommandExtension
from rosidl_cli.command.helpers import generate_visibility_control_file
from rosidl_cli.command.helpers import legacy_generator_arguments_file
from rosidl_cli.command.translate.api import translate

from rosidl_typesupport_protobuf_c import generate_typesupport_protobuf_c


class GenerateProtobufCTypesupport(GenerateCommandExtension):

def generate(
self,
package_name,
interface_files,
include_paths,
output_path
):
generated_files = []

package_share_path = pathlib.Path(
get_package_share_directory('rosidl_typesupport_protobuf_c'))
templates_path = package_share_path / 'resource'

# Normalize interface definition format to .idl
idl_interface_files = []
non_idl_interface_files = []
for path in interface_files:
if not path.endswith('.idl'):
non_idl_interface_files.append(path)
else:
idl_interface_files.append(path)
if non_idl_interface_files:
idl_interface_files.extend(translate(
package_name=package_name,
interface_files=non_idl_interface_files,
include_paths=include_paths,
output_format='idl',
output_path=output_path / 'tmp',
))

# Generate visibility control file
visibility_control_file_template_path = \
'rosidl_typesupport_protobuf_c__visibility_control.h.in'
visibility_control_file_template_path = \
templates_path / visibility_control_file_template_path
visibility_control_file_path = \
'rosidl_typesupport_protobuf_c__visibility_control.h'
visibility_control_file_path = \
output_path / 'msg' / visibility_control_file_path

generate_visibility_control_file(
package_name=package_name,
template_path=visibility_control_file_template_path,
output_path=visibility_control_file_path
)
generated_files.append(visibility_control_file_path)

# Generate code
with legacy_generator_arguments_file(
package_name=package_name,
interface_files=idl_interface_files,
include_paths=include_paths,
templates_path=templates_path,
output_path=output_path
) as path_to_arguments_file:
generated_files.extend(generate_typesupport_protobuf_c(path_to_arguments_file))

return generated_files
3 changes: 3 additions & 0 deletions rosidl_typesupport_protobuf_c/setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[options.entry_points]
rosidl_cli.command.generate.typesupport_extensions =
protobuf_c = rosidl_typesupport_protobuf_c.cli:GenerateProtobufCTypesupport
30 changes: 30 additions & 0 deletions rosidl_typesupport_protobuf_c/test/test_rosidl_cli_ts_pb_c.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import pytest
import os
import pathlib
import shutil
import subprocess

from ament_index_python import get_package_share_directory

def test_ts_files_generation():
build_then_install('/tmp/pb')
files_exists('/tmp/pb')

def build_then_install(output_path):
if os.path.exists(output_path):
shutil.rmtree(output_path)
os.makedirs(output_path)

package_share_path = pathlib.Path(
get_package_share_directory('std_msgs'))

subprocess.run([
'rosidl', 'generate', '-ts', 'protobuf_c', '-o', output_path, 'std_msgs', './msg/String.msg'
], cwd=package_share_path, check=True)

def files_exists(output_path):
assert pathlib.Path('/tmp/pb/tmp/msg/String.idl').exists()
assert pathlib.Path('/tmp/pb/msg/rosidl_typesupport_protobuf_c__visibility_control.h').exists()
assert pathlib.Path('/tmp/pb/msg/string__rosidl_typesupport_protobuf_c.hpp').exists()
assert pathlib.Path('/tmp/pb/msg/detail/string__type_support.cpp').exists()

2 changes: 2 additions & 0 deletions rosidl_typesupport_protobuf_cpp/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@ if(BUILD_TESTING)
target_link_libraries(test_wstring_conversion
${PROJECT_NAME})
endif()
find_package(ament_cmake_pytest REQUIRED)
ament_add_pytest_test(test_rosidl_cli_ts_pb_cpp test/test_rosidl_cli_ts_pb_cpp.py)
endif()

ament_package(CONFIG_EXTRAS "cmake/rosidl_typesupport_protobuf_cpp-extras.cmake.in")
Expand Down
Loading
Loading