Add support for external_id and fail_mode. Updated syntax to pass pep8 v1.6.2 and pylint v0.25.0

network/openvswitch_bridge.py

@@ -17,6 +17,10 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this software.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Portions copyright @ 2015 VMware, Inc.  All rights reserved.
+
+# pylint: disable=C0111
 
 DOCUMENTATION = '''
 ---
@@ -43,62 +47,98 @@ options:
         default: 5
         description:
             - How long to wait for ovs-vswitchd to respond
+    external_id:
+        required: false
+        description:
+            - bridge external-id
+    fail_mode:
+        required: false
+        choices : [secure, standalone]
+        description:
+            - bridge fail-mode
 '''
 
 EXAMPLES = '''
 # Create a bridge named br-int
 - openvswitch_bridge: bridge=br-int state=present
+
+# Create an integration bridge
+- openvswitch_bridge: bridge=br-int state=present external_id=br-int
+                      fail_mode=secure
 '''
 
+import syslog
+import os
+
 
 class OVSBridge(object):
+    """ Interface to ovs-vsctl. """
     def __init__(self, module):
         self.module = module
         self.bridge = module.params['bridge']
         self.state = module.params['state']
         self.timeout = module.params['timeout']
+        self.external_id = module.params['external_id']
+        self.fail_mode = module.params['fail_mode']
 
     def _vsctl(self, command):
         '''Run ovs-vsctl command'''
-        return self.module.run_command(['ovs-vsctl', '-t', str(self.timeout)] + command)
+        return self.module.run_command(['ovs-vsctl', '-t',
+                                        str(self.timeout)] + command)
 
     def exists(self):
         '''Check if the bridge already exists'''
-        rc, _, err = self._vsctl(['br-exists', self.bridge])
+        rtc, _, err = self._vsctl(['br-exists', self.bridge])
-        if rc == 0:  # See ovs-vsctl(8) for status codes
+        if rtc == 0:  # See ovs-vsctl(8) for status codes
             return True
-        if rc == 2:
+        if rtc == 2:
             return False
-        raise Exception(err)
+        self.module.fail_json(msg=err)
 
     def add(self):
         '''Create the bridge'''
-        rc, _, err = self._vsctl(['add-br', self.bridge])
+        rtc, _, err = self._vsctl(['add-br', self.bridge])
-        if rc != 0:
+        if rtc != 0:
-            raise Exception(err)
+            self.module.fail_json(msg=err)
+        if self.external_id:
+            self.set_external_id()
+        if self.fail_mode:
+            self.set_fail_mode()
 
     def delete(self):
         '''Delete the bridge'''
-        rc, _, err = self._vsctl(['del-br', self.bridge])
+        rtc, _, err = self._vsctl(['del-br', self.bridge])
-        if rc != 0:
+        if rtc != 0:
-            raise Exception(err)
+            self.module.fail_json(msg=err)
 
     def check(self):
         '''Run check mode'''
+        changed = False
+
+        # pylint: disable=W0703
         try:
-            if self.state == 'absent' and self.exists():
+            if self.state == 'present' and self.exists():
+                if (self.external_id and
+                   (self.external_id != self.get_external_id())):
+                    changed = True
+                if (self.fail_mode and
+                   (self.fail_mode != self.get_fail_mode())):
+                    changed = True
+            elif self.state == 'absent' and self.exists():
                 changed = True
             elif self.state == 'present' and not self.exists():
                 changed = True
-            else:
+        except Exception, earg:
-                changed = False
+            self.module.fail_json(msg=str(earg))
-        except Exception, e:
+
-            self.module.fail_json(msg=str(e))
+        # pylint: enable=W0703
         self.module.exit_json(changed=changed)
 
     def run(self):
         '''Make the necessary changes'''
         changed = False
+        # pylint: disable=W0703
+
         try:
             if self.state == 'absent':
                 if self.exists():
@@ -108,27 +148,93 @@ class OVSBridge(object):
                 if not self.exists():
                     self.add()
                     changed = True
-        except Exception, e:
+
-            self.module.fail_json(msg=str(e))
+                if (self.external_id and
+                   (self.external_id != self.get_external_id())):
+                    self.set_external_id()
+                    changed = True
+
+                current_fail_mode = self.get_fail_mode()
+                if self.fail_mode and (self.fail_mode != current_fail_mode):
+                    syslog.syslog(syslog.LOG_NOTICE,
+                                  "changing fail mode %s to %s" %
+                                  (current_fail_mode, self.fail_mode))
+                    self.set_fail_mode()
+                    changed = True
+
+        except Exception, earg:
+            self.module.fail_json(msg=str(earg))
+        # pylint: enable=W0703
         self.module.exit_json(changed=changed)
 
+    def get_external_id(self):
+        """ Return the current external id. """
+        value = ''
+        if self.exists():
+            rtc, out, err = self._vsctl(['br-get-external-id', self.bridge])
+            if rtc != 0:
+                self.module.fail_json(msg=err)
+            try:
+                (_, value) = out.split('=')
+            except ValueError:
+                pass
+        return value.strip("\n")
 
+    def set_external_id(self):
+        """ Set external id. """
+        if self.exists():
+            (rtc, _, err) = self._vsctl(['br-set-external-id', self.bridge,
+                                         'bridge-id', self.external_id])
+            if rtc != 0:
+                self.module.fail_json(msg=err)
+
+    def get_fail_mode(self):
+        """ Get failure mode. """
+        value = ''
+        if self.exists():
+            rtc, out, err = self._vsctl(['get-fail-mode', self.bridge])
+            if rtc != 0:
+                self.module.fail_json(msg=err)
+            value = out.strip("\n")
+        return value
+
+    def set_fail_mode(self):
+        """ Set failure mode. """
+
+        if self.exists():
+            (rtc, _, err) = self._vsctl(['set-fail-mode', self.bridge,
+                                         self.fail_mode])
+            if rtc != 0:
+                self.module.fail_json(msg=err)
+
+
+# pylint: disable=E0602
 def main():
+    """ Entry point. """
     module = AnsibleModule(
         argument_spec={
             'bridge': {'required': True},
             'state': {'default': 'present', 'choices': ['present', 'absent']},
-            'timeout': {'default': 5, 'type': 'int'}
+            'timeout': {'default': 5, 'type': 'int'},
+            'external_id': {'default': ''},
+            'fail_mode': {'default': ''},
+            'syslogging': {'required': False, 'type': 'bool', 'default': True}
         },
         supports_check_mode=True,
     )
 
-    br = OVSBridge(module)
+    if (module.params["syslogging"]):
+        syslog.openlog('ansible-%s' % os.path.basename(__file__))
+
+    bridge = OVSBridge(module)
     if module.check_mode:
-        br.check()
+        bridge.check()
     else:
-        br.run()
+        bridge.run()
 
+# pylint: disable=W0614
+# pylint: disable=W0401
+# pylint: disable=W0622
 
 # import module snippets
 from ansible.module_utils.basic import *