Merge basic test from @nadavelkabets ament#587

Co-authored-by: R. Kent James <[email protected]>
Co-authored-by Nadav Elkabets <[email protected]>

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

Author: rkent

ament_cmake_python_test/test/COLCON_IGNORE

@@ -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()

ament_cmake_python_test/test/ament_python_test_package/CMakeLists.txt

@@ -0,0 +1,3 @@
+class Bar:
+    def __init__() -> None:
+        pass

ament_cmake_python_test/test/ament_python_test_package/ament_python_test_package/__init__.py

@@ -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="[email protected]">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>

ament_cmake_python_test/test/ament_python_test_package/ament_python_test_package/main.py

@@ -2,6 +2,7 @@
 Test building python packages with colcon
 """
 
+import filecmp
 import os
 from pathlib import Path
 import shutil
@@ -17,6 +18,7 @@
 
 INSTALL_BASE = 'install_test'
 BUILD_BASE = 'build_test'
+AMENT_PYTHON_TEST_PACKAGE = "ament_python_test_package"
 
 DEFAULT_OPTIONS = {
   'name': 'SET_ME',
@@ -76,7 +78,7 @@
 ]
 
 
-def test_from_template():
+def not_test_from_template():
   print(f"PWD: {PWD}")
 
   # delete any existing package directory
@@ -132,11 +134,22 @@ 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, base_prefix=PWD, 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, base_prefix=PWD, 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 do_build_package(
+    package_name, options=None,
+    base_prefix=SOURCE_DIR / 'test',
+    source_prefix=None):
   if options and 'build' in options:
     build_options = options['build']
   elif options and 'symlink_install' in options and options['symlink_install']:
@@ -146,7 +159,7 @@ def do_build_package(package_name, options=None, base_prefix=SOURCE_DIR / 'test'
 
   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: