pulumi/sdk/dotnet/Pulumi/Serialization/ResourcePackages.cs

// Copyright 2016-2020, Pulumi Corporation

using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using System.Reflection;
using Semver;

namespace Pulumi
{
    internal static class ResourcePackages
    {
        private static readonly Lazy<ImmutableDictionary<string, ImmutableList<(string?, Type)>>> _resourceTypes
            = new Lazy<ImmutableDictionary<string, ImmutableList<(string?, Type)>>>(DiscoverResourceTypes);

        internal static bool TryConstruct(string type, string version, string urn, [NotNullWhen(true)] out Resource? resource)
        {
            if (!TryGetResourceType(type, version, out var resourceType))
            {
                resource = null;
                return false;
            }

            var urnParts = urn.Split("::");
            var urnName = urnParts[3];
            var constructorInfo = resourceType.GetConstructors().Single(c => c.GetParameters().Length == 3);

            var resourceOptions = typeof(CustomResource).IsAssignableFrom(resourceType) ?
                new CustomResourceOptions { Urn = urn } :
                (ResourceOptions)new ComponentResourceOptions { Urn = urn };

            resource = (Resource)constructorInfo.Invoke(new[] { urnName, (object?)null, resourceOptions });
            return true;
        }

        internal static bool TryGetResourceType(string name, string? version, [NotNullWhen(true)] out Type? type)
        {
            var minimalVersion = !string.IsNullOrEmpty(version) ? SemVersion.Parse(version, SemVersionStyles.Any) : new SemVersion(0);
            var yes = _resourceTypes.Value.TryGetValue(name, out var types);
            if (!yes)
            {
                type = null;
                return false;
            }

            var matches =
                    from vt in types
                    let resourceVersion = !string.IsNullOrEmpty(vt.Item1) ? SemVersion.Parse(vt.Item1, SemVersionStyles.Any) : minimalVersion
                    where resourceVersion >= minimalVersion
                    where (string.IsNullOrEmpty(version) || vt.Item1 == null || minimalVersion.Major == resourceVersion.Major)
                    orderby resourceVersion descending
                    select vt.Item2;

            type = matches.FirstOrDefault();
            return type != null;
        }

        private static ImmutableDictionary<string, ImmutableList<(string?, Type)>> DiscoverResourceTypes()
        {
            var pairs =
                from a in LoadReferencedAssemblies()
                where MayContainResourceTypes(a)
                from t in a.GetTypes()
                where typeof(Resource).IsAssignableFrom(t)
                let attr = t.GetCustomAttribute<ResourceTypeAttribute>()
                where attr != null
                let versionType = (attr.Version, t)
                group versionType by attr.Type into g
                select new { g.Key, Items = g };
            return pairs.ToImmutableDictionary(v => v.Key, v => v.Items.ToImmutableList());
        }

        // Assemblies are loaded on demand, so it could be that some assemblies aren't yet loaded to the current
        // app domain at the time of discovery. This method iterates through the list of referenced assemblies
        // recursively.
        // Note: If an assembly is referenced but its types are never used anywhere in the program, that reference
        // will be optimized out and won't appear in the result of the enumeration.
        private static IEnumerable<Assembly> LoadReferencedAssemblies()
        {
            var yieldedAssemblies = new HashSet<string>();
            var assembliesToCheck = new Queue<Assembly>();

            foreach (var assembly in AppDomain.CurrentDomain.GetAssemblies())
            {
                if (MayReferenceResourceTypes(assembly.GetName()))
                {
                    assembliesToCheck.Enqueue(assembly!);
                }
            }

            while (assembliesToCheck.Any())
            {
                var assemblyToCheck = assembliesToCheck.Dequeue();
                if (yieldedAssemblies.Contains(assemblyToCheck.FullName!))
                    continue;

                yieldedAssemblies.Add(assemblyToCheck.FullName!);
                yield return assemblyToCheck;

                foreach (var reference in assemblyToCheck.GetReferencedAssemblies())
                {
                    if (MayReferenceResourceTypes(reference))
                    {
                        var assembly = Assembly.Load(reference);
                        assembliesToCheck.Enqueue(assembly);
                    }
                }
            }
        }

        /// Helper to short-circuit checking assembly names that
        /// cannot refer to or reference assemblies with resource
        /// types in principle.
        private static bool MayReferenceResourceTypes(AssemblyName? assemblyName)
        {
            return assemblyName != null
                && !assemblyName.FullName.StartsWith("System", StringComparison.Ordinal)
                && assemblyName.ContentType != AssemblyContentType.WindowsRuntime;
        }

        /// Helper to short-circuit traversing assemblies that do not
        /// reference Pulumi.dll and cannot contain resource types in
        /// principle.
        private static bool MayContainResourceTypes(Assembly assembly)
        {
            return MayReferenceResourceTypes(assembly.GetName()) &&

                // NOTE: currently excluding dynamic assemblies to
                // aviod a race that makes pulumi/pulumi test suite
                // flaky. In this use case dynamic assemblies are
                // generated by Moq and Castle as part of testing. The
                // race is between these assemblies being added and
                // ResourceTypes being forced. In some cases we have a
                // spurios failure of a.GetTypes() throwing on a
                // dynamic assembly.
                //
                // It is not enirely clear yet there will be no use
                // cases where users define resources in dynamic
                // assemblies, so this may need to be revisited.
                !assembly.IsDynamic &&

                assembly.GetReferencedAssemblies().Any(a => a.Name == _pulumiAssemblyName);
        }

        private static readonly string _pulumiAssemblyName = typeof(Resource).Assembly.GetName().Name!;
    }
}