App_Offline в MSBuild Remote Web Deploy

У меня есть следующая задача в моем MSBuild script для развертывания на удаленном сервере с помощью службы Web Deploy (служба MSDeploy):

  <Target Name="Deploy">
    <MSBuild
            Projects="$(SolutionFile)"
            Properties="Configuration=Release; DeployOnBuild=True; 
              DeployTarget=MsDeployPublish; MSDeployPublishMethod=WMSvc; 
              MsDeployServiceUrl=$(DeployServiceUrl); 
              DeployIisAppPath=$(DeployIisAppPath); 
              UserName=$(DeployUserName); Password=$(DeployPassword); 
              CreatePackageOnPublish=True; AllowUntrustedCertificate=True" />
  </Target>

Он отлично работает. Однако я хотел бы разместить файл app_offline.htm(на удаленном сервере) до развертывания приложения и удалить файл app_offline.htm после развертывания (или при ошибке). Есть ли свойство MSBuild или любые другие скриптовые настройки, чтобы это произошло?

Спасибо заранее.

Ответ 1

Недавно я писал об этом в http://sedodream.com/2012/01/08/HowToTakeYourWebAppOfflineDuringPublishing.aspx. Это сложнее, чем должно быть, и я работаю над упрощением этого для более поздней версии. В любом случае я вставлял здесь весь контент.

Я получил электронное письмо с клиентом о том, как они могут отключить веб-приложение/сайт в автономном режиме в течение всего срока публикации публикации Visual Studio. Легкий способ отключить ваш сайт - это удалить файл app_offline.htm в корневом каталоге сайтов. Для получения дополнительной информации об этом вы можете прочитать сообщение ScottGus, ссылку ниже в разделе ресурсов. К сожалению, сам Web Deploy не поддерживает это. Если вы хотите, чтобы Web Deploy (aka MSDeploy) поддерживал эту функцию, пожалуйста, проголосуйте за нее по адресу http://aspnet.uservoice.com/forums/41199-general/suggestions/2499911-take-my-site-app-offline-during-publishing.

Так как Web Deploy не поддерживает это, это будет немного сложнее, и нам нужно выполнить следующие шаги:

Опубликовать app_offline.htm
Опубликуйте приложение и убедитесь, что app_offline.htm содержится внутри публикуемой полезной нагрузки.
Удалить app_offline.htm

1 отключит приложение до начала процесса публикации.

2 гарантирует, что когда мы опубликуем, что app_offline.htm не удаляется (и, следовательно, приложение отключено)

3 удалит app_offline.htm и вернет сайт онлайн

Теперь, когда мы знаем, что нужно сделать, давайте посмотрим на реализацию. Сначала для легкой части. Создайте файл в проекте веб-приложений (WAP) с именем app_offline-template.htm. Это будет файл, который в конечном итоге станет файлом app_offline.htm на вашем целевом сервере. Если вы оставите его пустым, ваши пользователи получат общее сообщение о том, что приложение отключено, но вам было бы лучше разместить статический HTML (без разметки ASP.NET) внутри этого файла, позволяя пользователям знайте, что сайт вернется и любая другая информация, которую вы считаете релевантной для ваших пользователей. Когда вы добавляете этот файл, вы должны изменить действие "Сборка" на "Нет" в сетке "Свойства". Это гарантирует, что этот файл не будет опубликован/упакован. Поскольку файл заканчивается на .htm, он по умолчанию будет опубликован. См. Изображение ниже.

Теперь для тяжелой части. Для проектов веб-приложений мы подключаем процесс публикации/пакета, который мы называем "wpp.targets". Если вы хотите расширить процесс публикации/пакета, вы можете создать файл с именем {ProjectName}.wpp.targets в той же папке, что и сам файл проекта. Вот файл, который я создал, вы можете скопировать и вставить содержимое в файл wpp.targets. Я объясню значимые части, но хочу опубликовать весь файл для вашего убеждения. Примечание: вы можете взять мою последнюю версию этого файла из моего github repo, ссылка находится в разделе ресурсов ниже.

