[FEAT] - Centralized management of provider versions using bicepconfig.json

.editorconfig

@@ -36,5 +36,5 @@ dotnet_sort_system_directives_first = true
 
 # Expression-level preferences
 csharp_style_implicit_object_creation_when_type_is_apparent = true:warning
-# IDE0005: Using directive is unnecessary.
+# IDE0005: [Using directive is unnecessary](https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/ide0005) 
 dotnet_diagnostic.IDE0005.severity = suggestion

.vscode/settings.json

@@ -7,5 +7,17 @@
     "yaml.schemas": {
         "https://json.schemastore.org/github-workflow.json": "/.github/workflows/*.yml"
     },
-    "dotnet.defaultSolution": "Bicep.sln"
+    "dotnet.defaultSolution": "Bicep.sln",
+    "cSpell.words": [
+        "azureacr",
+        "bicepconfig",
+        "contoso",
+        "Decorable",
+        "Interpolable",
+        "Newtonsoft",
+        "outdir",
+        "outfile",
+        "outputdir",
+        "sarif"
+    ]
 }

src/Bicep.Cli.E2eTests/src/examples/providers.ff/bicepconfig.json

@@ -9,6 +9,7 @@
   },
   "experimentalFeaturesEnabled": {
     "extensibility": true,
+    "dynamicTypeLoading": true,
     "providerRegistry": true
   }
 }

src/Bicep.Cli.E2eTests/src/examples/providers.prod/bicepconfig.json

@@ -5,6 +5,7 @@
   },
   "experimentalFeaturesEnabled": {
     "extensibility": true,
+    "dynamicTypeLoading": true,
     "providerRegistry": true
   }
 }

src/Bicep.Cli.IntegrationTests/BuildCommandTests.cs

@@ -103,7 +103,7 @@ public async Task Build_Valid_SingleFile_WithTemplateSpecReference_ShouldSucceed
         [DataRow("br/mcr:az", true, LanguageConstants.BicepPublicMcrRegistry)]
         [DataRow("br:contoso.azurecr.io/bicep/providers/az", true, "contoso.azurecr.io")]
         // Negative
