Changeset 43832 in vbox for trunk/src/VBox/Installer/linux

Timestamp:

Nov 7, 2012 2:37:42 PM (12 years ago)

Author:

vboxsync

Message:

Installer/linux: HeadlessXOrg clean-up.

Location:

trunk/src/VBox/Installer/linux

Files:

• VBoxHeadlessXOrg.sh (modified) (7 diffs)
• testcase/tstHeadlessXOrg.sh (modified) (12 diffs)

trunk/src/VBox/Installer/linux/VBoxHeadlessXOrg.sh

@@ -69 +69 @@
 rendering.  We only support X.Org Server at the moment.  Starting the X servers
 is managed by dropping one or more files xorg.conf.<n> into a configuration
-directory (by default ${DEFAULT_CONFIGURATION_FOLDER} - this can be overridden
+directory, by default ${DEFAULT_CONFIGURATION_FOLDER}, but this can be overridden
 in the configuration file (see below).  We will attempt to start an X server
 process for each configuration file using display number <n>.
@@ -76 +76 @@
 
   -c|--conf-file)        Specify an alternative locations for the configuration
-                         file.  The default location is \"${CONFIGURATION_FILE}\".
+                         file.  The default location is "${CONFIGURATION_FILE}".
 
   --help|--usage         Print this text.
@@ -119 +119 @@
 
   HEADLESS_X_ORG_SERVER_COMMAND
-    The default X server start-up command, containing the variables "${screen}"
-    for the screen number, "${conf_file}" for the configuration file path and
-    ${log_file} for the log file.  The variables must be quoted for expansion
-    at evaluation time, e.g.
-      HEADLESS_X_ORG_SERVER_COMMAND="Xorg :\${screen} [...] > \"\${log_file}\"
+    The default X server start-up command.  It will be passed three parameters
+    - in order, the screen number to use, the path of the X.Org configuration
+    file to use and the path of the X server log file to create.
 
   HEADLESS_X_ORG_SERVER_POST_COMMAND
@@ -129 +127 @@
     default this stores the service configuration information to VirtualBox
     extra data for each of the users in the list \${HEADLESS_X_ORG_USERS}.
-
-  HEADLESS_X_ORG_SERVER_LOG_FILE_TEMPLATE
-    The default X server log file name, containing the variable "\${screen}" for
-    the screen number.  The variable must be quoted for expansion at evaluation
-    time, e.g.
-      HEADLESS_X_ORG_SERVER_LOG_FILE_TEMPLATE="Xorg.\${screen}.log"
+    It will be passed a single parameter which is a space-separated list of the
+    X server screen numbers.
 EOF
 }
@@ -144 +138 @@
 HEADLESS_X_ORG_RUN_FOLDER="/var/run/${SERVICE_NAME}"
 HEADLESS_X_ORG_CHECK_PREREQUISITES="udevadm settle || ! udevadm -V"
+HEADLESS_X_ORG_USERS=""
+
 X_AUTH_FILE="${HEADLESS_X_ORG_RUN_FOLDER}/xauth"
-HEADLESS_X_ORG_SERVER_PRE_COMMAND="echo > \"${X_AUTH_FILE}\"; xauth -f \"${X_AUTH_FILE}\" add :0 . \"\$(dd if=/dev/urandom count=1 bs=16 2>/dev/null | od -An -x)\"; for i in ${HEADLESS_X_ORG_USERS}; do cp \"${X_AUTH_FILE}\" \"${X_AUTH_FILE}.${i}\"; chown \"${i}\" \"${X_AUTH_FILE}.${i}\"; done"
-HEADLESS_X_ORG_SERVER_COMMAND="Xorg :\${screen} -auth \"${HEADLESS_X_ORG_RUN_FOLDER}/xauth\" -config \"\${conf_file}\" -logverbose 0 -logfile /dev/null -verbose 7 > \"\${log_file}\" 2>&1"
-HEADLESS_X_ORG_SERVER_LOG_FILE_TEMPLATE="Xorg.\${screen}.log"
+default_pre_command()
+{
+  echo > "${X_AUTH_FILE}"
+  key="$(dd if=/dev/urandom count=1 bs=16 2>/dev/null | od -An -x)"
+  xauth -f "${X_AUTH_FILE}" add :0 . "${key}"
+  for i in ${HEADLESS_X_ORG_USERS}; do
+    cp "${X_AUTH_FILE}" "${X_AUTH_FILE}.${i}"
+    chown "${i}" "${X_AUTH_FILE}.${i}"
+  done
+}
+HEADLESS_X_ORG_SERVER_PRE_COMMAND="default_pre_command"
+
+default_command()
+{
+  auth="${HEADLESS_X_ORG_RUN_FOLDER}/xauth"
+  # screen=$1
+  # conf_file=$2
+  # log_file=$3
+  Xorg :"${1}" -auth "${auth}" -config "${2}" -logverbose 0 -logfile /dev/null -verbose 7 > "${3}" 2>&1
+}
+HEADLESS_X_ORG_SERVER_COMMAND="default_command"
+
+default_post_command()
+{
+  # screens=$1
+  for i in ${HEADLESS_X_ORG_USERS}; do
+    su ${i} -c "VBoxManage setextradata global HeadlessXServer/Screens \"${1}\""
+    su ${i} -c "VBoxManage setextradata global HeadlessXServer/AuthFile \"${HEADLESS_X_ORG_RUN_FOLDER}/xauth\""
+  done
+}
+HEADLESS_X_ORG_SERVER_POST_COMMAND="default_post_command"
 
 ## The function definition at the start of every non-trivial shell script!
