lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2026-10-24 03:48:58 +03:00
Code Activity

build: make examples a separate target, add quick-build for cmake

Browse Source 
- cmake: do not build examples automatically. This makes the
  `BUILD_EXAMPLES=OFF` option redundant.
- cmake: build all examples with target `libssh2-examples`.
- cmake: build-test all examples with target `libssh2-examples-build`.
  To save linking them 23 times in CI.
- autotools: add root `examples` build target to build examples.
- CI: build examples in a separate step.
  (for autotools, make them not build in the main build step by
  configuring with `--disable-examples-build`)

To make the build more transparent, scale better, be faster in CI, also
syncing with curl.

Slight downsides after this patch:
- cmake and autotools have different default behavior for building
  examples.
- cmake needs an extra step to build examples. (an explicit option is
  planned to restore the old behavior.)

Also:
- sync BSD matrix build-tool naming with rest of jobs.

Closes #2276
This commit is contained in:
Viktor Szakats
2026-07-12 15:10:56 +02:00
parent bce5593c56
commit 6bf392f627
6 changed files with 113 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
.github/workflows/ci.yml vendored
View File

@@ -320,6 +320,7 @@ jobs:
MATRIX_BUILD: '${{ matrix.build }}'
MATRIX_COMPILER: '${{ matrix.compiler }}'
MATRIX_CRYPTO: '${{ matrix.crypto }}'
MATRIX_TARGET: '${{ matrix.target }}'
MATRIX_ZLIB: '${{ matrix.zlib }}'
FIXTURE_TRACE_ALL_CONNECT: 0
AWSLC_VERSION: 5.0.0
@@ -604,6 +605,9 @@ jobs:
else
options+=' --with-libz'
fi
if [ "${MATRIX_TARGET}" != 'distcheck' ]; then
options+=' --disable-examples-build'
fi
../configure --enable-option-checking=fatal --enable-werror --enable-debug \
${options} \
--disable-dependency-tracking
@@ -648,6 +652,15 @@ jobs:
make -C bld check V=1 || { cat bld/tests/*.log; false; }
fi
- name: 'build examples'
if: ${{ !matrix.target }}
run: |
if [ "${MATRIX_BUILD}" = 'CM' ]; then
cmake --build bld --verbose --target libssh2-examples-build
else
make -C bld V=1 examples
fi
- name: 'autotools distcheck'
if: ${{ matrix.target == 'distcheck' }}
timeout-minutes: 5
@@ -736,7 +749,7 @@ jobs:
mkdir bld && cd bld
../configure --enable-option-checking=fatal --enable-werror --enable-debug \
--host="${TRIPLET}" \
--disable-dependency-tracking
--disable-dependency-tracking --disable-examples-build
fi
- name: 'configure log'
@@ -756,6 +769,14 @@ jobs:
make -C bld
fi
- name: 'build examples'
run: |
if [ "${MATRIX_BUILD}" = 'CM' ]; then
cmake --build bld --verbose --target libssh2-examples-build
else
make -C bld V=1 examples
fi
build_cygwin:
name: 'cygwin'
runs-on: windows-2022
@@ -808,7 +829,7 @@ jobs:
../configure --enable-option-checking=fatal --enable-werror --enable-debug \
--with-crypto=openssl \
--disable-docker-tests \
--disable-dependency-tracking
--disable-dependency-tracking --disable-examples-build
fi
- name: 'configure log'
@@ -840,6 +861,14 @@ jobs:
make -C bld check V=1 || { cat bld/tests/*.log; false; }
fi
- name: 'build examples'
run: |
if [ "${MATRIX_BUILD}" = 'CM' ]; then
cmake --build bld --verbose --target libssh2-examples-build
else
make -C bld V=1 examples
fi
build_msys2:
name: 'msys2'
runs-on: windows-2022
@@ -934,7 +963,7 @@ jobs:
--disable-docker-tests \
--disable-sshd-tests \
${options} \
--disable-dependency-tracking
--disable-dependency-tracking --disable-examples-build
fi
- name: 'configure log'
@@ -965,6 +994,14 @@ jobs:
make -C bld check V=1 || { cat bld/tests/*.log; false; }
fi
- name: 'build examples'
run: |
if [ "${MATRIX_BUILD}" = 'CM' ]; then
cmake --build bld --verbose --target libssh2-examples-build
else
make -C bld V=1 examples
fi
build_msvc:
name: 'msvc'
runs-on: '${{ matrix.image }}'
@@ -1044,6 +1081,9 @@ jobs:
timeout-minutes: 10
run: cd bld && ctest -VV -C Release --output-on-failure
- name: 'build examples'
run: cmake --build bld --verbose --target libssh2-examples-build
build_macos:
name: 'macOS (${{ matrix.build }}, ${{ matrix.crypto.name }})'
runs-on: macos-latest
@@ -1119,7 +1159,7 @@ jobs:
--with-libz ${MATRIX_CONFIGURE} \
--disable-docker-tests \
--disable-sshd-tests \
--disable-dependency-tracking
--disable-dependency-tracking --disable-examples-build
fi
- name: 'configure log'
@@ -1148,8 +1188,16 @@ jobs:
make -C bld check V=1 || { cat bld/tests/*.log; false; }
fi
- name: 'build examples'
run: |
if [ "${MATRIX_BUILD}" = 'CM' ]; then
cmake --build bld --verbose --target libssh2-examples-build
else
make -C bld V=1 examples
fi
cross:
name: "${{ matrix.os }} ${{ matrix.version }}, ${{ matrix.build == 'cmake' && 'CM' || 'AM' }} ${{ matrix.cc }} ${{ matrix.desc }} ${{ matrix.arch }}"
name: "${{ matrix.os }} ${{ matrix.version }}, ${{ matrix.build }} ${{ matrix.cc }} ${{ matrix.desc }} ${{ matrix.arch }}"
runs-on: ubuntu-26.04
timeout-minutes: 10
defaults:
@@ -1166,37 +1214,37 @@ jobs:
matrix:
include:
# https://github.com/DragonFlyBSD/DPorts
# { os: 'dragonflybsd', version: '6.4.2', build: 'autotools', arch: 'x86_64', cc: 'gcc' , desc: 'libgcrypt skiprun',
# { os: 'dragonflybsd', version: '6.4.2', build: 'AM', arch: 'x86_64', cc: 'gcc' , desc: 'libgcrypt skiprun',
# install: 'autoconf automake libtool libgcrypt',
# options: '--with-crypto=libgcrypt --with-libgcrypt-prefix=/usr/local' }
# https://ports.freebsd.org/
- { os: 'freebsd' , version: '15.1', build: 'autotools', arch: 'x86_64', cc: 'clang', desc: 'openssl',
- { os: 'freebsd' , version: '15.1', build: 'AM', arch: 'x86_64', cc: 'clang', desc: 'openssl',
install: 'autoconf automake libtool gettext',
options: '--with-crypto=openssl' }
- { os: 'freebsd' , version: '14.3', build: 'cmake' , arch: 'arm64' , cc: 'clang', desc: 'openssl skiprun',
- { os: 'freebsd' , version: '14.3', build: 'CM', arch: 'arm64' , cc: 'clang', desc: 'openssl skiprun',
install: 'cmake-core ninja',
options: '-DCRYPTO_BACKEND=OpenSSL' }
# https://app.midnightbsd.org/
# https://man.midnightbsd.org/cgi-bin/man.cgi/mport
- { os: 'midnightbsd' , version: '4.0.4', build: 'cmake' , arch: 'x86_64', cc: 'clang', desc: 'gnutls skiprun',
- { os: 'midnightbsd' , version: '4.0.4', build: 'CM', arch: 'x86_64', cc: 'clang', desc: 'gnutls skiprun',
install: 'cmake-core ninja',
options: '-DCRYPTO_BACKEND=OpenSSL' }
# https://pkgsrc.se/
- { os: 'netbsd' , version: '10.1' , build: 'cmake' , arch: 'x86_64', cc: 'gcc' , desc: 'openssl skiprun',
- { os: 'netbsd' , version: '10.1' , build: 'CM', arch: 'x86_64', cc: 'gcc' , desc: 'openssl skiprun',
install: 'cmake ninja-build',
options: '-DCRYPTO_BACKEND=OpenSSL' }
- { os: 'netbsd' , version: '10.1' , build: 'cmake' , arch: 'arm64' , cc: 'gcc' , desc: 'openssl skiprun',
- { os: 'netbsd' , version: '10.1' , build: 'CM', arch: 'arm64' , cc: 'gcc' , desc: 'openssl skiprun',
install: 'cmake ninja-build',
options: '-DCRYPTO_BACKEND=OpenSSL' }
# https://openbsd.app/
# https://www.openbsd.org/faq/faq15.html
- { os: 'openbsd' , version: '7.9' , build: 'cmake' , arch: 'x86_64', cc: 'clang', desc: 'libressl skiprun',
- { os: 'openbsd' , version: '7.9' , build: 'CM', arch: 'x86_64', cc: 'clang', desc: 'libressl skiprun',
install: 'cmake ninja',
options: '-DCRYPTO_BACKEND=OpenSSL' }
@@ -1229,12 +1277,12 @@ jobs:
fi
- name: 'autoreconf'
if: ${{ matrix.build == 'autotools' }}
if: ${{ matrix.build == 'AM' }}
run: autoreconf -fi
- name: 'configure'
run: |
if [ "${MATRIX_BUILD}" = 'cmake' ]; then
if [ "${MATRIX_BUILD}" = 'CM' ]; then
cmake -B bld -G Ninja \
-DCMAKE_UNITY_BUILD=ON \
-DENABLE_WERROR=ON \
@@ -1247,7 +1295,7 @@ jobs:
mkdir bld && cd bld
../configure --enable-option-checking=fatal --enable-werror --enable-debug \
--disable-docker-tests \
--disable-dependency-tracking \
--disable-dependency-tracking --disable-examples-build \
${MATRIX_OPTIONS}
fi
@@ -1262,18 +1310,26 @@ jobs:
- name: 'build'
run: |
if [ "${MATRIX_BUILD}" = 'cmake' ]; then
if [ "${MATRIX_BUILD}" = 'CM' ]; then
cmake --build bld
else
make -C bld
fi
- name: 'run tests'
- name: 'tests'
if: ${{ matrix.arch == 'x86_64' && !contains(matrix.desc, 'skiprun') }} # Slow on emulated CPU
run: |
export FIXTURE_TRACE_ALL_CONNECT=1 # try to close in on flaky CI failures on FreeBSD
if [ "${MATRIX_BUILD}" = 'cmake' ]; then
if [ "${MATRIX_BUILD}" = 'CM' ]; then
cmake --build bld --verbose --target test-ci
else
make -C bld check V=1 || { cat bld/tests/*.log; false; }
fi
- name: 'build examples'
run: |
if [ "${MATRIX_BUILD}" = 'CM' ]; then
cmake --build bld --verbose --target libssh2-examples-build
else
make -C bld V=1 examples
fi

3
Makefile.am
View File

@@ -95,3 +95,6 @@ coverage: init-coverage build-coverage gen-coverage
checksrc:
scripts/checksrc-all.pl
examples:
@(cd example; $(MAKE))

8
appveyor.sh
View File

@@ -44,12 +44,16 @@ fi
cmake -B _bld \
-DCMAKE_UNITY_BUILD=ON -DENABLE_WERROR=ON \
-DCMAKE_VS_GLOBALS=TrackFileAccess=false \
-DBUILD_EXAMPLES=OFF \
-DLIBSSH2_BUILD_DOCS=OFF \
${CMAKE_GENERATE:-} \
${options}
echo 'libssh2_config.h'; grep -F '#define' _bld/src/libssh2_config.h | sort || true
cmake --build _bld --config "${CMAKE_CONFIGURATION}" --parallel 2
time cmake --build _bld --config "${CMAKE_CONFIGURATION}" --parallel 2
# build examples
if [[ "${APPVEYOR_JOB_NAME}" = *'examples'* ]]; then
time cmake --build _bld --config "${CMAKE_CONFIGURATION}" --parallel 2 --target libssh2-examples-build
fi
# Install docker-cli for tests
if [ "${SKIP_CTEST:-}" != 'yes' ]; then

2
appveyor.yml
View File

@@ -65,7 +65,7 @@ environment:
- job_name: 'VS2010, WinCNG, x64, Server 2012 R2, Build-only, non-unity, examples, docs'
APPVEYOR_BUILD_WORKER_IMAGE: 'Visual Studio 2015'
CMAKE_GENERATOR: 'Visual Studio 10 2010'
CMAKE_GENERATE: '-A x64 -DCRYPTO_BACKEND=WinCNG -DCMAKE_UNITY_BUILD=OFF -DBUILD_EXAMPLES=ON -DLIBSSH2_BUILD_DOCS=ON'
CMAKE_GENERATE: '-A x64 -DCRYPTO_BACKEND=WinCNG -DCMAKE_UNITY_BUILD=OFF -DLIBSSH2_BUILD_DOCS=ON'
#SKIP_CTEST: 'yes'
# Re-enable when tests work again

36
example/CMakeLists.txt
View File

@@ -36,14 +36,34 @@ libssh2_transform_makefile_inc("Makefile.inc" "${CMAKE_CURRENT_BINARY_DIR}/Makef
# Get noinst_PROGRAMS variable
include("${CMAKE_CURRENT_BINARY_DIR}/Makefile.inc.cmake")
foreach(_example IN LISTS noinst_PROGRAMS)
add_executable(${_example} "${_example}.c")
list(APPEND _example_targets ${_example})
# to find generated header
target_include_directories(${_example} PRIVATE
add_custom_target(libssh2-examples)
set(_all_src "")
set(_all_canary "")
set(_all "all")
foreach(_target IN LISTS noinst_PROGRAMS _all) # keep '_all' last
if(_target STREQUAL "all")
set(_target "libssh2-example-${_all}")
add_library(${_target} OBJECT EXCLUDE_FROM_ALL ${_all_src})
if(CMAKE_C_COMPILER_ID STREQUAL "MSVC") # MSVC but exclude clang-cl
# CMake generates a static library for the OBJECT target. Silence these 'lib.exe' warnings:
# warning LNK4006: main already defined in ....obj; second definition ignored
# warning LNK4221: This object file does not define any previously undefined public symbols,
# [...] not be used by any link operation that consumes this library
set_target_properties(${_target} PROPERTIES STATIC_LIBRARY_OPTIONS "-ignore:4006;-ignore:4221")
endif()
add_custom_target(libssh2-examples-build) # Special target to compile all tests quickly and build a single test to probe linkage
add_dependencies(libssh2-examples-build ${_target} ${_all_canary}) # Include a full build of a single test
else()
set(_all_canary ${_target}) # Save the last test for the libssh2-examples-build target
list(APPEND _all_src "${_target}.c")
add_executable(${_target} EXCLUDE_FROM_ALL "${_target}.c")
add_dependencies(libssh2-examples ${_target})
endif()
target_include_directories(${_target} PRIVATE
"${PROJECT_BINARY_DIR}/src"
"${PROJECT_SOURCE_DIR}/src")
target_link_libraries(${_example} ${LIB_SELECTED} ${LIBSSH2_LIBS})
set_property(TARGET ${_example} APPEND PROPERTY COMPILE_OPTIONS "${LIBSSH2_PICKY_C_FLAGS}")
set_target_properties(${_example} PROPERTIES UNITY_BUILD OFF)
target_link_libraries(${_target} ${LIB_SELECTED} ${LIBSSH2_LIBS})
set_property(TARGET ${_target} APPEND PROPERTY COMPILE_OPTIONS "${LIBSSH2_PICKY_C_FLAGS}")
set_target_properties(${_target} PROPERTIES UNITY_BUILD OFF)
endforeach()

2
tests/cmake/test.sh
View File

@@ -16,7 +16,7 @@ cmake_provider="${TEST_CMAKE_PROVIDER:-${cmake_consumer}}"
gen="${TEST_CMAKE_GENERATOR:-Ninja}"
cmake_opts='-DBUILD_EXAMPLES=OFF -DBUILD_TESTING=OFF -DENABLE_ZLIB_COMPRESSION=ON'
cmake_opts='-DBUILD_TESTING=OFF -DENABLE_ZLIB_COMPRESSION=ON'
src='../..'