Українська
Завдання серверної частини
Завдання серверної частини перетворює правила бекенду на «ворота»: кожен крок або проходить, або зупиняє завдання. Цей розділ проходить його зверху вниз.
Крок 1. Свіжа машина: код і SDK
Навіщо. Виконавець починає порожнім: ні репозиторію, ні .NET SDK потрібної версії, ні пакетів. Перші кроки його готують, і вони мають створити саме те середовище, яке є у розробників, інакше CI перевірятиме не те, що працює на наших комп’ютерах.
Що зробити. Завдання починається так:
yaml
backend:
name: Backend
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- uses: actions/checkout@v7
- uses: actions/setup-dotnet@v6
with:
global-json-file: global.json
- name: Cache NuGet packages
uses: actions/cache@v6
with:
path: ~/.nuget/packages
key: nuget-${{ runner.os }}-${{ hashFiles('Directory.Packages.props', '**/*.csproj') }}
restore-keys: nuget-${{ runner.os }}-name: Backend– назва перевірки, що з’являється на комітах і запитах на злиття; захист гілки посилається на неї в розділі Запуск CI.actions/checkoutклонує репозиторій на коміті, що запустив процес.actions/setup-dotnetвстановлює .NET SDK. Зglobal-json-file: global.jsonвона читає версію з того самого файлу, що вибирає SDK на наших комп’ютерах (тема 2), тож виконавець збирає тим самим компілятором і тими самими аналізаторами. Один файл визначає SDK скрізь.actions/cacheзберігає папку пакетів NuGet після успішного запуску й відновлює її на початку наступного, що економить завантаження кількох сотень мегабайтів.keyмістить хеш усіх файлів, що визначають версії пакетів:Directory.Packages.propsі файлів проєктів. Коли версія змінюється, змінюється й ключ, і будується свіжий кеш;restore-keysдозволяє тим часом почати з останнього старішого кешу тієї самої системи, тож завантажуються лише змінені пакети.
uses: і версії
actions/checkout@v7 означає репозиторій actions/checkout на тезі v7. Тег основної версії рухається разом з виправленнями помилок, але ніколи – разом зі змінами, що ламають сумісність. Команди зі суворими правилами безпеки ланцюга постачання натомість фіксують дії за повним хешем коміту, а не за тегом, бо тег може перемістити той, хто контролює репозиторій дії.
Крок 2. Відновлення та перевірка форматування
Навіщо. Відновлення пакетів й інструментів один раз, окремим кроком, дає змогу всім наступним крокам працювати з --no-restore/--no-build і полегшує пошук збою: червоний крок Restore означає проблему з пакетами, а не з кодом. Перевірка форматування йде далі, бо це найдешевші «ворота»: компілювати код, який відхилять через зайвий пробіл, марно.
Що зробити.
yaml
- name: Restore
run: |
dotnet restore Chatex.slnx
dotnet tool restore
- name: Check formatting
run: dotnet format Chatex.slnx --verify-no-changes --no-restoredotnet restore Chatex.slnxзавантажує пакети всіх семи проєктів. Тут же працює аудит NuGet (крок 3).dotnet tool restoreвстановлює локальні інструменти зdotnet-tools.json–dotnet-ef10.0.14, потрібний для перевірки міграцій.dotnet format --verify-no-changesзастосовує правила.editorconfigіз теми 2 у пам’яті й завершується помилкою, якщо будь-який файл змінився б. На диску він нічого не змінює. Зайвий пробіл післяusingу першому рядку файлу виглядає так:
…\Source\Chatex.Api\Contracts\ApiContracts.cs(1,7): error WHITESPACE: Fix whitespace formatting. Delete 1 characters. […\Source\Chatex.Api\Chatex.Api.csproj]Команда завершується з кодом 2, і GitHub позначає крок червоним. Виправлення завжди однакове: запустіть локально ./Run.ps1 format (або dotnet format Chatex.slnx) і надішліть знову. Рев’ю коду ніколи не доведеться обговорювати пробіли.
Крок 3. Збирання Release
Навіщо. Розгортання з теми 24 публікує збірку Release, а Release може поводитися інакше, ніж Debug: оптимізатор увімкнено, код під #if DEBUG зникає, деякі аналізатори повідомляють про інше. Тож CI збирає те, що ми постачаємо.
Що зробити.
yaml
- name: Build
run: dotnet build Chatex.slnx -c Release --no-restoreБільшу частину роботи цього кроку було налаштовано давно в Directory.Build.props (тема 2):
xml
<Project>
<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<LangVersion>14</LangVersion>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
<!-- .NET analyzers at the recommended level, plus the IDE style rules from .editorconfig, checked on build. -->
<AnalysisLevel>latest-recommended</AnalysisLevel>
<EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
<!-- Restore checks direct and transitive packages against known advisories; with warnings as errors a
vulnerable package fails the build, in CI and in the deploy. -->
<NuGetAudit>true</NuGetAudit>
<NuGetAuditMode>all</NuGetAuditMode>
</PropertyGroup>
<PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">
<ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
</PropertyGroup>
</Project>TreatWarningsAsErrorsразом з аналізаторами: можливе розіменуванняnull, невикористана змінна чи порушення стилю зупиняє збирання.NuGetAuditзNuGetAuditModeall: кожен пакет, зокрема ті, від яких залежать наші пакети, порівнюється з базою вразливостей GitHub. Пакет із відомою вразливістю дає попередження – а отже, помилку. Повідомлення про вразливість, опубліковане завтра, зробить завтрашній запуск CI червоним без жодних змін у нашому коді; так і задумано.ContinuousIntegrationBuildвмикається лише тоді, коли зміннаGITHUB_ACTIONSдорівнюєtrue, яку GitHub задає на кожному виконавці. Вона робить результат збирання незалежним від папки, в якій його виконано.
Крок 4. Відсутня міграція
Навіщо. Тема 4 показала, що буває, коли сутність змінено без міграції: код очікує стовпець, якого немає в базі даних, і помилка з’являється лише під час виконання – у найгіршому разі на робочому сервері. EF Core може виявити таку ситуацію статично: він порівнює модель скомпільованого коду зі знімком, що зберігається разом з останньою міграцією.
Що зробити.
yaml
- name: Check for model changes without a migration
run: dotnet ef migrations has-pending-model-changes --project Source/Chatex.Data --configuration Release --no-build--configuration Release --no-buildвикористовує збірку, щойно створену попереднім кроком, тож перевірка коштує секунду.- Команді не потрібна база даних: вона порівнює дві моделі в пам’яті.
На чистому репозиторії вона виводить:
No changes have been made to the model since the last migration.Якщо хтось змінив, скажімо, максимальну довжину Attachment.FileName і забув ./Run.ps1 migration <Name>, вона виводить таке й завершується з кодом 1, що провалює завдання:
Changes have been made to the model since the last migration. Add a new migration.Крок 5. Тести зі справжнім PostgreSQL
Навіщо. Тести з тем 6–14 працюють зі справжнім PostgreSQL у контейнері Docker, який запускає Testcontainers (PostgresFixture у Chatex.Testing). Чи запрацюють вони в CI? Так, і без додаткового налаштування: на виконавцях Ubuntu від GitHub Docker встановлено й запущено. Контейнер служби в робочому процесі (services: postgres:) теж підійшов би, але тоді CI і комп’ютери розробників запускали б базу двома різними способами; з Testcontainers тести самі запускають усе потрібне, скрізь однаково.
Що зробити.
yaml
# Testcontainers starts PostgreSQL in the runner's Docker.
- name: Test
run: dotnet test --solution Chatex.slnx -c Release --no-build
- name: Upload test results
if: failure()
uses: actions/upload-artifact@v7
with:
name: test-results
path: '**/TestResults/**'
if-no-files-found: ignoredotnet test --solutionвикористовує засіб запуску Microsoft Testing Platform, вибраний уglobal.json(тема 6). Кожна тестова збірка запускає один контейнерpostgres:18-alpine, застосовує справжні міграції й скидає дані перед кожним тестом; три збірки працюють паралельно, кожна зі своїм контейнером.-c Release --no-buildтестує саме ті збірки, що зібрані й перевірені вище.if: failure()запускає крок вивантаження лише тоді, коли попередній крок завершився помилкою. Зазвичай після збою кроки пропускаються; ця умова змінює це.upload-artifactдодає до запуску кожен файл у папціTestResultsяк артефактtest-results. Платформа тестування записує туди файли, коли ви вмикаєте звіти або коли процес тестів аварійно завершується; зif-no-files-found: ignoreпорожнє вивантаження не вважається помилкою.
Вивід успішного кроку завершується підсумком на кшталт цього (шляхи скорочено):
Test run summary: Passed!
…/Chatex.Api.Tests.dll (net10.0|x64) passed (26s 617ms)
…/Chatex.Core.Tests.dll (net10.0|x64) passed (19s 906ms)
…/Chatex.Data.Tests.dll (net10.0|x64) passed (14s 850ms)
total: 93
failed: 0
succeeded: 93
skipped: 0Перевірка
Запустіть серверну частину завдання на своєму комп’ютері крок за кроком із кореня репозиторію (Docker має працювати):
powershell
dotnet format Chatex.slnx --verify-no-changes --no-restorepowershell
dotnet build Chatex.slnx -c Release --no-restorepowershell
dotnet ef migrations has-pending-model-changes --project Source/Chatex.Data --configuration Release --no-buildpowershell
dotnet test --solution Chatex.slnx -c Release --no-buildПеревірка форматування нічого не виводить, збирання повідомляє 0 Warning(s) і 0 Error(s), перевірка міграцій виводить No changes have been made to the model since the last migration., а тести завершуються рядками total: 93, failed: 0. Запуск CI виконує все це однією командою.