This is an archive of the discontinued LLVM Phabricator instance.

Differential D109585

[lldb] [test] Move "platform connect" logic into a common class
ClosedPublic

Authored by mgorny on Sep 10 2021, 2:22 AM.

Details

Reviewers
labath
emaste
krytarowski
Commits
rGc240d2bb06da: [lldb] [test] Move "platform connect" logic into a common class
Summary

Create a common GDBPlatformClientTestBase class and move the platform
select/connect logic there to reduce duplication.

Diff Detail

Event Timeline

mgorny requested review of this revision.Sep 10 2021, 2:22 AM
mgorny created this revision.
mgorny added a child revision: D107809: [lldb] Add new commands and tests for getting file perms & exists.
mgorny added a child revision: D107811: [lldb] [gdb-remote] Add fallbacks for vFile:mode and vFile:exists.Sep 10 2021, 2:26 AM
labath added a comment.Sep 10 2021, 2:30 AM

looks better. Can we also move the DisconnectRemote() thingy into the tearDown method ?

mgorny updated this revision to Diff 371844.Sep 10 2021, 2:37 AM

Sorry about missing that. Done now.

labath accepted this revision.Sep 10 2021, 2:55 AM

cool

This revision is now accepted and ready to land.Sep 10 2021, 2:55 AM
Harbormaster completed remote builds in B123397: Diff 371844.Sep 10 2021, 3:18 AM
Closed by commit rGc240d2bb06da: [lldb] [test] Move "platform connect" logic into a common class (authored by mgorny). · Explain WhySep 10 2021, 5:08 AM
This revision was automatically updated to reflect the committed changes.
mgorny added a commit: rGc240d2bb06da: [lldb] [test] Move "platform connect" logic into a common class.
Herald added a project: Restricted Project. · View Herald TranscriptSep 10 2021, 5:08 AM

Revision Contents

PathSize
lldb/
test/
API/
functionalities/
gdb_remote_client/
20 lines
124 lines
20 lines

Diff 371887

lldb/test/API/functionalities/gdb_remote_client/TestGDBRemoteDiskFileCompletion.py

from gdbclientutils import * from gdbclientutils import *
class TestGDBRemoteDiskFileCompletion(GDBRemoteTestBase): class TestGDBRemoteDiskFileCompletion(GDBPlatformClientTestBase):
def test_autocomplete_request(self): def test_autocomplete_request(self):
"""Test remote disk completion on remote-gdb-server plugin""" """Test remote disk completion on remote-gdb-server plugin"""
class Responder(MockGDBServerResponder): class Responder(MockGDBServerResponder):
def qPathComplete(self): def qPathComplete(self):
return "M{},{}".format( return "M{},{}".format(
"test".encode().hex(), "test".encode().hex(),
"123".encode().hex() "123".encode().hex()
) )
self.server.responder = Responder() self.server.responder = Responder()
try:
self.runCmd("platform select remote-gdb-server")
self.runCmd("platform connect connect://" +
self.server.get_connect_address())
self.assertTrue(self.dbg.GetSelectedPlatform().IsConnected())
self.complete_from_to('platform get-size ', ['test', '123']) self.complete_from_to('platform get-size ', ['test', '123'])
self.complete_from_to('platform get-file ', ['test', '123']) self.complete_from_to('platform get-file ', ['test', '123'])
self.complete_from_to('platform put-file foo ', ['test', '123']) self.complete_from_to('platform put-file foo ', ['test', '123'])
self.complete_from_to('platform file open ', ['test', '123']) self.complete_from_to('platform file open ', ['test', '123'])
self.complete_from_to('platform settings -w ', ['test', '123']) self.complete_from_to('platform settings -w ', ['test', '123'])
finally:
self.dbg.GetSelectedPlatform().DisconnectRemote()

lldb/test/API/functionalities/gdb_remote_client/TestGDBRemotePlatformFile.py

