Skip to content

Commit e8efe7e

Browse files
ekohlekohl
committed
Add a socket_service definition
For systemd socket activated services it's needed to have both the .socket and .service unit defintions in place when starting the service. Prior to 97dd16f the systemctl daemon-reload took care of it, but now this must be done explicitly. This new defined type makes it easy and reduces the burden on modules that define the unit/service pair.
1 parent 81f3eb5 commit e8efe7e

File tree

2 files changed

+253
-0
lines changed

2 files changed

+253
-0
lines changed

‎manifests/socket_service.pp

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# @summary Create a systemd socket activated service
2+
# @api public
3+
#
4+
# Systemd socket activated services have their own dependencies. This is a
5+
# convenience wrapper around systemd::unit_file.
6+
#
7+
# @param name [Pattern['^[^/]+$']]
8+
# The target unit file to create
9+
# @param socket_content
10+
# The content for the socket unit file. Required if ensure isn't absent.
11+
# @param service_content
12+
# The content for the service unit file. Required if ensure isn't absent.
13+
# @param enable
14+
# Whether to enable or disable the service. By default this is derived from
15+
# $ensure but can be overridden for advanced use cases where the service is
16+
# running during a migration but shouldn't be enabled on boot.
17+
define systemd::socket_service (
18+
Enum['running', 'stopped', 'present', 'absent'] $ensure = 'running',
19+
Optional[String[1]] $socket_content = undef,
20+
Optional[String[1]] $service_content = undef,
21+
Optional[Boolean] $enable = undef,
22+
) {
23+
assert_type(Pattern['^[^/]+$'], $name)
24+
25+
if $ensure != 'absent' {
26+
assert_type(NotUndef, $socket_content)
27+
assert_type(NotUndef, $service_content)
28+
}
29+
30+
$active = $ensure ? {
31+
'running' => true,
32+
'stopped' => false,
33+
'absent' => false,
34+
default => undef,
35+
}
36+
# https://tickets.puppetlabs.com/browse/MODULES-11018
37+
if $enable == undef and $active == undef {
38+
$real_enable = undef
39+
} else {
40+
$real_enable = pick($enable, $active)
41+
}
42+
43+
$unit_file_ensure = bool2str($ensure == 'absent', 'absent', 'present')
44+
45+
systemd::unit_file { "${name}.socket":
46+
ensure => $unit_file_ensure,
47+
content => $socket_content,
48+
active => $active,
49+
enable => $real_enable,
50+
}
51+
52+
systemd::unit_file { "${name}.service":
53+
ensure => $unit_file_ensure,
54+
content => $service_content,
55+
active => $active,
56+
enable => $real_enable,
57+
}
58+
59+
if $active != undef or $real_enable != undef {
60+
# Systemd needs both .socket and .service to be loaded when starting the
61+
# service. The unit_file takes care of matching, this ensures the
62+
# non-matching order.
63+
File["/etc/systemd/system/${name}.socket"] -> Service["${name}.service"]
64+
File["/etc/systemd/system/${name}.service"] -> Service["${name}.socket"]
65+
}
66+
}

‎spec/defines/socket_service_spec.rb

