Packages > pkl

pkl.test0.28.0

Overview
Properties
Methods

open module pkl.test

A template for writing tests.

Module URI:: pkl:test
Pkl version:: 0.28.0 or higher
Known subtypes:
Known usages:
All versions:

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.

link

facts: Mapping<String, Listing<Boolean>>?

Named groups of boolean expressions that are expected to evaluate to true.

If an expression evaluates to false, it is reported as a test failure.

Example:

// for brevity, code under test is defined here
function multiply(a, b) = a * b

facts {
  ["multiply numbers"] {
    multiply(3, 5) == 15
    multiple(3, 0) == 1 // will be reported as a test failure
  }
  // more facts here
}

link
examples: Mapping<String, Listing<unknown>>?

Named groups of expressions whose results are expected to match results stored in $filename-expected.pcf.
If $filename-expected.pcf does not exist, it is generated based on the examples' actual results. After verifying the contents of this file, it should be added to version control.

If $filename-expected.pcf does exist, its results are compared one-by-one to actual results. If an actual result does not compare equal (according to ==) to its expected result, it is reported as a test failure, and $filename-actual.pcf is generated to aid with debugging.

Example:
```
// for brevity, code under test is defined here
local function createPigeon(_age) = new {
  name = "Pigeon"
  age = _age
}

examples {
  ["create Pigeons"] {
    createPigeon(21)
    createPigeon(42)
  }
  // more examples here
}
```
When the above code is evaluated for the first time, the following $filename-expected.pcf is generated:
```
examples {
  ["create Pigeons"] {
    new {
      name = "Pigeon"
      age = 21
    }
    new {
      name = "Pigeon"
      age = 42
    }
  }
}
```
To update expected results after making changes, delete $filename-expected.pcf and evaluate the test module again.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```
link

function

catch(fun: () -> Any): String

Applies fun and returns the error thrown.

Throws if fun did not throw an error.
link

function

catchOrNull(fun: () -> Any): String?

Applies fun and returns the error thrown.

Returns null if fun did not throw an error.