-
Notifications
You must be signed in to change notification settings - Fork 0
/
lslock.py
185 lines (150 loc) · 5.57 KB
/
lslock.py
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
#!/usr/bin/env python
import os
import fcntl
import string
import random
import click
from multiprocessing import Process
import logging
@click.command()
@click.argument(
'directory', type=click.Path(exists=True), default="/tmp/lslock-test")
@click.option(
'--verbose',
'-v',
default=False,
is_flag=True,
help='Enable verbose output')
def display_locked_files(directory, verbose):
"""Displays all locked files underneath directory."""
if verbose:
logging.basicConfig(level=logging.DEBUG)
logging.info('Checking for locks on %s' % click.format_filename(directory))
locks = locked_files_in_dir(directory)
logging.info('Found following locks: {}'.format(locks))
for lock in locks:
click.echo('File {} is locked by PID {}'.format(
click.format_filename(lock.get('filepath')), lock.get('pid')))
if not locks:
click.echo('Found no locked files')
@click.command()
@click.argument(
'directory', type=click.Path(exists=True), default="/tmp/lslock-test")
@click.option(
'--number', '-n', default=5, help='How many lock files are generated')
@click.option(
'--verbose',
'-v',
default=False,
is_flag=True,
help='Enable verbose output')
def create_locks(directory, verbose, number):
"""Creates some locked files in directory
and checks the validity of lslock"""
if verbose:
logging.basicConfig(level=logging.DEBUG)
for i in range(0, number):
full_path = os.path.join(directory, str(i))
p = Process(target=create_lock, args=(full_path, ))
p.start()
p.join()
click.echo("All done!")
def create_lock(full_path):
with open(full_path, "w") as file_to_lock:
lock_file(file_to_lock)
check_is_locked_file(full_path)
def locked_files_in_dir(directory):
"""Returns a tuple of dicts of all filepaths in directory
that are currently locked"""
all_locks = {}
locked_files = []
files_in_directory = inodes_in_dir(directory)
with open("/proc/locks", "r") as locks:
for line in locks:
pid = line.split()[4] # process locking the file
inode = line.split()[
5] # has the format MAJOR-DEVICE:MINOR-DEVICE:INODE-NUMBER
inode = inode.split(":")[2] # interested only in inode number
all_locks[int(inode)] = int(pid)
# The intersection of all locks and the locks in the specified directory
intersection = set(all_locks) & set(files_in_directory)
logging.info("All current locks: {}".format(all_locks))
# to get a dict with both pid and filepath,
# we need to append the pid we got from /proc/locks and the associated
# filepath from the file inside the directory
for lock in intersection:
locked_files.append({
'pid': all_locks[lock],
'filepath': files_in_directory[lock]
})
return locked_files
def inodes_in_dir(directory):
"""Descent into directory and return
a dict of all inodes with their filepath"""
inode_dict = {}
for filepath in files_in_dir(directory):
inode_dict[os.stat(filepath).st_ino] = filepath
return inode_dict
def files_in_dir(directory):
"""Returns all files in directory and its subdirectories
If a file is given, return the file"""
file_paths = []
if os.path.isfile(directory):
file_paths.append(directory)
else:
for root, directories, files in os.walk(directory):
for filename in files:
filepath = os.path.join(root, filename)
file_paths.append(filepath)
return file_paths
def lock_file(file_to_lock):
"""locks the passed file"""
fcntl.flock(file_to_lock, fcntl.LOCK_NB | fcntl.LOCK_EX)
logging.info("Creating lock on {}".format(file_to_lock))
def random_string(size=10):
"""Generates a random lowercase string of size"""
return ''.join(random.choice(string.ascii_lowercase) for x in range(size))
# Here start the tests
def test_file_to_lock_creation():
filename = random_string()
directory = "/tmp/lslock-test"
full_path = os.path.join(directory, filename)
if not os.path.exists(directory):
os.makedirs(directory)
with open(full_path, "w") as file_to_lock:
lock_file(file_to_lock)
logging.info("Checking if {} exists".format(full_path))
assert os.path.isfile(full_path)
def check_is_locked_file(full_path):
assert is_locked(full_path)
def check_is_unlocked_file(full_path):
assert not is_locked(full_path)
def is_locked(full_path):
logging.info("Checking if {} is locked.".format(full_path))
locks = locked_files_in_dir(full_path)
if not locks:
return []
lock = [lock for lock in locks if lock.get('filepath') == full_path]
logging.info("Found lock on {}".format(lock))
return lock
def test_five_locked_files():
directory = "/tmp/lslock-test"
if not os.path.exists(directory):
os.makedirs(directory)
for i in range(0, 5):
full_path = os.path.join(directory, str(i))
with open(full_path, "w") as file_to_lock:
lock_file(file_to_lock)
locks = locked_files_in_dir(full_path)
logging.info(locks)
yield check_is_locked_file, full_path
def test_five_unlocked_files():
directory = "/tmp/lslock-test"
if not os.path.exists(directory):
os.makedirs(directory)
for i in range(0, 5):
full_path = os.path.join(directory, str(i))
with open(full_path, "w"):
locks = locked_files_in_dir(full_path)
logging.info(locks)
yield check_is_unlocked_file, full_path