Import a test for FIXME in comments

Disabled by default.
This commit is contained in:
Pierre Pronchery 2018-02-24 21:10:17 +01:00
parent d185479478
commit f29338bf63
2 changed files with 184 additions and 1 deletions

177
tests/fixme.sh Executable file
View File

@ -0,0 +1,177 @@
#!/bin/sh
#$Id$
#Copyright (c) 2017 Pierre Pronchery <khorben@defora.org>
#
#Redistribution and use in source and binary forms, with or without
#modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
#THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
#AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
#IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
#DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
#FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
#DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
#SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
#CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
#OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
#OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#variables
PROGNAME="fixme.sh"
PROJECTCONF="../project.conf"
#executables
DATE="date"
DEBUG="_debug"
FIND="find"
GREP="grep"
SORT="sort -n"
TR="tr"
#functions
#fixme
_fixme()
{
ret=0
$DATE
echo
while read line; do
case "$line" in
"["*)
break
;;
"subdirs="*)
subdirs=${line#subdirs=}
subdirs=$(echo "$subdirs" | $TR ',' ' ')
;;
esac
done < "$PROJECTCONF"
for subdir in $subdirs; do
[ -d "../$subdir" ] || continue
for filename in $($FIND "../$subdir" -type f | $SORT); do
callback=
case "$filename" in
*.asm|*.S)
callback="_fixme_asm"
;;
*.c|*.h|*.js)
callback="_fixme_c"
;;
*.conf|*.sh)
callback="_fixme_sh"
;;
esac
[ -n "$callback" ] || continue
$callback "$filename" 2>&1
if [ $? -ne 0 ]; then
echo "$PROGNAME: $filename: FAIL" 1>&2
ret=2
fi
done
done
return $ret
}
_fixme_asm()
{
retc=0
filename="$1"
#warnings
$GREP -nH '/\*.*\(TODO\|XXX\)' "$filename"
#failures
$GREP -nH '/\*.*FIXME' "$filename" && retc=2
return $retc
}
_fixme_c()
{
retc=0
filename="$1"
#warnings
$GREP -nH '/\(/\|\*\).*\(TODO\|XXX\)' "$filename"
#failures
$GREP -nH '/\(/\|\*\).*FIXME' "$filename" && retc=2
return $retc
}
_fixme_sh()
{
retsh=0
filename="$1"
#XXX avoid matching the regexp
comment="#"
#warnings
$GREP -nH "$comment.*\\(TODO\\|XXX\\)" "$filename"
#failures
$GREP -nH "$comment.*FIXME" "$filename" && retsh=2
return $retsh
}
#debug
_debug()
{
echo "$@" 1>&3
"$@"
res=$?
#ignore errors when the command is not available
[ $res -eq 127 ] && return 0
return $res
}
#usage
_usage()
{
echo "Usage: $PROGNAME [-c] target..." 1>&2
return 1
}
#main
clean=0
while getopts "cO:P:" name; do
case "$name" in
c)
clean=1
;;
O)
export "${OPTARG%%=*}"="${OPTARG#*=}"
;;
P)
#XXX ignored for compatibility
;;
?)
_usage
exit $?
;;
esac
done
shift $((OPTIND - 1))
if [ $# -lt 1 ]; then
_usage
exit $?
fi
#clean
[ $clean -ne 0 ] && exit 0
exec 3>&1
while [ $# -gt 0 ]; do
target="$1"
shift
_fixme > "$target" || exit 2
done

View File

@ -1,4 +1,4 @@
targets=define.o,if.o,include.o targets=define.o,fixme.log,if.o,include.o
cxx=./cpp.sh cxx=./cpp.sh
cxxflags= cxxflags=
dist=Makefile,cpp.sh,include-define.cpp dist=Makefile,cpp.sh,include-define.cpp
@ -11,6 +11,12 @@ depends=../src/cpp
[define.cpp] [define.cpp]
depends=cpp.sh depends=cpp.sh
[fixme.log]
type=script
script=./fixme.sh
depends=fixme.sh
enabled=0
[if.o] [if.o]
type=object type=object
sources=if.cpp sources=if.cpp