canic-core 0.99.19

Canic — a canister orchestration and management toolkit for the Internet Computer
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

//! Module: infra::ic::release_build
//!
//! Responsibility: expose the release-build identity embedded at compile time.
//! Does not own: release-build planning, artifact hashing, or install admission.
//! Boundary: qualified release builds supply one canonical ID through the build script.

use crate::ids::{ReleaseBuildId, ReleaseBuildIdParseError};
use thiserror::Error as ThisError;

///
/// EmbeddedReleaseBuildError
///

#[derive(Debug, ThisError)]
pub enum EmbeddedReleaseBuildError {
    #[error("Wasm has no embedded release-build identity")]
    Missing,

    #[error("Wasm contains an invalid embedded release-build identity: {0}")]
    Invalid(#[from] ReleaseBuildIdParseError),
}

///
/// ReleaseBuildInfra
///

pub struct ReleaseBuildInfra;

impl ReleaseBuildInfra {
    pub fn embedded_release_build_id() -> Result<ReleaseBuildId, EmbeddedReleaseBuildError> {
        Self::release_build_id_from_env(option_env!("CANIC_RELEASE_BUILD_ID"))
    }

    fn release_build_id_from_env(
        value: Option<&str>,
    ) -> Result<ReleaseBuildId, EmbeddedReleaseBuildError> {
        value
            .ok_or(EmbeddedReleaseBuildError::Missing)?
            .parse()
            .map_err(Into::into)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn embedded_release_build_identity_requires_canonical_text() {
        assert!(matches!(
            ReleaseBuildInfra::release_build_id_from_env(None),
            Err(EmbeddedReleaseBuildError::Missing)
        ));
        assert!(matches!(
            ReleaseBuildInfra::release_build_id_from_env(Some("AB")),
            Err(EmbeddedReleaseBuildError::Invalid(_))
        ));

        let text = "ab".repeat(32);
        assert_eq!(
            ReleaseBuildInfra::release_build_id_from_env(Some(&text))
                .expect("canonical release-build ID")
                .to_string(),
            text
        );
    }
}