Extend ament_cmake_python_test to support combined msg & python builds

Signed-off-by: R Kent James <[email protected]>

Author: rkent

ament_cmake_python/cmake/ament_python_install_registered_packages.cmake

@@ -73,6 +73,16 @@ macro(_ament_cmake_python_copy_build_files package_name)
 
   add_custom_target(${_sync_target} DEPENDS ${_PACKAGE_DIRS} ${_SETUP_CFG})
 
+  # Force any interface packages to be at the front of the list to prevent overwrite of
+  # python package __init__.py files
+  foreach(_dir IN LISTS _PACKAGE_DIRS)
+    string(FIND "${_dir}" "rosidl_generator_py" SUBSTRING_INDEX)
+    if(NOT SUBSTRING_INDEX EQUAL -1)
+      list(REMOVE_ITEM _PACKAGE_DIRS ${_dir})
+      list(PREPEND _PACKAGE_DIRS ${_dir})
+    endif()
+  endforeach()
+
   foreach(_dir IN LISTS _PACKAGE_DIRS)
     add_custom_command(TARGET ${_sync_target}
       COMMAND ${CMAKE_COMMAND} -E copy_directory

ament_cmake_python_test/CMakeLists.txt

@@ -26,7 +26,7 @@ if(BUILD_TESTING)
     ament_add_pytest_test(${_test_name} ${_test_path}
       APPEND_ENV PYTHONPATH=${CMAKE_CURRENT_BINARY_DIR}
       ENV SOURCE_DIR=${CMAKE_CURRENT_SOURCE_DIR} PYTHON_INSTALL_DIR=${PYTHON_INSTALL_DIR} PYEGG_VERSION=py${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR}
-      TIMEOUT 60
+      TIMEOUT 360
       WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
     )
   endforeach()

ament_cmake_python_test/package.xml

@@ -14,6 +14,7 @@
   <build_depend>ament_cmake_python</build_depend>
 
   <test_depend>python-jinja2</test_depend>
+  <test_depend>rosidl_cmake</test_depend>
 
   <buildtool_export_depend>ament_cmake_core</buildtool_export_depend>
 

ament_cmake_python_test/test/build_with_colcon.py

@@ -34,6 +34,12 @@
     'name': 'python_package',
     'description': 'Package with python code',
   },
+  {
+    'name': 'msg_package',
+    'description': 'Package with only msg files',
+    'has_msg': True,
+    'has_python': False,
+  },
   {
     'name': 'python_package_symlink',
     'description': 'Package with python code, installed with symlink in build',
@@ -64,12 +70,6 @@
     'description': 'Package with python code',
     'scripts_destination': 'lib/python_package_with_scripts',
   },
-  {
-    'name': 'msg_package',
-    'description': 'Package with only msg files',
-    'has_msg': True,
-    'has_python': False,
-  },
 ]
 
 
@@ -80,9 +80,25 @@ def test_from_template():
   packages_dir = PWD / 'packages'
   shutil.rmtree(packages_dir, ignore_errors=True)
 
-  # Create test packages from template
-  template_dir = SOURCE_DIR / 'test' / 'pkg_template'
+  # extend the tests to include combinations of msg and python
+  additional_options = TESTS_OPTIONS.copy()
   for options in TESTS_OPTIONS:
+    if options['name'].startswith('python_package'):
+      msg_options = options.copy()
+      msg_options['name'] += '_with_msg'
+      msg_options['description'] += 'and msg files'
+      msg_options['has_msg'] = True
+      additional_options.append(msg_options)
+    elif options['name'].startswith('msg_package'):
+      py_options = options.copy()
+      py_options['name'] += '_with_python_before'
+      py_options['description'] += ' and python code before msg'
+      py_options['has_python_before'] = True
+      additional_options.append(py_options)
+
+  template_dir = SOURCE_DIR / 'test' / 'pkg_template'
+  # Create test packages from template
+  for options in additional_options:
     options = DEFAULT_OPTIONS | options
     print(f"Generating package {options['name']}")
     print(f"  options: {options}")
@@ -96,7 +112,7 @@ def test_from_template():
     if options['has_msg']:
       shutil.copytree(template_dir / 'msg', package_dir / 'msg')
 
-    if options['has_python']:
+    if options['has_python'] or options['has_python_before']:
       ignore_patterns = shutil.ignore_patterns('*.jinja')
       shutil.copytree(template_dir / 'package_directory', package_dir / package_subdir, ignore=ignore_patterns)
       template = Template(Path.read_text(template_dir / 'package_directory' / '__init__.py.jinja'))
@@ -161,7 +177,7 @@ def do_test_package(package_name, options):
   assert install_path.exists(), f"install path does not exist for {package_name}: {install_path}"
   assert (install_path / '__init__.py').exists(), f"missing __init__.py in {install_path}"
 
-  if options['has_python']:
+  if options['has_python'] or options['has_python_before']:
     assert Path.read_text (install_path / '__init__.py').startswith(f"# This is {package_name}"), \
           f"__init__.py should be from {package_name} python package"