Module `Tezos_alpha_test_helpers.Scenario_base`Source

This module gathers the basic operations used in test scenarios. This includes starting a scenario, baking, checking and manipulating the state, and various wait functions

Sourcetype Tezos_base.TzPervasives.error +=

| Unexpected_error

For assert_failure, when expected error does not match the actual error.

Sourcetype Tezos_base.TzPervasives.error +=

| Unexpected_success

For assert_failure, when scenario actually succeeds when expected to fail.

Sourcetype t = Block.t * State.t

Usual threaded state for the tests. Contains the current block, pending operations and the known State.t

Source

val log : 
  ?level:Tezt_core.Cli.Logs.level ->
  ?color:Tezt_core.Log.Color.t ->
  ('a, Format.formatter, unit, ('b, 'b) Scenario_dsl.scenarios) format4 ->
  'a

Sourceval set_baker : string -> (t, t) Scenario_dsl.scenarios

Sets the de facto baker for all future blocks

Sourceval exclude_bakers : string list -> (t, t) Scenario_dsl.scenarios

Exclude a list of delegates from baking

Sourceval unset_baking_policy : (t, t) Scenario_dsl.scenarios

Unsets the baking policy, it returns to default (By_round 0)

Source

val snapshot_balances : 
  Tezos_base.TzPervasives.String.Map.key ->
  Tezos_base.TzPervasives.String.Map.key list ->
  (t, t) Scenario_dsl.scenarios

Creates a snapshot of the current balances for the given account names. Can be used to check that balances at point A and B in the execution of a test are the same (either nothing happened, or a succession of actions resulted in getting the same values as before

Source

val check_snapshot_balances : 
  ?f:
    (name:Tezos_base.TzPervasives.String.Map.key ->
      old_balance:State_account.balance ->
      new_balance:State_account.balance ->
      (unit, Tezos_base.TzPervasives.tztrace) result Lwt.t) ->
  Tezos_base.TzPervasives.String.Map.key ->
  (t, t) Scenario_dsl.scenarios

Check balances against a previously defined snapshot

Sourceval save_current_rate : (t, t) Scenario_dsl.scenarios

Save the current issuance rate for future use

Source

val check_rate_evolution : 
  (Q.t -> Q.t -> bool) ->
  (t, t) Scenario_dsl.scenarios

Check that f saved_rate current_rate is true. f is typically a comparison function

Source

val check_failure_aux : 
  ?loc:string ->
  ?expected_error:('a -> Tezos_base.TzPervasives.tztrace) ->
  ('a -> 'b Tezos_base.TzPervasives.tzresult Lwt.t) ->
  'a ->
  'a Tezos_base.TzPervasives.tzresult Lwt.t

Source

val check_fail_and_rollback : 
  ?loc:string ->
  ?expected_error:('a -> Tezos_base.TzPervasives.tztrace) ->
  ('a, 'b) Scenario_dsl.single_scenario ->
  'a ->
  'a Tezos_base.TzPervasives.tzresult Lwt.t

Source

val assert_failure : 
  ?loc:string ->
  ?expected_error:('a -> Tezos_base.TzPervasives.tztrace) ->
  ('a, 'b) Scenario_dsl.scenarios ->
  ('a, 'a) Scenario_dsl.scenarios

Useful function to test expected failures: runs the given branch until it fails, then rollbacks to before execution. Fails if the given branch Succeeds

Source

val assert_success : 
  ?loc:string ->
  ('a, 'b) Scenario_dsl.scenarios ->
  ('a, 'a) Scenario_dsl.scenarios

Check a scenario does not fail, and rolls back to before the assert

Source

val loop : 
  int ->
  ('a, 'a) Scenario_dsl.scenarios ->
  ('a, 'a) Scenario_dsl.scenarios

Loop

Source

val loop_action : 
  int ->
  ('a -> 'a Tezos_base.TzPervasives.tzresult Lwt.t) ->
  ('a, 'a) Scenario_dsl.scenarios

Source

val check_balance_field : 
  Tezos_base.TzPervasives.String.Map.key ->
  [< `Bonds
  | `Liquid
  | `Staked
  | `Total
  | `Unstaked_finalizable
  | `Unstaked_frozen_total ] ->
  Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  (t, t) Scenario_dsl.scenarios

Check a specific balance field for a specific account is equal to a specific amount

Source

val check_balance_fields : 
  Tezos_base.TzPervasives.String.Map.key ->
  liquid:Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  staked:Tezos_protocol_alpha.Protocol.Alpha_context.Tez.t ->
  ?unstaked_frozen_total:Tezos_alpha_test_helpers.State_account.Tez.t ->
  unit ->
  (t, t) Scenario_dsl.scenarios

Install

Dune Dependency

Authors

Maintainers

Sources

doc/octez-protocol-alpha-libs.test-helpers/Tezos_alpha_test_helpers/Scenario_base/index.html

Module `Tezos_alpha_test_helpers.Scenario_base`Source

package octez-protocol-alpha-libs

Install

Dune Dependency

Authors

Maintainers

Sources

doc/octez-protocol-alpha-libs.test-helpers/Tezos_alpha_test_helpers/Scenario_base/index.html

Module Tezos_alpha_test_helpers.Scenario_baseSource

Module `Tezos_alpha_test_helpers.Scenario_base`Source