File: DependencyProviderTests.cs
Web Access
Project: ..\..\..\test\Microsoft.DotNet.Cli.Utils.Tests\Microsoft.DotNet.Cli.Utils.Tests.csproj (Microsoft.DotNet.Cli.Utils.Tests)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
#nullable disable
 
using Microsoft.Win32;
 
namespace Microsoft.DotNet.Cli.Utils.Tests
{
#pragma warning disable CA1416
    public class DependencyProviderTests
    {
        [WindowsOnlyTheory]
        [InlineData(false, "NET.CORE.SDK,v6.0", @"SOFTWARE\Classes\Installer\Dependencies\NET.CORE.SDK,v6.0\Dependents", "HKEY_CURRENT_USER")]
        [InlineData(true, "NET.CORE.SDK,v6.0", @"SOFTWARE\Classes\Installer\Dependencies\NET.CORE.SDK,v6.0\Dependents", "HKEY_LOCAL_MACHINE")]
        public void ProviderProperties(bool allUsers, string providerKeyName, string expectedDependentsKeyPath, string expectedBaseKeyName)
        {
            DependencyProvider dep = new(providerKeyName, allUsers);
 
            Assert.Equal(expectedDependentsKeyPath, dep.DependentsKeyPath);
            Assert.Equal(expectedBaseKeyName, dep.BaseKey.Name);
            Assert.Equal(providerKeyName, dep.ProviderKeyName);
        }
 
        [WindowsOnlyFact]
        public void ItCanAddDependents()
        {
            // We cannot create per-machine entries unless the tests run elevated. The results are the
            // the same, it's only the base key that's different
            DependencyProvider dep = new(".NET_SDK_TEST_PROVIDER_KEY", allUsers: false);
 
            try
            {
                // We should not have any dependents
                Assert.Empty(dep.Dependents);
 
                dep.AddDependent("Microsoft.NET.SDK,v6.0.100");
 
                Assert.Single(dep.Dependents);
                Assert.Equal("Microsoft.NET.SDK,v6.0.100", dep.Dependents.First());
            }
            finally
            {
                DeleteProviderKey(dep);
            }
        }
 
        [WindowsOnlyFact]
        public void ItCanFindVisualStudioDependents()
        {
            DependencyProvider dep = new(".NET_SDK_TEST_PROVIDER_KEY", allUsers: false);
 
            try
            {
                // We should not have any dependents
                Assert.Empty(dep.Dependents);
 
                // Write the VS dependents key
                dep.AddDependent(DependencyProvider.VisualStudioDependentKeyName);
 
                Assert.True(dep.HasVisualStudioDependency);
            }
            finally
            {
                DeleteProviderKey(dep);
            }
        }
 
        [WindowsOnlyFact]
        public void ItWillNotRemoveTheProviderIfOtherDependentsExist()
        {
            DependencyProvider dep = new(".NET_SDK_TEST_PROVIDER_KEY", allUsers: false);
 
            try
            {
                // Write multiple dependents
                dep.AddDependent(DependencyProvider.VisualStudioDependentKeyName);
                dep.AddDependent("Microsoft.NET.SDK,v6.0.100");
 
                Assert.Equal(2, dep.Dependents.Count());
 
                dep.RemoveDependent("Microsoft.NET.SDK,v6.0.100", removeProvider: true);
 
                Assert.True(dep.HasVisualStudioDependency);
            }
            finally
            {
                DeleteProviderKey(dep);
            }
        }
 
        [WindowsOnlyFact]
        public void ItReturnsNullIfProductCodeDoesNotExist()
        {
            string providerKeyName = "Microsoft.NET.Test.Pack";
            DependencyProvider dep = new(providerKeyName, allUsers: false);
            using RegistryKey providerKey = Registry.CurrentUser.CreateSubKey(Path.Combine(DependencyProvider.DependenciesKeyRelativePath, providerKeyName), writable: true);
 
            try
            {
                Assert.Null(dep.ProductCode);
            }
            finally
            {
                DeleteProviderKey(dep);
            }
        }
 
        [WindowsOnlyFact]
        public void ItCanRetrieveTheProductCodeFromTheProviderKey()
        {
            string providerKeyName = "Microsoft.NET.Test.Pack";
            DependencyProvider dep = new(providerKeyName, allUsers: false);
            using RegistryKey providerKey = Registry.CurrentUser.CreateSubKey(Path.Combine(DependencyProvider.DependenciesKeyRelativePath, providerKeyName), writable: true);
            string productCode = Guid.NewGuid().ToString("B");
            providerKey?.SetValue(null, productCode);
 
            try
            {
                Assert.Equal(productCode, dep.ProductCode);
            }
            finally
            {
                DeleteProviderKey(dep);
            }
        }
 
        private void DeleteProviderKey(DependencyProvider dep)
        {
            using RegistryKey providerKey = dep.BaseKey.OpenSubKey(DependencyProvider.DependenciesKeyRelativePath, writable: true);
            providerKey?.DeleteSubKeyTree(dep.ProviderKeyName);
        }
    }
#pragma warning restore CA1416
}