Merge ~xavpaice/charm-openstack-service-checks/+git/charm-openstack-service-checks:addressinfo into ~canonical-bootstack/charm-openstack-service-checks:master

[Xav Paice]

Add action addressinfo

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Drew Freiberger (afreiberger)]

Can't get this to build. If you've got a ~xavpaice release or a branch with the built charm, that'd be handy for testing.

Code looks good, I just can't get it to build for testing.

review: Needs Information

[Xav Paice (xavpaice)]

switching to WIP, doesn't build.

Unmerged commits

8378f2a... by Xav Paice on 2017-08-30

Add action addressinfo

diff --git a/actions.yaml b/actions.yaml
new file mode 100644
index 0000000..76a1cb9
--- /dev/null
+++ b/actions.yaml
@@ -0,0 +1,6 @@
+addressinfo:
+  description: Collect information about a given IP address.
+  params:
+    ip:
+      type: string
+      description: IP address to collect info about
diff --git a/actions/addressinfo b/actions/addressinfo
new file mode 120000
index 0000000..e9da941
--- /dev/null
+++ b/actions/addressinfo
@@ -0,0 +1 @@
+addressinfo.py
\ No newline at end of file
diff --git a/actions/addressinfo.py b/actions/addressinfo.py
new file mode 100755
index 0000000..7fa435b
--- /dev/null
+++ b/actions/addressinfo.py
@@ -0,0 +1,190 @@
+#!/usr/local/sbin/charm-env python3
+#
+# Copyright 2018 Canonical Ltd
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+import pprint
+from reactive import service_checks
+from openstack import connection, profile, exceptions
+from charmhelpers.core.hookenv import (
+        action_get,
+        action_set,
+        log,
+        action_fail
+        )
+
+
+# copied directly from the docs for openstacksdk
+def create_connection(auth_url, region, project_name, username, password):
+    prof = profile.Profile()
+    prof.set_region(profile.Profile.ALL, region)
+    conn = connection.Connection(region_name=region, auth=dict(
+        auth_url=auth_url,
+        username=username,
+        password=password,
+        project_name=project_name),
+        )
+    return conn
+
+
+def port_from_ip(conn, ip):
+    for port_obj in conn.network.ports():
+        port = port_obj.to_dict()
+        for fixed_ip in port['fixed_ips']:
+            if fixed_ip['ip_address'] == ip:
+                return port
+    return None
+
+
+def project_id_to_name(conn, project_id):
+    #v2
+    project_obj = conn.identity.find_tenant(project_id)
+    if project_obj:
+        project = project_obj.to_dict()
+        return project['name']
+    return None
+
+
+def instance_info(conn, port_id):
+    log('getting floating_ip target info.')
+    port = conn.network.get_port(port_id).to_dict()
+    # TODO exception handling, ResourceNotFound
+    instance = conn.compute.get_server(port['device_id']).to_dict()
+    target_info = {
+                   'instance_name': instance['name'],
+                   'instance_virsh_name': instance['instance_name'],
+                   'instance_id': instance['id'],
+                   'hypervisor_hostname': instance['hypervisor_hostname'],
+                   'instance_port_id': port_id
+                  }
+    sgrules = []
+    for security_group in port['security_group_ids']:
+        for rule in conn.network.security_group_rules(
+                security_group_id=security_group
+                ):
+            sgrules.append(rule.to_dict())
+    target_info['sgrules'] = sgrules
+    tap_interface = 'tap' + port['id'][:11]
+    target_info['PROTIP'] = ('"tcpdump -ni {}" on '
+                             '{}'.format(tap_interface,
+                                         port['binding_host_id']))
+    return target_info
+
+
+def get_floatingip_mapping(conn, ip, floatingip_obj):
+    mapping_info = {}
+    mapping_info['router_id'] = floatingip_obj.router_id
+    try:
+        mapping_info['router_info'] = get_router_info(conn,
+                                                      floatingip_obj.router_id)
+    except NameError:
+        pass
+    mapping_info['mapping'] = '{} <-> {}'.format(
+            ip, floatingip_obj.fixed_ip_address
+            )
+    return mapping_info
+
+
+def get_router_info(conn, router_id):
+    log('getting router info')
+    router_info = {}
+    try:
+        router = conn.network.get_router(router_id).to_dict()
+    except exceptions.ResourceNotFound:
+        router_info['router_id'] = 'Router not found'
+        return router_info
+    for agent_obj in conn.network.routers_hosting_l3_agents(router_id):
+        agent = agent_obj.to_dict()
+        if agent['is_alive']:
+            agent_state = 'ALIVE'
+            scheduled = True
+            router_info['PROTIP'] = ('tcpdump inside the router namespace '
+                                     '"ip netns exec qrouter-{} tcpdump -ln" '
+                                     'on {}'.format(router['id'],
+                                                    agent['host']))
+        else:
+            agent_state = 'DEAD'
+        router_info['L3_Agent_host'] = agent['host']
+        router_info['L3_Agent_state'] = agent_state
+    if not scheduled:
+        router_info['L3_Agent_host'] = ('Router {} does not appear to be '
+                                        'scheduled.'.format(router['id']))
+    router_info['router_id'] = router_id
+    return router_info
+
+
+def address_info():
+    output_json = {}
+    ip = action_get("ip")
+    if not ip:
+        action_fail("Need an IP address supplied for this to be useful")
+    output_json['ip'] = ip
+    creds = service_checks.get_credentials()
+    conn = create_connection(creds['auth_url'],
+                             creds['region'],
+                             creds['credentials_project'],
+                             creds['credentials_username'],
+                             creds['credentials_password']
+                             )
+    # is it a floating ip?
+    floatingip_obj = conn.network.find_ip(ip)
+    if floatingip_obj and floatingip_obj.port_id is None:
+        output_json['type'] = 'Unassociated Floating IP'
+    else:
+        if floatingip_obj and floatingip_obj.port_id is not None:
+            # floating IP mapped to something, get more info
+            output_json['mapping'] = get_floatingip_mapping(conn,
+                                                            ip,
+                                                            floatingip_obj)
+            output_json['instance_info'] = instance_info(conn,
+                                                         floatingip_obj.port_id)
+            output_json['router_info'] = get_router_info(conn,
+                                                         floatingip_obj.router_id)
+        port = port_from_ip(conn, ip)
+        if not port:
+            action_fail('IP {} not found'.format(ip))
+        output_json['type'] = port['device_owner']
+        output_json['port_network_id'] = port['network_id']
+        output_json['port_subnet_id'] = port['fixed_ips'][0]['subnet_id']
+        output_json['project_name'] = project_id_to_name(conn,
+                                                         port['project_id'])
+        output_json['project_id'] = port['project_id']
+        output_json['port_id'] = port['id']
+        output_json['mac_address'] = port['mac_address']
+        if (port['device_owner'] == 'network:router_interface' or
+           port['device_owner'] == 'network:router_gateway'):
+            output_json['host'] = port['binding_host_id']
+            try:
+                output_json['router_info'] = get_router_info(conn,
+                                                             port['device_id'])
+            except NameError:
+                pass
+        elif port['device_owner'] == 'network:dhcp':
+            output_json['host'] = port['binding_host_id']
+        elif port['device_owner'] == 'compute:None':
+            instance = conn.compute.get_server(port['device_id'])
+            output_json['host'] = instance.hypervisor_hostname
+            output_json['virsh_name'] = instance.instance_name
+            output_json['instance_id'] = instance.id
+            output_json['instance_addresses'] = instance.addresses
+            output_json['instance_info'] = instance_info(conn,
+                                                         port['id'])
+    output_text = pprint.pformat(output_json)
+    return output_text
+
+
+if __name__ == '__main__':
+    message = address_info()
+    action_set({'message': message})
diff --git a/tests/00-setup b/tests/00-setup
new file mode 100755
index 0000000..cd5b3a2
--- /dev/null
+++ b/tests/00-setup
@@ -0,0 +1,5 @@
+#!/bin/bash
+
+sudo add-apt-repository ppa:juju/stable -y
+sudo apt-get update
+sudo apt-get install amulet python3-requests -y
diff --git a/tests/99-autogen b/tests/99-autogen
new file mode 100755
index 0000000..750f608
--- /dev/null
+++ b/tests/99-autogen
@@ -0,0 +1,49 @@
+#!/usr/bin/env python3
+
+import amulet
+import requests
+import unittest
+
+
+class TestDeployment(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.deployment = amulet.Deployment(series='trusty')
+
+        cls.deployment.add('openstack-service-checks')
+
+        try:
+            cls.deployment.setup(timeout=900)
+            cls.deployment.sentry.wait()
+        except amulet.helpers.TimeoutError:
+            amulet.raise_status(amulet.SKIP, msg="Environment wasn't stood up in time")
+        except:
+            raise
+
+    def test_case(self):
+        # Now you can use self.deployment.sentry.unit[UNIT] to address each of
+        # the units and perform more in-depth steps.  You can also reference
+        # the first unit as self.unit.
+        # There are three test statuses that can be triggered with
+        # amulet.raise_status():
+        #   - amulet.PASS
+        #   - amulet.FAIL
+        #   - amulet.SKIP
+        # Each unit has the following methods:
+        #   - .info - An array of the information of that unit from Juju
+        #   - .file(PATH) - Get the details of a file on that unit
+        #   - .file_contents(PATH) - Get plain text output of PATH file from that unit
+        #   - .directory(PATH) - Get details of directory
+        #   - .directory_contents(PATH) - List files and folders in PATH on that unit
+        #   - .relation(relation, service:rel) - Get relation data from return service
+        #          add tests here to confirm service is up and working properly
+        # For example, to confirm that it has a functioning HTTP server:
+        #     page = requests.get('http://{}'.format(self.unit.info['public-address']))
+        #     page.raise_for_status()
+        # More information on writing Amulet tests can be found at:
+        #     https://jujucharms.com/docs/stable/tools-amulet
+        pass
+
+
+if __name__ == '__main__':
+    unittest.main()
diff --git a/wheelhouse.txt b/wheelhouse.txt
new file mode 100644
index 0000000..720dbc3
--- /dev/null
+++ b/wheelhouse.txt
@@ -0,0 +1 @@
+openstacksdk