Skip to content
This repository was archived by the owner on Jun 11, 2019. It is now read-only.

Tunnel enhancement #11

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Tunnel enhancement #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
352ba7f
Fix: openvpn group in tunnel template is not correct
lermit Dec 18, 2013
a2b19eb
Merge remote-tracking branch 'addonline/fix-tunnel-template' into tun…
lermit Dec 19, 2013
fe5dadd
Add: compress option
lermit Dec 19, 2013
360d7e6
Add: keepalive option
lermit Dec 19, 2013
212475d
Fix: Prevent carriage return
lermit Dec 19, 2013
00e7cd0
Fix test with 1.0 rspec-puppet version
lermit Dec 19, 2013
5f6c689
Fix test with 1.0 rspec-puppet version
lermit Dec 19, 2013
e6a497a
Fix: Double keepalive declaration
lermit Dec 19, 2013
089d5fa
Remove dupliacte tls-client
lermit Dec 19, 2013
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
43 changes: 31 additions & 12 deletions manifests/tunnel.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,19 @@
# [*push*]
# Push parameter
#
# [*compress*]
# Active comp-lzo (default false)
#
# [*keepalive]
# Active keepalive (default true).
# On client this parameter can be push by server
#
# [*keepalive_freq*]
# Keepalive test frequency (default 10s)
#
# [*keepalive_timeout*]
# Keepalive time before restart (default 60s)
#
# [*template*]
# Template to be used for the tunnel configuration.
# Default is openvpn/server.conf.erb
Expand All @@ -59,22 +72,28 @@
# }
#
define openvpn::tunnel (
$auth_type = 'tls-server',
$mode = 'server',
$remote = '',
$port = '1194',
$auth_key = '',
$proto = 'tcp',
$dev = 'tun',
$server = '10.8.0.0 255.255.255.0',
$route = '',
$push = '',
$template = '',
$enable = true ) {
$auth_type = 'tls-server',
$mode = 'server',
$remote = '',
$port = '1194',
$auth_key = '',
$proto = 'tcp',
$dev = 'tun',
$server = '10.8.0.0 255.255.255.0',
$route = '',
$push = '',
$template = '',
$compress = false,
$keepalive = true,
$keepalive_freq = "10",
$keepalive_timeout = "60",
$enable = true ) {

include openvpn

$bool_enable=any2bool($enable)
$bool_compress=any2bool($compress)
$bool_keepalive=any2bool($keepalive)

$manage_file = $bool_enable ? {
true => 'present',
Expand Down
27 changes: 10 additions & 17 deletions spec/classes/openvpn_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
describe 'Test decommissioning - absent' do
let(:params) { {:absent => true, :monitor => true , :firewall => true, :port => '42', :protocol => 'tcp'} }

it 'should remove Package[openvpn]' do should contain_package('openvpn').with_ensure('absent') end
it 'should remove Package[openvpn]' do should contain_package('openvpn').with_ensure('absent') end
it 'should stop Service[openvpn]' do should contain_service('openvpn').with_ensure('stopped') end
it 'should not enable at boot Service[openvpn]' do should contain_service('openvpn').with_enable('false') end
end
Expand All @@ -35,23 +35,21 @@

describe 'Test decommissioning - disableboot' do
let(:params) { {:disableboot => true, :monitor => true , :firewall => true, :port => '42', :protocol => 'tcp'} }

it { should contain_package('openvpn').with_ensure('present') }
it { should_not contain_service('openvpn').with_ensure('present') }
it { should_not contain_service('openvpn').with_ensure('absent') }
it 'should not enable at boot Service[openvpn]' do should contain_service('openvpn').with_enable('false') end
end
end

describe 'Test customizations - template' do
let(:params) { {:template => "openvpn/spec.erb" , :options => { 'opt_a' => 'value_a' } } }

it 'should generate a valid template' do
content = catalogue.resource('file', 'openvpn.conf').send(:parameters)[:content]
content.should match "fqdn: rspec.example42.com"
should contain_file('openvpn.conf').with_content(/fqdn: rspec\.example42\.com/)
end
it 'should generate a template that uses custom options' do
content = catalogue.resource('file', 'openvpn.conf').send(:parameters)[:content]
content.should match "value_a"
should contain_file('openvpn.conf').with_content(/value_a/)
end

end
Expand All @@ -60,16 +58,13 @@
let(:params) { {:source => "puppet://modules/openvpn/spec" , :source_dir => "puppet://modules/openvpn/dir/spec" , :source_dir_purge => true } }

it 'should request a valid source ' do
content = catalogue.resource('file', 'openvpn.conf').send(:parameters)[:source]
content.should == "puppet://modules/openvpn/spec"
should contain_file('openvpn.conf').with_source('puppet://modules/openvpn/spec')
end
it 'should request a valid source dir' do
content = catalogue.resource('file', 'openvpn.dir').send(:parameters)[:source]
content.should == "puppet://modules/openvpn/dir/spec"
should contain_file('openvpn.dir').with_source('puppet://modules/openvpn/dir/spec')
end
it 'should purge source dir if source_dir_purge is true' do
content = catalogue.resource('file', 'openvpn.dir').send(:parameters)[:purge]
content.should == true
should contain_file('openvpn.dir').with_purge(true)
end
end

Expand All @@ -82,17 +77,15 @@
let(:params) { {:service_autorestart => "no" , :source => 'real' } }

it 'should not automatically restart the service, when service_autorestart => false' do
content = catalogue.resource('file', 'openvpn.conf').send(:parameters)[:notify]
content.should be_nil
should contain_file('openvpn.conf').with_notify(nil)
end
end

describe 'Test Puppi Integration' do
let(:params) { {:puppi => true, :puppi_helper => "myhelper"} }

it 'should generate a puppi::ze define' do
content = catalogue.resource('puppi::ze', 'openvpn').send(:parameters)[:helper]
content.should == "myhelper"
should contain_puppi__ze('openvpn').with_helper('myhelper')
end
end

Expand Down
52 changes: 42 additions & 10 deletions spec/defines/openvpn_tunnel_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,40 +20,72 @@
should contain_file('openvpn_mytunnel.conf').with_ensure('present')
end
it 'should populate correctly the openvpn::tunnel configuration file' do
content = catalogue.resource('file', 'openvpn_mytunnel.conf').send(:parameters)[:content]
content.should match "secret /etc/openvpn/mytunnel.key "
should contain_file('openvpn_mytunnel.conf').with_content(/secret \/etc\/openvpn\/mytunnel\.key/)
end
it 'should create a key file when auth_key is provided' do
content = catalogue.resource('file', 'openvpn_mytunnel.key').send(:parameters)[:source]
content.should match "mykey"
should contain_file('openvpn_mytunnel.key').with_source(/mykey/)
end
end

describe 'Test many remote configuration' do
let(:params) { {
let(:params) { {
:name => 'mytunnel',
:mode => 'client',
:port => '1150',
:remote => ['vpn1.example42.com','vpn2.example42.com'],
} }
it { should contain_file('openvpn_mytunnel.conf').with_content(/remote vpn1.example42.com 1150\nremote vpn2.example42.com 1150/) }
end


describe 'Test Monitoring Tools Integration' do
let(:facts) { {:monitor => true, :monitor_tool => "puppi", :monitor_target => "2.2.2.2" } }

it 'should generate monitor defines' do
should contain_monitor__process('openvpn_mytunnel_process').with_tool('puppi')
end
end

describe 'Test client compress configuration' do
let(:params) { {
:name => 'mytunnel',
:mode => 'client',
:compress => true,
} }
it { should contain_file('openvpn_mytunnel.conf').with_content(/comp-lzo/) }
end

describe 'Test Monitoring Tools Integration' do
let(:facts) { {:monitor => true, :monitor_tool => "puppi", :monitor_target => "2.2.2.2" } }

it 'should generate monitor defines' do
should contain_monitor__process('openvpn_mytunnel_process').with_tool('puppi')
end
end

describe 'Test client keepalive configuration' do
let(:params) { {
:name => 'mytunnel',
:mode => 'client',
:keepalive => true,
:keepalive_freq => '42',
:keepalive_timeout => '4242',
} }
it { should contain_file('openvpn_mytunnel.conf').with_content(/keepalive 42 4242/) }
end

Copy link
Member

Choose a reason for hiding this comment

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

Tests are failing on Travis probably due to the usage of the new, 1.0, version of rspec-puppet which deprecates some usage patterns used in these testes (and most of all other example42 modules :-I ).
A note which may help(copied and pasted, so names and details may change):

it 'should generate a template that uses custom options' do
  content = catalogue.resource('file', 'squid.conf').send(:parameters)[:content]
  content.should match "value_a"
end

needs tobe changed to

should contain_file('file').with_content(/value_a/)

the syntax on "should match" fails

Would you be so kind to fix the failing tests too (with the latest version of rspec-puppet)? Would be much appreciated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok let's go !

describe 'Test Monitoring Tools Integration' do
let(:facts) { {:monitor => true, :monitor_tool => "puppi", :monitor_target => "2.2.2.2" } }

it 'should generate monitor defines' do
content = catalogue.resource('monitor::process', 'openvpn_mytunnel_process').send(:parameters)[:tool]
content.should == "puppi"
should contain_monitor__process('openvpn_mytunnel_process').with_tool('puppi')
end
end

describe 'Test Firewall Tools Integration' do
let(:facts) { {:firewall => true, :firewall_tool => "iptables" } }

it 'should generate correct firewall define' do
content = catalogue.resource('firewall', 'openvpn_mytunnel_tcp_1150').send(:parameters)[:tool]
content.should == "iptables"
should contain_firewall('openvpn_mytunnel_tcp_1150').with_tool('iptables')
end
end

Expand Down
11 changes: 7 additions & 4 deletions templates/client.conf.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,22 @@ tls-client
ca ca.crt
cert <%= @hostname %>.crt
key <%= @hostname %>.key
tls-client
pull
<% end -%>

ns-cert-type server
verb 3
;mute 20
user <%= scope.lookupvar("openvpn::process_user") %>
group <%= scope.lookupvar("openvpn::process_user") %>
group <%= scope.lookupvar("openvpn::process_group") %>

keepalive 10 60
<% if @bool_compress -%>
comp-lzo
<% end -%>
<% if @bool_keepalive -%>
keepalive <%= @keepalive_freq %> <%= @keepalive_timeout %>
<% end -%>
inactive 0
# cipher x
# comp-lzo # Compress data
# client-connect /etc/openvpn/script/client_connect
# client-disconnect /etc/openvpn/script/client_disconnect