Add configuration environment

.github/actions/spelling/allow.txt

@@ -321,6 +321,7 @@ STDAPI
 STGM
 storeedgefd
 stpkgmanvalwestustest
+stringable
 STRINGID
 STRINGIZE
 STRSAFE

src/AppInstallerCLICore/Commands/DebugCommand.cpp

@@ -102,6 +102,7 @@ namespace AppInstaller::CLI
         OutputProxyStubInterfaceRegistration<winrt::Windows::Foundation::Collections::IIterable<winrt::Microsoft::Management::Configuration::TestConfigurationUnitResult>>(context);
         OutputProxyStubInterfaceRegistration<winrt::Windows::Foundation::Collections::IIterable<winrt::Microsoft::Management::Configuration::IApplyGroupMemberSettingsResult>>(context);
         OutputProxyStubInterfaceRegistration<winrt::Windows::Foundation::Collections::IIterable<winrt::Microsoft::Management::Configuration::ITestSettingsResult>>(context);
+        OutputProxyStubInterfaceRegistration<winrt::Windows::Foundation::Collections::IIterable<winrt::Microsoft::Management::Configuration::IConfigurationEnvironmentView>>(context);
         OutputProxyStubInterfaceRegistration<winrt::Microsoft::Management::Configuration::IConfigurationUnitProcessorDetails2>(context);
         OutputProxyStubInterfaceRegistration<winrt::Microsoft::Management::Configuration::IGetAllSettingsConfigurationUnitProcessor>(context);
         OutputProxyStubInterfaceRegistration<winrt::Microsoft::Management::Configuration::IConfigurationStatics2>(context);

src/AppInstallerCLICore/ConfigurationDynamicRuntimeFactory.cpp

@@ -142,9 +142,9 @@ namespace AppInstaller::CLI::ConfigurationRemoting
                 // Check for multiple integrity level requirements
                 bool multipleIntegrityLevels = false;
                 bool higherIntegrityLevelsThanCurrent = false;
