Fix broken PyImath.pc, and add pkg-config CI tests (AcademySoftwareFoundation#510)

PyImath.pc failed to get updated with recent changes to PyImath CMakeLists.txt.

This also adds CI tests for Imath.pc and PyImath.pc, steps to build
simple programs in `share/ci/src` using values extracted via pkg-config.

Signed-off-by: Cary Phillips <cary@ilm.com>

Author: cary-ilm

.github/workflows/ci_steps.yml

@@ -650,4 +650,18 @@ jobs:
           $EXAMPLES_BUILD_DIR/bin/imath-examples.exe
         shell: msys2 {0}
 
+      - name: Test Imath.pc
+        # Validate that Imath.pc works by compiling/linking the test program
+        if: runner.os != 'Windows' && inputs.IMATH_INSTALL_PKG_CONFIG == 'ON' && inputs.IMATH_BUILD_APPLE_FRAMEWORKS != 'ON'
+        run: |
+          set -x
+          share/ci/scripts/validate_pkgconfig.sh $INSTALL_DIR Imath share/ci/src/Imath.pc/Imath.pc.cpp
+
 
+      - name: Test PyImath.pc
+        # Validate that PyImath.pc works by compiling/linking the test program
+        if: runner.os != 'Windows' && inputs.IMATH_INSTALL_PKG_CONFIG == 'ON' && inputs.PYTHON == 'ON' && inputs.IMATH_TEST_PYTHON == 'ON' && inputs.IMATH_BUILD_APPLE_FRAMEWORKS != 'ON'
+        run: |
+          set -x
+          share/ci/scripts/validate_pkgconfig.sh $INSTALL_DIR PyImath share/ci/src/PyImath.pc/PyImath.pc.cpp
+        shell: bash

share/ci/scripts/validate_pkgconfig.sh

@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright Contributors to the OpenEXR Project.
+
+#
+# Validate that the given source file compiles and links with the
+# given pkg-config file.
+#
+# First argument is the directory where Imath is installed
+# Second argument is the pkg name, i.e. Imath or PyImath
+# Third argument is the test program source 
+#
+
+set -x
+
+if [ "$#" -ne 3 ]; then
+    echo "Error: Expected 4 arguments, got $#." >&2
+    echo "Usage: $0 <install dir> <pc file> <src file>" >&2
+    exit 1
+fi
+
+INSTALL=$1
+PKG=$2
+SRC=$3
+
+export PKG_CONFIG_PATH=$INSTALL/lib/pkgconfig
+cflags=$(pkg-config --cflags $PKG)
+libs=$(pkg-config --libs $PKG)
+bin=$SRC.bin
+g++ -std=c++17 $cflags $SRC $libs -o $bin -Wl,-rpath,$INSTALL/lib
+./$bin

share/ci/src/fetch/fetch.cpp share/ci/src/Imath.pc/Imath.pc.cppshare/ci/src/fetch/fetch.cpp renamed to share/ci/src/Imath.pc/Imath.pc.cpp

@@ -4,9 +4,8 @@
 //
 
 //
-// A simple program for use in validating that Imath's configuration properly
-// exports the information require by downstream projects using Imath via
-// CMake's FetchContent
+// A simple program for use in validating that Imath.pc is configured
+// properly.
 //
 
 #include <ImathConfig.h>
@@ -20,7 +19,7 @@ main (int argc, char* argv[])
 
     V2f v(0);
 
-    std::cout << "ImathFetchTest: v=" << v << std::endl;
+    std::cout << argv[0] << ": ok" << std::endl;
 
     return 0;
 }

share/ci/src/PyImath.pc/PyImath.pc.cpp

@@ -0,0 +1,24 @@
+//
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright Contributors to the OpenEXR Project.
+//
+
+//
+// A simple program for use in validating that PyImath.pc is
+// configured properly.
+//
+
+#include <PyImathStringTable.h>
+#include <PyImath.h>
+
+int
+main (int argc, char* argv[])
+{
+    Py_Initialize();
+
+    PyImath::StringTable st;
+
+    std::cout << argv[0] << ": ok" << std::endl;
+    
+    return 0;
+}

share/ci/src/fetch/CMakeLists.txt

@@ -289,10 +289,26 @@ if (IMATH_INSTALL)
     set(exec_prefix "\${prefix}")
     set(libdir "\${exec_prefix}/${CMAKE_INSTALL_LIBDIR}")
     set(includedir "\${prefix}/${CMAKE_INSTALL_INCLUDEDIR}")
+    string(TOUPPER "${CMAKE_BUILD_TYPE}" uppercase_CMAKE_BUILD_TYPE)
+    set(lib_suffix "${IMATH_LIB_SUFFIX}${CMAKE_${uppercase_CMAKE_BUILD_TYPE}_POSTFIX}")
+    set(pylib_suffix "${PYIMATH_LIB_SUFFIX}${CMAKE_${uppercase_CMAKE_BUILD_TYPE}_POSTFIX}")
+
+    # boost lib/dir
+    set(BOOST_PYTHON_LOCATION ${Boost_PYTHON_LIBRARY_RELEASE})
+    get_filename_component(boost_libdir "${BOOST_PYTHON_LOCATION}" DIRECTORY)
+    get_filename_component(boost_libname "${BOOST_PYTHON_LOCATION}" NAME_WE)
+    string(REGEX REPLACE "^lib" "" boost_libname "${boost_libname}")
+
+    # python lib/dir
+    get_filename_component(python_libdir "${Python3_LIBRARIES}" DIRECTORY)
+    set(python_libname "python${Python3_VERSION_MAJOR}.${Python3_VERSION_MINOR}")
+
     string(REPLACE ".in" "" pcout ${pcinfile})
     configure_file(${pcinfile} ${CMAKE_CURRENT_BINARY_DIR}/${pcout} @ONLY)
+
     install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${pcout} DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig)
-    message(STATUS "generating ${pcout}") 
+
+    message(STATUS "generating ${pcout}")
   else()
     message(STATUS "pkg-config generation disabled for PyImath")
   endif()

src/python/PyImath/CMakeLists.txt

@@ -7,10 +7,19 @@ prefix=@prefix@
 exec_prefix=@exec_prefix@
 libdir=@libdir@
 includedir=@includedir@
-libsuffix=@LIB_SUFFIX_DASH@
+libsuffix=@lib_suffix@
+pylibsuffix=@pylib_suffix@
+
+boost_includedir=@Boost_INCLUDE_DIRS@
+boost_libdir=@boost_libdir@
+boost_libname=@boost_libname@
+
+python_includedir=@Python3_INCLUDE_DIRS@
+python_libdir=@python_libdir@
+python_libname=@python_libname@
 
 Name: PyImath
-Description: Python bindings for the Imath libraries
+Description: Python wrappings of Imath classes/functions
 Version: @IMATH_VERSION@
-Libs: -L${libdir} -lImath${libsuffix} -lPyImath@PYIMATH_LIB_PYTHONVER_ROOT@@Python3_VERSION_MAJOR@_@Python3_VERSION_MINOR@${libsuffix}
-Cflags: -I${includedir} -I${includedir}/Imath
+Libs: -L${libdir} -lImath${libsuffix} -lPyImath${pylibsuffix} -L${boost_libdir} -l${boost_libname} -L${python_libdir} -l${python_libname}
+Cflags: -I${includedir} -I${includedir}/@IMATH_OUTPUT_SUBDIR@ -I${includedir}/@PYIMATH_OUTPUT_SUBDIR@ -I${boost_includedir} -I${python_includedir}