def _test_reporter(api, analyzers):
# Always use the same setup, only varies the analyzers
revision = PhabricatorRevision('PHID-DIFF-abcdef', api)
revision.lines = {
'test.cpp': [41, 42, 43],
}
reporter = PhabricatorReporter({'analyzers': analyzers}, api=api)
issues = [
ClangFormatIssue('test.cpp', 42, 1, revision),
ClangTidyIssue(('test.cpp', '42', '51', 'error', 'dummy message', 'modernize-use-nullptr'), revision),
InferIssue({
'file': 'test.cpp',
'line': 42,
'column': 1,
'bug_type': 'dummy',
'kind': 'whatever',
'qualifier': 'dummy message.',
}, revision),
MozLintIssue('test.cpp', 1, 'danger', 42, 'flake8', 'Python error', 'EXXX', revision),
]
assert all(i.is_publishable() for i in issues)
revision.improvement_patches = {
'dummy': 'not gonna work',
'clang-format': 'https://diff.url/clang-format',
'clang-tidy': 'https://diff.url/clang-tidy',
'mozlint': 'https://diff.url/mozlint',
'infer': 'https://diff.url/infer',
}
return reporter.publish(issues, revision)
def test_phabricator_clang_format(mock_repository, mock_phabricator):
'''
Test Phabricator reporter publication on a mock clang-format issue
'''
from static_analysis_bot.report.phabricator import PhabricatorReporter
from static_analysis_bot.revisions import PhabricatorRevision
from static_analysis_bot.clang.format import ClangFormatIssue
def _check_comment(request):
# Check the Phabricator main comment is well formed
payload = urllib.parse.parse_qs(request.body)
assert payload['output'] == ['json']
assert len(payload['params']) == 1
details = json.loads(payload['params'][0])
assert details['message'] == VALID_CLANG_FORMAT_MESSAGE
# Outputs dummy empty response
resp = {
'error_code': None,
'result': None,
}
return 201, {
'Content-Type': 'application/json',
'unittest': 'clang-format'
}, json.dumps(resp)
responses.add_callback(
responses.POST,
'http://phabricator.test/api/differential.createcomment',
callback=_check_comment,
)
with mock_phabricator as api:
revision = PhabricatorRevision('PHID-DIFF-abcdef', api)
revision.lines = {
# Add dummy lines diff
'test.cpp': [41, 42, 43],
'dom/test.cpp': [
42,
],
}
reporter = PhabricatorReporter({'analyzers': ['clang-format']},
api=api)
issue = ClangFormatIssue('dom/test.cpp', 42, 1, revision)
assert issue.is_publishable()
revision.improvement_patches = {'clang-format': 'https://diff.url'}
issues, patches = reporter.publish([
issue,
], revision)
assert len(issues) == 1
assert len(patches) == 1
# Check the callback has been used
assert len(responses.calls) > 0
call = responses.calls[-1]
assert call.request.url == 'http://phabricator.test/api/differential.createcomment'
assert call.response.headers.get('unittest') == 'clang-format'
def test_phabricator_coverage(mock_config, mock_phabricator, mock_try_task):
'''
Test Phabricator reporter publication on a mock coverage issue
'''
from static_analysis_bot.report.phabricator import PhabricatorReporter
from static_analysis_bot.revisions import Revision
from static_analysis_bot.tasks.coverage import CoverageIssue
def _check_comment(request):
# Check the Phabricator main comment is well formed
payload = urllib.parse.parse_qs(request.body)
assert payload['output'] == ['json']
assert len(payload['params']) == 1
details = json.loads(payload['params'][0])
assert details['message'] == VALID_COVERAGE_MESSAGE.format(
results=mock_config.taskcluster.results_dir)
# Outputs dummy empty response
resp = {
'error_code': None,
'result': None,
}
return 201, {
'Content-Type': 'application/json',
'unittest': 'coverage'
}, json.dumps(resp)
responses.add_callback(
responses.POST,
'http://phabricator.test/api/differential.createcomment',
callback=_check_comment,
)
with mock_phabricator as api:
revision = Revision(api, mock_try_task)
revision.lines = {
# Add dummy lines diff
'test.txt': [0],
'test.cpp': [0],
'dom/test.cpp': [
42,
],
}
reporter = PhabricatorReporter({'analyzers': ['coverage']}, api=api)
issue = CoverageIssue('test.cpp', 0, 'This file is uncovered', revision)
assert issue.is_publishable()
issues, patches = reporter.publish([
issue,
], revision)
assert len(issues) == 1
assert len(patches) == 0
# Check the callback has been used
assert len(responses.calls) > 0
call = responses.calls[-1]
assert call.request.url == 'http://phabricator.test/api/differential.createcomment'
assert call.response.headers.get('unittest') == 'coverage'
def test_phabricator_clang_format(mock_config, mock_repository, mock_phabricator):
'''
Test Phabricator reporter publication on a mock clang-format issue
'''
from static_analysis_bot.report.phabricator import PhabricatorReporter
from static_analysis_bot.revisions import PhabricatorRevision, ImprovementPatch
from static_analysis_bot.clang.format import ClangFormatIssue
def _check_comment(request):
# Check the Phabricator main comment is well formed
payload = urllib.parse.parse_qs(request.body)
assert payload['output'] == ['json']
assert len(payload['params']) == 1
details = json.loads(payload['params'][0])
assert details['message'] == VALID_CLANG_FORMAT_MESSAGE.format(results=mock_config.taskcluster.results_dir)
# Outputs dummy empty response
resp = {
'error_code': None,
'result': None,
}
return 201, {'Content-Type': 'application/json', 'unittest': 'clang-format'}, json.dumps(resp)
responses.add_callback(
responses.POST,
'http://phabricator.test/api/differential.createcomment',
callback=_check_comment,
)
with mock_phabricator as api:
revision = PhabricatorRevision(api, 'PHID-DIFF-abcdef')
revision.lines = {
# Add dummy lines diff
'test.cpp': [41, 42, 43],
'dom/test.cpp': [42, ],
}
reporter = PhabricatorReporter({'analyzers': ['clang-format']}, api=api)
issue = ClangFormatIssue('dom/test.cpp', 42, 1, revision)
assert issue.is_publishable()
revision.improvement_patches = [
ImprovementPatch('clang-format', repr(revision), 'Some lint fixes'),
]
list(map(lambda p: p.write(), revision.improvement_patches)) # trigger local write
issues, patches = reporter.publish([issue, ], revision)
assert len(issues) == 1
assert len(patches) == 1
# Check the callback has been used
assert len(responses.calls) > 0
call = responses.calls[-1]
assert call.request.url == 'http://phabricator.test/api/differential.createcomment'
assert call.response.headers.get('unittest') == 'clang-format'
def test_phabricator_clang_tidy(mock_repository, mock_phabricator):
'''
Test Phabricator reporter publication on a mock clang-tidy issue
'''
from static_analysis_bot.report.phabricator import PhabricatorReporter
from static_analysis_bot.revisions import PhabricatorRevision
from static_analysis_bot.clang.tidy import ClangTidyIssue
def _check_comment(request):
# Check the Phabricator main comment is well formed
payload = urllib.parse.parse_qs(request.body)
assert payload['output'] == ['json']
assert len(payload['params']) == 1
details = json.loads(payload['params'][0])
assert details == {
'revision_id': 51,
'message': VALID_CLANG_TIDY_MESSAGE,
'attach_inlines': 1,
'__conduit__': {'token': 'deadbeef'},
}
# Outputs dummy empty response
resp = {
'error_code': None,
'result': None,
}
return 201, {'Content-Type': 'application/json', 'unittest': 'clang-tidy'}, json.dumps(resp)
responses.add_callback(
responses.POST,
'http://phabricator.test/api/differential.createcomment',
callback=_check_comment,
)
with mock_phabricator as api:
revision = PhabricatorRevision('PHID-DIFF-abcdef', api)
revision.lines = {
# Add dummy lines diff
'test.cpp': [41, 42, 43],
}
reporter = PhabricatorReporter({'analyzers': ['clang-tidy']}, api=api)
issue_parts = ('test.cpp', '42', '51', 'error', 'dummy message', 'modernize-use-nullptr')
issue = ClangTidyIssue(issue_parts, revision)
assert issue.is_publishable()
issues, patches = reporter.publish([issue, ], revision)
assert len(issues) == 1
assert len(patches) == 0
# Check the callback has been used
assert len(responses.calls) > 0
call = responses.calls[-1]
assert call.request.url == 'http://phabricator.test/api/differential.createcomment'
assert call.response.headers.get('unittest') == 'clang-tidy'
def test_phabricator_clang_tidy(mock_repository, mock_phabricator):
'''
Test Phabricator reporter publication on a mock clang-tidy issue
'''
from static_analysis_bot.report.phabricator import PhabricatorReporter
from static_analysis_bot.revisions import PhabricatorRevision
from static_analysis_bot.clang.tidy import ClangTidyIssue
def _check_comment(request):
# Check the Phabricator main comment is well formed
payload = urllib.parse.parse_qs(request.body)
assert payload['output'] == ['json']
assert len(payload['params']) == 1
details = json.loads(payload['params'][0])
assert details == {
'revision_id': 51,
'message': VALID_CLANG_TIDY_MESSAGE,
'attach_inlines': 1,
'__conduit__': {'token': 'deadbeef'},
}
# Outputs dummy empty response
resp = {
'error_code': None,
'result': None,
}
return 201, {'Content-Type': 'application/json', 'unittest': 'clang-tidy'}, json.dumps(resp)
responses.add_callback(
responses.POST,
'http://phabricator.test/api/differential.createcomment',
callback=_check_comment,
)
with mock_phabricator as api:
revision = PhabricatorRevision(api, 'PHID-DIFF-abcdef')
revision.lines = {
# Add dummy lines diff
'test.cpp': [41, 42, 43],
}
reporter = PhabricatorReporter({'analyzers': ['clang-tidy'], 'modes': ('comment')}, api=api)
issue = ClangTidyIssue(revision, 'test.cpp', '42', '51', 'modernize-use-nullptr', 'dummy message', 'error')
assert issue.is_publishable()
issues, patches = reporter.publish([issue, ], revision)
assert len(issues) == 1
assert len(patches) == 0
# Check the callback has been used
assert len(responses.calls) > 0
call = responses.calls[-1]
assert call.request.url == 'http://phabricator.test/api/differential.createcomment'
assert call.response.headers.get('unittest') == 'clang-tidy'
def test_phabricator_coverage(mock_config, mock_repository, mock_phabricator):
'''
Test Phabricator reporter publication on a mock coverage issue
'''
from static_analysis_bot.report.phabricator import PhabricatorReporter
from static_analysis_bot.revisions import PhabricatorRevision
from static_analysis_bot.coverage import CoverageIssue
def _check_comment(request):
# Check the Phabricator main comment is well formed
payload = urllib.parse.parse_qs(request.body)
assert payload['output'] == ['json']
assert len(payload['params']) == 1
details = json.loads(payload['params'][0])
assert details['message'] == VALID_COVERAGE_MESSAGE.format(results=mock_config.taskcluster.results_dir)
# Outputs dummy empty response
resp = {
'error_code': None,
'result': None,
}
return 201, {'Content-Type': 'application/json', 'unittest': 'coverage'}, json.dumps(resp)
responses.add_callback(
responses.POST,
'http://phabricator.test/api/differential.createcomment',
callback=_check_comment,
)
with mock_phabricator as api:
revision = PhabricatorRevision(api, 'PHID-DIFF-abcdef')
revision.lines = {
# Add dummy lines diff
'test.txt': [0],
'test.cpp': [0],
'dom/test.cpp': [42, ],
}
reporter = PhabricatorReporter({'analyzers': ['coverage']}, api=api)
issue = CoverageIssue('test.cpp', 0, 'This file is uncovered', revision)
assert issue.is_publishable()
issues, patches = reporter.publish([issue, ], revision)
assert len(issues) == 1
assert len(patches) == 0
# Check the callback has been used
assert len(responses.calls) > 0
call = responses.calls[-1]
assert call.request.url == 'http://phabricator.test/api/differential.createcomment'
assert call.response.headers.get('unittest') == 'coverage'
def _test_reporter(api, analyzers):
# Always use the same setup, only varies the analyzers
revision = Revision(api, mock_try_task)
revision.lines = {
'test.cpp': [0, 41, 42, 43],
'dom/test.cpp': [
42,
],
}
reporter = PhabricatorReporter({'analyzers': analyzers}, api=api)
issues = [
ClangFormatIssue('dom/test.cpp', 42, 1, revision),
ClangTidyIssue(revision, 'test.cpp', '42', '51',
'modernize-use-nullptr', 'dummy message', 'error'),
InferIssue(
{
'file': 'test.cpp',
'line': 42,
'column': 1,
'bug_type': 'dummy',
'kind': 'whatever',
'qualifier': 'dummy message.',
}, revision),
MozLintIssue('test.cpp', 1, 'danger', 42, 'flake8', 'Python error',
'EXXX', revision),
CoverageIssue('test.cpp', 0, 'This file is uncovered', revision),
]
assert all(i.is_publishable() for i in issues)
revision.improvement_patches = [
ImprovementPatch('dummy', repr(revision), 'Whatever'),
ImprovementPatch('clang-tidy', repr(revision), 'Some C fixes'),
ImprovementPatch('clang-format', repr(revision),
'Some lint fixes'),
ImprovementPatch('infer', repr(revision), 'Some java fixes'),
ImprovementPatch('mozlint', repr(revision), 'Some js fixes'),
]
list(map(lambda p: p.write(),
revision.improvement_patches)) # trigger local write
return reporter.publish(issues, revision)
def _test_reporter(api, analyzers):
# Always use the same setup, only varies the analyzers
revision = PhabricatorRevision(api, 'PHID-DIFF-abcdef')
revision.lines = {
'test.cpp': [0, 41, 42, 43],
'dom/test.cpp': [42, ],
}
reporter = PhabricatorReporter({'analyzers': analyzers}, api=api)
issues = [
ClangFormatIssue('dom/test.cpp', 42, 1, revision),
ClangTidyIssue(revision, 'test.cpp', '42', '51', 'modernize-use-nullptr', 'dummy message', 'error'),
InferIssue({
'file': 'test.cpp',
'line': 42,
'column': 1,
'bug_type': 'dummy',
'kind': 'whatever',
'qualifier': 'dummy message.',
}, revision),
MozLintIssue('test.cpp', 1, 'danger', 42, 'flake8', 'Python error', 'EXXX', revision),
CoverageIssue('test.cpp', 0, 'This file is uncovered', revision),
]
assert all(i.is_publishable() for i in issues)
revision.improvement_patches = [
ImprovementPatch('dummy', repr(revision), 'Whatever'),
ImprovementPatch('clang-tidy', repr(revision), 'Some C fixes'),
ImprovementPatch('clang-format', repr(revision), 'Some lint fixes'),
ImprovementPatch('infer', repr(revision), 'Some java fixes'),
ImprovementPatch('mozlint', repr(revision), 'Some js fixes'),
]
list(map(lambda p: p.write(), revision.improvement_patches)) # trigger local write
return reporter.publish(issues, revision)
def test_phabricator_harbormaster(mock_repository, mock_phabricator):
'''
Test Phabricator reporter publication on a mock clang-tidy issue
using harbormaster
'''
from static_analysis_bot.report.phabricator import PhabricatorReporter
from static_analysis_bot.revisions import PhabricatorRevision
from static_analysis_bot.clang.tidy import ClangTidyIssue
def _check_message(request):
# Check the Phabricator main comment is well formed
payload = urllib.parse.parse_qs(request.body)
assert payload['output'] == ['json']
assert len(payload['params']) == 1
details = json.loads(payload['params'][0])
assert details == {
'buildTargetPHID': 'PHID-HMBD-deadbeef12456',
'lint': [
{
'char': 51,
'code': 'clang-tidy.modernize-use-nullptr',
'name': 'Clang-Tidy - modernize-use-nullptr',
'line': 42,
'path': 'test.cpp',
'severity': 'warning',
'description': 'dummy message'
}
],
'unit': [],
'type': 'work',
'__conduit__': {'token': 'deadbeef'},
}
# Outputs dummy empty response
resp = {
'error_code': None,
'result': None,
}
return 201, {'Content-Type': 'application/json', 'unittest': 'clang-tidy'}, json.dumps(resp)
responses.add_callback(
responses.POST,
'http://phabricator.test/api/harbormaster.sendmessage',
callback=_check_message,
)
with mock_phabricator as api:
revision = PhabricatorRevision(api, 'PHID-DIFF-abcdef')
revision.lines = {
# Add dummy lines diff
'test.cpp': [41, 42, 43],
}
revision.build_target_phid = 'PHID-HMBD-deadbeef12456'
reporter = PhabricatorReporter({'analyzers': ['clang-tidy'], 'mode': 'harbormaster'}, api=api)
issue = ClangTidyIssue(revision, 'test.cpp', '42', '51', 'modernize-use-nullptr', 'dummy message', 'error')
assert issue.is_publishable()
issues, patches = reporter.publish([issue, ], revision)
assert len(issues) == 1
assert len(patches) == 0
# Check the callback has been used
assert len(responses.calls) > 0
call = responses.calls[-1]
assert call.request.url == 'http://phabricator.test/api/harbormaster.sendmessage'
assert call.response.headers.get('unittest') == 'clang-tidy'
def test_phabricator_harbormaster(mock_phabricator, mock_try_task):
'''
Test Phabricator reporter publication on a mock clang-tidy issue
using harbormaster
'''
from static_analysis_bot.report.phabricator import PhabricatorReporter
from static_analysis_bot.revisions import Revision
from static_analysis_bot.tasks.clang_tidy import ClangTidyIssue
def _check_message(request):
# Check the Phabricator main comment is well formed
payload = urllib.parse.parse_qs(request.body)
assert payload['output'] == ['json']
assert len(payload['params']) == 1
details = json.loads(payload['params'][0])
assert details == {
'buildTargetPHID':
'PHID-HMBD-deadbeef12456',
'lint': [{
'char': 51,
'code': 'clang-tidy.modernize-use-nullptr',
'name': 'Clang-Tidy - modernize-use-nullptr',
'line': 42,
'path': 'test.cpp',
'severity': 'warning',
'description': 'dummy message'
}],
'unit': [],
'type':
'work',
'__conduit__': {
'token': 'deadbeef'
},
}
# Outputs dummy empty response
resp = {
'error_code': None,
'result': None,
}
return 201, {
'Content-Type': 'application/json',
'unittest': 'clang-tidy'
}, json.dumps(resp)
responses.add_callback(
responses.POST,
'http://phabricator.test/api/harbormaster.sendmessage',
callback=_check_message,
)
with mock_phabricator as api:
revision = Revision(api, mock_try_task)
revision.lines = {
# Add dummy lines diff
'test.cpp': [41, 42, 43],
}
revision.build_target_phid = 'PHID-HMBD-deadbeef12456'
reporter = PhabricatorReporter(
{
'analyzers': ['clang-tidy'],
'mode': 'harbormaster'
}, api=api)
issue = ClangTidyIssue(revision, 'test.cpp', '42', '51',
'modernize-use-nullptr', 'dummy message', 'error')
assert issue.is_publishable()
issues, patches = reporter.publish([
issue,
], revision)
assert len(issues) == 1
assert len(patches) == 0
# Check the callback has been used
assert len(responses.calls) > 0
call = responses.calls[-1]
assert call.request.url == 'http://phabricator.test/api/harbormaster.sendmessage'
assert call.response.headers.get('unittest') == 'clang-tidy'
def test_phabricator_clang_tidy_and_coverage(mock_config, mock_phabricator,
mock_try_task):
'''
Test Phabricator reporter publication on a mock coverage issue
'''
from static_analysis_bot.report.phabricator import PhabricatorReporter
from static_analysis_bot.revisions import Revision
from static_analysis_bot.tasks.coverage import CoverageIssue
from static_analysis_bot.tasks.clang_tidy import ClangTidyIssue
def _check_comment_sa(request):
# Check the Phabricator main comment is well formed
payload = urllib.parse.parse_qs(request.body)
assert payload['output'] == ['json']
assert len(payload['params']) == 1
details = json.loads(payload['params'][0])
assert details == {
'revision_id': 51,
'message': VALID_CLANG_TIDY_MESSAGE,
'attach_inlines': 1,
'__conduit__': {
'token': 'deadbeef'
},
}
# Outputs dummy empty response
resp = {
'error_code': None,
'result': None,
}
return 201, {
'Content-Type': 'application/json',
'unittest': 'clang-tidy'
}, json.dumps(resp)
def _check_comment_ccov(request):
# Check the Phabricator main comment is well formed
payload = urllib.parse.parse_qs(request.body)
assert payload['output'] == ['json']
assert len(payload['params']) == 1
details = json.loads(payload['params'][0])
assert details['message'] == VALID_COVERAGE_MESSAGE.format(
results=mock_config.taskcluster.results_dir)
# Outputs dummy empty response
resp = {
'error_code': None,
'result': None,
}
return 201, {
'Content-Type': 'application/json',
'unittest': 'coverage'
}, json.dumps(resp)
responses.add_callback(
responses.POST,
'http://phabricator.test/api/differential.createcomment',
callback=_check_comment_sa,
)
responses.add_callback(
responses.POST,
'http://phabricator.test/api/differential.createcomment',
callback=_check_comment_ccov,
)
with mock_phabricator as api:
revision = Revision(api, mock_try_task)
revision.lines = {
# Add dummy lines diff
'test.txt': [0],
'test.cpp': [0],
'another_test.cpp': [41, 42, 43],
}
revision.files = ['test.txt', 'test.cpp', 'another_test.cpp']
reporter = PhabricatorReporter(
{'analyzers': ['coverage', 'clang-tidy']}, api=api)
issue_clang_tidy = ClangTidyIssue(revision, 'another_test.cpp', '42', '51',
'modernize-use-nullptr', 'dummy message',
'error')
assert issue_clang_tidy.is_publishable()
issue_coverage = CoverageIssue('test.cpp', 0, 'This file is uncovered',
revision)
assert issue_coverage.is_publishable()
issues, patches = reporter.publish([
issue_clang_tidy,
issue_coverage,
], revision)
assert len(issues) == 2
assert len(patches) == 0
# Check the callback has been used
assert len(responses.calls) > 0
call = responses.calls[-2]
assert call.request.url == 'http://phabricator.test/api/differential.createcomment'
assert call.response.headers.get('unittest') == 'clang-tidy'
# Check the callback has been used
assert len(responses.calls) > 0
call = responses.calls[-1]
assert call.request.url == 'http://phabricator.test/api/differential.createcomment'
assert call.response.headers.get('unittest') == 'coverage'
def test_phabricator_clang_format(mock_config, mock_phabricator,
mock_try_task):
'''
Test Phabricator reporter publication on a mock clang-format issue
'''
from static_analysis_bot.report.phabricator import PhabricatorReporter
from static_analysis_bot.revisions import Revision, ImprovementPatch
from static_analysis_bot.tasks.clang_format import ClangFormatIssue
def _check_comment(request):
# Check the Phabricator main comment is well formed
payload = urllib.parse.parse_qs(request.body)
assert payload['output'] == ['json']
assert len(payload['params']) == 1
details = json.loads(payload['params'][0])
assert details['message'] == VALID_CLANG_FORMAT_MESSAGE.format(
results=mock_config.taskcluster.results_dir)
# Outputs dummy empty response
resp = {
'error_code': None,
'result': None,
}
return 201, {
'Content-Type': 'application/json',
'unittest': 'clang-format'
}, json.dumps(resp)
responses.add_callback(
responses.POST,
'http://phabricator.test/api/differential.createcomment',
callback=_check_comment,
)
with mock_phabricator as api:
revision = Revision(api, mock_try_task)
revision.lines = {
# Add dummy lines diff
'test.cpp': [41, 42, 43],
'dom/test.cpp': [
42,
],
}
reporter = PhabricatorReporter({'analyzers': ['clang-format']},
api=api)
issue = ClangFormatIssue('dom/test.cpp', 42, 1, revision)
assert issue.is_publishable()
revision.improvement_patches = [
ImprovementPatch('clang-format', repr(revision), 'Some lint fixes'),
]
list(map(lambda p: p.write(),
revision.improvement_patches)) # trigger local write
issues, patches = reporter.publish([
issue,
], revision)
assert len(issues) == 1
assert len(patches) == 1
# Check the callback has been used
assert len(responses.calls) > 0
call = responses.calls[-1]
assert call.request.url == 'http://phabricator.test/api/differential.createcomment'
assert call.response.headers.get('unittest') == 'clang-format'
