@@ -154,3 +154,24 @@ functions:

 -  ``start_nova_hypervisor`` - start any external services

 -  ``stop_nova_hypervisor`` - stop any external services

 -  ``cleanup_nova_hypervisor`` - remove transient data and cache

+

+System Packages

+===============

+

+Devstack provides a framework for getting packages installed at an early

+phase of its execution. This packages may be defined in a plugin as files

+that contain new-line separated lists of packages required by the plugin

+

+Supported packaging systems include apt and yum across multiple distributions.

+To enable a plugin to hook into this and install package dependencies, packages

+may be listed at the following locations in the top-level of the plugin

+repository:

+

+- ``./devstack/files/debs/$plugin_name`` - Packages to install when running

+  on Ubuntu, Debian or Linux Mint.

+

+- ``./devstack/files/rpms/$plugin_name`` - Packages to install when running

+  on Red Hat, Fedora, CentOS or XenServer.

+

+- ``./devstack/files/rpms-suse/$plugin_name`` - Packages to install when

+  running on SUSE Linux or openSUSE.

@@ -973,13 +973,18 @@ function get_or_create_endpoint {

 # _get_package_dir

 function _get_package_dir {

+    local base_dir=$1

     local pkg_dir

+

+    if [[ -z "$base_dir" ]]; then

+        base_dir=$FILES

+    fi

     if is_ubuntu; then

-        pkg_dir=$FILES/debs

+        pkg_dir=$base_dir/debs

     elif is_fedora; then

-        pkg_dir=$FILES/rpms

+        pkg_dir=$base_dir/rpms

     elif is_suse; then

-        pkg_dir=$FILES/rpms-suse

+        pkg_dir=$base_dir/rpms-suse

     else

         exit_distro_not_supported "list of packages"

     fi

@@ -1005,6 +1010,59 @@ function apt_get {

         apt-get --option "Dpkg::Options::=--force-confold" --assume-yes "$@"

 }

+function _parse_package_files {

+    local files_to_parse=$@

+

+    if [[ -z "$DISTRO" ]]; then

+        GetDistro

+    fi

+

+    for fname in ${files_to_parse}; do

+        local OIFS line package distros distro

+        [[ -e $fname ]] || continue

+

+        OIFS=$IFS

+        IFS=$'\n'

+        for line in $(<${fname}); do

+            if [[ $line =~ "NOPRIME" ]]; then

+                continue

+            fi

+

+            # Assume we want this package

+            package=${line%#*}

+            inst_pkg=1

+

+            # Look for # dist:xxx in comment

+            if [[ $line =~ (.*)#.*dist:([^ ]*) ]]; then

+                # We are using BASH regexp matching feature.

+                package=${BASH_REMATCH[1]}

+                distros=${BASH_REMATCH[2]}

+                # In bash ${VAR,,} will lowecase VAR

+                # Look for a match in the distro list

+                if [[ ! ${distros,,} =~ ${DISTRO,,} ]]; then

+                    # If no match then skip this package

+                    inst_pkg=0

+                fi

+            fi

+

+            # Look for # testonly in comment

+            if [[ $line =~ (.*)#.*testonly.* ]]; then

+                package=${BASH_REMATCH[1]}

+                # Are we installing test packages? (test for the default value)

+                if [[ $INSTALL_TESTONLY_PACKAGES = "False" ]]; then

+                    # If not installing test packages the skip this package

+                    inst_pkg=0

+                fi

+            fi

+

+            if [[ $inst_pkg = 1 ]]; then

+                echo $package

+            fi

+        done

+        IFS=$OIFS

+    done

+}

+

 # get_packages() collects a list of package names of any type from the

 # prerequisite files in ``files/{debs|rpms}``.  The list is intended

 # to be passed to a package installer such as apt or yum.

@@ -1029,103 +1087,76 @@ function get_packages {

         echo "No package directory supplied"

         return 1

     fi

-    if [[ -z "$DISTRO" ]]; then

-        GetDistro

-    fi

     for service in ${services//,/ }; do

         # Allow individual services to specify dependencies

         if [[ -e ${package_dir}/${service} ]]; then

-            file_to_parse="${file_to_parse} $service"

+            file_to_parse="${file_to_parse} ${package_dir}/${service}"

         fi

         # NOTE(sdague) n-api needs glance for now because that's where

         # glance client is

         if [[ $service == n-api ]]; then

             if [[ ! $file_to_parse =~ nova ]]; then

-                file_to_parse="${file_to_parse} nova"

+                file_to_parse="${file_to_parse} ${package_dir}/nova"

             fi

             if [[ ! $file_to_parse =~ glance ]]; then

-                file_to_parse="${file_to_parse} glance"

+                file_to_parse="${file_to_parse} ${package_dir}/glance"

             fi

         elif [[ $service == c-* ]]; then

             if [[ ! $file_to_parse =~ cinder ]]; then

-                file_to_parse="${file_to_parse} cinder"

+                file_to_parse="${file_to_parse} ${package_dir}/cinder"

             fi

         elif [[ $service == ceilometer-* ]]; then

             if [[ ! $file_to_parse =~ ceilometer ]]; then

-                file_to_parse="${file_to_parse} ceilometer"

+                file_to_parse="${file_to_parse} ${package_dir}/ceilometer"

             fi

         elif [[ $service == s-* ]]; then

             if [[ ! $file_to_parse =~ swift ]]; then

-                file_to_parse="${file_to_parse} swift"

+                file_to_parse="${file_to_parse} ${package_dir}/swift"

             fi

         elif [[ $service == n-* ]]; then

             if [[ ! $file_to_parse =~ nova ]]; then

-                file_to_parse="${file_to_parse} nova"

+                file_to_parse="${file_to_parse} ${package_dir}/nova"

             fi

         elif [[ $service == g-* ]]; then

             if [[ ! $file_to_parse =~ glance ]]; then

-                file_to_parse="${file_to_parse} glance"

+                file_to_parse="${file_to_parse} ${package_dir}/glance"

             fi

         elif [[ $service == key* ]]; then

             if [[ ! $file_to_parse =~ keystone ]]; then

-                file_to_parse="${file_to_parse} keystone"

+                file_to_parse="${file_to_parse} ${package_dir}/keystone"

             fi

         elif [[ $service == q-* ]]; then

             if [[ ! $file_to_parse =~ neutron ]]; then

-                file_to_parse="${file_to_parse} neutron"

+                file_to_parse="${file_to_parse} ${package_dir}/neutron"

             fi

         elif [[ $service == ir-* ]]; then

             if [[ ! $file_to_parse =~ ironic ]]; then

-                file_to_parse="${file_to_parse} ironic"

+                file_to_parse="${file_to_parse} ${package_dir}/ironic"

             fi

         fi

     done

+    echo "$(_parse_package_files $file_to_parse)"

+    $xtrace

+}

-    for file in ${file_to_parse}; do

-        local fname=${package_dir}/${file}

-        local OIFS line package distros distro

-        [[ -e $fname ]] || continue

-

-        OIFS=$IFS

-        IFS=$'\n'

-        for line in $(<${fname}); do

-            if [[ $line =~ "NOPRIME" ]]; then

-                continue

-            fi

-

-            # Assume we want this package

-            package=${line%#*}

-            inst_pkg=1

-

-            # Look for # dist:xxx in comment

-            if [[ $line =~ (.*)#.*dist:([^ ]*) ]]; then

-                # We are using BASH regexp matching feature.

-                package=${BASH_REMATCH[1]}

-                distros=${BASH_REMATCH[2]}

-                # In bash ${VAR,,} will lowecase VAR

-                # Look for a match in the distro list

-                if [[ ! ${distros,,} =~ ${DISTRO,,} ]]; then

-                    # If no match then skip this package

-                    inst_pkg=0

-                fi

-            fi

-

-            # Look for # testonly in comment

-            if [[ $line =~ (.*)#.*testonly.* ]]; then

-                package=${BASH_REMATCH[1]}

-                # Are we installing test packages? (test for the default value)

-                if [[ $INSTALL_TESTONLY_PACKAGES = "False" ]]; then

-                    # If not installing test packages the skip this package

-                    inst_pkg=0

-                fi

-            fi

-

-            if [[ $inst_pkg = 1 ]]; then

-                echo $package

-            fi

-        done

-        IFS=$OIFS

+# get_plugin_packages() collects a list of package names of any type from a

+# plugin's prerequisite files in ``$PLUGIN/devstack/files/{debs|rpms}``.  The

+# list is intended to be passed to a package installer such as apt or yum.

+#

+# Only packages required for enabled and collected plugins will included.

+#

+# The same metadata used in the main devstack prerequisite files may be used

+# in these prerequisite files, see get_packages() for more info.

+function get_plugin_packages {

+    local xtrace=$(set +o | grep xtrace)

+    set +o xtrace

+    local files_to_parse=""

+    local package_dir=""

+    for plugin in ${DEVSTACK_PLUGINS//,/ }; do

+        local package_dir="$(_get_package_dir ${GITDIR[$plugin]}/devstack/files)"

+        files_to_parse+="$package_dir/$plugin"

     done

+    echo "$(_parse_package_files $files_to_parse)"

     $xtrace

 }

@@ -62,6 +62,8 @@ export_proxy_variables

 # Install package requirements

 PACKAGES=$(get_packages general $ENABLED_SERVICES)

+PACKAGES="$PACKAGES $(get_plugin_packages)"

+

 if is_ubuntu && echo $PACKAGES | grep -q dkms ; then

     # ensure headers for the running kernel are installed for any DKMS builds

     PACKAGES="$PACKAGES linux-headers-$(uname -r)"