lib/ureq
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add support for using testserver in doctests. (#218)

Browse Source 
Doctests run against a normally-built copy of the crate, i.e. one
without #[cfg(test)] set, so we can't use the conditional compilation
feature.

Instead, define a static var that indicates whether the library is
running in test mode or not. For each doctest, insert a hidden call that
sets this var to true. Then, when ureq::agent() is called, it returns a
test_agent instead.

This required moving testserver out of the test mod and into src/, so
that it can be included unconditionally (i.e. when cfg(test) is false).

This PR converts one doctest as an example. If we land this PR, I'll
send a followup to convert the rest.
This commit is contained in:
Jacob Hoffman-Andrews
2020-11-13 10:40:16 -08:00
committed by GitHub
parent a0b901f35b
commit acc36ac370
8 changed files with 177 additions and 132 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
src/test/mod.rs
View File

@@ -1,10 +1,10 @@
use crate::unit::Unit;
use crate::{error::Error, Agent};
use crate::{stream::Stream, AgentBuilder};
use crate::{error::Error};
use crate::{stream::Stream};
use once_cell::sync::Lazy;
use std::io::{Cursor, Write};
use std::sync::{Arc, Mutex};
use std::{collections::HashMap, net::ToSocketAddrs};
use std::{collections::HashMap};
mod agent_test;
mod body_read;
@@ -13,44 +13,8 @@ mod query_string;
mod range;
mod redirect;
mod simple;
pub(crate) mod testserver;
mod timeout;
// An agent to be installed by default for tests and doctests, such
// that all hostnames resolve to a TestServer on localhost.
pub(crate) fn test_agent() -> Agent {
use std::io;
use std::net::{SocketAddr, TcpStream};
let testserver = testserver::TestServer::new(|mut stream: TcpStream| -> io::Result<()> {
testserver::read_headers(&stream);
stream.write_all(b"HTTP/1.1 200 OK\r\n")?;
stream.write_all(b"Transfer-Encoding: chunked\r\n")?;
stream.write_all(b"Content-Type: text/html; charset=ISO-8859-1\r\n")?;
stream.write_all(b"\r\n")?;
stream.write_all(b"7\r\n")?;
stream.write_all(b"success\r\n")?;
stream.write_all(b"0\r\n")?;
stream.write_all(b"\r\n")?;
Ok(())
});
// Slightly tricky thing here: we want to make sure the TestServer lives
// as long as the agent. This is accomplished by `move`ing it into the
// closure, which becomes owned by the agent.
AgentBuilder::new()
.resolver(move |h: &str| -> io::Result<Vec<SocketAddr>> {
// Don't override resolution for HTTPS requests yet, since we
// don't have a setup for an HTTPS testserver. Also, skip localhost
// resolutions since those may come from a unittest that set up
// its own, specific testserver.
if h.ends_with(":443") || h.starts_with("localhost:") {
return Ok(h.to_socket_addrs()?.collect::<Vec<_>>());
}
let addr: SocketAddr = format!("127.0.0.1:{}", testserver.port).parse().unwrap();
Ok(vec![addr])
})
.build()
}
type RequestHandler = dyn Fn(&Unit) -> Result<Stream, Error> + Send + 'static;
pub(crate) static TEST_HANDLERS: Lazy<Arc<Mutex<HashMap<String, Box<RequestHandler>>>>> =