<?xml version="1.0" encoding="utf-8"?>
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <Target Name="InitalizeAppOffline">
    <!-- 
    This property needs to be declared inside of target because this is imported before
    the MSDeployPath property is defined as well as others -->
    <PropertyGroup>
      <MSDeployExe Condition=" '$(MSDeployExe)'=='' ">$(MSDeployPath)msdeploy.exe</MSDeployExe>
    </PropertyGroup>    
  </Target>

  <PropertyGroup>
    <PublishAppOfflineToDest>
      InitalizeAppOffline;
    </PublishAppOfflineToDest>
  </PropertyGroup>

  <!--
    %msdeploy% 
      -verb:sync 
      -source:contentPath="C:\path\to\app_offline-template.htm" 
      -dest:contentPath="Default Web Site/AppOfflineDemo/app_offline.htm"
  -->

  <!--***********************************************************************
  Make sure app_offline-template.htm gets published as app_offline.htm
  ***************************************************************************-->
  <Target Name="PublishAppOfflineToDest" 
          BeforeTargets="MSDeployPublish" 
          DependsOnTargets="$(PublishAppOfflineToDest)">
    <ItemGroup>
      <_AoPubAppOfflineSourceProviderSetting Include="contentPath">
        <Path>$(MSBuildProjectDirectory)\app_offline-template.htm</Path>
        <EncryptPassword>$(DeployEncryptKey)</EncryptPassword>
        <WebServerAppHostConfigDirectory>$(_MSDeploySourceWebServerAppHostConfigDirectory)</WebServerAppHostConfigDirectory>
        <WebServerManifest>$(_MSDeploySourceWebServerManifest)</WebServerManifest>
        <WebServerDirectory>$(_MSDeploySourceWebServerDirectory)</WebServerDirectory>
      </_AoPubAppOfflineSourceProviderSetting>

      <_AoPubAppOfflineDestProviderSetting Include="contentPath">
        <Path>"$(DeployIisAppPath)/app_offline.htm"</Path>
        <ComputerName>$(_PublishMsDeployServiceUrl)</ComputerName>
        <UserName>$(UserName)</UserName>
        <Password>$(Password)</Password>
        <EncryptPassword>$(DeployEncryptKey)</EncryptPassword>
        <IncludeAcls>False</IncludeAcls>
        <AuthType>$(AuthType)</AuthType>
        <WebServerAppHostConfigDirectory>$(_MSDeployDestinationWebServerAppHostConfigDirectory)</WebServerAppHostConfigDirectory>
        <WebServerManifest>$(_MSDeployDestinationWebServerManifest)</WebServerManifest>
        <WebServerDirectory>$(_MSDeployDestinationWebServerDirectory)</WebServerDirectory>
      </_AoPubAppOfflineDestProviderSetting>
    </ItemGroup>

    <MSdeploy
          MSDeployVersionsToTry="$(_MSDeployVersionsToTry)"
          Verb="sync"
          Source="@(_AoPubAppOfflineSourceProviderSetting)"
          Destination="@(_AoPubAppOfflineDestProviderSetting)"
          EnableRule="DoNotDeleteRule"
          AllowUntrusted="$(AllowUntrustedCertificate)"
          RetryAttempts="$(RetryAttemptsForDeployment)"
          SimpleSetParameterItems="@(_AoArchivePublishSetParam)"
          ExePath="$(MSDeployPath)" />
  </Target>

  <!--***********************************************************************
  Make sure app_offline-template.htm gets published as app_offline.htm
  ***************************************************************************-->
  <!-- We need to create a replace rule for app_offline-template.htm->app_offline.htm for when the app get published -->
  <ItemGroup>
    <!-- Make sure not to include this file if a package is being created, so condition this on publishing -->
    <FilesForPackagingFromProject Include="app_offline-template.htm" Condition=" '$(DeployTarget)'=='MSDeployPublish' ">
      <DestinationRelativePath>app_offline.htm</DestinationRelativePath>
    </FilesForPackagingFromProject>

    <!-- This will prevent app_offline-template.htm from being published -->
    <MsDeploySkipRules Include="SkipAppOfflineTemplate">
      <ObjectName>filePath</ObjectName>
      <AbsolutePath>app_offline-template.htm</AbsolutePath>
    </MsDeploySkipRules>
  </ItemGroup>

  <!--***********************************************************************
  When publish is completed we need to delete the app_offline.htm
  ***************************************************************************-->
  <Target Name="DeleteAppOffline" AfterTargets="MSDeployPublish">
    <!--
    %msdeploy% 
      -verb:delete 
      -dest:contentPath="{IIS-Path}/app_offline.htm",computerName="...",username="...",password="..."
    -->
    <Message Text="************************************************************************" />
    <Message Text="Calling MSDeploy to delete the app_offline.htm file" Importance="high" />
    <Message Text="************************************************************************" />

    <ItemGroup>
      <_AoDeleteAppOfflineDestProviderSetting Include="contentPath">
        <Path>$(DeployIisAppPath)/app_offline.htm</Path>
        <ComputerName>$(_PublishMsDeployServiceUrl)</ComputerName>
        <UserName>$(UserName)</UserName>
        <Password>$(Password)</Password>
        <EncryptPassword>$(DeployEncryptKey)</EncryptPassword>
        <AuthType>$(AuthType)</AuthType>
        <WebServerAppHostConfigDirectory>$(_MSDeployDestinationWebServerAppHostConfigDirectory)</WebServerAppHostConfigDirectory>
        <WebServerManifest>$(_MSDeployDestinationWebServerManifest)</WebServerManifest>
        <WebServerDirectory>$(_MSDeployDestinationWebServerDirectory)</WebServerDirectory>
      </_AoDeleteAppOfflineDestProviderSetting>
    </ItemGroup>

    <!-- 
    We cannot use the MSDeploy/VSMSDeploy tasks for delete so we have to call msdeploy.exe directly.
    When they support delete we can just pass in @(_AoDeleteAppOfflineDestProviderSetting) as the dest
    -->
    <PropertyGroup>
      <_Cmd>"$(MSDeployExe)" -verb:delete -dest:contentPath="%(_AoDeleteAppOfflineDestProviderSetting.Path)"</_Cmd>
      <_Cmd Condition=" '%(_AoDeleteAppOfflineDestProviderSetting.ComputerName)' != '' ">$(_Cmd),computerName="%(_AoDeleteAppOfflineDestProviderSetting.ComputerName)"</_Cmd>
      <_Cmd Condition=" '%(_AoDeleteAppOfflineDestProviderSetting.UserName)' != '' ">$(_Cmd),username="%(_AoDeleteAppOfflineDestProviderSetting.UserName)"</_Cmd>
      <_Cmd Condition=" '%(_AoDeleteAppOfflineDestProviderSetting.Password)' != ''">$(_Cmd),password=$(Password)</_Cmd>
      <_Cmd Condition=" '%(_AoDeleteAppOfflineDestProviderSetting.AuthType)' != ''">$(_Cmd),authType="%(_AoDeleteAppOfflineDestProviderSetting.AuthType)"</_Cmd>
    </PropertyGroup>

    <Exec Command="$(_Cmd)"/>
  </Target>  
