Fix to emit info message if invalid manifest is found

Author: Steve Lee (POWERSHELL HE/HIM) (from Dev Box)

dsc/tests/dsc_discovery.tests.ps1

@@ -302,4 +302,24 @@ Describe 'tests for resource discovery' {
             $env:DSC_RESOURCE_PATH = $null
         }
     }
+
+    It 'Invalid resource manifest will generate info message' {
+        $invalidManifest = @'
+        {
+            "$schema": "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json",
+            "type": "Test/InvalidManifest",
+            "version": "0.1.0",
+            "get": {
+                "executable": "dsctest",
+                "unexpectedField": "This field is not expected in the get section and should be ignored by the discovery process"
+            },
+            "newProperty": "This property is not expected in the manifest and should be ignored by the discovery process"
+        }
+'@
+        Set-Content -Path "$testdrive/test.dsc.resource.json" -Value $invalidManifest
+        $out = dsc -l info resource list 'Test/InvalidManifest' 2> "$testdrive/error.txt" | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0
+        $out | Should -BeNullOrEmpty -Because (Get-Content -Raw -Path "$testdrive/error.txt")
+        Get-Content -Raw -Path "$testdrive/error.txt" | Should -Match "INFO Failed to load manifest for resource '.*test.dsc.resource.json':" -Because (Get-Content -Raw -Path "$testdrive/error.txt")
+    }
 }

dsc_lib/locales/en-us.toml

@@ -91,6 +91,8 @@ extensionResourceFound = "Extension found resource '%{resource}'"
 callingExtension = "Calling extension '%{extension}' to discover resources"
 extensionFoundResources = "Extension '%{extension}' found %{count} resources"
 invalidManifestVersion = "Manifest '%{path}' has invalid version: %{err}"
+failedImportManifest = "Failed to import manifest for resource '%{resource}': %{err}"
+failedLoadManifest = "Failed to load manifest for resource '%{resource}': %{err}"
 
 [dscresources.commandResource]
 invokeGet = "Invoking get for '%{resource}'"
@@ -173,6 +175,7 @@ resourceManifestSchemaDescription = "Defines the JSON Schema the resource manife
 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}"
+failedImportManifest = "Failed to import manifest for resource '%{resource}': %{err}"
 
 [extensions.extension_manifest]
 extensionManifestSchemaTitle = "Extension manifest schema URI"

dsc_lib/src/discovery/command_discovery.rs

@@ -247,9 +247,9 @@ impl ResourceDiscovery for CommandDiscovery {
                                     Err(e) => {
                                         // At this point we can't determine whether or not the bad manifest contains
                                         // resource that is requested by resource/config operation
-                                        // if it is, then "ResouceNotFound" error will be issued later
-                                        // and here we just write as warning
-                                        warn!("{e}");
+                                        // if it is, then "ResourceNotFound" error will be issued later
+                                        // and here we just write as information
+                                        info!("{}", t!("discovery.commandDiscovery.failedLoadManifest", resource = path.to_string_lossy(), err = e).to_string());
                                         continue;
                                     },
                                 };
@@ -277,7 +277,13 @@ impl ResourceDiscovery for CommandDiscovery {
                                     ImportedManifest::Resource(resource) => {
                                         if regex.is_match(&resource.type_name) {
                                             if let Some(ref manifest) = resource.manifest {
-                                                let manifest = import_manifest(manifest.clone())?;
+                                                let manifest = match import_manifest(manifest.clone()) {
+                                                    Ok(manifest) => manifest,
+                                                    Err(err) => {
+                                                        info!("{}", t!("discovery.commandDiscovery.failedImportManifest", resource = resource.type_name, err = err).to_string());
+                                                        continue;
+                                                    }
+                                                };
                                                 if manifest.kind == Some(Kind::Adapter) {
                                                     trace!("{}", t!("discovery.commandDiscovery.adapterFound", adapter = resource.type_name));
                                                     insert_resource(&mut adapters, &resource, true);

dsc_lib/src/discovery/mod.rs

@@ -9,7 +9,7 @@ use crate::extensions::dscextension::DscExtension;
 use crate::{dscresources::dscresource::DscResource, dscerror::DscError, progress::ProgressFormat};
 use std::collections::BTreeMap;
 use command_discovery::ImportedManifest;
-use tracing::error;
+use tracing::{error, warn};
 
 #[derive(Clone)]
 pub struct Discovery {
@@ -54,7 +54,7 @@ impl Discovery {
             let discovered_resources = match discovery_type.list_available(kind, type_name_filter, adapter_name_filter) {
                 Ok(value) => value,
                 Err(err) => {
-                    error!("{err}");
+                    warn!("{err}");
                     continue;
                 }
             };

dsc_lib/src/dscresources/resource_manifest.rs

@@ -35,9 +35,6 @@ pub struct ResourceManifest {
     pub kind: Option<Kind>,
     /// The version of the resource using semantic versioning.
     pub version: String,
-    /// The deprecation message of the resource, if the resource is deprecated.
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub deprecation_message: Option<String>,
     /// The description of the resource.
     pub description: Option<String>,
     /// Tags for the resource.

dsc_lib/src/extensions/dscextension.rs

@@ -111,9 +111,17 @@ impl DscExtension {
                     }
                     let manifest_path = Path::new(&discover_result.manifest_path);
                     // Currently we don't support extensions discovering other extensions
-                    if let ImportedManifest::Resource(resource) = load_manifest(manifest_path)? {
-                        resources.push(resource);
-                    }
+                    let resource = match load_manifest(manifest_path) {
+                        Ok(ImportedManifest::Resource(resource)) => resource,
+                        Ok(_) => continue,
+                        Err(err) => {
+                            // For invalid manifest, we write an information and skip it
+                            info!("{}", t!("extensions.dscextension.failedImportManifest", resource = manifest_path.to_string_lossy(), err = err).to_string());
+                            continue;
+                        }
+                    };
+
+                    resources.push(resource);
                 }
             }