Changeset 44049 in vbox for trunk/src/VBox/Installer

Timestamp:

Dec 6, 2012 11:31:26 AM (12 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

82516

Message:

Installer/linux: finish init script generator and add a couple of test cases.

Location:

trunk/src/VBox/Installer/linux

Files:

• Makefile.kmk (modified) (1 diff)
• install_service/Makefile.kmk (modified) (2 diffs)
• install_service/generate_service_file.cpp (modified) (2 diffs)
• install_service/init_template.sh (modified) (13 diffs)
• install_service/install_service.sh (added)
• testcase/Makefile.kmk (modified) (1 diff)
• testcase/tstInstallInit.sh (added)

trunk/src/VBox/Installer/linux/Makefile.kmk

@@ -19 +19 @@
 include $(KBUILD_PATH)/subheader.kmk
 
-# Include sub-makefile.
+# Include sub-makefiles.
+include $(PATH_SUB_CURRENT)/install_service/Makefile.kmk
 ifdef VBOX_WITH_TESTCASES
  include $(PATH_SUB_CURRENT)/testcase/Makefile.kmk

trunk/src/VBox/Installer/linux/install_service/Makefile.kmk

@@ -1 +1 @@
 # $Id$
 ## @file
-# Sub-Makefile for the VirtualBox Guest Addition X11 Client.
+# Sub-Makefile for the Linux installer init file generator.
 #
 
@@ -34 +34 @@
 endif
 
+INSTALLS.linux += linux-install-service-bin
+linux-install-service-bin_INST =    bin/helpers/
+linux-install-service-bin_MODE =    a+rx,u+w
+linux-install-service-bin_SOURCES = \
+        install_service.sh=>install_service
+
+INSTALLS.linux += linux-install-service-nobin
+linux-install-service-nobin_INST =    bin/helpers/
+linux-install-service-nobin_MODE =    a+r,u+w
+linux-install-service-nobin_SOURCES = \
+        init_template.sh
+
 include $(FILE_KBUILD_SUB_FOOTER)
 

trunk/src/VBox/Installer/linux/install_service/generate_service_file.cpp

@@ -89 +89 @@
 "      is supported.  This affects escaping of strings substituted.\n"
 "\n"
-"  --command\n"
+"  --command <command>\n"
 "      The absolute path of the executable file to be started by the service.\n"
 "      No form of quoting should be used here.  Substituted for the sequence\n"
@@ -95 +95 @@
     RTPrintf(
 "\n"
-"  --arguments <arguments>\n"
-"      The arguments to pass to the executable file when it is started.  ASCII\n"
-"      characters 0 to 31, \"\'\" and 127 should be escaped in C string-style and\n"
-"      spaces inside words should be preceeded by a back slash.  Some systemd-\n"
-"      style \"%%\" sequences may be added at a future time.  Substituted for the\n"
-"      sequence \"%%ARGUMENTS%%\" in the template.\n");
-    RTPrintf(
-"\n"
 "  --description <description>\n"
 "      A short description of the service which can also be used in sentences\n"
-"      like \"<description> failed to start.\".  ASCII characters 0 to 31 and 127\n"
-"      should not be used.  Substituted for the sequence \"%%DESCRIPTION%%\" in the\n"
-"      template.\n"
+"      like \"<description> failed to start.\", as a single parameter.  ASCII\n"
+"      characters 0 to 31 and 127 should not be used.  Substituted for the\n"
+"      sequence \"%%DESCRIPTION%%\" in the template.\n"
 "\n"
 "Other options:\n"
+"\n");
+    RTPrintf(
+"  --arguments <arguments>\n"
+"      The arguments to pass to the executable file when it is started, as a\n"
+"      single parameter.  ASCII characters 0 to 31, \"\'\" and 127 should be escaped\n"
+"      in C string-style and spaces inside words should be preceeded by a back\n"
+"      slash.  Some systemd-style \"%%\" sequences may be added at a future time.\n"
+"      Substituted for the sequence \"%%ARGUMENTS%%\" in the template.\n"
 "\n");
     RTPrintf(

trunk/src/VBox/Installer/linux/install_service/init_template.sh

@@ -23 +23 @@
 # Short-Description: %DESCRIPTION%
 ### END INIT INFO
+
+## @todo We should really replace the daemon starting, stopping and checking
+#        code with a tool of our own written in C, which we could always use
+#        instead of the LSB functions.
 
 cr="
@@ -71 +75 @@
 LSB_FUNCTIONS="/lib/lsb/init-functions"
 
-## Redhat and Fedora lock directory
-LOCK_FOLDER="/var/lock/subsys/"
-LOCK_FILE="${LOCK_FOLDER}/%SERVICE_NAME%"
-
 # Silently exit if the package was uninstalled but not purged.
-[ -r %COMMAND% ] || exit 0
+test -r %COMMAND% || exit 0
 
 ## The function definition at the start of every non-trivial shell script!
@@ -91 +91 @@
     exit 0
 }
+
+## Set the error message.
+set_error()
+{
+    test -z "${error}" && error="${1}"
+}
+
+# Gentoo/OpenRC perculiarity.
+if test "x${0}" = "x/sbin/rc" || test "x${0}" = "xrc"; then
+    shift
+fi
+
+# Process arguments.
+action=""
+error=""
+prefix="/var"
+while test x"${#}" != "x0"; do
+    case "${1}" in
+    --lsb-functions)
+        test x"${#}" = "x1" &&
+            set_error "${1}: missing argument."
+        LSB_FUNCTIONS="${2}"
+        shift 2;;
+    --prefix)
+        test x"${#}" = "x1" &&
+            set_error "${1}: missing argument."
+        prefix="${2}"
+        shift 2;;
+    --help)
+        cat << EOF
+Usage:
+
+  ${0} {start|stop|restart|status} [<options>]
+
+  start|stop|restart|status
+      Start/stop/restart/report status for the service.
+
+Options:
+
+  --lsb-functions <script>
+      Take the standard LSB init functions from <script> instead of from the
+      normal location, or use our own versions if <script> is an empty string.
+
+  --prefix <folder>
+      Use the folder <folder> for storing variable data instead of "/var".  The
+      child folder "run" must exist.
+EOF
+        exit 0;;
+    start|stop|restart|force-reload|condrestart|try-restart|reload|status)
+        test -z "${action}" ||
+            set_error "More than one action requested."
+        action="${1}"
+        shift;;
+    *)
+        set_error "Unknown option \"${1}\".  Try \"${0} --help\" for more information."
+        shift;;
+    esac
+done
+
+## Set Redhat and Fedora lock directory
+LOCK_FOLDER="${prefix}/lock/subsys/"
+LOCK_FILE="${LOCK_FOLDER}/%SERVICE_NAME%"
 
 # Use LSB functions if available.  Success and failure messages default to just
 # "echo" if the LSB functions are not available, so call these functions with
 # messages which clearly read as success or failure messages.
