Version: 0.17.0

Testing LIGO

Testing LIGO code#

The LIGO command-line interpreter provides sub-commands to test directly your LIGO code. The three main sub-commands we currently support are:

  • interpret

  • test

  • dry-run

We will show how to use the first two, while an example on how to use the third one was already explained in the here.

Testing with test#

The sub-command test can be used to test a contract using LIGO.

⚠️ Please keep in mind that this sub-command is still BETA, and that there are features that are work in progress and are subject to change. No real test procedure should rely on this sub-command alone.

To test the contract we need to create a testing file. This file has access to an additional Test module. The test file is interpreted, and implicitly updates a global state (the tezos context). To do that, the LIGO interpreter uses the same library that Tezos internally uses for testing. Here we will simulate that the contract is actually deployed to an address, and check that the resulting storage is 42 after executing a call to Increment:

Note: the types present in the context of the testing file differ from the ones when writing a contract.

Code insertion are used to write code to be compiled in the context of a contract. Holding all the default types you are used to and the ones you defined in your file (if specified).

const testme_test = "./gitlab-pages/docs/advanced/src/testme.ligo"
const test = block {
const init_storage = Test.compile_expression (Some(testme_test), [%pascaligo ({| (10 : int) |} : ligo_program) ]);
const originated_contract = Test.originate(testme_test, "main", init_storage);
const addr = originated_contract.0;
const param = Test.compile_expression (Some (testme_test), [%pascaligo ({| Increment(32) |} : ligo_program)]);
const transfer_result = Test.transfer(addr, param, 0n);
const result = Test.get_storage(addr);
const check = Test.compile_expression ((None : option(string)), [%pascaligo ({| (42: int) |} : ligo_program)]);
Test.log(result);
} with (Test.michelson_equal(result, check))

Notice that now we wrote the test property inside LIGO, using:

  • Test.compile_expression to compile an expression.

  • Test.originate to deploy a contract.

  • Test.transfer to simulate an external call.

  • Test.get_storage to check the storage from a contract.

  • Test.log to log variables.

  • Test.michelson_equal to check if the Michelson results are equal.

A property like testme is a definition of a boolean value. The sub-command test evaluates a test, and returns whether it was successful or not (i.e. returned true or false).

ligo test gitlab-pages/docs/advanced/src/test.ligo "test"
// Outputs:
// Test passed with true

More info about the Test module available when using the sub-command test.

Unit testing a function#

Consider a map binding addresses to amounts and a function removing all entries in that map having an amount less to a given threshold.

(*This is remove-balance.ligo*)
type balances is map (address, tez)
function balances_under (const b : balances ; const threshold : tez) is
block {
const f =
function (const x : balances * (address * tez)) is
block {
const (acc, (k,v)) = x ;
} with if v < threshold then Map.remove (k, acc) else acc ;
} with Map.fold (f, b, b)

Let us imagine that we want to test this function against a range of thresholds with the LIGO test framework.

First, let's define a variable for the file under test and reset the state with 5 bootstrap accounts (we are going to use the bootstrap addresses later)

const under_test : option (string) = Some ("./gitlab-pages/docs/advanced/src/remove-balance.ligo")
const _u = Test.reset_state (5n, (list [] : list (nat)))

Now build the balances map that will serve as the input of our test.
Because types/values living in the context of balances_under are not directly accessible from our unit-test code, you will need to compile bootstrap account addresses to michelson using Test.compile_value and inject the resulting michelson value in the map using Test.compile_expression_subst.
Note that within the code injection (e.g. {| <code> |}), you have access to all the types accesible from the tested file.

function bs_addr (const i : int) is Test.compile_value (Test.nth_bootstrap_account (i))
const balances : michelson_program =
Test.compile_expression_subst
( under_test,
[%pascaligo ({| map [ ( $a1 : address) -> 10tz ; ( $a2 : address) -> 100tz ; ( $a3 : address) -> 1000tz ] |} : ligo_program)],
list [("a1", bs_addr (1)); ("a2", bs_addr (2)); ("a3", bs_addr (3))] )

