pathfinder-common 0.22.2

Common types and utilities for Pathfinder
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

use std::path::Path;

/// ## Important
/// This function does nothing in production builds.
///
/// ## Integration testing
/// Creates a marker file in the data directory indicating that a specific port
/// has been assigned. This function is only active in debug builds. The file is
/// named `{pid}_{name}_port_{value}`.
///
/// ## Panics
/// The function will panic if it fails to create the marker file.
pub fn debug_create_port_marker_file(_name: &str, _value: u16, _data_directory: &Path) {
    #[cfg(debug_assertions)]
    {
        if std::env::var_os("PATHFINDER_TEST_ENABLE_MARKER_FILES").is_some() {
            _ = std::fs::create_dir_all(_data_directory);
            let marker_file =
                _data_directory.join(format!("pid_{}_{}_port", std::process::id(), _name));
            std::fs::write(&marker_file, _value.to_string()).unwrap_or_else(|_| {
                panic!("Failed to create marker file {}", marker_file.display())
            });
        }
    }
}

/// ## Important
/// This function does nothing in production builds.
///
/// ## Integration testing
/// Creates a marker file in the data directory.
///
/// ## Panics
/// The function will panic if it fails to create the marker file.
pub fn debug_create_marker_file(_name: &str, _data_directory: &Path) {
    #[cfg(debug_assertions)]
    {
        if std::env::var_os("PATHFINDER_TEST_ENABLE_MARKER_FILES").is_some() {
            _ = std::fs::create_dir_all(_data_directory);
            let marker_file = _data_directory.join(_name);
            std::fs::File::create(&marker_file).unwrap_or_else(|_| {
                panic!("Failed to create marker file {}", marker_file.display())
            });
        }
    }
}