I mindre ASP.NET applikationer har jeg altid brugt en eller anden form for script i forbindelse med deloyment (i større applikationer benyttes TFS, buildserver eller lign.). Tidligere har jeg enten brugt et standard batch (.bat) script eller et WSH (windows script host) script, men efter at Windows Powershell er dukket op er jeg begyndt at bruge det en del. Jeg har dog en fornemmelse af at der ikke er mange udviklere som kender til mulighederne med Powershell - bla i forbindelse med deployment, og derfor syntes jeg det var på sin plads at skrive lidt om deployment med Powershell.
Vi kan tage udgangspunkt i deployment af et simpelt site som du kan finde i zippet form tilknyttet dette indlæg. Ideen er at skabe et Powershell script som foretager følgende:
- Opretter eller tømmer en midlertidig mappe under c:\temp som bruges som midlertidig opbevaringsmappe for applikationen
- Foretager en kompilering med aspnet_compiler (prekompilering), og placerer resultatet i den førnævnte mappe
- Sletter mapper og filer man ikke ønsker skal deployes (eksempelvis intern dokumentation, debug-filer mv). I eksemplet findes der under sitet en Temp-mappe der bla indeholder Powershell-scriptet, og den mappe skal ikke med til produktions- eller testserveren.
- Tilretter web.config således, at debug sætter til false (egentlig ikke nødvendigt ved en prekompilering - men det er blot for eksemples skyld), og appsettings og connectionsstrings tilrettes. Tilretning af connectionsstring(s) er vigtigt fordi det i et script skal være muligt at tilrette en connectionsstring til at ramme en produktions- eller test database. Tilretning af AppSettings kunne eksempelvis bruges til at angive en deployment dato (som dette script), opskrive et versionsnummer eller lign.
- Sletter filer og mapper i den mappe som i IIS er sat op til at være applikationsmappe
- Kopierer filer og mapper fra den midlertidige mappe (herunder den tilrettede web.config) til IIS mappen. I de fleste situationer kræver dette enten en VPN eller FTP forbindelse til serveren, men her kopieres blot til en mappe på c:\.
Her er et Powershell-script som udfører de forskellige steps:
$source_sti = "C:\temp\pstest"
$deploy_sti = "c:\temp\deploy"
$prod_sti = "c:\tempiis"
$compiler_sti = "c:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\aspnet_compiler.exe"
$virtualpath = "\pstest"
clear;
if( [System.IO.Directory]::Exists( $deploy_sti ) )
{
write-host "Sletter filer og mapper i "$deploy_sti;
Remove-Item $deploy_sti\* -recurse -force -confirm;
}
else
{
write-host "Opretter "$deploy_sti;
$null=mkdir "$deploy_sti";
}
write-host "Påbegynder kompilering med aspnet_compiler";
&$compiler_sti -nologo -v $virtualpath -p $source_sti -f -c $deploy_sti;
write-host "Sletter uønskede filer og mapper i "$deploy_sti;
rmdir "$deploy_sti\temp" -force -recurse -confirm;
remove-item $deploy_sti\uønsketfil.txt -confirm;
$webConfigFilePath = $deploy_sti+"\web.config";
write-host "Foretager rettelser i "$webConfigFilePath;
[System.Xml.XmlDocument]$doc = new-object System.Xml.XmlDocument;
$doc.Load($webConfigFilePath);
$root = $doc.get_DocumentElement();
write-host "Sætter debug=false";
$root."system.web".compilation.debug = "false";
write-host "Retter connectionstrings";
write-host "";
$cnstr = @{ 'cnstring'='cnstring sat af Powershell';};
$cnstr;
foreach($navn in $cnstr.Keys)
{
foreach($item in $root.connectionStrings.add )
{
if( $item.name -eq $navn )
{
$item.connectionString = $cnstr[$navn];
}
}
}
write-host "";
write-host "Retter app.settings";
$d=get-date;
$appsettings = @{ 'app1'='Sat fra Powershell';`
'deploymentdato'=$d.tostring("F") };
$appsettings;
foreach($navn in $appsettings.Keys)
{
foreach($item in $root.appSettings.add )
{
if( $item.key -eq $navn )
{
$item.value = $appsettings[$navn];
}
}
}
$doc.Save($webConfigFilePath);
write-host "Sletter filer og mapper i"$prod_sti;
Remove-Item $prod_sti\* -recurse -force -confirm;
write-host "Kopiere filer fra "$deploy_sti\*" til "$prod_sti;
Copy-Item $deploy_sti\* $prod_sti -recurse;
write-host "Script afsluttet - afventer et tryk på Enter...";
$null = read-host;
Bemærk især hvor effektivt det er at "lege" med XML i Powershell og hvor nemt det er at kopiere og slette mapper og filer. Der er en del -confirm argumenter på funktioner som sletter filer og mapper. Hvis du vil have scriptet til at køre "af sig selv" kan du bare fjerne argumentet.
Når scriptet afvikles vil det resultere i følgende:
En fuld deployment - inkl. tilretning af web-config - er sket ved at afvikle et enkelt script. Det viste eksempel er som det fremgår rimeligt simpelt, men det kan udvides efter behov. Jeg har script som zipper, mailer, FTP'er, taler med IIS med videre - det er altså ikke småting man kan med Powershell.
Hvis du vil prøve det viste script gør du følgende:
- Sørg for at Powershell er installeret. Download evt her.
- Sørg for at Powershell tillader afvikling af scripts. Se evt. her - led efter spørgsmålet "How come I cannot run scripts when I first install Windows PowerShell?" (få en Powershell prompt ved at skrive powershell under Kør på Windows Start-menuen)
- Hent zip med demo sitet (inkl. script) og pak ud til c:\temp\ (sitet skal ligge under c:\temp\pstest). Find zip-filen nederst i dette indlæg.
- Opret c:\iistest som scriptet bruger som "IIS" mappe
- Åben sitet i Visual Studio
- I Solution Explorer højreklikkes på deploy.ps1 under /temp
- Vælg Open with...
- Klik på Add-knappen og find powershell.exe under
C:\WINDOWS\system32\windowspowershell\v1.0
- Åben scriptet med Powershell
Nu burde scriptet blive afviklet som ovennævnte billede - check c:\iistest hvor de prekompilerede filer nu ligger, og bemærk tilretningerne i web.config.
Advarsel: Bare for en god ordens skyld - afvikling af scriptet er på eget ansvar. Det sletter mapper og filer i c:\temp\deploy og c:\tempiis (dog bruges -confirm jf. ovenfor). Disse mapper kan evt tilrettes i toppen af scriptet, men pas på: scriptet gør bare hvad det bliver bedt om.
Dette indlæg var blot en hurtig introduktion til brug af Powershell ifbm med deployment, og du kan bruge scriptet som inspiration til at udvikle egne scripts.
pstest.zip (3,68 KB)