In general, you can use Test.compile_value for simple types such as int; string; nat; bytes; address and pair which will directly compile its argument to michelson without the need of writing a LIGO code injection. Otherwise, use Test.compile_expression_subst or Test.compile_expression to compile an expression written in the same manner as in the tested file.

Test.compile_expression_subst will bind a new variable holding a michelson injection for each hole (e.g. $a1) present in the substitution before compiling the expression.

Our simple test loop will call balances_under with the compiled map defined above, get the size of the resulting map and compare it to an expected value with Test.michelson_equal.
The threshold - of type nat in the test file but of type tez in the tested file - also needs to be dynamically compiled from the test loop and injected in the function call using Test.compile_expression_subst.

We also print the actual and expected sizes for good measure.

function to_tez (const i : nat) is
Test.compile_expression_subst
( (None : option (string)),
[%pascaligo ({| $i * 1tez |} : ligo_program)],
list [("i", Test.compile_value (i))] )
const test =
List.iter (
(function (const threshold : nat ; const expected_size : nat) is
block {
const expected_size = Test.compile_value (expected_size);
const size_ = Test.compile_expression_subst
( under_test,
[%pascaligo ({| Map.size (balances_under ($b, $threshold)) |} : ligo_program)],
list [("b", balances); ("threshold", to_tez (threshold))]
);
Test.log (("expected", expected_size));
Test.log (("actual", size_));
} with
assert (Test.michelson_equal (size_, expected_size))),
list [(15n, 2n); (130n, 1n); (1200n, 0n)])

You can now execute the test:

Testing with interpret#

The sub-command interpret allows to interpret an expression in a context initialised by a source file. The interpretation is done using Michelson's interpreter.

Let's see how it works on an example. Suppose we write the following contract which we want to test.

// This is testme.ligo
type storage is int
type parameter is
Increment of int
| Decrement of int
| Reset
type return is list (operation) * storage
// Two entrypoints
function add (const store : storage; const delta : int) : storage is
store + delta
function sub (const store : storage; const delta : int) : storage is
store - delta
(* Main access point that dispatches to the entrypoints according to
the smart contract parameter. *)
function main (const action : parameter; const store : storage) : return is
((nil : list (operation)), // No operations
case action of
Increment (n) -> add (store, n)
| Decrement (n) -> sub (store, n)
| Reset -> 0
end)

This contract keeps an integer as storage, and has three entry-points: one for incrementing the storage, one for decrementing the storage, and one for resetting the storage to 0.

As a simple property, we check whether starting with an storage of 10, if we execute the entry-point for incrementing 32, then we get a resulting storage of 42. For checking it, we can interpret the main function:

ligo interpret --init-file gitlab-pages/docs/advanced/src/testing/testme.ligo "main (Increment (32), 10)"
// Outputs:
// ( LIST_EMPTY() , 42 )

With the argument --init-file we pass the contract we want to test, and the sub-command requires also the expression to evaluate in that context, in this case, a call to our contract (main) with parameter Increment (32) and storage 10. As a result, we can check that the resulting storage is 42 (the second component of the pair), and there are no further operations to execute (the first component).

We can tune certain parameters of the execution by passing them as arguments:

--amount=AMOUNT (absent=0)
AMOUNT is the amount the Michelson interpreter will use for the
transaction.
--balance=BALANCE (absent=0)
BALANCE is the balance the Michelson interpreter will use for the
contract balance.
--now=NOW
NOW is the NOW value the Michelson interpreter will use
(e.g. '2000-01-01T10:10:10Z')
--sender=SENDER
SENDER is the sender the Michelson interpreter transaction will use.
--source=SOURCE
SOURCE is the source the Michelson interpreter transaction will use.