Ledger API Test Tool¶
The Ledger API Test Tool is a command line tool for testing the correctness of implementations of the Ledger API, i.e. DAML ledgers. For example, it will show you if there are consistency or conformance problem with your implementation.
Its intended audience are developers of DAML ledgers, who are using the DAML Ledger Implementation Kit to develop a DAML ledger on top of their distributed-ledger or database of choice.
Use this tool to verify if your Ledger API endpoint conforms to the DA Ledger Model.
Please note that currently the tool is in experimental status.
Downloading the tool¶
Run the following command to fetch the tool:
curl -L 'https://bintray.com/api/v1/content/digitalassetsdk/DigitalAssetSDK/com/daml/ledger/testtool/ledger-api-test-tool_2.12/$latest/ledger-api-test-tool_2.12-$latest.jar?bt_package=sdk-components' -o ledger-api-test-tool.jar
This will create a file
ledger-api-test-tool.jar in your current directory.
.dar files required to run the tests¶
Before you can run the Ledger API test tool on your ledger, you need to load a specific set of DAML templates onto your ledger.
To obtain the corresponding
$ java -jar ledger-api-test-tool.jar --extract
This writes all
.darfiles required for the tests into the current directory.
.darfiles into your Ledger.
Running the tool against a custom Ledger API endpoint¶
Run this command to test your Ledger API endpoint exposed at host
at a port
$ java -jar ledger-api-test-tool.jar <host>:<port>
$ java -jar ledger-api-test-tool.jar localhost:6865
If any test embedded in the tool fails, it will print out details of the failure for further debugging.
Exploring options the tool provides¶
Run the tool with
--help flag to obtain the list of options the tool provides:
$ java -jar ledger-api-test-tool.jar --help
Selecting tests to run¶
Running the tool without any arguments runs the default tests. Use the following command line flags to select which tests to run:
--list: print all available tests to the console
--include: only run the tests provided as argument
--exclude: do not run the tests provided as argument
--all-tests: run all default and optional tests. This flag can be combined with the
Examples (hitting a single participant at
$ java -jar ledger-api-test-tool.jar --include TestA localhost:6865
$ java -jar ledger-api-test-tool.jar --exclude TestB localhost:6865
$ java -jar ledger-api-test-tool.jar --all-tests localhost:6865
$ java -jar ledger-api-test-tool.jar --all-tests --exclude TestC
Try out the Ledger API Test Tool against DAML Sandbox¶
If you wanted to test out the tool, you can run it against DAML Sandbox. To do this:
$ java -jar ledger-api-test-tool.jar --extract $ daml sandbox -- *.dar $ java -jar ledger-api-test-tool.jar
This should always succeed, as the Sandbox is tested to correctly implement the Ledger API. This is useful if you do not have yet a custom Ledger API endpoint.
Testing your tool from continuous integration pipelines¶
To test your ledger in a CI pipeline, run it as part of your pipeline:
$ java -jar ledger-api-test-tool localhost:6865 2>&1 /dev/null $ echo $? 0
The tool is tailored to be used in CI pipelines: as customary, when the tests succeed, it will produce minimal output and return the success exit code.
Using the tool with a known-to-be-faulty Ledger API implementation¶
--must-fail if you expect one or more or the scenario tests to
fail. If enabled, the tool will return the success exit code when at least one
test fails, and it will return a failure exit code when all tests succeed:
java -jar ledger-api-test-tool.jar --must-fail localhost:6865
This is useful during development of a DAML ledger implementation, when tool needs to be used against a known-to-be-faulty implementation (e.g. in CI). It will still print information about failed tests.
We used this flag during tool development to ensure that the tool does not always return success.
Tuning the testing behaviour of the tool¶
Use the command line options
--command-submission-ttl-scale-factor to tune timeouts applied by the tool.
--timeout-scale-factorto a floating point value higher than 1.0 to make the tool wait longer for expected events coming from the DAML ledger implementation under test. Conversely use values smaller than 1.0 to make it wait shorter.
--command-submission-ttl-scale-factorto adjust the time-to-live of commands as represented by the MRT (Maximum Record Time) on the Ledger API. The default value is 1.0 and will be applied to the default TTL, which is the maximum TTL as returned by the LedgerConfigurationService. In any case, the used TTL value will be clipped to stay between the minimum and maximum TTL.