From 54675c2cc9aa9c1315478107cce14e5ba23d865e Mon Sep 17 00:00:00 2001
From: Christian Poessinger <christian@poessinger.com>
Date: Tue, 11 Jan 2022 10:27:13 +0100
Subject: policy: T4170: rename "policy ipv6-route" -> "policy route6"

In order to have a consistent looking CLI we should rename this CLI node.

There is:
* access-list and access-list6 (policy)
* prefix-list and prefix-list6 (policy)
* route and route6 (static routes)
---
 data/templates/firewall/nftables-policy.tmpl |  6 ++--
 interface-definitions/policy-route.xml.in    |  2 +-
 src/conf_mode/policy-route.py                |  4 +--
 src/migration-scripts/policy/1-to-2          | 49 ++++++++++++++++++++++++++++
 4 files changed, 55 insertions(+), 6 deletions(-)
 create mode 100755 src/migration-scripts/policy/1-to-2

diff --git a/data/templates/firewall/nftables-policy.tmpl b/data/templates/firewall/nftables-policy.tmpl
index aa6bb6fc1..ecc7e0fbd 100644
--- a/data/templates/firewall/nftables-policy.tmpl
+++ b/data/templates/firewall/nftables-policy.tmpl
@@ -9,7 +9,7 @@ table ip mangle {
         type filter hook postrouting priority -150; policy accept;
     }
 {% endif %}
-{% if route is defined -%}
+{% if route is defined and route is not none -%}
 {%   for route_text, conf in route.items() %}
     chain VYOS_PBR_{{ route_text }} {
 {%     if conf.rule is defined %}
@@ -36,8 +36,8 @@ table ip6 mangle {
         type filter hook postrouting priority -150; policy accept;
     }
 {% endif %}
-{% if ipv6_route is defined %}
-{%   for route_text, conf in ipv6_route.items() %}
+{% if route6 is defined and route6 is not none %}
+{%   for route_text, conf in route6.items() %}
     chain VYOS_PBR6_{{ route_text }} {
 {%     if conf.rule is defined %}
 {%       for rule_id, rule_conf in conf.rule.items() if rule_conf.disable is not defined %}
diff --git a/interface-definitions/policy-route.xml.in b/interface-definitions/policy-route.xml.in
index ee456a82b..4ce953b52 100644
--- a/interface-definitions/policy-route.xml.in
+++ b/interface-definitions/policy-route.xml.in
@@ -2,7 +2,7 @@
 <interfaceDefinition>
   <node name="policy">
     <children>
-      <tagNode name="ipv6-route" owner="${vyos_conf_scripts_dir}/policy-route.py">
+      <tagNode name="route6" owner="${vyos_conf_scripts_dir}/policy-route.py">
         <properties>
           <help>Policy route rule set name for IPv6</help>
           <priority>201</priority>
diff --git a/src/conf_mode/policy-route.py b/src/conf_mode/policy-route.py
index d098be68d..9edab4b47 100755
--- a/src/conf_mode/policy-route.py
+++ b/src/conf_mode/policy-route.py
@@ -51,7 +51,7 @@ def verify(policy):
     if not policy:
         return None
 
-    for route in ['route', 'ipv6_route']:
+    for route in ['route', 'route6']:
         if route in policy:
             for name, pol_conf in policy[route].items():
                 if 'rule' in pol_conf:
@@ -98,7 +98,7 @@ def generate(policy):
     return None
 
 def apply_table_marks(policy):
-    for route in ['route', 'ipv6_route']:
+    for route in ['route', 'route6']:
         if route in policy:
             for name, pol_conf in policy[route].items():
                 if 'rule' in pol_conf:
diff --git a/src/migration-scripts/policy/1-to-2 b/src/migration-scripts/policy/1-to-2
new file mode 100755
index 000000000..3e46227de
--- /dev/null
+++ b/src/migration-scripts/policy/1-to-2
@@ -0,0 +1,49 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2022 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# T4170: rename "policy ipv6-route" to "policy route6" to match common
+#        IPv4/IPv6 schema
+
+from sys import argv
+from sys import exit
+
+from vyos.configtree import ConfigTree
+
+if (len(argv) < 1):
+    print("Must specify file name!")
+    exit(1)
+
+file_name = argv[1]
+
+with open(file_name, 'r') as f:
+    config_file = f.read()
+
+base = ['policy', 'ipv6-route']
+config = ConfigTree(config_file)
+
+if not config.exists(base):
+    # Nothing to do
+    exit(0)
+
+config.rename(base, 'route6')
+config.set_tag(['policy', 'route6'])
+
+try:
+    with open(file_name, 'w') as f:
+        f.write(config.to_string())
+except OSError as e:
+    print(f'Failed to save the modified config: {e}')
+    exit(1)
-- 
cgit v1.2.3