Merge pull request #1226 from michaeltlombardi/gh-538/main/get_keyword_as_subschema

(GH-538) Enable retrieving keywords as `Schema` objects

Author: SteveL-MSFT

lib/dsc-lib-jsonschema/src/schema_utility_extensions.rs

@@ -13,5 +13,4 @@
 //! of the modules from the rest of the source tree.
 
 #[cfg(test)] mod schema_utility_extensions;
-#[cfg(test)] mod transforms;
 #[cfg(test)] mod vscode;

lib/dsc-lib-jsonschema/src/tests/mod.rs

@@ -26,6 +26,9 @@ static OBJECT_VALUE: LazyLock<Map<String, Value>> = LazyLock::new(|| json!({
 }).as_object().unwrap().clone());
 static NULL_VALUE:    ()   = ();
 static STRING_VALUE: &str  = "value";
+static SUBSCHEMA_VALUE: LazyLock<Schema> = LazyLock::new(|| json_schema!({
+    "$id": "https://schema.contoso.com/test/get_keyword_as/subschema.json"
+}));
 static TEST_SCHEMA: LazyLock<Schema> = LazyLock::new(|| json_schema!({
     "$id": "https://schema.contoso.com/test/get_keyword_as.json",
     "array": *ARRAY_VALUE,
@@ -35,6 +38,7 @@ static TEST_SCHEMA: LazyLock<Schema> = LazyLock::new(|| json_schema!({
     "object": *OBJECT_VALUE,
     "null": null,
     "string": *STRING_VALUE,
+    "subschema": *SUBSCHEMA_VALUE,
 }));
 
 /// Defines test cases for a given `get_keyword_as` function (non-mutable).
@@ -135,12 +139,14 @@ test_cases_for_get_keyword_as!(
     get_keyword_as_number: "array", "integer", Some(&(INTEGER_VALUE.into())),
     get_keyword_as_str: "array", "string", Some(STRING_VALUE),
     get_keyword_as_string: "array", "string", Some(STRING_VALUE.to_string()),
+    get_keyword_as_subschema: "array", "subschema", Some(&*SUBSCHEMA_VALUE),
 );
 
 
 test_cases_for_get_keyword_as_mut!(
     get_keyword_as_array_mut: "boolean", "array", Some(&mut (*ARRAY_VALUE).clone()),
     get_keyword_as_object_mut: "array", "object", Some(&mut (*OBJECT_VALUE).clone()),
+    get_keyword_as_subschema_mut: "array", "subschema", Some(&mut (*SUBSCHEMA_VALUE).clone()),
 );
 
 #[cfg(test)] mod get_id {
@@ -335,7 +341,6 @@ test_cases_for_get_keyword_as_mut!(
 
     use pretty_assertions::assert_eq;
     use schemars::json_schema;
-    use serde_json::json;
 
     use crate::schema_utility_extensions::SchemaUtilityExtensions;
 
@@ -382,13 +387,13 @@ test_cases_for_get_keyword_as_mut!(
                 }
             }
         });
-        let ref expected = json!({
+        let ref expected = json_schema!({
             "$id": "https://contoso.com/schemas/foo.json",
             "title": "Foo"
         });
         assert_eq!(
             schema.get_defs_subschema_from_id("https://contoso.com/schemas/foo.json"),
-            expected.as_object()
+            Some(expected)
         );
     }
 }
@@ -397,7 +402,6 @@ test_cases_for_get_keyword_as_mut!(
 
     use pretty_assertions::assert_eq;
     use schemars::json_schema;
-    use serde_json::json;
 
     use crate::schema_utility_extensions::SchemaUtilityExtensions;
 
@@ -444,20 +448,19 @@ test_cases_for_get_keyword_as_mut!(
                 }
             }
         });
-        let ref mut expected = json!({
+        let ref mut expected = json_schema!({
             "$id": "https://contoso.com/schemas/foo.json",
             "title": "Foo"
         });
         assert_eq!(
             schema.get_defs_subschema_from_id_mut("https://contoso.com/schemas/foo.json"),
-            expected.as_object_mut()
+            Some(expected)
         );
     }
 }
 #[cfg(test)] mod get_defs_subschema_from_reference {
     use pretty_assertions::assert_eq;
     use schemars::json_schema;
-    use serde_json::json;
 
     use crate::schema_utility_extensions::SchemaUtilityExtensions;
 
@@ -518,13 +521,13 @@ test_cases_for_get_keyword_as_mut!(
                 }
             }
         });