</Project>

1 Опубликовать app_offline.htm

Реализация для # 1 содержится внутри целевого объекта PublishAppOfflineToDest. Команда msdeploy.exe, которую нужно выполнить, выполняется.

msdeploy.exe 
    -source:contentPath='C:\Data\Personal\My Repo\sayed-samples\AppOfflineDemo01\AppOfflineDemo01\app_offline-template.htm' 
    -dest:contentPath='"Default Web Site/AppOfflineDemo/app_offline.htm"',UserName='sayedha',Password='password-here',ComputerName='computername-here',IncludeAcls='False',AuthType='NTLM' -verb:sync -enableRule:DoNotDeleteRule

Для этого я буду использовать задачу MSDeploy. Внутри объекта PublishAppOfflineToDest вы можете увидеть, как это достигается путем создания элемента как для источника, так и для адресата.

2 Опубликуйте приложение и убедитесь, что app_offline.htm содержится внутри публикуемой полезной нагрузки

Эта часть выполняется фрагментом

<!--***********************************************************************
Make sure app_offline-template.htm gets published as app_offline.htm
***************************************************************************-->
<!-- We need to create a replace rule for app_offline-template.htm->app_offline.htm for when the app get published -->
<ItemGroup>
  <!-- Make sure not to include this file if a package is being created, so condition this on publishing -->
  <FilesForPackagingFromProject Include="app_offline-template.htm" Condition=" '$(DeployTarget)'=='MSDeployPublish' ">
    <DestinationRelativePath>app_offline.htm</DestinationRelativePath>
  </FilesForPackagingFromProject>

  <!-- This will prevent app_offline-template.htm from being published -->
  <MsDeploySkipRules Include="SkipAppOfflineTemplate">
    <ObjectName>filePath</ObjectName>
    <AbsolutePath>app_offline-template.htm</AbsolutePath>
  </MsDeploySkipRules>
