mirror of
https://github.com/obgm/libcoap.git
synced 2026-11-01 07:25:47 +03:00
Jon Shallow
7812efb1eb
There needs to be an easy way to validate that the examples provided in the man pages compile without errors. This PR provides a new executable examples-code-check that can be run against the .txt.in files that are in the man directory. It abstracts the code for each example and then runs the compiler against that stub code reporting errors and warnings as appropriate for subsequent fixing in the man page. .gitignore: Ignore the new executable and the files it generates. Makefile.am: configure.ac: Remove MAN_DIR and hard code in the man directory so that examples-code-check is always built. autogen.sh: Make sure that all the temporary stub code files are cleaned up. man/Makefile.am: Support building and clean-up of the new examples-code-check. man/examples-code-check.c: (new) The code that parses the man pages, looking for examples and the gets the examples compiled, testing for errors. The function definitions in the SYNOPSIS section are also included in the compilation of the examples. scripts/build.sh: If WITH_TESTS is set, check that the man page examples compile. man/coap_encryption.txt.in: man/coap_io.txt.in: man/coap_observe.txt.in: man/coap_pdu_setup.txt.in: man/coap_resource.txt.in: man/coap_session.txt.in: Correct the SYNOPSIS function definitions.
87 lines
2.5 KiB
Bash
Executable File
87 lines
2.5 KiB
Bash
Executable File
#! /bin/sh
|
|
|
|
SILENT="--disable-silent-rules"
|
|
|
|
if test "x$TESTS" = "xyes" -o "x$TESTS" = "xtrue" ; then
|
|
WITH_TESTS="`scripts/fix-cunit.sh` --enable-tests"
|
|
test -f `pwd`/cunit.pc && echo cat `pwd`/cunit.pc
|
|
fi
|
|
|
|
TEST_LD_LIBRARY_PATH=
|
|
case "x${TLS}" in
|
|
xno) WITH_TLS="--disable-dtls"
|
|
;;
|
|
xopenssl) WITH_TLS="--with-openssl"
|
|
;;
|
|
xgnutls) WITH_TLS="--with-gnutls"
|
|
;;
|
|
xmbedtls) WITH_TLS="--with-mbedtls"
|
|
;;
|
|
xtinydtls) WITH_TLS="--with-tinydtls"
|
|
# Need this as libtinydtls.so has not been installed
|
|
# as a part of the travis build
|
|
TEST_LD_LIBRARY_PATH="ext/tinydtls"
|
|
;;
|
|
*) WITH_TLS="--with-gnutls"
|
|
;;
|
|
esac
|
|
|
|
case "x${DOCS}" in
|
|
xyes) WITH_DOCS="--enable-documentation"
|
|
;;
|
|
*) WITH_DOCS="--disable-documentation"
|
|
;;
|
|
esac
|
|
|
|
# Building with epoll support can be disabled by setting EPOLL=no.
|
|
# Otherwise, it is enabled by default and used if available.
|
|
if test "x$EPOLL" = "xno" ; then
|
|
OTHER_OPTS="$OTHER_OPTS --without-epoll"
|
|
fi
|
|
|
|
# Enable constrained stack build when SMALL_STACK is set to yes.
|
|
if test "x$SMALL_STACK" = "xyes" ; then
|
|
OTHER_OPTS="$OTHER_OPTS --enable-small-stack"
|
|
fi
|
|
|
|
config() {
|
|
echo "./configure $SILENT $*"
|
|
./configure $SILENT $* || cat config.log
|
|
}
|
|
|
|
case "${PLATFORM}" in
|
|
contiki) config "--disable-tests $WITH_DOCS --disable-examples $WITH_TLS" && \
|
|
make -C examples/contiki
|
|
;;
|
|
lwip) config "--disable-tests $WITH_DOCS --disable-examples $WITH_TLS" && \
|
|
make -C examples/lwip
|
|
;;
|
|
posix|*) config "$WITH_TESTS $WITH_DOCS --enable-examples $WITH_TLS $OTHER_OPTS" && \
|
|
make && make check
|
|
;;
|
|
esac
|
|
|
|
err=$?
|
|
if test $err = 0 -a -n "$WITH_TESTS" ; then
|
|
EXEC_FILE=tests/testdriver
|
|
# then run valgrind on the actual executable
|
|
LD_LIBRARY_PATH=$TEST_LD_LIBRARY_PATH libtool --mode=execute valgrind --track-origins=yes --leak-check=yes --show-reachable=yes --error-exitcode=123 --quiet --suppressions=tests/valgrind_suppression $EXEC_FILE
|
|
err=$?
|
|
fi
|
|
|
|
# invoke OSS-Fuzz syntax checks
|
|
if test $err = 0 -a -n "$WITH_TESTS" ; then
|
|
make -C tests/oss-fuzz -f Makefile.ci check clean
|
|
err=$?
|
|
fi
|
|
|
|
# invoke man page examples code compiles checks
|
|
if test $err = 0 -a -n "$WITH_TESTS" ; then
|
|
make -C man
|
|
EXEC_FILE=man/examples-code-check
|
|
$EXEC_FILE man
|
|
err=$?
|
|
fi
|
|
|
|
exit $err
|