migrate away from erb

.fixtures.yml

@@ -3,3 +3,4 @@ fixtures:
     concat: "https://github.com/puppetlabs/puppetlabs-concat.git"
     stdlib: "https://github.com/puppetlabs/puppetlabs-stdlib.git"
     systemd: "https://github.com/voxpupuli/puppet-systemd.git"
+    extlib: "https://github.com/voxpupuli/puppet-extlib.git"

REFERENCE.md

@@ -20,6 +20,7 @@
 ### Functions
 
 * [`unbound::print_config`](#unbound--print_config): Print a configuration value if it is defined and the version is supported
+* [`unbound::split_txt`](#unbound--split_txt): function to split TXT records. Long TXT records must be broken into strings of 255 characters as per RFC 4408
 
 ### Data types
 
@@ -2357,7 +2358,7 @@ Custom type Unbound::Local_zone_type.
 
 ##### <a name="-unbound--localzone--config_file"></a>`config_file`
 
-Data type: `Any`
+Data type: `Stdlib::Absolutepath`
 
 name of configuration file.
 
@@ -2543,7 +2544,7 @@ Type: Puppet Language
 
 Print a configuration value if it is defined and the version is supported
 
-#### `unbound::print_config(String[1] $name, Optional[Variant[Boolean, Integer, String, Array[String, 1]]] $value = undef, Optional[String[1]] $version = undef)`
+#### `unbound::print_config(String[1] $name, Optional[Variant[Boolean, Integer, String, Array[String]]] $value = undef, Optional[String[1]] $version = undef)`
 
 The unbound::print_config function.
 
@@ -2557,7 +2558,7 @@ the config item name
 
 ##### `value`
 
-Data type: `Optional[Variant[Boolean, Integer, String, Array[String, 1]]]`
+Data type: `Optional[Variant[Boolean, Integer, String, Array[String]]]`
 
 the config item value
 
@@ -2567,6 +2568,24 @@ Data type: `Optional[String[1]]`
 
 the version when the config item was introduced
 
+### <a name="unbound--split_txt"></a>`unbound::split_txt`
+
+Type: Puppet Language
+
+function to split TXT records. Long TXT records must be broken into strings of 255 characters as per RFC 4408
+
+#### `unbound::split_txt(String[1] $data)`
+
+The unbound::split_txt function.
+
+Returns: `String[1]` A string of 255 character strings
+
+##### `data`
+
+Data type: `String[1]`
+
+A TXT record to split
+
 ## Data types
 
 ### <a name="Unbound--Access_control"></a>`Unbound::Access_control`

functions/print_config.pp

@@ -5,13 +5,16 @@
 # @return the config item as a string or an empty string if the version is not supported
 function unbound::print_config (
   String[1]                                                     $name,
-  Optional[Variant[Boolean, Integer, String, Array[String, 1]]] $value   = undef,
+  Optional[Variant[Boolean, Integer, String, Array[String]]] $value   = undef,
   Optional[String[1]]                                           $version = undef,
 ) >> String {
   $unbound_version = $facts['unbound_version'].lest || { '0.a' }
   if ($value =~ Undef or ($version =~ NotUndef and versioncmp($unbound_version, $version) < 0)) {
     return ''
   }
+  if $value =~ Array and $value.empty {
+    return ''
+  }
   $value ? {
     String  => "  ${name}: \"${value}\"",
     Integer => "  ${name}: ${value}",

functions/split_txt.pp

@@ -0,0 +1,8 @@
+# @summary function to split TXT records. Long TXT records must be broken into strings of 255 characters as per RFC 4408
+# @param data A TXT record to split
+# @return A string of 255 character strings
+function unbound::split_txt(
+  String[1] $data
+) >> String[1] {
+  $data.slice(255).map |$slice| { "\"${slice.join}\"" }.join
+}

manifests/dnstap.pp

@@ -98,7 +98,7 @@
     concat::fragment { 'unbound-dnstap':
       order   => '20',
       target  => $unbound::config_file,
-      content => $config.split("\n").filter |$x| { !$x.empty }.join("\n"),
+      content => $config.extlib::remove_blank_lines(),
     }
   }
 }

manifests/forward.pp

@@ -28,9 +28,18 @@
   Pattern[/yes|no/] $forward_tls_upstream = 'no',
   $config_file                            = $unbound::config_file,
 ) {
+  $content = @("CONTENT")
+    forward-zone:
+    ${unbound::print_config('name', $zone)}
+    ${unbound::print_config('forward-addr', $address)}
+    ${unbound::print_config('forward-host', $host)}
+    ${unbound::print_config('forward-first', $forward_first)}
+    ${unbound::print_config('forward-ssl-upstream', $forward_ssl_upstream)}
+    ${unbound::print_config('forward-tls-upstream', $forward_tls_upstream)}
+    | CONTENT
   concat::fragment { "unbound-forward-${name}":
     order   => '20',
     target  => $config_file,
-    content => template('unbound/forward.erb'),
+    content => $content.extlib::remove_blank_lines(),
   }
 }

manifests/localzone.pp

@@ -26,15 +26,34 @@
 # @param template_name Use a custom template.
 #
 define unbound::localzone (
-  Unbound::Local_zone_type $type,
-  String $zone = $name,
-  $config_file = $unbound::config_file,
-  Array[Unbound::Resource_record_type] $local_data = [],
-  String $template_name = 'unbound/local_zone.erb'
+  Unbound::Local_zone_type             $type,
+  String                               $zone          = $name,
+  Stdlib::Absolutepath                 $config_file   = $unbound::config_file,
+  String                               $template_name = 'unbound/local_zone.erb',
+  Array[Unbound::Resource_record_type] $local_data    = [],
 ) {
+  # Loop through the local_data hash and create ablock of local-data strings with the correctly formated
+  # local-data lines which are ued in the final content block below.
+  # local-data: 'api.test.com 15 300 IN A 192.0.2.1
+  $records = $local_data.map |$record| {
+    $data = $record['data']
+    $_data = $record['type'] ? {
+      'TXT'   => $data.unbound::split_txt(),
+      default => $data,
+    }
+    $record_txt = "${record['name']} ${record['ttl']} ${record['class']} ${record['type']} ${_data}".regsubst(
+      /\s+/, ' ', 'G'
+    )  # Remove multiple spaces
+    "  local-data: '${record_txt}'"
+  }.join("\n")
+  $content = @("CONTENT")
+    server:
+      local-zone: "${zone}" ${type}
+    ${records}
+    | CONTENT
   concat::fragment { "unbound-localzone-${name}":
     order   => '06',
     target  => $config_file,
-    content => template($template_name),
+    content => $content,
   }
 }

manifests/remote.pp

@@ -50,10 +50,24 @@
   $config_file                        = $unbound::config_file,
   $control_setup_path                 = $unbound::control_setup_path,
 ) {
+  $_tls_config = @("CONFIG")
+      ${unbound::print_config('server-key-file', $server_key_file)}
+      ${unbound::print_config('server-cert-file', $server_cert_file)}
+      ${unbound::print_config('control-key-file', $control_key_file)}
+      ${unbound::print_config('control-cert-file', $control_cert_file)}
+    | CONFIG
+  $tls_config = $control_use_cert.bool2str($_tls_config, '')
+  $content = @("CONFIG")
+    remote-control:
+      ${unbound::print_config('control-enable', $enable)}
+      ${unbound::print_config('control-interface', $interface)}
+      ${unbound::print_config('control-port', $port)}
+    ${tls_config}
+    | CONFIG
   concat::fragment { 'unbound-remote':
     order   => '10',
     target  => $config_file,
-    content => template('unbound/remote.erb'),
+    content => $content.extlib::remove_blank_lines(),
   }
 
   unless $control_setup_path.empty {

manifests/stub.pp

@@ -20,7 +20,7 @@
 #   Controls 'stub-first' stub zone option.
 #   If true, a query that fails with the stub clause is attempted again
 #   without the stub clause.
-# @param type 
+# @param type
 #   can be 'deny', 'refuse', 'static', 'transparent', 'typetransparent', 'redirect' or 'nodefault'.
 # @param config_file Name of the unbound config file
 #
@@ -37,10 +37,18 @@
 ) {
   include unbound
   $_config_file = pick($config_file, $unbound::config_file)
+  $content = @("CONFIG")
+    stub-zone:
+    ${unbound::print_config('name', $name)}
+    ${unbound::print_config('stub-addr', $address)}
+    ${unbound::print_config('stub-host', $nameservers)}
+    ${unbound::print_config('stub-first', $stub_first)}
+    ${unbound::print_config('stub-no-cache', $no_cache)}
+    | CONFIG
   concat::fragment { "unbound-stub-${name}":
     order   => '15',
     target  => $_config_file,
-    content => template('unbound/stub.erb'),
+    content => $content.extlib::remove_blank_lines(),
   }
 
   if str2bool($insecure) == true {

metadata.json

@@ -1,4 +1,4 @@
 {
   "name": "puppet-unbound",
   "version": "7.0.1-rc0",
   "author": "Vox Pupuli",
@@ -123,6 +123,10 @@
     {
       "name": "puppet/systemd",
       "version_requirement": ">= 6.3.0 < 9.0.0"
+    },
+    {
+      "name": "puppet/extlib",
+      "version_requirement": ">= 7.4.0 < 8.0.0"
     }
   ]
 }

spec/classes/init_spec.rb

@@ -829,7 +829,14 @@
 
         it do
           expect(subject).to contain_concat__fragment('unbound-stub-example-stub.com').with_content(
-            %r{^stub-zone:\n  name: "example-stub.com"\n  stub-addr: 10.0.0.1\n  stub-addr: 10.0.0.2}
+            %r{
+              ^stub-zone:
+              \s+name:\s"example-stub.com"
+              \s+stub-addr:\s"10.0.0.1"
+              \s+stub-addr:\s"10.0.0.2"
+              \s+stub-first:\sno
+              \s+stub-no-cache:\sno
+            }x
           )
         end
       end
@@ -843,7 +850,15 @@
 
         it do
           expect(subject).to contain_concat__fragment('unbound-forward-example-forward.com').with_content(
-            %r{^forward-zone:\n  name: "example-forward.com"\n  forward-addr: 10.0.0.1\n  forward-addr: 10.0.0.2\n  forward-first: yes\n  forward-ssl-upstream: yes}
+            %r{
+              ^forward-zone:
+              \s+name:\s"example-forward.com"
+              \s+forward-addr:\s"10.0.0.1"
+              \s+forward-addr:\s"10.0.0.2"
+              \s+forward-first:\s"yes"
+              \s+forward-ssl-upstream:\s"yes"
+              \s+forward-tls-upstream:\s"no"
+            }x
           )
         end
       end
@@ -943,7 +958,7 @@
 
         it { is_expected.to contain_class('unbound::remote') }
 
         it do
           expect(subject).to contain_concat__fragment('unbound-remote').with_content(
             %r{^  control-enable: yes\n}
           )
@@ -980,7 +995,7 @@
 
         it { is_expected.to contain_class('unbound::remote') }
 
         it do
           expect(subject).to contain_concat__fragment('unbound-remote').with_content(
             %r{^  control-enable: yes\n}
           )

spec/classes/remote_spec.rb

@@ -29,13 +29,13 @@
             %r{
               ^remote-control:
               \s+control-enable:\sno
-              \s+control-interface:\s::1
-              \s+control-interface:\s127.0.0.1
+              \s+control-interface:\s"::1"
+              \s+control-interface:\s"127.0.0.1"
               \s+control-port:\s8953
-              \s+server-key-file:\s/etc/unbound/unbound_server.key
-              \s+server-cert-file:\s/etc/unbound/unbound_server.pem
-              \s+control-key-file:\s/etc/unbound/unbound_control.key
-              \s+control-cert-file:\s/etc/unbound/unbound_control.pem
+              \s+server-key-file:\s"/etc/unbound/unbound_server.key"
+              \s+server-cert-file:\s"/etc/unbound/unbound_server.pem"
+              \s+control-key-file:\s"/etc/unbound/unbound_control.key"
+              \s+control-cert-file:\s"/etc/unbound/unbound_control.pem"
             }x
           )
         end
@@ -62,7 +62,7 @@
 
         it do
           is_expected.to contain_concat__fragment('unbound-remote').with_content(
-            %r{control-interface:\s192.0.2.42}
+            %r{control-interface:\s"192.0.2.42"}
           )
         end
       end

spec/defines/stub_spec.rb

@@ -19,12 +19,14 @@
         it { is_expected.to compile.with_all_deps }
         it { is_expected.to contain_unbound__stub('lab.example.com') }
 
         it {
-          expect(subject).to contain_concat__fragment('unbound-stub-lab.example.com').with(
-            content: <<~ZONE
+          expect(subject).to contain_concat__fragment('unbound-stub-lab.example.com').with_content(
+            <<~ZONE
               stub-zone:
                 name: "lab.example.com"
-                stub-addr: ::1
+                stub-addr: "::1"
+                stub-first: no
+                stub-no-cache: no
             ZONE
           )
         }
@@ -41,14 +43,16 @@
         it { is_expected.to compile.with_all_deps }
         it { is_expected.to contain_unbound__stub('lab.example.com') }
 
         it {
-          expect(subject).to contain_concat__fragment('unbound-stub-lab.example.com').with(
-            content: <<~ZONE
+          expect(subject).to contain_concat__fragment('unbound-stub-lab.example.com').with_content(
+            <<~ZONE
               stub-zone:
                 name: "lab.example.com"
-                stub-addr: 10.0.0.10@10053
-                stub-host: ns1.example.com
-                stub-host: ns2.example.com
+                stub-addr: "10.0.0.10@10053"
+                stub-host: "ns1.example.com"
+                stub-host: "ns2.example.com"
+                stub-first: no
+                stub-no-cache: no
             ZONE
           )
         }
@@ -65,12 +69,13 @@
         it { is_expected.to compile.with_all_deps }
         it { is_expected.to contain_unbound__stub('lab.example.com') }
 
         it {
-          expect(subject).to contain_concat__fragment('unbound-stub-lab.example.com').with(
-            content: <<~ZONE
+          expect(subject).to contain_concat__fragment('unbound-stub-lab.example.com').with_content(
+            <<~ZONE
               stub-zone:
                 name: "lab.example.com"
-                stub-addr: ::1
+                stub-addr: "::1"
+                stub-first: no
                 stub-no-cache: yes
             ZONE
           )
@@ -88,13 +93,14 @@
         it { is_expected.to compile.with_all_deps }
         it { is_expected.to contain_unbound__stub('lab.example.com') }
 
         it {
-          expect(subject).to contain_concat__fragment('unbound-stub-lab.example.com').with(
-            content: <<~ZONE
+          expect(subject).to contain_concat__fragment('unbound-stub-lab.example.com').with_content(
+            <<~ZONE
               stub-zone:
                 name: "lab.example.com"
-                stub-addr: ::1
+                stub-addr: "::1"
                 stub-first: yes
+                stub-no-cache: no
             ZONE
           )
         }
@@ -111,12 +117,13 @@
         it { is_expected.to compile.with_all_deps }
         it { is_expected.to contain_unbound__stub('lab.example.com') }
 
         it {
-          expect(subject).to contain_concat__fragment('unbound-stub-lab.example.com').with(
-            content: <<~ZONE
+          expect(subject).to contain_concat__fragment('unbound-stub-lab.example.com').with_content(
+            <<~ZONE
               stub-zone:
                 name: "lab.example.com"
-                stub-addr: ::1
+                stub-addr: "::1"
+                stub-first: no
                 stub-no-cache: yes
             ZONE
           )

spec/functions/split_txt_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+input = "Long TXT Record #{'X' * 255}"
+output = "\"Long TXT Record #{'X' * 239}\"\"#{'X' * 16}\""
+
+describe 'unbound::split_txt' do
+  it { is_expected.to run.with_params(input).and_return(output) }
+end