nat(66): T4333: migrate to new vyos_defined Jinja2 test

2 files changed, 119 insertions, 121 deletions

diff --git a/data/templates/firewall/nftables-nat.tmpl b/data/templates/firewall/nftables-nat.tmpl
index 9ea880697..922f3dcb4 100644
--- a/data/templates/firewall/nftables-nat.tmpl
+++ b/data/templates/firewall/nftables-nat.tmpl
@@ -3,146 +3,144 @@
 {% macro nat_rule(rule, config, chain) %}
 {%   set comment  = '' %}
 {%   set base_log = '' %}
-{%   set src_addr  = 'ip saddr ' + config.source.address.replace('!','!= ') if config.source is defined and config.source.address is defined and config.source.address is not none %}
-{%   set dst_addr  = 'ip daddr ' + config.destination.address.replace('!','!= ') if config.destination is defined and config.destination.address is defined and config.destination.address is not none %}
+{%   set src_addr  = 'ip saddr ' ~ config.source.address.replace('!','!= ') if config.source.address is vyos_defined %}
+{%   set dst_addr  = 'ip daddr ' ~ config.destination.address.replace('!','!= ') if config.destination.address is vyos_defined %}
 {#   negated port groups need special treatment, move != in front of { } group #}
-{%   if config.source is defined and config.source.port is defined and config.source.port is not none and config.source.port.startswith('!=') %}
-{%     set src_port  = 'sport != { ' + config.source.port.replace('!=','') + ' }' %}
+{%   if config.source.port is vyos_defined and config.source.port.startswith('!=') %}
+{%     set src_port  = 'sport != { ' ~ config.source.port.replace('!=','') ~ ' }' %}
 {%   else %}
-{%     set src_port  = 'sport { ' + config.source.port + ' }' if config.source is defined and config.source.port is defined and config.source.port is not none %}
+{%     set src_port  = 'sport { ' ~ config.source.port ~ ' }' if config.source.port is vyos_defined %}
 {%   endif %}
 {#   negated port groups need special treatment, move != in front of { } group #}
-{%   if config.destination is defined and config.destination.port is defined and config.destination.port is not none and config.destination.port.startswith('!=') %}
-{%     set dst_port  = 'dport != { ' + config.destination.port.replace('!=','') + ' }' %}
+{%   if config.destination.port is vyos_defined and config.destination.port.startswith('!=') %}
+{%     set dst_port  = 'dport != { ' ~ config.destination.port.replace('!=','') ~ ' }' %}
 {%   else %}
-{%     set dst_port  = 'dport { ' + config.destination.port + ' }' if config.destination is defined and config.destination.port is defined and config.destination.port is not none %}
+{%     set dst_port  = 'dport { ' ~ config.destination.port ~ ' }' if config.destination.port is vyos_defined %}
 {%   endif %}
-{%   if chain == 'PREROUTING' %}
-{%     set comment   = 'DST-NAT-' + rule %}
-{%     set base_log  = '[NAT-DST-' + rule %}
-{%     set interface = ' iifname "' + config.inbound_interface + '"' if config.inbound_interface is defined and config.inbound_interface != 'any' else '' %}
-{%     if config.translation is defined and config.translation.address is defined and config.translation.address is not none %}
+{%   if chain is vyos_defined('PREROUTING') %}
+{%     set comment   = 'DST-NAT-' ~ rule %}
+{%     set base_log  = '[NAT-DST-' ~ rule %}
+{%     set interface = ' iifname "' ~ config.inbound_interface ~ '"' if config.inbound_interface is vyos_defined and config.inbound_interface is not vyos_defined('any') else '' %}
+{%     if config.translation.address is vyos_defined %}
 {#       support 1:1 network translation #}
 {%       if config.translation.address | is_ip_network %}
-{%         set trns_addr = 'dnat ip prefix to ip daddr map { ' + config.destination.address + ' : ' + config.translation.address + ' }' %}
+{%         set trns_addr = 'dnat ip prefix to ip daddr map { ' ~ config.destination.address ~ ' : ' ~ config.translation.address ~ ' }' %}
 {#         we can now clear out the dst_addr part as it's already covered in aboves map #}
 {%         set dst_addr  = '' %}
 {%       else %}
-{%         set trns_addr = 'dnat to ' + config.translation.address %}
+{%         set trns_addr = 'dnat to ' ~ config.translation.address %}
 {%       endif %}
 {%     endif %}
-{%   elif chain == 'POSTROUTING' %}
-{%     set comment   = 'SRC-NAT-' + rule %}
-{%     set base_log  = '[NAT-SRC-' + rule %}
-{%     set interface = ' oifname "' + config.outbound_interface + '"' if config.outbound_interface is defined and config.outbound_interface != 'any' else '' %}
-{%     if config.translation is defined and config.translation.address is defined and config.translation.address is not none %}
-{%       if config.translation.address == 'masquerade' %}
+{%   elif chain is vyos_defined('POSTROUTING') %}
+{%     set comment   = 'SRC-NAT-' ~ rule %}
+{%     set base_log  = '[NAT-SRC-' ~ rule %}
+{%     set interface = ' oifname "' ~ config.outbound_interface ~ '"' if config.outbound_interface is vyos_defined and config.outbound_interface is not vyos_defined('any') else '' %}
+{%     if config.translation.address is vyos_defined %}
+{%       if config.translation.address is vyos_defined('masquerade') %}
 {%         set trns_addr = config.translation.address %}
-{%         if config.translation.port is defined and config.translation.port is not none %}
-{%           set trns_addr = trns_addr + ' to ' %}
+{%         if config.translation.port is vyos_defined %}
+{%           set trns_addr = trns_addr ~ ' to ' %}
 {%         endif %}
 {#       support 1:1 network translation #}
 {%       elif config.translation.address | is_ip_network %}
-{%         set trns_addr = 'snat ip prefix to ip saddr map { ' + config.source.address + ' : ' + config.translation.address + ' }' %}
+{%         set trns_addr = 'snat ip prefix to ip saddr map { ' ~ config.source.address ~ ' : ' ~ config.translation.address ~ ' }' %}
 {#         we can now clear out the src_addr part as it's already covered in aboves map #}
 {%         set src_addr  = '' %}
 {%       else %}
-{%         set trns_addr = 'snat to ' + config.translation.address %}
+{%         set trns_addr = 'snat to ' ~ config.translation.address %}
 {%       endif %}
 {%     endif %}
 {%   endif %}
-{%   set trns_port = ':' + config.translation.port if config.translation is defined and config.translation.port is defined and config.translation.port is not none %}
+{%   set trns_port = ':' ~ config.translation.port if config.translation.port is vyos_defined %}
 {#   protocol has a default value thus it is always present #}
-{%   if config.protocol == 'tcp_udp' %}
+{%   if config.protocol is vyos_defined('tcp_udp') %}
 {%     set protocol  = 'tcp' %}
-{%     set comment   = comment + ' tcp_udp' %}
+{%     set comment   = comment ~ ' tcp_udp' %}
 {%   else %}
 {%     set protocol  = config.protocol %}
 {%   endif %}
-{%   if config.log is defined %}
-{%     if config.exclude is defined %}
-{%       set log = base_log + '-EXCL]' %}
-{%     elif config.translation is defined and config.translation.address is defined and config.translation.address == 'masquerade' %}
+{%   if config.log is vyos_defined %}
+{%     if config.exclude is vyos_defined %}
+{%       set log = base_log ~ '-EXCL]' %}
+{%     elif config.translation.address is vyos_defined('masquerade') %}
 {%       set log = base_log +'-MASQ]' %}
 {%     else %}
-{%       set log = base_log + ']' %}
+{%       set log = base_log ~ ']' %}
 {%     endif %}
 {%   endif %}
-{%   if config.exclude is defined %}
+{%   if config.exclude is vyos_defined %}
 {#     rule has been marked as 'exclude' thus we simply return here #}
 {%     set trns_addr = 'return' %}
 {%     set trns_port = '' %}
 {%   endif %}
 {#   T1083: NAT address and port translation options #}
-{%   if config.translation is defined and config.translation.options is defined and config.translation.options is not none %}
-{%     if config.translation.options.address_mapping is defined and config.translation.options.address_mapping == "persistent" %}
+{%   if config.translation.options is vyos_defined %}
+{%     if config.translation.options.address_mapping is vyos_defined('persistent') %}
 {%         set trns_opts_addr  = 'persistent' %}
 {%     endif %}
-{%     if config.translation.options.port_mapping is defined %}
-{%       if config.translation.options.port_mapping == "random" %}
-{%         set trns_opts_port  = 'random' %}
-{%       elif config.translation.options.port_mapping == "fully-random" %}
-{%         set trns_opts_port  = 'fully-random' %}
-{%       endif %}
+{%     if config.translation.options.port_mapping is vyos_defined('random') %}
+{%       set trns_opts_port  = 'random' %}
+{%     elif config.translation.options.port_mapping is vyos_defined('fully-random') %}
+{%       set trns_opts_port  = 'fully-random' %}
 {%     endif %}
 {%   endif %}
-{%   if trns_opts_addr and trns_opts_port %}
-{%     set trns_opts  = trns_opts_addr + ',' + trns_opts_port %}
-{%   elif trns_opts_addr %}
+{%   if trns_opts_addr is vyos_defined and trns_opts_port is vyos_defined %}
+{%     set trns_opts  = trns_opts_addr ~ ',' ~ trns_opts_port %}
+{%   elif trns_opts_addr is vyos_defined %}
 {%     set trns_opts  = trns_opts_addr %}
-{%   elif trns_opts_port %}
+{%   elif trns_opts_port is vyos_defined %}
 {%     set trns_opts  = trns_opts_port %}
 {%   endif %}
-{%   set output = 'add rule ip nat ' + chain + interface %}
-{%   if protocol != 'all' %}
-{%     set output = output + ' ip protocol ' + protocol %}
+{%   set output = 'add rule ip nat ' ~ chain ~ interface %}
+{%   if protocol is not vyos_defined('all') %}
+{%     set output = output ~ ' ip protocol ' ~ protocol %}
 {%   endif %}
-{%   if src_addr %}
-{%     set output = output + ' ' + src_addr %}
+{%   if src_addr is vyos_defined %}
+{%     set output = output ~ ' ' ~ src_addr %}
 {%   endif %}
-{%   if src_port %}
-{%     set output = output + ' ' + protocol + ' ' + src_port %}
+{%   if src_port is vyos_defined %}
+{%     set output = output ~ ' ' ~ protocol ~ ' ' ~ src_port %}
 {%   endif %}
-{%   if dst_addr %}
-{%     set output = output + ' ' + dst_addr %}
+{%   if dst_addr is vyos_defined %}
+{%     set output = output ~ ' ' ~ dst_addr %}
 {%   endif %}
-{%   if dst_port %}
-{%     set output = output + ' ' + protocol + ' ' + dst_port %}
+{%   if dst_port is vyos_defined %}
+{%     set output = output ~ ' ' ~ protocol ~ ' ' ~ dst_port %}
 {%   endif %}
 {#   Count packets #}
-{%     set output = output + ' counter' %}
+{%   set output = output ~ ' counter' %}
 {#   Special handling of log option, we must repeat the entire rule before the #}
 {#   NAT translation options are added, this is essential                      #}
-{%   if log %}
-{%     set log_output = output + ' log prefix "' + log + '" comment "' + comment + '"' %}
+{%   if log is vyos_defined %}
+{%     set log_output = output ~ ' log prefix "' ~ log ~ '" comment "' ~ comment ~ '"' %}
 {%   endif %}
-{%   if trns_addr %}
-{%     set output = output + ' ' + trns_addr %}
+{%   if trns_addr is vyos_defined %}
+{%     set output = output ~ ' ' ~ trns_addr %}
 {%   endif %}
-{%   if trns_port %}
+{%   if trns_port is vyos_defined %}
 {#     Do not add a whitespace here, translation port must be directly added after IP address #}
 {#     e.g. 192.0.2.10:3389                                                                   #}
-{%     set output = output + trns_port %}
+{%     set output = output ~ trns_port %}
 {%   endif %}
-{%   if trns_opts %}
-{%     set output = output + ' ' + trns_opts %}
+{%   if trns_opts is vyos_defined %}
+{%     set output = output ~ ' ' ~ trns_opts %}
 {%   endif %}
-{%   if comment %}
-{%     set output = output + ' comment "' + comment + '"' %}
+{%   if comment is vyos_defined %}
+{%     set output = output ~ ' comment "' ~ comment ~ '"' %}
 {%   endif %}
-{{ log_output if log_output }}
+{{ log_output if log_output is vyos_defined}}
 {{ output }}
 {#   Special handling if protocol is tcp_udp, we must repeat the entire rule with udp as protocol #}
-{%   if config.protocol == 'tcp_udp' %}
-{#     Beware of trailing whitespace, without it the comment tcp_udp will be changed to udp_udp   #}
-{{ log_output | replace('tcp ', 'udp ') if log_output }}
+{%   if config.protocol is vyos_defined('tcp_udp') %}
+{#     Beware of trailing whitespace, without it the comment tcp_udp will be changed to udp_udp #}
+{{ log_output | replace('tcp ', 'udp ') if log_output is vyos_defined }}
 {{ output | replace('tcp ', 'udp ') }}
 {%   endif %}
 {% endmacro %}
 
 # Start with clean NAT table
 flush table ip nat
-{% if helper_functions == 'remove' %}
+{% if helper_functions is vyos_defined('remove') %}
 {# NAT if going to be disabled - remove rules and targets from nftables #}
 {%   set base_command = 'delete rule ip raw' %}
 {{ base_command }} PREROUTING handle {{ pre_ct_ignore }}
@@ -152,7 +150,7 @@ flush table ip nat
 
 delete chain ip raw NAT_CONNTRACK
 
-{% elif helper_functions == 'add' %}
+{% elif helper_functions is vyos_defined('add') %}
 {# NAT if enabled - add targets to nftables #}
 add chain ip raw NAT_CONNTRACK
 add rule ip raw NAT_CONNTRACK counter accept
@@ -166,16 +164,16 @@ add rule ip raw NAT_CONNTRACK counter accept
 #
 # Destination NAT rules build up here
 #
-{% if destination is defined and destination.rule is defined and destination.rule is not none %}
-{%   for rule, config in destination.rule.items() if config.disable is not defined %}
+{% if destination.rule is vyos_defined %}
+{%   for rule, config in destination.rule.items() if config.disable is not vyos_defined %}
 {{ nat_rule(rule, config, 'PREROUTING') }}
 {%   endfor %}
 {% endif %}
 #
 # Source NAT rules build up here
 #
-{% if source is defined and source.rule is defined and source.rule is not none %}
-{%   for rule, config in source.rule.items() if config.disable is not defined %}
+{% if source.rule is vyos_defined %}
+{%   for rule, config in source.rule.items() if config.disable is not vyos_defined %}
 {{ nat_rule(rule, config, 'POSTROUTING') }}
 {%   endfor %}
 {% endif %}
diff --git a/data/templates/firewall/nftables-nat66.tmpl b/data/templates/firewall/nftables-nat66.tmpl
index e5c1b1b8d..ed98b888a 100644
--- a/data/templates/firewall/nftables-nat66.tmpl
+++ b/data/templates/firewall/nftables-nat66.tmpl
@@ -3,83 +3,83 @@
 {% macro nptv6_rule(rule,config, chain) %}
 {%   set comment  = '' %}
 {%   set base_log = '' %}
-{%   set src_prefix  = "ip6 saddr " + config.source.prefix if config.source is defined and config.source.prefix is defined and config.source.prefix is not none  %}
-{%   set dest_address  = "ip6 daddr " + config.destination.address if config.destination is defined and config.destination.address is defined and config.destination.address is not none %}
-{%   if chain == "PREROUTING" %}
-{%     set comment   = "DST-NAT66-" + rule %}
-{%     set base_log  = '[NAT66-DST-' + rule %}
-{%     set interface = " iifname \"" + config.inbound_interface + "\"" if config.inbound_interface is defined and config.inbound_interface != 'any' else '' %}
+{%   set src_prefix  = 'ip6 saddr ' ~ config.source.prefix if config.source.prefix is vyos_defined %}
+{%   set dest_address  = 'ip6 daddr ' ~ config.destination.address if config.destination.address is vyos_defined %}
+{%   if chain is vyos_defined('PREROUTING') %}
+{%     set comment   = 'DST-NAT66-' ~ rule %}
+{%     set base_log  = '[NAT66-DST-' ~ rule %}
+{%     set interface = ' iifname "' ~ config.inbound_interface ~ '"' if config.inbound_interface is vyos_defined and config.inbound_interface is not vyos_defined('any') else '' %}
 {%     if config.translation.address | is_ip_network %}
 {#       support 1:1 network translation #}
-{%       set dnat_type = "dnat prefix to " %}
+{%       set dnat_type = 'dnat prefix to ' %}
 {%     else   %}
-{%       set dnat_type = "dnat to " %}
+{%       set dnat_type = 'dnat to ' %}
 {%     endif %}
-{%     set trns_address = dnat_type + config.translation.address if config.translation is defined and config.translation.address is defined and config.translation.address is not none  %}
-{%   elif chain == "POSTROUTING" %}
-{%     set comment   = 'SRC-NAT66-' + rule %}
-{%     set base_log  = '[NAT66-SRC-' + rule %}
-{%     if config.translation is defined and config.translation.address is defined and config.translation.address is not none  %}
-{%         if config.translation.address == 'masquerade' %}
+{%     set trns_address = dnat_type ~ config.translation.address if config.translation.address is vyos_defined %}
+{%   elif chain is vyos_defined('POSTROUTING') %}
+{%     set comment   = 'SRC-NAT66-' ~ rule %}
+{%     set base_log  = '[NAT66-SRC-' ~ rule %}
+{%     if config.translation.address is vyos_defined %}
+{%         if config.translation.address is vyos_defined('masquerade') %}
 {%             set trns_address = config.translation.address %}
-{%         else   %}
+{%         else %}
 {%             if config.translation.address | is_ip_network %}
 {#                 support 1:1 network translation #}
-{%                 set snat_type = "snat prefix to " %}
+{%                 set snat_type = 'snat prefix to ' %}
 {%             else   %}
-{%                 set snat_type = "snat to " %}
+{%                 set snat_type = 'snat to ' %}
 {%             endif %}
-{%             set trns_address = snat_type + config.translation.address %}
+{%             set trns_address = snat_type ~ config.translation.address %}
 {%         endif %}
 {%     endif   %}
-{%     set interface = " oifname \"" + config.outbound_interface + "\"" if config.outbound_interface is defined else '' %}
+{%     set interface = ' oifname "' ~ config.outbound_interface ~ '"' if config.outbound_interface is vyos_defined else '' %}
 {%   endif %}
-{%   if config.log is defined %}
-{%     if config.translation is defined and config.translation.address is defined and config.translation.address == 'masquerade' %}
+{%   if config.log is vyos_defined %}
+{%     if config.translation.address is vyos_defined('masquerade') %}
 {%       set log = base_log +'-MASQ]' %}
 {%     else %}
-{%       set log = base_log + "]" %}
+{%       set log = base_log ~ ']' %}
 {%     endif %}
 {%   endif %}
-{%   set output = "add rule ip6 nat " + chain + interface %}
+{%   set output = 'add rule ip6 nat ' ~ chain ~ interface %}
 {#   Count packets #}
-{%     set output = output + " counter" %}
+{%   set output = output ~ ' counter' %}
 {#   Special handling of log option, we must repeat the entire rule before the #}
 {#   NAT translation options are added, this is essential                      #}
-{%   if log %}
-{%     set log_output = output + " log prefix \"" + log + "\" comment \"" + comment + "\"" %}
+{%   if log is vyos_defined %}
+{%     set log_output = output ~ ' log prefix "' ~ log ~ '" comment "' ~ comment ~ '"' %}
 {%   endif %}
-{%   if src_prefix %}
-{%     set output = output + " " + src_prefix %}
+{%   if src_prefix is vyos_defined %}
+{%     set output = output ~ ' ' ~ src_prefix %}
 {%   endif %}
-{%   if dest_address %}
-{%     set output = output + " " + dest_address %}
+{%   if dest_address is vyos_defined %}
+{%     set output = output ~ ' ' ~ dest_address %}
 {%   endif %}
-{%   if trns_address %}
-{%     set output = output + " " + trns_address %}
+{%   if trns_address is vyos_defined %}
+{%     set output = output ~ ' ' ~ trns_address %}
 {%   endif %}
-{%   if comment %}
-{%     set output = output + " comment \"" + comment + "\"" %}
+{%   if comment is vyos_defined %}
+{%     set output = output ~ ' comment "' ~ comment ~ '"' %}
 {%   endif %}
-{{ log_output if log_output }}
+{{ log_output if log_output is vyos_defined }}
 {{ output }}
 {% endmacro %}
 
 # Start with clean NAT table
 flush table ip6 nat
-{% if helper_functions == 'remove' %}
+{% if helper_functions is vyos_defined('remove') %}
 {# NAT if going to be disabled - remove rules and targets from nftables #}
-{%   set base_command = "delete rule ip6 raw" %}
+{%   set base_command = 'delete rule ip6 raw' %}
 {{base_command}} PREROUTING handle {{ pre_ct_conntrack }}
 {{base_command}} OUTPUT handle {{ out_ct_conntrack }}
 
 delete chain ip6 raw NAT_CONNTRACK
 
-{% elif helper_functions == 'add' %}
+{% elif helper_functions is vyos_defined('add') %}
 {# NAT if enabled - add targets to nftables #}
 add chain ip6 raw NAT_CONNTRACK
 add rule ip6 raw NAT_CONNTRACK counter accept
-{%   set base_command = "add rule ip6 raw" %}
+{%   set base_command = 'add rule ip6 raw' %}
 {{ base_command }} PREROUTING position {{ pre_ct_conntrack }} counter jump NAT_CONNTRACK
 {{ base_command }} OUTPUT     position {{ out_ct_conntrack }} counter jump NAT_CONNTRACK
 {% endif %}
@@ -87,16 +87,16 @@ add rule ip6 raw NAT_CONNTRACK counter accept
 #
 # Destination NAT66 rules build up here
 #
-{% if destination is defined and destination.rule is defined and destination.rule is not none %}
-{%   for rule, config in destination.rule.items() if config.disable is not defined %}
+{% if destination.rule is vyos_defined %}
+{%   for rule, config in destination.rule.items() if config.disable is not vyos_defined %}
 {{ nptv6_rule(rule, config, 'PREROUTING') }}
 {%   endfor %}
 {% endif %}
 #
 # Source NAT66 rules build up here
 #
-{% if source is defined and source.rule is defined and source.rule is not none %}
-{%   for rule, config in source.rule.items() if config.disable is not defined %}
+{% if source.rule is vyos_defined %}
+{%   for rule, config in source.rule.items() if config.disable is not vyos_defined %}
 {{ nptv6_rule(rule, config, 'POSTROUTING') }}
 {%   endfor %}
 {% endif %}