feat: implement export filter functionality for resource exports

dsc/src/resource_command.rs

@@ -339,7 +339,7 @@ pub fn export(dsc: &mut DscManager, resource_type: &FullyQualifiedTypeName, vers
     }
 
     let mut conf = Configuration::new();
-    if let Err(err) = add_resource_export_results_to_configuration(dsc_resource, &mut conf, input) {
+    if let Err(err) = add_resource_export_results_to_configuration(dsc_resource, &mut conf, input, None) {
         error!("{err}");
         exit(EXIT_DSC_ERROR);
     }

dsc/tests/dsc_export.tests.ps1

@@ -213,3 +213,134 @@ resources:
       $out.resources[0].properties.id | Should -Be 1
     }
 }
+
+Describe 'export filter directive tests' {
+    It 'exportFilter applies equality filtering for non-string properties' {
+        $yaml = @'
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+resources:
+- name: Test Export
+  type: Test/Export
+  directives:
+    exportFilter:
+    - count: 2
+  properties:
+    count: 5
+'@
+        $out = dsc config export -i $yaml 2>$TESTDRIVE/error.log | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0 -Because (Get-Content "$TESTDRIVE/error.log" -Raw)
+        @($out.resources).Count | Should -Be 1
+        $out.resources[0].properties.count | Should -Be 2
+    }
+
+    It 'exportFilter supports wildcards and is case-insensitive' {
+        $yaml = @'
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+resources:
+- name: Test Export
+  type: Test/Export
+  directives:
+    exportFilter:
+    - name: '*STANCE3'
+  properties:
+    count: 5
+'@
+        $out = dsc config export -i $yaml 2>$TESTDRIVE/error.log | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0 -Because (Get-Content "$TESTDRIVE/error.log" -Raw)
+        @($out.resources).Count | Should -Be 1
+        $out.resources[0].properties.name | Should -BeExactly 'Instance3'
+    }
+
+    It 'exportFilter objects are a logical OR' {
+        $yaml = @'
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+resources:
+- name: Test Export
+  type: Test/Export
+  directives:
+    exportFilter:
+    - count: 0
+    - name: '*stance2'
+  properties:
+    count: 5
+'@
+        $out = dsc config export -i $yaml 2>$TESTDRIVE/error.log | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0 -Because (Get-Content "$TESTDRIVE/error.log" -Raw)
+        @($out.resources).Count | Should -Be 2
+        $out.resources[0].properties.count | Should -Be 0
+        $out.resources[1].properties.name | Should -BeExactly 'Instance2'
+    }
+
+    It 'properties within an exportFilter object are a logical AND' {
+        $yaml = @'
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+resources:
+- name: Test Export
+  type: Test/Export
+  directives:
+    exportFilter:
+    - count: 2
+      name: 'instance2'
+  properties:
+    count: 5
+'@
+        $out = dsc config export -i $yaml 2>$TESTDRIVE/error.log | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0 -Because (Get-Content "$TESTDRIVE/error.log" -Raw)
+        @($out.resources).Count | Should -Be 1
+        $out.resources[0].properties.count | Should -Be 2
+    }
+
+    It 'exportFilter with an AND mismatch returns no instances' {
+        $yaml = @'
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+resources:
+- name: Test Export
+  type: Test/Export
+  directives:
+    exportFilter:
+    - count: 2
+      name: 'instance1'
+  properties:
+    count: 5
+'@
+        $out = dsc config export -i $yaml 2>$TESTDRIVE/error.log | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0 -Because (Get-Content "$TESTDRIVE/error.log" -Raw)
+        @($out.resources).Count | Should -Be 0
+    }
+
+    It 'exportFilter works for a resource that does not support filtering natively' {
+        $yaml = @'
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+resources:
+- name: No Native Filtering
+  type: Test/ExportSchemaNoFiltering
+  directives:
+    exportFilter:
+    - name: '*e*'
+'@
+        $out = dsc config export -i $yaml 2>$TESTDRIVE/error.log | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0 -Because (Get-Content "$TESTDRIVE/error.log" -Raw)
+        @($out.resources).Count | Should -Be 2
+        $out.resources.properties.name | Should -Be @('Steve', 'Tess')
+    }
+
+    It 'exportFilter works with an exporter resource' {
+        $yaml = @'
+$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+resources:
+- name: export this
+  type: Test/Exporter
+  directives:
+    exportFilter:
+    - type: '*Foo'
+  properties:
+    typeNames:
+    - Test/Foo
+    - Test/Bar
+'@
+        $out = dsc config export -i $yaml 2>$TESTDRIVE/error.log | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0 -Because (Get-Content "$TESTDRIVE/error.log" -Raw)
+        @($out.resources).Count | Should -Be 1
+        $out.resources[0].type | Should -BeExactly 'Test/Foo'
+    }
+}

