feat(opennebula): support ETHx_ROUTES static routes in network config

Add `get_routes()` to `OpenNebulaNetwork` to parse the `ETHx_ROUTES`
context variable (format: "NETWORK via GATEWAY, ...") and emit the
resulting routes into the Netplan v2 `routes:` list in `gen_conf()`.

Malformed entries are skipped with a warning. No `routes` key is emitted
when the variable is absent or empty, preserving backward compatibility.

Author: mcanevet

cloudinit/sources/DataSourceOpenNebula.py

@@ -217,6 +217,28 @@ def get_gateway6(self, dev):
     def get_mask(self, dev):
         return self.get_field(dev, "mask", "255.255.255.0")
 
+    def get_routes(self, dev):
+        """Parse ETHx_ROUTES into a list of Netplan route dicts.
+
+        Expected format: "NETWORK via GATEWAY[, NETWORK via GATEWAY, ...]"
+        e.g. "10.0.0.0/8 via 192.168.1.1, 192.168.100.0/24 via 10.0.0.1"
+        Returns an empty list when the variable is absent or empty.
+        """
+        raw = self.get_field(dev, "routes", "")
+        routes = []
+        for entry in raw.split(","):
+            entry = entry.strip()
+            if not entry:
+                continue
+            parts = entry.split()
+            if len(parts) == 3 and parts[1].lower() == "via":
+                routes.append({"to": parts[0], "via": parts[2]})
+            else:
+                LOG.warning(
+                    "Unparseable ETHx_ROUTES entry for %s: %r", dev, entry
+                )
+        return routes
+
     def get_field(self, dev, name, default=None):
         """return the field name in context for device dev.
 
@@ -285,6 +307,11 @@ def gen_conf(self):
             if mtu:
                 devconf["mtu"] = mtu
 
+            # Set static routes
+            extra_routes = self.get_routes(c_dev)
+            if extra_routes:
+                devconf["routes"] = extra_routes
+
             ethernets[dev] = devconf
 
         netconf["ethernets"] = ethernets
@@ -312,15 +339,13 @@ def switch_user_cmd(user):
 
 def varprinter():
     """print the shell environment variables within delimiters to be parsed"""
-    return textwrap.dedent(
-        """
+    return textwrap.dedent("""
         printf "%s\\0" _start_
         [ $0 != 'sh' ] && set -o posix
         set
         [ $0 != 'sh' ] && set +o posix
         printf "%s\\0" _start_
-        """
-    )
+        """)
 
 
 def parse_shell_config(content, asuser=None):

doc/rtd/reference/datasources/opennebula.rst

@@ -72,9 +72,15 @@ the OpenNebula documentation.
     ETH<x>_IP6_ULA
     ETH<x>_IP6_PREFIX_LENGTH
     ETH<x>_IP6_GATEWAY
+    ETH<x>_ROUTES
 
 Static `network configuration`_.
 
+``ETH<x>_ROUTES`` is a comma-separated list of static routes in the form
+``NETWORK via GATEWAY``. For example::
+
+    ETH0_ROUTES="10.0.0.0/8 via 192.168.1.1, 172.16.0.0/12 via 192.168.1.254"
+
 ::
 
     SET_HOSTNAME

tests/unittests/sources/test_opennebula.py

@@ -986,6 +986,87 @@ def test_multiple_nics(self):
 
         assert expected == net.gen_conf()
 
+    # ------------------------------------------------------------------ #
+    # ETHx_ROUTES                                                          #
+    # ------------------------------------------------------------------ #
+
+    def test_get_routes_absent(self):
+        """get_routes returns empty list when ETHx_ROUTES is not set."""
+        net = ds.OpenNebulaNetwork({}, mock.Mock())
+        assert net.get_routes("eth0") == []
+
+    def test_get_routes_empty_string(self):
+        """get_routes returns empty list when ETHx_ROUTES is empty string."""
+        net = ds.OpenNebulaNetwork({"ETH0_ROUTES": ""}, mock.Mock())
+        assert net.get_routes("eth0") == []
+
+    def test_get_routes_single(self):
+        """get_routes parses a single 'NETWORK via GATEWAY' entry."""
+        net = ds.OpenNebulaNetwork(
+            {"ETH0_ROUTES": "10.0.0.0/8 via 192.168.1.1"}, mock.Mock()
+        )
+        assert net.get_routes("eth0") == [
+            {"to": "10.0.0.0/8", "via": "192.168.1.1"}
+        ]
+
+    def test_get_routes_multiple(self):
+        """get_routes parses multiple comma-separated entries."""
+        net = ds.OpenNebulaNetwork(
+            {
+                "ETH0_ROUTES": (
+                    "10.0.0.0/8 via 192.168.1.1,"
+                    " 172.16.0.0/12 via 192.168.1.254"
+                )
+            },
+            mock.Mock(),
+        )
+        assert net.get_routes("eth0") == [
+            {"to": "10.0.0.0/8", "via": "192.168.1.1"},
+            {"to": "172.16.0.0/12", "via": "192.168.1.254"},
+        ]
+
+    def test_get_routes_malformed_entry_skipped(self):
+        """get_routes silently skips entries it cannot parse."""
+        net = ds.OpenNebulaNetwork(
+            {"ETH0_ROUTES": "bad-entry, 10.0.0.0/8 via 192.168.1.1"},
+            mock.Mock(),
+        )
+        assert net.get_routes("eth0") == [
+            {"to": "10.0.0.0/8", "via": "192.168.1.1"}
+        ]
+
+    @mock.patch(DS_PATH + ".get_physical_nics_by_mac")
+    def test_gen_conf_routes(self, m_get_phys_by_mac):
+        """Routes from ETHx_ROUTES appear in gen_conf() output."""
+        self.maxDiff = None
+        context = {
+            "ETH0_MAC": "02:00:0a:12:01:01",
+            "ETH0_IP": "10.0.0.5",
+            "ETH0_MASK": "255.255.255.0",
+            "ETH0_GATEWAY": "10.0.0.1",
+            "ETH0_ROUTES": (
+                "192.168.0.0/16 via 10.0.0.1, 172.16.0.0/12 via 10.0.0.1"
+            ),
+        }
+        for nic in self.system_nics:
+            m_get_phys_by_mac.return_value = {MACADDR: nic}
+            net = ds.OpenNebulaNetwork(context, mock.Mock())
+            conf = net.gen_conf()
+            routes = conf["ethernets"][nic].get("routes", [])
+            assert {"to": "192.168.0.0/16", "via": "10.0.0.1"} in routes
+            assert {"to": "172.16.0.0/12", "via": "10.0.0.1"} in routes
+
+    @mock.patch(DS_PATH + ".get_physical_nics_by_mac")
+    def test_gen_conf_no_routes_key_when_absent(self, m_get_phys_by_mac):
+        """gen_conf() does not emit 'routes' key when ETHx_ROUTES is unset."""
+        context = {
+            "ETH0_MAC": "02:00:0a:12:01:01",
+        }
+        m_get_phys_by_mac.return_value = {MACADDR: "eth0"}
+        net = ds.OpenNebulaNetwork(context, mock.Mock())
+        conf = net.gen_conf()
+        assert "routes" not in conf["ethernets"]["eth0"]
+
 
 class TestParseShellConfig:
     @pytest.mark.allow_subp_for("bash", "sh")