Write bicep into modules based on scope hierarchy rather than user constructs

sdk/provisioning/Azure.Provisioning/Azure.Provisioning.sln

@@ -7,6 +7,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Provisioning", "src\A
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Provisioning.Tests", "tests\Azure.Provisioning.Tests.csproj", "{BC884FD9-0973-4FD2-A112-F285F041A3B2}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Azure.Core.TestFramework", "..\..\core\Azure.Core.TestFramework\src\Azure.Core.TestFramework.csproj", "{A93F6964-45B3-4F08-BB85-EBC3BAC40B72}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -21,6 +23,10 @@ Global
 		{BC884FD9-0973-4FD2-A112-F285F041A3B2}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{BC884FD9-0973-4FD2-A112-F285F041A3B2}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{BC884FD9-0973-4FD2-A112-F285F041A3B2}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A93F6964-45B3-4F08-BB85-EBC3BAC40B72}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A93F6964-45B3-4F08-BB85-EBC3BAC40B72}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A93F6964-45B3-4F08-BB85-EBC3BAC40B72}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A93F6964-45B3-4F08-BB85-EBC3BAC40B72}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

sdk/provisioning/Azure.Provisioning/api/Azure.Provisioning.net6.0.cs

@@ -60,7 +60,7 @@ public void Build(string? outputPath = null) { }
     }
     public partial class Output
     {
-        public Output(string name, string value, Azure.Provisioning.IConstruct source, bool isLiteral = false, bool isSecure = false) { }
+        internal Output() { }
         public bool IsLiteral { get { throw null; } }
         public bool IsSecure { get { throw null; } }
         public string Name { get { throw null; } }
@@ -116,7 +116,7 @@ namespace Azure.Provisioning.AppService
 {
     public partial class AppServicePlan : Azure.Provisioning.Resource<Azure.ResourceManager.AppService.AppServicePlanData>
     {
-        public AppServicePlan(Azure.Provisioning.IConstruct scope, string resourceName, string version = "2021-02-01", Azure.Core.AzureLocation? location = default(Azure.Core.AzureLocation?)) : base (default(Azure.Provisioning.IConstruct), default(Azure.Provisioning.Resource), default(string), default(Azure.Core.ResourceType), default(string), default(System.Func<string, Azure.ResourceManager.AppService.AppServicePlanData>)) { }
+        public AppServicePlan(Azure.Provisioning.IConstruct scope, string resourceName, string version = "2021-02-01", Azure.Core.AzureLocation? location = default(Azure.Core.AzureLocation?), Azure.Provisioning.ResourceManager.ResourceGroup? parent = null) : base (default(Azure.Provisioning.IConstruct), default(Azure.Provisioning.Resource), default(string), default(Azure.Core.ResourceType), default(string), default(System.Func<string, Azure.ResourceManager.AppService.AppServicePlanData>)) { }
         protected override Azure.Provisioning.Resource? FindParentInScope(Azure.Provisioning.IConstruct scope) { throw null; }
     }
     public static partial class AppServicesExtensions
@@ -125,7 +125,7 @@ public static partial class AppServicesExtensions
     }
     public partial class WebSite : Azure.Provisioning.Resource<Azure.ResourceManager.AppService.WebSiteData>
     {
-        public WebSite(Azure.Provisioning.IConstruct scope, string resourceName, Azure.Provisioning.AppService.AppServicePlan appServicePlan, Azure.Provisioning.AppService.WebSiteRuntime runtime, string runtimeVersion, string version = "2021-02-01", Azure.Core.AzureLocation? location = default(Azure.Core.AzureLocation?)) : base (default(Azure.Provisioning.IConstruct), default(Azure.Provisioning.Resource), default(string), default(Azure.Core.ResourceType), default(string), default(System.Func<string, Azure.ResourceManager.AppService.WebSiteData>)) { }
+        public WebSite(Azure.Provisioning.IConstruct scope, string resourceName, Azure.Provisioning.AppService.AppServicePlan appServicePlan, Azure.Provisioning.AppService.WebSiteRuntime runtime, string runtimeVersion, string version = "2021-02-01", Azure.Core.AzureLocation? location = default(Azure.Core.AzureLocation?), Azure.Provisioning.ResourceManager.ResourceGroup? parent = null) : base (default(Azure.Provisioning.IConstruct), default(Azure.Provisioning.Resource), default(string), default(Azure.Core.ResourceType), default(string), default(System.Func<string, Azure.ResourceManager.AppService.WebSiteData>)) { }
         public void AddApplicationSetting(string key, Azure.Provisioning.Parameter value) { }
         public void AddApplicationSetting(string key, string value) { }
         public void AddLogConfig(string resourceName) { }
@@ -170,7 +170,7 @@ namespace Azure.Provisioning.ResourceManager
 {
     public partial class ResourceGroup : Azure.Provisioning.Resource<Azure.ResourceManager.Resources.ResourceGroupData>
     {
-        public ResourceGroup(Azure.Provisioning.IConstruct scope, string name = "rg", string version = "2023-07-01", Azure.Core.AzureLocation? location = default(Azure.Core.AzureLocation?)) : base (default(Azure.Provisioning.IConstruct), default(Azure.Provisioning.Resource), default(string), default(Azure.Core.ResourceType), default(string), default(System.Func<string, Azure.ResourceManager.Resources.ResourceGroupData>)) { }
+        public ResourceGroup(Azure.Provisioning.IConstruct scope, string name = "rg", string version = "2023-07-01", Azure.Core.AzureLocation? location = default(Azure.Core.AzureLocation?), Azure.Provisioning.ResourceManager.Subscription? parent = null) : base (default(Azure.Provisioning.IConstruct), default(Azure.Provisioning.Resource), default(string), default(Azure.Core.ResourceType), default(string), default(System.Func<string, Azure.ResourceManager.Resources.ResourceGroupData>)) { }
         protected override Azure.Provisioning.Resource? FindParentInScope(Azure.Provisioning.IConstruct scope) { throw null; }
     }
     public static partial class ResourceManagerExtensions

sdk/provisioning/Azure.Provisioning/api/Azure.Provisioning.netstandard2.0.cs

@@ -60,7 +60,7 @@ public void Build(string? outputPath = null) { }
     }
     public partial class Output
     {
-        public Output(string name, string value, Azure.Provisioning.IConstruct source, bool isLiteral = false, bool isSecure = false) { }
+        internal Output() { }
         public bool IsLiteral { get { throw null; } }
         public bool IsSecure { get { throw null; } }
         public string Name { get { throw null; } }
@@ -116,7 +116,7 @@ namespace Azure.Provisioning.AppService
 {
     public partial class AppServicePlan : Azure.Provisioning.Resource<Azure.ResourceManager.AppService.AppServicePlanData>
     {
-        public AppServicePlan(Azure.Provisioning.IConstruct scope, string resourceName, string version = "2021-02-01", Azure.Core.AzureLocation? location = default(Azure.Core.AzureLocation?)) : base (default(Azure.Provisioning.IConstruct), default(Azure.Provisioning.Resource), default(string), default(Azure.Core.ResourceType), default(string), default(System.Func<string, Azure.ResourceManager.AppService.AppServicePlanData>)) { }
+        public AppServicePlan(Azure.Provisioning.IConstruct scope, string resourceName, string version = "2021-02-01", Azure.Core.AzureLocation? location = default(Azure.Core.AzureLocation?), Azure.Provisioning.ResourceManager.ResourceGroup? parent = null) : base (default(Azure.Provisioning.IConstruct), default(Azure.Provisioning.Resource), default(string), default(Azure.Core.ResourceType), default(string), default(System.Func<string, Azure.ResourceManager.AppService.AppServicePlanData>)) { }
         protected override Azure.Provisioning.Resource? FindParentInScope(Azure.Provisioning.IConstruct scope) { throw null; }
     }
     public static partial class AppServicesExtensions
@@ -125,7 +125,7 @@ public static partial class AppServicesExtensions
     }
     public partial class WebSite : Azure.Provisioning.Resource<Azure.ResourceManager.AppService.WebSiteData>
     {
-        public WebSite(Azure.Provisioning.IConstruct scope, string resourceName, Azure.Provisioning.AppService.AppServicePlan appServicePlan, Azure.Provisioning.AppService.WebSiteRuntime runtime, string runtimeVersion, string version = "2021-02-01", Azure.Core.AzureLocation? location = default(Azure.Core.AzureLocation?)) : base (default(Azure.Provisioning.IConstruct), default(Azure.Provisioning.Resource), default(string), default(Azure.Core.ResourceType), default(string), default(System.Func<string, Azure.ResourceManager.AppService.WebSiteData>)) { }
+        public WebSite(Azure.Provisioning.IConstruct scope, string resourceName, Azure.Provisioning.AppService.AppServicePlan appServicePlan, Azure.Provisioning.AppService.WebSiteRuntime runtime, string runtimeVersion, string version = "2021-02-01", Azure.Core.AzureLocation? location = default(Azure.Core.AzureLocation?), Azure.Provisioning.ResourceManager.ResourceGroup? parent = null) : base (default(Azure.Provisioning.IConstruct), default(Azure.Provisioning.Resource), default(string), default(Azure.Core.ResourceType), default(string), default(System.Func<string, Azure.ResourceManager.AppService.WebSiteData>)) { }
         public void AddApplicationSetting(string key, Azure.Provisioning.Parameter value) { }
         public void AddApplicationSetting(string key, string value) { }
         public void AddLogConfig(string resourceName) { }
@@ -170,7 +170,7 @@ namespace Azure.Provisioning.ResourceManager
 {
     public partial class ResourceGroup : Azure.Provisioning.Resource<Azure.ResourceManager.Resources.ResourceGroupData>
     {
-        public ResourceGroup(Azure.Provisioning.IConstruct scope, string name = "rg", string version = "2023-07-01", Azure.Core.AzureLocation? location = default(Azure.Core.AzureLocation?)) : base (default(Azure.Provisioning.IConstruct), default(Azure.Provisioning.Resource), default(string), default(Azure.Core.ResourceType), default(string), default(System.Func<string, Azure.ResourceManager.Resources.ResourceGroupData>)) { }
+        public ResourceGroup(Azure.Provisioning.IConstruct scope, string name = "rg", string version = "2023-07-01", Azure.Core.AzureLocation? location = default(Azure.Core.AzureLocation?), Azure.Provisioning.ResourceManager.Subscription? parent = null) : base (default(Azure.Provisioning.IConstruct), default(Azure.Provisioning.Resource), default(string), default(Azure.Core.ResourceType), default(string), default(System.Func<string, Azure.ResourceManager.Resources.ResourceGroupData>)) { }
         protected override Azure.Provisioning.Resource? FindParentInScope(Azure.Provisioning.IConstruct scope) { throw null; }
     }
     public static partial class ResourceManagerExtensions

sdk/provisioning/Azure.Provisioning/src/Construct.cs

@@ -50,6 +50,20 @@ public abstract class Construct : IConstruct, IPersistableModel<Construct>
         /// <param name="envName">The environment name to use.  If not passed in will try to load from AZURE_ENV_NAME environment variable.</param>
         /// <exception cref="ArgumentException"><paramref name="constructScope"/> is <see cref="ConstructScope.ResourceGroup"/> and <paramref name="scope"/> is null.</exception>
         protected Construct(IConstruct? scope, string name, ConstructScope constructScope = ConstructScope.ResourceGroup, Guid? tenantId = null, Guid? subscriptionId = null, string? envName = null)
+            : this(scope, name, constructScope, tenantId, subscriptionId, envName, null, null, null)
+        {
+        }
+
+        internal Construct(
+            IConstruct? scope,
+            string name,
+            ConstructScope constructScope,
+            Guid? tenantId = default,
+            Guid? subscriptionId = default,
+            string? envName = default,
+            Tenant? tenant = default,
+            Subscription? subscription = default,
+            ResourceGroup? resourceGroup = default)
         {
             if (scope is null && constructScope == ConstructScope.ResourceGroup)
             {
@@ -64,15 +78,15 @@ protected Construct(IConstruct? scope, string name, ConstructScope constructScop
             _constructs = new List<IConstruct>();
             _existingResources = new List<Resource>();
             Name = name;
-            Root = scope?.Root ?? new Tenant(this, tenantId);
+            Root = tenant ?? scope?.Root ?? new Tenant(this, tenantId);
             ConstructScope = constructScope;
             if (constructScope == ConstructScope.ResourceGroup)
             {
-                ResourceGroup = scope!.ResourceGroup ?? scope.GetOrAddResourceGroup();
+                ResourceGroup = resourceGroup ?? scope!.ResourceGroup ?? scope.GetOrAddResourceGroup();
             }
             if (constructScope == ConstructScope.Subscription)
             {
-                Subscription = scope is null ? this.GetOrCreateSubscription(subscriptionId) : scope.Subscription ?? scope.GetOrCreateSubscription(subscriptionId);
+                Subscription = subscription ?? (scope is null ? this.GetOrCreateSubscription(subscriptionId) : scope.Subscription ?? scope.GetOrCreateSubscription(subscriptionId));
             }
 
             _environmentName = envName;
@@ -103,7 +117,7 @@ public IEnumerable<Resource> GetResources(bool recursive = true)
             IEnumerable<Resource> result = _resources;
             if (recursive)
             {
-                result = result.Concat(GetConstructs(false).SelectMany(c => c.GetResources(false)));
+                result = result.Concat(GetConstructs(false).SelectMany(c => c.GetResources(true)));
             }
             return result;
         }
@@ -114,7 +128,7 @@ public IEnumerable<IConstruct> GetConstructs(bool recursive = true)
             IEnumerable<IConstruct> result = _constructs;
             if (recursive)
             {
-                result = result.Concat(GetConstructs(false).SelectMany(c => c.GetConstructs(false)));
+                result = result.Concat(GetConstructs(false).SelectMany(c => c.GetConstructs(true)));
             }
             return result;
         }
@@ -125,7 +139,7 @@ public IEnumerable<Parameter> GetParameters(bool recursive = true)
             IEnumerable<Parameter> result = _parameters;
             if (recursive)
             {
-                result = result.Concat(GetConstructs(false).SelectMany(c => c.GetParameters(false)));
+                result = result.Concat(GetResources(true).SelectMany(c => c.Parameters));
             }
             return result;
         }
@@ -136,7 +150,7 @@ public IEnumerable<Output> GetOutputs(bool recursive = true)
             IEnumerable<Output> result = _outputs;
             if (recursive)
             {
-                result = result.Concat(GetConstructs(false).SelectMany(c => c.GetOutputs(false)));
+                result = result.Concat(GetConstructs(false).SelectMany(c => c.GetOutputs(true)));
             }
             return result;
         }
@@ -167,7 +181,7 @@ public void AddOutput(Output output)
 
         private string GetScopeName()
         {
-            return ResourceGroup?.Name ?? Subscription?.Name ?? "tenant()";
+            return ResourceGroup?.Name ?? (Subscription != null ? $"subscription('{Subscription.Name}')" : "tenant()");
         }
 
         private BinaryData SerializeModuleReference(ModelReaderWriterOptions options)
@@ -244,7 +258,7 @@ private void WriteScopeLine(MemoryStream stream)
         {
             if (ConstructScope != ConstructScope.ResourceGroup)
             {
-                stream.WriteLine($"targetScope = {ConstructScope.ToString().ToCamelCase()}{Environment.NewLine}");
+                stream.WriteLine($"targetScope = '{ConstructScope.ToString().ToCamelCase()}'{Environment.NewLine}");
             }
         }
 

sdk/provisioning/Azure.Provisioning/src/Infrastructure.cs

@@ -2,9 +2,6 @@
 // Licensed under the MIT License.
 
 using System;
-using System.ClientModel.Primitives;
-using System.Collections.Generic;
-using System.IO;
 
 namespace Azure.Provisioning
 {
@@ -33,46 +30,9 @@ public Infrastructure(ConstructScope constructScope = ConstructScope.Subscriptio
         /// <param name="outputPath">Path to put the files.</param>
         public void Build(string? outputPath = null)
         {
-            outputPath ??= $".\\{GetType().Name}";
-            outputPath = Path.GetFullPath(outputPath);
+            var moduleInfrastructure = new ModuleInfrastructure(this);
 
-            WriteBicepFile(this, outputPath);
-
-            var queue = new Queue<IConstruct>();
-            queue.Enqueue(this);
-            WriteConstructsByLevel(queue, outputPath);
-        }
-
-        private void WriteConstructsByLevel(Queue<IConstruct> constructs, string outputPath)
-        {
-            while (constructs.Count > 0)
-            {
-                var construct = constructs.Dequeue();
-                foreach (var child in construct.GetConstructs(false))
-                {
-                    constructs.Enqueue(child);
-                }
-                WriteBicepFile(construct, outputPath);
-            }
-        }
-
-        private string GetFilePath(IConstruct construct, string outputPath)
-        {
-            string fileName = object.ReferenceEquals(construct, this) ? Path.Combine(outputPath, "main.bicep") : Path.Combine(outputPath, "resources", construct.Name, $"{construct.Name}.bicep");
-            Directory.CreateDirectory(Path.GetDirectoryName(fileName)!);
-            return fileName;
-        }
-
-        private void WriteBicepFile(IConstruct construct, string outputPath)
-        {
-            using var stream = new FileStream(GetFilePath(construct, outputPath), FileMode.Create);
-#if NET6_0_OR_GREATER
-            stream.Write(ModelReaderWriter.Write(construct, new ModelReaderWriterOptions("bicep")));
-#else
-            BinaryData data = ModelReaderWriter.Write(construct, new ModelReaderWriterOptions("bicep"));
-            var buffer = data.ToArray();
-            stream.Write(buffer, 0, buffer.Length);
-#endif
+            moduleInfrastructure.Write(outputPath);
         }
     }
 }

sdk/provisioning/Azure.Provisioning/src/ModuleConstruct.cs

@@ -0,0 +1,57 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using Azure.Provisioning.ResourceManager;
+
+namespace Azure.Provisioning
+{
+    internal class ModuleConstruct : Construct
+    {
+        public ModuleConstruct(ModuleResource resource)
+            : base(
+                resource.Scope,
+                resource.Resource is Subscription ? resource.Resource.Name : resource.Resource.Id.Name.Replace('-', '_'),
+                ResourceToConstructScope(resource.Resource),
+                tenant: GetTenant(resource.Resource),
+                subscription: GetSubscription(resource.Resource),
+                resourceGroup: resource.Resource as ResourceGroup)
+        {
+        }
+
+        public bool IsRoot { get; set; }
+
+        private static Tenant? GetTenant(Resource resource)
+        {
+            return resource switch
+            {
+                Tenant tenant => tenant,
+                Subscription sub => (Tenant) sub.Parent!,
+                ResourceGroup rg => (Tenant) rg.Parent!.Parent!,
+                _ => null,
+            };
+        }
+
+        private static Subscription? GetSubscription(Resource resource)
+        {
+            return resource switch
+            {
+                Subscription subscription => subscription,
+                ResourceGroup rg => (Subscription) rg.Parent!,
+                _ => null,
+            };
+        }
+
+        private static ConstructScope ResourceToConstructScope(Resource resource)
+        {
+            return resource switch
+            {
+                Tenant => ConstructScope.Tenant,
+                ResourceManager.Subscription => ConstructScope.Subscription,
+                //TODO managementgroup support
+                ResourceManager.ResourceGroup => ConstructScope.ResourceGroup,
+                _ => throw new InvalidOperationException(),
+            };
+        }
+    }
+}