-                for (const auto& existingUnit : m_configurationSet.Units())
+                for (const auto& environment : m_configurationSet.GetUnitEnvironments())
                 {
-                    auto integrityLevel = GetIntegrityLevelForUnit(existingUnit);
+                    auto integrityLevel = SecurityContextToIntegrityLevel(environment.Context());
                     if (integrityLevel != m_currentIntegrityLevel)
                     {
                         multipleIntegrityLevels = true;
@@ -183,9 +183,9 @@ namespace AppInstaller::CLI::ConfigurationRemoting
                 std::call_once(m_createUnitSetProcessorsOnce,
                     [&]()
                     {
-                        for (const auto& existingUnit : m_configurationSet.Units())
+                        for (const auto& environment : m_configurationSet.GetUnitEnvironments())
                         {
-                            Security::IntegrityLevel requiredIntegrityLevel = GetIntegrityLevelForUnit(existingUnit);
+                            Security::IntegrityLevel requiredIntegrityLevel = SecurityContextToIntegrityLevel(environment.Context());
 
                             if (m_setProcessors.find(requiredIntegrityLevel) == m_setProcessors.end())
                             {
@@ -212,16 +212,13 @@ namespace AppInstaller::CLI::ConfigurationRemoting
 
         private:
             // Converts the string representation of SecurityContext to the integrity level
-            Security::IntegrityLevel SecurityContextToIntegrityLevel(winrt::hstring securityContext)
+            Security::IntegrityLevel SecurityContextToIntegrityLevel(SecurityContext securityContext)
             {
-                std::wstring securityContextLower = Utility::ToLower(securityContext);
-
-                if (securityContextLower == L"elevated")
-                {
-                    return Security::IntegrityLevel::High;
-                }
-                else if (securityContextLower == L"restricted")
+                switch (securityContext)
                 {
+                case SecurityContext::Current:
+                    return m_currentIntegrityLevel;
+                case SecurityContext::Restricted:
 #ifndef AICLI_DISABLE_TEST_HOOKS
                     if (m_enableRestrictedIntegrityLevel)
                     {
@@ -236,34 +233,17 @@ namespace AppInstaller::CLI::ConfigurationRemoting
                         // Technically this means the default level of the user token, so if UAC is disabled it would be the only integrity level (aka current).
                         // return Security::IntegrityLevel::Medium;
                     }
+                case SecurityContext::Elevated:
+                    return Security::IntegrityLevel::High;
+                default:
+                    THROW_WIN32(ERROR_NOT_SUPPORTED);
                 }
-                else if (securityContextLower == L"current")
-                {
-                    return m_currentIntegrityLevel;
-                }
-
-                THROW_WIN32(ERROR_NOT_SUPPORTED);
             }
 
             // Gets the integrity level that the given unit should be run at
             Security::IntegrityLevel GetIntegrityLevelForUnit(const ConfigurationUnit& unit)
             {
-                // Support for 0.2 schema via metadata value
-                // TODO: Support case-insensitive lookup by iteration
-                auto unitMetadata = unit.Metadata();
-                auto securityContext = unitMetadata.TryLookup(L"securityContext");
-                if (securityContext)
-                {
-                    auto securityContextProperty = securityContext.try_as<IPropertyValue>();
-                    if (securityContextProperty && securityContextProperty.Type() == PropertyType::String)
-                    {
-                        return SecurityContextToIntegrityLevel(securityContextProperty.GetString());
-                    }
-                }
-
-                // TODO: Support for 0.3 schema will require a group processor wrapper
-
-                return m_currentIntegrityLevel;
+                return SecurityContextToIntegrityLevel(unit.Environment().Context());
             }
 
             // Serializes the set properties to be sent to the remote server

src/AppInstallerCLIPackage/Package.appxmanifest

@@ -113,6 +113,7 @@
         <Interface Name="Windows.Foundation.Collections.IIterable`1&lt;Microsoft.Management.Configuration.TestConfigurationUnitResult&gt;" InterfaceId="73848262-86D4-5FFC-8353-8408C4E649DE" />
         <Interface Name="Windows.Foundation.Collections.IIterable`1&lt;Microsoft.Management.Configuration.IApplyGroupMemberSettingsResult&gt;" InterfaceId="5086070C-F468-5B00-8352-50FB420BA8B0" />
         <Interface Name="Windows.Foundation.Collections.IIterable`1&lt;Microsoft.Management.Configuration.ITestSettingsResult&gt;" InterfaceId="2D28E6AA-7036-5D78-9B58-9456F1E332FE" />
+        <Interface Name="Windows.Foundation.Collections.IIterable`1&lt;Microsoft.Management.Configuration.IConfigurationEnvironmentView&gt;" InterfaceId="F1344DB2-5194-5A6A-B36C-EDD05D28FE4C" />
         <Interface Name="Microsoft.Management.Configuration.IConfigurationUnitProcessorDetails2" InterfaceId="E89623ED-76E2-5145-B920-D09659554E35" />
         <Interface Name="Microsoft.Management.Configuration.IGetAllSettingsConfigurationUnitProcessor" InterfaceId="72EB8304-D8D3-57D4-9940-7C1C4AD8C40C" />
         <Interface Name="Microsoft.Management.Configuration.IConfigurationStatics2" InterfaceId="540BE073-F2EF-5375-83AA-8E23086B0669" />

src/Microsoft.Management.Configuration.Processor/Extensions/DictionaryExtensions.cs

@@ -0,0 +1,62 @@
+// -----------------------------------------------------------------------------
+// <copyright file="DictionaryExtensions.cs" company="Microsoft Corporation">
+//     Copyright (c) Microsoft Corporation. Licensed under the MIT License.
+// </copyright>
+// -----------------------------------------------------------------------------
+
+namespace Microsoft.Management.Configuration.Processor.Extensions
+{
+    using System;
+    using System.Collections;
+    using System.Collections.Generic;
+    using Windows.Foundation.Collections;
+
+    /// <summary>
+    /// Extensions for dictionaries.
+    /// </summary>
+    internal static class DictionaryExtensions
+    {
+        /// <summary>
+        /// Performs a deep compare of the dictionaries.
+        /// </summary>
+        /// <param name="first">First dictionary.</param>
+        /// <param name="second">Second dictionary.</param>
+        /// <returns>Whether the two dictionaries equal.</returns>
+        internal static bool ContentEquals(this IDictionary<string, string> first, IDictionary<string, string> second)
+        {
+            if (first.Count != second.Count)
+            {
+                return false;
+            }
+
+            foreach (var keyValuePair in first)
+            {
+                string key = keyValuePair.Key;
+                if (!second.ContainsKey(key))
+                {
+                    return false;
+                }
+
+                var firstValue = keyValuePair.Value;
+                var secondValue = second[key];
+
+                // Empty value check.
+                if (firstValue == null && secondValue == null)
+                {
+                    continue;
+                }
+                else if (firstValue == null || secondValue == null)
+                {
+                    return false;
+                }
+
+                if (firstValue != secondValue)
+                {
+                    return false;
+                }
+            }
+
+            return true;
+        }
+    }
+}

src/Microsoft.Management.Configuration.Processor/Extensions/ValueSetExtensions.cs

@@ -105,13 +105,14 @@ public static bool ContentEquals(this ValueSet first, ValueSet second)
 
             foreach (var keyValuePair in first)
             {
-                if (!second.ContainsKey(keyValuePair.Key))
+                string key = keyValuePair.Key;
+                if (!second.ContainsKey(key))
                 {
                     return false;
                 }
 
                 var firstValue = keyValuePair.Value;
-                var secondValue = second[keyValuePair.Key];
+                var secondValue = second[key];
 
                 // Empty value check.
                 if (firstValue == null && secondValue == null)

src/Microsoft.Management.Configuration.Processor/Set/ConfigurationSetProcessor.cs

@@ -217,9 +217,25 @@ private static bool IsUnitTypeResourceName(string? schemaVersion)
 
         private static bool ConfigurationUnitEquals(ConfigurationUnit first, ConfigurationUnit second)
         {
-            if (first.Identifier != second.Identifier ||
-                first.Type != second.Type ||
-                first.Intent != second.Intent)
+            var firstIdentifier = first.Identifier;
+            var firstIntent = first.Intent;
+            var firstType = first.Type;
+            var secondIdentifier = second.Identifier;
+            var secondType = second.Type;
+            var secondIntent = second.Intent;
+
+            if (firstIdentifier != secondIdentifier ||
+                firstType != secondType ||
+                firstIntent != secondIntent)
+            {
+                return false;
+            }
+
+            var firstEnvironment = first.Environment;
+            var secondEnvironment = second.Environment;
+            if (firstEnvironment.Context != secondEnvironment.Context ||
+                firstEnvironment.ProcessorIdentifier != secondEnvironment.ProcessorIdentifier ||
+                !firstEnvironment.ProcessorProperties.ContentEquals(secondEnvironment.ProcessorProperties))
             {
                 return false;
             }

src/Microsoft.Management.Configuration.UnitTests/Helpers/ConfigurationEnvironmentData.cs

@@ -0,0 +1,86 @@
+// -----------------------------------------------------------------------------
+// <copyright file="ConfigurationEnvironmentData.cs" company="Microsoft Corporation">
+//     Copyright (c) Microsoft Corporation. Licensed under the MIT License.
+// </copyright>
+// -----------------------------------------------------------------------------
+
+namespace Microsoft.Management.Configuration.UnitTests.Helpers
+{
+    using System;
+    using System.Collections.Generic;
+
+    /// <summary>
+    /// Contains the data defining a configuration environment.
+    /// </summary>
+    internal class ConfigurationEnvironmentData
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ConfigurationEnvironmentData"/> class.
+        /// </summary>
+        internal ConfigurationEnvironmentData() { }
+
+        /// <summary>
+        /// Gets or sets the security context.
+        /// </summary>
+        internal SecurityContext Context { get; set; } = SecurityContext.Current;
+
+        /// <summary>
+        /// Gets or sets the processor identifier.
+        /// </summary>
+        internal string ProcessorIdentifier { get; set; } = string.Empty;
+
+        /// <summary>
+        /// Gets or sets the processor properties.
+        /// </summary>
+        internal Dictionary<string, string> ProcessorProperties { get; set; } = new ();
+
+        /// <summary>
+        /// Applies this environment to the given unit.
+        /// </summary>
+        /// <param name="unit">The unit to apply to.</param>
+        /// <returns>The given unit.</returns>
+        internal ConfigurationUnit ApplyToUnit(ConfigurationUnit unit)
+        {
+            var environment = unit.Environment;
+
+            environment.Context = this.Context;
+            environment.ProcessorIdentifier = this.ProcessorIdentifier;
+            environment.ProcessorProperties.Clear();
+            foreach (var property in this.ProcessorProperties)
+            {
+                environment.ProcessorProperties.Add(property.Key, property.Value);
+            }
+
+            return unit;
+        }
+
+        /// <summary>
+        /// Tests whether the given properties match this object's properties.
+        /// </summary>
+        /// <param name="properties">The properties to test.</param>
+        /// <returns>True if the properties match; false if not.</returns>
+        internal bool PropertiesEqual(IReadOnlyDictionary<string, string> properties)
+        {
+            if (properties.Count != this.ProcessorProperties.Count)
+            {
+                return false;
+            }
+
+            foreach (var property in properties)
+            {
+                string? value = null;
+                if (!this.ProcessorProperties.TryGetValue(property.Key, out value))
+                {
+                    return false;
+                }
+
+                if (property.Value != value)
+                {
+                    return false;
+                }
+            }
+
+            return true;
+        }
+    }
+}

src/Microsoft.Management.Configuration.UnitTests/Helpers/ConfigurationExtensions.cs

@@ -1,4 +1,4 @@
-// -----------------------------------------------------------------------------
+// -----------------------------------------------------------------------------
 // <copyright file="ConfigurationExtensions.cs" company="Microsoft Corporation">
 //     Copyright (c) Microsoft Corporation. Licensed under the MIT License.
 // </copyright>