flake8/tests/unit/test_legacy_api.py
Lukasz Langa 01c0c648e1 Only require Mock on Python 3.4 and older. Use the builtin one elsewhere.
Mock 2.0 is using pbr which is hostile to environments without network access.
It's not required on Python 3.5+ so I made it possible to use `unittest.mock`
on this version.

Updated tox.ini to reflect this. Tested with 2.7.11, 3.3.6, 3.4.5, and 3.5.2 on
macOS 10.12.1 with tox and pyenv.
2016-11-27 15:13:30 -08:00

148 lines
4.6 KiB
Python

"""Tests for Flake8's legacy API."""
try:
import mock
except ImportError:
from unittest import mock
import pytest
from flake8.api import legacy as api
from flake8.formatting import base as formatter
def test_get_style_guide():
"""Verify the methods called on our internal Application."""
mockedapp = mock.Mock()
with mock.patch('flake8.main.application.Application') as Application:
Application.return_value = mockedapp
style_guide = api.get_style_guide()
Application.assert_called_once_with()
mockedapp.find_plugins.assert_called_once_with()
mockedapp.register_plugin_options.assert_called_once_with()
mockedapp.parse_configuration_and_cli.assert_called_once_with([])
mockedapp.make_formatter.assert_called_once_with()
mockedapp.make_notifier.assert_called_once_with()
mockedapp.make_guide.assert_called_once_with()
mockedapp.make_file_checker_manager.assert_called_once_with()
assert isinstance(style_guide, api.StyleGuide)
def test_styleguide_options():
"""Show tha we proxy the StyleGuide.options attribute."""
app = mock.Mock()
app.options = 'options'
style_guide = api.StyleGuide(app)
assert style_guide.options == 'options'
def test_styleguide_paths():
"""Show tha we proxy the StyleGuide.paths attribute."""
app = mock.Mock()
app.paths = 'paths'
style_guide = api.StyleGuide(app)
assert style_guide.paths == 'paths'
def test_styleguide_check_files():
"""Verify we call the right application methods."""
paths = ['foo', 'bar']
app = mock.Mock()
style_guide = api.StyleGuide(app)
report = style_guide.check_files(paths)
app.run_checks.assert_called_once_with(paths)
app.report_errors.assert_called_once_with()
assert isinstance(report, api.Report)
def test_styleguide_excluded():
"""Verify we delegate to our file checker manager.
We also want to ensure that if we don't specify a parent, is_path_excluded
is called exactly once.
"""
app = mock.Mock()
file_checker_manager = app.file_checker_manager = mock.Mock()
style_guide = api.StyleGuide(app)
style_guide.excluded('file.py')
file_checker_manager.is_path_excluded.assert_called_once_with('file.py')
def test_styleguide_excluded_with_parent():
"""Verify we delegate to our file checker manager.
When we add the parent argument, we don't check that is_path_excluded was
called only once.
"""
app = mock.Mock()
file_checker_manager = app.file_checker_manager = mock.Mock()
style_guide = api.StyleGuide(app)
style_guide.excluded('file.py', 'parent')
file_checker_manager.is_path_excluded.call_args == [
('file.py',),
('parent/file.py',),
]
def test_styleguide_init_report_does_nothing():
"""Verify if we use None that we don't call anything."""
app = mock.Mock()
style_guide = api.StyleGuide(app)
style_guide.init_report()
assert app.make_formatter.called is False
assert app.make_guide.called is False
def test_styleguide_init_report_with_non_subclass():
"""Verify we raise a ValueError with non BaseFormatter subclasses."""
app = mock.Mock()
style_guide = api.StyleGuide(app)
with pytest.raises(ValueError):
style_guide.init_report(object)
assert app.make_formatter.called is False
assert app.make_guide.called is False
def test_styleguide_init_report():
"""Verify we do the right incantation for the Application."""
app = mock.Mock(guide='fake')
style_guide = api.StyleGuide(app)
class FakeFormatter(formatter.BaseFormatter):
def format(self, *args):
pass
style_guide.init_report(FakeFormatter)
app.make_formatter.assert_called_once_with(FakeFormatter)
assert app.guide is None
app.make_guide.assert_called_once_with()
def test_styleguide_input_file():
"""Verify we call StyleGuide.check_files with the filename."""
app = mock.Mock()
style_guide = api.StyleGuide(app)
with mock.patch.object(style_guide, 'check_files') as check_files:
style_guide.input_file('file.py')
check_files.assert_called_once_with(['file.py'])
def test_report_total_errors():
"""Verify total errors is just a proxy attribute."""
app = mock.Mock(result_count='Fake count')
report = api.Report(app)
assert report.total_errors == 'Fake count'
def test_report_get_statistics():
"""Verify that we use the statistics object."""
stats = mock.Mock()
stats.statistics_for.return_value = []
style_guide = mock.Mock(stats=stats)
app = mock.Mock(guide=style_guide)
report = api.Report(app)
assert report.get_statistics('E') == []
stats.statistics_for.assert_called_once_with('E')