DSC v3 Export #5319
DSC v3 Export #5319
Conversation
…and for e2e export test
| @@ -159,6 +164,7 @@ private static int GetHRForMethod(string method) | |||
| case Get: return ErrorCodes.WinGetConfigUnitInvokeGet; | |||
| case Set: return ErrorCodes.WinGetConfigUnitInvokeSet; | |||
| case Test: return ErrorCodes.WinGetConfigUnitInvokeTest; | |||
| case Export: return ErrorCodes.WinGetConfigUnitInvokeGet; | |||
There was a problem hiding this comment.
Is it intentional to use same error code for export and get?
There was a problem hiding this comment.
It was rationalized laziness; we use the same verb for the public functions (get), so it seemed appropriate that to use the same error code. These are also more about the type of action we are taking than the actual specific action. And both get(one) and get(all) are reads.
If you think there is a reason to have another error code though, it can be added.
| // Licensed under the MIT License. | ||
| #pragma once | ||
| #include "DscCommandBase.h" | ||
|
|
There was a problem hiding this comment.
nit: surround all the test files with AICLI_DISABLE_TEST_HOOKS like TestCommand file does? I saw DscTestFileResource and this DscTestJsonResource missing them, both .h and .cpp.
There was a problem hiding this comment.
While that might save a few seconds of compile time, it shouldn't have any effect on the binary produced as the optimizer should be tossing the unreferenced code.
| @@ -84,6 +84,9 @@ namespace winrt::Microsoft::Management::Configuration::implementation | |||
| GetAllConfigurationUnitSettingsResult GetAllUnitSettings(const ConfigurationUnit& unit); | |||
| Windows::Foundation::IAsyncOperation<GetAllConfigurationUnitSettingsResult> GetAllUnitSettingsAsync(const ConfigurationUnit& unit); | |||
|
|
|||
| Configuration::GetAllConfigurationUnitsResult GetAllUnits(const ConfigurationUnit& unit); | |||
There was a problem hiding this comment.
| Configuration::GetAllConfigurationUnitsResult GetAllUnits(const ConfigurationUnit& unit); | |
| GetAllConfigurationUnitsResult GetAllUnits(const ConfigurationUnit& unit); | |
nit: consistency, and following 2 places in this file
There was a problem hiding this comment.
That is actually an intentional break with what I now think wasn't the best decision on clarity around public vs private type references.
| @@ -54,5 +57,49 @@ protected override bool ApplySettingsInternal() | |||
| { | |||
| return this.processorSettings.DSCv3.SetResourceSettings(this.UnitInternal, this).RebootRequired; | |||
| } | |||
|
|
|||
| /// <inheritdoc /> | |||
| protected override IList<ValueSet>? GetAllSettingsInternal() | |||
There was a problem hiding this comment.
From reading the caller implementation, this GetAllSettingsInternal() is for completeness, and the ConfigurationProcessor implementation will always go to GetAllUnitsInternal()?
There was a problem hiding this comment.
If the caller invokes GetAllSettings, this will still be called. If we want to deprecate GetAllSettings though, this code could be migrated to the ConfigurationProcessor implementation and it could be updated to use the GetAllUnits interface as well.
| @@ -541,6 +556,13 @@ namespace Microsoft.Management.Configuration | |||
| IGetAllSettingsResult GetAllSettings(); | |||
| } | |||
|
|
|||
| [contract(Microsoft.Management.Configuration.Contract, 4)] | |||
| interface IGetAllUnitsConfigurationUnitProcessor requires IConfigurationUnitProcessor | |||
There was a problem hiding this comment.
Do this interface and above IGetAllUnitsResult need to be registered in appxmanifest?
There was a problem hiding this comment.
No; this interface is "internal" (and I would have created a separate internal IDL if I had had the foresight).
Change
Adds a more generic
GetAllUnits(Async)export function to theConfigurationProcessor. This produces full configuration units, which may then differ from the given unit's type. This models the DSC v3Exporterresource type. The implementation of this function prefers the full implementation from the processor, but if not provided it can fall back to the previousGetAllSettingsfunction and synthesize results.Implements both the "all settings" and "all units" functionality for the DSC v3 processor. This in turn is done through the only DSC v3 option,
export.Validation
Adds a new test resource that manages an arbitrary JSON file via the top-level-object's properties.
Adds test command that can invoke export on an arbitrary DSC v3 resource target.
Adds unit tests for DSC v3 export functionality.
Adds E2E test for export of JSON resource.
Microsoft Reviewers: Open in CodeFlow