ci/ci_verify_cmake.sh

   1 #!/usr/bin/env bash
   2 set -e
   3
   4 # ci_verify_cmake.sh
   5 # Continuously integrate libpng using CMake.
   6 #
   7 # Copyright (c) 2019-2023 Cosmin Truta.
   8 #
   9 # This software is released under the libpng license.
  10 # For conditions of distribution and use, see the disclaimer
  11 # and license in png.h.
  12
  13 CI_SCRIPTNAME="$(basename "$0")"
  14 CI_SCRIPTDIR="$(cd "$(dirname "$0")" && pwd)"
  15 CI_SRCDIR="$(dirname "$CI_SCRIPTDIR")"
  16 CI_BUILDDIR="$CI_SRCDIR/out/ci_verify_cmake.build"
  17 CI_INSTALLDIR="$CI_SRCDIR/out/ci_verify_cmake.install"
  18
  19 # Keep the following relative paths in sync with the absolute paths.
  20 # We use them for the benefit of native Windows tools that might be
  21 # otherwise confused by the path encoding used by Bash-on-Windows.
  22 CI_SRCDIR_FROM_BUILDDIR="../.."
  23 CI_INSTALLDIR_FROM_BUILDDIR="../ci_verify_cmake.install"
  24
  25 function ci_info {
  26     printf >&2 "%s: %s\\n" "$CI_SCRIPTNAME" "$*"
  27 }
  28
  29 function ci_err {
  30     printf >&2 "%s: error: %s\\n" "$CI_SCRIPTNAME" "$*"
  31     exit 2
  32 }
  33
  34 function ci_spawn {
  35     printf >&2 "%s: executing:" "$CI_SCRIPTNAME"
  36     printf >&2 " %q" "$@"
  37     printf >&2 "\\n"
  38     "$@"
  39 }
  40
  41 function ci_init_cmake_build {
  42     CI_SYSTEM_NAME="$(uname -s)"
  43     CI_MACHINE_NAME="$(uname -m)"
  44     CI_CMAKE="${CI_CMAKE:-cmake}"
  45     CI_CTEST="${CI_CTEST:-ctest}"
  46     CI_CMAKE_BUILD_TYPE="${CI_CMAKE_BUILD_TYPE:-Release}"
  47     [[ -x $(command -v ninja) ]] &&
  48         CI_CMAKE_GENERATOR="${CI_CMAKE_GENERATOR:-Ninja}"
  49     if [[ $CI_CMAKE_GENERATOR == "Visual Studio"* ]]
  50     then
  51         # Clean up incidental mixtures of Windows and Bash-on-Windows
  52         # environment variables, to avoid confusing MSBuild.
  53         [[ $TEMP && ( $Temp || $temp ) ]] && unset TEMP
  54         [[ $TMP && ( $Tmp || $tmp ) ]] && unset TMP
  55         # Ensure that CI_CMAKE_GENERATOR_PLATFORM is initialized for this generator.
  56         [[ $CI_CMAKE_GENERATOR_PLATFORM ]] ||
  57             ci_err "missing: \$CI_CMAKE_GENERATOR_PLATFORM"
  58     fi
  59 }
  60
  61 function ci_trace_cmake_build {
  62     ci_info "## START OF CONFIGURATION ##"
  63     ci_info "system name: $CI_SYSTEM_NAME"
  64     ci_info "machine hardware name: $CI_MACHINE_NAME"
  65     ci_info "source directory: $CI_SRCDIR"
  66     ci_info "build directory: $CI_BUILDDIR"
  67     ci_info "install directory: $CI_INSTALLDIR"
  68     ci_info "environment option: \$CI_CMAKE: '$CI_CMAKE'"
  69     ci_info "environment option: \$CI_CMAKE_GENERATOR: '$CI_CMAKE_GENERATOR'"
  70     ci_info "environment option: \$CI_CMAKE_GENERATOR_PLATFORM: '$CI_CMAKE_GENERATOR_PLATFORM'"
  71     ci_info "environment option: \$CI_CMAKE_BUILD_TYPE: '$CI_CMAKE_BUILD_TYPE'"
  72     ci_info "environment option: \$CI_CMAKE_BUILD_FLAGS: '$CI_CMAKE_BUILD_FLAGS'"
  73     ci_info "environment option: \$CI_CMAKE_TOOLCHAIN_FILE: '$CI_CMAKE_TOOLCHAIN_FILE'"
  74     ci_info "environment option: \$CI_CMAKE_VARS: '$CI_CMAKE_VARS'"
  75     ci_info "environment option: \$CI_CTEST: '$CI_CTEST'"
  76     ci_info "environment option: \$CI_CTEST_FLAGS: '$CI_CTEST_FLAGS'"
  77     ci_info "environment option: \$CI_CC: '$CI_CC'"
  78     ci_info "environment option: \$CI_CC_FLAGS: '$CI_CC_FLAGS'"
  79     ci_info "environment option: \$CI_AR: '$CI_AR'"
  80     ci_info "environment option: \$CI_RANLIB: '$CI_RANLIB'"
  81     ci_info "environment option: \$CI_SANITIZERS: '$CI_SANITIZERS'"
  82     ci_info "environment option: \$CI_NO_TEST: '$CI_NO_TEST'"
  83     ci_info "environment option: \$CI_NO_INSTALL: '$CI_NO_INSTALL'"
  84     ci_info "environment option: \$CI_NO_CLEAN: '$CI_NO_CLEAN'"
  85     ci_info "executable: \$CI_CMAKE: $(command -V "$CI_CMAKE")"
  86     ci_info "executable: \$CI_CTEST: $(command -V "$CI_CTEST")"
  87     [[ $CI_CC ]] &&
  88         ci_info "executable: \$CI_CC: $(command -V "$CI_CC")"
  89     [[ $CI_AR ]] &&
  90         ci_info "executable: \$CI_AR: $(command -V "$CI_AR")"
  91     [[ $CI_RANLIB ]] &&
  92         ci_info "executable: \$CI_RANLIB: $(command -V "$CI_RANLIB")"
  93     ci_info "## END OF CONFIGURATION ##"
  94 }
  95
  96 function ci_cleanup_old_cmake_build {
  97     [[ ! -e $CI_BUILDDIR ]] ||
  98         ci_spawn rm -fr "$CI_BUILDDIR"
  99     [[ ! -e $CI_INSTALLDIR ]] ||
 100         ci_spawn rm -fr "$CI_INSTALLDIR"
 101 }
 102
 103 function ci_build_cmake {
 104     ci_info "## START OF BUILD ##"
 105     ci_spawn "$(command -v "$CI_CMAKE")" --version
 106     ci_spawn "$(command -v "$CI_CTEST")" --version
 107     [[ $CI_CMAKE_GENERATOR == *"Ninja"* ]] &&
 108         ci_spawn "$(command -v ninja)" --version
 109     # Initialize ALL_CC_FLAGS as a string.
 110     local ALL_CC_FLAGS="$CI_CC_FLAGS"
 111     [[ $CI_SANITIZERS ]] &&
 112         ALL_CC_FLAGS="-fsanitize=$CI_SANITIZERS $ALL_CC_FLAGS"
 113     # Initialize ALL_CMAKE_VARS, ALL_CMAKE_BUILD_FLAGS and ALL_CTEST_FLAGS as arrays.
 114     local ALL_CMAKE_VARS=()
 115     [[ $CI_CMAKE_TOOLCHAIN_FILE ]] &&
 116         ALL_CMAKE_VARS+=(-DCMAKE_TOOLCHAIN_FILE="$CI_CMAKE_TOOLCHAIN_FILE")
 117     [[ $CI_CC ]] &&
 118         ALL_CMAKE_VARS+=(-DCMAKE_C_COMPILER="$CI_CC")
 119     [[ $ALL_CC_FLAGS ]] &&
 120         ALL_CMAKE_VARS+=(-DCMAKE_C_FLAGS="$ALL_CC_FLAGS")
 121     [[ $CI_AR ]] &&
 122         ALL_CMAKE_VARS+=(-DCMAKE_AR="$CI_AR")
 123     [[ $CI_RANLIB ]] &&
 124         ALL_CMAKE_VARS+=(-DCMAKE_RANLIB="$CI_RANLIB")
 125     ALL_CMAKE_VARS+=(-DCMAKE_BUILD_TYPE="$CI_CMAKE_BUILD_TYPE")
 126     ALL_CMAKE_VARS+=(-DCMAKE_VERBOSE_MAKEFILE=ON)
 127     [[ $CI_NO_TEST ]] &&
 128         ALL_CMAKE_VARS+=(-DPNG_TESTS=OFF)
 129     ALL_CMAKE_VARS+=($CI_CMAKE_VARS)
 130     local ALL_CMAKE_BUILD_FLAGS=($CI_CMAKE_BUILD_FLAGS)
 131     local ALL_CTEST_FLAGS=($CI_CTEST_FLAGS)
 132     # Export the CMake environment variables.
 133     [[ $CI_CMAKE_GENERATOR ]] &&
 134         ci_spawn export CMAKE_GENERATOR="$CI_CMAKE_GENERATOR"
 135     [[ $CI_CMAKE_GENERATOR_PLATFORM ]] &&
 136         ci_spawn export CMAKE_GENERATOR_PLATFORM="$CI_CMAKE_GENERATOR_PLATFORM"
 137     # Build and install.
 138     # Use $CI_SRCDIR_FROM_BUILDDIR and $CI_INSTALLDIR_FROM_BUILDDIR
 139     # instead of $CI_SRCDIR and $CI_INSTALLDIR from this point onwards.
 140     ci_spawn mkdir -p "$CI_BUILDDIR"
 141     ci_spawn cd "$CI_BUILDDIR"
 142     [[ $CI_SRCDIR -ef $CI_SRCDIR_FROM_BUILDDIR ]] ||
 143         ci_err "assertion failed: testing: '$CI_SRCDIR' -ef '$CI_SRCDIR_FROM_BUILDDIR'"
 144     ci_spawn mkdir -p "$CI_INSTALLDIR"
 145     [[ $CI_INSTALLDIR -ef $CI_INSTALLDIR_FROM_BUILDDIR ]] ||
 146         ci_err "assertion failed: testing: '$CI_INSTALLDIR' -ef '$CI_INSTALLDIR_FROM_BUILDDIR'"
 147     ci_spawn "$CI_CMAKE" -DCMAKE_INSTALL_PREFIX="$CI_INSTALLDIR_FROM_BUILDDIR" \
 148                          "${ALL_CMAKE_VARS[@]}" \
 149                          "$CI_SRCDIR_FROM_BUILDDIR"
 150     ci_spawn "$CI_CMAKE" --build . \
 151                          --config "$CI_CMAKE_BUILD_TYPE" \
 152                          "${ALL_CMAKE_BUILD_FLAGS[@]}"
 153     [[ $CI_NO_TEST ]] ||
 154         ci_spawn "$CI_CTEST" --build-config "$CI_CMAKE_BUILD_TYPE" \
 155                              "${ALL_CTEST_FLAGS[@]}"
 156     [[ $CI_NO_INSTALL ]] ||
 157         ci_spawn "$CI_CMAKE" --build . \
 158                              --config "$CI_CMAKE_BUILD_TYPE" \
 159                              --target install \
 160                              "${ALL_CMAKE_BUILD_FLAGS[@]}"
 161     [[ $CI_NO_CLEAN ]] ||
 162         ci_spawn "$CI_CMAKE" --build . \
 163                              --config "$CI_CMAKE_BUILD_TYPE" \
 164                              --target clean \
 165                              "${ALL_CMAKE_BUILD_FLAGS[@]}"
 166     ci_info "## END OF BUILD ##"
 167 }
 168
 169 function main {
 170     [[ $# -eq 0 ]] || {
 171         ci_info "note: this program accepts environment options only"
 172         ci_err "unexpected command arguments: '$*'"
 173     }
 174     ci_init_cmake_build
 175     ci_trace_cmake_build
 176     ci_cleanup_old_cmake_build
 177     ci_build_cmake
 178 }
 179
 180 main "$@"