@@ -248 +272 @@
 
 X_SERVER_PIDS=""
+X_SERVER_SCREENS=""
 trap "kill \${X_SERVER_PIDS} 2>/dev/null" ${EXIT_SIGNALS}
 space=""  # Hack to put spaces between the pids but not before or after.
@@ -258 +283 @@
   [ 0 -le "${screen}" ] 2>/dev/null ||
     abort "Badly formed file name \"${conf_file}\".\n"
-  log_file="${HEADLESS_X_ORG_LOG_FOLDER}/$(eval echo "${HEADLESS_X_ORG_SERVER_LOG_FILE_TEMPLATE}")"
-  eval "${HEADLESS_X_ORG_SERVER_COMMAND}" "&"
+  log_file="${HEADLESS_X_ORG_LOG_FOLDER}/Xorg.${screen}.log"
+  eval "${HEADLESS_X_ORG_SERVER_COMMAND} \"\${screen}\" \"\${conf_file}\" \"\${log_file}\"" "&"
   X_SERVER_PIDS="${X_SERVER_PIDS}${space}$!"
+  X_SERVER_SCREENS="${X_SERVER_SCREENS}${space}${screen}"
   space=" "
 done
 
 # Do any post-start work.
-eval "${HEADLESS_X_ORG_SERVER_POST_COMMAND}"
+eval "${HEADLESS_X_ORG_SERVER_POST_COMMAND} \"${X_SERVER_SCREENS}\""
 
 wait

trunk/src/VBox/Installer/linux/testcase/tstHeadlessXOrg.sh

@@ -69 +69 @@
 HEADLESS_X_ORG_CHECK_PREREQUISITES=
 HEADLESS_X_ORG_SERVER_PRE_COMMAND=
-HEADLESS_X_ORG_SERVER_COMMAND="echo \\\${screen} \\\${conf_file} \\\${log_file}"
-HEADLESS_X_ORG_SERVER_LOG_FILE_TEMPLATE="log.\\\${screen}"
+HEADLESS_X_ORG_SERVER_COMMAND="echo"
 EOF
 
@@ -95 +94 @@
 # Create a temporary directory for configuration and logging.
 for i in 0 1 2 3 4 5 6 7 8 9; do
-  TEST_FOLDER="/tmp/${TEST_NAME}${i}"
+  TEST_FOLDER="/tmp/${TEST_NAME} ${i}"  # Space in the name to test quoting.
   mkdir -m 0700 "${TEST_FOLDER}" 2>/dev/null && break
 done
@@ -105 +104 @@
 mkdir -p "${XORG_FOLDER}"
 
-# Simple start-up test.
+###############################################################################
+# Simple start-up test.                                                       #
+###############################################################################
 print_line "simple start-up test"
 create_basic_configuration_file "${TEST_FOLDER}/conf" "${TEST_FOLDER}"
@@ -118 +119 @@
     LOG_FOLDER="${TEST_FOLDER}/log"
     LOG="${LOG_FOLDER}/log"
-    if grep -q "2 ${XORG_FOLDER}/xorg.conf.2 ${LOG_FOLDER}/log.2" "${LOG}" &&
-      grep -q "4 ${XORG_FOLDER}/xorg.conf.4 ${LOG_FOLDER}/log.4" "${LOG}"; then
+    if grep -q "2 ${XORG_FOLDER}/xorg.conf.2 ${LOG_FOLDER}/Xorg.2.log" "${LOG}" &&
+      grep -q "4 ${XORG_FOLDER}/xorg.conf.4 ${LOG_FOLDER}/Xorg.4.log" "${LOG}"; then
       printf "SUCCESS.\n"
     else
