[chores] Moved shared VPN backend logic to BaseVpnBackend

Author: nemesifier

netjsonconfig/backends/base/backend.py

@@ -333,3 +333,39 @@ def __restore_intermediate_data(self):
         del self.intermediate_data
         self.intermediate_data = self._intermediate_copy
         del self._intermediate_copy
+
+
+class BaseVpnBackend(BaseBackend):
+    """
+    Shared logic between VPN backends
+    Requires setting the following attributes:
+
+    - vpn_pattern
+    - config_suffix
+    """
+
+    def _generate_contents(self, tar):
+        """
+        Adds configuration files to tarfile instance.
+
+        :param tar: tarfile instance
+        :returns: None
+        """
+        text = self.render(files=False)
+        # create a list with all the packages (and remove empty entries)
+        vpn_instances = self.vpn_pattern.split(text)
+        if '' in vpn_instances:
+            vpn_instances.remove('')
+        # create a file for each VPN
+        for vpn in vpn_instances:
+            lines = vpn.split('\n')
+            vpn_name = lines[0]
+            text_contents = '\n'.join(lines[2:])
+            # do not end with double new line
+            if text_contents.endswith('\n\n'):
+                text_contents = text_contents[0:-1]
+            self._add_file(
+                tar=tar,
+                name='{0}{1}'.format(vpn_name, self.config_suffix),
+                contents=text_contents,
+            )

netjsonconfig/backends/openvpn/openvpn.py

@@ -1,12 +1,12 @@
 from ...schema import X509_FILE_MODE
-from ..base.backend import BaseBackend
+from ..base.backend import BaseVpnBackend
 from . import converters
 from .parser import OpenVpnParser, config_suffix, vpn_pattern
 from .renderer import OpenVpnRenderer
 from .schema import schema
 
 
-class OpenVpn(BaseBackend):
+class OpenVpn(BaseVpnBackend):
     """
     OpenVPN 2.x Configuration Backend
     """
@@ -16,32 +16,9 @@ class OpenVpn(BaseBackend):
     parser = OpenVpnParser
     renderer = OpenVpnRenderer
     list_identifiers = ['name']
-
-    def _generate_contents(self, tar):
-        """
-        Adds configuration files to tarfile instance.
-
-        :param tar: tarfile instance
-        :returns: None
-        """
-        text = self.render(files=False)
-        # create a list with all the packages (and remove empty entries)
-        vpn_instances = vpn_pattern.split(text)
-        if '' in vpn_instances:
-            vpn_instances.remove('')
-        # create a file for each VPN
-        for vpn in vpn_instances:
-            lines = vpn.split('\n')
-            vpn_name = lines[0]
-            text_contents = '\n'.join(lines[2:])
-            # do not end with double new line
-            if text_contents.endswith('\n\n'):
-                text_contents = text_contents[0:-1]
-            self._add_file(
-                tar=tar,
-                name='{0}{1}'.format(vpn_name, config_suffix),
-                contents=text_contents,
-            )
+    # BaseVpnBackend attributes
+    vpn_pattern = vpn_pattern
+    config_suffix = config_suffix
 
     @classmethod
     def auto_client(

netjsonconfig/backends/wireguard/wireguard.py

@@ -1,37 +1,14 @@
-from ..base.backend import BaseBackend
+from ..base.backend import BaseVpnBackend
 from . import converters
 from .parser import config_suffix, vpn_pattern
 from .renderer import WireguardRenderer
 from .schema import schema
 
 
-class Wireguard(BaseBackend):
+class Wireguard(BaseVpnBackend):
     schema = schema
     converters = [converters.Wireguard]
     renderer = WireguardRenderer
-
-    def _generate_contents(self, tar):
-        """
-        Adds configuration files to tarfile instance.
-
-        :param tar: tarfile instance
-        :returns: None
-        """
-        text = self.render(files=False)
-        # create a list with all the packages (and remove empty entries)
-        vpn_instances = vpn_pattern.split(text)
-        if '' in vpn_instances:
-            vpn_instances.remove('')
-        # create a file for each VPN
-        for vpn in vpn_instances:
-            lines = vpn.split('\n')
-            vpn_name = lines[0]
-            text_contents = '\n'.join(lines[2:])
-            # do not end with double new line
-            if text_contents.endswith('\n\n'):
-                text_contents = text_contents[0:-1]
-            self._add_file(
-                tar=tar,
-                name='{0}{1}'.format(vpn_name, config_suffix),
-                contents=text_contents,
-            )
+    # BaseVpnBackend attributes
+    vpn_pattern = vpn_pattern
+    config_suffix = config_suffix