-[ -n "${LSB_FUNCTIONS}" ] && [ -f "${LSB_FUNCTIONS}" ] &&
+test -n "${LSB_FUNCTIONS}" && test -f "${LSB_FUNCTIONS}" &&
   . "${LSB_FUNCTIONS}"
 
@@ -101 +163 @@
     log_success_msg()
     {
-        echo "${*}"
-    }
-
-type log_success_fail >/dev/null 2>&1 ||
-    log_success_fail()
-    {
-        echo "${*}"
+        cat << EOF
+${*}
+EOF
+    }
+
+type log_failure_msg >/dev/null 2>&1 ||
+    log_failure_msg()
+    {
+        cat << EOF
+${*}
+EOF
     }
 
@@ -113 +179 @@
 pidfilename()
 {
-    echo "/var/run/${1##*/}.pid"
+    echo "${prefix}/run/${1##*/}.pid"
 }
 
@@ -119 +185 @@
 pidfileofproc()
 {
-    if [ x"${1}" = "x-p" ]; then
+    if test x"${1}" = "x-p"; then
         echo "${2}"
     else
@@ -129 +195 @@
 pidsfromfile()
 {
-    read -r pids < "${1}" 2>/dev/null
+    pids=""
+    test -r "${1}" &&
+        read -r pids < "${1}" 2>/dev/null
     for i in $pids; do
-        [ 1 -le "${i}" ] || return 1
+        test 1 -le "${i}" || return 1
+    done
     echo "${pids}"
 }
@@ -140 +209 @@
     binary="${1}"
     shift
-    ps -p "${@}" -f 2>/dev/null | grep -q "${binary}"
+    ps -p "${@}" -f 2>/dev/null | grep "${binary}" >/dev/null
 }
 
@@ -146 +215 @@
     pidofproc()
     {
-        pidfile="$(pidfileofproc "${@}")"
-        [ "x${1}" = "x-p" ] && shift 2
-        pids="$(pidsfromfile "${pidfile}")"
+        pidfile="`pidfileofproc "${@}"`"
+        test "x${1}" = "x-p" && shift 2
+        pids="`pidsfromfile "${pidfile}"`"
         procrunning "${1}" ${pids} && echo "${pids}"
     }
