Add flakehell python linter (#3295) (#3921)

test/handler/test_flakehell_handler.vader

@@ -0,0 +1,276 @@
+Before:
+  Save g:ale_warn_about_trailing_blank_lines
+  Save g:ale_warn_about_trailing_whitespace
+
+  let g:ale_warn_about_trailing_blank_lines = 1
+  let g:ale_warn_about_trailing_whitespace = 1
+
+  runtime ale_linters/python/flakehell.vim
+
+After:
+  Restore
+
+  unlet! b:ale_warn_about_trailing_blank_lines
+  unlet! b:ale_warn_about_trailing_whitespace
+
+  call ale#linter#Reset()
+
+Execute(The flakehell handler should handle basic warnings and syntax errors):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 6,
+  \     'col': 6,
+  \     'vcol': 1,
+  \     'type': 'E',
+  \     'text': 'indentation is not a multiple of four',
+  \     'code': 'E111',
+  \     'sub_type': 'style',
+  \   },
+  \   {
+  \     'lnum': 7,
+  \     'col': 6,
+  \     'vcol': 1,
+  \     'type': 'W',
+  \     'text': 'some warning',
+  \     'code': 'W123',
+  \     'sub_type': 'style',
+  \   },
+  \   {
+  \     'lnum': 8,
+  \     'col': 3,
+  \     'vcol': 1,
+  \     'type': 'E',
+  \     'text': 'SyntaxError: invalid syntax',
+  \     'code': 'E999',
+  \   },
+  \ ],
+  \ ale_linters#python#flakehell#Handle(1, [
+  \   'stdin:6:6: E111 indentation is not a multiple of four',
+  \   'stdin:7:6: W123 some warning',
+  \   'stdin:8:3: E999 SyntaxError: invalid syntax',
+  \ ])
+
+Execute(The flakehell handler should set end column indexes for certain errors):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 25,
+  \     'col': 1,
+  \     'vcol': 1,
+  \     'type': 'E',
+  \     'end_col': 3,
+  \     'text': 'undefined name ''foo''',
+  \     'code': 'F821',
+  \   },
+  \   {
+  \     'lnum': 28,
+  \     'col': 5,
+  \     'vcol': 1,
+  \     'type': 'E',
+  \     'end_col': 9,
+  \     'text': 'hello may be undefined, or defined from star imports: x',
+  \     'code': 'F405',
+  \   },
+  \   {
+  \     'lnum': 104,
+  \     'col': 5,
+  \     'vcol': 1,
+  \     'type': 'E',
+  \     'end_col': 12,
+  \     'text': '''continue'' not properly in loop',
+  \     'code': 'F999',
+  \   },
+  \   {
+  \     'lnum': 106,
+  \     'col': 5,
+  \     'vcol': 1,
+  \     'type': 'E',
+  \     'end_col': 9,
+  \     'text': '''break'' outside loop',
+  \     'code': 'F999',
+  \   },
+  \   {
+  \     'lnum': 109,
+  \     'col': 5,
+  \     'vcol': 1,
+  \     'type': 'E',
+  \     'end_col': 8,
+  \     'text': 'local variable ''test'' is assigned to but never used',
+  \     'code': 'F841',
+  \   },
+  \ ],
+  \ ale_linters#python#flakehell#Handle(1, [
+  \ 'foo.py:25:1: F821 undefined name ''foo''',
+  \ 'foo.py:28:5: F405 hello may be undefined, or defined from star imports: x',
+  \ 'foo.py:104:5: F999 ''continue'' not properly in loop',
+  \ 'foo.py:106:5: F999 ''break'' outside loop',
+  \ 'foo.py:109:5: F841 local variable ''test'' is assigned to but never used',
+  \ ])
+
+Execute(The flakehell handler should handle stack traces):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 1,
+  \     'text': 'ImportError: No module named parser (See :ALEDetail)',
+  \     'detail': join([
+  \       'Traceback (most recent call last):',
+  \       '  File "/usr/local/bin/flakehell", line 7, in <module>',
+  \       '    from flakehell.main.cli import main',
+  \       '  File "/usr/local/lib/python2.7/dist-packages/flakehell/main/cli.py", line 2, in <module>',
+  \       '    from flakehell.main import application',
+  \       '  File "/usr/local/lib/python2.7/dist-packages/flakehell/main/application.py", line 17, in <module>',
+  \       '    from flakehell.plugins import manager as plugin_manager',
+  \       '  File "/usr/local/lib/python2.7/dist-packages/flakehell/plugins/manager.py", line 5, in <module>',
+  \       '    import pkg_resources',
+  \       '  File "/usr/lib/python2.7/dist-packages/pkg_resources/__init__.py", line 35, in <module>',
+  \       '    import email.parser',
+  \       'ImportError: No module named parser',
+  \     ], "\n"),
+  \   },
+  \ ],
+  \ ale_linters#python#flakehell#Handle(42, [
+  \   'Traceback (most recent call last):',
+  \   '  File "/usr/local/bin/flakehell", line 7, in <module>',
+  \   '    from flakehell.main.cli import main',
+  \   '  File "/usr/local/lib/python2.7/dist-packages/flakehell/main/cli.py", line 2, in <module>',
+  \   '    from flakehell.main import application',
+  \   '  File "/usr/local/lib/python2.7/dist-packages/flakehell/main/application.py", line 17, in <module>',
+  \   '    from flakehell.plugins import manager as plugin_manager',
+  \   '  File "/usr/local/lib/python2.7/dist-packages/flakehell/plugins/manager.py", line 5, in <module>',
+  \   '    import pkg_resources',
+  \   '  File "/usr/lib/python2.7/dist-packages/pkg_resources/__init__.py", line 35, in <module>',
+  \   '    import email.parser',
+  \   'ImportError: No module named parser',
+  \ ])
+
+Execute(The flakehell handler should handle names with spaces):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 6,
+  \     'col': 6,
+  \     'vcol': 1,
+  \     'type': 'E',
+  \     'text': 'indentation is not a multiple of four',
+  \     'code': 'E111',
+  \     'sub_type': 'style',
+  \   },
+  \ ],
+  \ ale_linters#python#flakehell#Handle(42, [
+  \   'C:\something\with spaces.py:6:6: E111 indentation is not a multiple of four',
+  \ ])
+
+Execute(Warnings about trailing whitespace should be reported by default):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 6,
+  \     'col': 1,
+  \     'vcol': 1,
+  \     'code': 'W291',
+  \     'type': 'W',
+  \     'sub_type': 'style',
+  \     'text': 'who cares',
+  \   },
+  \   {
+  \     'lnum': 6,
+  \     'col': 1,
+  \     'vcol': 1,
+  \     'code': 'W293',
+  \     'type': 'W',
+  \     'sub_type': 'style',
+  \     'text': 'who cares',
+  \   },
+  \ ],
+  \ ale_linters#python#flakehell#Handle(bufnr(''), [
+  \   'foo.py:6:1: W291 who cares',
+  \   'foo.py:6:1: W293 who cares',
+  \ ])
+
+Execute(Disabling trailing whitespace warnings should work):
+  let b:ale_warn_about_trailing_whitespace = 0
+
+  AssertEqual
+  \ [
+  \ ],
+  \ ale_linters#python#flakehell#Handle(bufnr(''), [
+  \   'foo.py:6:1: W291 who cares',
+  \   'foo.py:6:1: W293 who cares',
+  \ ])
+
+Execute(Warnings about trailing blank lines should be reported by default):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 6,
+  \     'col': 1,
+  \     'vcol': 1,
+  \     'code': 'W391',
+  \     'type': 'W',
+  \     'sub_type': 'style',
+  \     'text': 'blank line at end of file',
+  \   },
+  \ ],
+  \ ale_linters#python#flakehell#Handle(bufnr(''), [
+  \   'foo.py:6:1: W391 blank line at end of file',
+  \ ])
+
+Execute(Disabling trailing blank line warnings should work):
+  let b:ale_warn_about_trailing_blank_lines = 0
+
+  AssertEqual
+  \ [
+  \ ],
+  \ ale_linters#python#flakehell#Handle(bufnr(''), [
+  \   'foo.py:6:1: W391 blank line at end of file',
+  \ ])
+
+Execute(F401 should be a warning):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 6,
+  \     'col': 1,
+  \     'vcol': 1,
+  \     'code': 'F401',
+  \     'type': 'W',
+  \     'text': 'module imported but unused',
+  \   },
+  \ ],
+  \ ale_linters#python#flakehell#Handle(bufnr(''), [
+  \   'foo.py:6:1: F401 module imported but unused',
+  \ ])
+
+Execute(E112 should be a syntax error):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 6,
+  \     'col': 1,
+  \     'vcol': 1,
+  \     'code': 'E112',
+  \     'type': 'E',
+  \     'text': 'expected an indented block',
+  \   },
+  \ ],
+  \ ale_linters#python#flakehell#Handle(bufnr(''), [
+  \   'foo.py:6:1: E112 expected an indented block',
+  \ ])
+
+Execute(Compatibility with hacking which uses older style flakehell):
+  AssertEqual
+  \ [
+  \   {
+  \     'lnum': 6,
+  \     'col': 1,
+  \     'vcol': 1,
+  \     'code': 'H306',
+  \     'type': 'W',
+  \     'text': 'imports not in alphabetical order (smtplib, io)',
+  \   },
+  \ ],
+  \ ale_linters#python#flakehell#Handle(bufnr(''), [
+  \   'foo.py:6:1: H306: imports not in alphabetical order (smtplib, io)',
+  \ ])

