Merge pull request #96 from F-Secure/working-directory-rts

feat: run tests from changes in workdir

Author: matveypashkovskiy

README.md

@@ -16,8 +16,14 @@ Plugin is supposed to be used to execute tests related to changes done locally o
 To start using pytest-rts build of coverage DB is needed. For [Trunk Based Development](https://trunkbaseddevelopment.com/) mapping database from `master` branch should be used, for [A successful Git branching model](https://nvie.com/posts/a-successful-git-branching-model/) - `develop`
 
 1. Install [pytest-cov](https://github.com/pytest-dev/pytest-cov) with `pip install pytest-cov`
-2. Execute `pytest --cov=[path to your package] --cov-context=test` which will run the entire test suite and build a mapping database in `.coverage` file
-3. Rename the coverage file `.coverage` produced by `pytest-cov` to your liking. Example: `mv .coverage pytest-rts-coverage`
+2. Create a `.coveragerc` file with the following contents inside to configure `pytest-cov`:
+```
+[run] 
+relative_files = True
+```
+ 
+3. Execute `pytest --cov=[path to your package] --cov-context=test` which will run the entire test suite and build a mapping database in `.coverage` file
+4. Rename the coverage file `.coverage` produced by `pytest-cov` to your liking. Example: `mv .coverage pytest-rts-coverage`
 
 ### Local usage
 

pytest_rts/plugin.py

@@ -6,7 +6,8 @@
 from _pytest.config.argparsing import Parser
 
 from pytest_rts.pytest.runner_plugin import RunnerPlugin
-from pytest_rts.utils.common import get_existing_tests
+from pytest_rts.utils.common import get_existing_tests, get_tests_current
+from pytest_rts.utils.git import is_git_repo
 
 
 def pytest_addoption(parser: Parser) -> None:
@@ -26,11 +27,15 @@ def pytest_configure(config: Config) -> None:
  if not config.option.rts:
  return
 
+ if not is_git_repo():
+ pytest.exit("pytest-rts: Cannot find a Git repository in the current folder", 2)
+
  if not config.option.rts_coverage_db:
- pytest.exit("No coverage file provided", 2)
+ pytest.exit("pytest-rts: No coverage file provided", 2)
 
  if not os.path.exists(config.option.rts_coverage_db):
- pytest.exit("Provided coverage file does not exist", 2)
+ pytest.exit("pytest-rts: Provided coverage file does not exist", 2)
 
  existing_tests = get_existing_tests(config.option.rts_coverage_db)
- config.pluginmanager.register(RunnerPlugin(existing_tests))
+ workdir_tests = get_tests_current(config.option.rts_coverage_db)
+ config.pluginmanager.register(RunnerPlugin(existing_tests, workdir_tests))

pytest_rts/pytest/runner_plugin.py

@@ -12,9 +12,10 @@
 class RunnerPlugin:
  """Plugin class for pytest"""
 
- def __init__(self, existing_tests: Set[str]) -> None:
+ def __init__(self, existing_tests: Set[str], tests_from_changes: Set[str]) -> None:
  """Set existing tests"""
  self.existing_tests = existing_tests
+ self.tests_from_changes = tests_from_changes
 
  def pytest_collection_modifyitems(
  self,
@@ -24,7 +25,9 @@ def pytest_collection_modifyitems(
  ) -> None:
  """Select only specific tests for running"""
  original_length = len(items)
- items[:] = filter_pytest_items(items, self.existing_tests)
+ items[:] = filter_pytest_items(
+ items, self.existing_tests, self.tests_from_changes
+ )
  session.config.hook.pytest_deselected(
  items=([FakeItem(session.config)] * (original_length - len(items)))
  )

pytest_rts/tests/helper_project/.coveragerc

@@ -0,0 +1,2 @@
+[run]
+relative_files=True

pytest_rts/tests/helper_project/.gitignore

@@ -0,0 +1,3 @@
+.coverage
+rts-coverage.1234
+*__pycache__*

pytest_rts/tests/helper_project/changes/decorated/change_decorator.txt

@@ -0,0 +1,29 @@
+"""
+Decorator, to check that changes in the decorator switch on tests using
+decorated functions.
+"""
+from functools import wraps
+from typing import Callable
+
+def decrement(func: Callable[[int], int]) -> Callable[[int], int]:
+ """
+ Decrements the value returned by the decorated function.
+ """
+ @wraps(func)
+ def _wrapper(num):
+ return func(num) + 1
+
+ return _wrapper
+
+
+def modify_by(delta: int):
+ """
+ Adds delta to the value returned by the decorated function.
+ """
+ def decorator(func: Callable[[int], int]) -> Callable[[int], int]:
+ @wraps(func)
+ def _wrapper(num):
+ return func(num) + delta
+ return _wrapper
+ return decorator
+

pytest_rts/tests/helper_project/changes/decorated/change_decorator_2.txt

@@ -0,0 +1,29 @@
+"""
+Decorator, to check that changes in the decorator switch on tests using
+decorated functions.
+"""
+from functools import wraps
+from typing import Callable
+
+def decrement(func: Callable[[int], int]) -> Callable[[int], int]:
+ """
+ Decrements the value returned by the decorated function.
+ """
+ @wraps(func)
+ def _wrapper(num):
+ return func(num) - 1
+
+ return _wrapper
+
+
+def modify_by(delta: int):
+ """
+ Adds delta to the value returned by the decorated function.
+ """
+ def decorator(func: Callable[[int], int]) -> Callable[[int], int]:
+ @wraps(func)
+ def _wrapper(num):
+ return func(num) * delta
+ return _wrapper
+ return decorator
+

pytest_rts/tests/helper_project/changes/init/change_function_one.txt

@@ -0,0 +1,2 @@
+def one():
+ return 2

pytest_rts/tests/helper_project/changes/shop/change_get_price.txt

@@ -0,0 +1,38 @@
+
+class Shop:
+
+ def __init__(self,item_price,items,money):
+ self.item_price = item_price
+ self.items = items
+ self.money = money
+
+ def buy_item(self):
+ if self.items > 0:
+ self.items = self.items - 1
+ self.money = self.money + self.item_price
+ 
+ def get_items(self):
+ return self.items
+
+ def get_item_price(self):
+ return self.item_price + 1 - 1
+
+ def get_money(self):
+ return self.money
+
+ def calculate_useless_stuff(self):
+ k = 2
+ s = "ATGATATCATCGACGATGTAG"
+ context = {} 
+ for i,c in enumerate(s):
+ if (i+k >= len(s)):break
+ substring = s[i:i+k]
+ if substring not in context:
+ context[substring] = s[i+k]
+ else:
+ context[substring] = context[substring] + s[i+k] 
+ 
+ return context
+
+
+ 

pytest_rts/tests/helper_project/src/decorated.py

@@ -0,0 +1,17 @@
+"""
+Decorated function, to test that changes in the decorator code switch on tests
+using the function itself.
+"""
+
+from .decorators import decrement, modify_by
+
+@decrement
+def decremented_square(num: int) -> int:
+ """Square the number and decrement the result."""
+ return num * num
+
+
+@modify_by(3)
+def modified_double(num: int) -> int:
+ """Double the number and and three to the result."""
+ return 2 * num