test for check point

This commit is contained in:
Lý Kim Quyên 2019-01-23 16:23:58 +01:00 committed by Raphaël Proust
parent d7ba8bb07d
commit e4a5d3c45c
4 changed files with 660 additions and 0 deletions

View File

@ -110,3 +110,19 @@ let is_false ?(msg="") x =
let is_true ?(msg="") x = let is_true ?(msg="") x =
if not x then fail "true" "false" msg if not x then fail "true" "false" msg
let equal_checkpoint ?msg cp1 cp2 =
let eq cp1 cp2 =
match cp1, cp2 with
| None, None -> true
| Some (x, bh1), Some (y, bh2) ->
Int32.equal x y &&
(Block_hash.equal bh1 bh2)
| _ -> false in
let prn = function
| None -> "none"
| Some (_x, bh) ->
(*let s = Printf.sprintf "%s" x in*)
Block_hash.to_b58check bh
in
equal ?msg ~prn ~eq cp1 cp2

View File

@ -27,4 +27,6 @@ let () =
Alcotest.run "tezos-state" [ Alcotest.run "tezos-state" [
"store", Test_store.tests ; "store", Test_store.tests ;
"state", Test_state.tests ; "state", Test_state.tests ;
"store checkpoint", Test_store_checkpoint.tests;
"state checkpoint", Test_state_checkpoint.tests
] ]

View File

