Compare commits

...

6 commits

Author SHA1 Message Date
0641752a29 feat(net)!: net api: net.{get,post,etc..}(url) alternative to net.send(request) 2024-11-20 19:26:52 +00:00
f2957b2d67 feat(fs): add TempFileSystem::as_real() 2024-11-19 19:41:15 +00:00
52ab5004d0 feat(net)!: new api: .on().respond().{status,header{s},body}(_)?, replacing respond(response) 2024-11-19 19:40:14 +00:00
f759884517 feat(net)!: new api: .on().{get,post, etc}(url), replacing .on(method).get(url)
The `http::Method` parameter is not needed as we now use named methods that the methods on the underlying `reqwest` client.

The `url` parameter can be a `String` or `&str` rather than a parsed, and error handled `url::Url`.
2024-11-19 19:40:02 +00:00
782307a856 fix(net)!: Remove MatchOn
`MatchOn` was left behind from the v1 implementation and isn't used by
anything in the v2 implementation.
2024-11-17 09:15:01 +00:00
0c27a0ee45 feat: re-export http::HeaderMap
Some checks failed
Rust / build (map[name:stable]) (push) Failing after 32s
Rust / build (map[name:nightly]) (push) Failing after 45s
2024-11-17 09:14:39 +00:00
8 changed files with 604 additions and 183 deletions

View file

