Add -WithSource to bicep publish (#23317)

* Add -WithSource to Publish-AzBicepModule

* Revert unintended changes

* Add back missing tests and fix merge error

* Fix test

* Remove quotes around version

* Update src/Resources/Resources/ChangeLog.md

---------

Co-authored-by: Stephen Weatherford <Stephen.Weatherford.com>
Co-authored-by: Beisi Zhou <[email protected]>

Author: StephenWeatherford

src/Resources/ResourceManager/Implementation/Bicep/PublishAzureBicepModuleCmdlet.cs

@@ -34,6 +34,9 @@ public class PublishAzureBicepModuleCmdlet : AzureRMCmdlet
         [Parameter(Mandatory = false, HelpMessage = "Documentation uri of the Bicep module.")]
         public string DocumentationUri { get; set; }
 
+        [Parameter(Mandatory = false, HelpMessage="[Experimental] Publish source code with the module.")]
+        public SwitchParameter WithSource { get; set; }
+
         [Parameter(Mandatory = false, HelpMessage="Overwrite existing published module.")]
         public SwitchParameter Force { get; set; }
 
@@ -42,7 +45,7 @@ public class PublishAzureBicepModuleCmdlet : AzureRMCmdlet
 
         public override void ExecuteCmdlet()
         {
-            BicepUtility.Create().PublishFile(this.TryResolvePath(this.FilePath), this.Target, this.DocumentationUri, this.Force.IsPresent, this.WriteVerbose, this.WriteWarning);
+            BicepUtility.Create().PublishFile(this.TryResolvePath(this.FilePath), this.Target, this.DocumentationUri, this.WithSource.IsPresent, this.Force.IsPresent, this.WriteVerbose, this.WriteWarning);
 
             if (this.PassThru.IsPresent)
             {

src/Resources/ResourceManager/Properties/Resources.Designer.cs

@@ -510,7 +510,7 @@ You can help us improve the accuracy of the result by opening an issue here: htt
     <value>Invalid Bicep file path.</value>
   </data>
   <data name="BicepVersionRequirement" xml:space="preserve">
-    <value>Please use bicep '{0}' or higher verison.</value>
+    <value>Please use bicep {0} or higher.</value>
   </data>
   <data name="BuildBicepFileToJsonFailed" xml:space="preserve">
     <value>Build bicep file '{0}' to json failed.</value>

src/Resources/ResourceManager/Properties/Resources.resx

@@ -55,6 +55,8 @@ public static BicepUtility Create()
 
         private const string MinimalVersionRequirementForBicepPublishWithOptionalForceParameter = "0.17.1";
 
+        private const string MinimalVersionRequirementForBicepPublishWithOptionalWithSourceParameter = "0.23.1";
+
         private const string MinimalVersionRequirementForBicepparamFileBuild = "0.16.1";
 
         private const string MinimalVersionRequirementForBicepparamFileBuildWithInlineOverrides = "0.22.6";
@@ -136,7 +138,7 @@ public BicepBuildParamsStdout BuildParams(string bicepParamFilePath, IReadOnlyDi
             return JsonConvert.DeserializeObject<BicepBuildParamsStdout>(stdout);
         }
 
-        public void PublishFile(string bicepFilePath, string target, string documentationUri = null, bool force = false, OutputCallback writeVerbose = null, OutputCallback writeWarning = null)
+        public void PublishFile(string bicepFilePath, string target, string documentationUri = null, bool withSource = false, bool force = false, OutputCallback writeVerbose = null, OutputCallback writeWarning = null)
         {
             if (!dataStore.FileExists(bicepFilePath))
             {
@@ -150,6 +152,12 @@ public void PublishFile(string bicepFilePath, string target, string documentatio
                 bicepPublishCommand += $" --documentationUri {GetQuotedFilePath(documentationUri)}";
             }
 
+            if (withSource)
+            {
+                CheckMinimalVersionRequirement(MinimalVersionRequirementForBicepPublishWithOptionalWithSourceParameter);
+                bicepPublishCommand += $" --with-source";
+            }
+
             if (force)
             {
                 CheckMinimalVersionRequirement(MinimalVersionRequirementForBicepPublishWithOptionalForceParameter);

src/Resources/ResourceManager/Utilities/BicepUtility.cs

@@ -106,7 +106,7 @@ public void BuildParams_fails_for_old_bicep_version()
             var bicepUtility = new BicepUtility(invokerMock.Object, dataStoreMock.Object);
 
             FluentActions.Invoking(() => bicepUtility.BuildParams("foo.bicepparam", new Dictionary<string, object>()))
-                .Should().Throw<AzPSApplicationException>().WithMessage("Please use bicep '0.16.1' or higher verison.");
+                .Should().Throw<AzPSApplicationException>().WithMessage("Please use bicep 0.16.1 or higher.");
         }
 
         [Fact]
@@ -141,5 +141,47 @@ public void BuildParams_fails_for_missing_param_file()
             FluentActions.Invoking(() => bicepUtility.BuildParams("foo.bicepparam", new Dictionary<string, object>()))
                 .Should().Throw<AzPSArgumentException>().WithMessage("Invalid Bicepparam file path.");
         }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void WithSource_adds_with_source_to_CLI()
+        {
+            var invokerMock = new Mock<IProcessInvoker>(MockBehavior.Strict);
+            invokerMock.Setup(x => x.Invoke(It.Is<ProcessInput>(p => p.Arguments == "-v")))
+                .Returns(new ProcessOutput { ExitCode = 0, Stderr = "", Stdout = "Bicep CLI version 0.23.1 (b02de2da48)" });
+            invokerMock.Setup(x => x.Invoke(It.Is<ProcessInput>(p => p.Arguments == "publish \"foo.bicep\" --target \"br:example.azurecr.io/hello/world:v1\" --with-source")))
+                .Returns(new ProcessOutput { ExitCode = 0, Stderr = "", Stdout = "" });
+
+            invokerMock.Setup(x => x.CheckExecutableExists("bicep"))
+                .Returns(true);
+
+            var dataStoreMock = new Mock<IDataStore>();
+            dataStoreMock.Setup(x => x.FileExists("foo.bicep"))
+                .Returns(true);
+
+            var bicepUtility = new BicepUtility(invokerMock.Object, dataStoreMock.Object);
+
+            bicepUtility.PublishFile("foo.bicep", "br:example.azurecr.io/hello/world:v1", null, withSource: true);
+        }
+
+        [Fact]
+        [Trait(Category.AcceptanceType, Category.CheckIn)]
+        public void WithSource_fails_for_old_bicep_version()
+        {
+            var invokerMock = new Mock<IProcessInvoker>(MockBehavior.Strict);
+            invokerMock.Setup(x => x.Invoke(It.Is<ProcessInput>(p => p.Arguments == "-v")))
+                .Returns(new ProcessOutput { ExitCode = 0, Stderr = "", Stdout = "Bicep CLI version 0.15.1 (d62b94db31)" });
+            invokerMock.Setup(x => x.CheckExecutableExists("bicep"))
+                .Returns(true);
+
+            var dataStoreMock = new Mock<IDataStore>();
+            dataStoreMock.Setup(x => x.FileExists("foo.bicep"))
+                .Returns(true);
+
+            var bicepUtility = new BicepUtility(invokerMock.Object, dataStoreMock.Object);
+
+            FluentActions.Invoking(() => bicepUtility.PublishFile("foo.bicep", "br:example.azurecr.io/hello/world:v1", null, withSource: true))
+                .Should().Throw<AzPSApplicationException>().WithMessage("Please use bicep 0.23.1 or higher.");
+        }
     }
 }

src/Resources/Resources.Test/UnitTests/Utilities/BicepUtilityTests.cs

@@ -19,6 +19,7 @@
 -->
 
 ## Upcoming Release
+* Added `-WithSource` parameter to `Publish-AzBicepModule` for publishing source with a module (currently experimental)
 * Supported nullable Bicep parameters in Deployment cmdlets
 
 ## Version 6.12.1

src/Resources/Resources/ChangeLog.md

@@ -13,8 +13,8 @@ Publishes a Bicep file to a registry.
 ## SYNTAX
 
 ```
-Publish-AzBicepModule -FilePath <String> -Target <String> [-DocumentationUri <String>] [-Force] [-PassThru]
- [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
+Publish-AzBicepModule -FilePath <String> -Target <String> [-DocumentationUri <String>] [-WithSource] [-Force]
+ [-PassThru] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -128,6 +128,21 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
+### -WithSource
+[Experimental] Publish source code with the module.
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Confirm
 Prompts you for confirmation before running the cmdlet.