@@ -135 +136 @@
 rm "${XORG_FOLDER}"/xorg.conf.*
 
-# No configuration files.
+###############################################################################
+# No configuration files.                                                     #
+###############################################################################
 print_line "no configuration files"
 
@@ -154 +157 @@
 expect_exit "${PID}" 5 test_should_fail
 
-# Bad configuration files.
+###############################################################################
+# Bad configuration files.                                                    #
+###############################################################################
 print_line "bad configuration files"
 touch "${XORG_FOLDER}/xorg.conf.2"
@@ -164 +169 @@
 rm "${XORG_FOLDER}/"xorg.conf.*
 
+###############################################################################
+# Long running server command.                                                #
+###############################################################################
+
 # Set up a configuration file for a long-running command.
 create_basic_configuration_file "${TEST_FOLDER}/conf" "${TEST_FOLDER}"
 cat >> "${TEST_FOLDER}/conf" << EOF
-HEADLESS_X_ORG_SERVER_COMMAND="\"${TEST_NAME_FULL}\" --test-sleep \\\${screen}"
-EOF
-
-# Long running server command.
+HEADLESS_X_ORG_SERVER_COMMAND="\"${TEST_NAME_FULL}\" --test-sleep"
+EOF
+
 print_line "long running server command (sleeps)"
 touch "${XORG_FOLDER}/xorg.conf.1"
@@ -208 +216 @@
 rm "${XORG_FOLDER}/"xorg.conf.*
 
+###############################################################################
+# Pre-requisite test.                                                         #
+###############################################################################
+
 # Set up a configuration file with a pre-requisite.
 create_basic_configuration_file "${TEST_FOLDER}/conf" "${TEST_FOLDER}"
@@ -214 +226 @@
 EOF
 
-# Pre-requisite test.
 print_line "configuration file with pre-requisite (sleeps)"
 touch "${XORG_FOLDER}/xorg.conf.2"
@@ -231 +242 @@
 rm -r "${XORG_FOLDER}"/xorg.conf.* "${TEST_FOLDER}/run"
 
+###############################################################################
+# Pre-command test.                                                           #
+###############################################################################
+
 # Set up our pre-command test configuration file.
 create_basic_configuration_file "${TEST_FOLDER}/conf" "${TEST_FOLDER}"
+
 cat >> "${TEST_FOLDER}/conf" << EOF
+test_pre_command_server_command()
+{
+  cp "${TEST_FOLDER}/run/pre" "${TEST_FOLDER}/run/pre2"
+}
 HEADLESS_X_ORG_SERVER_PRE_COMMAND="touch \"${TEST_FOLDER}/run/pre\""
-HEADLESS_X_ORG_SERVER_COMMAND="cp \"${TEST_FOLDER}/run/pre\" \"${TEST_FOLDER}/run/pre2\""
-EOF
-
-# Pre-command test.
+HEADLESS_X_ORG_SERVER_COMMAND="test_pre_command_server_command"
+EOF
+
 print_line "pre-command test"
 touch "${XORG_FOLDER}/xorg.conf.2"
@@ -266 +285 @@
 rm -f "${XORG_FOLDER}"/xorg.conf.* "${TEST_FOLDER}"/run/pre*
 
+###############################################################################
+# Post-command test.                                                          #
+###############################################################################
+
 # Set up our post-command test configuration file.
 create_basic_configuration_file "${TEST_FOLDER}/conf" "${TEST_FOLDER}"
 cat >> "${TEST_FOLDER}/conf" << EOF
-HEADLESS_X_ORG_SERVER_COMMAND="rm -f \"${TEST_FOLDER}/run/post\""
-HEADLESS_X_ORG_SERVER_POST_COMMAND="touch \"${TEST_FOLDER}/run/post\""
-EOF
-
-# Post-command test.
+test_post_command_post_command()
+{
+  echo "\${1}" > "${TEST_FOLDER}/run/post"
+}
+HEADLESS_X_ORG_SERVER_POST_COMMAND="test_post_command_post_command"
+EOF
+
 print_line "post-command test"
 touch "${XORG_FOLDER}/xorg.conf.2"
@@ -285 +310 @@
     LOG_FOLDER="${TEST_FOLDER}/log"
     LOG="${LOG_FOLDER}/log"
-    if [ -e "${TEST_FOLDER}/run/post" ]; then
+    if grep -q "2 4" "${TEST_FOLDER}/run/post"; then
       printf "SUCCESS.\n"
     else