fileTestSuite.py

wheel (GHA via nightly.link)

An implementation of fileTestSuite spec for Python.

Authoring

fileTestSuiteTool --help

init

Creates a boilerplate of meta.json.

convert

1. Create a meta.json in a dir.
2. fileTestSuiteTool convert meta.json to convert into the binary representation
3. fileTestSuiteTool convert meta.ftsmeta to convert the binary representation back into JSON.

Testing

Via withFTS decorator

0. Download a suite of test files. It can be a git submodule.

from fileTestSuite.unittest import withFTS

2. Get path of the directory of the test suite:

thisDir = Path(__file__).resolve().absolute().parent
thisDir = thisDir / "testDataset"

3. Create a test

class Tests(unittest.TestCase):
	@withFTS(thisDir / "testDataset")  # the decorator, that must be within a `TestCase`
	def testProcessorImpl(self, challFile: Path, respFile: Path, paramsDict: typing.Optional[dict]=None) -> None:  # the signature must be this one!
		self._testChallengeResponsePair(challFile=challFile.read_bytes(), respFile=respFile.read_bytes(), paramsDict=paramsDict)  # your function

Pros:

• each file corresponds to a test
• it nicely interoperates with pytest

Cons:

• tests are loaded at class construction time.

Via a subTest

from fileTestSuite.unittest import FileTestSuiteTestCaseMixin

3. Create a test

class Tests(unittest.TestCase, FileTestSuiteTestCaseMixin):
	@property
	def fileTestSuiteDir(self) -> Path:
		return thisDir / "testDataset"

	def _testProcessorImpl(self, challFile: Path, respFile: Path, paramsDict: typing.Optional[dict]=None) -> None:  # the signature must be this one! Note the underscore.
		self._testChallengeResponsePair(challFile=challFile.read_bytes(), respFile=respFile.read_bytes(), paramsDict=paramsDict)  # your function

Pros, cons: the inversion of ones of withFTS.