A tool for running in-source unittests for Anwer Set Programming (ASP)
Project description
asp-selftest
In-source test runner for Answer Set Programming (ASP) with Clingo.
With in-source testing, source and tests stay together in the same file, hence the tests are also expressed in ASP.
The tests are as non-obstrusive as possible and and many examples are idiomatic in nature and could have been written in another way. These idioms are merely ways to provide clearer code and avoid mistakes. As such, they have value in themselves.
MINIMALISTIC APPROACH
Tests could be as simple as creating ordinary predicates that become true when certain conditions hold. One could name such a predicate assert
. Imagine:
assert("output down on T=0") :- output(0, "X").
Simple as it is, this can already be very useful when combined with #show
:
assert("output down on T=0") :- output(0, "X").
#show assert/1.
The program is compatible with normal Clingo. It will output all asserts that succeed, suitable for manual inspection. It is very useful for initial development. Verifying the asserts is much easier because they are more to the point (more functional) than core model parameters.
But what about failing asserts? One that should be true, but it isn't? Without special measures, it will silently be absent.
Signalling failures
[runner checks for asserts]
Asserting Negations
[write sets, not 'not']
RUNNING
After installation via pip, run it using:
$ asp-tests <file.lp> ...
Alternatively you can run it as a module, given that either the working directory of the PYTHONPATH are set to 'src':
$ python -m asp_selftest <file.lp> ...
There are options to silents the in-source Python tests etc, have a look:
$ asp-tests -h
TESTING
The code is equiped with in-source Python tests which always run. You can silence them with --silent.
TODO
To use the program without the tests: Not Yet Implemented. But you can use the base
program anywhere of course, since all #program
s are ignored by default.
IDEA
-
Use
#program
's to identify units and their dependencies. Here we have a unit calledunitA
with a unit test for it calledtestunitA
.#program unit_A. #program test_unit_A(unit_A).
The implicit program
base
(see Clingo Guide) must be referenced explicitly if needed. -
Extend the notion of
#program
by allowing the use of functions instead of only constants. This allows#program
units with constants being tested. Here is a unitstep
that is tested with constanta
being substituted with2
:#program step(a). #program test_step(step(2)).
Note that using this feature makes the program incompatible with Clingo. The test runner has an option to transform a extended program back to compatible Clingo without running the tests.
-
Within a test program, use
assert
with@all
to ensure universal truths that must be in every model. We use@all
to communicate to the runtime that this particular assert must be checked for presence in every model. Its argument is just a name for identification.#program step(n). fact(n). #program test_step(step(3)). assert(@all("step fact")) :- fact(3).
Note that
"step fact"
is just a way of distinquishing the assert. It can be an atom, a string, a number or anything else. Pay attention to the uniqueness in case of variables in the body. Take note of point 5 below. -
To enable testing constraints and to guard tests for empty model sets, we use
@models
to check for the expected number of models. In the example above, we would add:assert(@models(1)).
-
Care must be taken if variables in the body lead to expansion and conjunctions. See
duplicate_assert.lp
. The system gives a warning for:assert(@all(id_uniq)) :- def_id(Id, _, _), { def_id(Id, _, _) } = 1.
Instead you have to write:
assert(@all(id_uniq(Id))) :- def_id(Id, _, _), { def_id(Id, _, _) } = 1.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file asp_selftest-0.0.18.tar.gz
.
File metadata
- Download URL: asp_selftest-0.0.18.tar.gz
- Upload date:
- Size: 29.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d8a1d08066e9c21ef3d827fbbe84f32a4b96801d543504f757cbe78ee2663196 |
|
MD5 | a222f8d45d3f0211593cec9f08eef4a4 |
|
BLAKE2b-256 | 2ff48d634e14e5dec595e2cbc70ddcd8986a4c782fb0f93a3701a4d2cf9a8fc5 |
File details
Details for the file asp_selftest-0.0.18-py3-none-any.whl
.
File metadata
- Download URL: asp_selftest-0.0.18-py3-none-any.whl
- Upload date:
- Size: 30.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4070b6ef8221248c86e1745fa05727863570ae47df537e87ad7de4264bb4afd3 |
|
MD5 | 526fa0f65dcde0bc5e540562f3191e20 |
|
BLAKE2b-256 | eda783231867ff7cbb647c0fd544e4ba874fa850842869100218b92d76c41495 |