updated

ChangeLog

@@ -1,3 +1,31 @@
+2015-11-09 15:13  marc
+
+	* scripts/bootstrap.sh, scripts/resolve-debbuilddeps.sh,
+	  scripts/sql-to-dot.sed: better documentation
+
+2015-11-07 10:47  marc
+
+	* bootstrap.sh, scripts/bootstrap.sh: there is no qt4-default
+
+2015-11-07 09:23  marc
+
+	* bootstrap.sh, scripts/bootstrap.sh: there is no qt4-default
+
+2015-11-07 00:20  marc
+
+	* README: set Section
+
+2015-11-07 00:11  marc
+
+	* ChangeLog, ax_init_standard_project.m4, bootstrap.sh,
+	  scripts/ax_init_standard_project.m4, scripts/bootstrap.sh: fixed
+	  debian readme issue
+
+2015-11-06 15:34  marc
+
+	* scripts/sql-to-dot.sed: new script to convert sql schema files
+	  into graphviz dot
+
 2015-11-05 15:59  marc
 
 	* README, scripts/ax_init_standard_project.m4,

README

@@ -68,6 +68,10 @@ Then I continue, I rerun bootstrap.sh, this time with option -b which calls make
 
     ../../bootstrap-build-environment/scripts/bootstrap.sh -b
 
+Add some additional files:
+
+    svn add trunk/{COPYING,INSTALL,ChangeLog}
+
 Everything is fine, so checkin the changes and cleanup the system:
 
     cd ..

bootstrap.sh

@@ -110,7 +110,9 @@ GENERATED FILES
     * resolve-rpmbuilddeps.sh - script to install RPM package dependencies
     * build-in-docker.sh - script to build the project encapsulated in a docker container
     * build-resource-file.sh - build resource.qrc file from a resource directory
+    * sql-to-dot.sed - script to convert SQL schema files to graphviz dot in doxygen
     * mac-create-app-bundle.sh - script to create apple mac os-x app-bundle
+    * test/runtests.sh - template file to run test scripts, i.e. docker based
     * AUTHORS - replace your name in AUTHORS before first run
     * NEWS - empty file add your project's news
     * README - add project description (first line is header, followed by an empty line)
@@ -196,7 +198,7 @@ FILES
                   <ou can access the readme by calling
                   ${DEFAULT_PROJECT_NAME}::description().
   * ChangeLog:    Your changelog is automatically maintained from
-                  subversion history, using svn2cl | subversion-tools. You don't need to
+                  subversion history, using svn2cl. You don't need to
                   care about.
   * configure.ac: This file becomes very short and simple. You provide
                   the project name, the major and minor version. The
@@ -424,6 +426,7 @@ copy resolve-debbuilddeps.sh
 copy resolve-rpmbuilddeps.sh
 copy build-in-docker.sh
 copy build-resource-file.sh
+copy sql-to-dot.sed
 copy mac-create-app-bundle.sh
 AUTHOR=$(gpg -K  | sed -n 's,uid *,,p' | sort | head -1)
 if test -z "${AUTHOR}"; then
@@ -718,6 +721,7 @@ ${HEADER}dist_bin_SCRIPTS =
 MAINTAINERCLEANFILES = makefile.in
 EOF
 echo "${HEADER}MAINTAINERCLEANFILES = makefile.in" | to --condition AX_USE_DOXYGEN doc/makefile.am
