Skip to content

Update configure export --all for recent DSC changes #6226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JohnMcPMS merged 1 commit into from
May 14, 2026
+127 −37
Merged

Update configure export --all for recent DSC changes #6226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 125 additions & 35 deletions src/AppInstallerCLICore/Workflows/ConfigurationFlow.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,16 +101,29 @@ namespace AppInstaller::CLI::Workflow
return {
L"Microsoft.WinGet/",
L"Microsoft.WinGet.Dev/",
L"Microsoft.DSC.Debug/",
};
};

// Returns unit type prefixes that identify resources known to be shipped with DSC.
// These are used both to exclude the resources themselves and to discover the DSC
// installation location, so that any co-located resources are also excluded.
std::vector<std::wstring_view> DscShippedResourcePrefixes()
{
return {
L"Microsoft.DSC/",
L"Microsoft.DSC.Debug/",
L"Microsoft.DSC.Transitional/",
L"Microsoft.Windows/RebootPending",
L"Microsoft.Windows/Registry",
L"Microsoft.Windows/WMI",
L"Microsoft.Windows/WindowsPowerShell",
L"Microsoft/OSInfo"
L"Microsoft/OSInfo",
};
};
}

// Returns unit type prefixes for DSC-shipped resources that are still allowed to
// appear in the exported configuration. All other DSC-shipped resources are excluded by default.
std::vector<std::wstring_view> DscShippedResourcesAllowList()
{
// Currently empty: all DSC-shipped resources are excluded from export by default.
return {};
}

Logging::Level ConvertLevel(DiagnosticLevel level)
{
Expand Down Expand Up @@ -1582,10 +1595,10 @@ namespace AppInstaller::CLI::Workflow
}
}

std::vector<IConfigurationUnitProcessorDetails> GetAllUnitProcessors(Execution::Context& context)
std::vector<IConfigurationUnitProcessorDetails3> GetAllUnitProcessors3(Execution::Context& context)
{
ConfigurationContext& configContext = context.Get<Data::ConfigurationContext>();
std::vector<IConfigurationUnitProcessorDetails> result;
std::vector<IConfigurationUnitProcessorDetails3> result;

// Only supported by dsc v3 processor.
if (ConfigurationRemoting::ProcessorEngine::DSCv3 == ConfigurationRemoting::DetermineProcessorEngine(configContext.Set()))
Expand All @@ -1601,7 +1614,11 @@ namespace AppInstaller::CLI::Workflow
auto cancellationScope = progressScope->Callback().SetCancellationFunction([&]() { findAction.Cancel(); });
for (auto unitProcessor : findAction.get())
{
result.emplace_back(std::move(unitProcessor));
IConfigurationUnitProcessorDetails3 processor3;
if (unitProcessor.try_as(processor3))
{
result.emplace_back(std::move(processor3));
}
}
}

Expand Down Expand Up @@ -1683,19 +1700,13 @@ namespace AppInstaller::CLI::Workflow
struct UnitProcessorTree
{
private:
struct SourceAndPackage
{
PackageCollection::Source Source;
PackageCollection::Package Package;
};

struct Node
{
// Packages whose installed location is at this node
std::vector<SourceAndPackage> Packages;
std::vector<PackageCollection::Package> Packages;

// Units whose location is at this node.
std::vector<IConfigurationUnitProcessorDetails> Units;
std::vector<IConfigurationUnitProcessorDetails3> Units;
};

Filesystem::PathTree<Node> m_pathTree;
Expand All @@ -1707,33 +1718,29 @@ namespace AppInstaller::CLI::Workflow
}

public:
UnitProcessorTree(std::vector<IConfigurationUnitProcessorDetails>&& unitProcessors)
UnitProcessorTree(std::vector<IConfigurationUnitProcessorDetails3>&& unitProcessors)
{
for (auto&& unit : unitProcessors)
{
IConfigurationUnitProcessorDetails3 unitProcessor3;
if (unit.try_as(unitProcessor3))
{
winrt::hstring unitPath = unitProcessor3.Path();
AICLI_LOG(Config, Verbose, << "Found unit `" << Utility::ConvertToUTF8(unit.UnitType()) << "` at: " << Utility::ConvertToUTF8(unitPath));
Node& node = FindNodeForFilePath(unitPath);
node.Units.emplace_back(std::move(unit));
}
winrt::hstring unitPath = unit.Path();
AICLI_LOG(Config, Verbose, << "Found unit `" << Utility::ConvertToUTF8(unit.UnitType()) << "` at: " << Utility::ConvertToUTF8(unitPath));
Node& node = FindNodeForFilePath(unitPath);
node.Units.emplace_back(std::move(unit));
}
}

void PlacePackage(const PackageCollection::Source& source, const PackageCollection::Package& package)
void PlacePackage(const PackageCollection::Package& package)
{
Node* node = m_pathTree.Find(package.InstalledLocation);
if (node)
{
node->Packages.emplace_back(SourceAndPackage{ source, package });
node->Packages.emplace_back(package);
}
}

