ci: Improved clang-format CI task

Old: Do a build with target 'clang-format', relying on our build
system.  But that means that we need to do the cmake config step, and
need a bunch of dependencies set up so that the config doesn't fail.

New: Make a new run-clang-format.bash utility to issue the commands
for the right files. No "build" is requred, and the only dependencies
we need are the minimum it takes to run clang-format itself.

Also, I noticed that we never had been clang-format testing the .cpp
and .h files in the testsuite itself. So enable that now, and commit
the small amount of reformatting that it identified.

These changes reduce the approximate total elapsed time of a CI
clang-format job from nearly 7:00 to 0:35.

Signed-off-by: Larry Gritz <[email protected]>

Author: lgritz

.github/workflows/build-steps.yml

@@ -52,6 +52,8 @@ on:
         type: string
       build_docs:
         type: string
+      clang_format:
+        type: string
       generator:
         type: string
       ctest_args:
@@ -144,6 +146,10 @@ jobs:
         if: inputs.skip_tests != '1'
         shell: bash
         run: src/build-scripts/ci-test.bash
+      - name: clang-format
+        if: inputs.clang_format == '1'
+        shell: bash
+        run: src/build-scripts/run-clang-format.bash
       - name: Code coverage
         if: inputs.coverage == '1'
         run: src/build-scripts/ci-coverage.bash

.github/workflows/ci.yml

@@ -267,6 +267,7 @@ jobs:
       skip_tests: ${{ matrix.skip_tests }}
       abi_check: ${{ matrix.abi_check }}
       build_docs: ${{ matrix.build_docs }}
+      clang_format: ${{ matrix.clang_format }}
       generator: ${{ matrix.generator }}
       ctest_args: ${{ matrix.ctest_args }}
       ctest_test_timeout: ${{ matrix.ctest_test_timeout }}
@@ -367,24 +368,25 @@ jobs:
             setenvs: export OIIO_CMAKE_FLAGS="-DOIIO_BUILD_TOOLS=0 -DOIIO_BUILD_TESTS=0 -DUSE_PYTHON=0"
                             USE_OPENCV=0 USE_FFMPEG=0 USE_PYTHON=0 USE_FREETYPE=0
 
-          # Test formatting. This test entry doesn't do a full build, it
+          # Test formatting. This test entry doesn't build at all, it
           # just runs clang-format on everything, and passes if nothing is
           # misformatted. Upon failure, the build artifact will be the full
           # source code with the formatting fixed (diffs will also appear in
           # the console output).
           - desc: "clang-format"
             nametag: clang-format
-            runner: ubuntu-latest
+            runner: ubuntu-24.04
             cxx_std: 17
             extra_artifacts: "src/*.*"
-            openexr_ver: v3.1.13
             python_ver: "3.10"
+            pybind11_ver: "0"
+            clang_format: 1
+            skip_build: 1
             skip_tests: 1
-            setenvs: export BUILDTARGET=clang-format
-                            OIIO_CMAKE_FLAGS=-DUSE_PYTHON=0
-                            LLVM_VERSION=17.0.6 LLVM_DISTRO_NAME=ubuntu-22.04
-                            SKIP_SYSTEM_DEPS_INSTALL=1 QT_VERSION=0
-                            OpenImageIO_OPTIONAL_DEPS=ALL
+            setenvs: export SKIP_SYSTEM_DEPS_INSTALL=1 SKIP_APT_GET_UPDATE=1
+                            INSTALL_OPENCV=0 QT_VERSION=0 USE_LIBHEIF=0
+                            EXTRA_DEP_PACKAGES="clang-format-17"
+                            CLANG_FORMAT_EXE=clang-format-17
 
           - desc: latest releases gcc13 C++20 py3.12 avx2 exr3.3 ocio2.4
             nametag: linux-latest-releases

src/build-scripts/gh-installdeps.bash

@@ -86,12 +86,11 @@ else
         time sudo apt-get update
     fi
 
