Add sanity check framework to verify neutron server/backend integration

Some Neutron plugins require controllers and multiple backend services
to operate correctly. This patch adds the framework for third party
plugins to run sanity checks after Neutron Server has started.

This simple addition may reveal potential configuration pitfalls
much earlier in the dev/test cycle, thus speeding up the build
churn process.

The first plugin that uses this framework is the VMware NSX one.

Closes-bug: #1265671

Change-Id: I17f9c5c8e828316ff03f0eff42ae4ae6c6c58733

lib/neutron

@@ -958,6 +958,11 @@ function stop_neutron_third_party() {
     _neutron_third_party_do stop
 }
 
+# check_neutron_third_party_integration() - Check that third party integration is sane
+function check_neutron_third_party_integration() {
+    _neutron_third_party_do check
+}
+
 
 # Restore xtrace
 $XTRACE

lib/neutron_thirdparty/README.md

@@ -34,3 +34,6 @@ functions to be implemented
 
 * ``stop_<third_party>``:
   stop running processes (non-screen)
+
+* ``check_<third_party>``:
+  verify that the integration between neutron server and third-party components is sane

lib/neutron_thirdparty/bigswitch_floodlight

@@ -45,5 +45,9 @@ function stop_bigswitch_floodlight() {
     :
 }
 
+function check_bigswitch_floodlight() {
+    :
+}
+
 # Restore xtrace
 $MY_XTRACE

lib/neutron_thirdparty/midonet

@@ -56,5 +56,9 @@ function stop_midonet() {
     :
 }
 
+function check_midonet() {
+    :
+}
+
 # Restore xtrace
 $MY_XTRACE

lib/neutron_thirdparty/ryu

@@ -75,5 +75,9 @@ function stop_ryu() {
     :
 }
 
+function check_ryu() {
+    :
+}
+
 # Restore xtrace
 $MY_XTRACE

lib/neutron_thirdparty/trema

@@ -109,5 +109,9 @@ function stop_trema() {
     sudo TREMA_TMP=$TREMA_TMP_DIR trema killall
 }
 
+function check_trema() {
+    :
+}
+
 # Restore xtrace
 $MY_XTRACE

lib/neutron_thirdparty/vmware_nsx

@@ -78,5 +78,9 @@ function stop_vmware_nsx() {
     done
 }
 
+function check_vmware_nsx() {
+    :
+}
+
 # Restore xtrace
 $MY_XTRACE

stack.sh

@@ -1116,6 +1116,7 @@ fi
 if is_service_enabled q-svc; then
     echo_summary "Starting Neutron"
     start_neutron_service_and_check
+    check_neutron_third_party_integration
 elif is_service_enabled $DATABASE_BACKENDS && is_service_enabled n-net; then
     NM_CONF=${NOVA_CONF}
     if is_service_enabled n-cell; then