Constructor Detail

• EngineMigrationTester

  EngineMigrationTester(File migrationHome, MigrationTestConfiguration configuration)

Method Detail

• create

   ProtocolReferenceValue create(String prototypeId, List<Value> arguments, List<PartyValue> parties, Map<String, PartyValue> observers)

  Returns a reference to the new created protocol instance of the specified prototypeId. The list of arguments map respectively to the protocol parameters. The bound parties are mapped in the order given list. observers are indicated my the specified map of PartyValues.

  If parties variable is null or not given, the configured default party is used

• selectAction

   Value selectAction(ProtocolId protocolId, String action, List<Value> arguments, PartyValue party)

  Executes the protocol permission indicated by action with the given arguments of the specified protocol identified by protocolId. Calling party determined by party. Returning Value

• getProtocolStateById

   ProtocolState getProtocolStateById(ProtocolId protocolId)

  Returns a ProtocolState of the protocol instance identified by ProtocolId

• getCurrentProtocolStates

   Stream<ProtocolState> getCurrentProtocolStates(String prototypeId)

  Returns a Stream of all current ProtocolState that are of type prototypeId

• getAllProtocolStates

   Stream<ProtocolState> getAllProtocolStates()

  Returns a Stream of current instances of ProtocolState

• getLog

   List<NPLMigrationLogEntry> getLog()

  Returns a list of all NPLMigrationLogEntry

• run

   Boolean run(Boolean force)

  Performs all changes in migration. Set force to true to override default behavior

• runTo

   Boolean runTo(String version, Boolean force)

  Performs all changes in migration up to the indicated changeset equal to version. Set force to true to override default behavior

• runNPL

   Unit runNPL(Path sourcePath)

  Compiles and executes any test(s) provided in the source file pointed to by sourcePath. Each test will be run in the context of the current state of the migrated system.

  All tests follow have the same rules and signature as standard NPL tests (i.e. Tests must be annotated with @test and must have a single parameter of type Test).

  Each source file can have one or more tests, constituting a <i>test set</i>. To persist protocol state changes, you must store the protocol using the storeProtocol function. See storeProtocol documentation for more details.

  State changes are not persisted until after the execution of all the tests in the <i>test set</i>. This allows each test to execute 'cleanly' without effecting other tests in the set. Once completed, only the state changes for protocols that were explicitly 'stored', will be persisted.

• runNPL

   Unit runNPL(String name, @Language(value = "NPL") String snippet)

  Compiles and executes any test(s) provided in the source code snippet. Each test will be run in the context of the current state of the migrated system. name is just an identifier and has no effect on test results.

  All tests follow the same rules and signature as standard NPL tests (i.e. Test functions must be annotated with @test and must have a single parameter of type Test).

  Each snippet can have one or more tests, constituting a <i>test set</i>. To persist protocol state changes, you must store the protocol using the storeProtocol function. See storeProtocol documentation for more details.

  State changes are not persisted until after the execution of all the tests in the <i>test set</i>. This allows each test to execute 'cleanly' without effecting other tests in the set. Once completed, only the state changes for protocols that were explicitly 'stored', will be persisted.

• close

   Unit close()

  Performs steps for closing all open resources. Should be called after each test case execution.