Merge pull request #762 from SteveL-MSFT/appx-discover

Experimental Appx resource discovery extension

Author: SteveL-MSFT

build.ps1

@@ -38,6 +38,8 @@ if ($GetPackageVersion) {
 }
 
 $filesForWindowsPackage = @(
+    'appx.dsc.extension.json',
+    'appx-discover.ps1',
     'dsc.exe',
     'dsc_default.settings.json',
     'dsc.settings.json',
@@ -250,7 +252,7 @@ if (!$SkipBuild) {
     }
 
     # make sure dependencies are built first so clippy runs correctly
-    $windows_projects = @("pal", "registry", "reboot_pending", "wmi-adapter", "configurations/windows")
+    $windows_projects = @("pal", "registry", "reboot_pending", "wmi-adapter", "configurations/windows", 'extensions/appx')
     $macOS_projects = @("resources/brew")
     $linux_projects = @("resources/apt")
 

dsc_lib/locales/en-us.toml

@@ -170,6 +170,7 @@ resourceManifestSchemaDescription = "Defines the JSON Schema the resource manife
 [extensions.dscextension]
 discoverNoResults = "No results returned for discovery extension '%{extension}'"
 discoverNotAbsolutePath = "Resource path from extension '%{extension}' is not an absolute path: %{path}"
+extensionReturned = "Extension '%{extension}' returned line: %{line}"
 
 [extensions.extension_manifest]
 extensionManifestSchemaTitle = "Extension manifest schema URI"

dsc_lib/src/discovery/command_discovery.rs

@@ -567,7 +567,7 @@ fn insert_resource(resources: &mut BTreeMap<String, Vec<DscResource>>, resource:
                 },
             };
             // if the version already exists, we might skip it
-            if !skip_duplicate_version && resource_instance_version == resource_version {
+            if skip_duplicate_version && resource_instance_version == resource_version {
                 return;
             }
 

dsc_lib/src/extensions/dscextension.rs

@@ -6,7 +6,7 @@ use serde::{Deserialize, Serialize};
 use serde_json::Value;
 use schemars::JsonSchema;
 use std::{fmt::Display, path::Path};
-use tracing::info;
+use tracing::{info, trace};
 
 use crate::{discovery::command_discovery::{load_manifest, ImportedManifest}, dscerror::DscError, dscresources::{command_resource::{invoke_command, process_args}, dscresource::DscResource}};
 
@@ -99,6 +99,7 @@ impl DscExtension {
                 info!("{}", t!("extensions.dscextension.discoverNoResults", extension = self.type_name));
             } else {
                 for line in stdout.lines() {
+                    trace!("{}", t!("extensions.dscextension.extensionReturned", extension = self.type_name, line = line));
                     let discover_result: DiscoverResult = match serde_json::from_str(line) {
                         Ok(result) => result,
                         Err(err) => {

extensions/appx/appx-discover.ps1

@@ -0,0 +1,7 @@
+$packages = Get-AppxPackage
+foreach ($package in $packages) {
+    $manifests = Get-ChildItem -Path "$($package.InstallLocation)\*" -File -Include '*.dsc.resource.json','*.dsc.resource.yaml','*.dsc.resource.yml' -ErrorAction Ignore
+    foreach ($manifest in $manifests) {
+        @{ manifestPath = $manifest.FullName } | ConvertTo-Json -Compress
+    }
+}

extensions/appx/appx.dsc.extension.json

@@ -0,0 +1,16 @@
+{
+    "$schema": "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json",
+    "type": "Microsoft.Windows.Appx/Discover",
+    "version": "0.1.0",
+    "description": "Discovers DSC resources packaged as Appx packages.",
+    "discover": {
+        "executable": "powershell",
+        "args": [
+            "-NoLogo",
+            "-NonInteractive",
+            "-NoProfile",
+            "-Command",
+            "./appx-discover.ps1"
+            ]
+    }
+}

extensions/appx/appx.tests.ps1

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+Describe 'Tests for Appx resource discovery' -Skip:(!$IsWindows){
+    It 'Should find DSC appx resources' {
+        $out = dsc resource list | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0
+        $found = $false
+        foreach ($resource in $out) {
+            if ($resource.directory.StartsWith("$env:ProgramFiles\WindowsApps\Microsoft.DesiredStateConfiguration-Private")) {
+                $found = $true
+                break
+            }
+        }
+        $found | Should -Be $true
+    }
+}

extensions/appx/copy_files.txt

@@ -0,0 +1,2 @@
+appx-discover.ps1
+appx.dsc.extension.json