Convert Kudu custom script to PowerShell (#8315)

2025-04-05 17:08:47 +08:00 · 2020-02-07 03:15:46 +07:00 · 2020-02-07 03:15:46 +07:00 · e4ac0c02bc
commit e4ac0c02bc
parent ffaa98724a
6 changed files with 179 additions and 5 deletions
--- a/.deployment
+++ b/.deployment
@ -1,3 +1,23 @@
+; .deployment is actually an INI file and parsed by 
+; https://raw.githubusercontent.com/projectkudu/kudu/master/Kudu.Core/Infrastructure/IniFile.cs
+
+; Document of deployment with custom script
+; https://github.com/projectkudu/kudu/wiki/Customizing-deployments#deploying-with-custom-script
+
+; Document of configurable settings https://github.com/projectkudu/kudu/wiki/Configurable-settings
+; Runtime settings cannot be overrided in .deployment e.g. WEBSITE_NODE_DEFAULT_VERSION
+; More info https://github.com/projectkudu/kudu/wiki/Configurable-settings#runtime-settings
+
+; Define default Node.js version in WEBSITE_NODE_DEFAULT_VERSION App Setting
+; Find all Node.js versions from Kudu tool api/diagnostics/runtime
+
 [config]
-command = deploy.cmd
+COMMAND = PowerShell -NoProfile -NoLogo -ExecutionPolicy Unrestricted -Command "& "$(Join-Path -Path $(Get-Location) -ChildPath deploy.ps1)" 2>&1 | Write-Output"
 SCM_COMMAND_IDLE_TIMEOUT = 3600
+
+MSBUILD_PATH = D:\Program Files (x86)\MSBuild-15.9.21.664\MSBuild\MSBuild\15.0\Bin\MSBuild.exe
+PROJECT_PATH = Orchard.proj
+SOLUTION_PATH = src/Orchard.sln
+
+; You can define a custom environment variable as CUSTOM_VARIABLE = my custom variable value
+; and use in a deploy.ps1 script as $Env:CUSTOM_VARIABLE.
--- a/DeploymentUtility.psm1
+++ b/DeploymentUtility.psm1
@ -0,0 +1,33 @@
+Set-StrictMode -Version Latest
+$ErrorActionPreference = "Continue"
+
+function Invoke-ExternalCommand {
+    param (
+        [Parameter(Mandatory = $true)] [scriptblock] $ScriptBlock
+    )
+
+    # Displays an error message and continue executing if there is a standard error.
+    # This is because there are some external command tools write warning message to standard error. 
+    & $ScriptBlock 2>&1 
+
+    # If last exit code is not 0, throw an exception to stop a script
+    if ($LastExitCode) {
+        throw "Failed exitCode=$LastExitCode, command=$($ScriptBlock.ToString())"
+    }
+}
+
+function Write-EnviromentValue {
+    param (
+        [Parameter(Mandatory = $true)] [String[]] $EnvironmentName
+    )
+
+    "----------------- Begin of environment variables ---------------------------------"
+    Get-Item -Path Env:* | Where-Object { 
+        $EnvironmentName -contains $_.Name 
+    } | Format-Table Name, Value -Wrap
+
+    "----------------- End of environment variables ---------------------------------"
+}
+
+Export-ModuleMember -Function Invoke-ExternalCommand
+Export-ModuleMember -Function Write-EnviromentValue
--- a/deploy.ps1
+++ b/deploy.ps1
@ -0,0 +1,107 @@
+#https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/set-strictmode?view=powershell-7
+Set-StrictMode -Version Latest
+
+# https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_preference_variables?view=powershell-7#erroractionpreference
+$ErrorActionPreference = "Stop"
+
+Import-Module -Name .\DeploymentUtility
+
+"Verify if Node.js installed"
+if (-not (Get-Command -Name node -ErrorAction Ignore)) {
+    throw "Missing node.js executable, please install node.js." +
+    "If already installed, make sure it can be reached from the current Environment."
+}
+
+# Setup
+$ARTIFACTS = "$PSScriptRoot\..\artifacts"
+
+if (-not $Env:DEPLOYMENT_SOURCE) {
+    $Env:DEPLOYMENT_SOURCE = $PSScriptRoot
+}
+
+if (-not $Env:DEPLOYMENT_TARGET) {
+    $Env:DEPLOYMENT_TARGET = "$ARTIFACTS\wwwroot"
+}
+
+if (-not $Env:NEXT_MANIFEST_PATH) {
+    $Env:NEXT_MANIFEST_PATH = "$ARTIFACTS\manifest"
+
+    if (-not $Env:PREVIOUS_MANIFEST_PATH) {
+        $Env:PREVIOUS_MANIFEST_PATH = "$ARTIFACTS\manifest"
+    }
+}
+
+if (-not $Env:KUDU_SYNC_CMD) {
+    "Installing Kudu Sync"
+    Invoke-ExternalCommand -ScriptBlock { & npm install kudusync -g --silent }
+
+    # Locally just running "kuduSync" would also work
+    $Env:KUDU_SYNC_CMD = "$Env:AppData\npm\kuduSync.cmd"
+}
+
+# Log Environment variables
+$EnvironmentNameToWriteValue = @(
+    "DEPLOYMENT_SOURCE"
+    "DEPLOYMENT_TARGET"
+    "NEXT_MANIFEST_PATH"
+    "PREVIOUS_MANIFEST_PATH"
+    "KUDU_SYNC_CMD"
+    "WEBSITE_NODE_DEFAULT_VERSION"
+    "SCM_REPOSITORY_PATH"
+    "Path" 
+    "SOLUTION_PATH"
+    "PROJECT_PATH"
+    "MSBUILD_PATH"
+)
+Write-EnviromentValue -EnvironmentName $EnvironmentNameToWriteValue
+
+"Current node version: $(& node --version)"
+"Current npm version: $(& npm --version)"
+"Current MSBUILD version: $(& $Env:MSBUILD_PATH -version)"
+
+###########################################################
+# Deployment
+###########################################################
+
+"Handling .NET Web Application deployment."
+"Restore NuGet packages"
+"Current nuget version: $(nuget help | Select -First 1)"
+
+Invoke-ExternalCommand -ScriptBlock { 
+	& nuget restore "$Env:SOLUTION_PATH" -MSBuildPath "$(Split-Path -Path $Env:MSBUILD_PATH)"  
+}
+
+"Build .NET project to the temp directory"
+$preCompiledDir = "$Env:DEPLOYMENT_SOURCE\build\Precompiled"
+
+"Building with MSBUILD to '$preCompiledDir'" 
+Invoke-ExternalCommand -ScriptBlock { 
+    # https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild-command-line-reference?view=vs-2019
+    & "$Env:MSBUILD_PATH" `
+        "$Env:PROJECT_PATH" `
+        /t:Precompiled `
+        /verbosity:minimal `
+        /maxcpucount `
+        /nologo `
+        $Env:SCM_BUILD_ARGS
+    # Set SCM_BUILD_ARGS App Services Apps Settings to string you want to append to the msbuild command line.
+}
+
+"Kudu syncing" 
+Invoke-ExternalCommand -ScriptBlock { 
+    & "$Env:KUDU_SYNC_CMD" `
+        -v 50 `
+        -f "$preCompiledDir" `
+        -t "$Env:DEPLOYMENT_TARGET" `
+        -n "$Env:NEXT_MANIFEST_PATH" `
+        -p "$Env:PREVIOUS_MANIFEST_PATH" `
+        -i ".git;.hg;.deployment;deploy.cmd;deploy.ps1;node_modules;"
+}
+
+if ($Env:POST_DEPLOYMENT_ACTION) {
+    "Post deployment stub"
+    Invoke-ExternalCommand -ScriptBlock { & $Env:POST_DEPLOYMENT_ACTION }
+}
+
+"Deployment successfully"
+
--- a/src/Orchard.Web/Modules/Orchard.DynamicForms/Orchard.DynamicForms.csproj
+++ b/src/Orchard.Web/Modules/Orchard.DynamicForms/Orchard.DynamicForms.csproj
@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="12.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <Import Project="..\..\..\packages\Microsoft.TypeScript.MSBuild.3.7.4\build\Microsoft.TypeScript.MSBuild.props" Condition="Exists('..\..\..\packages\Microsoft.TypeScript.MSBuild.3.7.4\build\Microsoft.TypeScript.MSBuild.props')" />
  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
  <PropertyGroup>
    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
@ -27,6 +28,8 @@
    <UseGlobalApplicationHostFile />
    <TypeScriptToolsVersion>Latest</TypeScriptToolsVersion>
    <Use64BitIISExpress />
+    <NuGetPackageImportStamp>
+    </NuGetPackageImportStamp>
  </PropertyGroup>
  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
    <DebugSymbols>true</DebugSymbols>
@ -567,7 +570,6 @@
    <VSToolsPath Condition="'$(VSToolsPath)' == ''">$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)</VSToolsPath>
  </PropertyGroup>
  <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
