Specification

​
A Specification is a list of definitions which will be run in sequence, and the results are collated. It is often created via the describe function.
Example usage:
local spec = require "cp.spec"
local describe, it = spec.describe, spec.it
​
return describe "a specification" {
    it "performs an assertion"
    :doing(function()
        assert(true, "should not fail")
    end),
}
API Overview
Functions - API calls offered directly by the extension
​is​
Constructors - API calls which return an object, typically one that offers API methods
​Specification​
Methods - API calls which can only be made on an object returned by a constructor
​onAfterEach​
​onBeforeEach​
​run​
​with​
API Documentation
Functions
​is​
Signature
cp.spec.Specification.is(instance) -> boolean
Type
Function
Description
Checks if the instance is an instance of Specification.
Returns
true if it's a Specification instance.
Constructors
​Specification​
Signature
cp.spec.Specification(name) -> cp.spec.Specification
Type
Constructor
Description
Creates a new test suite.
Methods
​onAfterEach​
Signature
cp.spec.Specification:onAfterEach(afterEachFn) -> cp.spec.Specification
Type
Method
Description
Specifies a function to execute after each of the contained specifications is run.
Parameters
afterEachFn - The function to run after each child runs.
Returns
The same cp.spec.Specification instance.
​onBeforeEach​
Signature
cp.spec.Specification:onBeforeEach(beforeEachFn) -> cp.spec.Specification
Type
Method
Description
Specifies a function to execute before each of the contained specifications is run.
Parameters
beforeEachFn - The function to run before each child runs.
Returns
The same cp.spec.Specification instance.
​run​
Signature
cp.spec.Specification:run() -> cp.spec.Run
Type
Method
Description
Runs the specification, returning the Run instance, already running.
Returns
The Run instance.
​with​
Signature
cp.spec.Specification:with(...) -> self
Type
Method
Description
Adds the provided definitions to the suite.
Parameters
... - the definitions to add.
Returns
The same Specification instance, with the definitions added.

Last modified 1yr ago

Signature	`cp.spec.Specification.is(instance) -> boolean`
Type	Function
Description	Checks if the `instance` is an instance of `Specification`.
Returns	`true` if it's a `Specification` instance.

Signature	`cp.spec.Specification(name) -> cp.spec.Specification`
Type	Constructor
Description	Creates a new test suite.

Signature	`cp.spec.Specification:onAfterEach(afterEachFn) -> cp.spec.Specification`
Type	Method
Description	Specifies a function to execute after each of the contained specifications is run.
Parameters	afterEachFn - The function to run after each child runs.
Returns	The same `cp.spec.Specification` instance.

Signature	`cp.spec.Specification:onBeforeEach(beforeEachFn) -> cp.spec.Specification`
Type	Method
Description	Specifies a function to execute before each of the contained specifications is run.
Parameters	beforeEachFn - The function to run before each child runs.
Returns	The same `cp.spec.Specification` instance.

Signature	`cp.spec.Specification:run() -> cp.spec.Run`
Type	Method
Description	Runs the specification, returning the Run instance, already running.
Returns	The Run instance.

Signature	`cp.spec.Specification:with(...) -> self`
Type	Method
Description	Adds the provided definitions to the suite.
Parameters	... - the definitions to add.
Returns	The same `Specification` instance, with the definitions added.

Specification

API Overview

API Documentation

Functions

​is​

Constructors

​Specification​

Methods

​onAfterEach​

​onBeforeEach​

​run​

​with​

is

Specification

onAfterEach

onBeforeEach

run

with