-        let expected = json!({
+        let ref expected = json_schema!({
             "$id": "https://contoso.com/schemas/foo.json",
             "title": "Foo"
         });
         assert_eq!(
             schema.get_defs_subschema_from_reference("#/$defs/foo").unwrap(),
-            expected.as_object().unwrap()
+            expected
         );
     }
     #[test] fn with_absolute_id_uri_reference() {
@@ -539,13 +542,13 @@ test_cases_for_get_keyword_as_mut!(
                 }
             }
         });
-        let expected = json!({
+        let ref expected = json_schema!({
             "$id": "https://contoso.com/schemas/foo.json",
             "title": "Foo"
         });
         assert_eq!(
             schema.get_defs_subschema_from_reference("/schemas/foo.json").unwrap(),
-            expected.as_object().unwrap()
+            expected
         );
     }
     #[test] fn with_relative_id_uri_reference() {
@@ -560,20 +563,19 @@ test_cases_for_get_keyword_as_mut!(
                 }
             }
         });
-        let expected = json!({
+        let ref expected = json_schema!({
             "$id": "https://contoso.com/schemas/foo.json",
             "title": "Foo"
         });
         assert_eq!(
             schema.get_defs_subschema_from_reference("https://contoso.com/schemas/foo.json").unwrap(),
-            expected.as_object().unwrap()
+            expected
         );
     }
 }
 
 #[cfg(test)] mod get_defs_subschema_from_reference_mut {
     use schemars::json_schema;
-    use serde_json::json;
 
     use crate::schema_utility_extensions::SchemaUtilityExtensions;
 
@@ -634,14 +636,14 @@ test_cases_for_get_keyword_as_mut!(
                 }
             }
         });
-        let ref mut expected = json!({
+        let ref mut expected = json_schema!({
             "$id": "https://contoso.com/schemas/foo.json",
             "title": "Foo"
         });
 
         assert_eq!(
             schema.get_defs_subschema_from_reference_mut("#/$defs/foo"),
-            expected.as_object_mut()
+            Some(expected)
         );
     }
     #[test] fn with_absolute_id_uri_reference() {
@@ -656,13 +658,13 @@ test_cases_for_get_keyword_as_mut!(
                 }
             }
         });
-        let ref mut expected = json!({
+        let ref mut expected = json_schema!({
             "$id": "https://contoso.com/schemas/foo.json",
             "title": "Foo"
         });
         assert_eq!(
             schema.get_defs_subschema_from_reference_mut("/schemas/foo.json").unwrap(),
-            expected.as_object_mut().unwrap()
+            expected
         );
     }
     #[test] fn with_relative_id_uri_reference() {
@@ -677,13 +679,13 @@ test_cases_for_get_keyword_as_mut!(
                 }
             }
         });
-        let ref mut expected = json!({
+        let ref mut expected = json_schema!({
             "$id": "https://contoso.com/schemas/foo.json",
             "title": "Foo"
         });
         assert_eq!(
             schema.get_defs_subschema_from_reference_mut("https://contoso.com/schemas/foo.json").unwrap(),
-            expected.as_object_mut().unwrap()
+            expected
         );
     }
 }
@@ -883,7 +885,6 @@ test_cases_for_get_keyword_as_mut!(
 
     use pretty_assertions::assert_eq;
     use schemars::json_schema;
-    use serde_json::json;
 
     use crate::schema_utility_extensions::SchemaUtilityExtensions;
 
@@ -916,7 +917,7 @@ test_cases_for_get_keyword_as_mut!(
         assert_eq!(schema.get_property_subschema("foo"), None)
     }
     #[test] fn when_given_property_is_object() {
-        let ref property = json!({
+        let ref property = json_schema!({
             "title": "Foo property"
         });
         let ref schema = json_schema!({
@@ -926,7 +927,7 @@ test_cases_for_get_keyword_as_mut!(
         });
         assert_eq!(
             schema.get_property_subschema("foo").unwrap(),
-            property.as_object().unwrap()
+            property
         )
     }
 }
@@ -936,7 +937,6 @@ test_cases_for_get_keyword_as_mut!(
 
     use pretty_assertions::assert_eq;
     use schemars::json_schema;
-    use serde_json::json;
 
     use crate::schema_utility_extensions::SchemaUtilityExtensions;
 
@@ -969,7 +969,7 @@ test_cases_for_get_keyword_as_mut!(
         assert_eq!(schema.get_property_subschema_mut("foo"), None)
     }
     #[test] fn when_given_property_is_object() {
-        let ref mut property = json!({
+        let ref mut property = json_schema!({
             "title": "Foo property"
         });
         let ref mut schema = json_schema!({
@@ -979,7 +979,7 @@ test_cases_for_get_keyword_as_mut!(
         });
         assert_eq!(
             schema.get_property_subschema_mut("foo").unwrap(),
-            property.as_object_mut().unwrap()
+            property
         )
     }
 }