-  <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\TypeScript\Microsoft.TypeScript.targets" Condition="Exists('$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\TypeScript\Microsoft.TypeScript.targets')" />
  <Import Project="$(VSToolsPath)\WebApplications\Microsoft.WebApplication.targets" Condition="'$(VSToolsPath)' != ''" />
  <Import Project="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v10.0\WebApplications\Microsoft.WebApplication.targets" Condition="false" />
  <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
@ -607,4 +609,12 @@
      </FlavorProperties>
    </VisualStudio>
  </ProjectExtensions>
+  <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
+    <PropertyGroup>
+      <ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
+    </PropertyGroup>
+    <Error Condition="!Exists('..\..\..\packages\Microsoft.TypeScript.MSBuild.3.7.4\build\Microsoft.TypeScript.MSBuild.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\..\packages\Microsoft.TypeScript.MSBuild.3.7.4\build\Microsoft.TypeScript.MSBuild.props'))" />
+    <Error Condition="!Exists('..\..\..\packages\Microsoft.TypeScript.MSBuild.3.7.4\build\Microsoft.TypeScript.MSBuild.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\..\packages\Microsoft.TypeScript.MSBuild.3.7.4\build\Microsoft.TypeScript.MSBuild.targets'))" />
+  </Target>
+  <Import Project="..\..\..\packages\Microsoft.TypeScript.MSBuild.3.7.4\build\Microsoft.TypeScript.MSBuild.targets" Condition="Exists('..\..\..\packages\Microsoft.TypeScript.MSBuild.3.7.4\build\Microsoft.TypeScript.MSBuild.targets')" />
 </Project>