@@ -155 +224 @@
     killproc()
     {
-        pidfile="$(pidfileofproc "${@}")"
-        [ "x${1}" = "x-p" ] && shift 2
-        pids="$(pidsfromfile "${pidfile}")"
-        if [ -n "${2}" ]; then
+        pidfile="`pidfileofproc "${@}"`"
+        test "x${1}" = "x-p" && shift 2
+        pids="`pidsfromfile "${pidfile}"`"
+        if test -n "${2}"; then
             procrunning "${1}" ${pids} || return 1
             kill "${2}" ${pids}
@@ -165 +234 @@
             rm -f "${pidfile}"
             procrunning "${1}" ${pids} || return 0
-            kill "${pid}"
-            time=0
-            while true; do
-                sleep 1
-                procrunning "${1}" ${pids} || break
-                time=$((${time} + 1))
-                if [ "${time}" = "${SHUT_DOWN_TIME_OUT}" ]; then
-                    kill -9 "${pid}"
-                    break
-                fi
+            kill "${pids}"
+            # Short busy wait for the process to terminate.
+            stamp="`times`"
+            while test x"${stamp}" = x"`times`"; do
+                procrunning "${1}" ${pids} || return 0
+            done
+            # Slow sleeping wait if it is still running.
+            for high in "" 1 2 3 4 5 6 7 8 9; do
+                for time in ${high}0 ${high}1 ${high}2 ${high}3 ${high}4 ${high}5 ${high}6 ${high}7 ${high}8 ${high}9; do
+                    sleep 1
+                    procrunning "${1}" ${pids} || return 0
+                    if test "${time}" = "${SHUT_DOWN_TIME_OUT}"; then
+                        kill -9 "${pid}"
+                        return 0
+                    fi
+                done
             done
             return 0
@@ -182 +257 @@
 start()
 {
-    [ -d "${LOCK_FOLDER}" ] && touch "${LOCK_FILE}"
-    [ -n "$(pidofproc %COMMAND%)" ] && exit 0
+    test -d "${LOCK_FOLDER}" && touch "${LOCK_FILE}"
+    test -n "`pidofproc %COMMAND%`" && exit 0
     %COMMAND% %ARGUMENTS% >/dev/null 2>&1 &
     pid="$!"
-    pidfile="$(pidfilename %COMMAND%)"
+    pidfile="`pidfilename %COMMAND%`"
     echo "${pid}" > "${pidfile}"
     do_success
@@ -201 +276 @@
 status()
 {
-    [ -n "$(pidofproc %COMMAND%)" ] && exit 0
-    [ -f "$(pidfilename %COMMAND%)" ] && exit 1
-    [ -f "${LOCK_FILE}" ] && exit 2
+    pid="`pidofproc %COMMAND%`"
+    test -n "${pid}" &&
+    {
+        echo "%SERVICE_NAME% running, process ${pid}"
+        exit 0
+    }
+    test -f "`pidfilename %COMMAND%`" &&
+    {
+        echo "%SERVICE_NAME% not running but PID-file present."
+        exit 1
+    }
+    test -f "${LOCK_FILE}" &&
+    {
+        echo "%SERVICE_NAME% not running but lock file present."
+        exit 2
+    }
+    echo "%SERVICE_NAME% not running."
     exit 3
 }
 
-# Gentoo/OpenRC perculiarity.
-if [ "$(which "${0}")" = "/sbin/rc" ]; then
-    shift
-fi
-
-if [ "${1}" = "--lsb-functions" ]; then
-    LSB_FUNCTIONS="${2}"
-    shift 2
-fi
-
-case "${1}" in
+test -z "${error}" || abort "${error}"
+
+case "${action}" in
 start)
+    start;;
+stop)
+    stop;;
+restart|force-reload)
     start
-    ;;
-stop)
-    stop
-    ;;
-restart|force-reload)
-    stop
-    start
-    ;;
+    stop;;
 condrestart|try-restart)
     status || exit 0
     stop
-    start
-    ;;
+    start;;
 reload)
     ;;
 status)
-    status
-    ;;
-*)
-    echo "Usage: ${0} {start|stop|restart|status}"
-    exit 1
+    status;;
 esac

trunk/src/VBox/Installer/linux/testcase/Makefile.kmk

@@ -45 +45 @@
 tstHeadlessXOrg_SOURCES = tstHeadlessXOrg.sh
 
+INSTALLS += tstInstallInit
+TESTING += tstInstallInit
+tstHeadlessXOrg_INST    = $(INST_TESTCASE)
+tstHeadlessXOrg_MODE    = a+rx,u+w
+tstHeadlessXOrg_SOURCES = tstInstallInit.sh
+
 include $(FILE_KBUILD_SUB_FOOTER)