mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-11-14 23:06:59 +00:00
179 lines
18 KiB
HTML
179 lines
18 KiB
HTML
<!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/common/procedure-test/src/lib.rs`."><title>lib.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_procedure_test" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[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" title="Drag to resize sidebar"></div><main><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">common_procedure_test/</div>lib.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="comment">// Copyright 2023 Greptime Team
|
|
<a href=#2 id=2 data-nosnippet>2</a>//
|
|
<a href=#3 id=3 data-nosnippet>3</a>// Licensed under the Apache License, Version 2.0 (the "License");
|
|
<a href=#4 id=4 data-nosnippet>4</a>// you may not use this file except in compliance with the License.
|
|
<a href=#5 id=5 data-nosnippet>5</a>// You may obtain a copy of the License at
|
|
<a href=#6 id=6 data-nosnippet>6</a>//
|
|
<a href=#7 id=7 data-nosnippet>7</a>// http://www.apache.org/licenses/LICENSE-2.0
|
|
<a href=#8 id=8 data-nosnippet>8</a>//
|
|
<a href=#9 id=9 data-nosnippet>9</a>// Unless required by applicable law or agreed to in writing, software
|
|
<a href=#10 id=10 data-nosnippet>10</a>// distributed under the License is distributed on an "AS IS" BASIS,
|
|
<a href=#11 id=11 data-nosnippet>11</a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
<a href=#12 id=12 data-nosnippet>12</a>// See the License for the specific language governing permissions and
|
|
<a href=#13 id=13 data-nosnippet>13</a>// limitations under the License.
|
|
<a href=#14 id=14 data-nosnippet>14</a>
|
|
<a href=#15 id=15 data-nosnippet>15</a></span><span class="doccomment">//! Test utilities for procedures.
|
|
<a href=#16 id=16 data-nosnippet>16</a>
|
|
<a href=#17 id=17 data-nosnippet>17</a></span><span class="kw">use </span>std::collections::HashMap;
|
|
<a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>std::sync::Arc;
|
|
<a href=#19 id=19 data-nosnippet>19</a>
|
|
<a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>async_trait::async_trait;
|
|
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">use </span>common_procedure::local::{DynamicKeyLockGuard, acquire_dynamic_key_lock};
|
|
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">use </span>common_procedure::rwlock::KeyRwLock;
|
|
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">use </span>common_procedure::store::poison_store::PoisonStore;
|
|
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">use </span>common_procedure::test_util::InMemoryPoisonStore;
|
|
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">use </span>common_procedure::{
|
|
<a href=#26 id=26 data-nosnippet>26</a> Context, ContextProvider, Output, PoisonKey, Procedure, ProcedureId, ProcedureState,
|
|
<a href=#27 id=27 data-nosnippet>27</a> ProcedureWithId, <span class="prelude-ty">Result</span>, Status, StringKey,
|
|
<a href=#28 id=28 data-nosnippet>28</a>};
|
|
<a href=#29 id=29 data-nosnippet>29</a><span class="kw">use </span>tokio::sync::watch::Receiver;
|
|
<a href=#30 id=30 data-nosnippet>30</a>
|
|
<a href=#31 id=31 data-nosnippet>31</a><span class="doccomment">/// A Mock [ContextProvider].
|
|
<a href=#32 id=32 data-nosnippet>32</a></span><span class="attr">#[derive(Default)]
|
|
<a href=#33 id=33 data-nosnippet>33</a></span><span class="kw">pub struct </span>MockContextProvider {
|
|
<a href=#34 id=34 data-nosnippet>34</a> states: HashMap<ProcedureId, ProcedureState>,
|
|
<a href=#35 id=35 data-nosnippet>35</a> poison_manager: InMemoryPoisonStore,
|
|
<a href=#36 id=36 data-nosnippet>36</a> dynamic_key_lock: Arc<KeyRwLock<String>>,
|
|
<a href=#37 id=37 data-nosnippet>37</a>}
|
|
<a href=#38 id=38 data-nosnippet>38</a>
|
|
<a href=#39 id=39 data-nosnippet>39</a><span class="kw">impl </span>MockContextProvider {
|
|
<a href=#40 id=40 data-nosnippet>40</a> <span class="doccomment">/// Returns a new provider.
|
|
<a href=#41 id=41 data-nosnippet>41</a> </span><span class="kw">pub fn </span>new(states: HashMap<ProcedureId, ProcedureState>) -> MockContextProvider {
|
|
<a href=#42 id=42 data-nosnippet>42</a> MockContextProvider {
|
|
<a href=#43 id=43 data-nosnippet>43</a> states,
|
|
<a href=#44 id=44 data-nosnippet>44</a> poison_manager: InMemoryPoisonStore::default(),
|
|
<a href=#45 id=45 data-nosnippet>45</a> dynamic_key_lock: Arc::new(KeyRwLock::new()),
|
|
<a href=#46 id=46 data-nosnippet>46</a> }
|
|
<a href=#47 id=47 data-nosnippet>47</a> }
|
|
<a href=#48 id=48 data-nosnippet>48</a>
|
|
<a href=#49 id=49 data-nosnippet>49</a> <span class="doccomment">/// Returns a reference to the poison manager.
|
|
<a href=#50 id=50 data-nosnippet>50</a> </span><span class="kw">pub fn </span>poison_manager(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>InMemoryPoisonStore {
|
|
<a href=#51 id=51 data-nosnippet>51</a> <span class="kw-2">&</span><span class="self">self</span>.poison_manager
|
|
<a href=#52 id=52 data-nosnippet>52</a> }
|
|
<a href=#53 id=53 data-nosnippet>53</a>}
|
|
<a href=#54 id=54 data-nosnippet>54</a>
|
|
<a href=#55 id=55 data-nosnippet>55</a><span class="attr">#[async_trait]
|
|
<a href=#56 id=56 data-nosnippet>56</a></span><span class="kw">impl </span>ContextProvider <span class="kw">for </span>MockContextProvider {
|
|
<a href=#57 id=57 data-nosnippet>57</a> <span class="kw">async fn </span>procedure_state(<span class="kw-2">&</span><span class="self">self</span>, procedure_id: ProcedureId) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><ProcedureState>> {
|
|
<a href=#58 id=58 data-nosnippet>58</a> <span class="prelude-val">Ok</span>(<span class="self">self</span>.states.get(<span class="kw-2">&</span>procedure_id).cloned())
|
|
<a href=#59 id=59 data-nosnippet>59</a> }
|
|
<a href=#60 id=60 data-nosnippet>60</a>
|
|
<a href=#61 id=61 data-nosnippet>61</a> <span class="kw">async fn </span>procedure_state_receiver(
|
|
<a href=#62 id=62 data-nosnippet>62</a> <span class="kw-2">&</span><span class="self">self</span>,
|
|
<a href=#63 id=63 data-nosnippet>63</a> _procedure_id: ProcedureId,
|
|
<a href=#64 id=64 data-nosnippet>64</a> ) -> <span class="prelude-ty">Result</span><<span class="prelude-ty">Option</span><Receiver<ProcedureState>>> {
|
|
<a href=#65 id=65 data-nosnippet>65</a> <span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>)
|
|
<a href=#66 id=66 data-nosnippet>66</a> }
|
|
<a href=#67 id=67 data-nosnippet>67</a>
|
|
<a href=#68 id=68 data-nosnippet>68</a> <span class="kw">async fn </span>try_put_poison(<span class="kw-2">&</span><span class="self">self</span>, key: <span class="kw-2">&</span>PoisonKey, procedure_id: ProcedureId) -> <span class="prelude-ty">Result</span><()> {
|
|
<a href=#69 id=69 data-nosnippet>69</a> <span class="self">self</span>.poison_manager
|
|
<a href=#70 id=70 data-nosnippet>70</a> .try_put_poison(key.to_string(), procedure_id.to_string())
|
|
<a href=#71 id=71 data-nosnippet>71</a> .<span class="kw">await
|
|
<a href=#72 id=72 data-nosnippet>72</a> </span>}
|
|
<a href=#73 id=73 data-nosnippet>73</a>
|
|
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">async fn </span>acquire_lock(<span class="kw-2">&</span><span class="self">self</span>, key: <span class="kw-2">&</span>StringKey) -> DynamicKeyLockGuard {
|
|
<a href=#75 id=75 data-nosnippet>75</a> acquire_dynamic_key_lock(<span class="kw-2">&</span><span class="self">self</span>.dynamic_key_lock, key).<span class="kw">await
|
|
<a href=#76 id=76 data-nosnippet>76</a> </span>}
|
|
<a href=#77 id=77 data-nosnippet>77</a>}
|
|
<a href=#78 id=78 data-nosnippet>78</a>
|
|
<a href=#79 id=79 data-nosnippet>79</a><span class="doccomment">/// Executes a procedure until it returns [Status::Done].
|
|
<a href=#80 id=80 data-nosnippet>80</a>///
|
|
<a href=#81 id=81 data-nosnippet>81</a>/// # Panics
|
|
<a href=#82 id=82 data-nosnippet>82</a>/// Panics if the `procedure` has subprocedure to execute.
|
|
<a href=#83 id=83 data-nosnippet>83</a></span><span class="kw">pub async fn </span>execute_procedure_until_done(procedure: <span class="kw-2">&mut </span><span class="kw">dyn </span>Procedure) -> <span class="prelude-ty">Option</span><Output> {
|
|
<a href=#84 id=84 data-nosnippet>84</a> <span class="kw">let </span>ctx = Context {
|
|
<a href=#85 id=85 data-nosnippet>85</a> procedure_id: ProcedureId::random(),
|
|
<a href=#86 id=86 data-nosnippet>86</a> provider: Arc::new(MockContextProvider::default()),
|
|
<a href=#87 id=87 data-nosnippet>87</a> };
|
|
<a href=#88 id=88 data-nosnippet>88</a>
|
|
<a href=#89 id=89 data-nosnippet>89</a> <span class="kw">loop </span>{
|
|
<a href=#90 id=90 data-nosnippet>90</a> <span class="kw">match </span>procedure.execute(<span class="kw-2">&</span>ctx).<span class="kw">await</span>.unwrap() {
|
|
<a href=#91 id=91 data-nosnippet>91</a> Status::Executing { .. } => (),
|
|
<a href=#92 id=92 data-nosnippet>92</a> Status::Suspended { subprocedures, .. } => <span class="macro">assert!</span>(
|
|
<a href=#93 id=93 data-nosnippet>93</a> subprocedures.is_empty(),
|
|
<a href=#94 id=94 data-nosnippet>94</a> <span class="string">"Executing subprocedure is unsupported"
|
|
<a href=#95 id=95 data-nosnippet>95</a> </span>),
|
|
<a href=#96 id=96 data-nosnippet>96</a> Status::Done { output } => <span class="kw">return </span>output,
|
|
<a href=#97 id=97 data-nosnippet>97</a> Status::Poisoned { .. } => <span class="kw">return </span><span class="prelude-val">None</span>,
|
|
<a href=#98 id=98 data-nosnippet>98</a> }
|
|
<a href=#99 id=99 data-nosnippet>99</a> }
|
|
<a href=#100 id=100 data-nosnippet>100</a>}
|
|
<a href=#101 id=101 data-nosnippet>101</a>
|
|
<a href=#102 id=102 data-nosnippet>102</a><span class="doccomment">/// Executes a procedure once.
|
|
<a href=#103 id=103 data-nosnippet>103</a>///
|
|
<a href=#104 id=104 data-nosnippet>104</a>/// Returns whether the procedure is done.
|
|
<a href=#105 id=105 data-nosnippet>105</a></span><span class="kw">pub async fn </span>execute_procedure_once(
|
|
<a href=#106 id=106 data-nosnippet>106</a> procedure_id: ProcedureId,
|
|
<a href=#107 id=107 data-nosnippet>107</a> provider: MockContextProvider,
|
|
<a href=#108 id=108 data-nosnippet>108</a> procedure: <span class="kw-2">&mut </span><span class="kw">dyn </span>Procedure,
|
|
<a href=#109 id=109 data-nosnippet>109</a>) -> bool {
|
|
<a href=#110 id=110 data-nosnippet>110</a> <span class="kw">let </span>ctx = Context {
|
|
<a href=#111 id=111 data-nosnippet>111</a> procedure_id,
|
|
<a href=#112 id=112 data-nosnippet>112</a> provider: Arc::new(provider),
|
|
<a href=#113 id=113 data-nosnippet>113</a> };
|
|
<a href=#114 id=114 data-nosnippet>114</a>
|
|
<a href=#115 id=115 data-nosnippet>115</a> <span class="kw">match </span>procedure.execute(<span class="kw-2">&</span>ctx).<span class="kw">await</span>.unwrap() {
|
|
<a href=#116 id=116 data-nosnippet>116</a> Status::Executing { .. } => <span class="bool-val">false</span>,
|
|
<a href=#117 id=117 data-nosnippet>117</a> Status::Suspended { subprocedures, .. } => {
|
|
<a href=#118 id=118 data-nosnippet>118</a> <span class="macro">assert!</span>(
|
|
<a href=#119 id=119 data-nosnippet>119</a> subprocedures.is_empty(),
|
|
<a href=#120 id=120 data-nosnippet>120</a> <span class="string">"Executing subprocedure is unsupported"
|
|
<a href=#121 id=121 data-nosnippet>121</a> </span>);
|
|
<a href=#122 id=122 data-nosnippet>122</a> <span class="bool-val">false
|
|
<a href=#123 id=123 data-nosnippet>123</a> </span>}
|
|
<a href=#124 id=124 data-nosnippet>124</a> Status::Done { .. } => <span class="bool-val">true</span>,
|
|
<a href=#125 id=125 data-nosnippet>125</a> Status::Poisoned { .. } => <span class="bool-val">false</span>,
|
|
<a href=#126 id=126 data-nosnippet>126</a> }
|
|
<a href=#127 id=127 data-nosnippet>127</a>}
|
|
<a href=#128 id=128 data-nosnippet>128</a>
|
|
<a href=#129 id=129 data-nosnippet>129</a><span class="doccomment">/// Executes a procedure until it returns [Status::Suspended] or [Status::Done].
|
|
<a href=#130 id=130 data-nosnippet>130</a>///
|
|
<a href=#131 id=131 data-nosnippet>131</a>/// Returns `Some` if it returns [Status::Suspended] or `None` if it returns [Status::Done].
|
|
<a href=#132 id=132 data-nosnippet>132</a></span><span class="kw">pub async fn </span>execute_until_suspended_or_done(
|
|
<a href=#133 id=133 data-nosnippet>133</a> procedure_id: ProcedureId,
|
|
<a href=#134 id=134 data-nosnippet>134</a> provider: MockContextProvider,
|
|
<a href=#135 id=135 data-nosnippet>135</a> procedure: <span class="kw-2">&mut </span><span class="kw">dyn </span>Procedure,
|
|
<a href=#136 id=136 data-nosnippet>136</a>) -> <span class="prelude-ty">Option</span><Vec<ProcedureWithId>> {
|
|
<a href=#137 id=137 data-nosnippet>137</a> <span class="kw">let </span>ctx = Context {
|
|
<a href=#138 id=138 data-nosnippet>138</a> procedure_id,
|
|
<a href=#139 id=139 data-nosnippet>139</a> provider: Arc::new(provider),
|
|
<a href=#140 id=140 data-nosnippet>140</a> };
|
|
<a href=#141 id=141 data-nosnippet>141</a>
|
|
<a href=#142 id=142 data-nosnippet>142</a> <span class="kw">loop </span>{
|
|
<a href=#143 id=143 data-nosnippet>143</a> <span class="kw">match </span>procedure.execute(<span class="kw-2">&</span>ctx).<span class="kw">await</span>.unwrap() {
|
|
<a href=#144 id=144 data-nosnippet>144</a> Status::Executing { .. } => (),
|
|
<a href=#145 id=145 data-nosnippet>145</a> Status::Suspended { subprocedures, .. } => <span class="kw">return </span><span class="prelude-val">Some</span>(subprocedures),
|
|
<a href=#146 id=146 data-nosnippet>146</a> Status::Done { .. } => <span class="kw">break</span>,
|
|
<a href=#147 id=147 data-nosnippet>147</a> Status::Poisoned { .. } => <span class="macro">unreachable!</span>(),
|
|
<a href=#148 id=148 data-nosnippet>148</a> }
|
|
<a href=#149 id=149 data-nosnippet>149</a> }
|
|
<a href=#150 id=150 data-nosnippet>150</a>
|
|
<a href=#151 id=151 data-nosnippet>151</a> <span class="prelude-val">None
|
|
<a href=#152 id=152 data-nosnippet>152</a></span>}
|
|
<a href=#153 id=153 data-nosnippet>153</a>
|
|
<a href=#154 id=154 data-nosnippet>154</a><span class="kw">pub fn </span>new_test_procedure_context() -> Context {
|
|
<a href=#155 id=155 data-nosnippet>155</a> Context {
|
|
<a href=#156 id=156 data-nosnippet>156</a> procedure_id: ProcedureId::random(),
|
|
<a href=#157 id=157 data-nosnippet>157</a> provider: Arc::new(MockContextProvider::default()),
|
|
<a href=#158 id=158 data-nosnippet>158</a> }
|
|
<a href=#159 id=159 data-nosnippet>159</a>}
|
|
<a href=#160 id=160 data-nosnippet>160</a>
|
|
<a href=#161 id=161 data-nosnippet>161</a><span class="kw">pub async fn </span>execute_procedure_until<P: Procedure>(procedure: <span class="kw-2">&mut </span>P, until: <span class="kw">impl </span>Fn(<span class="kw-2">&</span>P) -> bool) {
|
|
<a href=#162 id=162 data-nosnippet>162</a> <span class="kw">let </span><span class="kw-2">mut </span>reached = <span class="bool-val">false</span>;
|
|
<a href=#163 id=163 data-nosnippet>163</a> <span class="kw">let </span>context = new_test_procedure_context();
|
|
<a href=#164 id=164 data-nosnippet>164</a> <span class="kw">while </span>!<span class="macro">matches!</span>(
|
|
<a href=#165 id=165 data-nosnippet>165</a> procedure.execute(<span class="kw-2">&</span>context).<span class="kw">await</span>.unwrap(),
|
|
<a href=#166 id=166 data-nosnippet>166</a> Status::Done { .. }
|
|
<a href=#167 id=167 data-nosnippet>167</a> ) {
|
|
<a href=#168 id=168 data-nosnippet>168</a> <span class="kw">if </span>until(procedure) {
|
|
<a href=#169 id=169 data-nosnippet>169</a> reached = <span class="bool-val">true</span>;
|
|
<a href=#170 id=170 data-nosnippet>170</a> <span class="kw">break</span>;
|
|
<a href=#171 id=171 data-nosnippet>171</a> }
|
|
<a href=#172 id=172 data-nosnippet>172</a> }
|
|
<a href=#173 id=173 data-nosnippet>173</a> <span class="macro">assert!</span>(
|
|
<a href=#174 id=174 data-nosnippet>174</a> reached,
|
|
<a href=#175 id=175 data-nosnippet>175</a> <span class="string">"procedure '{}' did not reach the expected state"</span>,
|
|
<a href=#176 id=176 data-nosnippet>176</a> procedure.type_name()
|
|
<a href=#177 id=177 data-nosnippet>177</a> );
|
|
<a href=#178 id=178 data-nosnippet>178</a>}
|
|
</code></pre></div></section></main></body></html> |