Merge pull request #5491 from markcowl/cmp-managed

Update module PSM1 creation tools to skip modules with a pre-created …

Author: markcowl

src/ResourceManager/Compute.ManagedService/AzureRM.Compute.ManagedService.psd1

@@ -9,7 +9,7 @@
 @{
 
 # Script module or binary module file associated with this manifest.
-RootModule = '.\ConvertTo-AzureRmVhd.psm1'
+RootModule = '.\AzureRM.Compute.ManagedService.psm1'
 
 # Version number of this module.
 ModuleVersion = '0.1.0'
@@ -66,13 +66,13 @@ TypesToProcess = @()
 FormatsToProcess = @()
 
 # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
-NestedModules = @('.\Microsoft.Azure.Commands.Compute.ManagedService.dll')
+NestedModules = @()
 
 # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
-FunctionsToExport = @()
+FunctionsToExport = 'ConvertTo-AzureRmVhd'
 
 # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
-CmdletsToExport = @('ConvertTo-AzureRmVhd')
+CmdletsToExport = 'ConvertTo-AzureRmVhd'
 
 # Variables to export from this module
 # VariablesToExport = @()

src/ResourceManager/Compute.ManagedService/Commands.Compute.ManagedService/ConvertTo-AzureRmVhd.psm1 renamed to src/ResourceManager/Compute.ManagedService/Commands.Compute.ManagedService/AzureRM.Compute.ManagedService.psm1

@@ -12,10 +12,10 @@ This module requires Hyper-V version 1.1. Please follow the instructions below t
 1) https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v
 2) https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/get-started/install-the-hyper-v-role-on-windows-server
 "@;
-    Write-Error $instructions -ErrorAction Stop;
+    Write-Error $instructions -ErrorAction Stop
 }
 else
 {
-    . $PSScriptRoot\Tools\ConvertTo-AzureRmVhd.ps1;
+    Import-Module Hyper-V -MinimumVersion 1.1 -Scope Global
+	. $PSScriptRoot\Tools\ConvertTo-AzureRmVhd.ps1
 }
-

src/ResourceManager/Compute.ManagedService/Commands.Compute.ManagedService/Commands.Compute.ManagedService.csproj

@@ -96,17 +96,13 @@
       <Project>{3819d8a7-c62c-4c47-8ddd-0332d9ce1252}</Project>
       <Name>Commands.ResourceManager.Common</Name>
     </ProjectReference>
-    <ProjectReference Include="..\..\Compute\Commands.Compute\Commands.Compute.csproj">
-      <Project>{52643bd5-6378-49bd-9f6e-dac9dd8a867b}</Project>
-      <Name>Commands.Compute</Name>
-    </ProjectReference>
   </ItemGroup>
   <ItemGroup>
     <None Include="..\AzureRM.Compute.ManagedService.psd1">
       <Link>AzureRM.Compute.ManagedService.psd1</Link>
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
-    <None Include="ConvertTo-AzureRmVhd.psm1">
+    <None Include="AzureRM.Compute.ManagedService.psm1">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
     <None Include="Tools\ConvertTo-AzureRmVhd.ps1">

src/ResourceManager/Compute.ManagedService/Commands.Compute.ManagedService/Tools/ConvertTo-AzureRmVhd.ps1

@@ -38,22 +38,6 @@ function ConvertTo-AzureRmVhd
         [switch]$AsJob
     )
 
-    $module = Get-Module Hyper-V;
-    if ($module -ne $null -and $module.Version.ToString().CompareTo("1.1") -lt 0)
-    {
-        $instructions =
-@"
-This module requires Hyper-V version 1.1. Please follow the instructions below to enable Hyper-V on your Windows System:
-1) https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v
-2) https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/get-started/install-the-hyper-v-role-on-windows-server
-"@;
-        Write-Error $instructions -ErrorAction Stop;
-    }
-    elseif ($module -eq $null)
-    {
-        Import-Module Hyper-V -MinimumVersion 1.1 -Scope Global;
-    }
-
     if ($AsJob)
     {
         Start-Job -ScriptBlock ${function:ExecuteCmdlet} -Argumentlist $HyperVVMName,$ExportPath,$HyperVServer,$Force;
@@ -158,7 +142,7 @@ function ExecuteCmdlet($HyperVVMName, $ExportPath, $HyperVServer, $Force)
         }
     }
 
-    if ($PSCmdlet.ShouldProcess($Name, "Converting a Hyper-V VM to Azure supported VHD file(s)..."))
+    if ($PSCmdlet.ShouldProcess($HyperVVMName, "Converting a Hyper-V VM to Azure supported VHD file(s)..."))
     {
         $vhdFiles = Export-DiskFiles $HyperVServer $HyperVVMName $ExportPath;
 

tools/PublishModules.ps1

@@ -160,6 +160,16 @@ function Update-NugetPackage
     }
 }
 
