Klávesové zkratky na tomto webu - rozšířené Na obsah stránky

Vlastní transformace konfiguračních souborů

| |

Jedna z pozitivních věcí, se kterou přišel publikační nástroj ve VS 2010, byla automatizovaná transformace web.configu podle zvolené build konfigurace. Od začátku jsem ji úspěšně používal, jak na Tropu, tak později i na Webmiu, při automatizovaném deploymentu do dev/staging/pro­duction prostředí. Používal jsem k tomu jednoduchý PowerShell script, který vyčistí projekt, sbuildí ho ve vybrané konfiguraci, včetně transformace web.configu, vytvoří MsDeploy balíček a pošle ho na cílový server. Je pravda, že pro Azure se používá jiný balíčkovací systém, ale princip je stejný.

Tohle všechno je super, pokud máte jednu nebo málo cílových instancí. Pokud máme víc produkčních deloyovacích konfigurací, je zbytečné vytvářet pro každou i build konfiguraci, která může být pro všechny stejná. A tím se pomalu dostáváme k potřebě oddělit transformace konfiguračního souboru od build konfigurací.

Transformace

Transformace konfiguračního souboru jsou zdánlivě zapečené do webového projektu. Dokonce jsem do některých konzolovek linkoval WebApplication.target, abych mohl transformovat i app.config. Přitom je to samostatný MsBuild task:

<UsingTask TaskName="TransformXml"
    AssemblyFile="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\v10.0\Web\Microsoft.Web.Publishing.Tasks.dll"/>

Ovšem, psát build script v XML, je tak neproduktivní a nehodné 21. století. Vytvoříme si jen jednoduchý znovupoužitelný wrapper, který budeme volat z psake nebo jiného vhodnějšího buildovacího DSL.

<Project ToolsVersion="4.0" DefaultTargets="Transform" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <UsingTask TaskName="TransformXml" AssemblyFile="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\v10.0\Web\Microsoft.Web.Publishing.Tasks.dll"/>
    <Target Name="Transform">
        <TransformXml Source="$(Source)" Transform="$(Transform)" Destination="$(Destination)" />
    </Target>
</Project>

Pak už si jen připravíme pomocnou funkci, která nám tenhle scrtipt zavolá a můžeme jet:

function Transform-Config {
    param([string] $source, [string] $transform, [string] $destination = '')
    if (-not $destination) { $destination = $source; }
    Exec { MsBuild TransformHelper.build /p:Source=$source /p:Transform=$transform /p:Destination=$destination.tmp }
    Remove-Item $destination -force
    Rename-Item "$destination.tmp" $destination -force
}

Parametr $destination je volitelný, pokud není zadaný přepíše se zdrojový soubor.

Použití v praxi

Ve výsledku tohle používám pro transformace configu pro různé instance. V aplikaci mám složku Configurations kde jsou jednotlivé transformace web.instance.config, kde instance je proměnná. Pokud potřebuju rychle přepnout na jinou instance napíšu do konzoly:

.\psake.ps1 TransformConfig –properties @{ instance = 'instance' }

A mám switchnuto. TransformConfig je task v psake scriptu, který volá výše vytvořenou funkci. Při balíčkování se dá využít běžných transformací jako Web.Release.config, který nastaví konfiguraci pro běh v ostrém prostředí v kombinaci s vlastními transformacemi pro různé instance. Mám tak oddělená nastavení specifická pro prostředí od těch, která specifikují konfiguraci instance.

Samozřejmě se to dá využít i na app.config nebo jakékoli jiné XML. To už záleží jen na vaší představivosti. :)

Našli jste v článku chybu? Máte námět na reportáž? Založte mi ticket.