18840985182

Committed 27 Oct 2025 12:29PM UTC coverage: 80.279% (-0.003%) from 80.282%

Build # 18840985182

Build Type

Pull #22812

github

Committed by

web-flow

Commit Message

Merge aae945cbd into 06e216752

Pull Request Pull Request #22812: Updating and locking most requirements items

Run Details

4 of 5 new or added lines in 3 files covered. (80.0%)

3 existing lines in 2 files now uncovered.

77871 of 97000 relevant lines covered (80.28%)

3.35 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

87.69

/src/python/pants/pantsd/lock_test.py

# Copyright 2016 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).

import os
import shutil
import tempfile
import unittest
from multiprocessing import Manager, Process
from threading import Thread

from pants.pantsd.lock import OwnerPrintingInterProcessFileLock


def hold_lock_until_terminate(path, lock_held, terminate):
    lock = OwnerPrintingInterProcessFileLock(path)
    lock.acquire()
    lock_held.set()
    # NOTE: We shouldn't ever wait this long, this is just to ensure
    # we don't somehow leak child processes.
    terminate.wait(60)
    lock.release()
    lock_held.clear()


class TestOwnerPrintingInterProcessFileLock(unittest.TestCase):
    def setUp(self):
        self.lock_dir = tempfile.mkdtemp()
        self.lock_path = os.path.join(self.lock_dir, "lock")
        self.lock = OwnerPrintingInterProcessFileLock(self.lock_path)
        self.manager = Manager()
        self.lock_held = self.manager.Event()
        self.terminate = self.manager.Event()
        self.lock_process = Process(
            target=hold_lock_until_terminate, args=(self.lock_path, self.lock_held, self.terminate)
        )

    def tearDown(self):
        self.terminate.set()
        try:
            shutil.rmtree(self.lock_dir)
        except OSError:
            pass

    def test_non_blocking_attempt(self):
        self.lock_process.start()
        self.lock_held.wait()
        self.assertFalse(self.lock.acquire(blocking=False))

    def test_message(self):
        self.lock_process.start()
        self.lock_held.wait()
        self.assertTrue(os.path.exists(self.lock.message_path))
        with open(self.lock.message_path) as f:
            message_content = f.read()
        self.assertIn(str(self.lock_process.pid), message_content)

        os.unlink(self.lock.message_path)

        def message_fn(message):
            self.assertIn(self.lock.missing_message_output, message)

        self.lock.acquire(blocking=False, message_fn=message_fn)

    def test_blocking(self):
        self.lock_process.start()
        self.lock_held.wait()
        self.assertFalse(self.lock.acquire(timeout=0.1))

        acquire_is_blocking = self.manager.Event()

        def terminate_subproc(terminate, acquire_is_blocking):
            acquire_is_blocking.wait()
            terminate.set()

        Thread(target=terminate_subproc, args=(self.terminate, acquire_is_blocking)).start()

        def message_fn(message):
            self.assertIn(str(self.lock_process.pid), message)
            acquire_is_blocking.set()

        # NOTE: We shouldn't ever wait this long (locally this runs in ~milliseconds)
        # but sometimes CI containers are extremely slow, so we choose a very large
        # value just in case.
        self.assertTrue(self.lock.acquire(timeout=30, message_fn=message_fn))

    def test_reentrant(self):
        self.assertTrue(self.lock.acquire())
        self.assertTrue(self.lock.acquire())

    def test_release(self):
        self.assertTrue(self.lock.acquire())
        self.assertTrue(self.lock.acquired)
        self.lock.release()
        self.assertFalse(self.lock.acquired)

1	# Copyright 2016 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4	import os	1✔
5	import shutil	1✔
6	import tempfile	1✔
7	import unittest	1✔
8	from multiprocessing import Manager, Process	1✔
9	from threading import Thread	1✔
10
11	from pants.pantsd.lock import OwnerPrintingInterProcessFileLock	1✔
12
13
14	def hold_lock_until_terminate(path, lock_held, terminate):	1✔
15	lock = OwnerPrintingInterProcessFileLock(path)	×
16	lock.acquire()	×
17	lock_held.set()	×
18	# NOTE: We shouldn't ever wait this long, this is just to ensure
19	# we don't somehow leak child processes.
20	terminate.wait(60)	×
21	lock.release()	×
22	lock_held.clear()	×
23
24
25	class TestOwnerPrintingInterProcessFileLock(unittest.TestCase):	1✔
26	def setUp(self):	1✔
27	self.lock_dir = tempfile.mkdtemp()	1✔
28	self.lock_path = os.path.join(self.lock_dir, "lock")	1✔
29	self.lock = OwnerPrintingInterProcessFileLock(self.lock_path)	1✔
30	self.manager = Manager()	1✔
31	self.lock_held = self.manager.Event()	1✔
32	self.terminate = self.manager.Event()	1✔
33	self.lock_process = Process(	1✔
34	target=hold_lock_until_terminate, args=(self.lock_path, self.lock_held, self.terminate)
35	)
36
37	def tearDown(self):	1✔
38	self.terminate.set()	1✔
39	try:	1✔
40	shutil.rmtree(self.lock_dir)	1✔
UNCOV 41	except OSError:	×
UNCOV 42	pass	×
43
44	def test_non_blocking_attempt(self):	1✔
45	self.lock_process.start()	1✔
46	self.lock_held.wait()	1✔
47	self.assertFalse(self.lock.acquire(blocking=False))	1✔
48
49	def test_message(self):	1✔
50	self.lock_process.start()	1✔
51	self.lock_held.wait()	1✔
52	self.assertTrue(os.path.exists(self.lock.message_path))	1✔
53	with open(self.lock.message_path) as f:	1✔
54	message_content = f.read()	1✔
55	self.assertIn(str(self.lock_process.pid), message_content)	1✔
56
57	os.unlink(self.lock.message_path)	1✔
58
59	def message_fn(message):	1✔
60	self.assertIn(self.lock.missing_message_output, message)	1✔
61
62	self.lock.acquire(blocking=False, message_fn=message_fn)	1✔
63
64	def test_blocking(self):	1✔
65	self.lock_process.start()	1✔
66	self.lock_held.wait()	1✔
67	self.assertFalse(self.lock.acquire(timeout=0.1))	1✔
68
69	acquire_is_blocking = self.manager.Event()	1✔
70
71	def terminate_subproc(terminate, acquire_is_blocking):	1✔
72	acquire_is_blocking.wait()	1✔
73	terminate.set()	1✔
74
75	Thread(target=terminate_subproc, args=(self.terminate, acquire_is_blocking)).start()	1✔
76
77	def message_fn(message):	1✔
78	self.assertIn(str(self.lock_process.pid), message)	1✔
79	acquire_is_blocking.set()	1✔
80
81	# NOTE: We shouldn't ever wait this long (locally this runs in ~milliseconds)
82	# but sometimes CI containers are extremely slow, so we choose a very large
83	# value just in case.
84	self.assertTrue(self.lock.acquire(timeout=30, message_fn=message_fn))	1✔
85
86	def test_reentrant(self):	1✔
87	self.assertTrue(self.lock.acquire())	1✔
88	self.assertTrue(self.lock.acquire())	1✔
89
90	def test_release(self):	1✔
91	self.assertTrue(self.lock.acquire())	1✔
92	self.assertTrue(self.lock.acquired)	1✔
93	self.lock.release()	1✔
94	self.assertFalse(self.lock.acquired)	1✔

pantsbuild / pants / 18840985182

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous