1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
|
# SPDX-FileCopyrightText: © 2008-2022 Oprea Dan
# SPDX-FileCopyrightText: © 2008-2022 Bart de Koning
# SPDX-FileCopyrightText: © 2008-2022 Richard Bailey
# SPDX-FileCopyrightText: © 2008-2022 Germar Reitze
# SPDX-FileCopyrightText: © 2024 Christian Buhtz <c.buhtz@posteo.jp>
#
# SPDX-License-Identifier: GPL-2.0-or-later
#
# This file is part of the program "Back In Time" which is released under GNU
# General Public License v2 (GPLv2). See LICENSES directory or go to
# <https://spdx.org/licenses/GPL-2.0-or-later.html>.
import os
import sys
import subprocess
from unittest.mock import patch
from threading import Thread
from test import generic
sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
import tools
from applicationinstance import ApplicationInstance
class General(generic.TestCase):
def setUp(self):
"""Preparing unittests including the instantiation of an
``ÀpplicationInstance``.
"""
super().setUp()
self.temp_file = '/tmp/temp.txt'
self.file_name = "/tmp/file_with_pid"
self.app_instance = ApplicationInstance(
pidFile=os.path.abspath(self.file_name),
autoExit=False)
self.subproc = None
def tearDown(self):
"""Delete temporary files and kill subprocesses.
"""
super().tearDown()
for f in (self.temp_file, self.file_name):
if os.path.exists(f):
os.remove(f)
self._killProcess()
def _createProcess(self):
"""Start a shell script and return ins PID."""
# path to the shell script
dummyPath = os.path.join(os.path.dirname(__file__), generic.DUMMY)
self.subproc = subprocess.Popen(dummyPath)
return self.subproc.pid
def _killProcess(self):
if self.subproc:
subproc = self.subproc
subproc.kill()
subproc.wait()
self.subproc = None
def test_create_and_remove_pid_file(self):
# create pid file
self.app_instance.startApplication()
self.assertIsFile(self.file_name)
# remove pid file
self.app_instance.exitApplication()
self.assertIsNoFile(self.file_name)
def test_pid_file_content(self):
"""Content of pid file fits to current process."""
self.app_instance.startApplication()
this_pid = os.getpid()
this_procname = tools.processName(this_pid)
expected_file_content = f'{this_pid}\n{this_procname}'
with open(self.file_name, 'rt') as file_with_pid:
pid_file_content = file_with_pid.read()
self.assertEqual(pid_file_content, expected_file_content)
@patch('builtins.open')
def test_write_pid_fail(self, mock_open):
"""The test is not clear. Because of the OSError() a log error will be
generated. But this isn't tested here.
I assume the expected behavior is just that nothing bad happens
because the OSError was caught.
"""
mock_open.side_effect = OSError()
self.app_instance.startApplication()
def test_existing_process_with_correct_procname(self):
"""
Test the check function with an existing process with correct process
name
"""
pid = self._createProcess()
procname = tools.processName(pid)
# create file with pid and process name
with open(self.file_name, "wt") as file_with_pid:
file_with_pid.write(str(pid) + "\n")
file_with_pid.write(procname)
# Execute test
self.assertFalse(self.app_instance.check())
self.assertTrue(self.app_instance.busy())
def test_existing_process_with_correct_proc_cmdline(self):
"""
Test the check function with an existing process with correct process
cmdline (for backwards compatibility)
"""
# start an extern shell script
pid = self._createProcess()
procname = tools.processCmdline(pid)
# create file with pid and process name
with open(self.file_name, "wt") as file_with_pid:
file_with_pid.write(str(pid) + "\n")
file_with_pid.write(procname)
# Execute test
self.assertFalse(self.app_instance.check())
def test_no_pid_file(self):
self.assertTrue(self.app_instance.check())
def test_existing_process_with_wrong_procname(self):
"""
Test the check function with an existing process with wrong process
name
"""
pid = self._createProcess()
procname = tools.processName(pid)
# create file with pid and process name
with open(self.file_name, "wt") as file_with_pid:
file_with_pid.write(str(pid) + "\n")
file_with_pid.write(procname + "DELETE")
# Execute test
self.assertTrue(self.app_instance.check())
def test_existing_process_with_wrong_pid(self):
"""
Test the check function with an existing process with wrong pid
"""
pid = self._createProcess()
procname = tools.processName(pid)
# create file with pid and process name
with open(self.file_name, "wt") as file_with_pid:
file_with_pid.write("987654321\n")
file_with_pid.write(procname)
# Execute test
self.assertTrue(self.app_instance.check())
def test_killing_existing_process(self):
"""
Test the check function with an existing process with correct process
name
"""
pid = self._createProcess()
procname = tools.processName(pid)
# create file with pid and process name
with open(self.file_name, "wt") as file_with_pid:
file_with_pid.write(str(pid) + "\n")
file_with_pid.write(procname)
self.assertFalse(self.app_instance.check())
self._killProcess()
# Execute test
self.assertTrue(self.app_instance.check())
def test_non_existing_process(self):
""" Test the check function with a non existing process """
# GIVE #
# create file with fake pid and process name
with open(self.file_name, "wt") as file_with_pid:
file_with_pid.write("987654321\n")
file_with_pid.write("FAKE_PROCNAME")
# Execute test
self.assertTrue(self.app_instance.check())
def test_leftover_empty_lockfile(self):
with open(self.file_name, 'wt'):
pass
self.assertTrue(self.app_instance.check())
def write_after_flock(self, pid_file):
inst = ApplicationInstance(os.path.abspath(pid_file),
autoExit = False,
flock = True)
with open(self.temp_file, 'wt') as f:
f.write('foo')
inst.flockUnlock()
def test_thread_write_without_flock(self):
thread = Thread(target = self.write_after_flock, args = (self.file_name,))
thread.start()
#wait for the thread to finish
thread.join()
self.assertExists(self.temp_file)
with open(self.temp_file, 'rt') as f:
self.assertEqual(f.read(), 'foo')
def test_flock_exclusive(self):
self.app_instance.flockExclusiv()
thread = Thread(target = self.write_after_flock, args = (self.file_name,))
thread.start()
#give the thread some time
thread.join(0.01)
self.assertNotExists(self.temp_file)
self.app_instance.flockUnlock()
#wait for the thread to finish
thread.join()
self.assertExists(self.temp_file)
with open(self.temp_file, 'rt') as f:
self.assertEqual(f.read(), 'foo')
@patch('builtins.open')
def test_flock_exclusive_fail(self, mock_open):
"""Dev note (buhtz: 2023-09)
Nothing is tested here.
Looking into flockExclusive() there is only the opportunity to
test for ERROR log output. Log output shouldn't be tested.
The behavior to test is unclear.
Proposal:
- Remove the test.
- Refactor flockExclusive() and related code to make its behavior
clear.
"""
mock_open.side_effect = OSError()
self.app_instance.flockExclusiv()
def test_auto_flock(self):
self.app_instance = ApplicationInstance(os.path.abspath(self.file_name),
autoExit = False,
flock = True)
thread = Thread(target = self.write_after_flock, args = (self.file_name,))
thread.start()
#give the thread some time
thread.join(0.01)
self.assertNotExists(self.temp_file)
self.app_instance.startApplication()
#wait for the thread to finish
thread.join()
self.assertExists(self.temp_file)
with open(self.temp_file, 'rt') as f:
self.assertEqual(f.read(), 'foo')
def test_autoExit_unique_process(self):
self.app_instance = ApplicationInstance(os.path.abspath(self.file_name),
autoExit = True)
self.assertExists(self.file_name)
this_pid = os.getpid()
this_procname = tools.processName(this_pid)
with open(self.file_name, 'rt') as file_with_pid:
self.assertEqual(file_with_pid.read(), '{}\n{}'.format(this_pid, this_procname))
def test_autoExit_other_running_process(self):
pid = self._createProcess()
procname = tools.processName(pid)
# create file with pid and process name
with open(self.file_name, "wt") as file_with_pid:
file_with_pid.write(str(pid) + "\n")
file_with_pid.write(procname)
with self.assertRaises(SystemExit):
self.app_instance = ApplicationInstance(os.path.abspath(self.file_name),
autoExit = True)
def test_readPidFile(self):
with open(self.file_name, "wt") as f:
f.write('123\nfoo')
self.assertEqual(self.app_instance.readPidFile(), (123, 'foo'))
# ValueError
with open(self.file_name, "wt") as f:
f.write('foo\nbar')
self.assertEqual(self.app_instance.readPidFile(), (0, 'bar'))
@patch('builtins.open')
def test_readPidFile_fail(self, mock_open):
mock_open.side_effect = OSError()
self.assertEqual(self.app_instance.readPidFile(), (0, ''))
|