lib/dsc-lib/locales/en-us.toml

@@ -35,6 +35,9 @@ dependencyNotInOrder = "Dependency not found in order"
 circularDependency = "Circular dependency detected for resource named '%{resource}'"
 invocationOrder = "Resource invocation order"
 
+[configure.export_filter]
+filteredInstances = "Export filter reduced %{original} instances to %{retained}"
+
 [configure.mod]
 nestedArraysNotSupported = "Nested arrays not supported"
 arrayElementCouldNotTransformAsString = "Array element could not be transformed as string"

lib/dsc-lib/src/configure/config_doc.rs

@@ -236,6 +236,10 @@ pub struct ConfigDirective {
 #[serde(rename_all = "camelCase")]
 #[dsc_repo_schema(base_name = "directive", folder_path = "resource")]
 pub struct ResourceDirective {
+    /// Filters applied by the engine to exported instances. Filters in the array are logically
+    /// OR'd while properties within a filter are logically AND'd. String values support the `*` wildcard.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub export_filter: Option<Vec<Map<String, Value>>>,
     /// Specify specific adapter type used for implicit operations
     #[serde(skip_serializing_if = "Option::is_none")]
     pub require_adapter: Option<FullyQualifiedTypeName>,

lib/dsc-lib/src/configure/export_filter.rs

@@ -0,0 +1,206 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+use rust_i18n::t;
+use serde_json::{Map, Value};
+use tracing::debug;
+
+/// Apply an export filter to a list of exported instances, retaining only matching instances.
+///
+/// # Arguments
+///
+/// * `instances` - The exported instances to filter.
+/// * `filters` - The filter objects from the `exportFilter` directive.
+pub(super) fn apply_export_filter(instances: &mut Vec<Value>, filters: &[Map<String, Value>]) {
+    if filters.is_empty() {
+        // an empty filter list means no filtering is applied
+        return;
+    }
+
+    let original_count = instances.len();
+    instances.retain(|instance| instance_matches_filters(instance, filters));
+    debug!("{}", t!("configure.export_filter.filteredInstances", original = original_count, retained = instances.len()));
+}
+
+/// Check if an instance matches any of the filter objects (logical OR).
+#[must_use]
+fn instance_matches_filters(instance: &Value, filters: &[Map<String, Value>]) -> bool {
+    let Some(instance) = instance.as_object() else {
+        // non-object instances can't be matched by property filters
+        return false;
+    };
+
+    filters.iter().any(|filter| instance_matches_filter(instance, filter))
+}
+
+/// Check if an instance matches all properties of a single filter object (logical AND).
+fn instance_matches_filter(instance: &Map<String, Value>, filter: &Map<String, Value>) -> bool {
+    filter.iter().all(|(name, expected)| {
+        instance.get(name).is_some_and(|actual| value_matches(actual, expected))
+    })
+}
+
+/// Check if an actual value matches an expected filter value.
+fn value_matches(actual: &Value, expected: &Value) -> bool {
+    match (actual, expected) {
+        // strings are compared case-insensitively with `*` wildcard support
+        (Value::String(actual_str), Value::String(pattern)) => wildcard_match(pattern, actual_str),
+        // nested objects match recursively as a partial match
+        (Value::Object(actual_obj), Value::Object(expected_obj)) => instance_matches_filter(actual_obj, expected_obj),
+        // everything else requires equality
+        _ => actual == expected,
+    }
+}
+
+/// Match `text` against `pattern` where `*` matches zero or more characters.
+/// The comparison is case-insensitive.
+fn wildcard_match(pattern: &str, text: &str) -> bool {
+    let pattern: Vec<char> = pattern.to_lowercase().chars().collect();
+    let text: Vec<char> = text.to_lowercase().chars().collect();
+
+    // iterative greedy matching with backtracking on the last `*`
+    let (mut p, mut t) = (0usize, 0usize);
+    let mut star: Option<usize> = None;
+    let mut star_text = 0usize;
+
+    while t < text.len() {
+        if p < pattern.len() && pattern[p] == '*' {
+            star = Some(p);
+            star_text = t;
+            p += 1;
+        } else if p < pattern.len() && pattern[p] == text[t] {
+            p += 1;
+            t += 1;
+        } else if let Some(star_pos) = star {
+            // backtrack: let the last `*` consume one more character
+            p = star_pos + 1;
+            star_text += 1;
+            t = star_text;
+        } else {
+            return false;
+        }
+    }
+
+    // remaining pattern must be all `*`
+    pattern[p..].iter().all(|c| *c == '*')
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use serde_json::json;
+
+    fn to_filters(value: Value) -> Vec<Map<String, Value>> {
+        serde_json::from_value(value).unwrap()
+    }
+
+    #[test]
+    fn wildcard_match_exact() {
+        assert!(wildcard_match("sshd", "sshd"));
+        assert!(!wildcard_match("sshd", "sshd2"));
+        assert!(!wildcard_match("sshd2", "sshd"));
+    }
+
+    #[test]
+    fn wildcard_match_case_insensitive() {
+        assert!(wildcard_match("SSHD", "sshd"));
+        assert!(wildcard_match("*Ssh*", "OpenSSH Server"));
+    }
+
+    #[test]
+    fn wildcard_match_star() {
+        assert!(wildcard_match("*ssh*", "ssh"));
+        assert!(wildcard_match("*ssh*", "openssh-server"));
+        assert!(wildcard_match("ssh*", "sshd"));
+        assert!(wildcard_match("*shd", "sshd"));
+        assert!(wildcard_match("*", ""));
+        assert!(wildcard_match("*", "anything"));
+        assert!(wildcard_match("s*h*d", "sshd"));
+        assert!(!wildcard_match("*ssh*", "no match"));
+        assert!(!wildcard_match("ssh*", "openssh"));
+    }
+
+    #[test]
+    fn empty_filter_list_matches_nothing_but_apply_is_noop() {
+        let mut instances = vec![json!({"name": "one"}), json!({"name": "two"})];
+        apply_export_filter(&mut instances, &[]);
+        assert_eq!(instances.len(), 2);
+    }
+
+    #[test]
+    fn filters_are_logical_or() {
+        let filters = to_filters(json!([
+            { "name": "*ssh*" },
+            { "startType": "automatic" }
+        ]));
+        // matches first filter
+        assert!(instance_matches_filters(&json!({"name": "sshd", "startType": "manual"}), &filters));
+        // matches second filter
+        assert!(instance_matches_filters(&json!({"name": "spooler", "startType": "automatic"}), &filters));
+        // matches neither
+        assert!(!instance_matches_filters(&json!({"name": "spooler", "startType": "manual"}), &filters));
+    }
+
+    #[test]
+    fn properties_within_filter_are_logical_and() {
+        let filters = to_filters(json!([
+            { "name": "*ssh*", "startType": "automatic" }
+        ]));
+        assert!(instance_matches_filters(&json!({"name": "sshd", "startType": "automatic"}), &filters));
+        assert!(!instance_matches_filters(&json!({"name": "sshd", "startType": "manual"}), &filters));
+        assert!(!instance_matches_filters(&json!({"name": "spooler", "startType": "automatic"}), &filters));
+    }
+
+    #[test]
+    fn missing_property_does_not_match() {
+        let filters = to_filters(json!([{ "name": "*ssh*" }]));
+        assert!(!instance_matches_filters(&json!({"startType": "automatic"}), &filters));
+    }
+
+    #[test]
+    fn non_string_values_use_equality() {
+        let filters = to_filters(json!([{ "count": 2, "enabled": true }]));
+        assert!(instance_matches_filters(&json!({"count": 2, "enabled": true}), &filters));
+        assert!(!instance_matches_filters(&json!({"count": 3, "enabled": true}), &filters));
+        assert!(!instance_matches_filters(&json!({"count": 2, "enabled": false}), &filters));
+        // a string pattern does not match a non-string value
+        let filters = to_filters(json!([{ "count": "*" }]));
+        assert!(!instance_matches_filters(&json!({"count": 2}), &filters));
+    }
+
+    #[test]
+    fn nested_objects_match_recursively() {
+        let filters = to_filters(json!([
+            { "properties": { "name": "b*r" } }
+        ]));
+        assert!(instance_matches_filters(&json!({"properties": {"name": "bar", "other": 1}}), &filters));
+        assert!(!instance_matches_filters(&json!({"properties": {"name": "baz"}}), &filters));
+    }
+
+    #[test]
+    fn empty_filter_object_matches_everything() {
+        let filters = to_filters(json!([{}]));
+        assert!(instance_matches_filters(&json!({"name": "anything"}), &filters));
+    }
+
+    #[test]
+    fn apply_export_filter_retains_matching() {
+        let mut instances = vec![
+            json!({"name": "sshd", "startType": "automatic"}),
+            json!({"name": "spooler", "startType": "automatic"}),
+            json!({"name": "ssh-agent", "startType": "manual"}),
+        ];
+        let filters = to_filters(json!([{ "name": "*ssh*" }]));
+        apply_export_filter(&mut instances, &filters);
+        assert_eq!(instances.len(), 2);
+        assert_eq!(instances[0]["name"], "sshd");
+        assert_eq!(instances[1]["name"], "ssh-agent");
+    }
+
+    #[test]
+    fn non_object_instances_do_not_match() {
+        let filters = to_filters(json!([{ "name": "*" }]));
+        assert!(!instance_matches_filters(&json!("just a string"), &filters));
+        assert!(!instance_matches_filters(&json!(42), &filters));
+    }
+}