Сборка, тестирование и развертывание приложений .NET Core

Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019

Используйте Azure Pipeline для автоматического создания, тестирования и развертывания проектов .NET Core. В этой статье показано, как выполнять следующие задачи:

Предварительные условия

Создание первого конвейера

Вы не знакомы с Azure Pipelines? В этом случае рекомендуется сначала попробовать следующий раздел.

Создание проекта .NET.

Если у вас нет проекта .NET для работы, создайте новый проект в локальной системе. Start by installing the .NET 8.0 SDK .

1. Откройте окно терминала.

2. Создайте каталог проекта и перейдите к нему.

3. Создайте веб-приложение .NET 8.

   dotnet new webapp -f net8.0
   

4. В том же сеансе терминала запустите приложение локально с помощью dotnet run команды из каталога проекта.

   dotnet run
   

5. Once the application starts, press Ctrl-C to shut it down.

Создание репозитория Git и его подключение к GitHub

1. В каталоге проекта создайте локальный репозиторий Git и зафиксируйте код приложения в главной ветви.

2. Подключите локальный репозиторий Git к репозиторию GitHub.

Создание проекта DevOps

Create a new Azure DevOps project to host your pipeline.

Настройка среды сборки

steps:
- task: UseDotNet@2
  inputs:
    version: '8.x'

Создание конвейера

Для создания конвейера можно использовать редактор конвейера YAML или классический редактор. Чтобы использовать классический редактор, выберите "Использовать классический редактор".

Теперь у вас есть рабочий конвейер, готовый к настройке! Узнайте подробнее о некоторых распространенных способах настройки конвейера.

Build environment

pool:
  name: myPrivateAgents
  demands:
  - agent.os -equals Darwin
  - anotherCapability -equals somethingElse

steps:
- task: UseDotNet@2
  displayName: 'Install .NET Core SDK'
  inputs:
    version: 8.x
    performMultiLevelLookup: true
    includePreviewVersions: true # Required for preview versions

pool:
  vmImage: 'ubuntu-latest' 

steps:
- task: UseDotNet@2
  inputs:
    version: '5.x'

steps:
- task: UseDotNet@2
  displayName: 'Install .NET Core SDK'
  inputs:
    version: 8.x
    performMultiLevelLookup: true
    includePreviewVersions: true # Required for preview versions

Восстановить зависимости

NuGet — это популярный способ зависеть от кода, который вы не создаете. Вы можете скачать пакеты NuGet и инструменты для конкретного проекта, указанные в файле проекта, выполнив dotnet restore команду с помощью задачи .NET Core или непосредственно в скрипте в конвейере. Дополнительные сведения см. в статье о задаче .NET Core (DotNetCoreCLI@2).

Пакеты NuGet можно скачать из Azure Artifacts, NuGet.org или какого-нибудь другого внешнего или внутреннего репозитория NuGet. Задача .NET Core особенно полезна для восстановления пакетов из аутентифицированных веб-каналов NuGet. If your feed is in the same project as your pipeline, you don't need to authenticate.

This pipeline uses an Azure Artifact feed for dotnet restore in the DotNetCoreCLI@2 task.

trigger:
- main

pool:
  vmImage: 'windows-latest'

steps:
- task: UseDotNet@2
  displayName: 'Install .NET Core SDK'
  inputs:
    version: 8.x
    performMultiLevelLookup: true
    includePreviewVersions: true # Required for preview versions

variables:
  buildConfiguration: 'Release'

steps:
- task: DotNetCoreCLI@2
  inputs:
    command: 'restore'
    feedsToUse: 'select'
    vstsFeed: 'my-vsts-feed' # A series of numbers and letters

- task: DotNetCoreCLI@2
  inputs:
    command: 'build'
    arguments: '--configuration $(buildConfiguration)'
  displayName: 'dotnet build $(buildConfiguration)'

Команда dotnet restore использует NuGet.exe, поставляемый с .NET Core SDK, и может восстанавливать только пакеты, указанные в файлах проекта .csproj .NET Core.

Если в решении также есть проект платформы Microsoft .NET Framework или используется package.json для указания зависимостей, используйте задачу NuGet для восстановления этих зависимостей.

- task: NuGetCommand@2
  inputs:
    command: 'restore'
    restoreSolution: '**/*.sln'
    feedsToUse: 'select'

В пакете SDK для .NET Core версии 2.0 и более поздних версий пакеты восстанавливаются автоматически при выполнении таких dotnet buildкоманд. Однако вам по-прежнему потребуется использовать задачу .NET Core для восстановления пакетов, если вы используете аутентифицированный канал.