--- a/src/Orchard.Web/Modules/Orchard.DynamicForms/packages.config
+++ b/src/Orchard.Web/Modules/Orchard.DynamicForms/packages.config
@ -4,6 +4,7 @@
  <package id="Microsoft.AspNet.Razor" version="3.2.3" targetFramework="net452" />
  <package id="Microsoft.AspNet.WebPages" version="3.2.3" targetFramework="net452" />
  <package id="Microsoft.CodeDom.Providers.DotNetCompilerPlatform" version="2.0.1" targetFramework="net452" />
+  <package id="Microsoft.TypeScript.MSBuild" version="3.7.4" targetFramework="net461" developmentDependency="true" />
  <package id="Microsoft.Web.Infrastructure" version="1.0.0.0" targetFramework="net452" />
  <package id="Newtonsoft.Json" version="12.0.2" targetFramework="net452" />
 </packages>
--- a/src/Orchard.sln
+++ b/src/Orchard.sln
@ -1,6 +1,6 @@
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 14
-VisualStudioVersion = 14.0.25420.1
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.29721.120
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Modules", "Modules", "{E9C9F120-07BA-4DFB-B9C3-3AFB9D44C9D5}"
 EndProject
@ -266,7 +266,10 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Orchard.Dashboards", "Orcha
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{DF3909B0-1DDD-4D8A-9919-56FC438E25E2}"
 	ProjectSection(SolutionItems) = preProject
+		..\.deployment = ..\.deployment
 		.editorconfig = .editorconfig
+		..\deploy.ps1 = ..\deploy.ps1
+		..\DeploymentUtility.psm1 = ..\DeploymentUtility.psm1
 		Rebracer.xml = Rebracer.xml
 		WebEssentials-Settings.json = WebEssentials-Settings.json
 	EndProjectSection
@ -1258,7 +1261,7 @@ Global
 		{8EE141BE-7217-4F5B-8214-3146BEFA07E3} = {E9C9F120-07BA-4DFB-B9C3-3AFB9D44C9D5}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
-		EnterpriseLibraryConfigurationToolBinariesPath = packages\TransientFaultHandling.Core.5.1.1209.1\lib\NET4
 		SolutionGuid = {3585D970-275B-4363-9F61-CD37CFC9DCD3}
+		EnterpriseLibraryConfigurationToolBinariesPath = packages\TransientFaultHandling.Core.5.1.1209.1\lib\NET4
 	EndGlobalSection
 EndGlobal