Skip to content

Commit ac092f6

Browse files
batrickbatrick
committed
qa: add test to verify recovery of alternate_name from journal
Test without the fix: 2024-05-16T22:34:21.781 DEBUG:teuthology.orchestra.run.smithi044:> sudo adjust-ulimits ceph-coverage /home/ubuntu/cephtest/archive/coverage timeout 300 ceph --cluster ceph --admin-daemon /var/run/ceph/ceph-mds.a.asok --format=json dump tree /dir 0 ... [ { "accounted_rstat": { "rbytes": 4096, "rctime": "2024-05-16T22:34:15.251864+0000", "rfiles": 1, "rsnaps": 0, "rsubdirs": 1, "version": 0 }, "atime": "2024-05-16T22:34:14.498880+0000", "auth_pins": 0, "auth_state": { "replicas": {} }, "authlock": {}, "backtrace_version": 14, "btime": "2024-05-16T22:34:14.498880+0000", "change_attr": 3, "client_caps": [ { "client_id": 5184, "issued": "pAsLsXsFsx", "last_sent": 4, "pending": "pAsLsXsFsx", "wanted": "pAsLsXsFsxcral" } ], "client_ranges": [], "ctime": "2024-05-16T22:34:15.249864+0000", "damage_flags": 0, "dir_layout": { "dir_hash": 2, "unused1": 0, "unused2": 0, "unused3": 0 }, "dirfrags": [ { "auth_pins": 0, "auth_state": { "replicas": {} }, "committed_version": "0", "committing_version": "0", "dentries": [ { "alternate_name": "bUHUwH9E8uiVaf8xZ+zONcB1CToj53x5aUUnKdnNj5U37zbh28l1AaWwHhbOT3HyzqKjmSKKW1o4odQJc7nF9xrKIB8D3b4qqb2Cs6s7t2106hHhQk5/YV7DtpeNPZnorcTqxPM/hExtWHSS4P+S+Dpwj62hMyh/77sGhiW1Filvv1gQjV+sN/GozPNwHgfleadkUs1OkRkYtgWrCjbKP0MayRtiOLrVTRuYyOp/Qt3+XCIyiS87B9bUcOFjWratF+yR0kpJ0RYriix7NKVkBJ0kGWYSCY+PYjiLeMYJBMQcCxW/nwfVku+m6fgFJvb6pjEFxIk9zT5cunSImsjr", "auth_pins": 0, "auth_state": { "replicas": {} }, "inode": 1099511628283, "is_auth": true, "is_freezing": false, "is_frozen": false, "is_new": false, "is_null": false, "is_primary": true, "is_remote": false, "lock": {}, "nref": 2, "path": "dir/bUHUwH9E8uiVaf8xZ+zONcB1CToj53x5aUUnKdnNj5U37zbh28l1AaWwHhbOT3HyzqKjmSKKW1o4odQJc7nF9xrKIB8D3b4qqb2Cs6s7t2106hHhQk5,YV7DtpeNPZnorcTqxPM,hExtWHSS4P+S+Dpwj62hMyh,77sGhiW1Filvv1gQjV+sN,GozPNwHgfleadkUuZ+PMLCaKQXhuid9WvmHanxJnaabYDLj4VEz+EX2WsG", ... # fail + journal recovery 2024-05-16T22:35:31.077 DEBUG:teuthology.orchestra.run.smithi044:> sudo adjust-ulimits ceph-coverage /home/ubuntu/cephtest/archive/coverage timeout 300 ceph --cluster ceph --admin-daemon /var/run/ceph/ceph-mds.a.asok --format=json dump tree /dir 0 ... [ { "accounted_rstat": { "rbytes": 4096, "rctime": "2024-05-16T22:34:15.251864+0000", "rfiles": 1, "rsnaps": 0, "rsubdirs": 1, "version": 0 }, "atime": "2024-05-16T22:34:14.498880+0000", "auth_pins": 0, "auth_state": { "replicas": {} }, "authlock": {}, "backtrace_version": 14, "btime": "2024-05-16T22:34:14.498880+0000", "change_attr": 3, "client_caps": [], "client_ranges": [], "ctime": "2024-05-16T22:34:15.249864+0000", "damage_flags": 0, "dir_layout": { "dir_hash": 2, "unused1": 0, "unused2": 0, "unused3": 0 }, "dirfrags": [ { "auth_pins": 0, "auth_state": { "replicas": {} }, "committed_version": "5", "committing_version": "5", "dentries": [ { "alternate_name": "", "auth_pins": 0, "auth_state": { "replicas": {} }, "inode": 1099511628283, "is_auth": true, "is_freezing": false, "is_frozen": false, "is_new": false, "is_null": false, "is_primary": true, "is_remote": false, "lock": {}, "nref": 2, "path": "dir/bUHUwH9E8uiVaf8xZ+zONcB1CToj53x5aUUnKdnNj5U37zbh28l1AaWwHhbOT3HyzqKjmSKKW1o4odQJc7nF9xrKIB8D3b4qqb2Cs6s7t2106hHhQk5,YV7DtpeNPZnorcTqxPM,hExtWHSS4P+S+Dpwj62hMyh,77sGhiW1Filvv1gQjV+sN,GozPNwHgfleadkUuZ+PMLCaKQXhuid9WvmHanxJnaabYDLj4VEz+EX2WsG", Signed-off-by: Patrick Donnelly <[email protected]>
1 parent 4b4cb54 commit ac092f6

File tree

2 files changed

+92
-3
lines changed

2 files changed

+92
-3
lines changed

‎qa/suites/fs/fscrypt/tasks/1-tests/fscrypt-common.yaml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
overrides:
2+
install:
3+
extra_system_packages:
4+
rpm:
5+
- fscrypt
6+
deb:
7+
- fscrypt
18
tasks:
29
- cephfs_test_runner:
310
fail_on_skip: false

‎qa/tasks/cephfs/test_fscrypt.py‎

Lines changed: 85 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,95 @@
1+
from io import StringIO
2+
from os.path import basename
3+
import random
4+
import string
5+
16
from logging import getLogger
27

3-
from io import StringIO
8+
from tasks.cephfs.cephfs_test_case import CephFSTestCase
49
from tasks.cephfs.xfstests_dev import XFSTestsDev
510

6-
711
log = getLogger(__name__)
812

13+
class FSCryptTestCase(CephFSTestCase):
14+
CLIENTS_REQUIRED = 1
15+
16+
def setUp(self):
17+
super().setUp()
18+
19+
self.protector = ''.join(random.choice(string.ascii_letters) for _ in range(8))
20+
self.key_file = "/tmp/key"
21+
self.path = "dir/"
22+
23+
self.mount_a.run_shell_payload("sudo fscrypt --help")
24+
self.mount_a.run_shell_payload("sudo fscrypt setup --help")
25+
self.mount_a.run_shell_payload("sudo fscrypt setup --force --quiet")
26+
self.mount_a.run_shell_payload("sudo fscrypt status")
27+
self.mount_a.run_shell_payload(f"sudo fscrypt setup --quiet {self.mount_a.hostfs_mntpt}")
28+
self.mount_a.run_shell_payload("sudo fscrypt status")
29+
self.mount_a.run_shell_payload(f"sudo dd if=/dev/urandom of={self.key_file} bs=32 count=1")
30+
self.mount_a.run_shell_payload(f"mkdir -p {self.path}")
31+
self.mount_a.run_shell_payload(f"sudo fscrypt encrypt --quiet --source=raw_key --name={self.protector} --no-recovery --skip-unlock --key={self.key_file} {self.path}")
32+
self.mount_a.run_shell_payload(f"sudo fscrypt unlock --quiet --key=/tmp/key {self.path}")
33+
34+
def tearDown(self):
35+
self.mount_a.run_shell_payload(f"sudo fscrypt purge --force --quiet {self.mount_a.hostfs_mntpt}")
36+
37+
super().tearDown()
38+
39+
class TestFSCrypt(FSCryptTestCase):
40+
41+
def test_fscrypt_basic_mount(self):
42+
"""
43+
That fscrypt can be setup and ingest files.
44+
"""
45+
46+
self.mount_a.run_shell_payload(f"cp -av /usr/include {self.path}/")
47+
48+
class TestFSCryptRecovery(FSCryptTestCase):
49+
50+
def test_fscrypt_journal_recovery(self):
51+
"""
52+
That alternate_name can be recovered from the journal.
53+
"""
54+
55+
file = ''.join(random.choice(string.ascii_letters) for _ in range(255))
56+
57+
self.mount_a.run_shell_payload(f"cd {self.path} && dd if=/dev/urandom of={file} bs=512 count=1 oflag=sync && sync . && stat {file}")
58+
59+
def verify_alternate_name():
60+
J = self.fs.read_cache("/dir", depth=0)
61+
self.assertEqual(len(J), 1)
62+
inode = J[0]
63+
dirfrags = inode['dirfrags']
64+
self.assertEqual(len(dirfrags), 1)
65+
dirfrag = dirfrags[0]
66+
dentries = dirfrag['dentries']
67+
self.assertEqual(len(dentries), 1)
68+
# we don't know it's encrypted name, so we cannot verify that it's {file}
69+
dentry = dentries[0]
70+
name = basename(dentry['path'])
71+
# https://github.com/ceph/ceph-client/blob/fec50db7033ea478773b159e0e2efb135270e3b7/fs/ceph/crypto.h#L65-L90
72+
self.assertEqual(len(name), 240)
73+
alternate_name = dentry['alternate_name']
74+
self.assertGreater(len(alternate_name), 240)
75+
76+
verify_alternate_name()
77+
78+
self.fs.fail()
79+
80+
self.fs.journal_tool(['event', 'recover_dentries', 'list'], 0)
81+
self.fs.journal_tool(['journal', 'reset', '--yes-i-really-really-mean-it'], 0)
82+
83+
self.fs.set_joinable()
84+
self.fs.wait_for_daemons()
85+
86+
verify_alternate_name()
87+
88+
self.mount_a.run_shell_payload(f"cd {self.path} && find")
89+
self.mount_a.run_shell_payload(f"cd {self.path} && stat {file}")
90+
991

10-
class TestFscrypt(XFSTestsDev):
92+
class TestFSCryptXFS(XFSTestsDev):
1193

1294
def setup_xfsprogs_devs(self):
1395
self.install_xfsprogs = True

0 commit comments

Comments
 (0)