chream / mockingbird

A small stubbing and mocking library for Common Lisp

Mockingbird

This package provides some useful stubbing and mocking macros for unit testing. Used when specified functions in a test should not be computed but should instead return a provided constant value.

This library was called cl-mock before but is/was NOT the library called "cl-mock" on quicklisp. I have now changed the name.

Usage

(in-package :cl-user)
(uiop:define-package :my-project
    (:use :closer-common-lisp
          :prove
          :mockingbird))
(in-package :my-project)

(defun foo (x) x)
(defun bar (x y) (+ x (foo x)))

(with-stubs ((foo 10))
  (is (foo 1 2) 10)) ;; --> T
  (is (bar 1 2) 2))  ;; --> T Only lexically stubbed!

(with-dynamic-stubs ((foo 10))
  (is (foo 1 2) 10)) ;; --> T
  (is (bar 1 2) 11))  ;; --> T Dynamically stubbed!

(with-mocks (foo bar)
  (is (foo 5) nil)    ;; --> T
  (is (bar 10) nil))  ;; --> T Args dont need to match!

(with-dynamic-mocks (foo bar)
  ...)

The arguments passed to mocked or stubbed functions are also saved.

(with-stubs ((foo 5))
  (foo 4 5)
  (call-times-for 'foo)                  ;; --> 1
  (verify-call-times-for 'foo 1)         ;; --> T
  (nth-mock-args-for 1 'foo)             ;; --> '(4 5)
  (verify-nth-call-args-for 1 'foo 4 5)  ;; --> T
  (verify-first-call-args-for 'foo 4 5)  ;; --> T
  (clear-calls))                         ;; --> no-value

These also work for the dynamic and mocking variants.

---

It is also possible to mock/stub individual methods.

(with-method-stubs ((foo (x y) 'is-stubbed)
                    (foo ((x aclass) (y aclass)) 'aclass-stubbed)
  ...)

The calls to methods are currently NOT saved so the above verification functions can not be used.

Installation

Clone this repository and put into asdf load path then

(ql:quickload :mockingbird)

To run tests:

(ql:test-system :mockingbird)

Author

• Christopher Eames (Chream) ([email protected])

Copyright

Copyright (c) 2016 Christopher Eames (Chream) ([email protected])

mockingbird's Issues

Export pbs ? Can not see `with-stubs` nor `nth-mock-args-for` and others

Hi,
Nice to find this lib :) I added it on Cliki.

I installed it with quicklisp (ql:quickload :cl-mock)) and tried to use it but I can't find all functions:

• (cl-mock:nth TAB => nothing
• (cl-mock::nth TAB => (with double colons) nth-value-for, nth-value, nthcdr
• I can't find with-stubs. (cl-mock:with- => with-mocks only, (cl-mock::with- => many more but no "with-stubs" nor with-dynamic-; can not find verify-*,…

so it looks like there is a pb with exported stuff (note that I have with-mocks). Also your use of uiop:define-package instead of asdf seems unusual to me but I can't judge.

Mocking functions defined in flet() or labels()

Mockingbird is a big help, but it only seems to allow me to mock a function that's been defined with defun(). Is it possible to mock a function that was defined (or overridden) in an flet() or labels()? When I try to do it, I see a message saying "does not have a defined original."

Thanks,
Rick

----------- Stack trace follows -------------

   UNDEFINED-STUB-FUNCTION: The defined stub function for TOURETZKY::INSTANT-LOSS-P does not have a defined original.

     1: ((FLET "H0" :IN #:DROP-THRU-TAG-69) The defined stub function for TOURETZKY::INSTANT-LOSS-P does not have a defined original.)
     2: (SB-KERNEL::%SIGNAL The defined stub function for TOURETZKY::INSTANT-LOSS-P does not have a defined original.)
     3: (ERROR UNDEFINED-STUB-FUNCTION NAME INSTANT-LOSS-P)
     4: (MOCKINGBIRD/SRC/FUNCTIONS:UNDEFINED-STUB-FUNCTION-ERROR INSTANT-LOSS-P)
     5: (MOCKINGBIRD/SRC/FUNCTIONS::DEFINED-FNS-BOUND-P ((INSTANT-LOSS-P T)))
     6: ((FLET "MAIN617" :IN #:DROP-THRU-TAG-69))
     7: ((FLET "MAIN67" :IN #:DROP-THRU-TAG-69))
     8: ((LAMBDA NIL :IN "/Users/rkawala/portacle/projects/touretzky/ch5-tests.lisp"))
     9: (ROVE/CORE/SUITE/PACKAGE:RUN-SUITE #S(ROVE/CORE/SUITE/PACKAGE::SUITE :NAME TOURETZKY :SETUP NIL :TEARDOWN NIL :BEFORE-HOOKS NIL :AFTER-HOOKS NIL :TESTS (EX5.6 ARRAY-POSITION ARRAY-LENGTH EX2.32 EX2.31 EX2.29 SEC2.15 EX2.23 EX2.22 EX2.21 EX2.20 EX2.19 EX2.18 SEC2.11.1 EX2.17 SEC2.10.4 EX2.15 EX2.13 EX2.12 EX2.9 EX2.8 EX2.7)))
     10: ((FLET "MAIN0" :IN ROVE/CORE/SUITE:RUN-SYSTEM-TESTS))
     11: (ROVE/CORE/SUITE:RUN-SYSTEM-TESTS TOURETZKY)
     12: (ROVE/MAIN:RUN TOURETZKY STYLE NIL ENV NIL)
     13: (SB-INT:SIMPLE-EVAL-IN-LEXENV (RUN TOURETZKY) #<NULL-LEXENV>)
     14: (SB-IMPL::SIMPLE-EVAL-PROGN-BODY ((RUN TOURETZKY) NIL) #<NULL-LEXENV>)
     15: (SB-INT:SIMPLE-EVAL-IN-LEXENV (PROGN (RUN TOURETZKY) NIL) #<NULL-LEXENV>)

Quicklisp !

Hello,
Can you ask to put this lib on Quicklisp ? ATM it prevents me from running a continuous integration :(
(btw it's as simple as asking on a new issue on Quicklisp: https://github.com/quicklisp/quicklisp-projects/issues/)

thanks !