Ignore missing docstrings in methods in "tests" dir "test_*.py" (#120)

* create a failing test

* Add ignore for tests docstrings

* Add check for tests\* - not test_*.py

* make test pass

Author: mnarus

ni_python_styleguide/config.ini

@@ -80,6 +80,9 @@ ignore =
     # flake8-import-order
     I101  #  The names in your from import are in the wrong order. (Enforced by E401)
 
+# We want to ignore missing docstrings in test methods as they are self documenting
+per-file-ignores= tests/**/test_*.py:D100,D103
+
 # Flake8 includes mccabe by default.
 # We have yet to evaluate it, so ignore the errors for now
 extend-ignore=C90

tests/test_cli/test_lint.py

@@ -1,12 +1,19 @@
 """Tests for the "lint" subcommand of ni-python-styleguide."""
 
 import itertools
+import textwrap
 
 import pytest
 import toml
 
 
 TOO_LONG_LINE = "a_really_long_order = [" + ", ".join(itertools.repeat('"spam"', 10)) + "]\n"
+NO_DOC_STRING = textwrap.dedent(
+    f"""\
+    def my_method():
+        assert True
+    """
+)
 
 
 @pytest.fixture
@@ -148,8 +155,8 @@ def test_lint__no_args_lints_subdirs(styleguide_lint, tmp_path):
     assert "subdir/spam.py" in result.output.replace("\\", "/")
 
 
-def test_lint__lignores_venv_by_default(styleguide_lint, tmp_path):
-    """Test that we exclude ".venv" dir by default."""
+def test_lint__ignores_venv_by_default(styleguide_lint, tmp_path):
+    """Tests that we exclude ".venv" dir by default."""
     (tmp_path / ".venv").mkdir()
     (tmp_path / ".venv" / "spam.py").write_text(TOO_LONG_LINE)
 
@@ -158,6 +165,26 @@ def test_lint__lignores_venv_by_default(styleguide_lint, tmp_path):
     assert result, result.output
 
 
+def test_lint__ignores_missing_docstrings_in_tests_dir(styleguide_lint, tmp_path):
+    (tmp_path / "tests" / "test_spam").mkdir(parents=True)
+    (tmp_path / "tests" / "test_spam" / "test_spam.py").write_text(NO_DOC_STRING)
+
+    result = styleguide_lint()
+
+    assert result, result.output
+
+
+def test_lint__checks_docstrings_in_test_helper_methods(styleguide_lint, tmp_path):
+    (tmp_path / "tests").mkdir()
+    (tmp_path / "tests" / "conftest.py").write_text(NO_DOC_STRING)
+
+    result = styleguide_lint()
+
+    # D100: Missing docstring in public module
+    # D103: Missing docstring in public function
+    assert "D100" and "D103" in result.output, result.output
+
+
 def test_lint__exclude__excludes_file(styleguide_lint_with_options, tmp_path):
     """Test that exclude option excludes a file."""
     (tmp_path / "spam.py").write_text(TOO_LONG_LINE)