@ -0,0 +1,518 @@
(*****************************************************************************)
(* *)
(* Open Source License *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.com> *)
(* *)
(* Permission is hereby granted, free of charge, to any person obtaining a *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense, *)
(* and/or sell copies of the Software, and to permit persons to whom the *)
(* Software is furnished to do so, subject to the following conditions: *)
(* *)
(* The above copyright notice and this permission notice shall be included *)
(* in all copies or substantial portions of the Software. *)
(* *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *)
(* DEALINGS IN THE SOFTWARE. *)
(* *)
(*****************************************************************************)
let (//) = Filename.concat
(**************************************************************************)
(** Basic blocks *)
let genesis_block =
Block_hash.of_b58check_exn
"BLockGenesisGenesisGenesisGenesisGenesisGeneskvg68z"
let genesis_protocol =
Protocol_hash.of_b58check_exn
"ProtoDemoDemoDemoDemoDemoDemoDemoDemoDemoDemoD3c8k9"
let genesis_time =
Time.of_seconds 0L
module Proto = (val Registered_protocol.get_exn genesis_protocol)
let genesis : State.Chain.genesis = {
time = genesis_time ;
block = genesis_block ;
protocol = genesis_protocol ;
}
let operation op =
let op : Operation.t = {
shell = { branch = genesis_block } ;
proto = MBytes.of_string op ;
} in
Operation.hash op,
op,
Data_encoding.Binary.to_bytes Operation.encoding op
let incr_fitness fitness =
let new_fitness =
match fitness with
| [ fitness ] ->
Pervasives.(
Data_encoding.Binary.of_bytes Data_encoding.int64 fitness
|> Option.unopt ~default:0L
|> Int64.succ
|> Data_encoding.Binary.to_bytes_exn Data_encoding.int64
)
| _ -> Data_encoding.Binary.to_bytes_exn Data_encoding.int64 1L
in
[ new_fitness ]
let incr_timestamp timestamp =
Time.add timestamp (Int64.add 1L (Random.int64 10L))
let block _state ?(context = Context_hash.zero) ?(operations = []) (pred: State.Block.t) name
: Block_header.t =
let operations_hash =
Operation_list_list_hash.compute
[Operation_list_hash.compute operations] in
let pred_header = State.Block.shell_header pred in
let fitness = incr_fitness pred_header.fitness in
let timestamp = incr_timestamp pred_header.timestamp in
{ shell = { level = Int32.succ pred_header.level ;
proto_level = pred_header.proto_level ;
predecessor = State.Block.hash pred ;
validation_passes = 1 ;
timestamp ; operations_hash ; fitness ;
context } ;
protocol_data = MBytes.of_string name ;
}
let parsed_block ({ shell ; protocol_data } : Block_header.t) =
let protocol_data =
Data_encoding.Binary.of_bytes_exn
Proto.block_header_data_encoding
protocol_data in
({ shell ; protocol_data } : Proto.block_header)
let zero = MBytes.create 0
let build_valid_chain state vtbl pred names =
Lwt_list.fold_left_s
(fun pred name ->
State.Block.context pred >>= fun predecessor_context ->
let rec attempt context =
begin
let oph, op, _bytes = operation name in
let block = block ?context state ~operations:[oph] pred name in
let hash = Block_header.hash block in
let pred_header = State.Block.header pred in
begin
Proto.begin_application
~chain_id: Chain_id.zero
~predecessor_context
~predecessor_timestamp: pred_header.shell.timestamp
~predecessor_fitness: pred_header.shell.fitness
(parsed_block block) >>=? fun vstate ->
(* no operations *)
Proto.finalize_block vstate
end >>=? fun (result, _metadata) ->
Context.commit
~time:(Time.now ())
?message:result.message
result.context >>= fun context_hash ->
let validation_store =
{ State.Block.context_hash ; message = result.message ;
max_operations_ttl = result.max_operations_ttl ;
last_allowed_fork_level = result.last_allowed_fork_level
} in
State.Block.store state
block zero [[op]] [[zero]] validation_store >>=? fun _vblock ->
State.Block.read state hash >>=? fun vblock ->
Hashtbl.add vtbl name vblock ;
return vblock
end >>= function
| Ok v -> Lwt.return v
| Error [ Validation_errors.Inconsistent_hash (got, _) ] ->
(* Kind of a hack, but at least it tests idempotence to some extent. *)
attempt (Some got)
| Error err ->
Error_monad.pp_print_error Format.err_formatter err ;
assert false in
attempt None)
pred
names >>= fun _ ->
Lwt.return_unit
type state = {
vblock: (string, State.Block.t) Hashtbl.t ;
state: State.t ;
chain: State.Chain.t ;
}
let vblock s = Hashtbl.find s.vblock
exception Found of string
let vblocks s =
Hashtbl.fold (fun k v acc -> (k,v) :: acc) s.vblock []
|> List.sort Pervasives.compare
(*******************************************************)
(*
Genesis - A1 - A2 - A3 - A4 - A5
\
B1 - B2 - B3 - B4 - B5
*)
let build_example_tree chain =
let vtbl = Hashtbl.create 23 in
Chain.genesis chain >>= fun genesis ->
Hashtbl.add vtbl "Genesis" genesis ;
let c = [ "A1" ; "A2" ; "A3" ; "A4" ; "A5" ] in
build_valid_chain chain vtbl genesis c >>= fun () ->
let a2 = Hashtbl.find vtbl "A2" in
let c = [ "B1" ; "B2" ; "B3" ; "B4" ; "B5" ] in
build_valid_chain chain vtbl a2 c >>= fun () ->
Lwt.return vtbl
let wrap_state_init f base_dir =
begin
let store_root = base_dir // "store" in
let context_root = base_dir // "context" in
State.init
~store_mapsize:4_096_000_000L
~context_mapsize:4_096_000_000L
~store_root
~context_root
genesis >>=? fun (state, chain, _index) ->
build_example_tree chain >>= fun vblock ->
f { state ; chain ; vblock } >>=? fun () ->
return ()
end
(*******************************************************)
(** State.Chain.checkpoint *)
(*
- Valid branch are kept after setting a checkpoint. Bad branch are cut
- Setting a checkpoint in the future does not remove anything
- Reaching a checkpoint in the future with the right block keeps that
block and remove any concurrent branch
- Reaching a checkpoint in the future with a bad block remove that block and
does not prevent a future good block from correctly being reached
- There are no bad quadratic behaviours *)
(* test genesis/basic check point: (level_0, genesis_block) *)
let test_checkpoint_genesis s =
Chain.genesis s.chain >>= fun genesis ->
let level = State.Block.level genesis in
if not (Block_hash.equal (State.Block.hash genesis) genesis_block)
then Assert.fail_msg "unexpected head";
(* set checkpoint at genesis *)
State.Chain.set_checkpoint s.chain (level, genesis_block) >>= fun () ->
State.Chain.checkpoint s.chain >>= fun (c_level, c_block) ->
(* if the level is equal and not the same hash then fail *)
if Int32.equal level c_level &&
not (Block_hash.equal c_block (State.Block.hash genesis))
then
Assert.fail_msg "unexpected checkpoint"
else
return ()
let test_basic_checkpoint s =
let block = vblock s "A1" in
let level = State.Block.level block in
let block_hash = State.Block.hash block in
State.Chain.set_checkpoint s.chain (level, block_hash) >>= fun () ->
State.Chain.checkpoint s.chain >>= fun (c_level, c_block) ->
if not (Block_hash.equal c_block block_hash) &&
Int32.equal c_level level
then
Assert.fail_msg "unexpected checkpoint"
else return ()
(*
- cp: checkpoint
Genesis - A1 - A2 (cp) - A3 - A4 - A5
\
B1 - B2 - B3 - B4 - B5
*)
(* State.Chain.acceptable_block:
will the block is compatible with the current checkpoint? *)
let test_acceptable_block s =
let block = vblock s "A2" in
let level = State.Block.level block in
let block_hash = State.Block.hash block in
State.Chain.set_checkpoint s.chain (level, block_hash) >>= fun () ->
(* it is accepted only if the current head is lower than the checkpoint *)
let block_1 = vblock s "A1" in
let hash = State.Block.hash block_1 in
Chain.set_head s.chain block_1 >>= fun head ->
let header = State.Block.header head in
State.Chain.acceptable_block s.chain hash header >>= fun is_accepted_block ->
if is_accepted_block
then return ()
else Assert.fail_msg "unacceptable block"
(*
Genesis - A1 - A2 (cp) - A3 - A4 - A5
\
B1 - B2 - B3 - B4 - B5
*)
(* State.Block.is_valid_for_checkpoint :
is the block still valid for a given checkpoint ? *)
let test_is_valid_checkpoint s =
let block = vblock s "A2" in
let block_hash = State.Block.hash block in
let level = State.Block.level block in
State.Chain.set_checkpoint s.chain (level, block_hash) >>= fun () ->
State.Chain.checkpoint s.chain >>= fun (c_level, c_block) ->
(* "b3" is valid because:
a1 - a2 (checkpoint) - b1 - b2 - b3
it is not valid when the checkpoint change to a pick different than a2.
*)
State.Block.is_valid_for_checkpoint (vblock s "B3") (c_level, c_block) >>= fun is_valid ->
if is_valid
then return ()
else Assert.fail_msg "invalid checkpoint"
(* return a block with the best fitness amongst the known blocks which
are compatible with the given checkpoint *)
let test_best_know_head_for_checkpoint s =
let block = vblock s "A2" in
let block_hash = State.Block.hash block in
let level = State.Block.level block in
let checkpoint = level, block_hash in
State.Chain.set_checkpoint s.chain checkpoint >>= fun () ->
Chain.set_head s.chain (vblock s "B3") >>= fun _head ->
State.best_known_head_for_checkpoint s.chain checkpoint >>= fun _block ->
(* the block returns with the best fitness is B3 at level 5 *)
return ()
(*
setting checkpoint in the future does not remove anything
Genesis - A1 - A2(cp) - A3 - A4 - A5
\
B1 - B2 - B3 - B4 - B5
*)
let test_future_checkpoint s =
let block = vblock s "A2" in
let block_hash = State.Block.hash block in
let level = State.Block.level block in
let checkpoint = level, block_hash in
State.Chain.set_checkpoint s.chain checkpoint >>= fun () ->
State.Chain.checkpoint s.chain >>= fun (c_level, c_block) ->
if Int32.equal c_level level && not (Block_hash.equal c_block block_hash)
then Assert.fail_msg "unexpected checkpoint"
else return ()
(*
setting checkpoint in the future does not remove anything
- iv = invalid
- (0): level of this block in the chain
Two exammples:
* Genesis (0)- A1 (1) - A2(2) - A3(3) - A4(4) - A5(5) (invalid)
\
B1(3) - B2(4) - B3 (5)(cp) - B4(6) - B5(7)
* Genesis - A1 - A2 - A3 - A4 - A5 (cp)
\
B1 - B2 - B3 (iv)- B4 (iv) - B5 (iv)
*)
let test_future_checkpoint_bad_good_block s =
let block = vblock s "A5" in
let block_hash = State.Block.hash block in
let level = State.Block.level block in
let checkpoint = level, block_hash in
State.Chain.set_checkpoint s.chain checkpoint >>= fun () ->
State.Chain.checkpoint s.chain >>= fun (c_level, c_block) ->
if Int32.equal c_level level && not (Block_hash.equal c_block block_hash)
then Assert.fail_msg "unexpected checkpoint"
else
State.Block.is_valid_for_checkpoint
(vblock s "B2") (c_level, c_block) >>= fun is_valid ->
if is_valid
then return ()
else Assert.fail_msg "invalid checkpoint"
(* check if the checkpoint can be reached
Genesis - A1 (cp) - A2 (head) - A3 - A4 - A5
\
B1 - B2 - B3 - B4 - B5
*)
let test_reach_checkpoint s =
let mem s x =
Chain.mem s.chain (State.Block.hash @@ vblock s x)
in
let test_mem s x = mem s x >>= function
| true -> Lwt.return_unit
| false -> Assert.fail_msg "mem %s" x
in
let test_not_mem s x =
mem s x >>= function
| false -> Lwt.return_unit
| true -> Assert.fail_msg "not (mem %s)" x in
let block = vblock s "A1" in
let block_hash = State.Block.hash block in
let header = State.Block.header block in
let level = State.Block.level block in
let checkpoint = level, block_hash in
State.Chain.set_checkpoint s.chain checkpoint >>= fun () ->
State.Chain.checkpoint s.chain >>= fun (c_level, c_block) ->
let time_now = Time.now () in
if Time.(add time_now 15L >= header.shell.timestamp)
then
if Int32.equal header.shell.level c_level &&
not (Block_hash.equal c_block block_hash)
then Assert.fail_msg "checkpoint error"
else
Chain.set_head s.chain (vblock s "A2") >>= fun _ ->
Chain.head s.chain >>= fun head ->
let checkpoint_reached =
(State.Block.header head).shell.level >= c_level
in
if checkpoint_reached
then
(* if reached the checkpoint, every block before the checkpoint
must be the part of the chain *)
if header.shell.level <= c_level
then
test_mem s "Genesis" >>= fun () ->
test_mem s "A1" >>= fun () ->
test_mem s "A2" >>= fun () ->
test_not_mem s "A3" >>= fun () ->
test_not_mem s "B1" >>= fun () ->
return ()
else Assert.fail_msg "checkpoint error"
else
Assert.fail_msg "checkpoint error"
else Assert.fail_msg "fail future block header"
(*
Chain.Validator function may_update_checkpoint
- ncp: new checkpoint
Genesis - A1 - A2 - A3 (cp) - A4 - A5
\
B1 - B2 - B3 - B4 - B5
Genesis - A1 (ncp) - A2 - A3 (cp) - A4 (ncp) - A5
\
B1 - B2 - B3 - B4 - B5
*)
let may_update_checkpoint chain_state new_head =
State.Chain.checkpoint chain_state >>= fun (old_level, _) ->
(* FIXME: the new level is always return 0l even
if the new_head is A4 at level 4l
Or TODO: set a level where allow to have a fork
*)
let new_level = State.Block.last_allowed_fork_level new_head in
if new_level <= old_level then
Lwt.return_unit
else
let head_level = State.Block.level new_head in
State.Block.predecessor_n new_head
(Int32.to_int (Int32.sub head_level new_level)) >>= function
| None -> Assert.fail_msg "Unexpected None in predecessor query"
| Some new_block ->
State.Chain.set_checkpoint chain_state (new_level, new_block)
let test_may_update_checkpoint s =
let block = vblock s "A3" in
let block_hash = State.Block.hash block in
let level = State.Block.level block in
let checkpoint = level, block_hash in
State.Chain.set_checkpoint s.chain checkpoint >>= fun () ->
State.Chain.checkpoint s.chain >>= fun (_, _) ->
Chain.set_head s.chain (vblock s "A4") >>= fun _ ->
Chain.head s.chain >>= fun head ->
may_update_checkpoint s.chain head >>= fun () ->
return ()
(* Check function may_update_checkpoint in Node.ml
Genesis - A1 - A2 (cp) - A3 - A4 - A5
\
B1 - B2 - B3 - B4 - B5
chain after update:
Genesis - A1 - A2 - A3(cp) - A4 - A5
\
B1 - B2 - B3 - B4 - B5
*)
let note_may_update_checkpoint chain_state checkpoint =
match checkpoint with
| None ->
Lwt.return_unit
| Some checkpoint ->
State.best_known_head_for_checkpoint
chain_state checkpoint >>= fun new_head ->
Chain.set_head chain_state new_head >>= fun _ ->
State.Chain.set_checkpoint chain_state checkpoint
let test_note_may_update_checkpoint s =
(* set checkpoint at (2l, A2) *)
let block = vblock s "A2" in
let block_hash = State.Block.hash block in
let level = State.Block.level block in
let checkpoint = level, block_hash in
State.Chain.set_checkpoint s.chain checkpoint >>= fun () ->
(* set new checkpoint at (3l, A3) *)
let block = vblock s "A3" in
let block_hash = State.Block.hash block in
let level = State.Block.level block in
let checkpoint = level, block_hash in
note_may_update_checkpoint s.chain (Some checkpoint) >>= fun () ->
return ()
(**********************************************************)
let tests: (string * (state -> unit tzresult Lwt.t)) list = [
"checkpoint genesis", test_checkpoint_genesis;
"basic checkpoint", test_basic_checkpoint;
"is valid checkpoint", test_is_valid_checkpoint;
"acceptable block", test_acceptable_block ;
"best know head", test_best_know_head_for_checkpoint;
"future checkpoint", test_future_checkpoint;
"future checkpoint bad/good block", test_future_checkpoint_bad_good_block;
"test_reach_checkpoint", test_reach_checkpoint;
"update checkpoint", test_may_update_checkpoint;
"update checkpoint in node", test_note_may_update_checkpoint;
]
let wrap (n, f) =
Alcotest_lwt.test_case n `Quick begin fun _ () ->
Lwt_utils_unix.with_tempdir "tezos_test_" begin fun dir ->
wrap_state_init f dir >>= function
| Ok () -> Lwt.return_unit
| Error error ->
Tezos_stdlib_unix.Logging_unix.close () >>= fun () ->
Format.eprintf "WWW %a@." pp_print_error error ;
Lwt.fail Alcotest.Test_error
end
end
let tests = List.map wrap tests

View File

@ -0,0 +1,124 @@
(*****************************************************************************)
(* *)
(* Open Source License *)
(* Copyright (c) 2018 Dynamic Ledger Solutions, Inc. <contact@tezos.com> *)
(* *)
(* Permission is hereby granted, free of charge, to any person obtaining a *)
(* copy of this software and associated documentation files (the "Software"),*)
(* to deal in the Software without restriction, including without limitation *)
(* the rights to use, copy, modify, merge, publish, distribute, sublicense, *)
(* and/or sell copies of the Software, and to permit persons to whom the *)
(* Software is furnished to do so, subject to the following conditions: *)
(* *)
(* The above copyright notice and this permission notice shall be included *)
(* in all copies or substantial portions of the Software. *)
(* *)
(* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR*)
(* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *)
(* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL *)
(* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER*)
(* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *)
(* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *)
(* DEALINGS IN THE SOFTWARE. *)
(* *)
(*****************************************************************************)
let mapsize = 4_096_000_000L (* ~4 GiB *)
let (//) = Filename.concat
let wrap_raw_store_init f _ () =
Lwt_utils_unix.with_tempdir "tezos_test_" begin fun base_dir ->
let root = base_dir // "store" in
Raw_store.init ~mapsize root >>= function
| Ok store ->
Lwt.finalize
(fun () -> f store)
(fun () -> Raw_store.close store ; Lwt.return_unit)
| Error err ->
Format.kasprintf Pervasives.failwith
"@[Cannot initialize store:@ %a@]" pp_print_error err
end
(**************************************************************************)
(** Basic blocks *)
let genesis_block =
Block_hash.of_b58check_exn
"BLockGenesisGenesisGenesisGenesisGenesisGeneskvg68z"
(**************************************************************************)
(** Block store *)
let lolblock ?(operations = []) header =
let operations_hash =
Operation_list_list_hash.compute
[Operation_list_hash.compute operations] in
( { Block_header.shell =
{ timestamp = Time.of_seconds (Random.int64 1500L) ;
level = 0l ; (* dummy *)
proto_level = 0 ; (* dummy *)
validation_passes = Random.int 32 ;
predecessor = genesis_block ; operations_hash ;
fitness = [MBytes.of_string @@ string_of_int @@ String.length header;
MBytes.of_string @@ string_of_int @@ 12] ;
context = Context_hash.zero } ;
protocol_data = MBytes.of_string header ; } ,
{ Store.Block.metadata = MBytes.create 0 ;
max_operations_ttl = 0 ;
message = None ;
context = Context_hash.zero ;
last_allowed_fork_level = 0l ;
} )
let (block_header,_) = lolblock "A1"
let block_hash = Block_header.hash block_header
(****************************************************)
open Store_helpers
let test_single (type t)
(module Store:Store_sigs.STORE with type t = t) (s: Store.t) =
let module Single =
Make_single_store
(Store)
(struct let name = ["checkpoint"] end)
(Store_helpers.Make_value (struct
type t = Int32.t * Block_hash.t
let encoding = Data_encoding.(tup2 int32 Block_hash.encoding)
end
))
in
(* is there any checkpoint in store *)
Single.known s >>= fun is_known ->
Assert.is_false ~msg:__LOC__ is_known;
Single.read_opt s >>= fun checkpoint' ->
Assert.equal_checkpoint ~msg:__LOC__ None checkpoint';
(* store new checkpoint: (1, A1) *)
let checkpoint = (1l, block_hash) in
Single.store s checkpoint >>= fun () ->
Single.known s >>= fun is_known ->
Assert.is_true ~msg:__LOC__ is_known;
Single.read_opt s >>= fun checkpoint' ->
Assert.equal_checkpoint ~msg:__LOC__ (Some checkpoint) checkpoint';
(* remove the checkpoint just store *)
Single.remove s >>= fun () ->
Single.known s >>= fun is_known ->
Assert.is_false ~msg:__LOC__ is_known;
Single.read_opt s >>= fun checkpoint' ->
Assert.equal_checkpoint ~msg:__LOC__ None checkpoint';
Lwt.return_unit
(**************************************************************************)
let tests_raw : (string * (Raw_store.t -> unit Lwt.t)) list =
[
"single", test_single (module Raw_store)
]
let tests =
List.map (fun (s, f) -> Alcotest_lwt.test_case s `Quick (wrap_raw_store_init f))
tests_raw