<!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 `actix-server/src/test_server.rs`."><title>test_server.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-b778ab399e080a4b.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="actix_server" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0-nightly (7608018cb 2024-09-29)" data-channel="nightly" data-search-js="search-e056c65ede92db13.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-54bc299d2a5e4e43.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></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">actix_server/</div>test_server.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></pre></div><pre class="rust"><code><span class="kw">use </span>std::{io, net, sync::mpsc, thread};

<span class="kw">use </span>actix_rt::{net::TcpStream, System};

<span class="kw">use crate</span>::{Server, ServerBuilder, ServerHandle, ServerServiceFactory};

<span class="doccomment">/// A testing server.
///
/// `TestServer` is very simple test server that simplify process of writing integration tests for
/// network applications.
///
/// # Examples
/// ```
/// use actix_service::fn_service;
/// use actix_server::TestServer;
///
/// #[actix_rt::main]
/// async fn main() {
///     let srv = TestServer::start(|| fn_service(
///         |sock| async move {
///             println!("New connection: {:?}", sock);
///             Ok::&lt;_, ()&gt;(())
///         }
///     ));
///
///     println!("SOCKET: {:?}", srv.connect());
/// }
/// ```
</span><span class="kw">pub struct </span>TestServer;

<span class="doccomment">/// Test server handle.
</span><span class="kw">pub struct </span>TestServerHandle {
    addr: net::SocketAddr,
    host: String,
    port: u16,
    server_handle: ServerHandle,
    thread_handle: <span class="prelude-ty">Option</span>&lt;thread::JoinHandle&lt;io::Result&lt;()&gt;&gt;&gt;,
}

<span class="kw">impl </span>TestServer {
    <span class="doccomment">/// Start new `TestServer` using application factory and default server config.
    </span><span class="kw">pub fn </span>start(factory: <span class="kw">impl </span>ServerServiceFactory&lt;TcpStream&gt;) -&gt; TestServerHandle {
        <span class="self">Self</span>::start_with_builder(Server::build(), factory)
    }

    <span class="doccomment">/// Start new `TestServer` using application factory and server builder.
    </span><span class="kw">pub fn </span>start_with_builder(
        server_builder: ServerBuilder,
        factory: <span class="kw">impl </span>ServerServiceFactory&lt;TcpStream&gt;,
    ) -&gt; TestServerHandle {
        <span class="kw">let </span>(tx, rx) = mpsc::channel();

        <span class="comment">// run server in separate thread
        </span><span class="kw">let </span>thread_handle = thread::spawn(<span class="kw">move </span>|| {
            <span class="kw">let </span>lst = net::TcpListener::bind(<span class="string">"127.0.0.1:0"</span>).unwrap();
            <span class="kw">let </span>local_addr = lst.local_addr().unwrap();

            System::new().block_on(<span class="kw">async </span>{
                <span class="kw">let </span>server = server_builder
                    .listen(<span class="string">"test"</span>, lst, factory)
                    .unwrap()
                    .workers(<span class="number">1</span>)
                    .disable_signals()
                    .run();

                tx.send((server.handle(), local_addr)).unwrap();
                server.<span class="kw">await
            </span>})
        });

        <span class="kw">let </span>(server_handle, addr) = rx.recv().unwrap();

        <span class="kw">let </span>host = <span class="macro">format!</span>(<span class="string">"{}"</span>, addr.ip());
        <span class="kw">let </span>port = addr.port();

        TestServerHandle {
            addr,
            host,
            port,
            server_handle,
            thread_handle: <span class="prelude-val">Some</span>(thread_handle),
        }
    }

    <span class="doccomment">/// Get first available unused local address.
    </span><span class="kw">pub fn </span>unused_addr() -&gt; net::SocketAddr {
        <span class="kw">use </span>socket2::{Domain, Protocol, Socket, Type};

        <span class="kw">let </span>addr: net::SocketAddr = <span class="string">"127.0.0.1:0"</span>.parse().unwrap();
        <span class="kw">let </span>domain = Domain::for_address(addr);
        <span class="kw">let </span>socket = Socket::new(domain, Type::STREAM, <span class="prelude-val">Some</span>(Protocol::TCP)).unwrap();

        socket.set_reuse_address(<span class="bool-val">true</span>).unwrap();
        socket.set_nonblocking(<span class="bool-val">true</span>).unwrap();
        socket.bind(<span class="kw-2">&amp;</span>addr.into()).unwrap();
        socket.listen(<span class="number">1024</span>).unwrap();

        net::TcpListener::from(socket).local_addr().unwrap()
    }
}

<span class="kw">impl </span>TestServerHandle {
    <span class="doccomment">/// Test server host.
    </span><span class="kw">pub fn </span>host(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>str {
        <span class="kw-2">&amp;</span><span class="self">self</span>.host
    }

    <span class="doccomment">/// Test server port.
    </span><span class="kw">pub fn </span>port(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; u16 {
        <span class="self">self</span>.port
    }

    <span class="doccomment">/// Get test server address.
    </span><span class="kw">pub fn </span>addr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; net::SocketAddr {
        <span class="self">self</span>.addr
    }

    <span class="doccomment">/// Stop server.
    </span><span class="kw">fn </span>stop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
        drop(<span class="self">self</span>.server_handle.stop(<span class="bool-val">false</span>));
        <span class="self">self</span>.thread_handle.take().unwrap().join().unwrap().unwrap();
    }

    <span class="doccomment">/// Connect to server, returning a Tokio `TcpStream`.
    </span><span class="kw">pub fn </span>connect(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; io::Result&lt;TcpStream&gt; {
        TcpStream::from_std(net::TcpStream::connect(<span class="self">self</span>.addr)<span class="question-mark">?</span>)
    }
}

<span class="kw">impl </span>Drop <span class="kw">for </span>TestServerHandle {
    <span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
        <span class="self">self</span>.stop()
    }
}

<span class="attr">#[cfg(test)]
</span><span class="kw">mod </span>tests {
    <span class="kw">use </span>actix_service::fn_service;

    <span class="kw">use super</span>::<span class="kw-2">*</span>;

    <span class="attr">#[tokio::test]
    </span><span class="kw">async fn </span>connect_in_tokio_runtime() {
        <span class="kw">let </span>srv = TestServer::start(|| fn_service(|_sock| <span class="kw">async move </span>{ <span class="prelude-val">Ok</span>::&lt;<span class="kw">_</span>, ()&gt;(()) }));
        <span class="macro">assert!</span>(srv.connect().is_ok());
    }

    <span class="attr">#[actix_rt::test]
    </span><span class="kw">async fn </span>connect_in_actix_runtime() {
        <span class="kw">let </span>srv = TestServer::start(|| fn_service(|_sock| <span class="kw">async move </span>{ <span class="prelude-val">Ok</span>::&lt;<span class="kw">_</span>, ()&gt;(()) }));
        <span class="macro">assert!</span>(srv.connect().is_ok());
    }
}
</code></pre></div></section></main></body></html>