def test_linter_config_file(self):
try:
# write the `markdownlint.json` config file instructing to
# except "MD022/blanks-around-headers"
config_file_path = path.join(self.cwd, ".markdownlint.json")
w_conf = Writer(config_file_path)
w_conf.write("{")
w_conf.write(' "MD022": false')
w_conf.write("}")
# write a bad markdown file
file_path = path.join(self.cwd, "test.md")
w = Writer(file_path)
w.write("# Section")
w.write("Missing a blank line after header.")
# instantiate the linter (sink STDOUT in testing)
f = StringIO()
with redirect_stdout(f):
return_value = (MarkdownLinter(config_path=w_conf.path).lint(
[w.path]))
# return value will be 0 if MD022 is correctly ignored
self.assertEqual(return_value, 0)
except Exception:
raise
finally:
# clean up
w_conf.delete()
w.delete()
def test_linter_config_file(self):
try:
# write the `.flake8` config file instructing to
# except "E225"
config_file_path = path.join(self.cwd, ".flake8")
w_conf = Writer(config_file_path)
w_conf.write("[flake8]")
w_conf.write("ignore = E225")
# write a bad python file
file_path = path.join(self.cwd, "test.py")
w = Writer(file_path)
w.write("# No space around =")
w.write("foo=1")
# instantiate the linter (sink STDOUT in testing)
f = StringIO()
with redirect_stdout(f):
return_value = (PythonLinter(config_path=w_conf.path).lint(
[w.path]))
# return value will be 0 if E225 is correctly ignored
self.assertEqual(return_value, 0)
except Exception:
raise
finally:
# clean up
w_conf.delete()
w.delete()
def test_non_zero_exit_code(self):
try:
# write a bad markdown file
file_path = path.join(self.cwd, "test.md")
w = Writer(file_path)
w.write("# Section")
w.write("Missing a blank line after header.")
# instantiate the linter (sink STDOUT in testing)
f = StringIO()
with redirect_stdout(f):
return_value = MarkdownLinter().lint([w.path])
self.assertEqual(return_value, 1)
except Exception:
raise
finally:
# clean up
w.delete()
def test_non_zero_exit_code(self):
try:
# write a bad R file
file_path = path.join(self.cwd, "test.R")
w = Writer(file_path)
w.write("# Use = instead of <-")
w.write("bar = 0")
# instantiate the linter (sink STDOUT in testing)
f = StringIO()
with redirect_stdout(f):
return_value = RLinter().lint([w.path])
self.assertEqual(return_value, 1)
except Exception:
raise
finally:
# clean up
w.delete()
def test_non_zero_exit_code(self):
try:
# write a bad python file
file_path = path.join(self.cwd, "test.py")
w = Writer(file_path)
w.write("# No space around =")
w.write("foo=1")
# instantiate the linter (sink STDOUT in testing)
f = StringIO()
with redirect_stdout(f):
return_value = PythonLinter().lint([w.path])
self.assertEqual(return_value, 1)
except Exception:
raise
finally:
# clean up
w.delete()
def test_linter_config_file(self):
try:
# write the `.lintr` config file instructing to
# deactivate the "assignment_linter"
config_file_path = path.join(self.cwd, ".lintr")
w_conf = Writer(config_file_path)
w_conf.write("linters: with_defaults(assignment_linter = NULL)")
# write a bad R file
file_path = path.join(self.cwd, "test.R")
w = Writer(file_path)
w.write("# Use = instead of <-")
w.write("bar = 0")
# instantiate the linter
f = StringIO()
with redirect_stdout(f):
return_value = (RLinter(config_path=w_conf.path).lint([w.path
]))
# return value will be 0 if the "assignment_linter" is correctly
# deactivated
self.assertEqual(return_value, 0)
except Exception:
raise
finally:
# clean up
w_conf.delete()
w.delete()
def test_zero_exit_code(self):
try:
# write a bad markdown file
file_path = path.join(self.cwd, "test.py")
w = Writer(file_path)
w.write("# This is ok")
w.write("a = 3")
w.write("b = 4")
w.write("a < 4")
# instantiate the linter (sink STDOUT in testing)
f = StringIO()
with redirect_stdout(f):
return_value = PythonLinter().lint([w.path])
self.assertEqual(return_value, 0)
except Exception:
raise
finally:
# clean up
w.delete()
def test_lint_single(self):
# test ability to execute `run` method with single linter
try:
# initialize repo
repo = BasicRepo(bare=False)
# write a bad markdown file
test_staged_file = path.join(repo.repo_path, "foo.md")
w = Writer(test_staged_file)
w.write("# Bad markdown")
w.write("There should be an empty line before this!")
w.write("Also, this is way too long" * 300)
# stage it
repo.repo.git.add(test_staged_file)
# initialize a `GitHandle`
git_handle = GitHandle(path=repo.repo_path)
# initialize a `Lint` object
ell = Lint(git_handle=git_handle, linters=[MarkdownLinter()])
# execute the main method of the `Lint` object
f = StringIO()
with redirect_stdout(f):
n_files_with_problems = ell.run()
self.assertEqual(n_files_with_problems, 1)
except Exception:
raise
finally:
# clean up
w.delete()
repo.delete()
def test_run(self):
# test ability to execute `run` method with multiple linters when
# only a subset of the files are staged;
# also check that linting works for staged files that live in
# subdirectories
try:
# initialize repo
repo = BasicRepo(bare=False)
# write a bad markdown file
test_staged_file = path.join(repo.repo_path, "foo.md")
w = Writer(test_staged_file)
w.write("# Bad markdown")
w.write("There should be an empty line before this!")
w.write("Also, this is way too long" * 300)
# write a bad R file
test_staged_file1 = path.join(repo.repo_path, "bar.R")
w1 = Writer(test_staged_file1)
w1.write("# Bad R")
w1.write("f=function(x) print( 'Hello' )")
w1.write("a=5")
# write a bad Python file
test_staged_file2 = path.join(repo.repo_path, "foof.py")
w2 = Writer(test_staged_file2)
w2.write("# Bad Python")
w2.write(" a=2")
w2.write("from os import path")
w2.write("a==2")
# write another bad Python in a subdirectory
subdir = path.join(repo.repo_path, "subdir")
mkdir(subdir)
test_staged_file3 = path.join(subdir, "fooffer.py")
w3 = Writer(test_staged_file3)
w3.write("# Bad Pyrhon")
w3.write("# Wrong indentation")
w3.write("class Foo(object):")
w3.write(" pass")
# stage these files
repo.repo.git.add([
test_staged_file, test_staged_file1, test_staged_file2,
test_staged_file3
])
# write another file which is problematic but not staged!
test_non_staged_file = path.join(repo.repo_path, "lmao.py")
w3 = Writer(test_non_staged_file)
w3.write("# An unnecessary import")
w3.write("from os import getcwd")
w3.write("# A test on an undefined variable")
w3.write("# And missing blank line at the end")
w3.write("a==3", newline=False)
# initialize a `GitHandle`
git_handle = GitHandle(path=repo.repo_path)
# initialize a `Lint` object
ell = Lint(git_handle=git_handle,
linters=[MarkdownLinter(),
PythonLinter(),
RLinter()])
# execute the main method of the `Lint` object
f = StringIO()
with redirect_stdout(f):
n_files_with_problems = ell.run()
self.assertEqual(n_files_with_problems, 4)
except Exception:
raise
finally:
# clean up
w.delete()
w1.delete()
w2.delete()
w3.delete()
repo.delete()
def test_run_with_linters_config(self):
# test ability to execute `run` method with multiple linters,
# honoring the linters config files
try:
# initialize repo
repo = BasicRepo(bare=False)
# write a bad markdown file
test_staged_file = path.join(repo.repo_path, "foo.md")
w = Writer(test_staged_file)
w.write("# Bad markdown")
w.write("There should be an empty line before this!")
# write the .markdownlint.json config file to ignore
# "MD022/blanks-around-headers"
md_config_file_path = path.join(repo.repo_path,
".markdownlint.json")
w_md_conf = Writer(md_config_file_path)
w_md_conf.write("{")
w_md_conf.write(' "MD022": false')
w_md_conf.write("}")
# write a bad R file
test_staged_file1 = path.join(repo.repo_path, "bar.R")
w1 = Writer(test_staged_file1)
w1.write("# Bad R")
w1.write("f <- function(x) print('Hello')")
# write the .lintr config file to ignore the "single_quotes_linter"
r_config_file_path = path.join(repo.repo_path, ".lintr")
w_r_conf = Writer(r_config_file_path)
w_r_conf.write("linters: with_defaults(single_quotes_linter=NULL)")
# write a bad Python file
test_staged_file2 = path.join(repo.repo_path, "foof.py")
w2 = Writer(test_staged_file2)
w2.write("# Bad Python")
w2.write("a=2")
# write the `.flake8` config file instructing to
# except "E225"
py_config_file_path = path.join(repo.repo_path, ".flake8")
w_py_conf = Writer(py_config_file_path)
w_py_conf.write("[flake8]")
w_py_conf.write("ignore = E225")
# stage the files
repo.repo.git.add(
[test_staged_file, test_staged_file1, test_staged_file2])
# initialize a `GitHandle`
git_handle = GitHandle(path=repo.repo_path)
# initialize a `Lint` object
ell = Lint(git_handle=git_handle,
linters=[
MarkdownLinter(config_path=w_md_conf.path),
PythonLinter(config_path=w_py_conf.path),
RLinter(config_path=w_r_conf.path)
])
# execute the main method of the `Lint` object
f = StringIO()
with redirect_stdout(f):
n_files_with_problems = ell.run()
# all linting issues should be ignored
self.assertEqual(n_files_with_problems, 0)
except Exception:
raise
finally:
# clean up
w.delete()
w_md_conf.delete()
w1.delete()
w_r_conf.delete()
w2.delete()
w_py_conf.delete()
repo.delete()