trazaeo 0.5.0

Open-source provenance SDK and specification for verifiable EO and climate data workflows
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

use crate::error::{TrazaeoError, TrazaeoResult};
use crate::utils::Hash;
use crate::verification::VerificationMode;
use pyo3::exceptions::{PyOSError, PyRuntimeError, PyTypeError, PyValueError};
use pyo3::prelude::*;
use serde::de::DeserializeOwned;
use serde::Serialize;
use std::path::{Path, PathBuf};

pub(crate) fn py_err(err: TrazaeoError) -> PyErr {
    match err {
        TrazaeoError::InvalidInput { context, details } => {
            PyValueError::new_err(format!("{context}: {details}"))
        }
        TrazaeoError::Validation { context, details } => {
            PyValueError::new_err(format!("{context}: {}", details.join("; ")))
        }
        TrazaeoError::Io { context, details } => {
            PyOSError::new_err(format!("{context}: {details}"))
        }
        TrazaeoError::Serialization { context, details } => {
            PyTypeError::new_err(format!("{context}: {details}"))
        }
        TrazaeoError::External { context, details } => {
            PyRuntimeError::new_err(format!("{context}: {details}"))
        }
    }
}

pub(crate) fn validate_input_path(path: &str) -> PyResult<PathBuf> {
    let canonical = Path::new(path).canonicalize().map_err(|e| {
        py_err(TrazaeoError::io(
            "validate input path",
            format!("invalid path: {e}"),
        ))
    })?;
    let meta = std::fs::symlink_metadata(&canonical).map_err(|e| {
        py_err(TrazaeoError::io(
            "validate input path",
            format!("failed to stat path: {e}"),
        ))
    })?;
    if meta.file_type().is_symlink() {
        return Err(py_err(TrazaeoError::invalid_input(
            "validate input path",
            "symlink paths are not allowed",
        )));
    }
    if !meta.is_file() {
        return Err(py_err(TrazaeoError::invalid_input(
            "validate input path",
            "path must point to a regular file",
        )));
    }
    Ok(canonical)
}

pub(crate) fn parse_hash32_hex(value: &str) -> PyResult<Hash> {
    let bytes = hex::decode(value).map_err(|e| {
        py_err(TrazaeoError::invalid_input(
            "parse hash hex",
            format!("invalid hex hash: {e}"),
        ))
    })?;
    let arr: [u8; 32] = bytes.as_slice().try_into().map_err(|_| {
        py_err(TrazaeoError::invalid_input(
            "parse hash hex",
            "hash must be exactly 32 bytes (64 hex chars)",
        ))
    })?;
    Ok(Hash(arr))
}

pub(crate) fn parse_verification_mode(mode: &str) -> PyResult<VerificationMode> {
    match mode {
        "sampled" => Ok(VerificationMode::Sampled),
        "full" => Ok(VerificationMode::Full),
        _ => Err(py_err(TrazaeoError::invalid_input(
            "parse verification mode",
            "mode must be 'sampled' or 'full'",
        ))),
    }
}

pub(crate) fn hash_to_hex(hash: &Hash) -> String {
    hex::encode(hash.0)
}

pub(crate) fn from_json<T: DeserializeOwned>(context: &'static str, value: &str) -> PyResult<T> {
    serde_json::from_str(value).map_err(|e| {
        py_err(TrazaeoError::serialization(
            context,
            format!("invalid json: {e}"),
        ))
    })
}

pub(crate) fn to_json<T: Serialize>(context: &'static str, value: &T) -> PyResult<String> {
    serde_json::to_string(value).map_err(|e| {
        py_err(TrazaeoError::serialization(
            context,
            format!("failed to serialize json: {e}"),
        ))
    })
}

pub(crate) fn into_py_result<T>(result: TrazaeoResult<T>) -> PyResult<T> {
    result.map_err(py_err)
}

pub(crate) fn into_py_result_display<T, E: std::fmt::Display>(result: Result<T, E>) -> PyResult<T> {
    result.map_err(|err| PyRuntimeError::new_err(err.to_string()))
}