</ItemGroup>

Значение элемента для FilesForPackagingFromProject здесь преобразует ваш app_offline-template.htm в app_offline.htm в папку, из которой будет обрабатываться публикация. Также на нем есть условие, так что это происходит только во время публикации, а не упаковки. Мы не хотим, чтобы app_offline-template.htm находился в пакете (но это не конец света, если он это делает).

Элемент для MsDeploySkiprules гарантирует, что сам app_offline-template.htm не будет опубликован. Это может не потребоваться, но это не должно повредить.

3 Удалить app_offline.htm

Теперь, когда наше приложение опубликовано, нам нужно удалить файл app_offline.htm из веб-приложения dest. Команда msdeploy.exe будет:

% MSDeploy% -verb: удалить -dest: contentPath = "{IIS-Path}/app_offline.htm", computerName = "..." , username = "..." , password = "..."

Это реализовано внутри цели DeleteAppOffline. Эта цель автоматически будет выполнена после публикации, поскольку я включил атрибут AfterTargets = "MSDeployPublish". В этой цели вы можете увидеть, что я создаю команду msdeploy.exe напрямую, похоже, что задача MSDeploy не поддерживает глагол удаления.

Если вы попробуете это, пожалуйста, дайте мне знать, если у вас возникнут проблемы. Я собираюсь создать пакет Nuget из этого, чтобы вы могли просто установить этот пакет. Это займет немного работы, поэтому, пожалуйста, дайте мне знать, если вы заинтересованы в этом.

Ресурсы

Последняя версия моего файла appppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppp

Ответ 2

Теперь это поддерживается WebDeploy v3.0.. все, что вам нужно сделать, это добавить эту строку в свой профиль публикации в 'Свойства\PublishProfiles'

<EnableMSDeployAppOffline>true</EnableMSDeployAppOffline>

Таким образом, итоговый профиль публикации будет выглядеть примерно так.

<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="12.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
    <EnableMSDeployAppOffline>true</EnableMSDeployAppOffline>
    <WebPublishMethod>MSDeploy</WebPublishMethod>
    <MSDeployServiceURL>(removed)</MSDeployServiceURL>
    <DeployIisAppPath>Default Web Site</DeployIisAppPath>
    <AllowUntrustedCertificate>True</AllowUntrustedCertificate>
    <SkipExtraFilesOnServer>True</SkipExtraFilesOnServer>
    <DeployAsIisApp>False</DeployAsIisApp>
    <MSDeployPublishMethod>WMSVC</MSDeployPublishMethod>
    <UserName>sayedha</UserName>
    <ExcludeApp_Data>False</ExcludeApp_Data>
    <_SavePWD>True</_SavePWD>
  </PropertyGroup>
</Project>

Я тестировал это, и он отключает мое приложение во время развертывания, но, к сожалению, я все же иногда получаю ошибку "PrecompiledApp.config is used".

Более подробную информацию об этом можно найти здесь: http://blogs.msdn.com/b/webdev/archive/2013/10/30/web-publishing-updates-for-app-offline-and-usechecksum.aspx