Pybind11 and python unit tests (#354) #708
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # SPDX-License-Identifier: BSD-3-Clause | |
| # Copyright Contributors to the OpenEXR Project. | |
| # | |
| # GitHub Actions workflow file | |
| # https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions | |
| name: CI | |
| on: | |
| push: | |
| # Jobs are skipped when ONLY Markdown (*.md) files are changed | |
| paths-ignore: | |
| - '**.md' | |
| pull_request: | |
| paths-ignore: | |
| - '**.md' | |
| permissions: | |
| contents: read | |
| jobs: | |
| # Linux jobs run in Docker containers, so the latest OS version is OK. macOS | |
| # and Windows jobs need to be locked to specific virtual environment | |
| # versions to mitigate issues from OS updates, and will require maintenance | |
| # as OS versions are retired. | |
| # | |
| # GH Actions (Free plan) supports 20 concurrent jobs, with 5 concurrent macOS | |
| # jobs. This workflow tries to utilize (but not exceed) that budget to | |
| # promote timely CI. | |
| # --------------------------------------------------------------------------- | |
| # Linux | |
| # --------------------------------------------------------------------------- | |
| # TODO: Add ARM build. Add sanitize build. | |
| linux: | |
| name: 'Linux CentOS 7 VFX CY${{ matrix.vfx-cy }} | |
| <${{ matrix.compiler-desc }} , | |
| ${{ matrix.python-desc }}, | |
| config=${{ matrix.build-type }}, | |
| shared=${{ matrix.build-shared }}, | |
| cxx=${{ matrix.cxx-standard }}>' | |
| # GH-hosted VM. The build runs in CentOS 7 'container' defined below. | |
| runs-on: ubuntu-latest | |
| container: | |
| # DockerHub: https://hub.docker.com/u/aswf | |
| # Source: https://github.com/AcademySoftwareFoundation/aswf-docker | |
| image: aswf/ci-openexr:${{ matrix.vfx-cy }} | |
| strategy: | |
| matrix: | |
| build: [1, 2, 3, 4, 5, 6, 7, 8, 9] | |
| include: | |
| # ------------------------------------------------------------------- | |
| # GCC, VFX CY2023 | |
| # ------------------------------------------------------------------- | |
| # C++17, Python 3.10.9 | |
| - build: 1 | |
| build-type: Release | |
| build-shared: 'ON' | |
| cxx-standard: 17 | |
| cxx-compiler: g++ | |
| cc-compiler: gcc | |
| compiler-desc: gcc11.2.1 | |
| python: 'ON' | |
| python-desc: python3.10.9 | |
| vfx-cy: 2023 | |
| # C++17, Python 3.10.9, Debug | |
| - build: 2 | |
| build-type: Debug | |
| build-shared: 'ON' | |
| cxx-standard: 17 | |
| cxx-compiler: g++ | |
| cc-compiler: gcc | |
| compiler-desc: gcc11.2.1 | |
| python: 'ON' | |
| python-desc: python3.10.9 | |
| vfx-cy: 2023 | |
| # C++17, Python 3.10.9, Static | |
| - build: 3 | |
| build-type: Release | |
| build-shared: 'OFF' | |
| cxx-standard: 17 | |
| cxx-compiler: g++ | |
| cc-compiler: gcc | |
| compiler-desc: gcc11.2.1 | |
| python: 'ON' | |
| python-desc: python3.10.9 | |
| vfx-cy: 2023 | |
| # C++14, Python 3.10.9 | |
| - build: 4 | |
| build-type: Release | |
| build-shared: 'ON' | |
| cxx-standard: 14 | |
| cxx-compiler: g++ | |
| cc-compiler: gcc | |
| compiler-desc: gcc11.2.1 | |
| python: 'ON' | |
| python-desc: python3.10.9 | |
| vfx-cy: 2023 | |
| # ------------------------------------------------------------------- | |
| # Clang 15.0, VFX CY2023 | |
| # ------------------------------------------------------------------- | |
| # C++17, Python 3.10.9 | |
| - build: 5 | |
| build-type: Release | |
| build-shared: 'ON' | |
| cxx-standard: 17 | |
| cxx-compiler: clang++ | |
| cc-compiler: clang | |
| compiler-desc: clang15.0 | |
| python: 'ON' | |
| python-desc: python3.10.9 | |
| vfx-cy: 2023 | |
| # ------------------------------------------------------------------- | |
| # Clang 14.0, VFX CY2023 | |
| # ------------------------------------------------------------------- | |
| # C++17, Python 3.10.9 | |
| - build: 6 | |
| build-type: Release | |
| build-shared: 'ON' | |
| cxx-standard: 17 | |
| cxx-compiler: clang++ | |
| cc-compiler: clang | |
| compiler-desc: clang14.0 | |
| python: 'ON' | |
| python-desc: python3.10.9 | |
| vfx-cy: 2023 | |
| # ------------------------------------------------------------------- | |
| # GCC, VFX CY2022 | |
| # ------------------------------------------------------------------- | |
| # C++17, Python 3.9 | |
| - build: 7 | |
| build-type: Release | |
| build-shared: 'ON' | |
| cxx-standard: 17 | |
| cxx-compiler: g++ | |
| cc-compiler: gcc | |
| compiler-desc: gcc9.3.1 | |
| python: 'ON' | |
| python-desc: python3.9.7 | |
| vfx-cy: 2022 | |
| # ------------------------------------------------------------------- | |
| # GCC, VFX CY2021 | |
| # ------------------------------------------------------------------- | |
| # C++17, Python 3.7.9 | |
| - build: 8 | |
| build-type: Release | |
| build-shared: 'ON' | |
| cxx-standard: 17 | |
| cxx-compiler: g++ | |
| cc-compiler: gcc | |
| compiler-desc: gcc9.3.1 | |
| python: 'ON' | |
| python-desc: python3.7.9 | |
| vfx-cy: 2021 | |
| # ------------------------------------------------------------------- | |
| # GCC, VFX CY2020 | |
| # ------------------------------------------------------------------- | |
| # C++14, Python 3.7 | |
| - build: 9 | |
| build-type: Release | |
| build-shared: 'ON' | |
| cxx-standard: 14 | |
| cxx-compiler: g++ | |
| cc-compiler: gcc | |
| compiler-desc: gcc6.3.1 | |
| python: 'ON' | |
| python-desc: python3.7.3 | |
| vfx-cy: 2020 | |
| env: | |
| CXX: ${{ matrix.cxx-compiler }} | |
| CC: ${{ matrix.cc-compiler }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v2 | |
| - name: Create build directories | |
| run: | | |
| mkdir _install | |
| mkdir _build | |
| mkdir _examples | |
| - name: Configure | |
| run: | | |
| cmake .. \ | |
| -DCMAKE_INSTALL_PREFIX=../_install \ | |
| -DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \ | |
| -DCMAKE_CXX_STANDARD=${{ matrix.cxx-standard }} \ | |
| -DCMAKE_CXX_FLAGS=${{ matrix.cxx-flags }} \ | |
| -DCMAKE_VERBOSE_MAKEFILE:BOOL='OFF' \ | |
| -DBUILD_SHARED_LIBS=${{ matrix.build-shared }} \ | |
| -DPYTHON=${{ matrix.python }} \ | |
| -DUSE_PYTHON2=${{ matrix.use-python2 }} | |
| working-directory: _build | |
| - name: Build | |
| run: | | |
| cmake --build . \ | |
| --target install \ | |
| --config ${{ matrix.build-type }} | |
| working-directory: _build | |
| - name: Examples | |
| run: | | |
| # Confirm the python module loads. Query the site-packages directory and substitute ../_install | |
| export PYTHONPATH=`python -c "import site; print('../_install%s' % site.USER_SITE[len(site.USER_BASE):])"` | |
| python -c "import imath;print(imath.__version__)" | |
| # Make sure we can build the tests when configured as a | |
| # standalone application linking against the just-installed | |
| # Imath library. | |
| cmake ../src/ImathTest \ | |
| -DCMAKE_PREFIX_PATH=../../_install \ | |
| -DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \ | |
| -DCMAKE_CXX_STANDARD=${{ matrix.cxx-standard }} \ | |
| -DCMAKE_CXX_FLAGS=${{ matrix.cxx-flags }} | |
| cmake --build . \ | |
| --config ${{ matrix.build-type }} | |
| # Confirm the tests run | |
| ./bin/ImathTest | |
| # Confirm the examples compile and execute | |
| rm -rf bin CMakeCache.txt CMakeFiles cmake_install.cmake Makefile | |
| cmake ../website/examples \ | |
| -DCMAKE_PREFIX_PATH=../../_install \ | |
| -DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \ | |
| -DCMAKE_CXX_STANDARD=${{ matrix.cxx-standard }} \ | |
| -DCMAKE_CXX_FLAGS=${{ matrix.cxx-flags }} | |
| cmake --build . \ | |
| --config ${{ matrix.build-type }} | |
| ctest | |
| working-directory: _examples | |
| - name: Test | |
| run: | | |
| ctest -T Test ${{ matrix.exclude-tests }} \ | |
| -C ${{ matrix.build-type }} \ | |
| --timeout 7200 \ | |
| --output-on-failure \ | |
| -VV | |
| working-directory: _build | |
| # --------------------------------------------------------------------------- | |
| # macOS | |
| # --------------------------------------------------------------------------- | |
| macos_no_python: | |
| name: 'macOS VFXP-${{matrix.vfx-cy }} macos-${{ matrix.osver }} | |
| <AppleClang 11.0 | |
| config=${{ matrix.build-type }}, | |
| shared=${{ matrix.build-shared }}, | |
| cxx=${{ matrix.cxx-standard }}' | |
| runs-on: macos-${{ matrix.osver }} | |
| strategy: | |
| matrix: | |
| build: [1, 2, 3, 4, 5, 6] | |
| include: | |
| # -------------------------------------------------------------------- | |
| # VFX CY2023 - MacOS 11.0 | |
| # -------------------------------------------------------------------- | |
| # C++11 | |
| - build: 1 | |
| build-type: Release | |
| build-shared: 'ON' | |
| cxx-standard: 17 | |
| exclude-tests: | |
| osver: 11.0 | |
| # Debug | |
| - build: 2 | |
| build-type: Debug | |
| build-shared: 'ON' | |
| cxx-standard: 17 | |
| exclude-tests: | |
| osver: 11.0 | |
| # Static | |
| - build: 3 | |
| build-type: Debug | |
| build-shared: 'OFF' | |
| cxx-standard: 17 | |
| exclude-tests: | |
| osver: 11.0 | |
| # C++14 | |
| - build: 4 | |
| build-type: Release | |
| build-shared: 'ON' | |
| cxx-standard: 14 | |
| exclude-tests: | |
| osver: 11.0 | |
| # C++11 | |
| - build: 5 | |
| build-type: Release | |
| build-shared: 'ON' | |
| cxx-standard: 11 | |
| exclude-tests: | |
| osver: 11.0 | |
| # -------------------------------------------------------------------- | |
| # VFX CY2022 - MacOS 12 | |
| # -------------------------------------------------------------------- | |
| # C++11 | |
| - build: 6 | |
| build-type: Release | |
| build-shared: 'ON' | |
| cxx-standard: 17 | |
| exclude-tests: | |
| osver: 12.0 | |
| steps: | |
| ## - name: Setup Python | |
| ## uses: actions/setup-python@v1 | |
| ## with: | |
| ## python-version: ${{ matrix.python-version }} | |
| - name: Checkout | |
| uses: actions/checkout@v2 | |
| - name: Create build directories | |
| run: | | |
| mkdir _install | |
| mkdir _build | |
| mkdir _examples | |
| ## - name: Install Dependences | |
| ## run: | | |
| ## share/ci/scripts/macos/install_boost.sh | |
| ## shell: bash | |
| - name: Configure | |
| run: | | |
| cmake ../. \ | |
| -DCMAKE_INSTALL_PREFIX=../_install \ | |
| -DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \ | |
| -DCMAKE_CXX_STANDARD=${{ matrix.cxx-standard }} \ | |
| -DCMAKE_CXX_FLAGS=${{ matrix.cxx-flags }} \ | |
| -DCMAKE_VERBOSE_MAKEFILE:BOOL='OFF' \ | |
| -DBUILD_SHARED_LIBS=${{ matrix.build-shared }} | |
| working-directory: _build | |
| - name: Build | |
| run: | | |
| cmake --build . \ | |
| --target install \ | |
| --config ${{ matrix.build-type }} \ | |
| -- -j2 | |
| working-directory: _build | |
| - name: Examples | |
| run: | | |
| # Make sure we can build the tests when configured as a | |
| # standalone application linking against the just-installed | |
| # Imath library. | |
| cmake ../src/ImathTest \ | |
| -DCMAKE_PREFIX_PATH=../../_install \ | |
| -DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \ | |
| -DCMAKE_CXX_STANDARD=${{ matrix.cxx-standard }} \ | |
| -DCMAKE_CXX_FLAGS=${{ matrix.cxx-flags }} | |
| cmake --build . \ | |
| --config ${{ matrix.build-type }} | |
| # Confirm the tests run | |
| ./bin/ImathTest | |
| working-directory: _examples | |
| - name: Test | |
| run: | | |
| ctest -T Test ${{matrix.exclude-tests }} \ | |
| -C ${{matrix.build-type}} \ | |
| --timeout 7200 \ | |
| --output-on-failure \ | |
| -VV | |
| working-directory: _build | |
| # --------------------------------------------------------------------------- | |
| # Windows | |
| # --------------------------------------------------------------------------- | |
| # TODO: Figure out how to get CMake to use Python 3.7.7. | |
| # Boost 1.70.0 will only make boost python for 3.7. | |
| # CMake finds Python 3.8 on the VM when configuring, then does not find | |
| # a corresponding boost python38 module. | |
| # TODO: Determine why tests hang in Debug job. | |
| # TODO: Fix boost script to install from sourceforge. | |
| windows: | |
| name: 'Windows VFXP-${{ matrix.vfx-cy }} | |
| <${{ matrix.compiler-desc }}, | |
| config=${{ matrix.build-type }}, | |
| shared=${{ matrix.build-shared }}, | |
| cxx=${{ matrix.cxx-standard }}, | |
| python=OFF>' | |
| runs-on: windows-${{ matrix.osver }} | |
| strategy: | |
| matrix: | |
| build: [1, 3, 4, 6, 7, 8] | |
| include: | |
| # ------------------------------------------------------------------- | |
| # VFX CY2023 - C++17 - Windows 2022 runner - MSVC 2022 (17.5) | |
| # ------------------------------------------------------------------- | |
| # C++17, Release Shared | |
| - build: 1 | |
| build-type: Release | |
| build-shared: 'ON' | |
| compiler-desc: msvc17.5 | |
| cxx-standard: 17 | |
| vfx-cy: 2023 | |
| exclude-tests: | |
| osver: 2022 | |
| # C++17, Debug - | |
| ## - build: 2 | |
| ## build-type: Debug | |
| ## build-shared: 'ON' | |
| ## cxx-standard: 17 | |
| ## exclude-tests: | |
| # C++17, Release Static | |
| - build: 3 | |
| build-type: Release | |
| build-shared: 'OFF' | |
| compiler-desc: msvc17.5 | |
| cxx-standard: 17 | |
| vfx-cy: 2023 | |
| exclude-tests: | |
| osver: 2022 | |
| # ------------------------------------------------------------------- | |
| # VFX CY2022 - C++17 - Windows 2019 | |
| # ------------------------------------------------------------------- | |
| # C++17, Release Shared | |
| - build: 4 | |
| build-type: Release | |
| build-shared: 'ON' | |
| compiler-desc: msvc16.11 | |
| cxx-standard: 17 | |
| vfx-cy: 2022 | |
| exclude-tests: | |
| osver: 2019 | |
| # C++17, Debug - | |
| ## - build: 5 | |
| ## build-type: Debug | |
| ## build-shared: 'ON' | |
| ## cxx-standard: 17 | |
| ## exclude-tests: | |
| # C++17, Release Static | |
| - build: 6 | |
| build-type: Release | |
| build-shared: 'OFF' | |
| compiler-desc: msvc16.11 | |
| cxx-standard: 17 | |
| vfx-cy: 2022 | |
| exclude-tests: | |
| osver: 2019 | |
| # ------------------------------------------------------------------- | |
| # VFX CY2020 - C++14 - Windows 2019 | |
| # ------------------------------------------------------------------- | |
| # C++14, Release Shared | |
| - build: 7 | |
| build-type: Release | |
| build-shared: 'ON' | |
| compiler-desc: msvc16.11 | |
| cxx-standard: 14 | |
| vfx-cy: 2020 | |
| exclude-tests: | |
| osver: 2019 | |
| # ------------------------------------------------------------------- | |
| # VFX CY2019 - C++11 - Windows 2019 | |
| # ------------------------------------------------------------------- | |
| # C++11, Release Shared | |
| - build: 8 | |
| build-type: Release | |
| build-shared: 'ON' | |
| compiler-desc: msvc16.11 | |
| cxx-standard: 11 | |
| exclude-tests: | |
| osver: 2019 | |
| steps: | |
| # - name: Setup Python | |
| # uses: actions/setup-python@v1 | |
| # with: | |
| # python-version: ${{ matrix.python-version }} | |
| - name: Checkout | |
| uses: actions/checkout@v2 | |
| - name: Create build directories | |
| run: | | |
| mkdir _install | |
| mkdir _build | |
| shell: bash | |
| # - name: Install Dependences | |
| # run: | | |
| # share/ci/scripts/windows/install_python.ps1 ${{ matrix.python-version }} $HOME | |
| # share/ci/scripts/windows/install_boost.ps1 ${{ matrix.boost-version }} $HOME 3.8 | |
| # shell: powershell | |
| - name: Configure | |
| run: | | |
| cmake ../. \ | |
| -DCMAKE_INSTALL_PREFIX=../_install \ | |
| -DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \ | |
| -DCMAKE_CXX_STANDARD=${{ matrix.cxx-standard }} \ | |
| -DCMAKE_CXX_FLAGS=${{ matrix.cxx-flags }} \ | |
| -DCMAKE_VERBOSE_MAKEFILE:BOOL='OFF' \ | |
| -DBUILD_SHARED_LIBS=${{ matrix.build-shared }} | |
| # NB: removed trailing slash from these lines | |
| # -DBOOST_ROOT:FILEPATH=$BOOST_ROOT | |
| # -DPYTHON='ON' | |
| # -DPython_EXECUTABLE:FILEPATH="$PYTHON_ROOT" | |
| # -DPython_INCLUDE_DIR:FILEPATH="$PYTHON_ROOT/include" | |
| # -DPython_LIBRARY:"$PYTHON_ROOT\libs" | |
| shell: bash | |
| working-directory: _build | |
| - name: Build | |
| run: | | |
| cmake --build . \ | |
| --target install \ | |
| --config ${{ matrix.build-type }} | |
| shell: bash | |
| working-directory: _build | |
| - name: Test | |
| run: | | |
| ctest -T Test ${{ matrix.exclude-tests }} \ | |
| -C ${{ matrix.build-type }} \ | |
| --timeout 7200 \ | |
| --output-on-failure \ | |
| -VV | |
| shell: bash | |
| working-directory: _build | |
| Website: | |
| # Build the documentation, using a process that mimics the readthedoc build. | |
| # | |
| # Note that this job does not actually build Imath libraries, | |
| # it just runs doxygen and sphinx. | |
| name: 'Website' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Create build directory | |
| run: mkdir _build | |
| - name: Install doxygen | |
| # Need help2man for tool manpages | |
| run: sudo apt-get install -y doxygen help2man | |
| - name: Install sphinx requirements | |
| run: pip3 install -r website/requirements.txt | |
| - name: Configure | |
| run: cmake .. -DBUILD_WEBSITE='ON' | |
| working-directory: _build | |
| - name: Build | |
| run: | | |
| cmake --build . \ | |
| --target website \ | |
| --config Release | |
| working-directory: _build | |