-        [DataRow("az", false)]
+        // [DataRow("az", false)] - commented out while we graciously deprecate the legacy provider declaration syntax.
         [DataRow("br:invalid.azureacr.io/bicep/providers/az", false)]
         [DataRow("br/unknown:az", false)]
         public async Task Build_Valid_SingleFile_WithProviderDeclarationStatement(
@@ -138,7 +138,7 @@ public async Task Build_Valid_SingleFile_WithTemplateSpecReference_ShouldSucceed
             var bicepFilePath = Path.Combine(tempDirectory, "main.bicep");
             File.WriteAllText(bicepFilePath, bicepFile);
 
-            var bicepConfigFile = $$"""
+            var bicepConfigFile = """
                 {
                     "providerAliases" : {
                         "br": {
@@ -392,7 +392,7 @@ public async Task Build_WithOutFile_ShouldSucceed()
         }
 
         [TestMethod]
-        public async Task Build_WithNonExistantOutDir_ShouldFail_WithExpectedErrorMessage()
+        public async Task Build_WithNonExistentOutDir_ShouldFail_WithExpectedErrorMessage()
         {
             var bicepPath = FileHelper.SaveResultFile(
                 TestContext,

src/Bicep.Cli/Commands/RestoreCommand.cs

@@ -24,7 +24,7 @@ public async Task<int> RunAsync(RestoreArguments args)
             var inputUri = ArgumentHelper.GetFileUri(args.InputFile);
 
             var compilation = compiler.CreateCompilationWithoutRestore(inputUri, markAllForRestore: args.ForceModulesRestore);
-            var restoreDiagnostics = await this.compiler.Restore(compilation, force: args.ForceModulesRestore);
+            var restoreDiagnostics = await this.compiler.Restore(compilation, forceArtifactRestore: args.ForceModulesRestore);
 
             var summary = diagnosticLogger.LogDiagnostics(DiagnosticOptions.Default, restoreDiagnostics);
 

src/Bicep.Core.IntegrationTests/CentralizedProviderVersionManagementTests.cs

@@ -0,0 +1,63 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Bicep.Core.UnitTests;
+using Bicep.Core.UnitTests.Utils;
+using FluentAssertions;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using Bicep.Core.UnitTests.Assertions;
+using Bicep.Core.Diagnostics;
+
+namespace Bicep.Core.IntegrationTests
+{
+    [TestClass]
+    public class CentralizedProviderVersionManagementTests : TestBase
+    {
+        private ServiceBuilder Services => new ServiceBuilder()
+            .WithFeatureOverrides(new(
+                ExtensibilityEnabled: true,
+                DynamicTypeLoadingEnabled: true,
+                MicrosoftGraphPreviewEnabled: true));
+
+        [TestMethod]
+        [DynamicData(nameof(ProvidersConfig_SupportForConfigManagedProviderDeclarationSyntax_When_ProviderIsBuiltIn_TestCases))]
+        public void ProvidersConfig_SupportForConfigManagedProviderDeclarationSyntax_When_ProviderIsBuiltIn(string providerIdentifier, bool shouldSucceed, (string code, DiagnosticLevel level, string message)[] expectedDiagnostics)
+        {
+            var result = CompilationHelper.Compile(Services, @$"
+                provider {providerIdentifier}
+            ");
+
+            if (shouldSucceed)
+            {
+                result.Should().NotHaveAnyDiagnostics();
+                return;
+            }
+            result.Should().HaveDiagnostics(expectedDiagnostics);
+        }
+
+        public static IEnumerable<object[]> ProvidersConfig_SupportForConfigManagedProviderDeclarationSyntax_When_ProviderIsBuiltIn_TestCases
+        {
+            get
+            {
+                (string, DiagnosticLevel, string)[] emptyDiagnostics = [];
+                yield return new object[] {
+                    "sys",
+                    true,
+                    emptyDiagnostics };
+                yield return new object[] {
+                    "microsoftGraph",
+                    true,
+                    emptyDiagnostics };
+                yield return new object[] {
+                    "az",
+                    true,
+                    emptyDiagnostics };
+                yield return new object[] {
+                    "kubernetes",
+                    false,
+                    new (string, DiagnosticLevel, string)[] {
+                     ("BCP206", DiagnosticLevel.Error, "Provider namespace \"kubernetes\" requires configuration, but none was provided.") } };
+            }
+        }
+    }
+}

src/Bicep.Core.IntegrationTests/DynamicAzTypesTests.cs

@@ -36,6 +36,28 @@ private async Task<ServiceBuilder> GetServices()
             return services;
         }
 
+        private async Task<ServiceBuilder> ServicesWithTestProviderArtifact(ArtifactRegistryAddress artifactRegistryAddress, BinaryData artifactPayload)
+        {
+            (var clientFactory, var blobClients) = RegistryUtils.CreateMockRegistryClients(artifactRegistryAddress.ClientDescriptor());
+
+            (_, var client) = blobClients.First();
+            var blobResult = await client.UploadBlobAsync(artifactPayload);
+            var manifest = BicepTestConstants.GetBicepProviderManifest(
+                            blobResult.Value.Digest,
+                            blobResult.Value.SizeInBytes);
+            await client.SetManifestAsync(manifest, artifactRegistryAddress.ProviderVersion);
+
+            var cacheRoot = FileHelper.GetUniqueTestOutputPath(TestContext);
+            Directory.CreateDirectory(cacheRoot);
+
+            return new ServiceBuilder()
+                .WithFeatureOverrides(new(
+                    ExtensibilityEnabled: true,
+                    DynamicTypeLoadingEnabled: true,
+                    CacheRootDirectory: cacheRoot))
+           .WithContainerRegistryClientFactory(clientFactory);
+        }
+
         [TestMethod]
         public async Task Az_namespace_can_be_used_without_configuration()
         {
@@ -79,11 +101,11 @@ public async Task Az_namespace_can_be_used_with_bicepconfig_provider_alias()
         {
             var services = await GetServices();
 
-            services = services.WithConfigurationPatch(c => c.WithProviderAlias($$"""
+            services = services.WithConfigurationPatch(c => c.WithProviderAlias("""
             {
                 "br": {
                     "customAlias": {
-                        "registry": "{{LanguageConstants.BicepPublicMcrRegistry}}",
+                        "registry": "mcr.microsoft.com",
                         "providerPath": "bicep/providers"
                     }
                 }
@@ -100,18 +122,41 @@ public async Task Az_namespace_can_be_used_with_bicepconfig_provider_alias()
 
         [TestMethod]
         public async Task Az_namespace_specified_using_legacy_declaration_syntax_yields_diagnostic()
+        {
+            var services = new ServiceBuilder()
+               .WithFeatureOverrides(new(ExtensibilityEnabled: true, DynamicTypeLoadingEnabled: true));
+
+            var result = await CompilationHelper.RestoreAndCompile(services, @$"
+            provider 'az@{BicepTestConstants.BuiltinAzProviderVersion}'
+            ");
+            result.Should().NotGenerateATemplate();
+            result.Should().HaveDiagnostics(
+                new[] {
+                ("BCP201", DiagnosticLevel.Error, """
+                Expected a provider specification string of with a valid format at this location. Valid formats:
+                * "br:<providerRegistryHost>/<providerRepositoryPath>@<providerVersion>"
+                * "br/<providerAlias>:<providerName>@<providerVersion>"
+                """),
+                ("BCP084", DiagnosticLevel.Error,
+                "The symbolic name \"az\" is reserved. Please use a different symbolic name. Reserved namespaces are \"az\", \"sys\".")
+            });
+        }
+
+        [TestMethod]
+        public async Task Inlined_Az_namespace_alias_is_not_specified_in_config_yields_diagnostic()
         {
             var services = new ServiceBuilder()
                .WithFeatureOverrides(new(ExtensibilityEnabled: true, DynamicTypeLoadingEnabled: true));
 
             var result = await CompilationHelper.RestoreAndCompile(services, @"
-            provider 'az@0.2.661'
+            provider 'br/notFound:az@0.2.661'
             ");
 
             result.Should().NotGenerateATemplate();
             result.Should().HaveDiagnostics(
                 new[] {
-                ("BCP304", DiagnosticLevel.Error, "Invalid provider specifier string. Specify a valid provider of format \"<providerName>@<providerVersion>\"."),
+                    ("BCP379", DiagnosticLevel.Error, "The OCI artifact provider alias name \"notFound\" does not exist in the built-in Bicep configuration."),
+                    ("BCP084", DiagnosticLevel.Error, "The symbolic name \"az\" is reserved. Please use a different symbolic name. Reserved namespaces are \"az\", \"sys\".")
             });
 
         }
@@ -155,36 +200,20 @@ public async Task Bicep_module_artifact_specified_in_provider_declaration_syntax
             string innerErrorMessage)
         {
             // ARRANGE
-            var testArtifact = new ArtifactRegistryAddress("biceptestdf.azurecr.io", "bicep/providers/az", "0.0.0-corruptpng");
-            (var clientFactory, var blobClients) = RegistryUtils.CreateMockRegistryClients(testArtifact.ClientDescriptor());
-
-            (_, var client) = blobClients.First();
-            var blobResult = await client.UploadBlobAsync(payload);
-            var manifest = BicepTestConstants.GetBicepProviderManifest(
-                            blobResult.Value.Digest,
-                            blobResult.Value.SizeInBytes);
-            await client.SetManifestAsync(manifest, testArtifact.ProviderVersion);
+            var testArtifactAddress = new ArtifactRegistryAddress("biceptestdf.azurecr.io", "bicep/providers/az", "0.0.0-corruptpng");
 
-            var cacheRoot = FileHelper.GetUniqueTestOutputPath(TestContext);
-            Directory.CreateDirectory(cacheRoot);
-
-            var services = new ServiceBuilder()
-                .WithFeatureOverrides(new(
-                    ExtensibilityEnabled: true,
-                    DynamicTypeLoadingEnabled: true,
-                    CacheRootDirectory: cacheRoot))
-           .WithContainerRegistryClientFactory(clientFactory);
+            var services = await ServicesWithTestProviderArtifact(testArtifactAddress, payload);
 
             // ACT
             var result = await CompilationHelper.RestoreAndCompile(services, @$"
-            provider '{testArtifact.ToSpecificationString('@')}'
+            provider '{testArtifactAddress.ToSpecificationString('@')}'
             ");
 
             // ASSERT
             result.Should().NotGenerateATemplate();
             result.Should().HaveDiagnostics(new[]
             {
-                ("BCP192", DiagnosticLevel.Error, $"Unable to restore the artifact with reference \"{testArtifact.ToSpecificationString(':')}\": The OCI artifact is not a valid Bicep artifact. {innerErrorMessage}"),
+                ("BCP192", DiagnosticLevel.Error, $"Unable to restore the artifact with reference \"{testArtifactAddress.ToSpecificationString(':')}\": The OCI artifact is not a valid Bicep artifact. {innerErrorMessage}"),
                 ("BCP084", DiagnosticLevel.Error, "The symbolic name \"az\" is reserved. Please use a different symbolic name. Reserved namespaces are \"az\", \"sys\".")
             });
 
@@ -298,5 +327,77 @@ public static IEnumerable<object[]> ArtifactRegistryCorruptedPackageNegativeTest
                 "Value cannot be null. (Parameter 'source')"
             };
         }
+
+        [TestMethod]
+        public async Task External_Az_namespace_can_be_loaded_from_configuration()
+        {
+            var services = await GetServices();
+            // Built-In Config contains the following entry:
+            // {
+            //   "implicitProviders": ["az"]
+            // }
+            services = services.WithConfigurationPatch(c => c.WithProvidersConfiguration($$"""
+            {
+                "az": {
+                    "source": "{{LanguageConstants.BicepPublicMcrRegistry}}/bicep/providers/az",
+                    "version": "{{BicepTestConstants.BuiltinAzProviderVersion}}"
+                }
+            }
+            """));
+            var result = await CompilationHelper.RestoreAndCompile(services, ("main.bicep", @$"
+            provider az
+            "));
+
+            result.Should().GenerateATemplate();
+        }
+
+        [TestMethod]
+        public async Task BuiltIn_Az_namespace_can_be_loaded_from_configuration()
+        {
+            var services = await GetServices();
+            // Built-In Config contains the following entries:
+            // {
+            //   "providers": {
+            //     "az": {
+            //       "builtIn": true
+            //     }
+            //   },
+            //   "implicitProviders": ["az"]
+            // }
+            var result = await CompilationHelper.RestoreAndCompile(services, ("main.bicep", @$"
+            provider az
+            "));
+
+            result.Should().GenerateATemplate();
+        }
+
+        [TestMethod]
+        public async Task Az_namespace_can_be_loaded_dynamically_using_provider_configuration()
+        {
+            //ARRANGE
+            var artifactRegistryAddress = new ArtifactRegistryAddress(
+                "fake.azurecr.io",
+                "fake/path/az",
+                "1.0.0-fake");
+            var services = await ServicesWithTestProviderArtifact(
+                artifactRegistryAddress,
+                ThirdPartyTypeHelper.GetTypesTgzBytesFromFiles(("index.json", """{"resources": {}, "resourceFunctions": {}}""")));
+            services = services.WithConfigurationPatch(c => c.WithProvidersConfiguration($$"""
+            {
+                "az": {
+                    "source": "{{artifactRegistryAddress.RegistryAddress}}/{{artifactRegistryAddress.RepositoryPath}}",
+                    "version": "{{artifactRegistryAddress.ProviderVersion}}"
+                }
+            }
+            """));
+            //ACT
+            var result = await CompilationHelper.RestoreAndCompile(services, ("main.bicep", @$"
+            provider az
+            "));
+            //ASSERT
+            result.Should().GenerateATemplate();
+            result.Template.Should().NotBeNull();
+            result.Template.Should().HaveValueAtPath("$.imports.az.version", artifactRegistryAddress.ProviderVersion);
+        }
     }
 }

src/Bicep.Core.IntegrationTests/ExamplesTests.cs

@@ -39,7 +39,7 @@ private async Task RunExampleTest(EmbeddedFile embeddedBicep, FeatureProviderOve
             {
                 DiagnosticAssertions.DoWithDiagnosticAnnotations(
                     file,
-                    diagnostics.Where(x => !IsPermittedMissingTypeDiagnostic(x)),
+                    diagnostics.Where(d => !IsPermittedMissingTypeDiagnostic(d)).Where(d => !d.Code.Equals("BCP395")),
                     diagnostics =>
                     {
                         diagnostics.Should().BeEmpty("{0} should not have warnings or errors", file.FileUri.LocalPath);