comparison SCRIPTS/process.sh @ 86:413a9d26189e

Handle VamPy plugins

 ##   the plugin builds!
 ##   plugin loads
 ##   passes vamp-plugin-tester tests
 ##   does not export any unnecessary symbols
 ##   has valid .cat and .n3
+
+set -eu
 
 mydir=$(dirname "$0")
 case "$mydir" in /*);; *) mydir=$(pwd)/"$mydir";; esac
 
 . "$mydir"/include.sh

 notbuilt="/tmp/notbuilt.$$.txt"
 
 trap 'rm -f "$built" "$envcheckfailed" "$testfailed" "$notbuilt"' 0
 touch "$built" "$envcheckfailed" "$testfailed" "$notbuilt"
 
+target_for() {
+    local dir="$1"
+    if grep -q "^$dir: " METADATA/maketarget.txt ; then
+	grep "^$dir: " METADATA/maketarget.txt | head -1 | sed 's/^[^:]*: //'
+    fi
+}
+
+plugin_dir_for() {
+    local dir="$1"
+    if grep -q "^$dir: " METADATA/plugindir.txt ; then
+	echo "$dir"/$(grep "^$dir: " METADATA/plugindir.txt | head -1 | sed 's/^[^:]*: //')
+    fi
+}
+
 configure() {
-    dir="$1"
+    local dir="$1"
     if [ -f "$dir/configure" ] ; then
 	( cd "$dir" ; ./configure ) 2>&1 | tee "$reportdir/$dir.configure.txt"
     fi
 }
 
 find_makefile() {
-    dir="$1"
+    local dir="$1"
     for f in \
 	build/$platform$bits/Makefile.$platform$bits \
 	build/$platform/Makefile.$platform$bits \
 	build/$platform$bits/Makefile.$platform \
 	build/$platform$bits/Makefile \

 	    break
 	fi
     done
 }
 
+find_vampy_plugins_in() {
+    local dir="$1"
+    local pdir=$(plugin_dir_for "$dir")
+    if [ -z "$pdir" ]; then
+	pdir="$dir"
+    fi
+    find "$pdir" -name \*.py -print0 | xargs -0 grep -l 'import.*\bvampy\b'
+}
+
+have_vampy_plugins() {
+    local dir="$1"
+    local plugs=$(find_vampy_plugins_in "$dir")
+    if [ -z "$plugs" ]; then
+	return 1
+    else
+	return 0
+    fi
+}
+
 configure_maybe() {
-    dir="$1"
+    local dir="$1"
     if [ t"$do_rebuild" = t"yes" ]; then
         configure "$dir"
     else
         mfile=$(find_makefile "$dir")
         if [ -z "$mfile" ]; then
 	    configure "$dir"
         fi
     fi
 }
 
-target_for() {
-    dir="$1"
-    if grep -q "^$dir: " METADATA/maketarget.txt ; then
-	grep "^$dir: " METADATA/maketarget.txt | head -1 | sed 's/^[^:]*: //'
-    fi
-}
-
-plugin_dir_for() {
-    dir="$1"
-    if grep -q "^$dir: " METADATA/plugindir.txt ; then
-	echo "$dir"/$(grep "^$dir: " METADATA/plugindir.txt | head -1 | sed 's/^[^:]*: //')
-    fi
-}
-
 logfile_for() {
-    activity="$1"
-    dir="$2"
+    local activity="$1"
+    local dir="$2"
     echo "$reportdir/$dir.$activity.txt"
 }
 
 build() {
-    dir="$1"
-    log=$(logfile_for build "$dir")
+    local dir="$1"
+    local log=$(logfile_for build "$dir")
     if configure_maybe "$dir"; then
 	mfile=$(find_makefile "$dir")
 	if [ -n "$mfile" ]; then
 	    target=$(target_for "$dir")
 	    TOOLPREFIX="$toolprefix" \

 		LDFLAGS="-L${deplibdir} -L../vamp-plugin-sdk" \
 		ARCHFLAGS="$archflags" \
 		make -C "$dir" -f "$mfile" $target 2>&1 | \
 		tee "$log"
 	    return ${PIPESTATUS[0]}
+	elif have_vampy_plugins "$dir"; then
+	    return 0
 	else
 	    echo "Failed to find a Makefile in $dir!" | tee "$log"
 	    return 1
 	fi
     fi
 }
 
 rebuild() {
-    dir="$1"
-    log=$(logfile_for build "$dir")
+    local dir="$1"
+    local log=$(logfile_for build "$dir")
     if configure_maybe "$dir"; then
 	mfile=$(find_makefile "$dir")
 	if [ -n "$mfile" ]; then
 	    if make -C "$dir" -f "$mfile" distclean; then
 		build "$dir"

 		build "$dir"
 	    else
 		echo "Failed to 'make clean' in $dir!" | tee "$log"
 		return 1
 	    fi
+	elif have_vampy_plugins "$dir"; then
+	    return 0
 	else
 	    echo "Failed to find a Makefile in $dir!" | tee "$log"
 	    return 1
 	fi
     fi
 }
 
 build_or_rebuild() {
-    dir="$1"
+    local dir="$1"
     if [ -n "$do_rebuild" ]; then
 	rebuild "$dir"
     else
 	build "$dir"
     fi
 }
 
 have_plugin() {
-    dir="$1"
-    log=$(logfile_for build "$dir")
+    local dir="$1"
+    local log=$(logfile_for build "$dir")
     for x in "$dir/"*"$pluginext"; do 
 	if [ -f "$x" ]; then
 	    if file "$x" | grep -q "$identpattern" ; then
 		return 0
 	    else
 		echo "Plugin $x exists, but fails to match file type for correct platform (file type is: `file $x`, expected pattern is: $identpattern)" | tee "$log"
 		return 1
 	    fi
 	fi
     done
-    return 1
+    have_vampy_plugins "$dir"
 }
 
 is_nondeterministic() {
     plugin_id="$1"
     grep -q "^$id\$" METADATA/nondeterministic.txt
 }
 
 plugin_ids_in() {
-    dir="$1"
-    pdir=$(plugin_dir_for "$dir")
+    local dir="$1"
+    local pdir=$(plugin_dir_for "$dir")
+    local vampydir=""
+    if have_vampy_plugins "$pdir"; then
+	vampydir="./vampy"
+    fi
     # can't use sed to remove \r from DOS line endings -- BSD and GNU
     # vary in how they interpret \r escape -- so we use perl for that...
-    VAMP_PATH="$dir:$pdir" $hostwrapper \
+    VAMP_PATH="$dir:$pdir:$vampydir" $hostwrapper \
 	vamp-plugin-sdk/host/vamp-simple-host$hostext --list-ids | \
 	grep '^vamp:' | \
 	sed 's/^vamp://' | \
 	perl -p -e 's/\r//g' 
 }
 
 run_tester() {
     ##!!! todo: timeout if the plugin takes too long and report as failure
-    dir="$1"
-    log=$(logfile_for test "$dir")
-    ids=$(plugin_ids_in "$dir")
-    pdir=$(plugin_dir_for "$dir")
+    local dir="$1"
+    local log=$(logfile_for test "$dir")
+    local ids=$(plugin_ids_in "$dir")
+    local pdir=$(plugin_dir_for "$dir")
     cat /dev/null > "$log"
     if [ -z "$ids" ]; then
 	echo 
 	echo "No plugins reported to test in $dir" | tee -a "$log"
 	echo "$dir" >> "$testfailed"

 	extra=""
 	if is_nondeterministic "$id"; then
 	    extra="-n"
 	fi
 	echo "Running command: VAMP_PATH=\"$dir:$pdir\" $hostwrapper vamp-plugin-tester/vamp-plugin-tester$hostext \"$extra\" \"$id\"" | tee -a "$log"
-	if ( VAMP_PATH="$dir:$pdir" $hostwrapper vamp-plugin-tester/vamp-plugin-tester$hostext "$extra" "$id" 2>&1 | tee -a "$log" ; exit ${PIPESTATUS[0]} ) ; then
+	if ( VAMP_PATH="$dir:$pdir:./vampy" $hostwrapper vamp-plugin-tester/vamp-plugin-tester$hostext "$extra" "$id" 2>&1 | tee -a "$log" ; exit ${PIPESTATUS[0]} ) ; then
 	    echo "OK" | tee -a "$log"
 	else
-	    echo | tee -a "$log"
-	    echo "Tester failed for id $id: running again with valgrind (if available) and verbose for a report..." | tee -a "$log"
-	    VAMP_PATH="$dir:$pdir" $valgrind $hostwrapper vamp-plugin-tester/vamp-plugin-tester$hostext -v "$extra" "$id" 2>&1 | tee -a "$log"
+	    if have_vampy_plugins "$pdir"; then # (don't attempt vampy+valgrind)
+		echo | tee -a "$log"
+		echo "Tester failed for id $id (not restarting with valgrind, as this is a VamPy plugin)" | tee -a "$log"
+	    else
+		echo | tee -a "$log"
+		echo "Tester failed for id $id: running again with valgrind (if available) and verbose for a report..." | tee -a "$log"
+		VAMP_PATH="$dir:$pdir:./vampy" $valgrind $hostwrapper vamp-plugin-tester/vamp-plugin-tester$hostext -v "$extra" "$id" 2>&1 | tee -a "$log"
+	    fi
 	    good=no
 	fi
     done
     if [ "$good" != "yes" ]; then
 	echo "$dir" >> "$testfailed"

     # grepping out the undefineds:
     "$toolprefix"nm -g "$lib" | grep -v ' U ' | awk '{ print $3; }'
 }
 
 env_test_exports() {
-    dir="$1"
-    log=$(logfile_for envtest "$dir")
-    good=yes
+    local dir="$1"
+    local log=$(logfile_for envtest "$dir")
+    local good=yes
     for lib in "$dir"/*"$pluginext"; do 
 	if [ ! -f "$lib" ]; then
 	    # This should only happen if the glob was not expanded at all
 	    echo "NOTE: no library found in $dir?" | tee -a "$log"
 	    good=no

     done
     [ "$good" = "yes" ]
 }
 
 env_test_stdout() {
-    dir="$1"
-    log=$(logfile_for envtest "$dir")
-    pdir=$(plugin_dir_for "$dir")
-    good=yes
-    ids=$(VAMP_PATH="$dir:$pdir" $hostwrapper vamp-plugin-sdk/host/vamp-simple-host$hostext --list-ids);
+    local dir="$1"
+    local log=$(logfile_for envtest "$dir")
+    local pdir=$(plugin_dir_for "$dir")
+    local good=yes
+    local ids=$(VAMP_PATH="$dir:$pdir" $hostwrapper vamp-plugin-sdk/host/vamp-simple-host$hostext --list-ids);
     echo 
     echo "Testing for any unwanted output to stdout..."
     for id in $ids; do
 	case "$id" in
 	    vamp:*) ;;

     done
     [ "$good" = "yes" ]
 }
 
 env_test_cat() {
-    dir="$1"
-    log=$(logfile_for envtest "$dir")
-    pdir=$(plugin_dir_for "$dir")
-    cdir=$(if test -n "$pdir" ; then echo "$pdir" ; else echo "$dir" ; fi)
-    good=yes
-    first=yes
+    local dir="$1"
+    local log=$(logfile_for envtest "$dir")
+    local pdir=$(plugin_dir_for "$dir")
+    local cdir=$(if test -n "$pdir" ; then echo "$pdir" ; else echo "$dir" ; fi)
+    local good=yes
+    local first=yes
     echo 
     echo "Testing some details of .cat files..."
     for catfile in "$cdir"/*".cat"; do
 	if [ ! -f "$catfile" ]; then
 	    # This should only happen if the glob was not expanded at all

     fi
     [ "$good" = "yes" ]
 }
 
 env_test_ttl() {
-    dir="$1"
-    log=$(logfile_for envtest "$dir")
-    pdir=$(plugin_dir_for "$dir")
-    rdir=$(if test -n "$pdir" ; then echo "$pdir" ; else echo "$dir" ; fi)
-    good=yes
-    first=yes
+    local dir="$1"
+    local log=$(logfile_for envtest "$dir")
+    local pdir=$(plugin_dir_for "$dir")
+    local rdir=$(if test -n "$pdir" ; then echo "$pdir" ; else echo "$dir" ; fi)
+    local good=yes
+    local first=yes
     echo 
     echo "Testing existence of RDF files..."
     for ttlfile in "$rdir"/*.{n3,ttl}; do
 	if [ ! -f "$ttlfile" ]; then
 	    # Because we have two different extensions, this isn't an

     fi
     [ "$good" = "yes" ]
 }
 
 env_test_accompaniments() {
-    dir="$1"
-    log=$(logfile_for envtest "$dir")
-    good=yes
+    local dir="$1"
+    local log=$(logfile_for envtest "$dir")
+    local good=yes
     echo 
     echo "Testing existence of README and accompanying files..."
     if ! ls -1 "$dir" | egrep -qi "^readme(.txt)?$"; then
 	echo "ERROR: no README file found" | tee -a "$log"
 	good=no

     fi
     [ "$good" = "yes" ]
 }
 
 run_environmental_tests() {
-    dir="$1"
-    log=$(logfile_for envtest "$dir")
-    allgood=yes
+    local dir="$1"
+    local log=$(logfile_for envtest "$dir")
+    local allgood=yes
     cat /dev/null > "$log"
     for test in exports stdout cat ttl accompaniments; do
 	"env_test_$test" "$dir" || allgood=no
     done
     if [ "$allgood" != "yes" ]; then

 	return 0
     fi
 }
 
 package() {
-    dir="$1"
-    id=$(vcs_id "$dir")
-    pstub="$dir-$platform$bits-$id"
-    pdir="$packagedir/$pstub"
+    local dir="$1"
+    local id=$(vcs_id "$dir")
+    local pstub="$dir-$platform$bits-$id"
+    local pdir="$packagedir/$pstub"
     mkdir -p "$pdir"
     ( cd "$dir" ; 
 	cp -av \
 	    *"$pluginext" \
 	    *.cat \

 	    [Rr][Ee][Aa][Dd][Mm][Ee]* \
 	    [Cc][Oo][Pp][Yy][Ii][Nn][Gg]* \
 	    [Ll][Ii][Cc][Ee][Nn][CcSs][Ee]* \
 	    [Cc][Ii][Tt][Aa][Tt][Ii][Oo][Nn]* \
 	    [Cc][Hh][Aa][Nn][Gg][Ee][Ll][Oo][Gg]* \
-	    ../"$pdir"/
+	    ../"$pdir"/ || /bin/true
+	if have_vampy_plugins "$dir"; then
+	    find_vampy_plugins_in "$dir" | while read p; do
+					       cp -av "$p" ../"$pdir"/
+					   done
+	fi
 	)
     ( cd "$packagedir";
 	if [ "$platform" = "mingw" ]; then
 	    zip -r "$pstub".zip "$pstub"
 	else

 	echo "Directory $dir not found!"
 	echo "$dir" >> "$notbuilt"
     elif build_or_rebuild "$dir"; then
 	if have_plugin "$dir" ; then
 	    echo "$dir" >> "$built"
-	    run_tester "$dir"
-	    run_environmental_tests "$dir"
+	    if ! run_tester "$dir"; then
+		echo "Tester failed for $dir"
+	    fi
+	    if ! run_environmental_tests "$dir"; then
+		echo "Environmental tests failed for $dir"
+	    fi
 	else 
 	    log=$(logfile_for build "$dir")
 	    echo "Build apparently succeeded, but no resulting plugin(s) found, or plugin(s) have wrong file type or platform" | tee -a "$log"
 	    echo "$dir" >> "$notbuilt"
 	fi
     else
 	echo "$dir" >> "$notbuilt"
     fi
     slog=$(logfile_for summary "$dir")
+    echo "initialising logfile $slog for $dir"
     cat /dev/null > "$slog"
 done
 
 cat "$built" | while read dir; do
     package "$dir"