[changes] Rendered ZeroTier configuration in JSON format

openwisp · Jun 5, 2023 · c78e68b · c78e68b
1 parent 6270334
commit c78e68b
Show file tree

Hide file tree

Showing 5 changed files with 246 additions and 103 deletions.
diff --git a/netjsonconfig/backends/zerotier/converters.py b/netjsonconfig/backends/zerotier/converters.py
@@ -14,25 +14,4 @@ def to_intermediate_loop(self, block, result, index=None):
         return result
 
     def __intermediate_vpn(self, config, remove=[False, 0, '']):
-        # The Zerotier network configuration keys taken from:
-        # https://github.com/zerotier/ZeroTierOne/blob/dev/node/NetworkConfig.hpp
-        config['nwid'] = config.pop('id')
-        config['t'] = config.pop('objtype')
-        config['r'] = config.pop('revision')
-        config['ts'] = config.pop('creationTime')
-        config['n'] = config.pop('name')
-        config['p'] = config.pop('private')
-        config['eb'] = config.pop('enableBroadcast')
-        config['v4s'] = config.pop('v4AssignMode')
-        config['v6s'] = config.pop('v6AssignMode')
-        config['mtu'] = config.pop('mtu')
-        config['ml'] = config.pop('multicastLimit')
-        config['I'] = config.pop('ipAssignmentPools')
-        config['RT'] = config.pop('routes')
-        config['DNS'] = config.pop('dns')
-        config['R'] = config.pop('rules')
-        config['CAP'] = config.pop('capabilities')
-        config['TAG'] = config.pop('tags')
-        config['tt'] = config.pop('remoteTraceTarget')
-        config['tl'] = config.pop('remoteTraceLevel')
         return self.sorted_dict(config)
diff --git a/netjsonconfig/backends/zerotier/parser.py b/netjsonconfig/backends/zerotier/parser.py
@@ -2,9 +2,9 @@
 
 from ..base.parser import BaseParser
 
-vpn_pattern = re.compile('^# zerotier config:\s', flags=re.MULTILINE)
+vpn_pattern = re.compile('^// zerotier config:\s', flags=re.MULTILINE)
 config_pattern = re.compile('^([^\s]*) ?(.*)$')
-config_suffix = '.conf'
+config_suffix = '.json'
 
 
 class ZeroTierParser(BaseParser):

diff --git a/netjsonconfig/backends/zerotier/schema.py b/netjsonconfig/backends/zerotier/schema.py
@@ -19,29 +19,39 @@
             "title": "ZeroTier",
             "uniqueItems": True,
             "additionalItems": True,
-            "propertyOrder": 12,
             "items": {
                 "type": "object",
-                "title": "ZeroTier",
+                "title": "ZeroTier Network",
                 "additionalProperties": True,
                 "required": ["name"],
                 "properties": {
                     # Read-only properties
+                    "name": {
+                        "type": "string",
+                        # Since it is intended to be set by
+                        # the VPN backend's name field, it is read-only
+                        "readOnly": True,
+                        "example": "openwisp-wifi-network",
+                        "description": "Name of the network",
+                    },
                     "id": {
                         "type": "string",
+                        "maxLength": 16,
                         "readOnly": True,
                         "example": "3e245e31af000001",
                         "description": "Network ID",
                     },
                     "nwid": {
                         "type": "string",
+                        "maxLength": 16,
                         "readOnly": True,
                         "example": "3e245e31af000001",
                         "description": "Network ID legacy field (same as 'id')",
                     },
                     "objtype": {
                         "type": "string",
                         "readOnly": True,
+                        "default": "network",
                         "example": "network",
                     },
                     "revision": {
@@ -54,19 +64,15 @@
                         "type": "number",
                         "readOnly": True,
                         "example": 1623101592,
-                        "description": "Time the network was created",
+                        "description": "Time when the network was created",
                     },
                     # Configurable properties
-                    "name": {
-                        "type": "string",
-                        "example": "openwisp-wifi-network",
-                        "description": "Name of the network",
-                    },
                     "private": {
                         "type": "boolean",
+                        "default": True,
                         "description": (
-                            "Whether or not the network is private."
-                            "If false, members will *NOT* need to be authorized to join."
+                            "Whether or not the network is private "
+                            "If false, members will NOT need to be authorized to join"
                         ),
                     },
                     "enableBroadcast": {
@@ -76,8 +82,10 @@
                     "v4AssignMode": {
                         "type": "object",
                         "properties": {
-                            "zt": {"type": "boolean"},
-                            "description": "Whether ZeroTier should assign IPv4 addresses to members",
+                            "zt": {
+                                "type": "boolean",
+                                "description": "Whether ZeroTier should assign IPv4 addresses to members",
+                            },
                         },
                     },
                     "v6AssignMode": {

diff --git a/netjsonconfig/backends/zerotier/templates/zerotier.jinja2 b/netjsonconfig/backends/zerotier/templates/zerotier.jinja2
@@ -1,17 +1,6 @@
 {% for vpn in data.zerotier %}
-# zerotier config: {{ vpn.nwid }}
+// zerotier config: {{ vpn.nwid }}
 
-    {% for key, value in vpn.items() %}
-        {% set key = key.replace('_', '-') %}
-        {% if key != 'name' %}
-            {% if value is string or value is number %}
-                {{ key }}={{ value }}
-            {% elif value is iterable %}
-                {% for element in value %}
-                    {{ key }}={{ element }}
-                {% endfor %}
-            {% endif %}
-        {% endif %}
-    {% endfor %}
+{{ vpn | tojson(indent=2)}}
 
 {% endfor %}