Your builds can fail because of connection issues when you restore packages from NuGet.org. You can use Azure Artifacts with upstream sources to cache the packages. Учетные данные конвейера автоматически используются при подключении к Azure Artifacts. These credentials are typically derived from the Project Collection Build Service account. To learn more about using Azure Artifacts to cache your NuGet packages, see Connect to Azure Artifact feeds.

Чтобы указать репозиторий NuGet, поместите URL-адрес в файл NuGet.config в вашем репозитории. Если ваш канал аутентифицирован, управляйте его учетными данными, создав подключение службы NuGet на вкладке Службы в разделе Параметры проекта.

For more information about NuGet service connections, see publish to NuGet feeds.

Восстановление пакетов из внешнего хранилища

Выполните следующие действия, чтобы восстановить пакеты из внешнего источника.

# do this before your build tasks
steps:
- task: DotNetCoreCLI@2
  displayName: Restore
  inputs:
    command: restore
    projects: '**/*.csproj'
    feedsToUse: config
    nugetConfigPath: NuGet.config    # Relative to root of the repository
    externalFeedCredentials: <Name of the NuGet service connection>

Создайте свой проект

Создайте проекты .NET Core, выполнив dotnet build команду. Вы можете добавить команду в конвейер в качестве скрипта командной строки или с помощью задачи .NET Core.

Build with the .NET Core task

Пример YAML для сборки с помощью задачи DotNetCoreCLI@2:

steps:
- task: DotNetCoreCLI@2
  displayName: Build
  inputs:
    command: build
    projects: '**/*.csproj'
    arguments: '--configuration $(buildConfiguration)' # Update this to match your needs

Build .NET Core with a command line script

YAML example to build using dotnet build as a script:

steps:
- script: dotnet build --configuration $(buildConfiguration)
  displayName: 'dotnet build $(buildConfiguration)'

Добавьте команды SDK для .NET в ваш конвейер

Команды SDK для .NET можно добавить в проект в качестве скрипта или с помощью задачи .NET Core. Задача .NET Core (DotNetCoreCLI@2) позволяет легко добавлять команды dotnet CLI в конвейер. Задачи .NET Core можно добавить, изменив файл YAML или используя классический редактор.

Add a .NET CLI command with the .NET Core task

Add a .NET Core CLI command in a script

Вы можете добавить команды CLI .NET Core как script в ваш файл azure-pipelines.yml.

Пример:

steps:
# ...
- script: dotnet test <test-project> 

Установка инструмента

Чтобы установить глобальное средство .NET Core, например dotnetsay в сборке, работающей в Windows, сделайте следующее:

1. Добавьте задачу .NET Core и задайте следующие свойства:
   • Command: custom.
     • Путь к проектам: оставьте пустым.
   • Настраиваемая команда: инструмент.
   • Аргументы: install -g dotnetsay.
2. Чтобы запустить средство, добавьте командную строку и задайте следующие свойства:
   • Скрипт:dotnetsay.

Запуск тестов

При наличии тестовых проектов в репозитории можно использовать задачу .NET Core для выполнения модульных тестов с помощью платформ тестирования, таких как MSTest, xUnit и NUnit. Тестовый проект должен ссылаться на Microsoft.NET.Test.SDK версии 15.8.0 или более поздней. Результаты теста автоматически публикуются в службе. Эти результаты доступны в сводке сборки и могут использоваться для устранения неполадок неудачных тестов и анализа времени тестирования.

Вы можете добавить тестовую задачу в конвейер с помощью задачи DotNetCoreCLI@2 или добавить следующий фрагмент кода в azure-pipelines.yml файл:

steps:
# ...
# do this after other tasks such as building
- task: DotNetCoreCLI@2
  inputs:
    command: test
    projects: '**/*Tests/*.csproj'
    arguments: '--configuration $(buildConfiguration)'

При использовании редактора задач .NET Core задайте команду для тестирования и пути к проектам, которые должны ссылаться на тестовые проекты в решении.

Кроме того, можно выполнить dotnet test команду с определенным средством ведения журнала, а затем использовать задачу "Опубликовать результаты теста".

steps:
# ...
# do this after your tests have run
- script: dotnet test <test-project> --logger trx
- task: PublishTestResults@2
  condition: succeededOrFailed()
  inputs:
    testRunner: VSTest
    testResultsFiles: '**/*.trx'

Collect code coverage

When you're building on the Windows platform, code coverage metrics can be collected by using the built-in coverage data collector. Тестовый проект должен ссылаться на Microsoft.NET.Test.SDK версии 15.8.0 или более поздней.

