Files
mCaptcha/src/mcaptcha/demo.rs.html

391 lines
20 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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/demo.rs`."><title>demo.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-9ee3a5e31a2afa3e.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="mcaptcha" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0 (82e1608df 2023-12-21)" data-channel="1.75.0" data-search-js="search-8fbf244ebcf71464.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../../static.files/src-script-3280b574d94e47b4.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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"></nav><main><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><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>
</pre></div><pre class="rust"><code><span class="comment">// Copyright (C) 2022 Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
// SPDX-FileCopyrightText: 2023 Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
//
// SPDX-License-Identifier: AGPL-3.0-or-later
</span><span class="kw">use </span>std::time::Duration;
<span class="comment">//use std::sync::atomicBool
</span><span class="kw">use </span>actix::clock::sleep;
<span class="kw">use </span>actix::spawn;
<span class="kw">use </span>tokio::sync::oneshot::{channel, error::TryRecvError, Receiver, Sender};
<span class="kw">use </span>tokio::task::JoinHandle;
<span class="kw">use </span><span class="kw">crate</span>::api::v1::account::delete::runners::delete_user;
<span class="kw">use </span><span class="kw">crate</span>::api::v1::account::{username::runners::username_exists, AccountCheckPayload};
<span class="kw">use </span><span class="kw">crate</span>::api::v1::auth::runners::{register_runner, Register};
<span class="kw">use crate</span>::<span class="kw-2">*</span>;
<span class="kw">use </span>errors::<span class="kw-2">*</span>;
<span class="doccomment">/// Demo username
</span><span class="kw">pub const </span>DEMO_USER: <span class="kw-2">&amp;</span>str = <span class="string">&quot;aaronsw&quot;</span>;
<span class="doccomment">/// Demo password
</span><span class="kw">pub const </span>DEMO_PASSWORD: <span class="kw-2">&amp;</span>str = <span class="string">&quot;password&quot;</span>;
<span class="kw">pub struct </span>DemoUser {
tx: Sender&lt;()&gt;,
}
<span class="kw">impl </span>DemoUser {
<span class="kw">pub async fn </span>spawn(
data: AppData,
duration: u32,
) -&gt; ServiceResult&lt;(<span class="self">Self</span>, JoinHandle&lt;()&gt;)&gt; {
<span class="kw">let </span>(tx, rx) = channel();
<span class="kw">let </span>handle = <span class="self">Self</span>::run(data, duration, rx).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">let </span>d = <span class="self">Self </span>{ tx };
<span class="prelude-val">Ok</span>((d, handle))
}
<span class="attr">#[allow(dead_code)]
</span><span class="kw">pub fn </span>abort(<span class="kw-2">mut </span><span class="self">self</span>) {
<span class="self">self</span>.tx.send(());
}
<span class="doccomment">/// register demo user runner
</span><span class="kw">async fn </span>register_demo_user(data: <span class="kw-2">&amp;</span>AppData) -&gt; ServiceResult&lt;()&gt; {
<span class="kw">let </span>user_exists_payload = AccountCheckPayload {
val: DEMO_USER.into(),
};
<span class="kw">if </span>!username_exists(<span class="kw-2">&amp;</span>user_exists_payload, data).<span class="kw">await</span><span class="question-mark">?</span>.exists {
<span class="kw">let </span>register_payload = Register {
username: DEMO_USER.into(),
password: DEMO_PASSWORD.into(),
confirm_password: DEMO_PASSWORD.into(),
email: <span class="prelude-val">None</span>,
};
<span class="macro">log::info!</span>(<span class="string">&quot;Registering demo user&quot;</span>);
<span class="kw">match </span>register_runner(<span class="kw-2">&amp;</span>register_payload, data).<span class="kw">await </span>{
<span class="prelude-val">Err</span>(ServiceError::UsernameTaken) | <span class="prelude-val">Ok</span>(<span class="kw">_</span>) =&gt; <span class="prelude-val">Ok</span>(()),
<span class="prelude-val">Err</span>(e) =&gt; <span class="prelude-val">Err</span>(e),
}
} <span class="kw">else </span>{
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">async fn </span>delete_demo_user(data: <span class="kw-2">&amp;</span>AppData) -&gt; ServiceResult&lt;()&gt; {
<span class="macro">log::info!</span>(<span class="string">&quot;Deleting demo user&quot;</span>);
delete_user(DEMO_USER, data).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
<span class="kw">pub async fn </span>run(
data: AppData,
duration: u32,
<span class="kw-2">mut </span>rx: Receiver&lt;()&gt;,
) -&gt; ServiceResult&lt;JoinHandle&lt;()&gt;&gt; {
<span class="self">Self</span>::register_demo_user(<span class="kw-2">&amp;</span>data).<span class="kw">await</span><span class="question-mark">?</span>;
<span class="kw">fn </span>can_run(rx: <span class="kw-2">&amp;mut </span>Receiver&lt;()&gt;) -&gt; bool {
<span class="kw">match </span>rx.try_recv() {
<span class="prelude-val">Err</span>(TryRecvError::Empty) =&gt; <span class="bool-val">true</span>,
<span class="kw">_ </span>=&gt; <span class="bool-val">false</span>,
}
}
<span class="kw">let </span><span class="kw-2">mut </span>exit = <span class="bool-val">false</span>;
<span class="kw">let </span>fut = <span class="kw">async move </span>{
<span class="kw">loop </span>{
<span class="kw">if </span>exit {
<span class="kw">break</span>;
}
<span class="kw">for _ in </span><span class="number">0</span>..duration {
<span class="kw">if </span>can_run(<span class="kw-2">&amp;mut </span>rx) {
sleep(Duration::new(<span class="number">1</span>, <span class="number">0</span>)).<span class="kw">await</span>;
<span class="kw">continue</span>;
} <span class="kw">else </span>{
exit = <span class="bool-val">true</span>;
<span class="kw">break</span>;
}
}
<span class="kw">if let </span><span class="prelude-val">Err</span>(e) = <span class="self">Self</span>::delete_demo_user(<span class="kw-2">&amp;</span>data).<span class="kw">await </span>{
<span class="macro">log::error!</span>(<span class="string">&quot;Error while deleting demo user: {:?}&quot;</span>, e);
}
<span class="kw">if let </span><span class="prelude-val">Err</span>(e) = <span class="self">Self</span>::register_demo_user(<span class="kw-2">&amp;</span>data).<span class="kw">await </span>{
<span class="macro">log::error!</span>(<span class="string">&quot;Error while registering demo user: {:?}&quot;</span>, e);
}
}
};
<span class="kw">let </span>handle = spawn(fut);
<span class="prelude-val">Ok</span>(handle)
}
}
<span class="attr">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span>actix_web::test;
<span class="kw">use </span>libmcaptcha::defense::Level;
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::tests::<span class="kw-2">*</span>;
<span class="kw">const </span>DURATION: u64 = <span class="number">25</span>;
<span class="attr">#[actix_rt::test]
</span><span class="kw">async fn </span>demo_account_works_pg() {
<span class="kw">let </span>data = <span class="kw">crate</span>::tests::pg::get_data().<span class="kw">await</span>;
demo_account_works(data).<span class="kw">await</span>;
}
<span class="attr">#[actix_rt::test]
</span><span class="kw">async fn </span>demo_account_works_maria() {
<span class="kw">let </span>data = <span class="kw">crate</span>::tests::maria::get_data().<span class="kw">await</span>;
demo_account_works(data).<span class="kw">await</span>;
}
<span class="kw">async fn </span>demo_account_works(data_inner: ArcData) {
<span class="kw">let </span>data_inner = <span class="kw-2">&amp;</span>data_inner;
<span class="kw">let </span>data = AppData::new(data_inner.clone());
<span class="kw">crate</span>::tests::delete_user(data_inner, DEMO_USER).<span class="kw">await</span>;
<span class="kw">let </span>duration = Duration::from_secs(DURATION);
<span class="comment">// register works
</span>DemoUser::register_demo_user(<span class="kw-2">&amp;</span>data).<span class="kw">await</span>.unwrap();
<span class="kw">let </span>payload = AccountCheckPayload {
val: DEMO_USER.into(),
};
<span class="macro">assert!</span>(username_exists(<span class="kw-2">&amp;</span>payload, <span class="kw-2">&amp;</span>data).<span class="kw">await</span>.unwrap().exists);
signin(data_inner, DEMO_USER, DEMO_PASSWORD).<span class="kw">await</span>;
<span class="comment">// deletion works
</span><span class="macro">assert!</span>(DemoUser::delete_demo_user(<span class="kw-2">&amp;</span>data).<span class="kw">await</span>.is_ok());
<span class="macro">assert!</span>(!username_exists(<span class="kw-2">&amp;</span>payload, <span class="kw-2">&amp;</span>data).<span class="kw">await</span>.unwrap().exists);
<span class="comment">// test the runner
</span><span class="kw">let </span>user = DemoUser::spawn(data, DURATION <span class="kw">as </span>u32).<span class="kw">await</span>.unwrap();
<span class="kw">let </span>(<span class="kw">_</span>, signin_resp, token_key) =
add_levels_util(data_inner, DEMO_USER, DEMO_PASSWORD).<span class="kw">await</span>;
<span class="kw">let </span>cookies = <span class="macro">get_cookie!</span>(signin_resp);
<span class="kw">let </span>app = <span class="macro">get_app!</span>(data_inner).<span class="kw">await</span>;
<span class="kw">let </span>resp = test::call_service(
<span class="kw-2">&amp;</span>app,
<span class="macro">post_request!</span>(<span class="kw-2">&amp;</span>token_key, <span class="kw">crate</span>::V1_API_ROUTES.captcha.get)
.cookie(cookies.clone())
.to_request(),
)
.<span class="kw">await</span>;
<span class="macro">assert_eq!</span>(resp.status(), StatusCode::OK);
<span class="kw">let </span>res_levels: Vec&lt;Level&gt; = test::read_body_json(resp).<span class="kw">await</span>;
<span class="macro">assert!</span>(!res_levels.is_empty());
sleep(Duration::from_secs(DURATION * <span class="number">2</span>)).<span class="kw">await</span>;
<span class="kw">let </span>resp = test::call_service(
<span class="kw-2">&amp;</span>app,
<span class="macro">post_request!</span>(<span class="kw-2">&amp;</span>token_key, <span class="kw">crate</span>::V1_API_ROUTES.captcha.get)
.cookie(cookies)
.to_request(),
)
.<span class="kw">await</span>;
<span class="macro">assert_eq!</span>(resp.status(), StatusCode::OK);
<span class="kw">let </span>res_levels: Vec&lt;Level&gt; = test::read_body_json(resp).<span class="kw">await</span>;
<span class="macro">assert!</span>(res_levels.is_empty());
user.<span class="number">0</span>.abort();
user.<span class="number">1</span>.<span class="kw">await</span>.unwrap();
}
}
</code></pre></div></section></main></body></html>