Merge pull request #20 from jps-help/templates

Switch to templates for db and lock files

Author: jps-help

CHANGELOG.md

@@ -1,6 +1,18 @@
 # Changelog
 
 All notable changes to this project will be documented in this file.
+## Release 0.2.2
+### Added
+- Declare support for Puppet 8
+- Declare support for Ubuntu 24.04
+- Add templates for db and locks files
+- Add commented headers for managed files
+### Changed
+- Use templates for db and locks files instead of inifile
+- Update spec tests for db and lock file generation
+### Removed
+- Remove dependency on puppetlabs-inifile
+
 ## Release 0.2.1
 ### Added
 - Ensure `/etc/dconf` directory

README.md

@@ -157,9 +157,7 @@ dconf::dbs:
     locks: []
 ```
 ## Limitations
-
-This module only ensures the specified settings are present in your dconf keyfiles. Unmanaged INI settings in your keyfiles will not be automatically removed.
-This is a limitation of the `puppetlabs/inifile` module used to generate the dconf keyfiles.
+No known limitations
 
 ## Development
 

REFERENCE.md

@@ -167,7 +167,6 @@ The following parameters are available in the `dconf::db` defined type:
 * [`locks_file_mode`](#-dconf--db--locks_file_mode)
 * [`purge`](#-dconf--db--purge)
 * [`ensure`](#-dconf--db--ensure)
-* [`inifile_defaults`](#-dconf--db--inifile_defaults)
 
 ##### <a name="-dconf--db--settings"></a>`settings`
 
@@ -281,14 +280,6 @@ Whether to ensure presence or absence of the resource
 
 Default value: `'present'`
 
-##### <a name="-dconf--db--inifile_defaults"></a>`inifile_defaults`
-
-Data type: `Hash`
-
-Default parameters to parse to inifile provider
-
-Default value: `{ ensure => 'present', path => $db_file, notify => Exec['dconf_update'], require => File[$db_file], }`
-
 ### <a name="dconf--profile"></a>`dconf::profile`
 
 Create dconf profiles

manifests/db.pp

@@ -74,8 +74,6 @@
 #
 # @param ensure Whether to ensure presence or absence of the resource
 #
-# @param inifile_defaults Default parameters to parse to inifile provider
-#
 define dconf::db (
   Optional[Hash] $settings = undef,
   Optional[Array] $locks = undef,
@@ -91,7 +89,6 @@
   String $locks_file_mode = '0644',
   Boolean $purge = true,
   Enum['present','absent'] $ensure = 'present',
-  Hash $inifile_defaults = { ensure => 'present', path => $db_file, notify => Exec['dconf_update'], require => File[$db_file], },
 ) {
   case $ensure {
     'present': {
@@ -102,23 +99,17 @@
           recurse => $purge,
           force   => $purge,
       })
+      $_db_file_header = epp('dconf/header.epp')
+      $_db_file_body = epp('dconf/db.epp', {
+          'settings' => $settings
+        }
+      )
       file { $db_file:
         ensure  => 'file',
         mode    => $db_file_mode,
+        content => "${_db_file_header}${_db_file_body}",
         require => File[$db_dir],
-      }
-      if $settings {
-        $settings.each |String $section, Hash $key_vals| {
-          $key_vals.each |String $setting, $value| {
-            ini_setting { "db_${name}_settings_${section}_${setting}":
-              path    => $db_file,
-              section => $section,
-              setting => $setting,
-              value   => $value,
-              notify  => Exec['dconf_update'],
-            }
-          }
-        }
+        notify  => Exec['dconf_update'],
       }
       if $locks {
         ensure_resource(file, $locks_dir, {
@@ -127,19 +118,18 @@
             purge   => $purge,
             recurse => $purge,
         })
-        concat { "db_${name}_locks":
+        $_locks_file_header = epp('dconf/header.epp')
+        $_locks_file_body = epp('dconf/locks.epp', {
+            'locks' => $locks
+          }
+        )
+        file { "db_${name}_locks":
+          ensure  => $ensure,
           path    => $locks_file,
           mode    => $locks_file_mode,
-          order   => 'alpha',
+          content => "${_locks_file_header}${_locks_file_body}",
           require => File[$locks_dir],
-        }
-        $locks.each |$lock| {
-          concat::fragment { "db_${name}_locks_${lock}":
-            target  => $locks_file,
-            content => "${lock}\n",
-            require => Concat["db_${name}_locks"],
-            notify  => Exec['dconf_update'],
-          }
+          notify  => Exec['dconf_update'],
         }
       }
     }

metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "jmckenzie-dconf",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "author": "James McKenzie",
   "summary": "Install and configure dconf",
   "license": "Apache-2.0",
@@ -9,10 +9,6 @@
   "source": "git://github.com/jps-help/dconf.git",
   "tags": ["dconf","gnome","gdm"],
   "dependencies": [
-    {
-      "name": "puppetlabs/inifile",
-      "version_requirement": ">= 4.2.0 < 7.0.0"
-    },
     {
       "name": "puppetlabs/concat",
       "version_requirement": ">= 4.1.0 < 10.0.0"
@@ -58,14 +54,15 @@
       "operatingsystemrelease": [
         "18.04",
         "20.04",
-        "22.04"
+        "22.04",
+        "24.04"
       ]
     }
   ],
   "requirements": [
     {
       "name": "puppet",
-      "version_requirement": ">= 6.21.0 < 8.0.0"
+      "version_requirement": ">= 6.21.0 < 9.0.0"
     }
   ],
   "pdk-version": "2.7.1",

spec/defines/db_spec.rb

@@ -22,34 +22,24 @@
 
       it { is_expected.to compile }
       it { is_expected.to contain_file("/etc/dconf/db/#{title}.d").with_ensure('directory') }
-      it { is_expected.to contain_file("/etc/dconf/db/#{title}.d/00-default").with_ensure('file') }
-      it {
-        params['settings'].each do |section, key_vals|
-          key_vals.each do |setting, _value|
-            is_expected.to contain_ini_setting("db_#{title}_settings_#{section}_#{setting}").with_notify('Exec[dconf_update]')
-          end
-        end
-      }
+      it { is_expected.to contain_file("/etc/dconf/db/#{title}.d/00-default").with_ensure('file').with_content(%r{[system/proxy/http]}) }
+      it { is_expected.to contain_file("/etc/dconf/db/#{title}.d/00-default").with_ensure('file').with_content(%r{host = '172.16.0.1'}) }
+      it { is_expected.to contain_file("/etc/dconf/db/#{title}.d/00-default").with_ensure('file').with_content(%r{enabled = true}) }
 
       context 'with locks' do
         let(:params) do
           super().merge(
             {
               'locks' => [
-                'system/proxy/http/host',
-                'system/proxy/http/enabled',
+                '/system/proxy/http/host',
+                '/system/proxy/http/enabled',
               ],
             },
           )
         end
 
         it { is_expected.to contain_file("/etc/dconf/db/#{title}.d/locks").with_ensure('directory') }
-        it { is_expected.to contain_concat("db_#{title}_locks").with_ensure('present') }
-        it {
-          params['locks'].each do |lock|
-            is_expected.to contain_concat__fragment("db_#{title}_locks_#{lock}").with_notify('Exec[dconf_update]')
-          end
-        }
+        it { is_expected.to contain_file("db_#{title}_locks").with_ensure('present').with_content(%r{/system/proxy/http/host\n/system/proxy/http/enabled}) }
 
         context 'with purge' do
           let(:params) do

templates/db.epp

@@ -0,0 +1,6 @@
+<% | Hash $settings | -%>
+<% $settings.each |String $section, Hash $key_vals| { -%>
+[<%= $section %>]
+<% $key_vals.each |String $key, $value| { -%>
+<%= $key %> = <%= $value %>
+<% }} -%>

templates/header.epp

@@ -0,0 +1 @@
+# This file is managed by Puppet. DO NOT EDIT.

templates/locks.epp

@@ -0,0 +1,4 @@
+<% | Array[String] $locks | -%>
+<% $locks.each | String $lock | { -%>
+<%= $lock %>
+<% } -%>