The cl-mock Reference Manual

4.1.1 cl-mock/cl-mock.asd

Source

cl-mock.asd.

Parent Component

cl-mock (system).

ASDF Systems

cl-mock.

4.1.2 cl-mock-basic/cl-mock-basic.asd

Source

cl-mock-basic.asd.

Parent Component

cl-mock-basic (system).

ASDF Systems

cl-mock-basic.

4.1.3 cl-mock/src/facade.lisp

Source

cl-mock.asd.

Parent Component

src (module).

Public Interface

answer (macro).

Internals

true (function).

4.1.4 cl-mock-basic/src/package.lisp

Source

cl-mock-basic.asd.

Parent Component

src (module).

Packages

cl-mock.

4.1.5 cl-mock-basic/src/functions.lisp

Source

cl-mock-basic.asd.

Parent Component

src (module).

Public Interface

• call-with-function-bindings (function).
• dflet (macro).
• maybe-fdefinition (function).
• progf (macro).
• set-fdefinition (function).
• set-or-unbind-fdefinition (function).

4.1.6 cl-mock-basic/src/mock.lisp

Source

cl-mock-basic.asd.

Parent Component

src (module).

Public Interface

• *arguments* (special variable).
• *previous* (special variable).
• call-previous (function).
• call-with-mocks (function).
• if-called (function).
• invocations (function).
• register-mock (function).
• unhandled (function).
• with-mocks (macro).

Internals

• *invocations* (special variable).
• *invocations-lock* (special variable).
• *mock-bindings* (special variable).
• *recordp* (special variable).
• find-and-invoke-mock (function).
• record-invocation (function).

4.2.1 cl-mock-basic/README.md

Source

cl-mock-basic.asd.

Parent Component

cl-mock-basic (system).

6.1.1 Special variables

Special Variable: *arguments* ¶

Package

cl-mock.

Source

mock.lisp.

Special Variable: *previous* ¶

Package

cl-mock.

Source

mock.lisp.

6.1.2 Macros

Macro: answer (call &body forms) ¶

Package

cl-mock.

Source

facade.lisp.

Macro: dflet ((&rest definitions) &body body) ¶

Like FLET, but dynamically sets the FDEFINITIONS during the duration of the BODY.

Package

cl-mock.

Source

functions.lisp.

Macro: progf (functions values &body body) ¶

Like PROGV, but for FUNCTIONS.

Package

cl-mock.

Source

functions.lisp.

Macro: with-mocks ((&key recordp) &body body) ¶

Execute BODY in a new mocking context. Invocations will be recorded if RECORDP is set (default true).

Package

cl-mock.

Source

mock.lisp.

6.1.3 Ordinary functions

Function: call-previous (&rest args) ¶

Invokes the previous binding either with the current arguments or with the given ones. Use *PREVIOUS*/*ARGUMENTS* directly in edge cases.

Package

cl-mock.

Source

mock.lisp.

Function: call-with-function-bindings (functions values function &optional previous) ¶

Calls FUNCTION while temporarily binding all FUNCTIONS with the given names to VALUES. See PROGF and PROGV. If PREVIOUS is set, it has to be the list of original values for each function.

Package

cl-mock.

Source

functions.lisp.

Function: call-with-mocks (function &key recordp) ¶

Call FUNCTION with a new mocking context. Invocations will be recorded if RECORDP is set (default true).

Package

cl-mock.

Source

mock.lisp.

Function: if-called (name function &key at-start) ¶

Registers a new binding, which should return true if it handled the invocation. If AT-START is set, the binding is put at the start of the bindings list instead. Calls REGISTER-MOCK automatically.

Package

cl-mock.

Source

mock.lisp.

Function: invocations (&optional name) ¶

Package

cl-mock.

Source

mock.lisp.

Function: maybe-fdefinition (name) ¶

If NAME is FBOUNDP, return its FDEFINITION, else NIL.

Package

cl-mock.

Source

functions.lisp.

Function: register-mock (name) ¶

Registers a mocked function under NAME. The mocked function will return no values. See IF-CALLED to add some behaviour to it.

Package

cl-mock.

Source

mock.lisp.

Function: set-fdefinition (name value) ¶

FUNCALLABLE expansion of (SETF (FDEFINITION NAME) VALUE).

Package

cl-mock.

Source

functions.lisp.

Function: set-or-unbind-fdefinition (name value) ¶

If VALUE is true, set the FDEFINITION of NAME to it, else FMAKUNBOUND it completely.

Package

cl-mock.

Source

functions.lisp.

Function: unhandled () ¶

Package

cl-mock.

Source

mock.lisp.

6.2.1 Special variables

Special Variable: *invocations* ¶

Package

cl-mock.

Source

mock.lisp.

Special Variable: *invocations-lock* ¶

Package

cl-mock.

Source

mock.lisp.

Special Variable: *mock-bindings* ¶

Package

cl-mock.

Source

mock.lisp.

Special Variable: *recordp* ¶

Package

cl-mock.

Source

mock.lisp.

6.2.2 Ordinary functions

Function: find-and-invoke-mock (binding *arguments*) ¶

Looks for a compatible mock (i.e. calls the TEST until one returns true) and executes it. If no mock was found, no values are returned instead.

Package

cl-mock.

Source

mock.lisp.

Function: record-invocation (record) ¶

Package

cl-mock.

Source

mock.lisp.

Function: true (&rest arguments) ¶

Package

cl-mock.

Source

facade.lisp.