test/linter/test_flakehell.vader

@@ -0,0 +1,202 @@
+Before:
+  call ale#assert#SetUpLinterTest('python', 'flakehell')
+
+  let b:bin_dir = has('win32') ? 'Scripts' : 'bin'
+
+  GivenCommandOutput ['0.8.0']
+
+After:
+  unlet! b:executable
+  unlet! b:bin_dir
+  call ale#assert#TearDownLinterTest()
+
+Execute(The flakehell callbacks should return the correct default values):
+  AssertLinter 'flakehell', [
+  \ ale#Escape('flakehell') . ' --version',
+  \ ale#Escape('flakehell') . ' lint --format=default --stdin-display-name %s -',
+  \]
+
+  " The version check should be cached.
+  GivenCommandOutput []
+  AssertLinter 'flakehell', [
+  \ ale#Escape('flakehell') . ' lint --format=default --stdin-display-name %s -',
+  \]
+
+Execute(The option for disabling changing directories should work):
+  let g:ale_python_flakehell_change_directory = 'off'
+
+  AssertLinterCwd ['', '']
+  call ale#semver#ResetVersionCache()
+  AssertLinter 'flakehell', [
+  \ ale#Escape('flakehell') . ' --version',
+  \ ale#Escape('flakehell') . ' lint --format=default --stdin-display-name %s -',
+  \]
+
+  let g:ale_python_flakehell_change_directory = 0
+
+  AssertLinterCwd ['']
+  AssertLinter 'flakehell', [
+  \ ale#Escape('flakehell') . ' lint --format=default --stdin-display-name %s -',
+  \]
+
+  " Invalid options should be considered the same as turning the setting off.
+  let g:ale_python_flakehell_change_directory = 'xxx'
+
+  AssertLinterCwd ['']
+  AssertLinter 'flakehell', [
+  \ ale#Escape('flakehell') . ' lint --format=default --stdin-display-name %s -',
+  \]
+
+Execute(The option for changing directory to project root should work):
+  silent execute 'file ' . fnameescape(g:dir . '/../test-files/python/namespace_package_tox/namespace/foo/bar.py')
+
+  AssertLinterCwd ale#python#FindProjectRootIni(bufnr(''))
+  call ale#semver#ResetVersionCache()
+  AssertLinter 'flakehell', [
+  \ ale#Escape('flakehell') . ' --version',
+  \ ale#Escape('flakehell') . ' lint --format=default --stdin-display-name %s -',
+  \]
+
+Execute(The option for changing directory to file dir should work):
+  let g:ale_python_flakehell_change_directory = 'file'
+  silent execute 'file ' . fnameescape(g:dir . '/../test-files/python/namespace_package_tox/namespace/foo/bar.py')
+
+  AssertLinter 'flakehell', [
+  \ ale#Escape('flakehell') . ' --version',
+  \ ale#Escape('flakehell') . ' lint --format=default --stdin-display-name %s -',
+  \]
+
+  let g:ale_python_flakehell_change_directory = 1
+
+  AssertLinter 'flakehell', [
+  \ ale#Escape('flakehell') . ' lint --format=default --stdin-display-name %s -',
+  \]
+
+Execute(The flakehell command callback should let you set options):
+  let g:ale_python_flakehell_options = '--some-option'
+
+  GivenCommandOutput ['0.8.0']
+  AssertLinter 'flakehell', [
+  \ ale#Escape('flakehell') . ' --version',
+  \ ale#Escape('flakehell') . ' lint --some-option'
+  \   . ' --format=default --stdin-display-name %s -',
+  \]
+
+Execute(You should be able to set a custom executable and it should be escaped):
+  let g:ale_python_flakehell_executable = 'executable with spaces'
+
+  AssertLinterCwd ['%s:h', '%s:h']
+  call ale#semver#ResetVersionCache()
+  AssertLinter 'executable with spaces', [
+  \ ale#Escape('executable with spaces') . ' --version',
+  \ ale#Escape('executable with spaces')
+  \   . ' lint'
+  \   . ' --format=default'
+  \   . ' --stdin-display-name %s -',
+  \]
+
+Execute(The flakehell callbacks should detect virtualenv directories):
+  silent execute 'file ' . fnameescape(g:dir . '/../test-files/python/with_virtualenv/subdir/foo/bar.py')
+
+  let b:executable = ale#path#Simplify(
+  \ g:dir . '/../test-files/python/with_virtualenv/env/' . b:bin_dir . '/flakehell'
+  \)
+
+  AssertLinter b:executable, [
+  \ ale#Escape(b:executable) . ' --version',
+  \ ale#Escape(b:executable)
+  \   . ' lint'
+  \   . ' --format=default'
+  \   . ' --stdin-display-name %s -',
+  \]
+
+Execute(The FindProjectRoot should detect the project root directory for namespace package via Manifest.in):
+  silent execute 'file ' . fnameescape(g:dir . '/../test-files/python/namespace_package_manifest/namespace/foo/bar.py')
+
+  AssertEqual
+  \ ale#path#Simplify(g:dir . '/../test-files/python/namespace_package_manifest'),
+  \ ale#python#FindProjectRoot(bufnr(''))
+
+Execute(The FindProjectRoot should detect the project root directory for namespace package via setup.cf):
+  silent execute 'file ' . fnameescape(g:dir . '/../test-files/python/namespace_package_setup/namespace/foo/bar.py')
+
+  AssertEqual
+  \ ale#path#Simplify(g:dir . '/../test-files/python/namespace_package_setup'),
+  \ ale#python#FindProjectRoot(bufnr(''))
+
+Execute(The FindProjectRoot should detect the project root directory for namespace package via pytest.ini):
+  silent execute 'file ' . fnameescape(g:dir . '/../test-files/python/namespace_package_pytest/namespace/foo/bar.py')
+
+  AssertEqual
+  \ ale#path#Simplify(g:dir . '/../test-files/python/namespace_package_pytest'),
+  \ ale#python#FindProjectRoot(bufnr(''))
+
+Execute(The FindProjectRoot should detect the project root directory for namespace package via tox.ini):
+  silent execute 'file ' . fnameescape(g:dir . '/../test-files/python/namespace_package_tox/namespace/foo/bar.py')
+
+  AssertEqual
+  \ ale#path#Simplify(g:dir . '/../test-files/python/namespace_package_tox'),
+  \ ale#python#FindProjectRoot(bufnr(''))
+
+Execute(The FindProjectRoot should detect the project root directory for non-namespace package):
+  silent execute 'file ' . fnameescape(g:dir . '/../test-files/python/no_virtualenv/subdir/foo/bar.py')
+
+  AssertEqual
+  \ ale#path#Simplify(g:dir . '/../test-files/python/no_virtualenv/subdir'),
+  \ ale#python#FindProjectRoot(bufnr(''))
+
+" Some users currently run flakehell this way, so we should support it.
+Execute(Using `python -m flakehell` should be supported for running flakehell):
+  silent execute 'file ' . fnameescape(g:dir . '/../test-files/python/with_virtualenv/subdir/foo/bar.py')
+
+  let g:ale_python_flakehell_executable = 'python'
+  let g:ale_python_flakehell_options = '--some-option'
+
+  AssertLinter 'python', [
+  \ ale#Escape('python') . ' -m flakehell --version',
+  \ ale#Escape('python')
+  \   . ' -m flakehell lint --some-option --format=default --stdin-display-name %s -'
+  \]
+
+  call ale#semver#ResetVersionCache()
+
+  " Leading spaces shouldn't matter
+  let g:ale_python_flakehell_options = '   --some-option'
+
+  AssertLinter 'python', [
+  \ ale#Escape('python') . ' -m flakehell --version',
+  \ ale#Escape('python')
+  \   . ' -m flakehell lint    --some-option --format=default --stdin-display-name %s -'
+  \]
+
+Execute(Setting executable to 'pipenv' should append 'run flakehell'):
+  let g:ale_python_flakehell_executable = 'path/to/pipenv'
+
+  " FIXME: pipenv should check the version with flakehell.
+  GivenCommandOutput []
+  AssertLinter 'path/to/pipenv',
+  \ ale#Escape('path/to/pipenv') . ' run flakehell lint --format=default -'
+
+Execute(Pipenv is detected when python_flakehell_auto_pipenv is set):
+  let g:ale_python_flakehell_auto_pipenv = 1
+  call ale#test#SetFilename('../test-files/python/pipenv/whatever.py')
+
+  AssertLinterCwd ale#python#FindProjectRootIni(bufnr(''))
+  AssertLinter 'pipenv',
+  \ ale#Escape('pipenv') . ' run flakehell lint --format=default --stdin-display-name %s -'
+
+Execute(Setting executable to 'poetry' should append 'run flakehell'):
+  let g:ale_python_flakehell_executable = 'path/to/poetry'
+
+  " FIXME: poetry should check the version with flakehell.
+  GivenCommandOutput []
+  AssertLinter 'path/to/poetry',
+  \ ale#Escape('path/to/poetry') . ' run flakehell lint --format=default -'
+
+Execute(poetry is detected when python_flakehell_auto_poetry is set):
+  let g:ale_python_flakehell_auto_poetry = 1
+  call ale#test#SetFilename('../test-files/python/poetry/whatever.py')
+
+  AssertLinterCwd ale#python#FindProjectRootIni(bufnr(''))
+  AssertLinter 'poetry',
+  \ ale#Escape('poetry') . ' run flakehell lint --format=default --stdin-display-name %s -'