+187
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
require 'spec_helper'
2+
3+
describe 'systemd::socket_service' do
4+
let(:title) { 'myservice' }
5+
6+
on_supported_os.each do |os, os_facts|
7+
context "on #{os}" do
8+
let(:facts) { os_facts }
9+
10+
context 'ensure => running' do
11+
let(:params) do
12+
{
13+
ensure: 'running',
14+
socket_content: "[Socket]\nListenStream=/run/myservice.socket\n",
15+
service_content: "[Service]\nType=notify\n",
16+
}
17+
end
18+
19+
it { is_expected.to compile.with_all_deps }
20+
it 'sets up the socket unit file' do
21+
is_expected.to contain_file('/etc/systemd/system/myservice.socket')
22+
.with_ensure('file')
23+
.with_content(%r{\[Socket\]})
24+
.that_comes_before(['Service[myservice.socket]', 'Service[myservice.service]'])
25+
end
26+
it 'sets up the socket service' do
27+
is_expected.to contain_service('myservice.socket')
28+
.with_ensure(true)
29+
.with_enable(true)
30+
end
31+
it 'sets up the service unit file' do
32+
is_expected.to contain_file('/etc/systemd/system/myservice.service')
33+
.with_ensure('file')
34+
.with_content(%r{\[Service\]})
35+
.that_comes_before('Service[myservice.service]')
36+
end
37+
it 'sets up the service service' do
38+
is_expected.to contain_service('myservice.service')
39+
.with_ensure(true)
40+
.with_enable(true)
41+
end
42+
43+
context 'enable => false' do
44+
let(:params) { super().merge(enable: false) }
45+
46+
it { is_expected.to compile.with_all_deps }
47+
it 'sets up the socket service' do
48+
is_expected.to contain_service('myservice.socket')
49+
.with_ensure(true)
50+
.with_enable(false)
51+
end
52+
it 'sets up the service service' do
53+
is_expected.to contain_service('myservice.service')
54+
.with_ensure(true)
55+
.with_enable(false)
56+
end
57+
end
58+
end
59+
60+
context 'ensure => stopped' do
61+
let(:params) do
62+
{
63+
ensure: 'stopped',
64+
socket_content: "[Socket]\nListenStream=/run/myservice.socket\n",
65+
service_content: "[Service]\nType=notify\n",
66+
}
67+
end
68+
69+
it { is_expected.to compile.with_all_deps }
70+
it 'sets up the socket unit file' do
71+
is_expected.to contain_file('/etc/systemd/system/myservice.socket')
72+
.with_ensure('file')
73+
.with_content(%r{\[Socket\]})
74+
.that_comes_before(['Service[myservice.socket]', 'Service[myservice.service]'])
75+
end
76+
it 'sets up the socket service' do
77+
is_expected.to contain_service('myservice.socket')
78+
.with_ensure(false)
79+
.with_enable(false)
80+
end
81+
it 'sets up the service unit file' do
82+
is_expected.to contain_file('/etc/systemd/system/myservice.service')
83+
.with_ensure('file')
84+
.with_content(%r{\[Service\]})
85+
.that_comes_before('Service[myservice.service]')
86+
end
87+
it 'sets up the service service' do
88+
is_expected.to contain_service('myservice.service')
89+
.with_ensure(false)
90+
.with_enable(false)
91+
end
92+
93+
context 'enable => true' do
94+
let(:params) { super().merge(enable: true) }
95+
96+
it { is_expected.to compile.with_all_deps }
97+
it 'sets up the socket service' do
98+
is_expected.to contain_service('myservice.socket')
99+
.with_ensure(false)
100+
.with_enable(true)
101+
end
102+
it 'sets up the service service' do
103+
is_expected.to contain_service('myservice.service')
104+
.with_ensure(false)
105+
.with_enable(true)
106+
end
107+
end
108+
end
109+
110+
context 'ensure => present' do
111+
let(:params) do
112+
{
113+
ensure: 'present',
114+
socket_content: "[Socket]\nListenStream=/run/myservice.socket\n",
115+
service_content: "[Service]\nType=notify\n",
116+
}
117+
end
118+
119+
it { is_expected.to compile.with_all_deps }
120+
it 'sets up the socket unit file' do
121+
is_expected.to contain_file('/etc/systemd/system/myservice.socket')
122+
.with_ensure('file')
123+
.with_content(%r{\[Socket\]})
124+
end
125+
it "doesn't set up the socket service" do
126+
is_expected.not_to contain_service('myservice.socket')
127+
end
128+
it 'sets up the service unit file' do
129+
is_expected.to contain_file('/etc/systemd/system/myservice.service')
130+
.with_ensure('file')
131+
.with_content(%r{\[Service\]})
132+
end
133+
it "doesn't set up the service service" do
134+
is_expected.not_to contain_service('myservice.service')
135+
end
136+
137+
context 'enable => true' do
138+
let(:params) { super().merge(enable: true) }
139+
140+
it { is_expected.to compile.with_all_deps }
141+
it 'sets up the socket service' do
142+
is_expected.to contain_service('myservice.socket')
143+
.without_ensure
144+
.with_enable(true)
145+
end
146+
it 'sets up the service service' do
147+
is_expected.to contain_service('myservice.service')
148+
.without_ensure
149+
.with_enable(true)
150+
end
151+
end
152+
end
153+
154+
context 'ensure => absent' do
155+
let(:params) do
156+
{
157+
ensure: 'absent',
158+
}
159+
end
160+
161+
it { is_expected.to compile.with_all_deps }
162+
it 'sets up the socket unit file' do
163+
is_expected.to contain_file('/etc/systemd/system/myservice.socket')
164+
.with_ensure('absent')
165+
.without_content
166+
.that_requires('Service[myservice.socket]')
167+
end
168+
it 'sets up the socket service' do
169+
is_expected.to contain_service('myservice.socket')
170+
.with_ensure(false)
171+
.with_enable(false)
172+
end
173+
it 'sets up the service unit file' do
174+
is_expected.to contain_file('/etc/systemd/system/myservice.service')
175+
.with_ensure('absent')
176+
.without_content
177+
.that_requires('Service[myservice.service]')
178+
end
179+
it 'sets up the service service' do
180+
is_expected.to contain_service('myservice.service')
181+
.with_ensure(false)
182+
.with_enable(false)
183+
end
184+
end
185+
end
186+
end
187+
end

0 commit comments

Comments
 (0)