MinaProtocol / mina / 535

Committed 25 Aug 2025 05:35PM UTC coverage: 32.09% (-28.7%) from 60.772%

Build # 535

Build Type

push

buildkite

Committed by

web-flow

Commit Message

Merge pull request #17673 from MinaProtocol/amcie-merge-release320-to-master

amcie-merge-release320-to-master

Run Details

1010 of 3745 new or added lines in 242 files covered. (26.97%)

17403 existing lines in 378 files now uncovered.

23062 of 71866 relevant lines covered (32.09%)

24742.7 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

6.15

/src/lib/disk_cache/test_lib/disk_cache_test_lib.ml

open Async
open Core

module Mock = struct
  type t = { proof : Mina_stdlib.Bounded_types.String.Stable.V1.t }
  [@@deriving bin_io_unversioned]
end

module type S = sig
  module Cache : sig
    type t

    type id
  end

  val logger : Logger.t

  val simple_write :
       ?additional_checks:
         (Cache.t * Mock.t * Mock.t * Cache.id * Cache.id -> unit)
    -> unit
    -> unit

  val initialization_special_cases : unit -> unit

  (** [remove_data_on_gc ?gc_strict ())] test behavior of cache on GC.
      If [gc_strict] is set to [false], then we won't check if the cache is
      empty after GC.
   *)
  val remove_data_on_gc : ?gc_strict:bool -> unit -> unit
end

module type S_extended = sig
  include S

  val simple_write_with_iteration : unit -> unit
end

module Make_impl (Cache : Disk_cache_intf.S_with_count with module Data := Mock) :
  S with module Cache := Cache = struct
  let () =
    Core.Backtrace.elide := false ;
    Async.Scheduler.set_record_backtraces true

  let logger = Logger.null ()

  let initialize_cache_or_fail tmpd ~logger =
    let open Deferred.Let_syntax in
    let%bind cache_res = Cache.initialize tmpd ~logger in
    match cache_res with
    | Ok cache ->
        return cache
    | Error _err ->
        failwith "error during initialization"

  let simple_write_impl ?(additional_checks = const ()) tmp_dir =
    let%map cache = initialize_cache_or_fail tmp_dir ~logger in

    let proof1 = Mock.{ proof = "dummy" } in
    let proof2 = Mock.{ proof = "smart" } in

    let id1 = Cache.put cache proof1 in
    let id2 = Cache.put cache proof2 in

    additional_checks (cache, proof1, proof2, id1, id2) ;

    [%test_eq: int] (Cache.count cache) 2
      ~message:"cache should contain only 2 elements" ;

    let proof_from_cache1 = Cache.get cache id1 in
    [%test_eq: string] proof1.proof proof_from_cache1.proof
      ~message:"invalid proof from cache" ;

    let proof_from_cache2 = Cache.get cache id2 in
    [%test_eq: string] proof2.proof proof_from_cache2.proof
      ~message:"invalid proof from cache"

  let simple_write ?additional_checks () =
    Async.Thread_safe.block_on_async_exn
    @@ fun () ->
    Mina_stdlib_unix.File_system.with_temp_dir "disk_cache"
      ~f:(simple_write_impl ?additional_checks)

  let remove_data_on_gc_impl ~gc_strict tmp_dir =
    let%map cache = initialize_cache_or_fail tmp_dir ~logger in

    let proof = Mock.{ proof = "dummy" } in

    (let id = Cache.put cache proof in

     [%test_eq: int] (Cache.count cache) 1
       ~message:"cache should contain only 1 element" ;

     let proof_from_cache = Cache.get cache id in
     [%test_eq: string] proof.proof proof_from_cache.proof
       ~message:"invalid proof from cache" ) ;

    if gc_strict then (
      Gc.compact () ;
      [%test_eq: int] (Cache.count cache) 0
        ~message:"cache should be empty after garbage collector run" )

  let remove_data_on_gc ?(gc_strict = true) () =
    Async.Thread_safe.block_on_async_exn
    @@ fun () ->
    Mina_stdlib_unix.File_system.with_temp_dir "disk_cache-remove_data_on_gc"
      ~f:(remove_data_on_gc_impl ~gc_strict)

  let initialize_and_expect_failure path ~logger =
    let%bind cache_res = Cache.initialize path ~logger in
    match cache_res with
    | Ok _ ->
        failwith "unexpected initialization success"
    | Error _err ->
        return ()

  let initialization_special_cases_impl tmp_dir =
    (* create a directory with 0x000 permissions and initialize from it *)
    let%bind () =
      let perm_denied_dir = tmp_dir ^/ "permission_denied" in
      Core.Unix.mkdir ~perm:0o000 perm_denied_dir ;
      let unreachable = perm_denied_dir ^/ "some_unreachable_path" in
      initialize_and_expect_failure unreachable ~logger
    in

    (* create a directory, create a symlink to it and initialize from a synlimk *)
    let%bind () =
      let some_dir_name = "some_dir" in
      let some_dir = tmp_dir ^/ some_dir_name in
      Core.Unix.mkdir some_dir ;
      let dir_symlink = tmp_dir ^/ "dir_link" in
      Core.Unix.symlink ~target:some_dir_name ~link_name:dir_symlink ;
      Cache.initialize dir_symlink ~logger
      >>| function
      | Ok _ ->
          ()
      | Error _ ->
          failwith "unexpected initialization failure for dir symlink"
    in

    (* create a symlink to a non-existent file, try to initialize from symlink *)
    let%bind () =
      let corrupt_symlink = tmp_dir ^/ "corrupt_link" in
      Core.Unix.symlink ~target:"doesnt_exist" ~link_name:corrupt_symlink ;
      initialize_and_expect_failure corrupt_symlink ~logger
    in

    (* create a file and initialize from it *)
    let%bind some_file_name =
      let some_file_name = "file.txt" in
      let some_file = tmp_dir ^/ some_file_name in
      Out_channel.write_all some_file ~data:"yo" ;
      initialize_and_expect_failure some_file ~logger >>| const some_file_name
    in

    (* create a symlink to an existing file, try to initialize from symlink *)
    let symlink = tmp_dir ^/ "link" in
    Core.Unix.symlink ~target:some_file_name ~link_name:symlink ;
    initialize_and_expect_failure symlink ~logger

  let initialization_special_cases () =
    Async.Thread_safe.block_on_async_exn
    @@ fun () ->
    Mina_stdlib_unix.File_system.with_temp_dir
      "disk_cache-invalid-initialization" ~f:initialization_special_cases_impl
