Создание, тестирование и развертывание проектов .NET Core

Сервисы Azure DevOps | Azure DevOps Server | Azure DevOps Server 2022

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

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

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

Если вы хотите использовать проект .NET, который уже находится в репозитории GitHub, можно пропустить этот раздел.

Если у вас нет проекта .NET для работы, создайте его на локальном компьютере следующим образом:

1. Установите пакет SDK для .NET 8.0 или убедитесь, что он установлен.
2. Откройте окно терминала на локальном компьютере.
3. Создайте каталог проекта и перейдите к нему.
4. Создайте веб-приложение .NET 8, выполнив команду dotnet new webapp -f net8.0.
5. Выполните сборку и запуск приложения локально с помощью dotnet run.
6. Когда приложение запускается, нажмите клавиши CTRL+C, чтобы завершить работу приложения.
7. Отправьте или подключите локальный проект к репозиторию GitHub.

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

Если у вас есть конвейер, который вы хотите использовать, можно пропустить этот раздел. В противном случае для создания конвейера можно использовать редактор конвейера YAML или классический редактор.

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

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

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

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

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

pool:
  vmImage: 'ubuntu-latest' 

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

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

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

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

Используйте задачу .NET Core (DotNetCoreCLI@2) для скачивания и восстановления пакетов NuGet из Azure Artifacts, NuGet.org или другого аутентифицированного внешнего или внутреннего репозитория NuGet. Если источник NuGet находится в том же проекте, что и ваш конвейер, вам не нужно проходить аутентификацию. Дополнительные сведения см. в статье о задаче .NET Core (DotNetCoreCLI@2).

Следующий конвейер использует задачу DotNetCoreCLI@2 для восстановления пакетов из канала Azure Artifacts.

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)'

.NET автоматически восстанавливает пакеты при выполнении таких команд, как dotnet build. Вам по-прежнему нужно использовать задачу .NET Core (DotNetCoreCLI@2) для восстановления пакетов, если вы используете канал пакетов, требующий аутентификации.

Управляйте учетными данными для аутентифицированного веб-канала, создав подключение к службе NuGet в разделе Параметры проекта>Конвейеры>Подключения служб. Дополнительные сведения о подключениях к службе NuGet см. в статье "Публикация пакетов NuGet с помощью Azure Pipelines".

Восстановление пакетов из NuGet.org

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

steps:
- task: DotNetCoreCLI@2
  displayName: Restore
  inputs:
    command: restore
    projects: '**/*.csproj'
    feedsToUse: select

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

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

Чтобы восстановить пакеты из внешнего источника, добавьте задачу restore, как указано в предыдущем разделе, но измените параметры конфигурации следующим образом:

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

Восстановление пакетов для проектов .NET Framework

Если решение включает проект .NET Framework или используетсяpackage.json для указания зависимостей, используйте задачу NuGetCommand@2 для восстановления этих зависимостей.

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

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

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

Используйте задачу .NET Core

steps:
- task: DotNetCoreCLI@2
  displayName: Build
  inputs:
    command: build
    projects: '**/*.csproj'
    arguments: '--configuration $(buildConfiguration)'

Создание .NET Core с помощью скрипта командной строки

Можно также создать с помощью скрипта командной строки.

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

Добавление других команд пакета SDK для .NET в конвейер

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

Добавить команду .NET CLI с помощью задачи .NET Core

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

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

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

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

• Команда: настраиваемая
• Путь к проектам: оставьте пустым
• Настраиваемая команда: tool
• Аргументы: install -g dotnetsay

Чтобы запустить инструмент, добавьте задачу Командная строка и в поле Скрипт введите dotnetsay.

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

Если репозиторий содержит тестовые проекты, используйте задачу .NET Core (DotNetCoreCLI@2) для выполнения модульных тестов с помощью платформ тестирования, таких как MSTest, xUnit и NUnit. Тестовый проект должен ссылаться на Microsoft.NET.Test.SDK версии 15.8.0 или более поздней.

Служба автоматически публикует результаты теста. Их можно увидеть в сводке по сборке. Используйте результаты теста для устранения неполадок неудачных тестов и анализа времени тестирования.

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

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

Если вы используете помощник по задачам для добавления задачи .NET Core (DotNetCoreCLI@2) , задайте следующие свойства:

• Команда: тест
• Путь к проектам: настройка тестовых проектов в решении
• Аргументы: --configuration $(BuildConfiguration)

Кроме того, выполните dotnet test команду с определенным логгером, затем используйте PublishTestResults@2 задачу:

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

Сбор данных о покрытии кода

