From 09efa6aeb22776a2d447ea499818aec7dbdba842 Mon Sep 17 00:00:00 2001 From: Douman Date: Thu, 12 Jul 2018 19:32:54 +0300 Subject: [PATCH] Add test to verify enum in query Docs are updated to show example of how to use enum. Closes #371 --- Cargo.toml | 244 ++++++++++++++++++++--------------------- src/extractor.rs | 21 +++- tests/test_handlers.rs | 42 +++++++ 3 files changed, 179 insertions(+), 128 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index d60dfedcf..422bf105c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,122 +1,122 @@ -[package] -name = "actix-web" -version = "0.7.0" -authors = ["Nikolay Kim "] -description = "Actix web is a simple, pragmatic and extremely fast web framework for Rust." -readme = "README.md" -keywords = ["http", "web", "framework", "async", "futures"] -homepage = "https://actix.rs" -repository = "https://github.com/actix/actix-web.git" -documentation = "https://docs.rs/actix-web/" -categories = ["network-programming", "asynchronous", - "web-programming::http-server", - "web-programming::http-client", - "web-programming::websocket"] -license = "MIT/Apache-2.0" -exclude = [".gitignore", ".travis.yml", ".cargo/config", "appveyor.yml"] -build = "build.rs" - -[package.metadata.docs.rs] -features = ["tls", "alpn", "session", "brotli", "flate2-c"] - -[badges] -travis-ci = { repository = "actix/actix-web", branch = "master" } -appveyor = { repository = "fafhrd91/actix-web-hdy9d" } -codecov = { repository = "actix/actix-web", branch = "master", service = "github" } - -[lib] -name = "actix_web" -path = "src/lib.rs" - -[features] -default = ["session", "brotli", "flate2-c"] - -# tls -tls = ["native-tls", "tokio-tls"] - -# openssl -alpn = ["openssl", "tokio-openssl"] - -# sessions feature, session require "ring" crate and c compiler -session = ["cookie/secure"] - -# brotli encoding, requires c compiler -brotli = ["brotli2"] - -# miniz-sys backend for flate2 crate -flate2-c = ["flate2/miniz-sys"] - -# rust backend for flate2 crate -flate2-rust = ["flate2/rust_backend"] - -[dependencies] -actix = "0.7.0" - -base64 = "0.9" -bitflags = "1.0" -failure = "0.1.1" -h2 = "0.1" -htmlescape = "0.3" -http = "^0.1.5" -httparse = "1.3" -log = "0.4" -mime = "0.3" -mime_guess = "2.0.0-alpha" -num_cpus = "1.0" -percent-encoding = "1.0" -rand = "0.5" -regex = "1.0" -serde = "1.0" -serde_json = "1.0" -serde_urlencoded = { path = "./serde_urlencoded/" } -sha1 = "0.6" -smallvec = "0.6" -time = "0.1" -encoding = "0.2" -language-tags = "0.2" -lazy_static = "1.0" -lazycell = "1.0.0" -parking_lot = "0.6" -url = { version="1.7", features=["query_encoding"] } -cookie = { version="0.10", features=["percent-encode"] } -brotli2 = { version="^0.3.2", optional = true } -flate2 = { version="1.0", optional = true, default-features = false } - -# io -mio = "^0.6.13" -net2 = "0.2" -bytes = "0.4" -byteorder = "1.2" -futures = "0.1" -futures-cpupool = "0.1" -slab = "0.4" -tokio = "0.1" -tokio-io = "0.1" -tokio-tcp = "0.1" -tokio-timer = "0.2" -tokio-reactor = "0.1" - -# native-tls -native-tls = { version="0.1", optional = true } -tokio-tls = { version="0.1", optional = true } - -# openssl -openssl = { version="0.10", optional = true } -tokio-openssl = { version="0.2", optional = true } - -[dev-dependencies] -env_logger = "0.5" -serde_derive = "1.0" - -[build-dependencies] -version_check = "0.1" - -[profile.release] -lto = true -opt-level = 3 -codegen-units = 1 - -[workspace] -members = [ - "./", -] +[package] +name = "actix-web" +version = "0.7.0" +authors = ["Nikolay Kim "] +description = "Actix web is a simple, pragmatic and extremely fast web framework for Rust." +readme = "README.md" +keywords = ["http", "web", "framework", "async", "futures"] +homepage = "https://actix.rs" +repository = "https://github.com/actix/actix-web.git" +documentation = "https://docs.rs/actix-web/" +categories = ["network-programming", "asynchronous", + "web-programming::http-server", + "web-programming::http-client", + "web-programming::websocket"] +license = "MIT/Apache-2.0" +exclude = [".gitignore", ".travis.yml", ".cargo/config", "appveyor.yml"] +build = "build.rs" + +[package.metadata.docs.rs] +features = ["tls", "alpn", "session", "brotli", "flate2-c"] + +[badges] +travis-ci = { repository = "actix/actix-web", branch = "master" } +appveyor = { repository = "fafhrd91/actix-web-hdy9d" } +codecov = { repository = "actix/actix-web", branch = "master", service = "github" } + +[lib] +name = "actix_web" +path = "src/lib.rs" + +[features] +default = ["session", "brotli", "flate2-c"] + +# tls +tls = ["native-tls", "tokio-tls"] + +# openssl +alpn = ["openssl", "tokio-openssl"] + +# sessions feature, session require "ring" crate and c compiler +session = ["cookie/secure"] + +# brotli encoding, requires c compiler +brotli = ["brotli2"] + +# miniz-sys backend for flate2 crate +flate2-c = ["flate2/miniz-sys"] + +# rust backend for flate2 crate +flate2-rust = ["flate2/rust_backend"] + +[dependencies] +actix = "0.7.0" + +base64 = "0.9" +bitflags = "1.0" +failure = "0.1.1" +h2 = "0.1" +htmlescape = "0.3" +http = "^0.1.5" +httparse = "1.3" +log = "0.4" +mime = "0.3" +mime_guess = "2.0.0-alpha" +num_cpus = "1.0" +percent-encoding = "1.0" +rand = "0.5" +regex = "1.0" +serde = "1.0" +serde_json = "1.0" +serde_urlencoded = { path = "./serde_urlencoded/" } +sha1 = "0.6" +smallvec = "0.6" +time = "0.1" +encoding = "0.2" +language-tags = "0.2" +lazy_static = "1.0" +lazycell = "1.0.0" +parking_lot = "0.6" +url = { version="1.7", features=["query_encoding"] } +cookie = { version="0.10", features=["percent-encode"] } +brotli2 = { version="^0.3.2", optional = true } +flate2 = { version="1.0", optional = true, default-features = false } + +# io +mio = "^0.6.13" +net2 = "0.2" +bytes = "0.4" +byteorder = "1.2" +futures = "0.1" +futures-cpupool = "0.1" +slab = "0.4" +tokio = "0.1" +tokio-io = "0.1" +tokio-tcp = "0.1" +tokio-timer = "0.2" +tokio-reactor = "0.1" + +# native-tls +native-tls = { version="0.1", optional = true } +tokio-tls = { version="0.1", optional = true } + +# openssl +openssl = { version="0.10", optional = true } +tokio-openssl = { version="0.2", optional = true } + +[dev-dependencies] +env_logger = "0.5" +serde_derive = "1.0" + +[build-dependencies] +version_check = "0.1" + +[profile.release] +lto = true +opt-level = 3 +codegen-units = 1 + +[workspace] +members = [ + "./", +] diff --git a/src/extractor.rs b/src/extractor.rs index 8e0a96594..a6f62bb9f 100644 --- a/src/extractor.rs +++ b/src/extractor.rs @@ -139,15 +139,24 @@ impl fmt::Display for Path { /// #[macro_use] extern crate serde_derive; /// use actix_web::{App, Query, http}; /// -/// #[derive(Deserialize)] -/// struct Info { -/// username: String, -/// } +/// +///#[derive(Debug, Deserialize)] +///pub enum ResponseType { +/// Token, +/// Code +///} +/// +///#[derive(Deserialize)] +///pub struct AuthRequest { +/// id: u64, +/// response_type: ResponseType, +///} /// /// // use `with` extractor for query info /// // this handler get called only if request's query contains `username` field -/// fn index(info: Query) -> String { -/// format!("Welcome {}!", info.username) +/// // The correct request for this handler would be `/index.html?id=64&response_type=Code"` +/// fn index(info: Query) -> String { +/// format!("Authorization request for client with id={} and type={:?}!", info.id, info.response_type) /// } /// /// fn main() { diff --git a/tests/test_handlers.rs b/tests/test_handlers.rs index 95bd5be2e..bc65b93f8 100644 --- a/tests/test_handlers.rs +++ b/tests/test_handlers.rs @@ -91,6 +91,48 @@ fn test_query_extractor() { assert_eq!(response.status(), StatusCode::BAD_REQUEST); } +#[derive(Deserialize, Debug)] +pub enum ResponseType { + Token, + Code +} + +#[derive(Debug, Deserialize)] +pub struct AuthRequest { + id: u64, + response_type: ResponseType, +} + +#[test] +fn test_query_enum_extractor() { + let mut srv = test::TestServer::new(|app| { + app.resource("/index.html", |r| { + r.with(|p: Query| format!("{:?}", p.into_inner())) + }); + }); + + // client request + let request = srv + .get() + .uri(srv.url("/index.html?id=64&response_type=Code")) + .finish() + .unwrap(); + let response = srv.execute(request.send()).unwrap(); + assert!(response.status().is_success()); + + // read response + let bytes = srv.execute(response.body()).unwrap(); + assert_eq!(bytes, Bytes::from_static(b"AuthRequest { id: 64, response_type: Code }")); + + let request = srv.get().uri(srv.url("/index.html?id=64&response_type=Co")).finish().unwrap(); + let response = srv.execute(request.send()).unwrap(); + assert_eq!(response.status(), StatusCode::BAD_REQUEST); + + let request = srv.get().uri(srv.url("/index.html?response_type=Code")).finish().unwrap(); + let response = srv.execute(request.send()).unwrap(); + assert_eq!(response.status(), StatusCode::BAD_REQUEST); +} + #[test] fn test_async_extractor_async() { let mut srv = test::TestServer::new(|app| {