add tests for examples (pre rocket 0.6)

Author: aeltorio

examples/custom_schema/Cargo.toml

@@ -10,6 +10,6 @@ rocket_okapi = { path = "../../rocket-okapi", features = [
     "swagger",
     "rapidoc",
 ] }
-serde = { workspace = true }
+serde = { workspace = true, features = ["derive"] }
 serde_json = { workspace = true }
 schemars = "1.1.0"

examples/custom_schema/src/main.rs

@@ -131,3 +131,23 @@ fn custom_openapi_spec() -> OpenApi {
         ..Default::default()
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use rocket_okapi::openapi_get_spec;
+
+    #[test]
+    fn custom_spec_contains_home_path() {
+        let spec = custom_openapi_spec();
+        assert!(spec.info.title.contains("The best API ever"));
+        assert!(spec.paths.keys().any(|k| k.contains("/home")));
+    }
+
+    #[test]
+    fn post_routes_spec_contains_post_path() {
+        let settings = rocket_okapi::settings::OpenApiSettings::default();
+        let spec = rocket_okapi::openapi_get_spec![settings: post::create_post, post::get_post];
+        assert!(spec.paths.keys().any(|k| k.contains("/")));
+    }
+}

examples/dyn_templates/Cargo.toml

@@ -12,6 +12,6 @@ rocket_okapi = { path = "../../rocket-okapi", features = [
     "rapidoc",
     "rocket_dyn_templates",
 ] }
-serde = { workspace = true }
+serde = { workspace = true, features = ["derive"] }
 rocket_dyn_templates = { workspace = true, features = ["handlebars"] }
 handlebars = "5.0.0"

examples/dyn_templates/src/main.rs

@@ -46,3 +46,15 @@ async fn main() {
         Err(err) => println!("Rocket had an error: {err}"),
     };
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use rocket_okapi::openapi_get_spec;
+
+    #[test]
+    fn spec_contains_page_route() {
+        let spec = openapi_get_spec![get_page];
+        assert!(spec.paths.keys().any(|k| k.contains("/page")));
+    }
+}

examples/json-web-api/Cargo.toml

@@ -10,5 +10,5 @@ rocket_okapi = { path = "../../rocket-okapi", features = [
     "swagger",
     "rapidoc",
 ] }
-serde = { workspace = true }
+serde = { workspace = true, features = ["derive"] }
 schemars = "1.1.0"

examples/json-web-api/src/main.rs

@@ -135,3 +135,24 @@ async fn main() {
         Err(err) => println!("Rocket had an error: {err}"),
     };
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use rocket_okapi::openapi_get_spec;
+
+    #[test]
+    fn generated_spec_contains_user_routes() {
+        let spec = openapi_get_spec![
+            get_all_users,
+            get_user,
+            get_user_by_name,
+            create_user,
+            create_post_by_query
+        ];
+        assert!(spec.paths.keys().any(|k| k.contains("/user")));
+        assert!(spec.paths.keys().any(|k| k.contains("post_by_query")));
+        // The `hidden` endpoint is marked skip
+        assert!(!spec.paths.keys().any(|k| k.contains("/hidden")));
+    }
+}

examples/nested/Cargo.toml

@@ -10,6 +10,6 @@ edition = "2021"
 [dependencies]
 rocket = { workspace = true }
 rocket_okapi = { path = "../../rocket-okapi", features = ["rapidoc"] }
-serde = { workspace = true }
+serde = { workspace = true, features = ["derive"] }
 serde_json = { workspace = true }
 schemars = "1.1.0"

examples/nested/src/main.rs

@@ -121,3 +121,17 @@ fn custom_openapi_spec() -> OpenApi {
         ..Default::default()
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use rocket_okapi::openapi_get_spec;
+    use rocket_okapi::settings::OpenApiSettings;
+
+    #[test]
+    fn nested_api_spec_contains_paths() {
+        let settings = OpenApiSettings::default();
+        let (_routes, spec) = api::get_routes_and_docs(&settings);
+        assert!(spec.paths.keys().any(|k| k.contains("/")));
+    }
+}

examples/raw_identifiers/Cargo.toml

@@ -8,4 +8,5 @@ edition = "2021"
 
 [dependencies]
 rocket = { workspace = true }
+serde = { workspace = true, features = ["derive"] }
 rocket_okapi = { path = "../../rocket-okapi", features = ["rapidoc", "swagger"] }

examples/raw_identifiers/src/main.rs

@@ -37,3 +37,15 @@ fn rocket() -> _ {
             }),
         )
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use rocket_okapi::openapi_get_spec;
+
+    #[test]
+    fn raw_identifier_route_present() {
+        let spec = openapi_get_spec![hello];
+        assert!(spec.paths.keys().any(|k| k.contains("/hello")));
+    }
+}