Tests refactoring is finished, closes #295, closes #305

Author: sobolevn

CHANGELOG.md

@@ -17,6 +17,7 @@ We used to have incremental versioning before `0.1.0`.
 
 ### Bugfixes
 
+- Multiple fixes to error text formats to be more readable
 - Fixes `UNDERSCORED_NUMBER_PATTERN` to match names like `come_22_me`
 - Fixes `UpperCaseAttributeViolation` not being displayed in the docs
 - Fixes consistency checks being duplicated in the docs
@@ -28,6 +29,7 @@ We used to have incremental versioning before `0.1.0`.
 - Fixes `TooManyElifsViolation` to show correct text
 - Fixes `TooDeepNestingViolation` to show correct text
 - Fixes `TooManyMethodsViolation` to show correct text
+- Fixes `ReassigningVariableToItselfViolation` to show correct text
 - Renames `UnderscoredNumberNameViolation` to `UnderscoredNumberNameViolation`
 
 ### Misc

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "wemake-python-styleguide"
 version = "0.3.0"
-description = "The most strict and opinionated python linter ever"
+description = "The strictest and most opinionated python linter ever"
 
 license = "MIT"
 

tests/test_violations/test_docs.py

@@ -26,3 +26,15 @@ def test_violation_name(all_violations):
     for violation in all_violations:
         class_name = violation.__qualname__
         assert class_name.endswith('Violation'), class_name
+
+
+def test_violation_error_text(all_violations):
+    """Ensures that all violations have correctly format error text."""
+    for violation in all_violations:
+        if violation.should_use_text:
+            error_format = ': {0}'
+
+            assert error_format in violation.error_template
+            assert violation.error_template.endswith(error_format)
+        else:
+            assert '{0}' not in violation.error_template

tests/test_visitors/test_ast/test_builtins/test_magic_numbers.py

@@ -18,11 +18,6 @@ def function_name(param1, param2={0}):
     return param1 / param2
 """
 
-async_function_definition = """
-async def function_name(param1, param2={0}):
-    return param1 / param2
-"""
-
 list_definition = '[{0}]'
 dict_definition_key = '{{{0}: "value"}}'
 dict_definition_value = '{{"first": {0}}}'
@@ -53,12 +48,12 @@ def method(self):
 """
 
 list_index = """
-some_list = [1, 2, 3]
+some_list = [10, 20, 30]
 some_list[{0}]
 """
 
 dict_key = """
-some_dict = {{1: 1, 2: 2}}
+some_dict = {{11: 12, 13: 14}}
 some_dict[{0}]
 """
 
@@ -67,7 +62,6 @@ def method(self):
     assignment,
     assignment_unary,
     function_definition,
-    async_function_definition,
     list_definition,
     dict_definition_key,
     dict_definition_value,
@@ -89,9 +83,10 @@ def test_magic_number(
     code,
     number,
     default_options,
+    mode,
 ):
     """Testing that there are no magic numbers in this code."""
-    tree = parse_ast_tree(code.format(number))
+    tree = parse_ast_tree(mode(code.format(number)))
 
     visitor = MagicNumberVisitor(default_options, tree=tree)
     visitor.run()
@@ -123,9 +118,10 @@ def test_magic_number_whitelist(
     code,
     number,
     default_options,
+    mode,
 ):
     """Testing that magic numbers in this code are whitelisted."""
-    tree = parse_ast_tree(code.format(number))
+    tree = parse_ast_tree(mode(code.format(number)))
 
     visitor = MagicNumberVisitor(default_options, tree=tree)
     visitor.run()
@@ -158,9 +154,10 @@ def test_magic_number_warning(
     code,
     number,
     default_options,
+    mode,
 ):
     """Testing that magic numbers in this code are warnings."""
-    tree = parse_ast_tree(code.format(number))
+    tree = parse_ast_tree(mode(code.format(number)))
 
     visitor = MagicNumberVisitor(default_options, tree=tree)
     visitor.run()

