Merge pull request #418 from cmurphy/rspec
[puppet-modules/puppetlabs-apt.git] / manifests / init.pp
index 2de6aa056ff24740e7588146251e95665643c1ef..d64b013accbbaa3e1bb1ba3f34e17672ce798cc3 100644 (file)
@@ -1,39 +1,78 @@
-# Class: apt
+# == Class: apt
 #
 # This module manages the initial configuration of apt.
 #
-# Parameters:
-#   The parameters listed here are not required in general and were
-#     added for use cases related to development environments.
-#   disable_keys - disables the requirement for all packages to be signed
-#   always_apt_update - rather apt should be updated on every run (intended
-#     for development environments where package updates are frequent)
-#   purge_sources_list - Accepts true or false. Defaults to false If set to
-#     true, Puppet will purge all unmanaged entries from sources.list
-#   purge_sources_list_d - Accepts true or false. Defaults to false. If set
-#     to true, Puppet will purge all unmanaged entries from sources.list.d
-#   update_timeout - Overrides the exec timeout in seconds for apt-get update.
-#     If not set defaults to Exec's default (300)
+# The parameters listed here are not required in general and were
+# added for use cases related to development environments.
 #
-# Actions:
+# === Parameters
+#
+# [*disable_keys*]
+#   Disables the requirement for all packages to be signed
+#
+# [*always_apt_update*]
+#   Rather apt should be updated on every run (intended
+#   for development environments where package updates are frequent)
+#
+# [*apt_update_frequency*]
+#   String: Supported values:
+#   **always**: Will fire `apt-get update` at every puppet run. Intended to
+#       deprecate the `always_apt_update` parameter.
+#   *daily**: Trigger `apt-get update` if the value of the fact
+#       `apt_update_last_success` is less than current epoch time - 86400.
+#        *notifying the apt_update exec will trigger apt-get update regardless*
+#   *weekly**: Trigger `apt-get update` if the value of the fact
+#       `apt_update_last_success` is less than current epoch time - 604800.
+#        *notifying the apt_update exec will trigger apt-get update regardless*
+#   *reluctantly**: *Default* only run apt-get update if the exec resource `apt_update` is notified.
+#
+# [*purge_sources_list*]
+#   Accepts true or false. Defaults to false If set to
+#   true, Puppet will purge all unmanaged entries from sources.list
+#
+# [*purge_sources_list_d*]
+#   Accepts true or false. Defaults to false. If set
+#   to true, Puppet will purge all unmanaged entries from sources.list.d
+#
+# [*update_timeout*]
+#   Overrides the exec timeout in seconds for apt-get update.
+#   If not set defaults to Exec's default (300)
+#
+# [*update_tries*]
+#   Number of times that `apt-get update` will be tried. Use this
+#   to work around transient DNS and HTTP errors. By default, the command
+#   will only be run once.
+#
+# === Examples
+#
+# class { 'apt': }
+#
+# === Requires
+#
+# puppetlabs/stdlib >= 2.2.1
 #
-# Requires:
-#   puppetlabs/stdlib
-# Sample Usage:
-#  class { 'apt': }
-
 class apt(
   $always_apt_update    = false,
+  $apt_update_frequency = 'reluctantly',
   $disable_keys         = undef,
-  $proxy_host           = false,
+  $proxy_host           = undef,
   $proxy_port           = '8080',
   $purge_sources_list   = false,
   $purge_sources_list_d = false,
   $purge_preferences    = false,
   $purge_preferences_d  = false,
-  $update_timeout       = undef
+  $update_timeout       = undef,
+  $update_tries         = undef,
+  $sources              = undef,
+  $fancy_progress       = undef
 ) {
 
+  if $::osfamily != 'Debian' {
+    fail('This module only works on Debian or derivatives like Ubuntu')
+  }
+
+  $frequency_options = ['always','daily','weekly','reluctantly']
+  validate_re($apt_update_frequency, $frequency_options)
   include apt::params
   include apt::update
 
@@ -45,19 +84,20 @@ class apt(
     true  => "# Repos managed by puppet.\n",
   }
 
-  $preferences_content = $purge_preferences ? {
-    false => undef,
-    true  => "Explanation: Preferences managed by Puppet\n
-Explanation: We need a bogus package line because of Debian Bug #732746\n
-Package: bogus-package\n",
-  }
-
   if $always_apt_update == true {
     Exec <| title=='apt_update' |> {
       refreshonly => false,
     }
   }
 
+  file { '/etc/apt/apt.conf.d/15update-stamp':
+    ensure  => 'file',
+    content => 'APT::Update::Post-Invoke-Success {"touch /var/lib/apt/periodic/update-success-stamp 2>/dev/null || true";};',
+    group   => 'root',
+    mode    => '0644',
+    owner   => 'root',
+  }
+
   $root           = $apt::params::root
   $apt_conf_d     = $apt::params::apt_conf_d
   $sources_list_d = $apt::params::sources_list_d
@@ -84,13 +124,11 @@ Package: bogus-package\n",
     notify  => Exec['apt_update'],
   }
 
-  file { 'apt-preferences':
-    ensure  => present,
-    path    => "${root}/preferences",
-    owner   => root,
-    group   => root,
-    mode    => '0644',
-    content => $preferences_content,
+  if $purge_preferences {
+    file { 'apt-preferences':
+      ensure => absent,
+      path   => "${root}/preferences",
+    }
   }
 
   file { 'preferences.d':
@@ -102,6 +140,24 @@ Package: bogus-package\n",
     recurse => $purge_preferences_d,
   }
 
+  case $fancy_progress {
+    true: {
+      file { '99progressbar':
+        ensure  => present,
+        content => 'Dpkg::Progress-Fancy "1";',
+        path    => "${apt_conf_d}/99progressbar",
+      }
+    }
+    false: {
+      file { '99progressbar':
+        ensure => absent,
+        path   => "${apt_conf_d}/99progressbar",
+      }
+    }
+    undef: {} # do nothing
+    default: { fail('Valid values for fancy_progress are true or false') }
+  }
+
   case $disable_keys {
     true: {
       file { '99unauth':
@@ -120,20 +176,41 @@ Package: bogus-package\n",
     default: { fail('Valid values for disable_keys are true or false') }
   }
 
-  $proxy_set = $proxy_host ? {
-    false   => absent,
-    default => present
+  case $proxy_host {
+    false, '', undef: {
+      file { '01proxy':
+        ensure => absent,
+        path   => "${apt_conf_d}/01proxy",
+        notify => Exec['apt_update'],
+      }
+    }
+    default: {
+      file { '01proxy':
+        ensure  => present,
+        path    => "${apt_conf_d}/01proxy",
+        content => "Acquire::http::Proxy \"http://${proxy_host}:${proxy_port}\";\n",
+        notify  => Exec['apt_update'],
+        mode    => '0644',
+        owner   => root,
+        group   => root,
+      }
+    }
   }
 
-  file { 'configure-apt-proxy':
-    ensure  => $proxy_set,
-    path    => "${apt_conf_d}/proxy",
-    content => "Acquire::http::Proxy \"http://${proxy_host}:${proxy_port}\";",
-    notify  => Exec['apt_update'],
+  file { 'old-proxy-file':
+    ensure => absent,
+    path   => "${apt_conf_d}/proxy",
+    notify => Exec['apt_update'],
   }
 
   # Need anchor to provide containment for dependencies.
   anchor { 'apt::update':
     require => Class['apt::update'],
   }
+
+  # manage sources if present
+  if $sources != undef {
+    validate_hash($sources)
+    create_resources('apt::source', $sources)
+  }
 }