-# ppa.pp
-define apt::ppa(
- String $ensure = 'present',
- Optional[String] $options = $::apt::ppa_options,
- Optional[String] $release = $facts['lsbdistcodename'],
- Optional[String] $package_name = $::apt::ppa_package,
- Boolean $package_manage = false,
+# @summary Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
+#
+# @example Example declaration of an Apt PPA
+# apt::ppa{ 'ppa:openstack-ppa/bleeding-edge': }
+#
+# @param ensure
+# Specifies whether the PPA should exist. Valid options: 'present' and 'absent'.
+#
+# @param options
+# Supplies options to be passed to the `add-apt-repository` command. Default: '-y'.
+#
+# @param release
+# Specifies the operating system of your node. Valid options: a string containing a valid LSB distribution codename.
+# Optional if `puppet facts show os.distro.codename` returns your correct distribution release codename.
+#
+# @param dist
+# Specifies the distribution of your node. Valid options: a string containing a valid distribution codename.
+# Optional if `puppet facts show os.name` returns your correct distribution name.
+#
+# @param package_name
+# Names the package that provides the `apt-add-repository` command. Default: 'software-properties-common'.
+#
+# @param package_manage
+# Specifies whether Puppet should manage the package that provides `apt-add-repository`.
+#
+define apt::ppa (
+ String $ensure = 'present',
+ Optional[Array[String]] $options = $apt::ppa_options,
+ Optional[String] $release = fact('os.distro.codename'),
+ Optional[String] $dist = $facts['os']['name'],
+ Optional[String] $package_name = $apt::ppa_package,
+ Boolean $package_manage = false,
) {
unless $release {
- fail('lsbdistcodename fact not available: release parameter required')
+ fail('os.distro.codename fact not available: release parameter required')
}
- if $facts['lsbdistid'] == 'Debian' {
+ if $dist == 'Debian' {
fail('apt::ppa is not currently supported on Debian.')
}
- if versioncmp($facts['lsbdistrelease'], '15.10') >= 0 {
- $distid = downcase($facts['lsbdistid'])
- $filename = regsubst($name, '^ppa:([^/]+)/(.+)$', "\\1-${distid}-\\2-${release}")
+ # Validate the resource name
+ if $name !~ /^ppa:([a-zA-Z0-9\-_.]+)\/([a-zA-z0-9\-_\.]+)$/ {
+ fail("Invalid PPA name: ${name}")
+ }
+
+ if versioncmp($facts['os']['release']['full'], '14.10') >= 0 {
+ $distid = downcase($dist)
+ $dash_filename = regsubst($name, '^ppa:([^/]+)/(.+)$', "\\1-${distid}-\\2")
+ $underscore_filename = regsubst($name, '^ppa:([^/]+)/(.+)$', "\\1_${distid}_\\2")
} else {
- $filename = regsubst($name, '^ppa:([^/]+)/(.+)$', "\\1-\\2-${release}")
+ $dash_filename = regsubst($name, '^ppa:([^/]+)/(.+)$', "\\1-\\2")
+ $underscore_filename = regsubst($name, '^ppa:([^/]+)/(.+)$', "\\1_\\2")
}
- $filename_no_slashes = regsubst($filename, '/', '-', 'G')
- $filename_no_specialchars = regsubst($filename_no_slashes, '[\.\+]', '_', 'G')
- $sources_list_d_filename = "${filename_no_specialchars}.list"
+ $dash_filename_no_slashes = regsubst($dash_filename, '/', '-', 'G')
+ $dash_filename_no_specialchars = regsubst($dash_filename_no_slashes, '[\.\+]', '_', 'G')
+ $underscore_filename_no_slashes = regsubst($underscore_filename, '/', '-', 'G')
+ $underscore_filename_no_specialchars = regsubst($underscore_filename_no_slashes, '[\.\+]', '_', 'G')
- $name_no_slashes = regsubst($name, '/', '-', 'G')
- $name_no_specialchars = regsubst($name_no_slashes, '[\.\+]', '_', 'G')
- $trusted_gpg_d_filename = regsubst($name_no_specialchars, '^ppa:(.+)', "\\1.gpg")
+ $sources_list_d_filename = "${dash_filename_no_specialchars}-${release}.list"
+
+ if versioncmp($facts['os']['release']['full'], '15.10') >= 0 and
+ versioncmp($facts['os']['release']['full'], '21.04') < 0 {
+ $trusted_gpg_d_filename = "${underscore_filename_no_specialchars}.gpg"
+ } else {
+ $trusted_gpg_d_filename = "${dash_filename_no_specialchars}.gpg"
+ }
+
+ # This is the location of our main exec script.
+ $cache_path = $facts['puppet_vardir']
+ $script_path = "${cache_path}/add-apt-repository-${dash_filename_no_specialchars}-${release}.sh"
if $ensure == 'present' {
if $package_manage {
$_require = File['sources.list.d']
}
- $_proxy = $::apt::_proxy
+ $_proxy = $apt::_proxy
if $_proxy['host'] {
if $_proxy['https'] {
$_proxy_env = ["http_proxy=http://${$_proxy['host']}:${$_proxy['port']}", "https_proxy=https://${$_proxy['host']}:${$_proxy['port']}"]
$_proxy_env = []
}
- exec { "add-apt-repository-${name}":
- environment => $_proxy_env,
- command => "/usr/bin/add-apt-repository ${options} ${name}",
- unless => "/usr/bin/test -f ${::apt::sources_list_d}/${sources_list_d_filename} && /usr/bin/test -f ${::apt::trusted_gpg_d}/${trusted_gpg_d_filename}",
- user => 'root',
- logoutput => 'on_failure',
- notify => Class['apt::update'],
- require => $_require,
- }
+ unless $sources_list_d_filename in $facts['apt_sources'] {
+ $script_content = epp('apt/add-apt-repository.sh.epp', {
+ command => ['/usr/bin/add-apt-repository', shell_join($options), $name],
+ sources_list_d_path => $apt::sources_list_d,
+ sources_list_d_filename => $sources_list_d_filename,
+ }
+ )
- file { "${::apt::sources_list_d}/${sources_list_d_filename}":
- ensure => file,
- require => Exec["add-apt-repository-${name}"],
+ file { "add-apt-repository-script-${name}":
+ ensure => 'file',
+ path => $script_path,
+ content => $script_content,
+ mode => '0755',
+ }
+
+ exec { "add-apt-repository-${name}":
+ environment => $_proxy_env,
+ command => $script_path,
+ logoutput => 'on_failure',
+ notify => Class['apt::update'],
+ require => $_require,
+ before => File["${apt::sources_list_d}/${sources_list_d_filename}"],
+ }
}
+
+ file { "${apt::sources_list_d}/${sources_list_d_filename}": }
}
else {
- file { "${::apt::sources_list_d}/${sources_list_d_filename}":
- ensure => 'absent',
+ tidy { "remove-apt-repository-script-${name}":
+ path => $script_path,
+ }
+
+ tidy { "remove-apt-repository-${name}":
+ path => "${apt::sources_list_d}/${sources_list_d_filename}",
notify => Class['apt::update'],
}
}
Code Review / puppet-modules / puppetlabs-apt.git / blobdiff