Merge tests from @nadavelkabets ament#587

rkent · rkent · commit 8289f2771ff7 · 2025-09-08T12:10:16.000-07:00
Co-authored-by: R. Kent James &lt;kent@caspia.com&gt;
Co-authored-by Nadav Elkabets &lt;elnadav12@gmail.com&gt;

Signed-off-by: R Kent James &lt;kent@caspia.com&gt;
diff --git a/ament_cmake_python_test/CMakeLists.txt b/ament_cmake_python_test/CMakeLists.txt
@@ -5,7 +5,7 @@ project(ament_cmake_python_test)
 find_package(ament_cmake_core REQUIRED)
 
 # Uncomment to debug CMake variables
-# 
+#
 #get_cmake_property(_variableNames VARIABLES)
 #list (SORT _variableNames)
 #foreach (_variableName ${_variableNames})
@@ -16,7 +16,7 @@ if(BUILD_TESTING)
   find_package(ament_cmake_pytest REQUIRED)
   find_package(ament_cmake_python REQUIRED)
   ament_get_python_install_dir(PYTHON_INSTALL_DIR)
-  
+
   set(_pytest_tests
     test/build_with_colcon.py
     # Add other test files here
diff --git a/ament_cmake_python_test/README.md b/ament_cmake_python_test/README.md
@@ -4,3 +4,4 @@ This package exists solely to test the ament_cmake_python package.
 
 It runs `colcon build` on some test packages, with the working directory `build/ament_cmake_package_test`.
 That means that the normal `build`, `install`, and `log` directories are subdirectories of `build/ament_cmake_package_test`
+named `build_test`, `install_test`, and `log` respectively.
diff --git a/ament_cmake_python_test/test/COLCON_IGNORE b/ament_cmake_python_test/test/COLCON_IGNORE
diff --git a/ament_cmake_python_test/test/ament_python_test_package/CMakeLists.txt b/ament_cmake_python_test/test/ament_python_test_package/CMakeLists.txt
@@ -0,0 +1,11 @@
+cmake_minimum_required(VERSION 3.12)
+
+project(ament_python_test_package)
+
+find_package(ament_cmake_core REQUIRED)
+
+find_package(ament_cmake_python REQUIRED)
+
+ament_python_install_package(${PROJECT_NAME})
+
+ament_package()
diff --git a/ament_cmake_python_test/test/ament_python_test_package/ament_python_test_package/__init__.py b/ament_cmake_python_test/test/ament_python_test_package/ament_python_test_package/__init__.py
diff --git a/ament_cmake_python_test/test/ament_python_test_package/ament_python_test_package/main.py b/ament_cmake_python_test/test/ament_python_test_package/ament_python_test_package/main.py
@@ -0,0 +1,3 @@
+class Bar:
+    def __init__() -> None:
+        pass
diff --git a/ament_cmake_python_test/test/ament_python_test_package/package.xml b/ament_cmake_python_test/test/ament_python_test_package/package.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
+<package format="3">
+  <name>ament_python_test_package</name>
+  <version>0.0.0</version>
+  <description>Minimal python package to test python cmake install</description>
+
+  <maintainer email="elnadav12@gmail.com">Nadav Elkabets</maintainer>
+
+  <license>Apache License 2.0</license>
+
+  <buildtool_depend>ament_cmake_core</buildtool_depend>
+  <build_depend>ament_cmake_python</build_depend>
+
+  <buildtool_export_depend>ament_cmake_core</buildtool_export_depend>
+
+  <export>
+    <build_type>ament_cmake</build_type>
+  </export>
+</package>
diff --git a/ament_cmake_python_test/test/ament_python_test_package_overlay/CMakeLists.txt b/ament_cmake_python_test/test/ament_python_test_package_overlay/CMakeLists.txt
@@ -0,0 +1,18 @@
+cmake_minimum_required(VERSION 3.12)
+
+project(ament_python_test_package_overlay)
+
+find_package(ament_cmake_core REQUIRED)
+
+find_package(ament_cmake_python REQUIRED)
+
+ament_python_install_package(
+    ament_python_test_package_overlay
+    PACKAGE_DIR "${CMAKE_CURRENT_LIST_DIR}/ament_python_test_package"
+)
+ament_python_install_package(
+    ament_python_test_package_overlay
+    PACKAGE_DIR "${CMAKE_CURRENT_LIST_DIR}/ament_python_test_package_overlay"
+)
+
+ament_package()
diff --git a/ament_cmake_python_test/test/ament_python_test_package_overlay/ament_python_test_package/__init__.py b/ament_cmake_python_test/test/ament_python_test_package_overlay/ament_python_test_package/__init__.py
diff --git a/ament_cmake_python_test/test/ament_python_test_package_overlay/ament_python_test_package/main.py b/ament_cmake_python_test/test/ament_python_test_package_overlay/ament_python_test_package/main.py
@@ -0,0 +1,3 @@
+class Bar:
+    def __init__() -> None:
+        pass
diff --git a/ament_cmake_python_test/test/ament_python_test_package_overlay/ament_python_test_package_overlay/__init__.py b/ament_cmake_python_test/test/ament_python_test_package_overlay/ament_python_test_package_overlay/__init__.py
@@ -0,0 +1 @@
+from subdir.utils import foo
diff --git a/ament_cmake_python_test/test/ament_python_test_package_overlay/ament_python_test_package_overlay/subdir/__init__.py b/ament_cmake_python_test/test/ament_python_test_package_overlay/ament_python_test_package_overlay/subdir/__init__.py
diff --git a/ament_cmake_python_test/test/ament_python_test_package_overlay/ament_python_test_package_overlay/subdir/utils.py b/ament_cmake_python_test/test/ament_python_test_package_overlay/ament_python_test_package_overlay/subdir/utils.py
@@ -0,0 +1,2 @@
+def foo() -> None:
+    pass
diff --git a/ament_cmake_python_test/test/ament_python_test_package_overlay/package.xml b/ament_cmake_python_test/test/ament_python_test_package_overlay/package.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
+<package format="3">
+  <name>ament_python_test_package_overlay</name>
+  <version>0.0.0</version>
+  <description>Testing merging two python packages into one</description>
+
+  <maintainer email="elnadav12@gmail.com">Nadav Elkabets</maintainer>
+
+  <license>Apache License 2.0</license>
+
+  <buildtool_depend>ament_cmake_core</buildtool_depend>
+  <build_depend>ament_cmake_python</build_depend>
+
+  <buildtool_export_depend>ament_cmake_core</buildtool_export_depend>
+
+  <export>
+    <build_type>ament_cmake</build_type>
+  </export>
+</package>
diff --git a/ament_cmake_python_test/test/build_with_colcon.py b/ament_cmake_python_test/test/build_with_colcon.py
@@ -2,6 +2,7 @@
 Test building python packages with colcon
 """
 
+import filecmp
 import os
 from pathlib import Path
 import shutil
@@ -15,6 +16,11 @@
 PYTHON_INSTALL_DIR = Path(os.environ.get('PYTHON_INSTALL_DIR'))
 PYEGG_VERSION = os.environ.get('PYEGG_VERSION')
 
+INSTALL_BASE = 'install_test'
+BUILD_BASE = 'build_test'
+AMENT_PYTHON_TEST_PACKAGE = "ament_python_test_package"
+AMENT_PYTHON_TEST_PACKAGE_OVERLAY = AMENT_PYTHON_TEST_PACKAGE + "_overlay"
+
 DEFAULT_OPTIONS = {
   'name': 'SET_ME',
   'version': None,
@@ -145,21 +151,47 @@ def test_from_template():
     template = Template(Path.read_text(template_dir / 'CMakeLists.txt.jinja'))
     Path.write_text(package_dir / 'CMakeLists.txt', template.render(options))
 
-    do_build_package(options['name'], options, base_prefix=PWD)
+    do_build_package(options['name'], options, source_prefix=PWD / 'packages')
     do_test_package(options['name'], options)
 
 
-def do_build_package(package_name, options=None, base_prefix=SOURCE_DIR / 'test'):
+def test_ament_python_test_package() -> None:
+    do_build_package(AMENT_PYTHON_TEST_PACKAGE, source_prefix=SOURCE_DIR / 'test')
+    assert not filecmp.dircmp(
+        SOURCE_DIR / 'test' / AMENT_PYTHON_TEST_PACKAGE,
+        PWD / INSTALL_BASE / AMENT_PYTHON_TEST_PACKAGE
+    ).diff_files, "All files in ament_python_test_package should match after install"
+
+
+def test_ament_python_test_package_with_overlay(tmpdir) -> None:
+    do_build_package(AMENT_PYTHON_TEST_PACKAGE_OVERLAY, source_prefix=SOURCE_DIR / 'test')
+
+    INSTALL_DIR = PWD / INSTALL_BASE / AMENT_PYTHON_TEST_PACKAGE_OVERLAY / PYTHON_INSTALL_DIR
+    shutil.copytree(SOURCE_DIR / 'test' / AMENT_PYTHON_TEST_PACKAGE / AMENT_PYTHON_TEST_PACKAGE, tmpdir, dirs_exist_ok=True)
+    shutil.copytree(SOURCE_DIR / 'test' / AMENT_PYTHON_TEST_PACKAGE_OVERLAY / AMENT_PYTHON_TEST_PACKAGE_OVERLAY, tmpdir, dirs_exist_ok=True)
+    assert not filecmp.dircmp(tmpdir, INSTALL_DIR / AMENT_PYTHON_TEST_PACKAGE_OVERLAY).diff_files, \
+        "Two overlaid python packages should match after install"
+    assert not filecmp.dircmp(
+        tmpdir / "subdir",
+        INSTALL_DIR / AMENT_PYTHON_TEST_PACKAGE_OVERLAY / "subdir"
+    ).diff_files, "Two overlaid python packages should match after install, including subdirectories"
+
+
+def do_build_package(
+    package_name, options=None,
+    source_prefix=None):
   if options and 'build' in options:
     build_options = options['build']
   elif options and 'symlink_install' in options and options['symlink_install']:
     build_options = '--symlink-install'
   else:
     build_options = None
-  
+
   print(f"Building package {package_name} with colcon options: {build_options}")
   build_command = ['colcon', 'build',
-    '--base-paths', base_prefix / 'packages' / package_name]
+    '--base-paths', source_prefix / package_name,
+    '--build-base', BUILD_BASE,
+    '--install-base', INSTALL_BASE]
   if build_options:
     build_command.append(build_options)
   result = subprocess.run(build_command, capture_output=True, text=True)
@@ -170,9 +202,9 @@ def do_build_package(package_name, options=None, base_prefix=SOURCE_DIR / 'test'
 
 def do_test_package(package_name, options):
   if options['destination']:
-    install_path = PWD / 'install' / package_name / options['destination'] / package_name
+    install_path = PWD / INSTALL_BASE / package_name / options['destination'] / package_name
   else:
-    install_path = PWD / 'install' / package_name / PYTHON_INSTALL_DIR / package_name
+    install_path = PWD / INSTALL_BASE / package_name / PYTHON_INSTALL_DIR / package_name
   print(f"install_path for package {package_name}: {install_path}")
   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}"
@@ -191,7 +223,7 @@ def do_test_package(package_name, options):
   if options['version']:
       print(f"Testing version: {options['version']} IN EGG-INFO in package {package_name}")
       version = options['version']
-      egg_info_dir = PWD / 'install' / package_name / PYTHON_INSTALL_DIR / f'{package_name}-{version}-{PYEGG_VERSION}.egg-info'
+      egg_info_dir = PWD / INSTALL_BASE / package_name / PYTHON_INSTALL_DIR / f'{package_name}-{version}-{PYEGG_VERSION}.egg-info'
       assert egg_info_dir.exists(), f"egg-info dir does not exist for {package_name}: {egg_info_dir}"
       egg_info_file = egg_info_dir / 'PKG-INFO'
       assert Path.read_text(egg_info_file).find(f"Version: {version}") != -1, \
@@ -201,13 +233,13 @@ def do_test_package(package_name, options):
       print(f"Testing setup.cfg metadata in package {package_name}")
       print(f"  options: {options}")
       version = options['version'] or "0.0.0"
-      egg_info_dir = PWD / 'install' / package_name / PYTHON_INSTALL_DIR / f'{package_name}-{version}-{PYEGG_VERSION}.egg-info'
+      egg_info_dir = PWD / INSTALL_BASE / package_name / PYTHON_INSTALL_DIR / f'{package_name}-{version}-{PYEGG_VERSION}.egg-info'
       assert egg_info_dir.exists(), f"egg-info dir does not exist for {package_name}: {egg_info_dir}"
       egg_info_file = egg_info_dir / 'PKG-INFO'
       assert Path.read_text(egg_info_file).find(f"Keywords: test_of_ament_cmake_python") != -1, \
         f"egg-info file should contain 'Keywords: test_of_ament_cmake_python' specified in setup.cfg"
 
   if options['scripts_destination']:
       print(f"Testing script installed in package {package_name}")
-      script_path = PWD / 'install' / package_name / options['scripts_destination'] / 'do_something'
+      script_path = PWD / INSTALL_BASE / package_name / options['scripts_destination'] / 'do_something'
       assert script_path.exists(), f"script do_something does not exist for {package_name}: {script_path}"

Original file line number	Diff line number	Diff line change
`@@ -4,3 +4,4 @@ This package exists solely to test the ament_cmake_python package.`
`4`	`4`
`5`	`5`	It runs `colcon build` on some test packages, with the working directory `build/ament_cmake_package_test`.
`6`	`6`	That means that the normal `build`, `install`, and `log` directories are subdirectories of `build/ament_cmake_package_test`
	`7`	+named `build_test`, `install_test`, and `log` respectively.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+class Bar:`
	`2`	`+ def __init__() -> None:`
	`3`	`+ pass`