-    time sudo apt-get -q install -y \
-        git cmake ninja-build ccache g++ \
-        libilmbase-dev libopenexr-dev \
-        libtiff-dev libgif-dev libpng-dev
     if [[ "${SKIP_SYSTEM_DEPS_INSTALL}" != "1" ]] ; then
         time sudo apt-get -q install -y --fix-missing \
+            git cmake ccache \
+            ninja-build g++ libilmbase-dev libopenexr-dev \
+            libtiff-dev libgif-dev libpng-dev \
             libraw-dev libwebp-dev \
             libavcodec-dev libavformat-dev libswscale-dev libavutil-dev \
             dcmtk libopenvdb-dev \
@@ -112,7 +111,9 @@ else
         time sudo apt-get -q install -y ${EXTRA_DEP_PACKAGES}
     fi
 
-    time sudo apt-get -q install -y python3-numpy
+    if [[ "${USE_PYTHON}" != "0" ]] ; then
+        time sudo apt-get -q install -y python3-numpy
+    fi
     if [[ "${PIP_INSTALLS}" != "" ]] ; then
         time pip3 install ${PIP_INSTALLS}
     fi
@@ -158,7 +159,9 @@ fi
 # Packages we need to build from scratch.
 #
 
-source src/build-scripts/build_pybind11.bash
+if [[ "$PYBIND11_VERSION" != "0" ]] ; then
+    source src/build-scripts/build_pybind11.bash
+fi
 
 if [[ "$OPENEXR_VERSION" != "" ]] ; then
     source src/build-scripts/build_openexr.bash

src/build-scripts/run-clang-format.bash

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+# Copyright Contributors to the OpenImageIO project.
+# SPDX-License-Identifier: Apache-2.0
+# https://github.com/AcademySoftwareFoundation/OpenImageIO
+
+# Important: set -ex causes this whole script to terminate with error if
+# any command in it fails. This is crucial for CI tests.
+set -ex
+
+CLANG_FORMAT_EXE=${CLANG_FORMAT_EXE:="clang-format"}
+echo "Running " `which clang-format` " version " `${CLANG_FORMAT_EXE} --version`
+
+files=`find ./{src,testsuite} \( -name '*.h' -o -name '*.cpp' \) -print \
+       | grep -Ev 'pugixml|SHA1|farmhash.cpp|libdpx|libcineon|bcdec.h|gif.h|stb_sprintf.h'`
+
+
+${CLANG_FORMAT_EXE}  -i -style=file $files
+git diff --color
+THEDIFF=`git diff`
+if [[ "$THEDIFF" != "" ]] ; then
+    echo "git diff was not empty. Failing clang-format check."
+    exit 1
+fi

src/cmake/compiler.cmake

@@ -568,7 +568,7 @@ endif ()
 # is being built as a subproject.
 if (PROJECT_IS_TOP_LEVEL)
     set (CLANG_FORMAT_EXE_HINT "" CACHE PATH "clang-format executable's directory (will search if not specified")
-    set (CLANG_FORMAT_INCLUDES "src/*.h" "src/*.cpp"
+    set (CLANG_FORMAT_INCLUDES "src/*.h" "src/*.cpp testsuite/*.cpp testsuite/*.h"
         CACHE STRING "Glob patterns to include for clang-format")
     set (CLANG_FORMAT_EXCLUDES "*pugixml*" "*SHA1*" "*/farmhash.cpp"
                                "src/dpx.imageio/libdpx/*"

testsuite/docs-examples-cpp/src/docs-examples-imagebuf.cpp

@@ -14,7 +14,8 @@
 #include <OpenImageIO/imageio.h>
 using namespace OIIO;
 
-void example1()
+void
+example1()
 {
     //
     // Example code fragment from the docs goes here.
@@ -32,7 +33,8 @@ void example1()
 
 
 
-int main(int /*argc*/, char** /*argv*/)
+int
+main(int /*argc*/, char** /*argv*/)
 {
     // Each example function needs to get called here, or it won't execute
     // as part of the test.