<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/lib/descriptor/env.rs`."><title>env.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-c579a84d.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="cli" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0-nightly (6067b3631 2025-01-17)" data-channel="nightly" data-search-js="search-ccb196c1.js" data-settings-js="settings-0f613d39.js" ><script src="../../../static.files/storage-59e33391.js"></script><script defer src="../../../static.files/src-script-56102188.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">cli/descriptor/</div>env.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers">
<a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
<a href="#143" id="143">143</a>
<a href="#144" id="144">144</a>
<a href="#145" id="145">145</a>
<a href="#146" id="146">146</a>
<a href="#147" id="147">147</a>
<a href="#148" id="148">148</a>
<a href="#149" id="149">149</a>
<a href="#150" id="150">150</a>
<a href="#151" id="151">151</a>
<a href="#152" id="152">152</a>
<a href="#153" id="153">153</a>
<a href="#154" id="154">154</a>
<a href="#155" id="155">155</a>
<a href="#156" id="156">156</a>
<a href="#157" id="157">157</a>
<a href="#158" id="158">158</a>
<a href="#159" id="159">159</a>
<a href="#160" id="160">160</a>
<a href="#161" id="161">161</a>
<a href="#162" id="162">162</a>
<a href="#163" id="163">163</a>
<a href="#164" id="164">164</a>
<a href="#165" id="165">165</a>
<a href="#166" id="166">166</a>
<a href="#167" id="167">167</a>
<a href="#168" id="168">168</a>
<a href="#169" id="169">169</a>
<a href="#170" id="170">170</a>
<a href="#171" id="171">171</a>
<a href="#172" id="172">172</a>
<a href="#173" id="173">173</a>
<a href="#174" id="174">174</a>
<a href="#175" id="175">175</a>
<a href="#176" id="176">176</a>
<a href="#177" id="177">177</a>
<a href="#178" id="178">178</a>
<a href="#179" id="179">179</a>
<a href="#180" id="180">180</a>
<a href="#181" id="181">181</a>
<a href="#182" id="182">182</a>
<a href="#183" id="183">183</a>
<a href="#184" id="184">184</a>
<a href="#185" id="185">185</a>
<a href="#186" id="186">186</a>
<a href="#187" id="187">187</a>
<a href="#188" id="188">188</a>
<a href="#189" id="189">189</a>
<a href="#190" id="190">190</a>
<a href="#191" id="191">191</a>
<a href="#192" id="192">192</a>
<a href="#193" id="193">193</a>
<a href="#194" id="194">194</a>
<a href="#195" id="195">195</a>
<a href="#196" id="196">196</a>
<a href="#197" id="197">197</a>
<a href="#198" id="198">198</a>
<a href="#199" id="199">199</a>
<a href="#200" id="200">200</a>
<a href="#201" id="201">201</a>
<a href="#202" id="202">202</a>
<a href="#203" id="203">203</a>
<a href="#204" id="204">204</a>
<a href="#205" id="205">205</a>
<a href="#206" id="206">206</a>
<a href="#207" id="207">207</a>
<a href="#208" id="208">208</a>
<a href="#209" id="209">209</a>
<a href="#210" id="210">210</a>
<a href="#211" id="211">211</a>
<a href="#212" id="212">212</a>
<a href="#213" id="213">213</a>
<a href="#214" id="214">214</a>
<a href="#215" id="215">215</a>
<a href="#216" id="216">216</a>
<a href="#217" id="217">217</a>
<a href="#218" id="218">218</a>
<a href="#219" id="219">219</a>
<a href="#220" id="220">220</a>
<a href="#221" id="221">221</a>
<a href="#222" id="222">222</a>
<a href="#223" id="223">223</a>
<a href="#224" id="224">224</a>
<a href="#225" id="225">225</a></pre></div><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::error::CargoMakeError;
<span class="kw">use </span><span class="kw">crate</span>::types::{
EnvFile, EnvValue, EnvValueConditioned, EnvValueDecode, EnvValuePathGlob, EnvValueScript,
};
<span class="kw">use </span>indexmap::{IndexMap, IndexSet};
<span class="kw">use </span>once_cell::sync::Lazy;
<span class="kw">use </span>petgraph::algo::{kosaraju_scc, toposort};
<span class="kw">use </span>petgraph::graphmap::{DiGraphMap, GraphMap};
<span class="kw">use </span>regex::Regex;
<span class="attr">#[cfg(test)]
#[path = <span class="string">"env_test.rs"</span>]
</span><span class="kw">mod </span>env_test;
<span class="kw">static </span>RE_VARIABLE: Lazy<Regex> = Lazy::new(|| Regex::new(<span class="string">r"\$\{.*?}"</span>).unwrap());
<span class="kw">fn </span>env_unique<<span class="lifetime">'a</span>>(vals: <span class="kw-2">&</span><span class="lifetime">'a </span>[<span class="kw-2">&</span><span class="lifetime">'a </span>IndexMap<String, EnvValue>]) -> Vec<(<span class="kw-2">&</span><span class="lifetime">'a </span>str, <span class="kw-2">&</span><span class="lifetime">'a </span>EnvValue)> {
<span class="kw">let </span><span class="kw-2">mut </span>visited = IndexSet::new();
<span class="kw">let </span><span class="kw-2">mut </span>unique = <span class="macro">vec!</span>[];
<span class="comment">// iterate through the list in reverse, only taking the first value, then
// reversing again to make sure that we still adhere to the order.
// This way we will only ever take the latest value.
</span><span class="kw">for </span>(key, val) <span class="kw">in </span>vals.iter().map(|map| map.iter()).flatten().rev() {
<span class="kw">if </span>visited.contains(<span class="kw-2">&</span>key.as_str()) {
<span class="kw">continue</span>;
}
visited.insert(key.as_str());
unique.push((key.as_str(), val))
}
unique.reverse();
unique
}
<span class="kw">static </span>RE_SH_PARAM: Lazy<Regex> =
Lazy::new(|| Regex::new(<span class="string">r"\$(?:([\w-]+)|\{#?([\w-]+)})"</span>).unwrap());
<span class="doccomment">/// The depends_on for a script is a bit more complicated to find,
/// this is because it invokes a shell script (`sh`).
/// This means, that we need to go through the shell script and find all environmental variables
/// that are used, but haven't been declared yet.
///
/// One can also explicitly use a list `depends_on = [...]` to overwrite the existing behavior
/// for finding all dependencies.
///
/// This implementation is very conservative, and regardless of the context, will just capture
/// all environment variables that have been used.
///
/// A future implementation might further extend this, by looking for `'` usage,
/// `declare` statements of `[declare] name=value`, and then exclude those in the
/// subsequent analysis.
///
/// To be completely compliant this implementation is based on:
/// https://pubs.opengroup.org/onlinepubs/9699919799/, the official POSIX standard.
///
/// Chapter 8 Environment Variables:
///
/// > Environment variable names used by the utilities in the Shell and Utilities volume of
/// > POSIX.1-2017 consist solely of uppercase letters, digits, and the <underscore> ( '_' )
/// > from the characters defined in Portable Character Set and do not begin with a digit.
/// > Other characters may be permitted by an implementation;
/// > applications shall tolerate the presence of such names.
/// > Uppercase and lowercase letters shall retain their unique identities and shall not be folded
/// > together.
/// > The name space of environment variable names containing lowercase letters is
/// > reserved for applications.
/// > Applications can define any environment variables with names
/// > from this name space without modifying the behavior of the standard utilities.
///
/// A declaration in a shell script is: `declare var=...` where `declare` is optional.
</span><span class="kw">fn </span>env_depends_on_find_script(val: <span class="kw-2">&</span>EnvValueScript) -> Vec<<span class="kw-2">&</span>str> {
<span class="kw">if let </span><span class="prelude-val">Some</span>(depends_on) = <span class="kw-2">&</span>val.depends_on {
<span class="kw">return </span>depends_on.iter().map(String::as_str).collect();
}
<span class="kw">let </span><span class="kw-2">mut </span>depends_on = <span class="macro">vec!</span>[];
<span class="kw">for </span>line <span class="kw">in </span><span class="kw-2">&</span>val.script {
<span class="kw">for </span>captures <span class="kw">in </span>RE_SH_PARAM.captures_iter(line) {
<span class="kw">if let </span><span class="prelude-val">Some</span>(capture) = captures.get(<span class="number">1</span>).or_else(|| captures.get(<span class="number">2</span>)) {
depends_on.push(capture.as_str());
}
}
}
depends_on
}
<span class="kw">fn </span>env_depends_on_find(val: <span class="kw-2">&</span>str) -> Vec<<span class="kw-2">&</span>str> {
<span class="kw">let </span><span class="kw-2">mut </span>depends_on = <span class="macro">vec!</span>[];
<span class="kw">for </span>matched <span class="kw">in </span>RE_VARIABLE.find_iter(val) {
<span class="kw">let </span>matched = matched.as_str();
<span class="comment">// remove the first two characters (`${`)
</span><span class="kw">let </span>(<span class="kw">_</span>, matched) = matched.split_at(<span class="number">2</span>);
<span class="comment">// remove the last character (`}`)
</span><span class="kw">let </span>(matched, <span class="kw">_</span>) = matched.split_at(matched.len() - <span class="number">1</span>);
depends_on.push(matched.trim());
}
depends_on
}
<span class="kw">fn </span>env_depends_on(val: <span class="kw-2">&</span>EnvValue) -> Vec<<span class="kw-2">&</span>str> {
<span class="kw">match </span>val {
EnvValue::Value(value) => env_depends_on_find(value),
EnvValue::Decode(EnvValueDecode { source, .. }) => env_depends_on_find(source),
EnvValue::List(values) => values
.iter()
.map(|value| env_depends_on_find(value))
.reduce(|<span class="kw-2">mut </span>acc, <span class="kw-2">mut </span>other| {
acc.append(<span class="kw-2">&mut </span>other);
acc
})
.unwrap_or_default(),
EnvValue::Conditional(EnvValueConditioned { value, .. }) => env_depends_on_find(value),
EnvValue::PathGlob(EnvValuePathGlob { glob, .. }) => env_depends_on_find(glob),
EnvValue::Script(script) => env_depends_on_find_script(script),
<span class="kw">_ </span>=> <span class="macro">vec!</span>[],
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>merge_env(
base: <span class="kw-2">&</span>IndexMap<String, EnvValue>,
ext: <span class="kw-2">&</span>IndexMap<String, EnvValue>,
) -> <span class="prelude-ty">Result</span><IndexMap<String, EnvValue>, CargoMakeError> {
<span class="kw">let </span>combined = [base, ext];
<span class="kw">let </span>combined: Vec<<span class="kw">_</span>> = env_unique(<span class="kw-2">&</span>combined);
<span class="kw">let </span><span class="kw-2">mut </span>graph: GraphMap<<span class="kw-2">&</span>str, (), <span class="kw">_</span>> = DiGraphMap::new();
<span class="kw">let </span>keys: IndexSet<<span class="kw">_</span>> = combined.iter().map(|(key, <span class="kw">_</span>)| <span class="kw-2">*</span>key).collect();
<span class="kw">for </span>key <span class="kw">in </span>keys {
graph.add_node(key);
}
<span class="kw">for </span>(key, val) <span class="kw">in </span><span class="kw-2">&</span>combined {
<span class="comment">// combined is unique (only latest value),
// which is why we do not need to delete any previously declared outbound edges.
// if the env variable is in the current scope add an edge,
// otherwise it is referencing an external variable.
// also, ignore self reference (such as PATH=${PATH})
</span><span class="kw">let </span>is_external = envmnt::exists(<span class="kw-2">&</span>key);
<span class="kw">for </span>used <span class="kw">in </span>env_depends_on(val).into_iter() {
<span class="kw">if </span>(key != <span class="kw-2">&</span>used || !is_external) && graph.contains_node(used) {
graph.add_edge(<span class="kw-2">*</span>key, used, ());
}
}
}
<span class="macro">debug!</span>(<span class="string">"env dependencies: {:?}"</span>, graph);
<span class="kw">let </span>variables = <span class="kw">match </span>toposort(<span class="kw-2">&</span>graph, <span class="prelude-val">None</span>) {
<span class="prelude-val">Ok</span>(iter) => iter,
<span class="prelude-val">Err</span>(<span class="kw">_</span>) => {
<span class="comment">// cycle has been detected, for better performance we now only
// execute scc.
// In strongly-connected-components every vertex
// (node) is reachable from every other node.
// This means that there **must** be a cycle.
// This isn't strictly necessary, but aids when debugging.
</span><span class="kw">for </span>scc <span class="kw">in </span>kosaraju_scc(<span class="kw-2">&</span>graph) {
<span class="kw">let </span>render = scc
.iter()
.chain(scc.first())
.map(ToString::to_string)
.reduce(|acc, name| <span class="macro">format!</span>(<span class="string">"{} -> {}"</span>, acc, name));
<span class="kw">if let </span><span class="prelude-val">Some</span>(render) = render {
<span class="kw">return </span><span class="prelude-val">Err</span>(CargoMakeError::EnvVarCycle(<span class="macro">format!</span>(<span class="string">" Cycle: {}."</span>, render)));
}
}
<span class="kw">return </span><span class="prelude-val">Err</span>(CargoMakeError::EnvVarCycle(String::new()));
}
};
<span class="kw">let </span><span class="kw-2">mut </span>merge = IndexMap::new();
<span class="kw">for </span>name <span class="kw">in </span>variables.into_iter().rev() {
<span class="kw">if </span>name.starts_with(<span class="string">"CARGO_MAKE_CURRENT_TASK_"</span>) {
<span class="comment">// CARGO_MAKE_CURRENT_TASK are handled differently and **always**
// retain their old value
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(value) = base.get(name) {
merge.insert(name.to_owned(), value.clone());
}
<span class="kw">continue</span>;
}
<span class="kw">if let </span><span class="prelude-val">Some</span>((key, val)) = combined
.iter()
.filter(|(key, <span class="kw">_</span>)| <span class="kw-2">*</span>key == name)
.last()
.cloned()
{
<span class="comment">// we need to check if the base and ext both are a profile,
// in that case we need to do some special handling,
// by merging them as well.
</span><span class="kw">match </span>(base.get(key), ext.get(key)) {
(<span class="prelude-val">Some</span>(EnvValue::Profile(base)), <span class="prelude-val">Some</span>(EnvValue::Profile(ext))) => {
merge.insert(key.to_owned(), EnvValue::Profile(merge_env(base, ext)<span class="question-mark">?</span>));
}
<span class="kw">_ </span>=> {
merge.insert(key.to_owned(), val.clone());
}
}
}
}
<span class="prelude-val">Ok</span>(merge)
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>merge_env_files(
base: <span class="kw-2">&mut </span>Vec<EnvFile>,
extended: <span class="kw-2">&mut </span>Vec<EnvFile>,
) -> Vec<EnvFile> {
[<span class="kw-2">&</span>extended[..], <span class="kw-2">&</span>base[..]].concat()
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>merge_env_scripts(base: <span class="kw-2">&mut </span>Vec<String>, extended: <span class="kw-2">&mut </span>Vec<String>) -> Vec<String> {
[<span class="kw-2">&</span>extended[..], <span class="kw-2">&</span>base[..]].concat()
}
</code></pre></div></section></main></body></html>