При использовании задачи .NET Core для выполнения тестов данные покрытия автоматически публикуются на сервере. Файл .coverage можно скачать из сводки сборки для просмотра в Visual Studio.

Добавьте следующий фрагмент кода в azure-pipelines.yml файл:

steps:
# ...
# do this after other tasks such as building
- task: DotNetCoreCLI@2
  inputs:
    command: test
    projects: '**/*Tests/*.csproj'
    arguments: '--configuration $(buildConfiguration) --collect "Code Coverage"'

Чтобы добавить задачу .NET Core через редактор задач, выполните следующие действия.

1. Добавьте задачу .NET Core в задание сборки и задайте следующие свойства:

   1. Command: test.
   2. Путь к проектам: должен ссылаться на тестовые проекты в решении.
   3. Аргументы: --configuration $(BuildConfiguration) --collect "Code Coverage".

2. Убедитесь, что параметр "Опубликовать результаты теста" остается выбранным.

Если вы решили выполнить dotnet test команду, укажите параметры ведения журнала результатов теста и покрытия. Затем используйте задачу "Опубликовать результаты теста":

steps:
# ...
# do this after your tests have run
- script: dotnet test <test-project> --logger trx --collect "Code Coverage"
- task: PublishTestResults@2
  inputs:
    testRunner: VSTest
    testResultsFiles: '**/*.trx'

Collect code coverage metrics with Coverlet

Если вы создаете проект на Linux или macOS, можно использовать Coverlet или аналогичное средство для сбора метрик покрытия кода.

You can publish code coverage results to the server with the Publish Code Coverage Results task (PublishCodeCoverageResults@2) task. Инструмент оценки покрытия необходимо настроить для генерации результатов в формате Cobertura или JaCoCo.

To run tests and publish code coverage with Coverlet, do the following tasks:

• Добавьте ссылку на пакет NuGet coverlet.collector.

• Добавьте следующий фрагмент кода в azure-pipelines.yml файл:

  - task: UseDotNet@2
    inputs:
      version: '8.x'
      includePreviewVersions: true # Required for preview versions
  
  - task: DotNetCoreCLI@2
    displayName: 'dotnet build'
    inputs:
      command: 'build'
      configuration: $(buildConfiguration)
  
  - task: DotNetCoreCLI@2
    displayName: 'dotnet test'
    inputs:
      command: 'test'
      arguments: '--configuration $(buildConfiguration) --collect:"XPlat Code Coverage" -- DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=cobertura'
      publishTestResults: true
      projects: 'MyTestLibrary' # update with your test project directory
  
  - task: PublishCodeCoverageResults@2
    displayName: 'Publish code coverage report'
    inputs:
      codeCoverageTool: 'Cobertura'
      summaryFileLocation: '$(Agent.TempDirectory)/**/coverage.cobertura.xml'
  

Упаковка и доставка кода

Артефакты сборки можно опубликовать следующими способами:

• Публикация в Azure Pipelines.
• Публикация пакетов в Azure Artifacts.
• Создание пакета NuGet и публикация в веб-канале NuGet.
• Создание архива .zip для развертывания веб-приложения.

Публикация артефактов в Azure Pipelines

steps:

- task: DotNetCoreCLI@2
  inputs:
    command: publish
    publishWebProjects: True
    arguments: '--configuration $(BuildConfiguration) --output $(Build.ArtifactStagingDirectory)'
    zipAfterPublish: True

# this code takes all the files in $(Build.ArtifactStagingDirectory) and uploads them as an artifact of your build.
- task: PublishPipelineArtifact@1
  inputs:
    targetPath: '$(Build.ArtifactStagingDirectory)' 
    artifactName: 'myWebsite'

steps:

- task: DotNetCoreCLI@2
  inputs:
    command: publish
    publishWebProjects: True
    arguments: '--configuration $(BuildConfiguration) --output $(Build.ArtifactStagingDirectory)'
    zipAfterPublish: True

# this code takes all the files in $(Build.ArtifactStagingDirectory) and uploads them as an artifact of your build.
- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)'
    ArtifactName: 'drop'

Publish to a NuGet feed

Чтобы создать пакет NuGet и опубликовать его в веб-канале NuGet, добавьте следующий фрагмент кода:

steps:
# ...
# do this near the end of your pipeline in most cases
- script: dotnet pack /p:PackageVersion=$(version)  # define version variable elsewhere in your pipeline
- task: NuGetAuthenticate@1
  inputs:
    nuGetServiceConnections: '<Name of the NuGet service connection>'
