Refactor openvswitch_port module (#24205)

Use current patterns from other network modules for better
maintainability.

lib/ansible/modules/network/ovs/openvswitch_port.py

@@ -49,7 +49,8 @@ options:
         version_added: 2.2
         required: false
         description:
-            - VLAN tag for this port
+            - VLAN tag for this port. Must be a value between
+              0 and 4095.
     state:
         required: false
         default: "present"
@@ -111,185 +112,168 @@ EXAMPLES = '''
       iface-status: active
 '''
 
-# pylint: disable=W0703
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.six import iteritems
+from ansible.module_utils.pycompat24 import get_exception
 
+def _external_ids_to_dict(text):
+    text = text.strip()
 
-def truncate_before(value, srch):
+    if text == '{}':
-    """ Return content of str before the srch parameters. """
+        return None
-
-    before_index = value.find(srch)
-    if (before_index >= 0):
-        return value[:before_index]
     else:
-        return value
+        d = {}
 
+        for kv in text[1:-1].split(','):
+            kv = kv.strip()
+            k, v = kv.split('=')
+            d[k] = v
 
-def _set_to_get(set_cmd, module):
+        return d
-    """ Convert set command to get command and set value.
-    return tuple (get command, set value)
-    """
 
-    ##
+def _tag_to_str(text):
-    # If set has option: then we want to truncate just before that.
+    text = text.strip()
-    set_cmd = truncate_before(set_cmd, " option:")
-    get_cmd = set_cmd.split(" ")
-    (key, value) = get_cmd[-1].split("=")
-    module.log("get commands %s " % key)
-    return (["--", "get"] + get_cmd[:-1] + [key], value)
 
+    if text == '[]':
+        return None
+    else:
+        return text
 
-# pylint: disable=R0902
+def map_obj_to_commands(want, have, module):
-class OVSPort(object):
+    commands = list()
-    """ Interface to OVS port. """
-    def __init__(self, module):
-        self.module = module
-        self.bridge = module.params['bridge']
-        self.port = module.params['port']
-        self.tag = module.params['tag']
-        self.state = module.params['state']
-        self.timeout = module.params['timeout']
-        self.set_opt = module.params.get('set', None)
 
-    def _vsctl(self, command, check_rc=True):
+    if module.params['state'] == 'absent':
-        '''Run ovs-vsctl command'''
+        if have:
+            templatized_command = ("%(ovs-vsctl)s -t %(timeout)s del-port"
+                                   " %(bridge)s %(port)s")
+            command = templatized_command % module.params
+            commands.append(command)
+    else:
+        if have:
+            if want['tag'] != have['tag']:
+                templatized_command = ("%(ovs-vsctl)s -t %(timeout)s"
+                                       " set port %(port)s tag=%(tag)s")
+                command = templatized_command % module.params
+                commands.append(command)
 
-        cmd = ['ovs-vsctl', '-t', str(self.timeout)] + command
+            if want['external_ids'] != have['external_ids']:
-        return self.module.run_command(cmd, check_rc=check_rc)
+                for k, v in iteritems(want['external_ids']):
-
+                    if (not have['external_ids']
-    def exists(self):
+                            or k not in have['external_ids']
-        '''Check if the port already exists'''
+                            or want['external_ids'][k] != have['external_ids'][k]):
-
+                        if v is None:
-        (rtc, out, err) = self._vsctl(['list-ports', self.bridge])
+                            templatized_command = ("%(ovs-vsctl)s -t %(timeout)s"
-
+                                                   " remove port %(port)s"
-        if rtc != 0:
+                                                   " external_ids " + k)
-            self.module.fail_json(msg=err)
+                            command = templatized_command % module.params
-
+                            commands.append(command)
-        return any(port.rstrip() == self.port for port in out.split('\n')) or self.port == self.bridge
+                        else:
-
+                            templatized_command = ("%(ovs-vsctl)s -t %(timeout)s"
-    def set(self, set_opt):
+                                                   " set port %(port)s"
-        """ Set attributes on a port. """
+                                                   " external_ids:")
-        self.module.log("set called %s" % set_opt)
+                            command = templatized_command % module.params
-        if (not set_opt):
+                            command += k + "=" + v
-            return False
+                            commands.append(command)
-
-        (get_cmd, set_value) = _set_to_get(set_opt, self.module)
-        (rtc, out, err) = self._vsctl(get_cmd, False)
-        if rtc != 0:
-            ##
-            # ovs-vsctl -t 5 -- get Interface port external_ids:key
-            # returns failure if key does not exist.
-            out = None
         else:
-            out = out.strip("\n")
+            templatized_command = ("%(ovs-vsctl)s -t %(timeout)s add-port"
-            out = out.strip('"')
+                                   " %(bridge)s %(port)s")
+            command = templatized_command % module.params
 
-        if (out == set_value):
+            if want['tag']:
-            return False
+                templatized_command =  " tag=%(tag)s"
+                command += templatized_command % module.params
 
-        (rtc, out, err) = self._vsctl(["--", "set"] + set_opt.split(" "))
+            if want['set']:
-        if rtc != 0:
+                templatized_command = " -- set %(set)s"
-            self.module.fail_json(msg=err)
+                command += templatized_command % module.params
 
-        return True
+            commands.append(command)
 
-    def add(self):
+            if want['external_ids']:
-        '''Add the port'''
+                for k, v in iteritems(want['external_ids']):
-        cmd = ['add-port', self.bridge, self.port]
+                    templatized_command = ("%(ovs-vsctl)s -t %(timeout)s"
-        if self.tag:
+                                           " set port %(port)s external_ids:")
-            cmd += ["tag=" + self.tag]
+                    command = templatized_command % module.params
-        if self.set and self.set_opt:
+                    command +=  k + "=" + v
-            cmd += ["--", "set"]
+                    commands.append(command)
-            cmd += self.set_opt.split(" ")
 
-        (rtc, _, err) = self._vsctl(cmd)
+    return commands
-        if rtc != 0:
-            self.module.fail_json(msg=err)
 
-        return True
 
-    def delete(self):
+def map_config_to_obj(module):
-        '''Remove the port'''
+    templatized_command = "%(ovs-vsctl)s -t %(timeout)s list-ports %(bridge)s"
-        (rtc, _, err) = self._vsctl(['del-port', self.bridge, self.port])
+    command = templatized_command % module.params
-        if rtc != 0:
+    rc, out, err = module.run_command(command, check_rc=True)
-            self.module.fail_json(msg=err)
+    if rc != 0:
+        module.fail_json(msg=err)
 
-    def check(self):
+    obj = {}
-        '''Run check mode'''
-        try:
-            if self.state == 'absent' and self.exists():
-                changed = True
-            elif self.state == 'present' and not self.exists():
-                changed = True
-            else:
-                changed = False
-        except Exception:
-            earg = get_exception()
-            self.module.fail_json(msg=str(earg))
-        self.module.exit_json(changed=changed)
 
-    def run(self):
+    if module.params['port'] in out.splitlines():
-        '''Make the necessary changes'''
+        obj['bridge'] = module.params['bridge']
-        changed = False
+        obj['port'] = module.params['port']
-        try:
-            if self.state == 'absent':
-                if self.exists():
-                    self.delete()
-                    changed = True
-            elif self.state == 'present':
-                ##
-                # Add any missing ports.
-                if (not self.exists()):
-                    self.add()
-                    changed = True
 
-                ##
+        templatized_command = ("%(ovs-vsctl)s -t %(timeout)s get"
-                # If the -- set changed check here and make changes
+                               " Port %(port)s tag")
-                # but this only makes sense when state=present.
+        command = templatized_command % module.params
-                if (not changed):
+        rc, out, err = module.run_command(command, check_rc=True)
-                    changed = self.set(self.set_opt) or changed
+        obj['tag'] = _tag_to_str(out)
-                    items = self.module.params['external_ids'].items()
-                    for (key, value) in items:
-                        value = value.replace('"', '')
-                        fmt_opt = "Interface %s external_ids:%s=%s"
-                        external_id = fmt_opt % (self.port, key, value)
-                        changed = self.set(external_id) or changed
-                ##
-        except Exception:
-            earg = get_exception()
-            self.module.fail_json(msg=str(earg))
-        self.module.exit_json(changed=changed)
 
+        templatized_command = ("%(ovs-vsctl)s -t %(timeout)s get"
+                               " Port %(port)s external_ids")
+        command = templatized_command % module.params
+        rc, out, err = module.run_command(command, check_rc=True)
+        obj['external_ids'] = _external_ids_to_dict(out)
+
+    return obj
+
+
+def map_params_to_obj(module):
+    obj = {
+        'bridge': module.params['bridge'],
+        'port': module.params['port'],
+        'tag': module.params['tag'],
+        'external_ids': module.params['external_ids'],
+        'set': module.params['set']
+    }
+
+    return obj
 
 # pylint: disable=E0602
 def main():
-    """ Entry point.  """
+    """ Entry point. """
-    module = AnsibleModule(
+    argument_spec={
-        argument_spec={
+        'bridge': {'required': True},
-            'bridge': {'required': True},
+        'port': {'required': True},
-            'port': {'required': True},
+        'state': {'default': 'present', 'choices': ['present', 'absent']},
-            'tag': {'required': False},
+        'timeout': {'default': 5, 'type': 'int'},
-            'state': {'default': 'present', 'choices': ['present', 'absent']},
+        'external_ids': {'default': None, 'type': 'dict'},
-            'timeout': {'default': 5, 'type': 'int'},
+        'tag': {'default': None},
-            'set': {'required': False, 'default': None},
+        'set': {'required': False, 'default': None}
-            'external_ids': {'default': {}, 'required': False, 'type': 'dict'},
+    }
-        },
-        supports_check_mode=True,
-    )
 
-    port = OVSPort(module)
+    module = AnsibleModule(argument_spec=argument_spec,
-    if module.check_mode:
+                           supports_check_mode=True)
-        port.check()
-    else:
-        port.run()
 
+    result = {'changed': False}
 
-# pylint: disable=W0614
+    # We add ovs-vsctl to module_params to later build up templatized commands
-# pylint: disable=W0401
+    module.params["ovs-vsctl"] = module.get_bin_path("ovs-vsctl", True)
-# pylint: disable=W0622
+
+    want = map_params_to_obj(module)
+    have = map_config_to_obj(module)
+
+    commands = map_obj_to_commands(want, have, module)
+    result['commands'] = commands
+
+    if commands:
+        if not module.check_mode:
+            for c in commands:
+                module.run_command(c, check_rc=True)
+        result['changed'] = True
+
+    module.exit_json(**result)
 
-# import module snippets
-from ansible.module_utils.basic import *
-from ansible.module_utils.pycompat24 import get_exception
 
 if __name__ == '__main__':
     main()

test/units/modules/network/ovs/fixtures/get_port_eth2_external_ids.cfg

@@ -0,0 +1 @@
+{foo=bar}

test/units/modules/network/ovs/fixtures/get_port_eth2_tag.cfg

@@ -0,0 +1 @@
+10

test/units/modules/network/ovs/fixtures/list_ports_test_br.cfg

@@ -0,0 +1 @@
+eth2

test/units/modules/network/ovs/test_openvswitch_port.py

@@ -0,0 +1,204 @@
+#
+# (c) 2016 Red Hat Inc.
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+# Make coding more python3-ish
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import json
+
+from ansible.compat.tests.mock import patch
+from ansible.modules.network.ovs import openvswitch_port
+from .ovs_module import TestOpenVSwitchModule, load_fixture, set_module_args
+
+test_name_side_effect_matrix = {
+    'test_openvswitch_port_absent_idempotent': [
+        (0, '', '')],
+    'test_openvswitch_port_absent_removes_port': [
+        (0, 'list_ports_test_br.cfg', ''),
+        (0, 'get_port_eth2_tag.cfg', ''),
+        (0, 'get_port_eth2_external_ids.cfg', ''),
+        (0, '', '')],
+    'test_openvswitch_port_present_idempotent': [
+        (0, 'list_ports_test_br.cfg', ''),
+        (0, 'get_port_eth2_tag.cfg', ''),
+        (0, 'get_port_eth2_external_ids.cfg', ''),
+        (0, '', '')],
+    'test_openvswitch_port_present_creates_port': [
+        (0, '', ''),
+        (0, '', ''),
+        (0, '', '')],
+    'test_openvswitch_port_present_changes_tag': [
+        (0, 'list_ports_test_br.cfg', ''),
+        (0, 'get_port_eth2_tag.cfg', ''),
+        (0, 'get_port_eth2_external_ids.cfg', ''),
+        (0, '', '')],
+    'test_openvswitch_port_present_changes_external_id': [
+        (0, 'list_ports_test_br.cfg', ''),
+        (0, 'get_port_eth2_tag.cfg', ''),
+        (0, 'get_port_eth2_external_ids.cfg', ''),
+        (0, '', '')],
+    'test_openvswitch_port_present_adds_external_id': [
+        (0, 'list_ports_test_br.cfg', ''),
+        (0, 'get_port_eth2_tag.cfg', ''),
+        (0, 'get_port_eth2_external_ids.cfg', ''),
+        (0, '', '')],
+    'test_openvswitch_port_present_clears_external_id': [
+        (0, 'list_ports_test_br.cfg', ''),
+        (0, 'get_port_eth2_tag.cfg', ''),
+        (0, 'get_port_eth2_external_ids.cfg', ''),
+        (0, '', '')],
+    'test_openvswitch_port_present_runs_set_mode': [
+        (0, '', ''),
+        (0, '', ''),
+        (0, '', '')],
+}
+
+
+class TestOpenVSwitchPortModule(TestOpenVSwitchModule):
+
+    module = openvswitch_port
+
+    def setUp(self):
+        self.mock_run_command = (
+            patch('ansible.module_utils.basic.AnsibleModule.run_command'))
+        self.run_command = self.mock_run_command.start()
+        self.mock_get_bin_path = (
+            patch('ansible.module_utils.basic.AnsibleModule.get_bin_path'))
+        self.get_bin_path = self.mock_get_bin_path.start()
+
+    def tearDown(self):
+        self.mock_run_command.stop()
+        self.mock_get_bin_path.stop()
+
+    def load_fixtures(self, test_name):
+        test_side_effects = []
+        for s in test_name_side_effect_matrix[test_name]:
+            rc = s[0]
+            out = s[1] if s[1] == '' else str(load_fixture(s[1]))
+            err = s[2]
+            side_effect_with_fixture_loaded = (rc, out, err)
+            test_side_effects.append(side_effect_with_fixture_loaded)
+        self.run_command.side_effect = test_side_effects
+
+        self.get_bin_path.return_value = '/usr/bin/ovs-vsctl'
+
+    def test_openvswitch_port_absent_idempotent(self):
+        set_module_args(dict(state='absent',
+                             bridge='test-br',
+                             port='eth2'))
+        self.execute_module(test_name='test_openvswitch_port_absent_idempotent')
+
+    def test_openvswitch_port_absent_removes_port(self):
+        set_module_args(dict(state='absent',
+                             bridge='test-br',
+                             port='eth2'))
+        commands = [
+            '/usr/bin/ovs-vsctl -t 5 del-port test-br eth2',
+        ]
+        self.execute_module(changed=True, commands=commands,
+                            test_name='test_openvswitch_port_absent_removes_port')
+
+    def test_openvswitch_port_present_idempotent(self):
+        set_module_args(dict(state='present',
+                             bridge='test-br',
+                             port='eth2',
+                             tag=10,
+                             external_ids={'foo': 'bar'}))
+        self.execute_module(test_name='test_openvswitch_port_present_idempotent')
+
+    def test_openvswitch_port_present_creates_port(self):
+        set_module_args(dict(state='present',
+                             bridge='test-br',
+                             port='eth2',
+                             tag=10,
+                             external_ids={'foo': 'bar'}))
+        commands = [
+            '/usr/bin/ovs-vsctl -t 5 add-port test-br eth2 tag=10',
+            '/usr/bin/ovs-vsctl -t 5 set port eth2 external_ids:foo=bar'
+        ]
+        self.execute_module(changed=True,
+                            commands=commands,
+                            test_name='test_openvswitch_port_present_creates_port')
+
+    def test_openvswitch_port_present_changes_tag(self):
+        set_module_args(dict(state='present',
+                             bridge='test-br',
+                             port='eth2',
+                             tag=20,
+                             external_ids={'foo': 'bar'}))
+        commands = [
+            '/usr/bin/ovs-vsctl -t 5 set port eth2 tag=20'
+        ]
+        self.execute_module(changed=True,
+                            commands=commands,
+                            test_name='test_openvswitch_port_present_changes_tag')
+
+    def test_openvswitch_port_present_changes_external_id(self):
+        set_module_args(dict(state='present',
+                             bridge='test-br',
+                             port='eth2',
+                             tag=10,
+                             external_ids={'foo': 'baz'}))
+        commands = [
+            '/usr/bin/ovs-vsctl -t 5 set port eth2 external_ids:foo=baz'
+        ]
+        self.execute_module(changed=True,
+                            commands=commands,
+                            test_name='test_openvswitch_port_present_changes_external_id')
+
+    def test_openvswitch_port_present_adds_external_id(self):
+        set_module_args(dict(state='present',
+                             bridge='test-br',
+                             port='eth2',
+                             tag=10,
+                             external_ids={'foo2': 'bar2'}))
+        commands = [
+            '/usr/bin/ovs-vsctl -t 5 set port eth2 external_ids:foo2=bar2'
+        ]
+        self.execute_module(changed=True,
+                            commands=commands,
+                            test_name='test_openvswitch_port_present_adds_external_id')
+
+    def test_openvswitch_port_present_clears_external_id(self):
+        set_module_args(dict(state='present',
+                             bridge='test-br',
+                             port='eth2',
+                             tag=10,
+                             external_ids={'foo': None}))
+        commands = [
+            '/usr/bin/ovs-vsctl -t 5 remove port eth2 external_ids foo'
+        ]
+        self.execute_module(changed=True,
+                            commands=commands,
+                            test_name='test_openvswitch_port_present_clears_external_id')
+
+    def test_openvswitch_port_present_runs_set_mode(self):
+        set_module_args(dict(state='present',
+                             bridge='test-br',
+                             port='eth2',
+                             tag=10,
+                             external_ids={'foo': 'bar'},
+                             set="port eth2 other_config:stp-path-cost=10"))
+        commands = [
+            '/usr/bin/ovs-vsctl -t 5 add-port test-br eth2 tag=10 -- set'
+            ' port eth2 other_config:stp-path-cost=10',
+            '/usr/bin/ovs-vsctl -t 5 set port eth2 external_ids:foo=bar'
+        ]
+        self.execute_module(changed=True, commands=commands,
+                            test_name='test_openvswitch_port_present_runs_set_mode')