[gcmole] Add tests for suspect collector
This adds tests of the GCSuspectsCollector and its relevant usages in GCMole. The relevant logic has now 100% code coverage, which prepares refactoring of the code and serialization of only partially collected suspect data in a future CL . No-Try: true Bug: v8:12660 Change-Id: I0b0cc6f8a5e65f14084e80cda50400232e0d2c45 Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/4031052 Reviewed-by: Alexander Schulze <alexschulze@chromium.org> Commit-Queue: Michael Achenbach <machenbach@chromium.org> Reviewed-by: Camillo Bruni <cbruni@chromium.org> Cr-Commit-Position: refs/heads/main@{#84361}
This commit is contained in:
Michael Achenbach
V8 LUCI CQ
parent
06aaa9625f
commit
8c37a1a8bc
@ -7,6 +7,9 @@ from pathlib import Path
|
||||
|
||||
import collections
|
||||
import os
|
||||
import re
|
||||
import tempfile
|
||||
import textwrap
|
||||
import unittest
|
||||
|
||||
import gcmole
|
||||
@ -60,5 +63,248 @@ class FilesTest(unittest.TestCase):
|
||||
list(map(abs_test_file, expected)))
|
||||
|
||||
|
||||
GC = 'Foo,NowCollectAllTheGarbage'
|
||||
SP = 'Bar,SafepointSlowPath'
|
||||
WF = 'Baz,WriteField'
|
||||
|
||||
|
||||
class OutputLines:
|
||||
CALLERS_RE = re.compile(r'([\w,]+)\s*→\s*(.*)')
|
||||
|
||||
def __init__(self, *callee_list):
|
||||
"""Construct a test data placeholder for output lines of one invocation of
|
||||
the GCMole plugin.
|
||||
|
||||
Args:
|
||||
callee_list: Strings, each containing a caller/calle relationship
|
||||
formatted as "A → B C", meaning A calls B and C. For GC,
|
||||
Safepoint and a allow-listed function use GC, SP and WF
|
||||
constants above respectivly.
|
||||
Methods not calling anything are formatted as "A →".
|
||||
"""
|
||||
self.callee_list = callee_list
|
||||
|
||||
def lines(self):
|
||||
result = []
|
||||
for str_rep in self.callee_list:
|
||||
match = self.CALLERS_RE.match(str_rep)
|
||||
assert match
|
||||
result.append(match.group(1))
|
||||
for callee in (match.group(2) or '').split():
|
||||
result.append('\t' + callee)
|
||||
return result
|
||||
|
||||
|
||||
class SuspectCollectorTest(unittest.TestCase):
|
||||
|
||||
def create_collector(self, outputs):
|
||||
Options = collections.namedtuple('OptionsForCollector', ['allowlist'])
|
||||
options = Options(True)
|
||||
collector = gcmole.GCSuspectsCollector(options)
|
||||
for output in outputs:
|
||||
collector.parse(output.lines())
|
||||
collector.propagate()
|
||||
return collector
|
||||
|
||||
def check(self, outputs, expected_gc, expected_gc_caused):
|
||||
"""Verify the GCSuspectsCollector propagation and outputs against test
|
||||
data.
|
||||
|
||||
Args:
|
||||
outputs: List of OutputLines object simulating the lines returned by
|
||||
the GCMole plugin in drop-callees mode. Each output lines object
|
||||
represents one plugin invocation.
|
||||
expected_gc: Mapping as expected by GCSuspectsCollector.gc.
|
||||
expected_gc_caused: Mapping as expected by GCSuspectsCollector.gc_caused.
|
||||
"""
|
||||
collector = self.create_collector(outputs)
|
||||
self.assertDictEqual(collector.gc, expected_gc)
|
||||
self.assertDictEqual(collector.gc_caused, expected_gc_caused)
|
||||
|
||||
def testNoGC(self):
|
||||
self.check(
|
||||
outputs=[OutputLines()],
|
||||
expected_gc={},
|
||||
expected_gc_caused={},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines('A →')],
|
||||
expected_gc={},
|
||||
expected_gc_caused={},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines('A →', 'B →')],
|
||||
expected_gc={},
|
||||
expected_gc_caused={},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines('A → B C')],
|
||||
expected_gc={},
|
||||
expected_gc_caused={},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines('A → B', 'B → C')],
|
||||
expected_gc={},
|
||||
expected_gc_caused={},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines('A → B C', 'B → D', 'D → A', 'C →')],
|
||||
expected_gc={},
|
||||
expected_gc_caused={},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines('A →'), OutputLines('B →')],
|
||||
expected_gc={},
|
||||
expected_gc_caused={},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines('A → B'), OutputLines('B → C')],
|
||||
expected_gc={},
|
||||
expected_gc_caused={},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines('A → B C'),
|
||||
OutputLines('B → D', 'D → A'),
|
||||
OutputLines('C →')],
|
||||
expected_gc={},
|
||||
expected_gc_caused={},
|
||||
)
|
||||
|
||||
def testGCOneFile(self):
|
||||
self.check(
|
||||
outputs=[OutputLines(f'{GC} →')],
|
||||
expected_gc={GC: True},
|
||||
expected_gc_caused={GC: {'<GC>'}},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines(f'A → {GC}')],
|
||||
expected_gc={GC: True, 'A': True},
|
||||
expected_gc_caused={'A': {GC}, GC: {'<GC>'}},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines(f'A → {GC}', 'B → A')],
|
||||
expected_gc={GC: True, 'A': True, 'B': True},
|
||||
expected_gc_caused={'B': {'A'}, 'A': {GC}, GC: {'<GC>'}},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines('B → A', f'A → {GC}')],
|
||||
expected_gc={GC: True, 'A': True, 'B': True},
|
||||
expected_gc_caused={'B': {'A'}, 'A': {GC}, GC: {'<GC>'}},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines(f'A → B {GC}', 'B →', 'C → B A')],
|
||||
expected_gc={GC: True, 'A': True, 'C': True},
|
||||
expected_gc_caused={'C': {'A'}, 'A': {GC}, GC: {'<GC>'}},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines(f'A → {GC}', 'B → A', 'C → A', 'D → B C')],
|
||||
expected_gc={GC: True, 'A': True, 'B': True, 'C': True, 'D': True},
|
||||
expected_gc_caused={'C': {'A'}, 'A': {GC}, 'B': {'A'}, 'D': {'B', 'C'},
|
||||
GC: {'<GC>'}},
|
||||
)
|
||||
|
||||
def testAllowListOneFile(self):
|
||||
self.check(
|
||||
outputs=[OutputLines(f'{WF} →')],
|
||||
expected_gc={WF: False},
|
||||
expected_gc_caused={},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines(f'{WF} → {GC}')],
|
||||
expected_gc={GC: True, WF: False},
|
||||
expected_gc_caused={WF: {GC}, GC: {'<GC>'}},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines(f'A → {GC}', f'{WF} → A B', 'D → A B',
|
||||
f'E → {WF}')],
|
||||
expected_gc={GC: True, WF: False, 'A': True, 'D': True},
|
||||
expected_gc_caused={'A': {GC}, WF: {'A'}, 'D': {'A'}, GC: {'<GC>'}},
|
||||
)
|
||||
|
||||
def testSafepointOneFile(self):
|
||||
self.check(
|
||||
outputs=[OutputLines(f'{SP} →')],
|
||||
expected_gc={SP: True},
|
||||
expected_gc_caused={SP: {'<Safepoint>'}},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines('B → A', f'A → {SP}')],
|
||||
expected_gc={SP: True, 'A': True, 'B': True},
|
||||
expected_gc_caused={'B': {'A'}, 'A': {SP}, SP: {'<Safepoint>'}},
|
||||
)
|
||||
|
||||
def testCombinedOneFile(self):
|
||||
self.check(
|
||||
outputs=[OutputLines(f'{GC} →', f'{SP} →')],
|
||||
expected_gc={SP: True, GC: True},
|
||||
expected_gc_caused={SP: {'<Safepoint>'}, GC: {'<GC>'}},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines(f'A → {GC}', f'B → {SP}')],
|
||||
expected_gc={GC: True, SP: True, 'A': True, 'B': True},
|
||||
expected_gc_caused={'B': {SP}, 'A': {GC}, SP: {'<Safepoint>'},
|
||||
GC: {'<GC>'}},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines(f'A → {GC}', f'B → {SP}', 'C → D A B')],
|
||||
expected_gc={GC: True, SP: True, 'A': True, 'B': True, 'C': True},
|
||||
expected_gc_caused={'B': {SP}, 'A': {GC}, 'C': {'A', 'B'},
|
||||
SP: {'<Safepoint>'}, GC: {'<GC>'}},
|
||||
)
|
||||
|
||||
def testCombinedMoreFiles(self):
|
||||
self.check(
|
||||
outputs=[OutputLines(f'A → {GC}'), OutputLines(f'B → {SP}')],
|
||||
expected_gc={GC: True, SP: True, 'A': True, 'B': True},
|
||||
expected_gc_caused={'B': {SP}, 'A': {GC}, SP: {'<Safepoint>'},
|
||||
GC: {'<GC>'}},
|
||||
)
|
||||
self.check(
|
||||
outputs=[OutputLines(f'A → {GC}'), OutputLines(f'B → {SP}'),
|
||||
OutputLines('C → D A B')],
|
||||
expected_gc={GC: True, SP: True, 'A': True, 'B': True, 'C': True},
|
||||
expected_gc_caused={'B': {SP}, 'A': {GC}, 'C': {'A', 'B'},
|
||||
SP: {'<Safepoint>'}, GC: {'<GC>'}},
|
||||
)
|
||||
|
||||
def testWriteGCMoleResults(self):
|
||||
temp_dir = Path(tempfile.mkdtemp('gcmole_test'))
|
||||
Options = collections.namedtuple('OptionsForWriting', ['v8_target_cpu'])
|
||||
collector = self.create_collector(
|
||||
[OutputLines(f'A → {GC}'), OutputLines(f'B → {SP}')])
|
||||
gcmole.write_gcmole_results(collector, Options('x64'), temp_dir)
|
||||
|
||||
gcsuspects_expected = textwrap.dedent(f"""\
|
||||
{GC}
|
||||
{SP}
|
||||
A
|
||||
B
|
||||
""")
|
||||
|
||||
with open(temp_dir / 'gcsuspects') as f:
|
||||
self.assertEqual(f.read(), gcsuspects_expected)
|
||||
|
||||
gccauses_expected = textwrap.dedent(f"""
|
||||
{GC}
|
||||
start,nested
|
||||
<GC>
|
||||
end,nested
|
||||
{SP}
|
||||
start,nested
|
||||
<Safepoint>
|
||||
end,nested
|
||||
A
|
||||
start,nested
|
||||
{GC}
|
||||
end,nested
|
||||
B
|
||||
start,nested
|
||||
{SP}
|
||||
end,nested
|
||||
""").strip()
|
||||
|
||||
with open(temp_dir / 'gccauses') as f:
|
||||
self.assertEqual(f.read().strip(), gccauses_expected)
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
|
||||
Loading…
Reference in New Issue
Block a user