end

module Make (Disk_cache : Disk_cache_intf.F_with_count) :
  S with module Cache := Disk_cache(Mock) = struct
  include Make_impl (Disk_cache (Mock))
end

module Make_extended (Disk_cache : Disk_cache_intf.F_extended) :
  S_extended with module Cache := Disk_cache(Mock) = struct
  module Cache = Disk_cache (Mock)
  include Make_impl (Cache)

  let iteration_checks (cache, proof1, proof2, id1, id2) =
    let id1_not_visited = ref true in
    let id2_not_visited = ref true in
    Cache.iteri cache ~f:(fun id content ->
        let expected_content =
          if id = Cache.int_of_id id1 then (
            assert !id1_not_visited ;
            id1_not_visited := false ;
            proof1 )
          else if id = Cache.int_of_id id2 then (
            assert !id2_not_visited ;
            id2_not_visited := false ;
            proof2 )
          else failwith "unexpected key in iteration"
        in
        [%test_eq: string] content.Mock.proof expected_content.Mock.proof ;
        `Continue ) ;
    assert ((not !id1_not_visited) && not !id2_not_visited)

  let simple_write_with_iteration =
    simple_write ~additional_checks:iteration_checks
end

1	open Async	49✔
2	open Core
3
4	module Mock = struct
5	type t = { proof : Mina_stdlib.Bounded_types.String.Stable.V1.t }	49✔
6	[@@deriving bin_io_unversioned]	196✔
7	end
8
9	module type S = sig
10	module Cache : sig
11	type t
12
13	type id
14	end
15
16	val logger : Logger.t
17
18	val simple_write :
19	?additional_checks:
20	(Cache.t * Mock.t * Mock.t * Cache.id * Cache.id -> unit)
21	-> unit
22	-> unit
23
24	val initialization_special_cases : unit -> unit
25
26	(** [remove_data_on_gc ?gc_strict ())] test behavior of cache on GC.
27	If [gc_strict] is set to [false], then we won't check if the cache is
28	empty after GC.
29	*)
30	val remove_data_on_gc : ?gc_strict:bool -> unit -> unit
31	end
32
33	module type S_extended = sig
34	include S
35
36	val simple_write_with_iteration : unit -> unit
37	end
38
39	module Make_impl (Cache : Disk_cache_intf.S_with_count with module Data := Mock) :
40	S with module Cache := Cache = struct
41	let () =
42	Core.Backtrace.elide := false ;
UNCOV 43	Async.Scheduler.set_record_backtraces true	×
44
UNCOV 45	let logger = Logger.null ()	×
46
47	let initialize_cache_or_fail tmpd ~logger =
UNCOV 48	let open Deferred.Let_syntax in	×
UNCOV 49	let%bind cache_res = Cache.initialize tmpd ~logger in	×
UNCOV 50	match cache_res with	×
UNCOV 51	\| Ok cache ->	×
52	return cache
53	\| Error _err ->	×
54	failwith "error during initialization"
55
UNCOV 56	let simple_write_impl ?(additional_checks = const ()) tmp_dir =	×
UNCOV 57	let%map cache = initialize_cache_or_fail tmp_dir ~logger in	×
58
UNCOV 59	let proof1 = Mock.{ proof = "dummy" } in	×
60	let proof2 = Mock.{ proof = "smart" } in
61
62	let id1 = Cache.put cache proof1 in
UNCOV 63	let id2 = Cache.put cache proof2 in	×
64
UNCOV 65	additional_checks (cache, proof1, proof2, id1, id2) ;	×
66
UNCOV 67	[%test_eq: int] (Cache.count cache) 2	×
68	~message:"cache should contain only 2 elements" ;
69
UNCOV 70	let proof_from_cache1 = Cache.get cache id1 in	×
UNCOV 71	[%test_eq: string] proof1.proof proof_from_cache1.proof	×
72	~message:"invalid proof from cache" ;
73
UNCOV 74	let proof_from_cache2 = Cache.get cache id2 in	×
UNCOV 75	[%test_eq: string] proof2.proof proof_from_cache2.proof	×
76	~message:"invalid proof from cache"
77
78	let simple_write ?additional_checks () =
UNCOV 79	Async.Thread_safe.block_on_async_exn	×
80	@@ fun () ->
NEW 81	Mina_stdlib_unix.File_system.with_temp_dir "disk_cache"	×
82	~f:(simple_write_impl ?additional_checks)
83
84	let remove_data_on_gc_impl ~gc_strict tmp_dir =
UNCOV 85	let%map cache = initialize_cache_or_fail tmp_dir ~logger in	×
86
UNCOV 87	let proof = Mock.{ proof = "dummy" } in	×
88
89	(let id = Cache.put cache proof in
90
UNCOV 91	[%test_eq: int] (Cache.count cache) 1	×
92	~message:"cache should contain only 1 element" ;
93
UNCOV 94	let proof_from_cache = Cache.get cache id in	×
UNCOV 95	[%test_eq: string] proof.proof proof_from_cache.proof	×
96	~message:"invalid proof from cache" ) ;
97
NEW 98	if gc_strict then (	×
99	Gc.compact () ;
NEW 100	[%test_eq: int] (Cache.count cache) 0	×
101	~message:"cache should be empty after garbage collector run" )
102
NEW 103	let remove_data_on_gc ?(gc_strict = true) () =	×
UNCOV 104	Async.Thread_safe.block_on_async_exn	×
105	@@ fun () ->
NEW 106	Mina_stdlib_unix.File_system.with_temp_dir "disk_cache-remove_data_on_gc"	×
107	~f:(remove_data_on_gc_impl ~gc_strict)
108
109	let initialize_and_expect_failure path ~logger =
UNCOV 110	let%bind cache_res = Cache.initialize path ~logger in	×
UNCOV 111	match cache_res with	×
112	\| Ok _ ->	×
113	failwith "unexpected initialization success"
UNCOV 114	\| Error _err ->	×
115	return ()
116
117	let initialization_special_cases_impl tmp_dir =
118	(* create a directory with 0x000 permissions and initialize from it *)
119	let%bind () =
120	let perm_denied_dir = tmp_dir ^/ "permission_denied" in
UNCOV 121	Core.Unix.mkdir ~perm:0o000 perm_denied_dir ;	×
UNCOV 122	let unreachable = perm_denied_dir ^/ "some_unreachable_path" in	×
UNCOV 123	initialize_and_expect_failure unreachable ~logger	×
124	in
125
126	(* create a directory, create a symlink to it and initialize from a synlimk *)
127	let%bind () =
128	let some_dir_name = "some_dir" in
129	let some_dir = tmp_dir ^/ some_dir_name in
UNCOV 130	Core.Unix.mkdir some_dir ;	×
UNCOV 131	let dir_symlink = tmp_dir ^/ "dir_link" in	×
UNCOV 132	Core.Unix.symlink ~target:some_dir_name ~link_name:dir_symlink ;	×
UNCOV 133	Cache.initialize dir_symlink ~logger	×
UNCOV 134	>>\| function	×
UNCOV 135	\| Ok _ ->	×
136	()
137	\| Error _ ->	×
138	failwith "unexpected initialization failure for dir symlink"
139	in
140
141	(* create a symlink to a non-existent file, try to initialize from symlink *)
142	let%bind () =
143	let corrupt_symlink = tmp_dir ^/ "corrupt_link" in
UNCOV 144	Core.Unix.symlink ~target:"doesnt_exist" ~link_name:corrupt_symlink ;	×
UNCOV 145	initialize_and_expect_failure corrupt_symlink ~logger	×
146	in
147
148	(* create a file and initialize from it *)
149	let%bind some_file_name =
150	let some_file_name = "file.txt" in
151	let some_file = tmp_dir ^/ some_file_name in
UNCOV 152	Out_channel.write_all some_file ~data:"yo" ;	×
UNCOV 153	initialize_and_expect_failure some_file ~logger >>\| const some_file_name	×
154	in
155
156	(* create a symlink to an existing file, try to initialize from symlink *)
UNCOV 157	let symlink = tmp_dir ^/ "link" in	×
UNCOV 158	Core.Unix.symlink ~target:some_file_name ~link_name:symlink ;	×
159	initialize_and_expect_failure symlink ~logger
160
161	let initialization_special_cases () =
UNCOV 162	Async.Thread_safe.block_on_async_exn	×
163	@@ fun () ->
NEW 164	Mina_stdlib_unix.File_system.with_temp_dir	×
165	"disk_cache-invalid-initialization" ~f:initialization_special_cases_impl
166	end
167
168	module Make (Disk_cache : Disk_cache_intf.F_with_count) :
169	S with module Cache := Disk_cache(Mock) = struct
170	include Make_impl (Disk_cache (Mock))
171	end
172
173	module Make_extended (Disk_cache : Disk_cache_intf.F_extended) :
174	S_extended with module Cache := Disk_cache(Mock) = struct
175	module Cache = Disk_cache (Mock)
176	include Make_impl (Cache)
177
178	let iteration_checks (cache, proof1, proof2, id1, id2) =
UNCOV 179	let id1_not_visited = ref true in	×
180	let id2_not_visited = ref true in
181	Cache.iteri cache ~f:(fun id content ->
UNCOV 182	let expected_content =	×
UNCOV 183	if id = Cache.int_of_id id1 then (	×
UNCOV 184	assert !id1_not_visited ;	×
185	id1_not_visited := false ;
186	proof1 )
UNCOV 187	else if id = Cache.int_of_id id2 then (	×
UNCOV 188	assert !id2_not_visited ;	×
189	id2_not_visited := false ;
190	proof2 )
191	else failwith "unexpected key in iteration"	×
192	in
UNCOV 193	[%test_eq: string] content.Mock.proof expected_content.Mock.proof ;	×
UNCOV 194	`Continue ) ;	×
UNCOV 195	assert ((not !id1_not_visited) && not !id2_not_visited)	×
196
197	let simple_write_with_iteration =
198	simple_write ~additional_checks:iteration_checks
199	end	98✔

MinaProtocol / mina / 535

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous