canic-host 0.68.24

Host-side build, install, deployment, and fleet-template library for Canic workspaces
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

use std::path::PathBuf;

use serde::{Deserialize, Serialize};

use crate::{
    canister_build::{CanisterArtifactBuildOutput, CanisterBuildProfile},
    evidence_envelope::{
        CommandProvenanceV1, EvidenceMessageV1, InputFingerprintV1, InputPathDisplayV1,
    },
};

pub const BUILD_PROVENANCE_SCHEMA_ID: &str = "canic.build_provenance.v1";
pub(super) const WASM_TARGET: &str = "wasm32-unknown-unknown";
pub(super) const DIRTY_SUMMARY_ALGORITHM: &str = "git-status-porcelain-v1-z-sha256";

///
/// BuildProvenanceV1
///
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct BuildProvenanceV1 {
    pub schema_version: u8,
    pub generated_at: String,
    pub canic_version: String,
    pub command: CommandProvenanceV1,
    pub build_status: BuildProvenanceStatusV1,
    pub source: SourceProvenanceV1,
    pub cargo: CargoProvenanceV1,
    pub artifacts: Vec<ArtifactProvenanceV1>,
    pub warnings: Vec<EvidenceMessageV1>,
}

///
/// BuildProvenanceStatusV1
///
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum BuildProvenanceStatusV1 {
    Success,
    Failed,
    NotRecorded,
}

///
/// SourceProvenanceV1
///
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct SourceProvenanceV1 {
    pub schema_version: u8,
    pub vcs: SourceVcsV1,
    pub revision: Option<String>,
    pub branch: Option<String>,
    pub dirty: Option<bool>,
    pub dirty_policy: SourceDirtyPolicyV1,
    pub dirty_summary_digest: Option<String>,
    pub dirty_summary_algorithm: Option<String>,
}

///
/// SourceVcsV1
///
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum SourceVcsV1 {
    Git,
    Unknown,
}

///
/// SourceDirtyPolicyV1
///
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum SourceDirtyPolicyV1 {
    Clean,
    DirtyRecorded,
    Unknown,
}

///
/// CargoProvenanceV1
///
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct CargoProvenanceV1 {
    pub cargo_lock_sha256: Option<String>,
    pub package_manifest_sha256: Option<String>,
    pub package_name: String,
    pub package_manifest: String,
    pub package_metadata_fleet: String,
    pub package_metadata_role: String,
    pub rustc_version: Option<String>,
    pub cargo_version: Option<String>,
    pub target: Option<String>,
    pub profile: String,
    pub features: Vec<String>,
    pub default_features: Option<bool>,
    pub rustflags_digest: Option<String>,
    pub rustflags_digest_algorithm: Option<String>,
    pub cargo_config_fingerprints: Vec<InputFingerprintV1>,
    pub build_script_inputs: BuildScriptInputStateV1,
}

///
/// BuildScriptInputStateV1
///
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum BuildScriptInputStateV1 {
    NotRecorded,
    Recorded,
    Unknown,
}

///
/// ArtifactProvenanceV1
///
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct ArtifactProvenanceV1 {
    pub role: String,
    pub fleet: String,
    pub artifact_kind: ArtifactProvenanceKindV1,
    pub path: Option<String>,
    pub path_display: InputPathDisplayV1,
    pub hash_algorithm: String,
    pub sha256: String,
    pub size_bytes: u64,
    pub produced_by: String,
}

///
/// ArtifactProvenanceKindV1
///
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum ArtifactProvenanceKindV1 {
    Wasm,
    WasmGzip,
    Candid,
    Metadata,
    Other,
}

///
/// BuildProvenanceRequest
///
#[derive(Clone, Debug)]
pub struct BuildProvenanceRequest {
    pub fleet: String,
    pub role: String,
    pub network: String,
    pub profile: CanisterBuildProfile,
    pub workspace_root: PathBuf,
    pub config_path: PathBuf,
    pub output: CanisterArtifactBuildOutput,
    pub command: CommandProvenanceV1,
    pub generated_at: String,
    pub canic_version: String,
}