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

Timestamp:

Aug 9, 2011 4:22:56 PM (13 years ago)

Author:

vboxsync

Message:

Installer/Linux: cleaned up the USB device node installation for the generic installer

Location:

trunk/src/VBox/Installer/linux

Files:

• install.sh (modified) (1 diff)
• installer-utils.sh (modified) (4 diffs)
• testcase/tstInstallerLinux.sh (modified) (1 diff)

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

@@ -442 +442 @@
     fi
 
-    # Create udev description file
-    install_udev "$VBOXDRV_GRP" "$VBOXDRV_MODE" "$INSTALLATION_DIR" \
-        > /etc/udev/rules.d/10-vboxdrv.rules
-
-    # Build our device tree
-    for i in /sys/bus/usb/devices/*; do
-        if test -r "$i/dev"; then
-            dev="`cat "$i/dev" 2> /dev/null`"
-            major="`expr "$dev" : '\(.*\):' 2> /dev/null`"
-            minor="`expr "$dev" : '.*:\(.*\)' 2> /dev/null`"
-            class="`cat $i/bDeviceClass 2> /dev/null`"
-            sh "$INSTALLATION_DIR/VBoxCreateUSBNode.sh" "$major" "$minor" "$class" 2>/dev/null
-        fi
-    done
+    install_device_node_setup "$VBOXDRV_GRP" "$VBOXDRV_MODE" "$INSTALLATION_DIR"
 
     # Write the configuration. Do this before we call /etc/init.d/vboxdrv setup!

trunk/src/VBox/Installer/linux/installer-utils.sh

@@ -15 +15 @@
 
 setup_normal_input_install_udev() {
-    TEST_UDEV_VERSION="$1"  # udev version to simulate
+    # The udev rule setup functions contain some aliases which are used for unit
+    # testing purposes.  This function sets up the aliases to point to the real
+    # commands for "normal" use.
     eval 'my_which() { which "$@" ; }'
     eval 'my_test() { test "$@" ; }'
@@ -21 +23 @@
 }
 
+# Needs to be done before the udev setup functions are called "normally" (i.e.
+# not in a unit testing context).  Will be overridden later in a unit test.
 setup_normal_input_install_udev
 
 setup_test_input_install_udev() {
+    # Set up unit testing environment for the "install_udev" function below.
     TEST_NAME="$1"          # used to identify the current test
     TEST_UDEV_VERSION="$2"  # udev version to simulate
@@ -30 +35 @@
     eval 'my_rm() { case "$2" in "/etc/udev/rules.d/60-vboxdrv.rules") true ;; *) echo "rm: bad file name \"$2\"!"; false ;; esac ; }'
     eval 'test_udev() { echo "$TEST_UDEV_VERSION" ; }'
+    DELETED_UDEV_FILE=""
+}
+
+cleanup_test_input_install_udev() {
+    # Clean up after unit testing install_udev for a given input
+    setup_normal_input_install_udev
+    unset test_udev
     DELETED_UDEV_FILE=""
 }
@@ -108 +120 @@
 }
 
-cleanup_test_input_install_udev() {
-    setup_normal_input_install_udev
-    unset test_udev
-    DELETED_UDEV_FILE=""
-}
+setup_normal_input_install_create_usb_node() {
+    # install_create_usb_node_for_sysfs contain some aliases for unit testing
+    # purposes.  This function sets up the aliases to point to the real
+    # commands for "normal" use.
+    eval 'my_test() { test "$@" ; }'
+    eval 'my_cat() { cat "$@" ; }'
+    eval 'my_sh() { sh "$@" ; }'
+}
+
+# Assume we will be calling the function normally, not for unit testing
+setup_normal_input_install_create_usb_node
+
+# Add a unit test here if/when needed following the same pattern as
+# setup_test_input_install_udev.
+
+install_create_usb_node_for_sysfs() {
+    # Create a usb device node for a given sysfs path
+    path="$1"           # sysfs path for the device
+    usb_createnode="$2" # Path to the USB device node creation script
+    usb_group="$3"      # The group to give ownership of the node to
+    if my_test -r "${path}/dev"; then
+        dev="`my_cat "${path}/dev" 2> /dev/null`"
+        major="`expr "$dev" : '\(.*\):' 2> /dev/null`"
+        minor="`expr "$dev" : '.*:\(.*\)' 2> /dev/null`"
+        class="`my_cat ${path}/bDeviceClass 2> /dev/null`"
+        my_sh "${usb_createnode}" "$major" "$minor" "$class" "${usb_group}" \
+              2>/dev/null
+    fi
+}
+
+setup_normal_input_install_device_node_setup() {
+    # install_device_node_setup contain some aliases for unit testing
+    # purposes.  This function sets up the aliases to point to the real
+    # values for "normal" use.
+    udev_rule_file=/etc/udev/rules.d/10-vboxdrv.rules # Set this to /dev/null
+                                                      # for unit testing
+    sysfs_usb_devices="/sys/bus/usb/devices/*"
+    eval 'do_install_udev() { install_udev "$@"; }'
+    eval 'do_install_create_usb_node_for_sysfs() { \
+                          install_create_usb_node_for_sysfs "$@" ; }'
+}
+
+# Assume we will be calling the function normally, not for unit testing
+setup_normal_input_install_device_node_setup
+
+setup_test_input_install_device_node_setup() {
+    # Set up unit testing environment for the "install_udev" function below.
+    test_drv_grp="$1"  # The expected vboxdrv group
+    test_drv_mode="$2" # The expected vboxdrv mode
+    test_inst_dir="$3" # The expected installation directory
+    test_usb_grp="$4"  # The expected USB node group
+    udev_rule_file=/dev/null
+    sysfs_usb_devices=test_sysfs_path
+    eval 'do_install_udev() {    test    "$1" = "${test_drv_grp}" \
+                                      -a "$2" = "${test_drv_mode}" \
+                                      -a "$3" = "${test_inst_dir}" \
+                                      -a "$4" = "${test_usb_grp}" \
+                                      -a "$5" = "${INSTALL_NO_UDEV}" \
+                              || echo "do_install_udev: bad parameters: $@" >&2 ; }'
+    eval 'do_install_create_usb_node_for_sysfs() { \
+                       test    "$1" = "${sysfs_usb_devices}" \
+                            -a "$2" = "${test_inst_dir}/VBoxCreateUSBNode.sh" \
+                            -a "$3" = "${test_usb_grp}" \
+                    || echo "do_install_create_usb_node_for_sysfs: \
+bad parameters: $@" >&2 ; }'
+}
+
+cleanup_test_input_install_device_node_setup() {
+    # Clean up unit testing environment for the "install_udev" function below.
+    # Nothing to do.
+    true
+}
+
+install_device_node_setup() {
+    # Install udev rules and create device nodes for usb access
+    VBOXDRV_GRP="$1"      # The group that should own /dev/vboxdrv
+    VBOXDRV_MODE="$2"     # The mode to be used for /dev/vboxdrv
+    INSTALLATION_DIR="$3" # The directory VirtualBox is installed in
+    USB_GROUP="$4"        # The group that should own the /dev/vboxusb device
+                          # nodes unless INSTALL_NO_GROUP=1 in
+                          # /etc/default/virtualbox.  Optional.
+    usb_createnode="$INSTALLATION_DIR/VBoxCreateUSBNode.sh"
+    # install udev rule (disable with INSTALL_NO_UDEV=1 in
+    # /etc/default/virtualbox)
+    if [ "$INSTALL_NO_GROUP" != "1" ]; then
+        usb_group=$USB_GROUP
+        vboxdrv_group=$VBOXDRV_GRP
+    else
+        usb_group=root
+        vboxdrv_group=root
+    fi
+    do_install_udev "${vboxdrv_group}" "$VBOXDRV_MODE" "$INSTALLATION_DIR" \
+                    "${usb_group}" "$INSTALL_NO_UDEV" > ${udev_rule_file}
+    # Build our device tree
+    for i in ${sysfs_usb_devices}; do  # This line intentionally without quotes.
+        do_install_create_usb_node_for_sysfs "$i" "${usb_createnode}" \
+                                             "${usb_group}"
+    done
+}

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

@@ -86 +86 @@
 cleanup_test_input_install_udev
 
+echo "Testing device node setup"
+
+unset INSTALL_NO_GROUP
+unset INSTALL_NO_UDEV
+setup_test_input_install_device_node_setup vboxusers 0660 /opt/VirtualBox \
+                                           vboxusb
+
+command="install_device_node_setup vboxusers 0660 /opt/VirtualBox vboxusb"
+err="`${command} 2>&1`"
+test -n "${err}" && {
+    echo "${command} failed."
+    echo "Error: ${err}"
+    CERRS="`expr "$CERRS" + 1`"
+}
+
+cleanup_test_input_install_device_node_setup
+
+INSTALL_NO_GROUP=1
+unset INSTALL_NO_UDEV
+setup_test_input_install_device_node_setup root 0660 /opt/VirtualBox root
+
+command="install_device_node_setup vboxusers 0660 /opt/VirtualBox vboxusb"
+err="`${command} 2>&1`"
+test -n "${err}" && {
+    echo "${command} failed."
+    echo "Error: ${err}"
+    CERRS="`expr "$CERRS" + 1`"
+}
+
+cleanup_test_input_install_device_node_setup
+
+unset INSTALL_NO_GROUP
+INSTALL_NO_UDEV=1
+setup_test_input_install_device_node_setup vboxusers 0660 /opt/VirtualBox \
+                                           vboxusb
+
+command="install_device_node_setup vboxusers 0660 /opt/VirtualBox vboxusb"
+err="`${command} 2>&1`"
+test -n "${err}" && {
+    echo "${command} failed."
+    echo "Error: ${err}"
+    CERRS="`expr "$CERRS" + 1`"
+}
+
+cleanup_test_input_install_device_node_setup
+
 echo "Done.  Error count $CERRS."