branch: elpa/buttercup
commit 41424d5fa0732c96cd54fdbbcb8800a6e6170f34
Author: Ola Nilsson <ola.nils...@gmail.com>
Commit: Ola Nilsson <ola.nils...@gmail.com>
Add new public function buttercup-mark-skipped
which wraps buttercup--mark-skipped. buttercup-mark-skipped should
be used to mark specs as skipped *before* running the tests.
Solves the test filtering part of #161.
---
buttercup.el | 32 +++++++++++++++++++++++---------
tests/test-buttercup.el | 41 ++++++++++++++++++++++++++++++-----------
2 files changed, 53 insertions(+), 20 deletions(-)
diff --git a/buttercup.el b/buttercup.el
index 1d369e3..12e5b06 100644
--- a/buttercup.el
+++ b/buttercup.el
@@ -1383,18 +1383,32 @@ current directory."
(when (not (string-match "\\(^\\|/\\)\\." (file-relative-name file)))
(load file nil t))))
(when patterns
- (buttercup--mark-skipped buttercup-suites patterns))
+ (buttercup-mark-skipped (regexp-opt patterns) t))
(buttercup-run)))
-(defun buttercup--mark-skipped (suites patterns)
- "Mark any spec in SUITES not matching PATTERNS as skipped.
-SUITES is a list of suites. PATTERNS is a list of regexps."
+(defun buttercup-mark-skipped (matcher &optional reverse)
+ "Mark any spec that match MATCHER as skipped.
+MATCHER can be either a regex or a function taking a spec as the
+single argument. If REVERSE is non-nil, specs will be marked as
+pending when MATCHER does not match."
+ (cl-etypecase matcher
+ (string (buttercup--mark-skipped
+ buttercup-suites
+ (lambda (spec)
+ (string-match matcher (buttercup-spec-full-name spec)))
+ reverse))
+ (function (buttercup--mark-skipped buttercup-suites matcher reverse))))
+
+(defun buttercup--mark-skipped (suites predicate &optional reverse-predicate)
+ "Mark all specs in SUITES as skipped if PREDICATE(spec) is true.
+If REVERSE-PREDICATE is non-nil, mark spec where PREDICATE(spec)
+is false."
(dolist (spec (buttercup--specs suites))
- (let ((spec-full-name (buttercup-spec-full-name spec)))
- (unless (cl-dolist (p patterns)
- (when (string-match p spec-full-name)
- (cl-return t)))
- (buttercup--spec-mark-pending spec "SKIPPED")))))
+ ;; cond implements (xor reverse-predicate (funcall predicate
+ ;; spec)) as xor is introduced in Emacs 27
+ (when (cond ((not reverse-predicate) (funcall predicate spec))
+ ((not (funcall predicate spec)) reverse-predicate))
+ (buttercup--spec-mark-pending spec "SKIPPED"))))
;;;###autoload
(defun buttercup-run-markdown-buffer (&rest markdown-buffers)
diff --git a/tests/test-buttercup.el b/tests/test-buttercup.el
index 076978d..da69317 100644
--- a/tests/test-buttercup.el
+++ b/tests/test-buttercup.el
@@ -335,8 +335,8 @@ text properties using `ansi-color-apply'."
(expect (buttercup-suites-total-specs-pending suites)
:to-equal 2)))
(it "should also count skipped specs"
- (with-local-buttercup
- (buttercup--mark-skipped suites (list "skipped"))
+ (with-local-buttercup :suites suites
+ (buttercup-mark-skipped "skipped" t)
(expect (buttercup-suites-total-specs-pending suites)
:to-equal 3))))
@@ -1370,7 +1370,7 @@ text properties using `ansi-color-apply'."
:to-have-been-called-with
"Hello, world")))
-(describe "The `buttercup--mark-skipped' function"
+(describe "The `buttercup-mark-skipped' function"
:var (suites)
(before-each
(with-local-buttercup
@@ -1389,27 +1389,46 @@ text properties using `ansi-color-apply'."
(it "2-3 spec" (ignore))
(it "2-4 spec" (ignore)))
(setq suites buttercup-suites)))
- (it "should do nothing with a match-all pattern"
+ (it "should do nothing with a reversed match-all pattern"
(expect (buttercup-suites-total-specs-defined suites) :to-equal 11)
(expect (buttercup-suites-total-specs-pending suites) :to-equal 5)
- (buttercup--mark-skipped suites '("."))
+ (with-local-buttercup :suites suites
+ (buttercup-mark-skipped "." t))
(expect (buttercup-suites-total-specs-defined suites) :to-equal 11)
(expect (buttercup-suites-total-specs-pending suites) :to-equal 5)
- (with-local-buttercup
- (setq buttercup-suites suites)
+ (with-local-buttercup :suites suites
(buttercup-run))
(expect (buttercup-suites-total-specs-pending suites) :to-equal 5)
(expect (cl-count "SKIPPED" (buttercup--specs suites)
:key #'buttercup-spec-failure-description)
:to-equal 0))
- (it "should mark all specs as pending with no pattern"
- (buttercup--mark-skipped suites '())
+ (it "should mark all specs as pending with a reversed match none pattern"
+ (with-local-buttercup :suites suites
+ (buttercup-mark-skipped "[z-a]" t))
(expect (buttercup-suites-total-specs-defined suites) :to-equal 11)
(expect (buttercup-suites-total-specs-pending suites) :to-equal 11))
(it "should handle multiple patterns"
- (buttercup--mark-skipped suites '("1-1-[1-2]" "[12]-4"))
+ (with-local-buttercup :suites suites
+ (buttercup-mark-skipped (regexp-opt '("1-1-1" "1-1-2" "1-4" "2-4")) t))
+ (expect (buttercup-suites-total-specs-defined suites) :to-equal 11)
+ (expect (buttercup-suites-total-specs-pending suites) :to-equal 8))
+ (it "should support predicates"
+ (with-local-buttercup :suites suites
+ (buttercup-mark-skipped
+ (lambda (spec) (= 2 (cl-count ?- (buttercup-spec-full-name spec))))))
(expect (buttercup-suites-total-specs-defined suites) :to-equal 11)
- (expect (buttercup-suites-total-specs-pending suites) :to-equal 8)))
+ (expect (buttercup-suites-total-specs-pending suites) :to-equal 10))
+ (it "should support reversed predicates"
+ (with-local-buttercup :suites suites
+ (buttercup-mark-skipped
+ (lambda (spec) (= 2 (cl-count ?- (buttercup-spec-full-name spec))))
+ t))
+ (expect (buttercup-suites-total-specs-defined suites) :to-equal 11)
+ (expect (buttercup-suites-total-specs-pending suites) :to-equal 6))
+ (it "should signal an error for invalid matchers"
+ (with-local-buttercup
+ (expect (buttercup-mark-skipped 4) :to-throw)))
+ )
;;;;;;;;;;;;;;;;;;;;;
;;; ERT Compatibility
