Merge pull request #869 from lelutin/purge_apt_conf

implement apt.conf.d purging
puppetlabs · Aug 12, 2019 · bfab353 · bfab353
2 parents 8b5051c + 84be3a6
commit bfab353
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -36,10 +36,11 @@ APT is a package manager available on Debian, Ubuntu, and several other operatin
 
 * Your system's `preferences` file and `preferences.d` directory
 * Your system's `sources.list` file and `sources.list.d` directory
+* Your system's `apt.conf.d` directory
 * System repositories
 * Authentication keys
 
-**Note:** This module offers `purge` parameters which, if set to `true`, **destroy** any configuration on the node's `sources.list(.d)` and `preferences(.d)` that you haven't declared through Puppet. The default for these parameters is `false`.
+**Note:** This module offers `purge` parameters which, if set to `true`, **destroy** any configuration on the node's `sources.list(.d)`, `preferences(.d)` and `apt.conf.d` that you haven't declared through Puppet. The default for these parameters is `false`.
 
 <a id="beginning-with-apt"></a>
 ### Beginning with apt

diff --git a/manifests/init.pp b/manifests/init.pp
@@ -144,6 +144,7 @@
   String $conf_d                = $apt::params::conf_d,
   String $preferences           = $apt::params::preferences,
   String $preferences_d         = $apt::params::preferences_d,
+  String $apt_conf_d            = $apt::params::apt_conf_d,
   Hash $config_files            = $apt::params::config_files,
   Hash $source_key_defaults     = $apt::params::source_key_defaults,
 ) inherits apt::params {
@@ -180,6 +181,9 @@
   if $purge['preferences.d'] {
     assert_type(Boolean, $purge['preferences.d'])
   }
+  if $purge['apt.conf.d'] {
+    assert_type(Boolean, $purge['apt.conf.d'])
+  }
 
   $_purge = merge($::apt::purge_defaults, $purge)
   $_proxy = merge($apt::proxy_defaults, $proxy)
@@ -258,6 +262,17 @@
     notify  => Class['apt::update'],
   }
 
+  file { 'apt.conf.d':
+    ensure  => directory,
+    path    => $::apt::apt_conf_d,
+    owner   => root,
+    group   => root,
+    mode    => '0644',
+    purge   => $_purge['apt.conf.d'],
+    recurse => $_purge['apt.conf.d'],
+    notify  => Class['apt::update'],
+  }
+
   if $confs {
     create_resources('apt::conf', $confs)
   }

diff --git a/manifests/params.pp b/manifests/params.pp
@@ -16,6 +16,7 @@
   $conf_d         = "${root}/apt.conf.d"
   $preferences    = "${root}/preferences"
   $preferences_d  = "${root}/preferences.d"
+  $apt_conf_d     = "${root}/apt.conf.d"
   $keyserver      = 'keyserver.ubuntu.com'
   $confs          = {}
   $update         = {}
@@ -64,6 +65,7 @@
     'sources.list.d' => false,
     'preferences'    => false,
     'preferences.d'  => false,
+    'apt.conf.d'     => false,
   }
 
   $source_key_defaults = {

diff --git a/spec/acceptance/apt_spec.rb b/spec/acceptance/apt_spec.rb
@@ -23,6 +23,7 @@ class { 'apt':
           'sources.list.d' => true,
           'preferences'    => true,
           'preferences.d'  => true,
+          'apt.conf.d'     => true,
         },
         sources => $sources,
       }

diff --git a/spec/classes/apt_spec.rb b/spec/classes/apt_spec.rb
@@ -32,6 +32,15 @@
                   recurse: false,
                   notify: 'Class[Apt::Update]' }
 
+apt_conf_d = {    ensure: 'directory',
+                  path: '/etc/apt/apt.conf.d',
+                  owner: 'root',
+                  group: 'root',
+                  mode: '0644',
+                  purge: false,
+                  recurse: false,
+                  notify: 'Class[Apt::Update]' }
+
 describe 'apt' do
   let(:facts) do
     {
@@ -59,6 +68,10 @@
       is_expected.to contain_file('preferences.d').that_notifies('Class[Apt::Update]').only_with(preferences_d)
     }
 
+    it {
+      is_expected.to contain_file('apt.conf.d').that_notifies('Class[Apt::Update]').only_with(apt_conf_d)
+    }
+
     it { is_expected.to contain_file('/etc/apt/auth.conf').with_ensure('absent') }
 
     it 'lays down /etc/apt/apt.conf.d/15update-stamp' do
@@ -158,7 +171,8 @@
       {
         update: { 'frequency' => 'always', 'timeout' => 1, 'tries' => 3 },
         purge: { 'sources.list' => false, 'sources.list.d' => false,
-                 'preferences' => false, 'preferences.d' => false },
+                 'preferences' => false, 'preferences.d' => false,
+                 'apt.conf.d' => false },
       }
     end
 
@@ -180,6 +194,11 @@
                                                         recurse: false)
     }
 
+    it {
+      is_expected.to contain_file('apt.conf.d').with(purge: false,
+                                                     recurse: false)
+    }
+
     it {
       is_expected.to contain_exec('apt_update').with(refreshonly: false,
                                                      timeout: 1,
@@ -509,5 +528,13 @@
         is_expected.to raise_error(Puppet::Error)
       end
     end
+
+    context "with purge['apt.conf.d']=>'banana'" do
+      let(:params) { { purge: { 'apt.conf.d' => 'banana' } } }
+
+      it do
+        is_expected.to raise_error(Puppet::Error)
+      end
+    end
   end
 end