def test_diff_with_nonexistent_file(self):
output_file = io.StringIO()
docformatter._main(argv=['my_fake_program', 'nonexistent_file'],
standard_out=output_file,
standard_error=output_file,
standard_in=None)
self.assertIn('no such file', output_file.getvalue().lower())
def test_diff_with_nonexistent_file(self):
output_file = io.StringIO()
docformatter._main(argv=['my_fake_program', 'nonexistent_file'],
standard_out=output_file,
standard_error=output_file,
standard_in=None)
self.assertIn('no such file', output_file.getvalue().lower())
def test_in_place(self):
with temporary_file('''\
def foo():
"""
Hello world
"""
''') as filename:
output_file = io.StringIO()
docformatter._main(argv=['my_fake_program', '--in-place', filename],
standard_out=output_file,
standard_error=None)
with open(filename) as f:
self.assertEqual('''\
def foo():
"""Hello world."""
''', f.read())
def test_io_error_exit_code(self):
stderr = io.StringIO()
ret_code = docformatter._main(
argv=['my_fake_program', 'this_file_should_not_exist_please'],
standard_out=None,
standard_error=stderr,
standard_in=None)
self.assertEqual(ret_code, 1)
def test_in_place(self):
with temporary_file('''\
def foo():
"""
Hello world
"""
''') as filename:
output_file = io.StringIO()
docformatter._main(
argv=['my_fake_program', '--in-place', filename],
standard_out=output_file,
standard_error=None,
standard_in=None)
with open(filename) as f:
self.assertEqual('''\
def foo():
"""Hello world."""
''', f.read())
def test_diff(self):
with temporary_file('''\
def foo():
"""
Hello world
"""
''') as filename:
output_file = io.StringIO()
docformatter._main(argv=['my_fake_program', filename],
standard_out=output_file,
standard_error=None)
self.assertEqual('''\
@@ -1,4 +1,2 @@
def foo():
- """
- Hello world
- """
+ """Hello world."""
''', '\n'.join(output_file.getvalue().split('\n')[2:]))
def test_ignore_hidden_directories(self):
with temporary_directory() as directory:
with temporary_directory(prefix='.',
directory=directory) as inner_directory:
with temporary_file('''\
def foo():
"""
Hello world
"""
''',
directory=inner_directory):
output_file = io.StringIO()
docformatter._main(
argv=['my_fake_program', '--recursive', directory],
standard_out=output_file,
standard_error=None,
standard_in=None)
self.assertEqual('', output_file.getvalue().strip())
def test_ignore_hidden_directories(self):
with temporary_directory() as directory:
with temporary_directory(prefix='.',
directory=directory) as inner_directory:
with temporary_file('''\
def foo():
"""
Hello world
"""
''', directory=inner_directory):
output_file = io.StringIO()
docformatter._main(argv=['my_fake_program', '--recursive',
directory],
standard_out=output_file,
standard_error=None)
self.assertEqual(
'',
output_file.getvalue().strip())
def test_diff(self):
with temporary_file('''\
def foo():
"""
Hello world
"""
''') as filename:
output_file = io.StringIO()
docformatter._main(argv=['my_fake_program', filename],
standard_out=output_file,
standard_error=None,
standard_in=None)
self.assertEqual('''\
@@ -1,4 +1,2 @@
def foo():
- """
- Hello world
- """
+ """Hello world."""
''', '\n'.join(output_file.getvalue().split('\n')[2:]))
def test_check_mode_correct_docstring(self):
with temporary_file('''
"""Totally fine docstring, do not report anything."""
''') as filename:
stdout = io.StringIO()
stderr = io.StringIO()
ret_code = docformatter._main(
argv=['my_fake_program', '--check', filename],
standard_out=stdout, standard_error=stderr, standard_in=None)
self.assertEqual(ret_code, 0,
msg='Exit code should be 0') # FormatResult.ok
self.assertEqual(stdout.getvalue(), '',
msg='Do not write to stdout')
self.assertEqual(stderr.getvalue(), '',
msg='Do not write to stderr')
def test_check_mode_correct_docstring(self):
with temporary_file('''
"""Totally fine docstring, do not report anything."""
''') as filename:
stdout = io.StringIO()
stderr = io.StringIO()
ret_code = docformatter._main(
argv=['my_fake_program', '--check', filename],
standard_out=stdout, standard_error=stderr, standard_in=None)
self.assertEqual(ret_code, 0,
msg='Exit code should be 0') # FormatResult.ok
self.assertEqual(stdout.getvalue(), '',
msg='Do not write to stdout')
self.assertEqual(stderr.getvalue(), '',
msg='Do not write to stderr')
def test_check_mode_incorrect_docstring(self):
with temporary_file('''
"""
Print my path and return error code
""" ''') as filename:
stdout = io.StringIO()
stderr = io.StringIO()
ret_code = docformatter._main(
argv=['my_fake_program', '--check', filename],
standard_out=stdout, standard_error=stderr, standard_in=None)
self.assertEqual(ret_code, 3,
msg='Exit code should be 3') # FormatResult.check_failed
self.assertEqual(stdout.getvalue(), '',
msg='Do not write to stdout')
self.assertEqual(stderr.getvalue().strip(), filename,
msg='Changed file should be reported')
def test_check_mode_incorrect_docstring(self):
with temporary_file('''
"""
Print my path and return error code
""" ''') as filename:
stdout = io.StringIO()
stderr = io.StringIO()
ret_code = docformatter._main(
argv=['my_fake_program', '--check', filename],
standard_out=stdout, standard_error=stderr, standard_in=None)
self.assertEqual(ret_code, 3,
msg='Exit code should be 3') # FormatResult.check_failed
self.assertEqual(stdout.getvalue(), '',
msg='Do not write to stdout')
self.assertEqual(stderr.getvalue().strip(), filename,
msg='Changed file should be reported')
def test_io_error_exit_code(self):
stderr = io.StringIO()
ret_code = docformatter._main(
argv=['my_fake_program', 'this_file_should_not_exist_please'],
standard_out=None, standard_error=stderr, standard_in=None)
self.assertEqual(ret_code, 1)