tests/test_visitors/test_ast/test_classes/test_base_class.py

@@ -7,8 +7,8 @@
 )
 from wemake_python_styleguide.visitors.ast.classes import WrongClassVisitor
 
-class_without_base = 'class WithoutBase: ...'
-class_with_empty_base = 'class EmptyBase(): ...'
+class_without_base = 'class Meta: ...'
+class_with_empty_base = 'class Meta(): ...'
 
 nested_class_without_base = """
 class Model(object):
@@ -22,7 +22,7 @@ class Meta(): ...
 
 # Correct:
 
-class_with_base = 'class Example({0}): ...'
+class_with_base = 'class Meta({0}): ...'
 
 nested_class_with_base = """
 class Model({0}):
@@ -38,6 +38,7 @@ class Meta({0}): ...
 ])
 def test_wrong_base_class(
     assert_errors,
+    assert_error_text,
     parse_ast_tree,
     code,
     default_options,
@@ -49,6 +50,7 @@ def test_wrong_base_class(
     visitor.run()
 
     assert_errors(visitor, [RequiredBaseClassViolation])
+    assert_error_text(visitor, 'Meta')
 
 
 @pytest.mark.parametrize('code', [

tests/test_visitors/test_ast/test_classes/test_magic_methods.py

@@ -17,6 +17,7 @@ def {0}(): ...
 @pytest.mark.parametrize('method', MAGIC_METHODS_BLACKLIST)
 def test_wrong_magic_used(
     assert_errors,
+    assert_error_text,
     parse_ast_tree,
     method,
     mode,
@@ -29,6 +30,7 @@ def test_wrong_magic_used(
     visitor.run()
 
     assert_errors(visitor, [BadMagicMethodViolation])
+    assert_error_text(visitor, method)
 
 
 @pytest.mark.parametrize('method', [

tests/test_visitors/test_ast/test_complexity/test_nested/test_nested_classes.py

@@ -34,18 +34,21 @@ class {0}(object): ...
 ])
 def test_nested_class(
     assert_errors,
+    assert_error_text,
     parse_ast_tree,
     code,
     default_options,
     mode,
 ):
     """Testing that nested classes are restricted."""
-    tree = parse_ast_tree(mode(code.format('NestedClass')))
+    nested_name = 'NestedClass'
+    tree = parse_ast_tree(mode(code.format(nested_name)))
 
     visitor = NestedComplexityVisitor(default_options, tree=tree)
     visitor.run()
 
     assert_errors(visitor, [NestedClassViolation])
+    assert_error_text(visitor, nested_name)
 
 
 @pytest.mark.parametrize('whitelist_name', NESTED_CLASSES_WHITELIST)
@@ -79,6 +82,7 @@ def test_whitelist_nested_classes(
 ])
 def test_whitelist_nested_classes_in_functions(
     assert_errors,
+    assert_error_text,
     parse_ast_tree,
     whitelist_name,
     code,
@@ -92,6 +96,7 @@ def test_whitelist_nested_classes_in_functions(
     visitor.run()
 
     assert_errors(visitor, [NestedClassViolation])
+    assert_error_text(visitor, whitelist_name)
 
 
 def test_ordinary_class(

tests/test_visitors/test_ast/test_complexity/test_nested/test_nested_functions.py

@@ -93,14 +93,22 @@ def container(self):
     nested_function_in_async_method,
     nested_async_function_in_async_method,
 ])
-def test_nested_function(assert_errors, parse_ast_tree, code, default_options):
+def test_nested_function(
+    assert_errors,
+    assert_error_text,
+    parse_ast_tree,
+    code,
+    default_options,
+):
     """Testing that nested functions are restricted."""
-    tree = parse_ast_tree(code.format('nested'))
+    nested_name = 'nested'
+    tree = parse_ast_tree(code.format(nested_name))
 
     visitor = NestedComplexityVisitor(default_options, tree=tree)
     visitor.run()
 
     assert_errors(visitor, [NestedFunctionViolation])
+    assert_error_text(visitor, nested_name)
 
 
 @pytest.mark.parametrize('whitelist_name', NESTED_FUNCTIONS_WHITELIST)
@@ -115,7 +123,11 @@ def test_nested_function(assert_errors, parse_ast_tree, code, default_options):
     nested_async_function_in_async_method,
 ])
 def test_whitelist_nested_functions(
-    assert_errors, parse_ast_tree, whitelist_name, code, default_options,
+    assert_errors,
+    parse_ast_tree,
+    whitelist_name,
+    code,
+    default_options,
 ):
     """Testing that it is possible to nest whitelisted functions."""
     tree = parse_ast_tree(code.format(whitelist_name))
@@ -133,7 +145,10 @@ def test_whitelist_nested_functions(
     lambda_in_async_method,
 ])
 def test_lambda_nested_functions(
-    assert_errors, parse_ast_tree, code, default_options,
+    assert_errors,
+    parse_ast_tree,
+    code,
+    default_options,
 ):
     """Testing that it is possible to nest lambda inside functions."""
     tree = parse_ast_tree(code)
@@ -144,7 +159,12 @@ def test_lambda_nested_functions(
     assert_errors(visitor, [])
 
 
-def test_lambda_nested_lambdas(assert_errors, parse_ast_tree, default_options):
+def test_lambda_nested_lambdas(
+    assert_errors,
+    assert_error_text,
+    parse_ast_tree,
+    default_options,
+):
     """
     Testing that it is restricted to nest lambdas.
 
@@ -159,3 +179,4 @@ def container():
     visitor.run()
 
     assert_errors(visitor, [NestedFunctionViolation])
+    assert_error_text(visitor, 'lambda')

tests/test_visitors/test_ast/test_functions/test_wrong_function_calls.py

@@ -27,6 +27,7 @@ def proxy(*args, **kwargs):
 ])
 def test_wrong_function_called(
     assert_errors,
+    assert_error_text,
     parse_ast_tree,
     bad_function,
     code,
@@ -40,6 +41,7 @@ def test_wrong_function_called(
     visitor.run()
 
     assert_errors(visitor, [WrongFunctionCallViolation])
+    assert_error_text(visitor, bad_function)
 
 
 @pytest.mark.parametrize('good_function', [

tests/test_visitors/test_ast/test_imports/test_dotted_raw_import.py

@@ -22,7 +22,12 @@
     'nested.dotted.path',
 ])
 def test_wrong_dotted_import(
-    assert_errors, parse_ast_tree, code, to_import, default_options,
+    assert_errors,
+    assert_error_text,
+    parse_ast_tree,
+    code,
+    to_import,
+    default_options,
 ):
     """Testing that dotted raw imports are restricted."""
     tree = parse_ast_tree(code.format(to_import))
@@ -31,6 +36,7 @@ def test_wrong_dotted_import(
     visitor.run()
 
     assert_errors(visitor, [DottedRawImportViolation])
+    assert_error_text(visitor, to_import)
 
 
 @pytest.mark.parametrize('code', [
@@ -42,7 +48,11 @@ def test_wrong_dotted_import(
     'sys',
 ])
 def test_correct_flat_import(
-    assert_errors, parse_ast_tree, code, to_import, default_options,
+    assert_errors,
+    parse_ast_tree,
+    code,
+    to_import,
+    default_options,
 ):
     """Testing that flat raw imports are allowed."""
     tree = parse_ast_tree(code.format(to_import))
@@ -63,7 +73,11 @@ def test_correct_flat_import(
     'nested.dotted.path',
 ])
 def test_regular_from_import(
-    assert_errors, parse_ast_tree, code, to_import, default_options,
+    assert_errors,
+    parse_ast_tree,
+    code,
+    to_import,
+    default_options,
 ):
     """Testing that dotted `from` imports are allowed."""
     tree = parse_ast_tree(code.format(to_import))