Skip to content

apt: Add proxy support on the class. #446

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 27, 2015
Merged

apt: Add proxy support on the class. #446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b53ea1b
spec/(apt|ppa): Enough with all the strings.
daenney Feb 27, 2015
d81c3d9
apt: Add proxy support on the class.
daenney Feb 27, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions manifests/init.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
#
class apt(
$proxy = {},
$always_apt_update = false,
$apt_update_frequency = 'reluctantly',
$purge_sources_list = false,
Expand All @@ -19,6 +20,28 @@
validate_bool($purge_sources_list, $purge_sources_list_d,
$purge_preferences, $purge_preferences_d)

validate_hash($proxy)
if $proxy['host'] {
validate_string($proxy['host'])
}
if $proxy['port'] {
unless is_integer($proxy['port']) {
fail('$proxy port must be an integer')
}
}
if $proxy['https'] {
validate_bool($proxy['https'])
}
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once we can use the type system we'll be able to simply do all this validation with a Struct declaration. How I long for that day...


$_proxy = merge($apt::proxy_defaults, $proxy)

if $proxy['host'] {
apt::setting { 'conf-proxy':
priority => '01',
content => template('apt/_header.erb', 'apt/proxy.erb'),
}
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this apt::setting needs to be wrapped in an if $proxy['host'], otherwise you're going to end up with a really funny file

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very good point, derp derp derp.


$sources_list_content = $purge_sources_list ? {
false => undef,
true => "# Repos managed by puppet.\n",
Expand Down
7 changes: 4 additions & 3 deletions manifests/params.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@
}
}

$proxy = {
'host' => undef,
'port' => 8080,
$proxy_defaults = {
'host' => undef,
'port' => 8080,
'https' => false,
}

$file_defaults = {
Expand Down
17 changes: 8 additions & 9 deletions manifests/ppa.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
$options = $::apt::ppa_options,
$package_name = $::apt::ppa_package,
$package_manage = false,
$proxy = {},
) {
if ! $release {
fail('lsbdistcodename fact not available: release parameter required')
Expand All @@ -20,8 +19,6 @@
$filename_without_ppa = regsubst($filename_without_dots, '^ppa:', '', 'G')
$sources_list_d_filename = "${filename_without_ppa}-${release}.list"

$_proxy = merge($apt::proxy, $proxy)

if $ensure == 'present' {
if $package_manage {
package { $package_name: }
Expand All @@ -31,13 +28,15 @@
$_require = File['sources.list.d']
}

case $_proxy['host'] {
false, '', undef: {
$_proxy_env = []
}
default: {
$_proxy_env = ["http_proxy=http://${_proxy['host']}:${_proxy['port']}", "https_proxy=http://${_proxy['host']}:${_proxy['port']}"]
$_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']}"]
} else {
$_proxy_env = ["http_proxy=http://${_proxy['host']}:${_proxy['port']}"]
}
} else {
$_proxy_env = []
}

exec { "add-apt-repository-${name}":
Expand Down
118 changes: 77 additions & 41 deletions spec/classes/apt_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,49 +1,85 @@
require 'spec_helper'
describe 'apt', :type => :class do
describe 'apt' do
let(:facts) { { :lsbdistid => 'Debian', :osfamily => 'Debian' } }

context 'defaults' do
it { is_expected.to contain_file('sources.list').that_notifies('Exec[apt_update]').only_with({
'ensure' => 'present',
'path' => '/etc/apt/sources.list',
'owner' => 'root',
'group' => 'root',
'mode' => '0644',
'notify' => 'Exec[apt_update]',
:ensure => 'present',
:path => '/etc/apt/sources.list',
:owner => 'root',
:group => 'root',
:mode => '0644',
:notify => 'Exec[apt_update]',
})}

it { is_expected.to contain_file('sources.list.d').that_notifies('Exec[apt_update]').only_with({
'ensure' => 'directory',
'path' => '/etc/apt/sources.list.d',
'owner' => 'root',
'group' => 'root',
'purge' => false,
'recurse' => false,
'notify' => 'Exec[apt_update]',
:ensure => 'directory',
:path => '/etc/apt/sources.list.d',
:owner => 'root',
:group => 'root',
:purge => false,
:recurse => false,
:notify => 'Exec[apt_update]',
})}

it { is_expected.to contain_file('preferences.d').only_with({
'ensure' => 'directory',
'path' => '/etc/apt/preferences.d',
'owner' => 'root',
'group' => 'root',
'purge' => false,
'recurse' => false,
:ensure => 'directory',
:path => '/etc/apt/preferences.d',
:owner => 'root',
:group => 'root',
:purge => false,
:recurse => false,
})}

it 'should lay down /etc/apt/apt.conf.d/15update-stamp' do
is_expected.to contain_file('/etc/apt/apt.conf.d/15update-stamp').with({
'group' => 'root',
'mode' => '0644',
'owner' => 'root',
:group => 'root',
:mode => '0644',
:owner => 'root',
}).with_content(/APT::Update::Post-Invoke-Success \{"touch \/var\/lib\/apt\/periodic\/update-success-stamp 2>\/dev\/null \|\| true";\};/)
end

it { is_expected.to contain_exec('apt_update').with({
'refreshonly' => 'true',
:refreshonly => 'true',
})}

it { is_expected.not_to contain_apt__setting('conf-proxy') }
end

describe 'proxy=' do
context 'host=localhost' do
let(:params) { { :proxy => { 'host' => 'localhost'} } }
it { is_expected.to contain_apt__setting('conf-proxy').with({
:priority => '01',
}).with_content(
/Acquire::http::proxy "http:\/\/localhost:8080\/";/
).without_content(
/Acquire::https::proxy/
)}
end

context 'host=localhost and port=8180' do
let(:params) { { :proxy => { 'host' => 'localhost', 'port' => 8180} } }
it { is_expected.to contain_apt__setting('conf-proxy').with({
:priority => '01',
}).with_content(
/Acquire::http::proxy "http:\/\/localhost:8180\/";/
).without_content(
/Acquire::https::proxy/
)}
end

context 'host=localhost and https=true' do
let(:params) { { :proxy => { 'host' => 'localhost', 'https' => true} } }
it { is_expected.to contain_apt__setting('conf-proxy').with({
:priority => '01',
}).with_content(
/Acquire::http::proxy "http:\/\/localhost:8080\/";/
).with_content(
/Acquire::https::proxy "https:\/\/localhost:8080\/";/
)}
end
end
context 'lots of non-defaults' do
let :params do
{
Expand All @@ -58,28 +94,28 @@
end

it { is_expected.to contain_file('sources.list').with({
'content' => "# Repos managed by puppet.\n"
:content => "# Repos managed by puppet.\n"
})}

it { is_expected.to contain_file('sources.list.d').with({
'purge' => 'true',
'recurse' => 'true',
:purge => 'true',
:recurse => 'true',
})}

it { is_expected.to contain_file('apt-preferences').only_with({
'ensure' => 'absent',
'path' => '/etc/apt/preferences',
:ensure => 'absent',
:path => '/etc/apt/preferences',
})}

it { is_expected.to contain_file('preferences.d').with({
'purge' => 'true',
'recurse' => 'true',
:purge => 'true',
:recurse => 'true',
})}

it { is_expected.to contain_exec('apt_update').with({
'refreshonly' => 'false',
'timeout' => '1',
'tries' => '3',
:refreshonly => 'false',
:timeout => '1',
:tries => '3',
})}

end
Expand All @@ -99,7 +135,7 @@
'key' => '55BE302B',
'key_server' => 'subkeys.pgp.net',
'pin' => '-10',
'include_src' => true
'include_src' => true,
},
'puppetlabs' => {
'location' => 'http://apt.puppetlabs.com',
Expand All @@ -111,7 +147,7 @@

it {
is_expected.to contain_apt__setting('list-debian_unstable').with({
'ensure' => 'present',
:ensure => 'present',
})
}

Expand All @@ -120,7 +156,7 @@

it {
is_expected.to contain_apt__setting('list-puppetlabs').with({
'ensure' => 'present',
:ensure => 'present',
})
}

Expand All @@ -131,7 +167,7 @@
context 'bad purge_sources_list' do
let :params do
{
'purge_sources_list' => 'foo'
:purge_sources_list => 'foo'
}
end
it do
Expand All @@ -144,7 +180,7 @@
context 'bad purge_sources_list_d' do
let :params do
{
'purge_sources_list_d' => 'foo'
:purge_sources_list_d => 'foo'
}
end
it do
Expand All @@ -157,7 +193,7 @@
context 'bad purge_preferences' do
let :params do
{
'purge_preferences' => 'foo'
:purge_preferences => 'foo'
}
end
it do
Expand All @@ -170,7 +206,7 @@
context 'bad purge_preferences_d' do
let :params do
{
'purge_preferences_d' => 'foo'
:purge_preferences_d => 'foo'
}
end
it do
Expand Down
Loading