+<#
+.DESCRIPTION
+Creates a module Nuget Package with correct Nuget metadata and module manifest metadata in two parts.
+Part 1: Uses Publish-Module to create a .nupkg file with the correct metadata for module installation, 
+Part 2: Updates the package contents to make module suitable for Import inside PowerShell.
+In part 1, psd1 dependencies are used to determine the dependencies in the Nuget package
+In part 2, Alters psd1 settings to allow fine-grained control of assembly loading when module is imported 
+through a generated psm1 file. If a module manifest already has a psm1 module definition in its RootModule property
+then the Part 2 processing is skipped.
+#>
 function Change-RMModule 
 {
     [CmdletBinding()]
@@ -179,6 +189,11 @@ function Change-RMModule
         $file = Get-Item $moduleSourcePath
         Import-LocalizedData -BindingVariable ModuleMetadata -BaseDirectory $file.DirectoryName -FileName $file.Name
         $toss = Publish-Module -Path $Path -Repository $TempRepo -Force
+        # Create a psm1 and alter psd1 dependencies to allow fine-grained control over assembly loading.  Opt out by definitng a RootModule.
+        if ($ModuleMetadata.RootModule)
+        {
+            return
+        }
         Write-Output "Changing to directory for module modifications $TempRepoPath"
         $moduleVersion = $ModuleMetadata.ModuleVersion.ToString()
         if ($ModuleMetadata.PrivateData.PSData.Prerelease -ne $null)
@@ -189,25 +204,25 @@ function Change-RMModule
         pushd $TempRepoPath
         try
         {
-          $nupkgPath = Join-Path -Path . -ChildPath ($moduleName + "." + $moduleVersion + ".nupkg")
-          $zipPath = Join-Path -Path . -ChildPath ($moduleName + "." + $moduleVersion + ".zip")
-          $dirPath = Join-Path -Path . -ChildPath $moduleName
-          $unzippedManifest = Join-Path -Path $dirPath -ChildPath ($moduleName + ".psd1")
-
-          if (!(Test-Path -Path $nupkgPath))
-          {
-              throw "Module at $nupkgPath in $TempRepoPath does not exist"
-          }
-          Write-Output "Renaming package $nupkgPath to zip archive $zipPath"
-          ren $nupkgPath $zipPath
-          Write-Output "Expanding $zipPath"
-          Expand-Archive $zipPath -DestinationPath $dirPath
-          Write-Output "Adding PSM1 dependency to $unzippedManifest"
-          Write-Output "Removing module manifest dependencies for $unzippedManifest"
-          Remove-ModuleDependencies -Path $unzippedManifest
-          Remove-Item -Path $zipPath -Force
-          Write-Output "Repackaging $dirPath"
-          Update-NugetPackage -BasePath $TempRepoPath -ModuleName $moduleName -DirPath $dirPath -NugetExe $NugetExe
+            $nupkgPath = Join-Path -Path . -ChildPath ($moduleName + "." + $moduleVersion + ".nupkg")
+            $zipPath = Join-Path -Path . -ChildPath ($moduleName + "." + $moduleVersion + ".zip")
+            $dirPath = Join-Path -Path . -ChildPath $moduleName
+            $unzippedManifest = Join-Path -Path $dirPath -ChildPath ($moduleName + ".psd1")
+
+            if (!(Test-Path -Path $nupkgPath))
+            {
+                throw "Module at $nupkgPath in $TempRepoPath does not exist"
+            }
+            Write-Output "Renaming package $nupkgPath to zip archive $zipPath"
+            ren $nupkgPath $zipPath
+            Write-Output "Expanding $zipPath"
+            Expand-Archive $zipPath -DestinationPath $dirPath
+            Write-Output "Adding PSM1 dependency to $unzippedManifest"
+            Write-Output "Removing module manifest dependencies for $unzippedManifest"
+            Remove-ModuleDependencies -Path $unzippedManifest
+            Remove-Item -Path $zipPath -Force
+            Write-Output "Repackaging $dirPath"
+            Update-NugetPackage -BasePath $TempRepoPath -ModuleName $moduleName -DirPath $dirPath -NugetExe $NugetExe
         }
         finally 
         {

tools/UpdateModules.ps1

@@ -37,6 +37,12 @@ function Create-ModulePsm1
      $manifestPath = Join-Path -Path $ModulePath -ChildPath $moduleName
      $file = Get-Item $manifestPath
      Import-LocalizedData -BindingVariable ModuleMetadata -BaseDirectory $file.DirectoryName -FileName $file.Name
+     if ($ModuleMetadata.RootModule)
+     {
+         # Do not create a psm1 file if the RootModule dependency already has one.
+         return
+     }
+     
      $templateOutputPath = $manifestPath -replace ".psd1", ".psm1"
      [string]$importedModules
      if ($ModuleMetadata.RequiredModules -ne $null)