include tests in installed package (#232)

perrinjerome · web-flow · commit 84a5015efcb4 · 2022-08-24T15:46:07.000+09:00
This moves the tests to a sub-directory of RestrictedPython, so that they are installed along with the package.

This also required adjusting the imports from within the tests (making them relative imports after adding necessary __init__.py ) and making the tests pass the linter (they were not linted before, because they were not part of src I guess).
Some configuration that became unnecessary was also removed ( no need to include from tests in MANIFEST and no need to collect coverage from tests )
diff --git a/.meta.toml b/.meta.toml
@@ -29,7 +29,7 @@ testenv-setenv = [
 testenv-commands = [
     "python -V",
     "pip list",
-    "pytest --cov=src --cov=tests --cov-report= {posargs}",
+    "pytest --cov=src --cov-report= {posargs}",
     ]
 testenv-additional = [
     "",
@@ -51,7 +51,7 @@ testenv-additional = [
     "depends = py36,py37,py38,py39,py39-datetime,py310,py311,coverage",
     ]
 coverage-basepython = "python3.8"
-coverage-command = "pytest --cov=src --cov=tests --cov-report= {posargs}"
+coverage-command = "pytest --cov=src --cov-report= {posargs}"
 coverage-setenv = [
     "COVERAGE_FILE=.coverage",
     ]
@@ -64,7 +64,6 @@ additional-rules = [
     "recursive-include docs *.ast",
     "recursive-include docs *.bat",
     "recursive-include docs *.jpg",
-    "recursive-include tests *.py",
     ]
 
 [check-manifest]
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -15,4 +15,3 @@ recursive-include src *.py
 recursive-include docs *.ast
 recursive-include docs *.bat
 recursive-include docs *.jpg
-recursive-include tests *.py
diff --git a/src/RestrictedPython/tests/__init__.py b/src/RestrictedPython/tests/__init__.py
diff --git a/src/RestrictedPython/tests/builtins/test_limits.py b/src/RestrictedPython/tests/builtins/test_limits.py
@@ -1,9 +1,9 @@
+import pytest
+
 from RestrictedPython.Limits import limited_list
 from RestrictedPython.Limits import limited_range
 from RestrictedPython.Limits import limited_tuple
 
-import pytest
-
 
 def test_limited_range_length_1():
     result = limited_range(1)
diff --git a/src/RestrictedPython/tests/builtins/test_utilities.py b/src/RestrictedPython/tests/builtins/test_utilities.py
diff --git a/src/RestrictedPython/tests/helper.py b/src/RestrictedPython/tests/helper.py
@@ -1,8 +1,7 @@
+import RestrictedPython.Guards
 from RestrictedPython import compile_restricted_eval
 from RestrictedPython import compile_restricted_exec
 
-import RestrictedPython.Guards
-
 
 def _compile(compile_func, source):
     """Compile some source with a compile func."""
diff --git a/src/RestrictedPython/tests/test_Guards.py b/src/RestrictedPython/tests/test_Guards.py
@@ -1,12 +1,13 @@
+import pytest
+
 from RestrictedPython import compile_restricted_exec
 from RestrictedPython.Guards import guarded_unpack_sequence
 from RestrictedPython.Guards import safe_builtins
 from RestrictedPython.Guards import safe_globals
 from RestrictedPython.Guards import safer_getattr
-from tests.helper import restricted_eval
-from tests.helper import restricted_exec
 
-import pytest
+from .helper import restricted_eval
+from .helper import restricted_exec
 
 
 def _write_(x):
diff --git a/src/RestrictedPython/tests/test_NamedExpr.py b/src/RestrictedPython/tests/test_NamedExpr.py
@@ -3,11 +3,12 @@
 
 from ast import NodeTransformer
 from ast import parse
+from unittest import TestCase
+from unittest import skipUnless
+
 from RestrictedPython import compile_restricted
 from RestrictedPython import safe_globals
 from RestrictedPython._compat import IS_PY38_OR_GREATER
-from unittest import skipUnless
-from unittest import TestCase
 
 
 @skipUnless(IS_PY38_OR_GREATER, "Feature available for Python 3.8+")
diff --git a/src/RestrictedPython/tests/test_Utilities.py b/src/RestrictedPython/tests/test_Utilities.py
diff --git a/src/RestrictedPython/tests/test_compile.py b/src/RestrictedPython/tests/test_compile.py
@@ -1,15 +1,17 @@
+import platform
+import types
+
+import pytest
+
+from RestrictedPython import CompileResult
 from RestrictedPython import compile_restricted
 from RestrictedPython import compile_restricted_eval
 from RestrictedPython import compile_restricted_exec
 from RestrictedPython import compile_restricted_single
-from RestrictedPython import CompileResult
 from RestrictedPython._compat import IS_PY38_OR_GREATER
 from RestrictedPython._compat import IS_PY310_OR_GREATER
-from tests.helper import restricted_eval
 
-import platform
-import pytest
-import types
+from .helper import restricted_eval
 
 
 def test_compile__compile_restricted_invalid_code_input():
diff --git a/src/RestrictedPython/tests/test_compile_restricted_function.py b/src/RestrictedPython/tests/test_compile_restricted_function.py
@@ -1,9 +1,10 @@
-from RestrictedPython import compile_restricted_function
+from types import FunctionType
+
 from RestrictedPython import PrintCollector
+from RestrictedPython import compile_restricted_function
 from RestrictedPython import safe_builtins
 from RestrictedPython._compat import IS_PY38_OR_GREATER
 from RestrictedPython._compat import IS_PY310_OR_GREATER
-from types import FunctionType
 
 
 def test_compile_restricted_function():
diff --git a/src/RestrictedPython/tests/test_eval.py b/src/RestrictedPython/tests/test_eval.py
@@ -1,7 +1,7 @@
-from RestrictedPython.Eval import RestrictionCapableEval
-
 import pytest
 
+from RestrictedPython.Eval import RestrictionCapableEval
+
 
 exp = """
     {'a':[m.pop()]}['a'] \
diff --git a/src/RestrictedPython/tests/test_imports.py b/src/RestrictedPython/tests/test_imports.py
@@ -2,11 +2,12 @@
 Tests about imports
 """
 
+import pytest
+
 from RestrictedPython import compile_restricted_exec
 from RestrictedPython import safe_builtins
-from tests.helper import restricted_exec
 
-import pytest
+from .helper import restricted_exec
 
 
 OS_IMPORT_EXAMPLE = """
diff --git a/src/RestrictedPython/tests/test_iterating_over_dict_items.py b/src/RestrictedPython/tests/test_iterating_over_dict_items.py
@@ -1,10 +1,10 @@
+import pytest
+
 from RestrictedPython import compile_restricted_exec
 from RestrictedPython import safe_globals
 from RestrictedPython.Eval import default_guarded_getiter
 from RestrictedPython.Guards import guarded_iter_unpack_sequence
 
-import pytest
-
 
 ITERATE_OVER_DICT_ITEMS = """
 d = {'a': 'b'}
diff --git a/src/RestrictedPython/tests/test_print_function.py b/src/RestrictedPython/tests/test_print_function.py
@@ -1,6 +1,5 @@
-from RestrictedPython.PrintCollector import PrintCollector
-
 import RestrictedPython
+from RestrictedPython.PrintCollector import PrintCollector
 
 
 compiler = RestrictedPython.compile.compile_restricted_exec
diff --git a/src/RestrictedPython/tests/transformer/__init__.py b/src/RestrictedPython/tests/transformer/__init__.py
diff --git a/src/RestrictedPython/tests/transformer/operators/__init__.py b/src/RestrictedPython/tests/transformer/operators/__init__.py
diff --git a/src/RestrictedPython/tests/transformer/operators/test_arithmetic_operators.py b/src/RestrictedPython/tests/transformer/operators/test_arithmetic_operators.py
@@ -1,5 +1,6 @@
 from RestrictedPython import compile_restricted_eval
-from tests.helper import restricted_eval
+
+from ...helper import restricted_eval
 
 
 # Arithmetic Operators
diff --git a/src/RestrictedPython/tests/transformer/operators/test_bit_wise_operators.py b/src/RestrictedPython/tests/transformer/operators/test_bit_wise_operators.py
@@ -1,4 +1,4 @@
-from tests.helper import restricted_eval
+from ...helper import restricted_eval
 
 
 def test_BitAnd():
diff --git a/src/RestrictedPython/tests/transformer/operators/test_bool_operators.py b/src/RestrictedPython/tests/transformer/operators/test_bool_operators.py
@@ -1,4 +1,4 @@
-from tests.helper import restricted_eval
+from ...helper import restricted_eval
 
 
 def test_Or():
diff --git a/src/RestrictedPython/tests/transformer/operators/test_comparison_operators.py b/src/RestrictedPython/tests/transformer/operators/test_comparison_operators.py
@@ -1,4 +1,4 @@
-from tests.helper import restricted_eval
+from ...helper import restricted_eval
 
 
 def test_Eq():
diff --git a/src/RestrictedPython/tests/transformer/operators/test_identity_operators.py b/src/RestrictedPython/tests/transformer/operators/test_identity_operators.py
@@ -1,4 +1,4 @@
-from tests.helper import restricted_eval
+from ...helper import restricted_eval
 
 
 def test_Is():
diff --git a/src/RestrictedPython/tests/transformer/operators/test_logical_operators.py b/src/RestrictedPython/tests/transformer/operators/test_logical_operators.py
@@ -1,4 +1,4 @@
-from tests.helper import restricted_eval
+from ...helper import restricted_eval
 
 
 def test_In():
diff --git a/src/RestrictedPython/tests/transformer/operators/test_unary_operators.py b/src/RestrictedPython/tests/transformer/operators/test_unary_operators.py
@@ -1,4 +1,4 @@
-from tests.helper import restricted_eval
+from ...helper import restricted_eval
 
 
 def test_UAdd():
diff --git a/src/RestrictedPython/tests/transformer/test_assert.py b/src/RestrictedPython/tests/transformer/test_assert.py
@@ -1,4 +1,4 @@
-from tests.helper import restricted_exec
+from ..helper import restricted_exec
 
 
 def test_RestrictingNodeTransformer__visit_Assert__1():
diff --git a/src/RestrictedPython/tests/transformer/test_assign.py b/src/RestrictedPython/tests/transformer/test_assign.py
@@ -1,5 +1,6 @@
 from RestrictedPython.Guards import guarded_unpack_sequence
-from tests.helper import restricted_exec
+
+from ..helper import restricted_exec
 
 
 def test_RestrictingNodeTransformer__visit_Assign__1(mocker):
diff --git a/src/RestrictedPython/tests/transformer/test_async.py b/src/RestrictedPython/tests/transformer/test_async.py
diff --git a/src/RestrictedPython/tests/transformer/test_attribute.py b/src/RestrictedPython/tests/transformer/test_attribute.py
@@ -1,5 +1,6 @@
 from RestrictedPython import compile_restricted_exec
-from tests.helper import restricted_exec
+
+from ..helper import restricted_exec
 
 
 BAD_ATTR_UNDERSCORE = """\
diff --git a/src/RestrictedPython/tests/transformer/test_augassign.py b/src/RestrictedPython/tests/transformer/test_augassign.py
@@ -1,5 +1,6 @@
 from RestrictedPython import compile_restricted_exec
-from tests.helper import restricted_exec
+
+from ..helper import restricted_exec
 
 
 def test_RestrictingNodeTransformer__visit_AugAssign__1(
diff --git a/src/RestrictedPython/tests/transformer/test_base_types.py b/src/RestrictedPython/tests/transformer/test_base_types.py
@@ -1,5 +1,6 @@
 from RestrictedPython import compile_restricted_exec
-from tests.helper import restricted_eval
+
+from ..helper import restricted_eval
 
 
 def test_Num():
diff --git a/src/RestrictedPython/tests/transformer/test_breakpoint.py b/src/RestrictedPython/tests/transformer/test_breakpoint.py
diff --git a/src/RestrictedPython/tests/transformer/test_call.py b/src/RestrictedPython/tests/transformer/test_call.py
@@ -1,5 +1,6 @@
 from RestrictedPython import compile_restricted_exec
-from tests.helper import restricted_exec
+
+from ..helper import restricted_exec
 
 
 def test_RestrictingNodeTransformer__visit_Call__1():
diff --git a/src/RestrictedPython/tests/transformer/test_classdef.py b/src/RestrictedPython/tests/transformer/test_classdef.py
@@ -1,6 +1,7 @@
 from RestrictedPython import compile_restricted_exec
 from RestrictedPython.Guards import safe_builtins
-from tests.helper import restricted_exec
+
+from ..helper import restricted_exec
 
 
 GOOD_CLASS = '''
diff --git a/src/RestrictedPython/tests/transformer/test_comparators.py b/src/RestrictedPython/tests/transformer/test_comparators.py
@@ -1,4 +1,4 @@
-from tests.helper import restricted_eval
+from ..helper import restricted_eval
 
 
 def test_RestrictingNodeTransformer__visit_Eq__1():
diff --git a/src/RestrictedPython/tests/transformer/test_conditional.py b/src/RestrictedPython/tests/transformer/test_conditional.py
@@ -1,4 +1,4 @@
-from tests.helper import restricted_exec
+from ..helper import restricted_exec
 
 
 def test_RestrictingNodeTransformer__test_ternary_if(
diff --git a/src/RestrictedPython/tests/transformer/test_dict_comprehension.py b/src/RestrictedPython/tests/transformer/test_dict_comprehension.py
@@ -1,5 +1,6 @@
 from RestrictedPython._compat import IS_PY38_OR_GREATER
-from tests.helper import restricted_exec
+
+from ..helper import restricted_exec
 
 
 DICT_COMPREHENSION_WITH_ATTRS = """
diff --git a/src/RestrictedPython/tests/transformer/test_eval_exec.py b/src/RestrictedPython/tests/transformer/test_eval_exec.py
diff --git a/src/RestrictedPython/tests/transformer/test_fstring.py b/src/RestrictedPython/tests/transformer/test_fstring.py
@@ -1,9 +1,9 @@
+import pytest
+
 from RestrictedPython import compile_restricted_exec
 from RestrictedPython._compat import IS_PY38_OR_GREATER
 from RestrictedPython.PrintCollector import PrintCollector
 
-import pytest
-
 
 def test_transform():
     """It compiles a function call successfully and returns the used name."""
diff --git a/src/RestrictedPython/tests/transformer/test_functiondef.py b/src/RestrictedPython/tests/transformer/test_functiondef.py
@@ -35,7 +35,6 @@ def test_RestrictingNodeTransformer__visit_FunctionDef__7():
     assert result.errors == (functiondef_err_msg,)
 
 
-
 BLACKLISTED_FUNC_NAMES_CALL_TEST = """
 def __init__(test):
     test
diff --git a/src/RestrictedPython/tests/transformer/test_generic.py b/src/RestrictedPython/tests/transformer/test_generic.py
@@ -1,7 +1,7 @@
-from RestrictedPython import RestrictingNodeTransformer
-
 import ast
 
+from RestrictedPython import RestrictingNodeTransformer
+
 
 def test_RestrictingNodeTransformer__generic_visit__1():
     """It log an error if there is an unknown ast node visited."""
diff --git a/src/RestrictedPython/tests/transformer/test_global_local.py b/src/RestrictedPython/tests/transformer/test_global_local.py
@@ -1,5 +1,6 @@
 from RestrictedPython import compile_restricted_exec
-from tests.helper import restricted_exec
+
+from ..helper import restricted_exec
 
 
 GLOBAL_EXAMPLE = """
diff --git a/src/RestrictedPython/tests/transformer/test_import.py b/src/RestrictedPython/tests/transformer/test_import.py
diff --git a/src/RestrictedPython/tests/transformer/test_iterator.py b/src/RestrictedPython/tests/transformer/test_iterator.py
@@ -1,7 +1,8 @@
+import types
+
 from RestrictedPython.Guards import guarded_iter_unpack_sequence
-from tests.helper import restricted_exec
 
-import types
+from ..helper import restricted_exec
 
 
 ITERATORS = """
diff --git a/src/RestrictedPython/tests/transformer/test_lambda.py b/src/RestrictedPython/tests/transformer/test_lambda.py
@@ -1,5 +1,6 @@
 from RestrictedPython import compile_restricted_exec
-from tests.helper import restricted_exec
+
+from ..helper import restricted_exec
 
 
 lambda_err_msg = 'Line 1: "_bad" is an invalid variable ' \
diff --git a/src/RestrictedPython/tests/transformer/test_loop.py b/src/RestrictedPython/tests/transformer/test_loop.py
@@ -1,4 +1,4 @@
-from tests.helper import restricted_exec
+from ..helper import restricted_exec
 
 
 WHILE = """\
diff --git a/src/RestrictedPython/tests/transformer/test_name.py b/src/RestrictedPython/tests/transformer/test_name.py
@@ -1,5 +1,6 @@
 from RestrictedPython import compile_restricted_exec
-from tests.helper import restricted_exec
+
+from ..helper import restricted_exec
 
 
 BAD_NAME_STARTING_WITH_UNDERSCORE = """\
diff --git a/src/RestrictedPython/tests/transformer/test_slice.py b/src/RestrictedPython/tests/transformer/test_slice.py
@@ -1,5 +1,6 @@
 from operator import getitem
-from tests.helper import restricted_eval
+
+from ..helper import restricted_eval
 
 
 def test_slice():
diff --git a/src/RestrictedPython/tests/transformer/test_subscript.py b/src/RestrictedPython/tests/transformer/test_subscript.py
@@ -1,4 +1,4 @@
-from tests.helper import restricted_exec
+from ..helper import restricted_exec
 
 
 SIMPLE_SUBSCRIPTS = """
diff --git a/src/RestrictedPython/tests/transformer/test_try.py b/src/RestrictedPython/tests/transformer/test_try.py
@@ -1,5 +1,6 @@
 from RestrictedPython import compile_restricted_exec
-from tests.helper import restricted_exec
+
+from ..helper import restricted_exec
 
 
 TRY_EXCEPT = """
diff --git a/src/RestrictedPython/tests/transformer/test_with_stmt.py b/src/RestrictedPython/tests/transformer/test_with_stmt.py
@@ -1,8 +1,9 @@
+import contextlib
+
 from RestrictedPython import compile_restricted_exec
 from RestrictedPython.Guards import guarded_unpack_sequence
-from tests.helper import restricted_exec
 
-import contextlib
+from ..helper import restricted_exec
 
 
 WITH_STMT_WITH_UNPACK_SEQUENCE = """
diff --git a/src/RestrictedPython/tests/transformer/test_yield.py b/src/RestrictedPython/tests/transformer/test_yield.py
@@ -34,7 +34,7 @@ def test_yield_from():
     def my_external_generator():
         my_list = [1, 2, 3, 4, 5]
         for elem in my_list:
-            yield(elem)
+            yield elem
 
     local = {}
     exec(result.code, {}, local)
diff --git a/tox.ini b/tox.ini

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ testenv-setenv = [`
`29`	`29`	`testenv-commands = [`
`30`	`30`	`"python -V",`
`31`	`31`	`"pip list",`
`32`		`- "pytest --cov=src --cov=tests --cov-report= {posargs}",`
	`32`	`+ "pytest --cov=src --cov-report= {posargs}",`
`33`	`33`	`]`
`34`	`34`	`testenv-additional = [`
`35`	`35`	`"",`
`@@ -51,7 +51,7 @@ testenv-additional = [`
`51`	`51`	`"depends = py36,py37,py38,py39,py39-datetime,py310,py311,coverage",`
`52`	`52`	`]`
`53`	`53`	`coverage-basepython = "python3.8"`
`54`		`-coverage-command = "pytest --cov=src --cov=tests --cov-report= {posargs}"`
	`54`	`+coverage-command = "pytest --cov=src --cov-report= {posargs}"`
`55`	`55`	`coverage-setenv = [`
`56`	`56`	`"COVERAGE_FILE=.coverage",`
`57`	`57`	`]`
`@@ -64,7 +64,6 @@ additional-rules = [`
`64`	`64`	`"recursive-include docs *.ast",`
`65`	`65`	`"recursive-include docs *.bat",`
`66`	`66`	`"recursive-include docs *.jpg",`
`67`		`- "recursive-include tests *.py",`
`68`	`67`	`]`
`69`	`68`
`70`	`69`	`[check-manifest]`