Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SIGNAL a condition on test failures, for use with ASDF:TEST-SYSTEM #58

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

vsedach
Copy link

@vsedach vsedach commented Sep 15, 2019

PLEASE DO NOT MERGE YET

See https://gitlab.common-lisp.net/asdf/asdf/merge_requests/124 and ASDF mailing list discussion https://mailman.common-lisp.net/pipermail/asdf-devel/2019-September/thread.html for details.


Hello!

I recently wrote a script to run FiveAM tests for one of my
libraries on many different implementations on your own machine:
https://gitlab.common-lisp.net/uri-template/uri-template2/blob/master/run-tests.lisp

I do not want to copy-paste that script for all of my libraries. It
would be nice to contribute a generalized version of the script to
Roswell (on which the script is based), and just be able to say "ros
test my-system in all installed implementations" for any system.

The first step to doing that is to get ASDF:TEST-SYSTEM to report
errors using a common interface.

Because of the way ASDF is designed, ASDF:TEST-SYSTEM needs to use
conditions to signal test failures. I like this idea. Since you do
not have to handle conditions raised by SIGNAL, the functionality can
be added without impacting existing use or interfaces of FiveAM (the
use of WARNING instead of ERROR as the parent condition of
TEST-SPEC-FAILURE also ensures this, as many people tend to abuse
HANDLER-CASE to indiscriminately catch ERRORs).

With this patch, all projects that use FiveAM and define ASDF test-op
should be testable from a generic version of the Roswell script
without any changes.

The basic mechanism for test automation with FiveAM is then very
simple:

(handler-case (asdf:test-system "system")
(fiveam:test-spec-failure (condition)
(princ condition uiop:stderr)
(uiop:quit 1)))

Other test libraries can have supported added as well:

(handler-case (asdf:test-system "system")
((or fiveam:test-spec-failure prove:test-failure) (condition)
(princ condition uiop:stderr)
(uiop:quit 1)))

The goal is to introduce a parent condition in ASDF that FiveAM, etc., will then inherit from:

(handler-case (asdf:test-system "system")
(asdf:test-failure (condition)
(princ condition uiop:stderr)
(uiop:quit 1)))

Ultimately, any system using any test library should be testable this way, ensuring that test automation becomes trivial to build.

I am going to propose adding the parent condition to ASDF, but in the
meantime (until the ASDF patch makes it to the repository, another
release comes out, release becomes widely available…), I would like to get this code into FiveAM.

Vladimir

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant