Upgrade OpenStack

Fix upgrade openstack
Update README
Update docstrings
Clean up for final review

.gitignore

@@ -5,3 +5,4 @@ interfaces
 .testrepository
 *__pycache__*
 *.pyc
+.stestr/

.stestr.conf

@@ -0,0 +1,3 @@
+[DEFAULT]
+test_path=./unit_tests
+top_dir=./

src/HACKING.md

@@ -4,7 +4,4 @@ This charm is developed as part of the OpenStack Charms project, and as such you
 should refer to the [OpenStack Charm Development Guide](https://github.com/openstack/charm-guide) for details on how
 to contribute to this charm.
 
-You can find its source code here: <https://github.com/openstack/charm-barbican>.
+You can find its source code here: <https://github.com/openstack/charm-neutron-dynamic-routing>.
-
-
-

src/README.md

@@ -1 +1,29 @@
+# Overview
 
+This charm provides the BGP speaker, dynamic routing agent, feature for OpenStack
+
+# Charm Usage
+
+Neutron dynamic routing relies on services from the rabbitmq-server charm and assumes a functioning neutron stack:
+
+    # The neutron-dynamic-routing charm only requires a relationship to rabbitmq-server
+    juju deploy neutron-dyanmic-routing
+    juju deploy rabbitmq-server
+    juju add-relation neutron-dyanmic-routing rabbitmq-server
+
+    # For minimum functionality a full neutron stack is required:
+    juju deploy keystone
+    juju deploy neutron-api
+    juju deploy percona-cluster
+    juju add-relation keystone percona-cluster
+    juju add-relation keystone neutron-api
+
+# Feature Usage
+
+For utilizing the dynamic routing feature of OpenStack see upstream documentation for [neutron dynamic routing](https://docs.openstack.org/neutron-dynamic-routing/latest/).
+
+# Bugs
+
+Please report bugs on [Launchpad](https://bugs.launchpad.net/charm-neutron-dynamic-routing/+filebug).
+
+For general questions please refer to the OpenStack [Charm Guide](https://docs.openstack.org/charm-guide/latest/).

src/lib/charm/openstack/dragent.py

@@ -44,37 +44,72 @@ charms_openstack.charm.use_defaults('charm.default-select-release')
 def render_configs(interfaces_list):
     """Using a list of interfaces, render the configs and, if they have
     changes, restart the services on the unit.
+
+    :returns: None
     """
-    # Starting out with just amqp
+
     try:
         [i for i in interfaces_list]
     except TypeError:
         interfaces_list = [interfaces_list]
+    # TODO: Add bgp-speaker as an optional interface.
+    # Currently, charms.openstack does not understand endpoints and will need
+    # to be updated for this functionality.
     DRAgentCharm.singleton.render_with_interfaces(interfaces_list)
 
 
 def assess_status():
     """Just call the DRAgentCharm.singleton.assess_status() command to update
     status on the unit.
+
+    :returns: None
     """
+
     DRAgentCharm.singleton.assess_status()
 
 
-def bgp_speaker_bindings():
+def upgrade_if_available(interfaces_list):
-    """Speaker bindings for bgp interface
+    """Just call the DRAgentCharm.singleton.upgrade_if_available() command to
+    update OpenStack package if upgrade is available
 
-    :return: list of bindings
+    @returns: None
     """
+
+    DRAgentCharm.singleton.upgrade_if_available(interfaces_list)
+
+
+def bgp_speaker_bindings():
+    """Return BGP speaker bindings for the bgp interface
+
+    :returns: list of bindings
+    """
+
     return [SPEAKER_BINDING]
 
 
 @os_adapters.config_property
 def provider_ip(cls):
+    """Return the provider binding network IP
+
+    Use the extra binding, provider, to determine the correct provider network
+    IP.
+
+    :returns: string IP address
+    """
+
     return ch_ip.get_relation_ip(PROVIDER_BINDING)
 
 
 @os_adapters.config_property
 def speaker_ip(cls):
+    """Return the BGP speaker binding network IP
+
+    Use the interface-bgp relation binding, to determine the correct bgp
+    network IP.
+
+    :returns: string IP address
+    """
+
     return ch_ip.get_relation_ip(SPEAKER_BINDING)
 
 
@@ -85,6 +120,10 @@ class TransportURLAdapter(os_adapters.RabbitMQRelationAdapter):
 
     @property
     def transport_url(self):
+        """Return the transport URL for communicating with rabbitmq
+
+        :returns: string transport URL
+        """
         hosts = self.hosts or [self.host]
         if hosts:
             transport_url_hosts = ','.join([
@@ -97,6 +136,10 @@ class TransportURLAdapter(os_adapters.RabbitMQRelationAdapter):
 
     @property
     def port(self):
+        """Return the port for commuicating with rabbitmq
+
+        :returns: int port number
+        """
         return self.ssl_port or 5672
 
 
@@ -109,9 +152,7 @@ class DRAgentCharm(charms_openstack.charm.OpenStackCharm):
     name = 'neutron-dynamic-routing'
     packages = PACKAGES
     default_service = 'neutron-bgp-dragent'
-    services = ['neutron-bgp-dragent']
+    services = [default_service]
-
-    # Note that the hsm interface is optional - defined in config.yaml
     required_relations = ['amqp']
 
     adapters_class = os_adapters.OpenStackRelationAdapters
@@ -137,28 +178,19 @@ class DRAgentCharm(charms_openstack.charm.OpenStackCharm):
     }
 
     def install(self):
+        """Configure openstack-origin and install packages
+
+        :returns: None
+        """
+
         self.configure_source()
         super().install()
 
-    def get_amqp_credentials(self):
+    def do_openstack_upgrade_db_migration(self, *args):
-        """Provide the default amqp username and vhost as a tuple.
+        """Override the default do_openstack_upgrade_db_migration function.
+        DRAgentCharm has no database to migrate.
 
-        :returns (username, host): two strings to send to the amqp provider.
+        :returns: None
         """
-        return (self.config['rabbit-user'], self.config['rabbit-vhost'])
 
-    def states_to_check(self, required_relations=None):
+        pass
-        """Override the default states_to_check() for the assess_status
-        functionality so that, if we have to have an HSM relation, then enforce
-        it on the assess_status() call.
-
-        If param required_relations is not None then it overrides the
-        instance/class variable self.required_relations.
-
-        :param required_relations: [list of state names]
-        :returns: [states{} as per parent method]
-        """
-        if required_relations is None:
-            required_relations = self.required_relations
-        return super(DRAgentCharm, self).states_to_check(
-            required_relations=required_relations)

src/reactive/dragent_handlers.py

@@ -22,7 +22,7 @@ import charms_openstack.charm as charm
 
 # This charm's library contains all of the handler code associated with
 # dragent -- we need to import it to get the definitions for the charm.
-import charm.openstack.dragent as dragent  # noqa
+import charm.openstack.dragent as dragent
 
 
 # Use the charms.openstack defaults for common states and hooks
@@ -30,23 +30,18 @@ charm.use_defaults(
     'charm.installed',
     'amqp.connected',
     'config.changed',
-    'update-status')
+    'update-status',
+    'upgrade-charm')
 
 
-@reactive.when('charm.installed')
+@reactive.when('endpoint.bgp-speaker.changed')
-def debug():
-    if not hookenv.config('debug'):
-        return
-    for key, value in reactive.get_states().items():
-        print(key, value)
-
-
-# Use for testing with the quagga charm
-@reactive.when('endpoint.bgp-speaker.joined')
 def publish_bgp_info(endpoint):
+    """Publish BGP information about this unit to interface-bgp peers
+    """
     endpoint.publish_info(asn=hookenv.config('asn'),
                           passive=True,
                           bindings=dragent.bgp_speaker_bindings())
+    dragent.assess_status()
 
 
 @reactive.when('amqp.connected')
@@ -60,10 +55,10 @@ def setup_amqp_req(amqp):
 
 
 @reactive.when('amqp.available')
-def render_stuff(*args):
+def render_configs(*args):
-    """Render the configuration for dyanmic routing when all the interfaces are
+    """Render the configuration for dynamic routing when all the interfaces are
     available.
     """
-    hookenv.log("about to call the render_configs with {}".format(args))
+    dragent.upgrade_if_available(args)
     dragent.render_configs(args)
     dragent.assess_status()

test-requirements.txt

@@ -3,5 +3,6 @@ flake8
 os-testr>=0.4.1
 charms.reactive
 mock>=1.2
+nose>=1.3.7
 coverage>=3.6
 git+https://github.com/openstack/charms.openstack.git#egg=charms-openstack

tox.ini

@@ -3,7 +3,7 @@
 # within individual charm repos.
 [tox]
 skipsdist = True
-envlist = pep8,py34,py35
+envlist = pep8,py3
 skip_missing_interpreters = True
 
 [testenv]
@@ -32,13 +32,8 @@ basepython = python2.7
 whitelist_externals = true
 commands = true
 
-[testenv:py34]
+[testenv:py3]
-basepython = python3.4
+basepython = python3
-deps = -r{toxinidir}/test-requirements.txt
-commands = ostestr {posargs}
-
-[testenv:py35]
-basepython = python3.5
 deps = -r{toxinidir}/test-requirements.txt
 commands = ostestr {posargs}