Initial commit with two functions.

Author: domdfcoding

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.2.2
+current_version = 0.0.0
 commit = True
 tag = True
 

README.rst

@@ -59,7 +59,7 @@ testing-tox
 .. |language| image:: https://img.shields.io/github/languages/top/python-coincidence/testing-tox
 	:alt: GitHub top language
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/python-coincidence/testing-tox/v0.2.2
+.. |commits-since| image:: https://img.shields.io/github/commits-since/python-coincidence/testing-tox/v0.0.0
 	:target: https://github.com/python-coincidence/testing-tox/pulse
 	:alt: GitHub commits since tagged version
 

__pkginfo__.py

@@ -26,7 +26,7 @@
 2021 Dominic Davis-Foster <dominic@davis-foster.co.uk>
 """
 
-__version__ = "0.2.2"
+__version__ = "0.0.0"
 repo_root = pathlib.Path(__file__).parent
 install_requires = (repo_root / "requirements.txt").read_text(encoding="utf-8").split('\n')
 extras_require = {}

formate.toml

@@ -31,5 +31,5 @@ lines_between_types = 0
 use_parentheses = true
 remove_redundant_aliases = true
 default_section = "THIRDPARTY"
-known_third_party = []
+known_third_party = [ "domdf_python_tools", "pytest", "tox",]
 known_first_party = "testing_tox"

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "whey"
 
 [project]
 name = "testing-tox"
-version = "0.2.2"
+version = "0.0.0"
 description = "Handy functions for testing tox plugins."
 readme = "README.rst"
 keywords = [ "tox",]

repo_helper.yml

@@ -6,7 +6,7 @@ author: 'Dominic Davis-Foster'
 email: 'dominic@davis-foster.co.uk'
 username: 'python-coincidence'
 assignee: 'domdfcoding'
-version: '0.2.2'
+version: '0.0.0'
 license: 'MIT'
 short_desc: 'Handy functions for testing tox plugins.'
 

requirements.txt

@@ -0,0 +1,3 @@
+domdf-python-tools>=2.8.1
+pytest>=6.2.2
+tox>=3.23.0

testing_tox/__init__.py

@@ -26,8 +26,59 @@
 #  OR OTHER DEALINGS IN THE SOFTWARE.
 #
 
+# stdlib
+import re
+import sys
+from typing import Iterable
+
+# 3rd party
+import pytest
+import tox.reporter  # type: ignore
+from domdf_python_tools.paths import PathPlus, in_directory
+
 __author__: str = "Dominic Davis-Foster"
 __copyright__: str = "2021 Dominic Davis-Foster"
 __license__: str = "MIT License"
-__version__: str = "0.2.2"
+__version__: str = "0.0.0"
 __email__: str = "dominic@davis-foster.co.uk"
+
+__all__ = ["prepare_stdout", "run_tox"]
+
+
+def run_tox(args: Iterable[str], workdir: PathPlus):
+	"""
+	Run ``tox`` in ``workdir`` with the given arguments.
+
+	:param args:
+	:param workdir:
+	"""
+
+	tox.reporter._INSTANCE.tw._file = sys.stdout
+
+	with pytest.raises(SystemExit), in_directory(workdir):
+		tox.cmdline(list(args))
+
+
+def prepare_stdout(stdout: str, toxinidir: PathPlus):
+	"""
+	Given the content of ``sys.stdout`` captured from a run of ``tox``,
+	prepare the output for regression tests.
+
+	This entails replacing the path ``toxindir`` with ``...``,
+	and removing deprecation warnings generated by ``packaging``.
+
+	:param stdout:
+	:param toxinidir:
+	"""  # noqa: D400
+
+	stdout = stdout.replace(str(toxinidir), "...")
+	stdout = re.sub(
+			r"\.\.\.[\\/]\.tox[\\/].*[\\/]lib[\\/]python3\.\d[\\/]site-packages[\\/]pip[\\/]"
+			r"_vendor[\\/]packaging[\\/]version\.py:\d*: "
+			r"DeprecationWarning: Creating a LegacyVersion has been deprecated and will be removed "
+			r"in the next major release, {2}(warnings\.warn\(|DeprecationWarning,)",
+			'',
+			stdout,
+			)
+
+	return stdout