При сборке на платформе Windows можно собирать метрики покрытия кода с помощью встроенного сборщика данных покрытия. Тестовый проект должен ссылаться на Microsoft.NET.Test.SDK версии 15.8.0 или более поздней.

При использовании задачи .NET Core (DotNetCoreCLI@2) для выполнения тестов конвейер автоматически публикует данные покрытия на сервере. Файл *.coverage можно скачать из сводки сборки, чтобы просмотреть в Visual Studio.

Чтобы собрать данные о покрытии кода, добавьте аргумент --collect "Code Coverage" при добавлении задачи тестирования в конвейер.

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

Если вы используете помощник по задачам для добавления задачи .NET Core (DotNetCoreCLI@2) , задайте следующие свойства:

• Команда: тест
• Путь к проектам: настройка тестовых проектов в решении
• Аргументы: --configuration $(BuildConfiguration) --collect "Code Coverage"

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

В качестве альтернативы, чтобы собрать результаты покрытия кода с помощью команды dotnet test с указанным средством ведения журнала, а затем запустить задачу PublishTestResults@2, используйте следующий код:

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

Сбор метрик покрытия кода с помощью Coverlet

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

Результаты покрытия кода можно опубликовать на сервере с помощью задачи "Публикация результатов покрытия кода" (PublishCodeCoverageResults@2). Необходимо настроить средство покрытия, чтобы создать результаты в формате покрытия Cobertura или JaCoCo.

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

1. Добавьте ссылку на пакет NuGet coverlet.collector.
2. Добавьте следующий фрагмент кода в файл azure-pipelines.yml . Не добавляйте дополнительные DataCollectionRunSettings аргументы, так как XPlat Code Coverage сборщик уже формирует отчет Cobertura.

- task: DotNetCoreCLI@2
  displayName: 'dotnet test'
  inputs:
    command: 'test'
    arguments: '--configuration $(buildConfiguration) --collect:"XPlat Code Coverage"'
    publishTestResults: true
    projects: '<test project directory>'
  
- task: PublishCodeCoverageResults@2
  displayName: 'Publish code coverage report'
  inputs:
    codeCoverageTool: 'Cobertura'
    summaryFileLocation: '$(Agent.TempDirectory)/**/coverage.cobertura.xml'

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

Чтобы упаковать и доставить выходные данные сборки, можно:

• Опубликуйте артефакты сборки в Azure Pipelines.
• Создайте пакет NuGet и опубликуйте его в веб-канале NuGet.
• Опубликуйте пакет NuGet в Azure Artifacts.
• Создайте ZIP-архив для развертывания в веб-приложении.
• Публикация символов в сервере символов Azure Artifacts или общей папке.

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

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

steps:

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

- 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

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)'
    ArtifactName: 'drop'

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

Публикация в веб-канале NuGet

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

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

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

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

Вы можете опубликовать свои пакеты NuGet в свой канал Azure Artifacts с помощью задачи NuGetCommand@2. Дополнительные сведения см. в статье "Публикация пакетов NuGet с помощью Azure Pipelines".

Опубликовать ZIP-архив в веб-приложение

Чтобы создать ZIP-архив, готовый к публикации в веб-приложении, добавьте следующий фрагмент кода в azure-pipelines.yml. Выполните эту задачу после сборки приложения, как правило, ближе к концу конвейера. Например, выполните эту задачу перед развертыванием в веб-приложении Azure в Windows.

steps:
# ...
- 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>'

Чтобы использовать классический редактор, добавьте источники индекса и задачу публикации символов в конвейер.

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

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

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

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

• Проблемы с подключением могут привести к сбою сборки при восстановлении пакетов из NuGet.org. NuGet.org могут возникнуть проблемы или могут возникнуть проблемы с сетью между центром обработки данных Azure и NuGet.org. Вы можете изучить, можно ли использовать azure Artifacts с вышестоящими источниками для кэширования пакетов, чтобы повысить надежность сборок.

  Конвейер автоматически использует свои учетные данные для подключения к «Артефактам Azure». Эти учетные данные обычно берутся из учетной записи службы сборки коллекции проектов . Дополнительные сведения об использовании артефактов Azure для кэширования пакетов NuGet см. в статье Подключение к веб-каналам артефактов Azure.

• Возможно, вы используете некоторую логику в Visual Studio, которая не закодирована в конвейере. Azure Pipelines выполняет каждую команду в задаче последовательно в новом процессе. Просмотрите журналы сборки конвейера, чтобы увидеть точные команды, которые выполнялись при сборке. Чтобы найти проблему, повторите те же команды в том же порядке на компьютере разработки.

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

Связанный контент

• Артефакты Azure
• Задачи сборки и выпуска
• Средства командной строки .NET Core
• Модульное тестирование в проектах .NET Core