from gdbclientutils import * from gdbclientutils import *
class TestGDBRemotePlatformFile(GDBRemoteTestBase): class TestGDBRemotePlatformFile(GDBPlatformClientTestBase):
def test_file(self): def test_file(self):
"""Test mock operations on a remote file""" """Test mock operations on a remote file"""
class Responder(MockGDBServerResponder): class Responder(MockGDBServerResponder):
def vFile(self, packet): def vFile(self, packet):
if packet.startswith("vFile:open:"): if packet.startswith("vFile:open:"):
return "F10" return "F10"
elif packet.startswith("vFile:pread:"): elif packet.startswith("vFile:pread:"):
return "Fd;frobnicator" return "Fd;frobnicator"
elif packet.startswith("vFile:pwrite:"): elif packet.startswith("vFile:pwrite:"):
return "Fa" return "Fa"
elif packet.startswith("vFile:close:"): elif packet.startswith("vFile:close:"):
return "F0" return "F0"
return "F-1,16" return "F-1,16"
self.server.responder = Responder() self.server.responder = Responder()
try:
self.runCmd("platform select remote-gdb-server")
self.runCmd("platform connect connect://" +
self.server.get_connect_address())
self.assertTrue(self.dbg.GetSelectedPlatform().IsConnected())
self.match("platform file open /some/file.txt -v 0755", self.match("platform file open /some/file.txt -v 0755",
[r"File Descriptor = 16"]) [r"File Descriptor = 16"])
self.match("platform file read 16 -o 11 -c 13", self.match("platform file read 16 -o 11 -c 13",
[r"Return = 11\nData = \"frobnicator\""]) [r"Return = 11\nData = \"frobnicator\""])
self.match("platform file write 16 -o 11 -d teststring", self.match("platform file write 16 -o 11 -d teststring",
[r"Return = 10"]) [r"Return = 10"])
self.match("platform file close 16", self.match("platform file close 16",
[r"file 16 closed."]) [r"file 16 closed."])
self.assertPacketLogContains([ self.assertPacketLogContains([
"vFile:open:2f736f6d652f66696c652e747874,00000202,000001ed", "vFile:open:2f736f6d652f66696c652e747874,00000202,000001ed",
"vFile:pread:10,d,b", "vFile:pread:10,d,b",
"vFile:pwrite:10,b,teststring", "vFile:pwrite:10,b,teststring",
"vFile:close:10", "vFile:close:10",
]) ])
finally:
self.dbg.GetSelectedPlatform().DisconnectRemote()
def test_file_fail(self): def test_file_fail(self):
"""Test mocked failures of remote operations""" """Test mocked failures of remote operations"""
class Responder(MockGDBServerResponder): class Responder(MockGDBServerResponder):
def vFile(self, packet): def vFile(self, packet):
return "F-1,16" return "F-1,16"
self.server.responder = Responder() self.server.responder = Responder()
try:
self.runCmd("platform select remote-gdb-server")
self.runCmd("platform connect connect://" +
self.server.get_connect_address())
self.assertTrue(self.dbg.GetSelectedPlatform().IsConnected())
self.match("platform file open /some/file.txt -v 0755", self.match("platform file open /some/file.txt -v 0755",
[r"error: Invalid argument"], [r"error: Invalid argument"],
error=True) error=True)
self.match("platform file read 16 -o 11 -c 13", self.match("platform file read 16 -o 11 -c 13",
[r"error: Invalid argument"], [r"error: Invalid argument"],
error=True) error=True)
self.match("platform file write 16 -o 11 -d teststring", self.match("platform file write 16 -o 11 -d teststring",
[r"error: Invalid argument"], [r"error: Invalid argument"],
error=True) error=True)
self.match("platform file close 16", self.match("platform file close 16",
[r"error: Invalid argument"], [r"error: Invalid argument"],
error=True) error=True)
self.assertPacketLogContains([ self.assertPacketLogContains([
"vFile:open:2f736f6d652f66696c652e747874,00000202,000001ed", "vFile:open:2f736f6d652f66696c652e747874,00000202,000001ed",
"vFile:pread:10,d,b", "vFile:pread:10,d,b",
"vFile:pwrite:10,b,teststring", "vFile:pwrite:10,b,teststring",
"vFile:close:10", "vFile:close:10",
]) ])
finally:
self.dbg.GetSelectedPlatform().DisconnectRemote()
def test_file_size(self): def test_file_size(self):
"""Test 'platform get-size'""" """Test 'platform get-size'"""
class Responder(MockGDBServerResponder): class Responder(MockGDBServerResponder):
def vFile(self, packet): def vFile(self, packet):
return "F1000" return "F1000"
self.server.responder = Responder() self.server.responder = Responder()
try:
self.runCmd("platform select remote-gdb-server")
self.runCmd("platform connect connect://" +
self.server.get_connect_address())
self.assertTrue(self.dbg.GetSelectedPlatform().IsConnected())
self.match("platform get-size /some/file.txt", self.match("platform get-size /some/file.txt",
[r"File size of /some/file\.txt \(remote\): 4096"]) [r"File size of /some/file\.txt \(remote\): 4096"])
self.assertPacketLogContains([ self.assertPacketLogContains([
"vFile:size:2f736f6d652f66696c652e747874", "vFile:size:2f736f6d652f66696c652e747874",
]) ])
finally:
self.dbg.GetSelectedPlatform().DisconnectRemote()
def test_file_size_fallback(self): def test_file_size_fallback(self):
"""Test 'platform get-size fallback to vFile:fstat'""" """Test 'platform get-size fallback to vFile:fstat'"""
class Responder(MockGDBServerResponder): class Responder(MockGDBServerResponder):
def vFile(self, packet): def vFile(self, packet):
if packet.startswith("vFile:open:"): if packet.startswith("vFile:open:"):
return "F5" return "F5"
elif packet.startswith("vFile:fstat:"): elif packet.startswith("vFile:fstat:"):
return "F40;" + 28 * "\0" + "\0\0\0\0\0\1\2\3" + 28 * "\0" return "F40;" + 28 * "\0" + "\0\0\0\0\0\1\2\3" + 28 * "\0"
if packet.startswith("vFile:close:"): if packet.startswith("vFile:close:"):
return "F0" return "F0"
return "" return ""
self.server.responder = Responder() self.server.responder = Responder()
try:
self.runCmd("platform select remote-gdb-server")
self.runCmd("platform connect connect://" +
self.server.get_connect_address())
self.assertTrue(self.dbg.GetSelectedPlatform().IsConnected())
self.match("platform get-size /some/file.txt", self.match("platform get-size /some/file.txt",
[r"File size of /some/file\.txt \(remote\): 66051"]) [r"File size of /some/file\.txt \(remote\): 66051"])
self.assertPacketLogContains([ self.assertPacketLogContains([
"vFile:size:2f736f6d652f66696c652e747874", "vFile:size:2f736f6d652f66696c652e747874",
"vFile:open:2f736f6d652f66696c652e747874,00000000,00000000", "vFile:open:2f736f6d652f66696c652e747874,00000000,00000000",
"vFile:fstat:5", "vFile:fstat:5",
"vFile:close:5", "vFile:close:5",
]) ])
finally:
self.dbg.GetSelectedPlatform().DisconnectRemote()

lldb/test/API/functionalities/gdb_remote_client/gdbclientutils.py

Show First 20 Lines • Show All 560 Lines • ▼ Show 20 Lines def assertPacketLogContains(self, packets):
while i < len(packets) and j < len(log): while i < len(packets) and j < len(log):
if log[j] == packets[i]: if log[j] == packets[i]:
i += 1 i += 1
j += 1 j += 1
if i < len(packets): if i < len(packets):
self.fail(u"Did not receive: %s\nLast 10 packets:\n\t%s" % self.fail(u"Did not receive: %s\nLast 10 packets:\n\t%s" %
(packets[i], u'\n\t'.join(log))) (packets[i], u'\n\t'.join(log)))
class GDBPlatformClientTestBase(GDBRemoteTestBase):
"""
Base class for platform server clients.
This class extends GDBRemoteTestBase by automatically connecting
via "platform connect" in the setUp() method.
"""
def setUp(self):
super().setUp()
self.runCmd("platform select remote-gdb-server")
self.runCmd("platform connect connect://" +
self.server.get_connect_address())
self.assertTrue(self.dbg.GetSelectedPlatform().IsConnected())
def tearDown(self):
self.dbg.GetSelectedPlatform().DisconnectRemote()
super().tearDown()