+to --condition AX_BUILD_TEST test/runtests.sh < test/runtests.sh
 to --condition 'AX_BUILD_TEST|AX_USE_CPPUNIT' test/makefile.am <<EOF
 ${HEADER}$(if testtag AX_USE_CXX; then
 cat <<EOF2
@@ -771,6 +775,7 @@ if testtag AX_USE_DOXYGEN; then
         doxyadd ALIASES '"classmutex=\\par Reentrant:\\nAccess is locked with class static mutex @c "'
         doxyadd ALIASES '"instancemutex=\\par Reentrant:\\nAccess is locked with per instance mutex @c "'
         doxyadd ALIASES '"mutex=\\par Reentrant:\\nAccess is locked with mutex @c "'
+        doxyadd ALIASES '"api=\\xrefitem api \\"API Call\\" \\"\\""'
         doxyreplace ENABLE_PREPROCESSING YES
         doxyreplace MACRO_EXPANSION YES
         doxyadd PREDEFINED '"NAMESPACE=@PACKAGE_NAME@"'
@@ -797,14 +802,14 @@ if testtag AX_USE_DOXYGEN; then
         if testtag AX_BUILD_TEST AX_USE_CPPUNIT; then
             doxyadd INPUT "@top_srcdir@/test"
         fi
-        doxyreplace FILE_PATTERNS '*.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.idl *.ddl *.odl *.h *.hh *.hxx *.hpp *.h++ *.cs *.d *.php *.php4 *.php5 *.phtml *.inc *.m *.markdown *.md *.mm *.dox *.py *.f90 *.f *.for *.tcl *.vhd *.vhdl *.ucf *.qsf *.as *.js *.wt'
+        doxyreplace FILE_PATTERNS '*.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.idl *.ddl *.odl *.h *.hh *.hxx *.hpp *.h++ *.cs *.d *.php *.php4 *.php5 *.phtml *.inc *.m *.markdown *.md *.mm *.dox *.py *.f90 *.f *.for *.tcl *.vhd *.vhdl *.ucf *.qsf *.as *.js *.wt *.sql'
         doxyreplace RECURSIVE YES
         doxyreplace EXCLUDE_PATTERNS "moc_* uic_* qrc_*"
         if testtag AX_BUILD_EXAMPLES; then
             doxyreplace EXAMPLE_PATH @top_srcdir@/examples
         fi
         doxyreplace EXAMPLE_RECURSIVE YES
-        doxyreplace FILTER_PATTERNS '*.wt=doxygen-webtester.sed'
+        doxyreplace FILTER_PATTERNS '*.wt=doxygen-webtester.sed *.sql=@top_srcdir@/sql-to-dot.sed'
         doxyreplace SOURCE_BROWSER YES
         doxyreplace INLINE_SOURCES YES
         doxyreplace GENERATE_TESTLIST YES
@@ -822,7 +827,7 @@ if testtag AX_USE_DOXYGEN; then
         doxyreplace CLASS_GRAPH YES
         doxyreplace TEMPLATE_RELATIONS YES
         doxyreplace DOT_IMAGE_FORMAT svg
-        doxyreplace INTERACTIVE_SVG YES
+        doxyreplace INTERACTIVE_SVG NO
         doxyreplace DOT_TRANSPARENT YES
     fi
 fi
@@ -835,7 +840,7 @@ if testtag AX_USE_DEBIAN_PACKAGING; then
 
  -- @AUTHOR@  @BUILD_DATE@
 EOF
-    BUILD_DEPENDS="debhelper, subversion, pkg-config, automake, libtool, autotools-dev, lsb-release $(if testtag AX_USE_DOXYGEN; then echo -n ", doxygen, graphviz, mscgen"; fi; if testtag AX_USE_CPPUNIT; then echo -n ", libcppunit-dev"; fi; if testtag AX_CXX_QT || testtag AX_CHECK_QT AX_REQUIRE_QT; then echo -n ", qt5-default | libqt4-core, qt5-qmake | qt4-qmake, qtbase5-dev | libqt4-dev, qtbase5-dev-tools | qt4-dev-tools, qttools5-dev-tools | qt4-dev-tools, qttools5-dev-tools | qt4-dev-tools"; fi)"
+    BUILD_DEPENDS="debhelper, subversion, pkg-config, automake, libtool, autotools-dev, lsb-release $(if testtag AX_USE_DOXYGEN; then echo -n ", doxygen, graphviz, mscgen"; fi; if testtag AX_USE_CPPUNIT; then echo -n ", libcppunit-dev"; fi; if testtag AX_CXX_QT || testtag AX_CHECK_QT AX_REQUIRE_QT; then echo -n ", qt5-default | libqt4-core | libqtcore4, qt5-qmake | qt4-qmake, qtbase5-dev | libqt4-dev, qtbase5-dev-tools | qt4-dev-tools, qttools5-dev-tools | qt4-dev-tools, qttools5-dev-tools | qt4-dev-tools"; fi)"
     to debian/control.in <<EOF
 Source: @PACKAGE_NAME@
 Priority: extra
@@ -1050,7 +1055,7 @@ if test -f makefile; then
 fi
 
 #### Bootstrap Before Configure ####
-run --no-check svn2cl | subversion-tools
+run --no-check svn2cl
 run aclocal
 if testtag AX_USE_LIBTOOL; then run libtoolize --force; fi
 run automake -a

resolve-debbuilddeps.sh

@@ -11,25 +11,27 @@
 ## 45678901234567890123456789012345678901234567890123456789012345678901234567890
 
 SCHROOTNAME="$1"
+if test -n "${SCHROOTNAME}"; then
+  DO="schroot -c "${SCHROOTNAME}" --"
+  SUDO="schroot -c "${SCHROOTNAME}" -u root -d / --"
+else
+  DO=""
+  SUDO="sudo"
+fi
 
 function install() {
-    if test -n "${SCHROOTNAME}"; then
+    if ${SUDO} apt-get -y install $*; then
-        if schroot -c "${SCHROOTNAME}" -u root -d / -- apt-get -y install $*; then
         return 0
-        fi
     else
-        if apt-get -y install $*; then
-            return 0
-        fi
-    fi
         return 1
+    fi
 }
 
 TO_INSTALL=
 
 if test -e debian/control.in -a ! -e debian/control; then
     for f in $(sed -n 's, *AX_DEB_DEPEND_IFEXISTS(\([^)]*\)).*,\1,p' configure.ac); do
-        if test -n "$(apt-cache policy -q ${f})" && ! dpkg -l "${f}"; then
+        if test -n "$(${DO} apt-cache policy -q ${f})" && ! ${DO} dpkg -l "${f}"; then
             TO_INSTALL+=" ${f}"
         fi
     done
@@ -38,13 +40,8 @@ if test -e debian/control.in -a ! -e debian/control; then
         sed 's,@[^@]*@, dummytext,g' > debian/control
 fi
 
-if test -n "${SCHROOTNAME}"; then
+install dpkg-dev
-  schroot -c "${SCHROOTNAME}" -u root -d / -- apt-get -y install dpkg-dev
+DEPS=$(${DO} dpkg-checkbuilddeps 2>&1 || true)
-  DEPS=$(schroot -c "${SCHROOTNAME}" -- dpkg-checkbuilddeps 2>&1 || true)
-else
-  apt-get -y install dpkg-dev
-  DEPS=$(dpkg-checkbuilddeps 2>&1 || true)
-fi
 DEPS=$(echo "$DEPS" | sed -n '/Unmet build dependencies/ { s,.*Unmet build dependencies: ,,g; s, ([^)]*),,g; s, *| *,|,g; p}')
 
 for pa in ${DEPS}; do

scripts/bootstrap.sh

@@ -112,6 +112,7 @@ GENERATED FILES
     * build-resource-file.sh - build resource.qrc file from a resource directory
     * sql-to-dot.sed - script to convert SQL schema files to graphviz dot in doxygen
     * mac-create-app-bundle.sh - script to create apple mac os-x app-bundle
+    * test/runtests.sh - template file to run test scripts, i.e. docker based
     * AUTHORS - replace your name in AUTHORS before first run
     * NEWS - empty file add your project's news
     * README - add project description (first line is header, followed by an empty line)
@@ -197,7 +198,7 @@ FILES
                   <ou can access the readme by calling
                   ${DEFAULT_PROJECT_NAME}::description().
   * ChangeLog:    Your changelog is automatically maintained from
-                  subversion history, using svn2cl | subversion-tools. You don't need to
+                  subversion history, using svn2cl. You don't need to
                   care about.
   * configure.ac: This file becomes very short and simple. You provide
                   the project name, the major and minor version. The
@@ -720,6 +721,7 @@ ${HEADER}dist_bin_SCRIPTS =
 MAINTAINERCLEANFILES = makefile.in
 EOF
 echo "${HEADER}MAINTAINERCLEANFILES = makefile.in" | to --condition AX_USE_DOXYGEN doc/makefile.am
+to --condition AX_BUILD_TEST test/runtests.sh < test/runtests.sh
 to --condition 'AX_BUILD_TEST|AX_USE_CPPUNIT' test/makefile.am <<EOF
 ${HEADER}$(if testtag AX_USE_CXX; then
 cat <<EOF2
@@ -773,6 +775,7 @@ if testtag AX_USE_DOXYGEN; then
         doxyadd ALIASES '"classmutex=\\par Reentrant:\\nAccess is locked with class static mutex @c "'
         doxyadd ALIASES '"instancemutex=\\par Reentrant:\\nAccess is locked with per instance mutex @c "'
         doxyadd ALIASES '"mutex=\\par Reentrant:\\nAccess is locked with mutex @c "'
+        doxyadd ALIASES '"api=\\xrefitem api \\"API Call\\" \\"\\""'
         doxyreplace ENABLE_PREPROCESSING YES
         doxyreplace MACRO_EXPANSION YES
         doxyadd PREDEFINED '"NAMESPACE=@PACKAGE_NAME@"'
@@ -824,7 +827,7 @@ if testtag AX_USE_DOXYGEN; then
         doxyreplace CLASS_GRAPH YES
         doxyreplace TEMPLATE_RELATIONS YES
         doxyreplace DOT_IMAGE_FORMAT svg
-        doxyreplace INTERACTIVE_SVG YES
+        doxyreplace INTERACTIVE_SVG NO
         doxyreplace DOT_TRANSPARENT YES
     fi
 fi
@@ -1052,7 +1055,7 @@ if test -f makefile; then
 fi
 
 #### Bootstrap Before Configure ####
-run --no-check svn2cl | subversion-tools
+run --no-check svn2cl
 run aclocal
 if testtag AX_USE_LIBTOOL; then run libtoolize --force; fi
 run automake -a

scripts/test/runtests.sh

@@ -0,0 +1,120 @@
+#!/bin/bash -e
+
+#check for a text in a docker volume log
+function check() {
+    if test $(docker inspect -f {{.State.Running}} $1) = "false"; then
+        echo
+        echo "**** ERROR: container $1 not running"
+        exit 1
+    fi
+    docker logs $1 2>&1 | grep -q "$2"
+}
+
+# call with volume name
+function wait_for_mysql() {
+    check $1 "mysqld: ready for connections"
+}
+
+# run a countdown and call a check function
+# $1:  expected time in seconds
+# $2-: check function
+function countdown() {
+    set +x
+    expect=$1
+    shift
+    max=$1
+    shift
+    for ((i=0; i<$((expect+max)); ++i)); do
+        echo -en "\rPlease wait: $((expect-i))s    "
+        $* && break || sleep 1
+    done
+    echo -e "\rdone in ${i}s: $*                      "
+    echo
+    set -x
+}
+
+# should not be called with sudo root
+if test "$(whoami)" = "root"; then
+    echo "**** ERROR: call as non root user"
+    exit 1
+fi
+
+# option checks
+NEED_XVFB=0
+NEED_DOCKER=0
+NEED_WEBTESTER=0
+while test $# -gt 0; do
+    case "$1" in
+        (--help|-h)
+            echo "$0 [OPTIONS] [PORTS <port>]"
+            echo
+            echo "OPTIONS:"
+            echo
+            exit 0
+            ;;
+        (*) echo "**** ERROR: unknown option '$1', try --help"; exit 1;;
+    esac
+    if test $# -eq 0; then
+        echo "**** ERROR: missing value, try --help"; exit 1;
+    fi
+    shift
+done
+
+error=0;
+
+# test for xvfb (needed by webtester)
+if test ${NEED_XVFB} -eq 1 -a \! -e "$(which xvfb-run)"; then
+    echo "**** ERROR: XVFB Not Installed"
+    echo "you need to install xvfb"
+    echo "please execute as root:"
+    echo "  apt-get install xvfb"
+    error=1
+fi
+
+# test for docker if needed
+if test ${NEED_DOCKER} -eq 1 -a \! -e "$(which docker)"; then
+    echo "**** ERROR: Docker Not Installed"
+    echo "you need to install the latest docker"
+    echo "please execute as root:"
+    echo "  apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 \\"
+    echo "    --recv-keys 36A1D7869245C8950F966E92D8576A8BA88D21E9"
+    echo "  echo 'deb https://get.docker.io/ubuntu docker main' \\"
+    echo "    > /etc/apt/sources.list.d/docker.list"
+    echo "  apt-get update"
+    echo "  apt-get install lxc-docker"
+    echo "  adduser $(whoami) docker"
+    echo "you need to add the following line to /etc/default/docker:"
+    echo '  DOCKER_OPTS="--insecure-registry dev0004:5000"'
+    echo "logout $(whoami) and login again to run $(whoami) with group docker"
+    echo "additionals note:"
+    echo "  if you run docker inside a VM (not recommended), you probably"
+    echo "  need to foollow the instructions in chapter \"Changing Bridge"
+    echo "  Subnetwork\" on https://marc.wäckerlin.ch/computer/docker-overview"
+    echo "introduction to docker, see:"
+    echo "  https://marc.wäckerlin.ch/computer/docker-overview"
+    error=1
+fi
+
+# check for webtester
+if test ${NEED_WEBTESTER} -eq 1 -a \! -e "$(which webrunner)"; then
+    echo "**** ERROR: Webtester Not Installed"
+    echo "you need to install webtester"
+    echo "please execute as root:"
+    echo "  apt-get install -y wget software-properties-common apt-transport-https"
+    echo "  apt-add-repository https://dev.marc.waeckerlin.org/repository"
+    echo "  wget -O- https://dev.marc.waeckerlin.org/repository/PublicKey \\"
+    echo "    | apt-key add -"
+    echo "  apt-get update -y"
+    echo "  apt-get install -y webtester"
+    echo "more information, see:"
+    echo "  https://dev.marc.waeckerlin.org/redmine/projects/webtester"
+    error=1
+fi
+
+if test "$error" = "1"; then
+    exit 1
+fi
+
+set -x
+
+# Add tests here

sql-to-dot.sed

@@ -0,0 +1,41 @@
+#! /bin/sed -f
+1i\
+/** @page database Database Schema\
+\
+@dot\
+digraph schema {
+
+# remove newlines
+:a;N;$!ba;s/\n/ /g
+# reduce spaces
+s, \+, ,g
+
+s| *CREATE *TABLE *\(if *not *exists\)\? *`\?\([a-z]\+\)`\? *|\n    \2\n        [shape=none, margin=0, label=<\n            <table bgcolor="#dddddd">\n                <tr><td bgcolor="#ddddff" colspan="4"><b>\2</b></td></tr>\n|ig
+
+s/varchar *( *\([0-9]\+\) *)/varchar[\1]/ig
+
+s/ *PRIMARY KEY *( *`\?\([a-z]\+\)`\? *) *[,)]//ig
+
+:b;s/\([a-z]\+\)\([^;]*\)FOREIGN KEY *( *`\?\([a-z]\+\)`\? *) *REFERENCES *`\?\([a-z]\+\)`\? *( *`\?\([a-z]\+\)`\? *) *\([^,)]*\)[,)]\(.*\)/\1\2\7\n \1:\3 -> \4:\5/ig;tb
+
+:c;s|\n[(,] *`\?\([a-z]\+\)`\? *\([^ ]\+\)*\([^,)]*\) *COMMENT *[`"']\([^`"']*\)[`"'] *[,)]|\n                <tr><td align="left" port="\1"><b>\1</b></td><td align="left">\2</td><td align="left">\3</td><td align="left">\4</td></tr>\n,|ig;tc
+
+s| \+</td>|</td>|g
+s|<td> \+|<td>|g
+s|\(<td[^>]*>[^<]\{30,40\}\) \+\([^<]\{20,\}</td>\)|\1<br/>\2|g
+:d;s|\(<br/>[^<]\{30,40\}\) \+\([^<]\{20,\}</td>\)|\1<br/>\2|g;td
+
+s| *COMMENT *= *["']\?\([^"']*\)["']\?|\n                <tr><td bgcolor="#ddddff" colspan="4">\1</td></tr>|ig
+
+s| \+</td>|</td>|g
+s|<td> \+|<td>|g
+s|\(<td[^>]*>[^<]\{60,80\}\) \+\([^<]\{30,\}</td>\)|\1<br/>\2|g
+:e;s|\(<br/>[^<]\{60,80\}\) \+\([^<]\{30,\}</td>\)|\1<br/>\2|g;te
+
+s/\n,[^\n]*/\n/g
+s|;|\n            </table>\n        >];\n|ig
+
+$a\
+}\
+@enddot\
+*/