- task: NuGetCommand@2
  inputs:
    command: push
    nuGetFeedType: external
    publishFeedCredentials: '<Name of the NuGet service connection>'
    versioningScheme: byEnvVar
    versionEnvVar: version

Дополнительные сведения о версионировании и публикации пакетов NuGet см. в статье Публикация в каналах NuGet.

Публикация пакета NuGet в Артефактах Azure

You can publish your NuGet packages to your Azure Artifacts feed by using the NuGetCommand@2 to push to your Azure Artifact feed. Например, см. статью "Публикация пакетов NuGet с помощью Azure Pipelines".

Развертывание веб-приложения

Чтобы создать архив файла .zip, готовый к публикации в веб-приложении, добавьте следующий фрагмент кода:

steps:
# ...
# do this after you've built your app, near the end of your pipeline in most cases
# for example, you do this before you deploy to an Azure web app on Windows
- task: DotNetCoreCLI@2
  inputs:
    command: publish
    publishWebProjects: True
    arguments: '--configuration $(BuildConfiguration) --output $(Build.ArtifactStagingDirectory)'
    zipAfterPublish: True

Чтобы опубликовать этот архив в веб-приложении, см. развертывание веб-приложений Azure.

Создание образа и отправка в реестр контейнеров

Вы также можете создать образ для приложения и отправить его в реестр контейнеров.

Публикация символов

Задачу PublishSymbols@2 можно использовать для публикации символов на сервере символов Azure Artifacts или общей папке.

Например, чтобы опубликовать символы в общей папке, добавьте следующий фрагмент кода в azure-pipelines.yml файл:

- task: PublishSymbols@2
  inputs:
    SymbolsFolder: '$(Build.SourcesDirectory)'
    SearchPattern: '**/bin/**/*.pdb'
    IndexSources: true
    PublishSymbols: true
    SymbolServerType: 'FileShare' 
    SymbolsPath: '\\server\shareName'

When using the classic editor, select Index sources publish symbols from the task catalog to add to your pipeline.

Дополнительные сведения см. в разделе "Публикация символов".

Устранение неполадок

Если вы можете создать проект на компьютере разработки, но у вас возникли проблемы с его сборкой в Azure Pipelines, изучите следующие потенциальные причины и корректирующие действия:

• Проверьте версии пакета SDK для .NET Core и среду выполнения на компьютере разработки и убедитесь, что они соответствуют агенту. Скрипт командной строки dotnet --version можно включить в конвейер, чтобы распечатать версию пакета SDK для .NET Core. Используйте установщик средств .NET Core для развертывания той же версии на агенте или обновите проекты и компьютер разработки до более новой версии пакета SDK для .NET Core.

• Возможно, вы используете некоторую логику в интегрированной среде разработки Visual Studio, которая не отражена в конвейере процессов. Azure Pipelines выполняет каждую из команд, указанных в задачах после другой в новом процессе. Просмотрите журналы сборки конвейеров, чтобы увидеть точные команды, которые выполнялись в процессе сборки. To locate the problem, repeat the same commands in the same order on your development machine.

• Если у вас есть смешанное решение, включающее некоторые проекты .NET Core и некоторые платформа .NET Framework проекты, необходимо также использовать задачу NuGet для восстановления пакетов, указанных в packages.config файлах. Добавьте задачу MSBuild или Visual Studio Build для сборки проектов на платформе .NET Framework.

• Your builds might fail intermittently while restoring packages: either NuGet.org is having issues or there are networking problems between the Azure data center and NuGet.org. You can explore whether using Azure Artifacts with NuGet.org as an upstream source improves the reliability of your builds, as it's not in our control.

• Иногда при развертывании новой версии пакета SDK для .NET Core или Visual Studio сборка может нарушиться. Например, более новая версия или функция средства NuGet, поставляемая вместе с пакетом SDK, может нарушить сборку. Чтобы изолировать эту проблему, используйте задачу установщика инструментов .NET Core, чтобы указать версию пакета SDK для .NET Core, используемого в сборке.

Вопросы и ответы

Вопрос. Где можно узнать больше о артефактах Azure?

A: Azure Artifacts

Вопрос. Где можно узнать больше о командах .NET Core?

Ответ. Средства командной строки .NET Core

Вопрос: Где можно узнать больше о выполнении тестов в вашем решении?

Ответ. Модульное тестирование в проектах .NET Core

Вопрос. Где можно узнать больше о задачах?

Ответ. Создание и выпуск задач