Add feature and rename structs

Author: dekomissMSFT

Cargo.toml

@@ -23,6 +23,7 @@ default = ["full-opa", "arc"]
 
 arc = ["scientific/arc"]
 ast = []
+azure_policy = []
 base64 = ["dep:data-encoding"]
 base64url = ["dep:data-encoding"]
 coverage = []

bindings/ffi/src/lib.rs

@@ -461,6 +461,7 @@ pub extern "C" fn regorus_engine_get_ast_as_json(engine: *mut RegorusEngine) ->
 ///
 /// See https://docs.rs/regorus/latest/regorus/coverage/struct.Engine.html#method.get_policy_package_names
 #[no_mangle]
+#[cfg(feature = "azure_policy")]
 pub extern "C" fn regorus_engine_get_policy_package_names(engine: *mut RegorusEngine) -> RegorusResult {
     let output = || -> Result<String> { serde_json::to_string_pretty(&to_ref(engine)?.engine.get_policy_package_names()?).map_err(anyhow::Error::msg) }();
     match output {
@@ -477,6 +478,7 @@ pub extern "C" fn regorus_engine_get_policy_package_names(engine: *mut RegorusEn
 ///
 /// See https://docs.rs/regorus/latest/regorus/coverage/struct.Engine.html#method.get_policy_parameters
 #[no_mangle]
+#[cfg(feature = "azure_policy")]
 pub extern "C" fn regorus_engine_get_policy_parameters(engine: *mut RegorusEngine) -> RegorusResult {
     let output = || -> Result<String> { serde_json::to_string_pretty(&to_ref(engine)?.engine.get_policy_parameters()?).map_err(anyhow::Error::msg) }();
     match output {

src/engine.rs

@@ -30,22 +30,22 @@ pub struct PolicyPackageNameDefinition {
 }
 
 #[derive(Debug, Clone, Serialize)]
-pub struct PolicyParameterDetails {
+pub struct PolicyParameter {
     pub name: String,
     pub modifiable: bool,
     pub required: bool,
 }
 
 #[derive(Debug, Clone, Serialize)]
-pub struct PolicyModifierDetails {
+pub struct PolicyModifier {
     pub name: String,
 }
 
 #[derive(Debug, Clone, Serialize)]
-pub struct PolicyParameterDefinition {
+pub struct PolicyParameters {
     pub source_file: String,
-    pub parameters: Vec<PolicyParameterDetails>,
-    pub modifiers: Vec<PolicyModifierDetails>,
+    pub parameters: Vec<PolicyParameter>,
+    pub modifiers: Vec<PolicyModifier>,
 }
 
 /// Create a default engine.
@@ -950,6 +950,8 @@ impl Engine {
     /// # Ok(())
     /// # }
     /// ```
+    #[cfg(feature = "azure_policy")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "azure_policy")))]
     pub fn get_policy_package_names(&self) -> Result<Vec<PolicyPackageNameDefinition>> {
         let mut package_names = vec![];
         for m in &self.modules {
@@ -981,7 +983,9 @@ impl Engine {
     /// # Ok(())
     /// # }
     /// ```
-    pub fn get_policy_parameters(&self) -> Result<Vec<PolicyParameterDefinition>> {
+    #[cfg(feature = "azure_policy")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "azure_policy")))]
+    pub fn get_policy_parameters(&self) -> Result<Vec<PolicyParameters>> {
         let mut policy_parameter_definitions = vec![];
         for m in &self.modules {
             let mut parameters = vec![];
@@ -996,7 +1000,7 @@ impl Engine {
 
                     if paths.len() == 2 && paths[0] == "parameters" {
                         // Todo: Fetch fields other than name from rego metadoc for the parameter
-                        parameters.push(PolicyParameterDetails {
+                        parameters.push(PolicyParameter {
                             name: paths[1].to_string(),
                             modifiable: false,
                             required: false,
@@ -1014,7 +1018,7 @@ impl Engine {
 
                             if paths.len() == 2 && paths[0] == "parameters" {
                                 // Todo: Fetch fields other than name from rego metadoc for the parameter
-                                modifiers.push(PolicyModifierDetails {
+                                modifiers.push(PolicyModifier {
                                     name: paths[1].to_string(),
                                 })
                             }
@@ -1025,7 +1029,7 @@ impl Engine {
                 }
             }
 
-            policy_parameter_definitions.push(PolicyParameterDefinition {
+            policy_parameter_definitions.push(PolicyParameters {
                 source_file: m.package.span.source.file().to_string(),
                 parameters,
                 modifiers,

tests/engine/mod.rs

@@ -103,6 +103,8 @@ fn extension_with_state() -> Result<()> {
 }
 
 #[test]
+#[cfg(feature = "azure_policy")]
+#[cfg_attr(docsrs, doc(cfg(feature = "azure_policy")))]
 fn get_policy_package_names() -> Result<()> {
     let mut engine = Engine::new();
     engine.add_policy(
@@ -138,6 +140,8 @@ fn get_policy_package_names() -> Result<()> {
 }
 
 #[test]
+#[cfg(feature = "azure_policy")]
+#[cfg_attr(docsrs, doc(cfg(feature = "azure_policy")))]
 fn get_policy_parameters() -> Result<()> {
     let mut engine = Engine::new();
     engine.add_policy(