ci(macos): Avoid linking against homebrew

Homebrew binaries are always compiled for exactly the version they're
installed on making them very un-portable. When a wheel is "repaired" by
cibuildwheel, delocate-wheel pulls in _psycopg's dependencies
(libpq.dylib, libssl.dylib and libcrypto.dylib) which, on a GitHub
Actions macOS 14 runner, are provided by Homebrew and are therefore only
macOS >= 14 compatible. The resultant wheel is therefore incompatible
with all but the latest macOS versions.

Build all dependencies from source so that we can set the deployment
target to something sensible. Fixes #1753.
This commit is contained in:
Brénainn Woodsend 2024-11-22 19:53:41 +00:00 committed by Daniele Varrazzo
parent 3b684f91ca
commit d43e5fe092
2 changed files with 117 additions and 25 deletions

View File

@ -5,6 +5,8 @@ on:
env: env:
PIP_BREAK_SYSTEM_PACKAGES: "1" PIP_BREAK_SYSTEM_PACKAGES: "1"
LIBPQ_VERSION: "16.0"
OPENSSL_VERSION: "1.1.1w"
jobs: jobs:
sdist: # {{{ sdist: # {{{
@ -59,10 +61,6 @@ jobs:
linux: # {{{ linux: # {{{
if: true if: true
env:
LIBPQ_VERSION: "16.0"
OPENSSL_VERSION: "1.1.1w"
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
@ -162,6 +160,12 @@ jobs:
- name: Checkout repos - name: Checkout repos
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: Build dependencies
run: ./scripts/build/build_libpq.sh
- name: Show dependency tree
run: otool -L /tmp/libpq.build/lib/*.dylib
- name: Build wheels - name: Build wheels
uses: pypa/cibuildwheel@v2.22.0 uses: pypa/cibuildwheel@v2.22.0
env: env:
@ -172,12 +176,11 @@ jobs:
export PYTHONPATH={project} && export PYTHONPATH={project} &&
python -c "import tests; tests.unittest.main(defaultTest='tests.test_suite')" python -c "import tests; tests.unittest.main(defaultTest='tests.test_suite')"
CIBW_ENVIRONMENT: >- CIBW_ENVIRONMENT: >-
MACOSX_DEPLOYMENT_TARGET=${{ matrix.macver }}.0
PG_VERSION=16 PG_VERSION=16
PACKAGE_NAME=psycopg2-binary PACKAGE_NAME=psycopg2-binary
PSYCOPG2_TESTDB=postgres PSYCOPG2_TESTDB=postgres
PSYCOPG2_TEST_FAST=1 PSYCOPG2_TEST_FAST=1
PATH="/usr/local/opt/postgresql@${PG_VERSION}/bin:$PATH" PATH="/tmp/libpq.build/bin:$PATH"
- name: Upload artifacts - name: Upload artifacts
uses: actions/upload-artifact@v4 uses: actions/upload-artifact@v4

View File

@ -1,6 +1,6 @@
#!/bin/bash #!/bin/bash
# Build a modern version of libpq and depending libs from source on Centos 5 # Build a modern version of libpq and depending libs from source on Centos 5, Alpine or macOS
set -euo pipefail set -euo pipefail
set -x set -x
@ -12,30 +12,69 @@ postgres_version="${LIBPQ_VERSION}"
# last release: https://www.openssl.org/source/ # last release: https://www.openssl.org/source/
openssl_version="${OPENSSL_VERSION}" openssl_version="${OPENSSL_VERSION}"
# last release: https://kerberos.org/dist/
krb5_version="1.21.3"
# last release: https://www.gnu.org/software/gettext/
gettext_version="0.22.5"
# last release: https://openldap.org/software/download/ # last release: https://openldap.org/software/download/
ldap_version="2.6.3" ldap_version="2.6.8"
# last release: https://github.com/cyrusimap/cyrus-sasl/releases # last release: https://github.com/cyrusimap/cyrus-sasl/releases
sasl_version="2.1.28" sasl_version="2.1.28"
export LIBPQ_BUILD_PREFIX=${LIBPQ_BUILD_PREFIX:-/tmp/libpq.build} export LIBPQ_BUILD_PREFIX=${LIBPQ_BUILD_PREFIX:-/tmp/libpq.build}
if [[ -f "${LIBPQ_BUILD_PREFIX}/lib/libpq.so" ]]; then case "$(uname)" in
Darwin)
ID=macos
library_suffix=dylib
;;
Linux)
source /etc/os-release
library_suffix=so
;;
*)
echo "$0: unexpected Operating system: '$(uname)'" >&2
exit 1
;;
esac
if [[ -f "${LIBPQ_BUILD_PREFIX}/lib/libpq.${library_suffix}" ]]; then
echo "libpq already available: build skipped" >&2 echo "libpq already available: build skipped" >&2
exit 0 exit 0
fi fi
source /etc/os-release
case "$ID" in case "$ID" in
centos) centos)
yum update -y yum update -y
yum install -y zlib-devel krb5-devel pam-devel yum install -y zlib-devel krb5-devel pam-devel
curl="$(which curl)"
;; ;;
alpine) alpine)
apk upgrade apk upgrade
apk add --no-cache zlib-dev krb5-dev linux-pam-dev openldap-dev openssl-dev apk add --no-cache zlib-dev krb5-dev linux-pam-dev openldap-dev openssl-dev
curl="$(which curl)"
;;
macos)
brew install automake m4 libtool
# If available, libpq seemingly insists on linking against homebrew's
# openssl no matter what so remove it. Since homebrew's curl depends on
# it, force use of system curl.
brew uninstall --force --ignore-dependencies openssl gettext
curl="/usr/bin/curl"
# The deployment target should be <= to that of the oldest supported Python version.
# e.g. https://www.python.org/downloads/release/python-380/
if [ "$(uname -m)" == "x86_64" ]; then
export MACOSX_DEPLOYMENT_TARGET=10.9
else
export MACOSX_DEPLOYMENT_TARGET=11.0
fi
;; ;;
*) *)
@ -44,12 +83,12 @@ case "$ID" in
;; ;;
esac esac
if [ "$ID" == "centos" ]; then if [ "$ID" == "centos" ] || [ "$ID" == "macos" ]; then
# Build openssl if needed # Build openssl if needed
openssl_tag="OpenSSL_${openssl_version//./_}" openssl_tag="OpenSSL_${openssl_version//./_}"
openssl_dir="openssl-${openssl_tag}" openssl_dir="openssl-${openssl_tag}"
if [ ! -d "${openssl_dir}" ]; then curl -sL \ if [ ! -d "${openssl_dir}" ]; then "$curl" -sL \
https://github.com/openssl/openssl/archive/${openssl_tag}.tar.gz \ https://github.com/openssl/openssl/archive/${openssl_tag}.tar.gz \
| tar xzf - | tar xzf -
@ -70,7 +109,55 @@ if [ "$ID" == "centos" ]; then
fi fi
if [ "$ID" == "centos" ]; then if [ "$ID" == "macos" ]; then
# Build kerberos if needed
krb5_dir="krb5-${krb5_version}/src"
if [ ! -d "${krb5_dir}" ]; then
"$curl" -sL \
curl -sL "https://kerberos.org/dist/krb5/$(echo 1.21.3 | grep -oE '\d+\.\d+')/krb5-${krb5_version}.tar.gz" \
| tar xzf -
cd "${krb5_dir}"
./configure --prefix=${LIBPQ_BUILD_PREFIX} \
CPPFLAGS=-I${LIBPQ_BUILD_PREFIX}/include/ LDFLAGS=-L${LIBPQ_BUILD_PREFIX}/lib
make
else
cd "${krb5_dir}"
fi
make install
cd ../..
fi
if [ "$ID" == "macos" ]; then
# Build gettext if needed
gettext_dir="gettext-${gettext_version}"
if [ ! -d "${gettext_dir}" ]; then
"$curl" -sL \
curl -sL "https://ftp.gnu.org/pub/gnu/gettext/gettext-${gettext_version}.tar.gz" \
| tar xzf -
cd "${gettext_dir}"
./configure --prefix=${LIBPQ_BUILD_PREFIX} --disable-java \
CPPFLAGS=-I${LIBPQ_BUILD_PREFIX}/include/ LDFLAGS=-L${LIBPQ_BUILD_PREFIX}/lib
make -C gettext-runtime all
else
cd "${gettext_dir}"
fi
make -C gettext-runtime install
cd ..
fi
if [ "$ID" == "centos" ] || [ "$ID" == "macos" ]; then
# Build libsasl2 if needed # Build libsasl2 if needed
# The system package (cyrus-sasl-devel) causes an amazing error on i686: # The system package (cyrus-sasl-devel) causes an amazing error on i686:
@ -79,14 +166,14 @@ if [ "$ID" == "centos" ]; then
sasl_tag="cyrus-sasl-${sasl_version}" sasl_tag="cyrus-sasl-${sasl_version}"
sasl_dir="cyrus-sasl-${sasl_tag}" sasl_dir="cyrus-sasl-${sasl_tag}"
if [ ! -d "${sasl_dir}" ]; then if [ ! -d "${sasl_dir}" ]; then
curl -sL \ "$curl" -sL \
https://github.com/cyrusimap/cyrus-sasl/archive/${sasl_tag}.tar.gz \ https://github.com/cyrusimap/cyrus-sasl/archive/${sasl_tag}.tar.gz \
| tar xzf - | tar xzf -
cd "${sasl_dir}" cd "${sasl_dir}"
autoreconf -i autoreconf -i
./configure --prefix=${LIBPQ_BUILD_PREFIX} \ ./configure --prefix=${LIBPQ_BUILD_PREFIX} --disable-macos-framework \
CPPFLAGS=-I${LIBPQ_BUILD_PREFIX}/include/ LDFLAGS=-L${LIBPQ_BUILD_PREFIX}/lib CPPFLAGS=-I${LIBPQ_BUILD_PREFIX}/include/ LDFLAGS=-L${LIBPQ_BUILD_PREFIX}/lib
make make
else else
@ -102,13 +189,13 @@ if [ "$ID" == "centos" ]; then
fi fi
if [ "$ID" == "centos" ]; then if [ "$ID" == "centos" ] || [ "$ID" == "macos" ]; then
# Build openldap if needed # Build openldap if needed
ldap_tag="${ldap_version}" ldap_tag="${ldap_version}"
ldap_dir="openldap-${ldap_tag}" ldap_dir="openldap-${ldap_tag}"
if [ ! -d "${ldap_dir}" ]; then if [ ! -d "${ldap_dir}" ]; then
curl -sL \ "$curl" -sL \
https://www.openldap.org/software/download/OpenLDAP/openldap-release/openldap-${ldap_tag}.tgz \ https://www.openldap.org/software/download/OpenLDAP/openldap-release/openldap-${ldap_tag}.tgz \
| tar xzf - | tar xzf -
@ -129,7 +216,7 @@ if [ "$ID" == "centos" ]; then
make -C libraries/liblber/ install make -C libraries/liblber/ install
make -C libraries/libldap/ install make -C libraries/libldap/ install
make -C include/ install make -C include/ install
chmod +x ${LIBPQ_BUILD_PREFIX}/lib/{libldap,liblber}*.so* chmod +x ${LIBPQ_BUILD_PREFIX}/lib/{libldap,liblber}*.${library_suffix}*
cd .. cd ..
fi fi
@ -139,17 +226,19 @@ fi
postgres_tag="REL_${postgres_version//./_}" postgres_tag="REL_${postgres_version//./_}"
postgres_dir="postgres-${postgres_tag}" postgres_dir="postgres-${postgres_tag}"
if [ ! -d "${postgres_dir}" ]; then if [ ! -d "${postgres_dir}" ]; then
curl -sL \ "$curl" -sL \
https://github.com/postgres/postgres/archive/${postgres_tag}.tar.gz \ https://github.com/postgres/postgres/archive/${postgres_tag}.tar.gz \
| tar xzf - | tar xzf -
cd "${postgres_dir}" cd "${postgres_dir}"
# Match the default unix socket dir default with what defined on Ubuntu and if [ "$ID" != "macos" ]; then
# Red Hat, which seems the most common location # Match the default unix socket dir default with what defined on Ubuntu and
sed -i 's|#define DEFAULT_PGSOCKET_DIR .*'\ # Red Hat, which seems the most common location
sed -i 's|#define DEFAULT_PGSOCKET_DIR .*'\
'|#define DEFAULT_PGSOCKET_DIR "/var/run/postgresql"|' \ '|#define DEFAULT_PGSOCKET_DIR "/var/run/postgresql"|' \
src/include/pg_config_manual.h src/include/pg_config_manual.h
fi
# Often needed, but currently set by the workflow # Often needed, but currently set by the workflow
# export LD_LIBRARY_PATH="${LIBPQ_BUILD_PREFIX}/lib" # export LD_LIBRARY_PATH="${LIBPQ_BUILD_PREFIX}/lib"
@ -171,4 +260,4 @@ make -C src/bin/pg_config install
make -C src/include install make -C src/include install
cd .. cd ..
find ${LIBPQ_BUILD_PREFIX} -name \*.so.\* -type f -exec strip --strip-unneeded {} \; find ${LIBPQ_BUILD_PREFIX} -name \*.${library_suffix}.\* -type f -exec strip --strip-unneeded {} \;