digital-asset/daml
1
1
Fork 0
mirror of https://github.com/digital-asset/daml.git synced 2024-09-20 01:07:18 +03:00
Code Issues Projects Releases Wiki Activity

Add notes on writing tests (#2264)

Browse Source
This commit is contained in:
Robert Autenrieth 2019-07-24 07:28:50 +02:00 committed by GitHub
parent 53de5edbc1
commit 164d57a48e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
ledger/ledger-api-integration-tests/README.md
View File

@ -61,3 +61,43 @@ participants, and executes the configured scenarios (to be precise,
the SemanticTester creates a list of commands and expected responses
based on the content of the scenarios, and executes these commands on
the backend).
## Writing integration tests
The integration tests should work with any conformant DAML ledger.
This includes not only our sandbox, but also other ledger implementations.
The following are important considerations for writing integration tests.
### Exclusive access
Don't assume you have exclusive access to the ledger.
Other tests or applications may be running concurrently.
* Don't make assumptions on how ledger offsets evolve.
Other applications may modify the ledger in between your commands.
* Make sure command and workflow IDs are globally unique,
and not shared between test runs.
* See `TestIdsGenerator.testCommandId` and `TestIdsGenerator.testWorkflowId`
* Make sure party names are globally unique,
and not shared between test runs.
* See `TestIdsGenerator.testPartyName`
* Thanks to our privacy model, using unique party names and workflow IDs
will essentially create a private sub-ledger and make sure none of your actions interfere with the rest of the ledger.
### Previous ledger content
Don't make assumptions on the previous content of the ledger.
The ledger may be completely empty, or it may be a long running ledger with millions of ledger entries.
* Don't start streaming from genesis.
Instead, at the start of the test, read the ledger begin,
and start all streaming from there.
* Make sure all required DAML packages are uploaded
and all required parties are allocated before the test runs.
Note that the packages may or may not have been previously uploaded by other applications.
* If possible, upload packages and allocate parties at the beginning of the test using the admin API.
In the future, this setup step will be handled by the test tool itself.
* Be mindful when using commands that return unfiltered results.
For example, `ListKnownPartiesRequest` could return a huge number of entries.