@ -14,6 +14,7 @@ unexpected_cfgs = { level = "warn", check-cfg = ['cfg(tarpaulin_include)'] }
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies] [dependencies]
bytes = "1.8"
derive_more = { version = "1.0", features = [ derive_more = { version = "1.0", features = [
"constructor", "constructor",
"display", "display",

View file

@ -61,10 +61,6 @@ async fn download_and_save_to_file(
) -> kxio::Result<()> { ) -> kxio::Result<()> {
println!("fetching: {url}"); println!("fetching: {url}");
// Uses the network abstraction to create a perfectly normal `reqwest::ResponseBuilder`.
// `kxio::net::RequestBuilder` is an alias.
let request: kxio::net::RequestBuilder = net.client().get(url);
// Rather than calling `.build().send()?` on the request, pass it to the `net` // Rather than calling `.build().send()?` on the request, pass it to the `net`
// This allows the `net` to either make the network request as normal, or, if we are // This allows the `net` to either make the network request as normal, or, if we are
// under test, to handle the request as the test dictates. // under test, to handle the request as the test dictates.
@ -72,7 +68,13 @@ async fn download_and_save_to_file(
// a real network request being made, even under test conditions. Only ever use the // a real network request being made, even under test conditions. Only ever use the
// `net.send(...)` function to keep your code testable. // `net.send(...)` function to keep your code testable.
// `kxio::net::Response` is an alias for `reqwest::Response`. // `kxio::net::Response` is an alias for `reqwest::Response`.
let response: kxio::net::Response = net.send(request).await?; let response: kxio::net::Response = net.get(url).header("key", "value").send().await?;
// Other options:
// Uses the network abstraction to create a perfectly normal `reqwest::ResponseBuilder`.
// `kxio::net::RequestBuilder` is an alias.
// let response = net.send(net.client().get(url)).await?;
//
// let response = net.post(url).body("{}").send().await?;
let body = response.text().await?; let body = response.text().await?;
println!("fetched {} bytes", body.bytes().len()); println!("fetched {} bytes", body.bytes().len());
@ -102,9 +104,9 @@ fn delete_file(file_path: &Path, fs: &kxio::fs::FileSystem) -> kxio::Result<()>
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use http::StatusCode;
use kxio::net::{Method, Url}; use super::*;
// This test demonstrates how to use the `kxio` to test your program. // This test demonstrates how to use the `kxio` to test your program.
#[tokio::test] #[tokio::test]
@ -118,11 +120,12 @@ mod tests {
let url = "http://localhost:8080"; let url = "http://localhost:8080";
// declare what response should be made for a given request // declare what response should be made for a given request
let response = mock_net.response().body("contents").expect("response body");
mock_net mock_net
.on(Method::GET) .on()
.url(Url::parse(url).expect("parse url")) .get(url)
.respond(response); .respond(StatusCode::OK)
.body("contents")
.expect("valid mock");
// Create a temporary directory that will be deleted with `fs` goes out of scope // Create a temporary directory that will be deleted with `fs` goes out of scope
let fs = kxio::fs::temp().expect("temp fs"); let fs = kxio::fs::temp().expect("temp fs");

View file

@ -21,6 +21,11 @@ impl TempFileSystem {
_temp_dir: temp_dir, _temp_dir: temp_dir,
}) })
} }
/// Create a clone of the wrapped [FileSystem].
pub fn as_real(&self) -> FileSystem {
self.real.clone()
}
} }
impl std::ops::Deref for TempFileSystem { impl std::ops::Deref for TempFileSystem {
type Target = FileSystem; type Target = FileSystem;

View file

@ -79,28 +79,19 @@
//! //!
//! ```rust //! ```rust
//! use kxio::net; //! use kxio::net;
//! use kxio::net::{Method, Url}; //! use kxio::net::StatusCode;
//!
//! # #[tokio::main] //! # #[tokio::main]
//! # async fn main() -> net::Result<()> { //! # async fn main() -> net::Result<()> {
//! # let mock_net = net::mock(); //! # let mock_net = net::mock();
//! mock_net.on(Method::GET) //! mock_net.on().get("https://example.com")
//! .url(Url::parse("https://example.com")?) //! .respond(StatusCode::OK).body("");
//! .respond(mock_net.response().status(200).body("")?); //! mock_net.on().get("https://example.com/foo")
//! mock_net.on(Method::GET) //! .respond(StatusCode::INTERNAL_SERVER_ERROR).body("Mocked response");
//! .url(Url::parse("https://example.com/foo")?)
//! .respond(mock_net.response().status(500).body("Mocked response")?);
//! # mock_net.reset(); //! # mock_net.reset();
//! # Ok(()) //! # Ok(())
//! # } //! # }
//! ``` //! ```
//! //!
//! All [MatchOn] options:
//! - [MatchOn::Method] (default)
//! - [MatchOn::Url] (default)
//! - [MatchOn::Headers]
//! - [MatchOn::Body].
//!
//! Once you have defined all your expected responses, convert the [MockNet] into a [Net]. //! Once you have defined all your expected responses, convert the [MockNet] into a [Net].
//! //!
//! ```rust //! ```rust
@ -155,14 +146,15 @@ mod system;
pub use result::{Error, Result}; pub use result::{Error, Result};
pub use system::{MatchOn, MockNet, Net}; pub use system::{MockNet, Net};
pub use http::Method; pub use http::HeaderMap;
pub use http::StatusCode;
pub use reqwest::Client; pub use reqwest::Client;
pub use reqwest::Error as RequestError;
pub use reqwest::Request; pub use reqwest::Request;
pub use reqwest::RequestBuilder; pub use reqwest::RequestBuilder;
pub use reqwest::Response; pub use reqwest::Response;
pub use url::Url;
/// Creates a new `Net`. /// Creates a new `Net`.
pub const fn new() -> Net { pub const fn new() -> Net {

View file

@ -3,6 +3,8 @@ use derive_more::derive::From;
use crate::net::Request; use crate::net::Request;
use super::system::MockError;
/// The Errors that may occur within [kxio::net][crate::net]. /// The Errors that may occur within [kxio::net][crate::net].
#[derive(Debug, From, derive_more::Display)] #[derive(Debug, From, derive_more::Display)]
pub enum Error { pub enum Error {
@ -32,6 +34,14 @@ pub enum Error {
/// Attempted to extract a [MockNet][super::MockNet] from a [Net][super::Net] that does not contain one. /// Attempted to extract a [MockNet][super::MockNet] from a [Net][super::Net] that does not contain one.
NetIsNotAMock, NetIsNotAMock,
InvalidMock(MockError),
/// The returned response is has an error status code (i.e. 4xx or 5xx)
#[display("response error: {}", response.status())]
ResponseError {
response: reqwest::Response,
},
} }
impl std::error::Error for Error {} impl std::error::Error for Error {}
impl Clone for Error { impl Clone for Error {

View file

@ -1,45 +1,41 @@
// //
use std::{cell::RefCell, ops::Deref, rc::Rc, sync::Arc}; use std::{
cell::RefCell,
collections::HashMap,
fmt::{Debug, Display},
marker::PhantomData,
ops::Deref,
rc::Rc,
sync::Arc,
};
use reqwest::{Body, Client}; use bytes::Bytes;
use derive_more::derive::{Display, From};
use http::StatusCode;
use reqwest::{Client, RequestBuilder};
use tokio::sync::Mutex; use tokio::sync::Mutex;
use url::Url;
use crate::net::{Method, Request, RequestBuilder, Response, Url}; use crate::net::{Request, Response};
use super::{Error, Result}; use super::{Error, Result};
/// A list of planned requests and responses /// A list of planned requests and responses
type Plans = Vec<Plan>; type Plans = Vec<Plan>;
/// The different ways to match a request.
#[derive(Debug, PartialEq, Eq)]
pub enum MatchOn {
/// The request must have a specific HTTP Request Method.
Method,
/// The request must have a specific URL.
Url,
/// The request must have a specify HTTP Body.
Body,
/// The request must have a specific set of HTTP Headers.
Headers,
}
/// A planned request and the response to return /// A planned request and the response to return
/// ///
/// Contains a list of the criteria that a request must meet before being considered a match. /// Contains a list of the criteria that a request must meet before being considered a match.
#[derive(Debug)] #[derive(Debug)]
struct Plan { struct Plan {
match_request: Vec<MatchRequest>, match_request: Vec<MatchRequest>,
response: Response, response: reqwest::Response,
} }
impl Plan { impl Plan {
fn matches(&self, request: &Request) -> bool { fn matches(&self, request: &Request) -> bool {
self.match_request.iter().all(|criteria| match criteria { self.match_request.iter().all(|criteria| match criteria {
MatchRequest::Method(method) => request.method() == method, MatchRequest::Method(method) => request.method() == http::Method::from(method),
MatchRequest::Url(uri) => request.url() == uri, MatchRequest::Url(uri) => request.url() == uri,
MatchRequest::Header { name, value } => { MatchRequest::Header { name, value } => {
request request
@ -53,11 +49,19 @@ impl Plan {
}) })
} }
MatchRequest::Body(body) => { MatchRequest::Body(body) => {
request.body().and_then(Body::as_bytes) == Some(body.as_bytes()) request.body().and_then(reqwest::Body::as_bytes) == Some(body)
} }
}) })
} }
} }
impl Display for Plan {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
for m in &self.match_request {
write!(f, " {m}")?;
}
writeln!(f, " => {:?}", self.response)
}
}
/// An abstraction for the network /// An abstraction for the network
#[derive(Debug, Clone, Default)] #[derive(Debug, Clone, Default)]
@ -81,6 +85,7 @@ impl Net {
/// let client = net.client(); /// let client = net.client();
/// let request = client.get("https://hyper.rs"); /// let request = client.get("https://hyper.rs");
/// ``` /// ```
#[must_use]
pub fn client(&self) -> Client { pub fn client(&self) -> Client {
Default::default() Default::default()
} }
@ -88,10 +93,16 @@ impl Net {
/// Constructs the Request and sends it to the target URL, returning a /// Constructs the Request and sends it to the target URL, returning a
/// future Response. /// future Response.
/// ///
/// However, if this request is from a [Net] that was created from a [MockNet],
/// then the request will be matched and any stored response returned, or an
/// error if no matched request was found.
///
/// # Errors /// # Errors
/// ///
/// This method fails if there was an error while sending request, /// This method fails if there was an error while sending request,
/// redirect loop was detected or redirect limit was exhausted. /// redirect loop was detected or redirect limit was exhausted.
/// If the response has a Status Code of `4xx` or `5xx` then the
/// response will be returned as an [Error::ResponseError].
/// ///
/// # Example /// # Example
/// ///
@ -109,6 +120,7 @@ impl Net {
return request.into().send().await.map_err(Error::from); return request.into().send().await.map_err(Error::from);
}; };
let request = request.into().build()?; let request = request.into().build()?;
eprintln!("? {} {} {:?}", request.method(), request.url(), request.headers());
let index = plans let index = plans
.lock() .lock()
.await .await
@ -118,12 +130,54 @@ impl Net {
.position(|plan| plan.matches(&request)); .position(|plan| plan.matches(&request));
match index { match index {
Some(i) => { Some(i) => {
let response = plans.lock().await.borrow_mut().remove(i).response; let plan = plans.lock().await.borrow_mut().remove(i);
eprintln!("- matched: {plan}");
let response = plan.response;
if response.status().is_success() {
Ok(response) Ok(response)
} else {
Err(crate::net::Error::ResponseError { response })
}
} }
None => Err(Error::UnexpectedMockRequest(request)), None => Err(Error::UnexpectedMockRequest(request)),
} }
} }
/// Starts building an http DELETE request for the URL.
#[must_use]
pub fn delete(&self, url: impl Into<String>) -> ReqBuilder {
ReqBuilder::new(self, NetMethod::Delete, url)
}
/// Starts building an http GET request for the URL.
#[must_use]
pub fn get(&self, url: impl Into<String>) -> ReqBuilder {
ReqBuilder::new(self, NetMethod::Get, url)
}
/// Starts building an http HEAD request for the URL.
#[must_use]
pub fn head(&self, url: impl Into<String>) -> ReqBuilder {
ReqBuilder::new(self, NetMethod::Head, url)
}
/// Starts building an http PATCH request for the URL.
#[must_use]
pub fn patch(&self, url: impl Into<String>) -> ReqBuilder {
ReqBuilder::new(self, NetMethod::Patch, url)
}
/// Starts building an http POST request for the URL.
#[must_use]
pub fn post(&self, url: impl Into<String>) -> ReqBuilder {
ReqBuilder::new(self, NetMethod::Post, url)
}
/// Starts building an http PUT request for the URL.
#[must_use]
pub fn put(&self, url: impl Into<String>) -> ReqBuilder {
ReqBuilder::new(self, NetMethod::Put, url)
}
} }
impl MockNet { impl MockNet {
pub async fn try_from(net: Net) -> std::result::Result<Self, super::Error> { pub async fn try_from(net: Net) -> std::result::Result<Self, super::Error> {
@ -136,6 +190,120 @@ impl MockNet {
} }
} }
#[derive(Debug, Clone, Display, PartialEq, Eq)]
pub enum NetMethod {
Delete,
Get,
Head,
Patch,
Post,
Put,
}
impl From<&NetMethod> for http::Method {
fn from(value: &NetMethod) -> Self {
match value {
NetMethod::Delete => http::Method::DELETE,
NetMethod::Get => http::Method::GET,
NetMethod::Head => http::Method::HEAD,
NetMethod::Patch => http::Method::PATCH,
NetMethod::Post => http::Method::POST,
NetMethod::Put => http::Method::PUT,
}
}
}
/// A builder for an http request.
pub struct ReqBuilder<'net> {
net: &'net Net,
url: String,
method: NetMethod,
headers: Vec<(String, String)>,
body: Option<Bytes>,
}
impl<'net> ReqBuilder<'net> {
#[must_use]
fn new(net: &'net Net, method: NetMethod, url: impl Into<String>) -> Self {
Self {
net,
url: url.into(),
method,
headers: vec![],
body: None,
}
}
/// Constructs the Request and sends it to the target URL, returning a
/// future Response.
///
/// However, if this request is from a [Net] that was created from a [MockNet],
/// then the request will be matched and any stored response returned, or an
/// error if no matched request was found.
///
/// # Errors
///
/// This method fails if there was an error while sending request,
/// redirect loop was detected or redirect limit was exhausted.
/// If the response has a Status Code of `4xx` or `5xx` then the
/// response will be returned as an [Error::ResponseError].
///
/// # Example
///
/// ```no_run
/// # use kxio::net::Result;
/// # async fn run() -> Result<()> {
/// let net = kxio::net::new();
/// let response = net.get("https://hyper.rs")
/// .header("foo", "bar")
/// .body("{}")
/// .send().await?;
/// # Ok(())
/// # }
/// ```
pub async fn send(self) -> Result<Response> {
let client = self.net.client();
// Method
let mut req = match self.method {
NetMethod::Delete => client.delete(self.url),
NetMethod::Get => client.get(self.url),
NetMethod::Head => client.head(self.url),
NetMethod::Patch => client.patch(self.url),
NetMethod::Post => client.post(self.url),
NetMethod::Put => client.put(self.url),
};
// Headers
for (name, value) in self.headers.into_iter() {
req = req.header(name, value);
}
// Body
if let Some(bytes) = self.body {
req = req.body(bytes);
}
self.net.send(req).await
}
/// Adds the header and value to the request.
#[must_use]
pub fn header(mut self, name: impl Into<String>, value: impl Into<String>) -> Self {
self.headers.push((name.into(), value.into()));
self
}
/// Adds the headers to the request.
#[must_use]
pub fn headers(mut self, headers: HashMap<String, String>) -> Self {
self.headers.extend(headers);
self
}
/// Sets the request body.
#[must_use]
pub fn body(mut self, bytes: impl Into<Bytes>) -> Self {
self.body = Some(bytes.into());
self
}
}
/// A struct for defining the expected requests and their responses that should be made /// A struct for defining the expected requests and their responses that should be made
/// during a test. /// during a test.
/// ///
@ -145,16 +313,15 @@ impl MockNet {
/// # Example /// # Example
/// ///
/// ```rust /// ```rust
/// use kxio::net::{Method, Url};
/// # use kxio::net::Result; /// # use kxio::net::Result;
/// use kxio::net::StatusCode;
/// # #[tokio::main] /// # #[tokio::main]
/// # async fn run() -> Result<()> { /// # async fn run() -> Result<()> {
/// let mock_net = kxio::net::mock(); /// let mock_net = kxio::net::mock();
/// let client = mock_net.client(); /// let client = mock_net.client();
/// // define an expected requet, and the response that should be returned /// // define an expected requet, and the response that should be returned
/// mock_net.on(Method::GET) /// mock_net.on().get("https://hyper.rs")
/// .url(Url::parse("https://hyper.rs")?) /// .respond(StatusCode::OK).body("Ok");
/// .respond(mock_net.response().status(200).body("Ok")?);
/// let net: kxio::net::Net = mock_net.into(); /// let net: kxio::net::Net = mock_net.into();
/// // use 'net' in your program, by passing it as a reference /// // use 'net' in your program, by passing it as a reference
/// ///
@ -188,30 +355,25 @@ impl MockNet {
/// # Example /// # Example
/// ///
/// ```rust /// ```rust
/// use kxio::net::{Method, Url}; /// use kxio::net::StatusCode;
/// # use kxio::net::Result; /// # use kxio::net::Result;
/// # fn run() -> Result<()> { /// # fn run() -> Result<()> {
/// let mock_net = kxio::net::mock(); /// let mock_net = kxio::net::mock();
/// let client = mock_net.client(); /// let client = mock_net.client();
/// mock_net.on(Method::GET) /// mock_net.on().get("https://hyper.rs")
/// .url(Url::parse("https://hyper.rs")?) /// .respond(StatusCode::OK).body("Ok");
/// .respond(mock_net.response().status(200).body("Ok")?);
/// # Ok(()) /// # Ok(())
/// # } /// # }
/// ``` /// ```
pub fn on(&self, method: impl Into<Method>) -> WhenRequest { #[must_use]
WhenRequest::new(self, method) pub fn on(&self) -> WhenRequest<WhenBuildRequest> {
WhenRequest::new(self)
} }
fn _when(&self, plan: Plan) { fn _when(&self, plan: Plan) {
self.plans.borrow_mut().push(plan); self.plans.borrow_mut().push(plan);
} }
/// Creates a [http::response::Builder] to be extended and returned by a mocked network request.
pub fn response(&self) -> http::response::Builder {
Default::default()
}
/// Clears all the expected requests and responses from the [MockNet]. /// Clears all the expected requests and responses from the [MockNet].
/// ///
/// When the [MockNet] goes out of scope it will assert that all expected requests and /// When the [MockNet] goes out of scope it will assert that all expected requests and
@ -252,30 +414,135 @@ impl Drop for MockNet {
impl Drop for Net { impl Drop for Net {
fn drop(&mut self) { fn drop(&mut self) {
if let Some(plans) = &self.plans { if let Some(plans) = &self.plans {
assert!(plans.try_lock().expect("lock plans").take().is_empty()) let unused = plans.try_lock().expect("lock plans").take();
if unused.is_empty() {
return; // all good
}
eprintln!("These requests were expected, but not made:");
for plan in unused {
eprintln!("-{plan}");
}
panic!("There were expected requests that were not made.");
} }
} }
} }
#[derive(Debug, Clone, PartialEq, Eq)] #[derive(Debug, Clone, PartialEq, Eq)]
pub enum MatchRequest { pub enum MatchRequest {
Method(Method), Method(NetMethod),
Url(Url), Url(Url),
Header { name: String, value: String }, Header { name: String, value: String },
Body(String), Body(bytes::Bytes),
} }
impl Display for MatchRequest {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::Method(method) => write!(f, "{method}"),
Self::Url(url) => write!(f, "{url}"),
Self::Header { name, value } => write!(f, "({name}: {value})"),
Self::Body(body) => write!(f, "Body: {body:?}"),
}
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum RespondWith {
Status(StatusCode),
Header { name: String, value: String },
Body(bytes::Bytes),
}
#[derive(Clone, Debug, Display, From)]
pub enum MockError {
#[display("url parse: {}", 0)]
UrlParse(#[from] url::ParseError),
}
impl std::error::Error for MockError {}
pub trait WhenState {}
pub struct WhenBuildRequest;
impl WhenState for WhenBuildRequest {}
pub struct WhenBuildResponse;
impl WhenState for WhenBuildResponse {}
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub struct WhenRequest<'net> { pub struct WhenRequest<'net, State>
where
State: WhenState,
{
_state: PhantomData<State>,
net: &'net MockNet, net: &'net MockNet,
match_on: Vec<MatchRequest>, match_on: Vec<MatchRequest>,
respond_with: Vec<RespondWith>,
error: Option<MockError>,
} }
impl<'net> WhenRequest<'net> { impl<'net> WhenRequest<'net, WhenBuildRequest> {
pub fn url(mut self, url: impl Into<Url>) -> Self { fn new(net: &'net MockNet) -> Self {
self.match_on.push(MatchRequest::Url(url.into())); Self {
_state: PhantomData,
net,
match_on: vec![],
respond_with: vec![],
error: None,
}
}
/// Starts mocking a GET http request.
#[must_use]
pub fn get(self, url: impl Into<String>) -> Self {
self._url(NetMethod::Get, url)
}
/// Starts mocking a POST http request.
#[must_use]
pub fn post(self, url: impl Into<String>) -> Self {
self._url(NetMethod::Post, url)
}
/// Starts mocking a PUT http request.
#[must_use]
pub fn put(self, url: impl Into<String>) -> Self {
self._url(NetMethod::Put, url)
}
/// Starts mocking a DELETE http request.
#[must_use]
pub fn delete(self, url: impl Into<String>) -> Self {
self._url(NetMethod::Delete, url)
}
/// Starts mocking a HEAD http request.
#[must_use]
pub fn head(self, url: impl Into<String>) -> Self {
self._url(NetMethod::Head, url)
}
/// Starts mocking a PATCH http request.
#[must_use]
pub fn patch(self, url: impl Into<String>) -> Self {
self._url(NetMethod::Patch, url)
}
fn _url(mut self, method: NetMethod, url: impl Into<String>) -> Self {
self.match_on.push(MatchRequest::Method(method));
match Url::parse(&url.into()) {
Ok(url) => {
self.match_on.push(MatchRequest::Url(url));
}
Err(err) => {
self.error.replace(err.into());
}
}
self self
} }
/// Specifies a header that the mock will match against.
///
/// Any request that does not have this header will not match the mock.
#[must_use]
pub fn header(mut self, name: impl Into<String>, value: impl Into<String>) -> Self { pub fn header(mut self, name: impl Into<String>, value: impl Into<String>) -> Self {
self.match_on.push(MatchRequest::Header { self.match_on.push(MatchRequest::Header {
name: name.into(), name: name.into(),
@ -283,25 +550,90 @@ impl<'net> WhenRequest<'net> {
}); });
self self
} }
pub fn body(mut self, body: impl Into<String>) -> Self {
/// Specifies headers that the mock will match against.
///
/// Any request that does not have this header will not match the mock.
#[must_use]
pub fn headers(mut self, headers: HashMap<String, String>) -> Self {
for (name, value) in headers {
self.match_on.push(MatchRequest::Header { name, value });
}
self
}
/// Specifies the body that the mock will match against.
///
/// Any request that does not have this body will not match the mock.
#[must_use]
pub fn body(mut self, body: impl Into<bytes::Bytes>) -> Self {
self.match_on.push(MatchRequest::Body(body.into())); self.match_on.push(MatchRequest::Body(body.into()));
self self
} }
pub fn respond<T>(self, response: http::Response<T>)
where /// Specifies the http Status Code that will be returned for the matching request.
T: Into<reqwest::Body>, #[must_use]
{ pub fn respond(self, status: StatusCode) -> WhenRequest<'net, WhenBuildResponse> {
WhenRequest::<WhenBuildResponse> {
_state: PhantomData,
net: self.net,
match_on: self.match_on,
respond_with: vec![RespondWith::Status(status)],
error: self.error,
}
}
}
impl<'net> WhenRequest<'net, WhenBuildResponse> {
/// Specifies a header that will be on the response sent for the matching request.
#[must_use]
pub fn header(mut self, name: impl Into<String>, value: impl Into<String>) -> Self {
let name = name.into();
let value = value.into();
self.respond_with.push(RespondWith::Header { name, value });
self
}
/// Specifies headers that will be on the response sent for the matching request.
#[must_use]
pub fn headers(mut self, headers: impl Into<HashMap<String, String>>) -> Self {
let h: HashMap<String, String> = headers.into();
for (name, value) in h.into_iter() {
self.respond_with.push(RespondWith::Header { name, value });
}
self
}
/// Specifies the body of the response sent for the matching request.
pub fn body(mut self, body: impl Into<bytes::Bytes>) -> Result<()> {
self.respond_with.push(RespondWith::Body(body.into()));
self.mock()
}
/// Marks a response that has no body as complete.
pub fn mock(self) -> Result<()> {
if let Some(error) = self.error {
return Err(crate::net::Error::InvalidMock(error));
}
let mut builder = http::response::Builder::default();
let mut response_body = None;
for part in self.respond_with {
builder = match part {
RespondWith::Status(status) => builder.status(status),
RespondWith::Header { name, value } => builder.header(name, value),
RespondWith::Body(body) => {
response_body.replace(body);
builder
}
}
}
let body = response_body.unwrap_or_default();
let response = builder.body(body)?;
self.net._when(Plan { self.net._when(Plan {
match_request: self.match_on, match_request: self.match_on,
response: response.into(), response: response.into(),
}); });
} Ok(())
fn new(net: &'net MockNet, method: impl Into<Method>) -> Self {
Self {
net,
match_on: vec![MatchRequest::Method(method.into())],
}
} }
} }

View file

@ -9,6 +9,13 @@ mod path {
use super::*; use super::*;
#[test]
fn temp_as_real() {
let fs = fs::temp().expect("temp fs");
let read = fs.as_real();
assert_eq!(read.base(), fs.base());
}
mod is_link { mod is_link {
use super::*; use super::*;

View file

@ -1,5 +1,8 @@
use std::collections::HashMap;
use http::StatusCode;
// //
use kxio::net::{Error, Method, MockNet, Net, Url}; use kxio::net::{Error, MockNet, Net};
use assert2::let_assert; use assert2::let_assert;
@ -7,25 +10,20 @@ use assert2::let_assert;
async fn test_get_url() { async fn test_get_url() {
//given //given
let mock_net = kxio::net::mock(); let mock_net = kxio::net::mock();
let client = mock_net.client();
let url = "https://www.example.com"; let url = "https://www.example.com";
let my_response = mock_net
.response()
.status(200)
.body("Get OK")
.expect("body");
mock_net mock_net
.on(Method::GET) .on()
.url(Url::parse(url).expect("parse url")) .get(url)
.respond(my_response); .respond(StatusCode::OK)
.header("foo", "bar")
.headers(HashMap::new())
.body("Get OK")
.expect("mock");
//when //when
let response = Net::from(mock_net) let response = Net::from(mock_net).get(url).send().await.expect("response");
.send(client.get(url))
.await
.expect("response");
//then //then
assert_eq!(response.status(), http::StatusCode::OK); assert_eq!(response.status(), http::StatusCode::OK);
@ -33,24 +31,142 @@ async fn test_get_url() {
} }
#[tokio::test] #[tokio::test]
async fn test_get_wrong_url() { async fn test_post_url() {
//given //given
let mock_net = kxio::net::mock(); let net = kxio::net::mock();
let client = mock_net.client(); let client = net.client();
let url = "https://www.example.com"; let url = "https://www.example.com";
let my_response = mock_net
.response() net.on()
.status(200) .post(url)
.respond(StatusCode::OK)
.body("post OK")
.expect("mock");
//when
let response = Net::from(net)
.send(client.post(url))
.await
.expect("reponse");
//then
assert_eq!(response.status(), http::StatusCode::OK);
assert_eq!(response.bytes().await.expect("response body"), "post OK");
}
#[tokio::test]
async fn test_put_url() {
//given
let net = kxio::net::mock();
let client = net.client();
let url = "https://www.example.com";
net.on()
.put(url)
.respond(StatusCode::OK)
.body("put OK")
.expect("mock");
//when
let response = Net::from(net).send(client.put(url)).await.expect("reponse");
//then
assert_eq!(response.status(), http::StatusCode::OK);
assert_eq!(response.bytes().await.expect("response body"), "put OK");
}
#[tokio::test]
async fn test_delete_url() {
//given
let net = kxio::net::mock();
let client = net.client();
let url = "https://www.example.com";
net.on()
.delete(url)
.respond(StatusCode::OK)
.body("delete OK")
.expect("mock");
//when
let response = Net::from(net)
.send(client.delete(url))
.await
.expect("reponse");
//then
assert_eq!(response.status(), http::StatusCode::OK);
assert_eq!(response.bytes().await.expect("response body"), "delete OK");
}
#[tokio::test]
async fn test_head_url() {
//given
let net = kxio::net::mock();
let client = net.client();
let url = "https://www.example.com";
net.on()
.head(url)
.respond(StatusCode::OK)
.body("head OK")
.expect("mock");
//when
let response = Net::from(net)
.send(client.head(url))
.await
.expect("reponse");
//then
assert_eq!(response.status(), http::StatusCode::OK);
assert_eq!(response.bytes().await.expect("response body"), "head OK");
}
#[tokio::test]
async fn test_patch_url() {
//given
let net = kxio::net::mock();
let client = net.client();
let url = "https://www.example.com";
net.on()
.patch(url)
.respond(StatusCode::OK)
.body("patch OK")
.expect("mock");
//when
let response = Net::from(net)
.send(client.patch(url))
.await
.expect("reponse");
//then
assert_eq!(response.status(), http::StatusCode::OK);
assert_eq!(response.bytes().await.expect("response body"), "patch OK");
}
#[tokio::test]
async fn test_get_wrong_url() {
//given
let net = kxio::net::mock();
let client = net.client();
let url = "https://www.example.com";
net.on()
.get(url)
.respond(StatusCode::OK)
.body("Get OK") .body("Get OK")
.expect("body"); .expect("mock");
mock_net let net = Net::from(net);
.on(Method::GET)
.url(Url::parse(url).expect("parse url"))
.respond(my_response);
let net = Net::from(mock_net);
//when //when
let_assert!( let_assert!(
@ -66,41 +182,14 @@ async fn test_get_wrong_url() {
mock_net.reset(); mock_net.reset();
} }
#[tokio::test]
async fn test_post_url() {
//given
let net = kxio::net::mock();
let client = net.client();
let url = "https://www.example.com";
let my_response = net.response().status(200).body("Post OK").expect("body");
net.on(Method::POST)
.url(Url::parse(url).expect("parse url"))
.respond(my_response);
//when
let response = Net::from(net)
.send(client.post(url))
.await
.expect("reponse");
//then
assert_eq!(response.status(), http::StatusCode::OK);
assert_eq!(response.bytes().await.expect("response body"), "Post OK");
}
#[tokio::test] #[tokio::test]
async fn test_post_by_method() { async fn test_post_by_method() {
//given //given
let net = kxio::net::mock(); let net = kxio::net::mock();
let client = net.client(); let client = net.client();
let my_response = net.response().status(200).body("").expect("response body"); // NOTE: No URL specified - so should match any URL
net.on().respond(StatusCode::OK).body("").expect("mock");
net.on(Method::POST)
// NOTE: No URL specified - so shou∂ match any URL
.respond(my_response);
//when //when
let response = Net::from(net) let response = Net::from(net)
@ -119,16 +208,12 @@ async fn test_post_by_body() {
let net = kxio::net::mock(); let net = kxio::net::mock();
let client = net.client(); let client = net.client();
let my_response = net
.response()
.status(200)
.body("response body")
.expect("body");
net.on(Method::POST)
// No URL - so any POST with a matching body // No URL - so any POST with a matching body
net.on()
.body("match on body") .body("match on body")
.respond(my_response); .respond(StatusCode::OK)
.body("response body")
.expect("mock");
//when //when
let response = Net::from(net) let response = Net::from(net)
@ -150,15 +235,11 @@ async fn test_post_by_header() {
let net = kxio::net::mock(); let net = kxio::net::mock();
let client = net.client(); let client = net.client();
let my_response = net net.on()
.response()
.status(200)
.body("response body")
.expect("body");
net.on(Method::POST)
.header("test", "match") .header("test", "match")
.respond(my_response); .respond(StatusCode::OK)
.body("response body")
.expect("mock");
//when //when
let response = Net::from(net) let response = Net::from(net)
@ -185,16 +266,12 @@ async fn test_post_by_header_wrong_value() {
let mock_net = kxio::net::mock(); let mock_net = kxio::net::mock();
let client = mock_net.client(); let client = mock_net.client();
let my_response = mock_net
.response()
.status(200)
.body("response body")
.expect("body");
mock_net mock_net
.on(Method::POST) .on()
.header("test", "match") .header("test", "match")
.respond(my_response); .respond(StatusCode::OK)
.body("response body")
.expect("mock");
let net = Net::from(mock_net); let net = Net::from(mock_net);
//when //when
@ -220,16 +297,13 @@ async fn test_unused_post_as_net() {
let mock_net = kxio::net::mock(); let mock_net = kxio::net::mock();
let url = "https://www.example.com"; let url = "https://www.example.com";
let my_response = mock_net
.response()
.status(200)
.body("Post OK")
.expect("body");
mock_net mock_net
.on(Method::POST) .on()
.url(Url::parse(url).expect("prase url")) .post(url)
.respond(my_response); .respond(StatusCode::OK)
.body("Post OK")
.expect("mock");
let _net = Net::from(mock_net); let _net = Net::from(mock_net);
@ -248,16 +322,13 @@ async fn test_unused_post_as_mocknet() {
let mock_net = kxio::net::mock(); let mock_net = kxio::net::mock();
let url = "https://www.example.com"; let url = "https://www.example.com";
let my_response = mock_net
.response()
.status(200)
.body("Post OK")
.expect("body");
mock_net mock_net
.on(Method::POST) .on()
.url(Url::parse(url).expect("parse url")) .post(url)
.respond(my_response); .respond(StatusCode::OK)
.body("Post OK")
.expect("mock");
//when //when
// don't send the planned request // don't send the planned request