std::vector<IConfigurationUnitProcessorDetails> GetResourcesForPackage(const PackageCollection::Package& package) const
std::vector<IConfigurationUnitProcessorDetails3> GetResourcesForPackage(const PackageCollection::Package& package) const
{
std::vector<IConfigurationUnitProcessorDetails> result;
std::vector<IConfigurationUnitProcessorDetails3> result;

m_pathTree.VisitIf(
package.InstalledLocation,
Expand All @@ -1760,10 +1767,10 @@ namespace AppInstaller::CLI::Workflow
std::wstring packageUnitType = GetWinGetPackageUnitType(configContext);

// This will be later used by per package settings export.
std::vector<IConfigurationUnitProcessorDetails> unitProcessors;
std::vector<IConfigurationUnitProcessorDetails3> unitProcessors;
try
{
unitProcessors = GetAllUnitProcessors(context);
unitProcessors = GetAllUnitProcessors3(context);
}
catch (...)
{
Expand All @@ -1776,11 +1783,13 @@ namespace AppInstaller::CLI::Workflow
// Filter out processors in exclusion list.
for (auto itr = unitProcessors.begin(); itr != unitProcessors.end(); /* itr incremented in the logic */)
{
std::wstring unitType{ itr->UnitType() };
bool processorRemoved = false;
for (const auto& exclusionItem : exclusionList)
{
if (Utility::CaseInsensitiveStartsWith(itr->UnitType(), exclusionItem))
if (Utility::CaseInsensitiveStartsWith(unitType, exclusionItem))
{
AICLI_LOG(Config, Verbose, << "Filtering excluded resource `" << Utility::ConvertToUTF8(itr->UnitType()) << "` from export");
itr = unitProcessors.erase(itr);
processorRemoved = true;
break;
Expand All @@ -1793,14 +1802,95 @@ namespace AppInstaller::CLI::Workflow
}
}

// Filter out DSC-shipped resources and any resources co-located with them.
// First pass: find the parent directory of each known DSC resource to identify the DSC
// installation location(s), handling both packaged and unpackaged (PATH-based) DSC installs.
// Second pass: remove any resource that either matches a known DSC prefix or resides in one
// of those locations, unless the resource type appears in DscShippedResourcesAllowList().
{
const auto dscPrefixes = DscShippedResourcePrefixes();
const auto dscAllowList = DscShippedResourcesAllowList();

std::set<std::filesystem::path> dscLocations;
for (const auto& processor : unitProcessors)
{
std::wstring unitType{ processor.UnitType() };
for (const auto& prefix : dscPrefixes)
{
if (Utility::CaseInsensitiveStartsWith(unitType, prefix))
{
std::filesystem::path location = std::filesystem::weakly_canonical(
std::filesystem::path{ std::wstring{ processor.Path() } }.parent_path());
dscLocations.emplace(std::move(location));
break;
}
}
}

for (auto itr = unitProcessors.begin(); itr != unitProcessors.end(); /* itr incremented in the logic */)
{
std::wstring unitType{ itr->UnitType() };

// Check the allow list first.
bool inAllowList = false;
for (const auto& allowedPrefix : dscAllowList)
{
if (Utility::CaseInsensitiveStartsWith(unitType, allowedPrefix))
{
inAllowList = true;
break;
}
}

if (inAllowList)
{
++itr;
continue;
}

// Check if the resource type is a known DSC-shipped prefix.
bool isDscResource = false;
for (const auto& prefix : dscPrefixes)
{
if (Utility::CaseInsensitiveStartsWith(unitType, prefix))
{
isDscResource = true;
break;
}
}

// If not matched by prefix, check whether it shares a location with a known DSC resource.
if (!isDscResource && !dscLocations.empty())
{
std::filesystem::path location = std::filesystem::weakly_canonical(
std::filesystem::path{ std::wstring{ itr->Path() } }.parent_path());

if (dscLocations.find(location) != dscLocations.end())
{
isDscResource = true;
}
}

if (isDscResource)
{
AICLI_LOG(Config, Verbose, << "Filtering DSC-shipped resource `" << Utility::ConvertToUTF8(itr->UnitType()) << "` from export");
itr = unitProcessors.erase(itr);
}
else
{
++itr;
}
}
}

// Build a tree of the unit processors and place packages onto it to indicate nearest ownership.
UnitProcessorTree unitProcessorTree{ std::move(unitProcessors) };

for (const auto& source : context.Get<Execution::Data::PackageCollection>().Sources)
{
for (const auto& package : source.Packages)
{
unitProcessorTree.PlacePackage(source, package);
unitProcessorTree.PlacePackage(package);
}
}

Expand Down
2 changes: 1 addition & 1 deletion src/AppInstallerCLIE2ETests/ConfigureExportCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ public void ExportAll()
Assert.True(showResult.StdOut.Contains($"Dependencies: {Constants.TestSourceName}_AppInstallerTest.TestPackageExport"));
Assert.True(showResult.StdOut.Contains("data: TestData"));

Assert.True(showResult.StdOut.Contains("AppInstallerTest/TestResource.SubDirectory"));
Assert.True(showResult.StdOut.Contains("AppInstallerTest/TestResource_SubDirectory"));
Assert.True(showResult.StdOut.Contains($"Dependencies: {Constants.TestSourceName}_AppInstallerTest.TestPackageExport"));
Assert.True(showResult.StdOut.Contains("data: TestData"));
}
Expand Down
2 changes: 1 addition & 1 deletion src/AppInstallerTestExeInstaller/main.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ void GenerateDSCv3ProviderFiles(const path& installDirectory, const std::wstring

if (!subDirectory.empty())
{
DscResourceJsonContent += '.';
DscResourceJsonContent += '_';
DscResourceJsonContent += subDirectory;
}

Expand Down