diff --git a/CHANGELOG.md b/CHANGELOG.md index 8d86baa..e89e00f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ ### Изменено -- Лицензия проекта изменена с MIT на Apache-2.0: обновлены файл `LICENSE` и поле `PackageLicenseExpression` в `Directory.Build.props`. +- Лицензия проекта изменена с MIT на Apache-2.0: обновлены файл `LICENSE` и поле `PackageLicenseExpression` в `Directory.Build.props`. Выпущенные версии 0.2.0 и 0.3.0 остаются под MIT; Apache-2.0 действует с версии, в которой это изменение будет выпущено. ## [0.3.0] - 2026-10-18 diff --git a/README.md b/README.md index 5c4e364..176c820 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,22 @@ UI-тесты проверялись вживую на Pilot-ICE Enterprise. Д | `PilotUITesting-Inspector-<версия>.zip` | инспектор дерева UI Automation | | `SHA256SUMS.txt` | контрольные суммы всех файлов | +Консольный запуск из архива: распакуйте `PilotTestHost-Cli-<версия>.zip` в любую папку (нужен .NET 8 Runtime), `pilottest.exe` лежит в корне. Плагин-хост из `PilotTestHost-Plugin-<версия>.zip` должен быть установлен, тестовые сборки лежат в его подпапке `Tests\`, у клиента сохранён вход (см. «Быстрый старт»). + +```powershell +.\pilottest.exe --filter "MyPlugin.Tests.*" --output report.json +``` + +Без `--client` ищется `C:\Program Files\ASCON\Pilot-ICE Enterprise\Ascon.Pilot.PilotEnterprise.exe`, затем `C:\Program Files\ASCON\Pilot-BIM\Ascon.Pilot.PilotBIM.exe`; другой путь задаётся `--client `. Список аргументов: `pilottest.exe --help`. + +Инспектор: в `PilotUITesting-Inspector-<версия>.zip` лежит `PilotUITesting.Inspector.exe` (.NET Framework 4.8) с зависимостями. Он подключается к запущенному клиенту по имени процесса (команда `start` запускает процесс сама) и сохраняет дерево UI Automation и снимок экрана в `%TEMP%\PilotUITesting`. Команды `dump`, `shot`, `start`, `click`, `row`, `type`, `keys`, `cancel`: + +```powershell +.\PilotUITesting.Inspector.exe dump Ascon.Pilot.PilotEnterprise +``` + +Подробнее: [docs/pilot-ui-testing.md](docs/pilot-ui-testing.md#инспектор). + ## Быстрый старт ### Тесты внутри клиента @@ -100,7 +116,7 @@ pilottest --filter "MyPlugin.Tests.*" --output report.json { "client": "PilotIce", // PilotIce | PilotBim "serverUrl": "http://host:5545/database", // сервер и база - "clientUser": "bot (bot)", // под кем вошёл клиент (сверяется) + "clientUser": "bot (Инженер)", // под кем вошёл клиент: подпись кнопки профиля (сверяется) "dpiAware": true, "resetUiBeforeEachTest": true } @@ -139,7 +155,7 @@ Debug-сборка `PilotTestHost.Plugin` дополнительно копир ## Выпуск -Файлы релиза собирает `tools/pack-release.ps1`, по тегу `v*` их собирает и workflow на GitHub Actions. Порядок: [RELEASING.md](RELEASING.md). История изменений: [CHANGELOG.md](CHANGELOG.md). +Файлы релиза собирает `tools/pack-release.ps1`, по тегу `v*` их собирает и workflow на GitHub Actions: он же создаёт черновик релиза с пометкой pre-release и публикует пакеты в nuget.org. Порядок: [RELEASING.md](RELEASING.md). История изменений: [CHANGELOG.md](CHANGELOG.md). ## Участие @@ -147,4 +163,4 @@ Debug-сборка `PilotTestHost.Plugin` дополнительно копир ## Лицензия -Проект распространяется по лицензии [Apache 2.0](LICENSE). +Проект распространяется по лицензии [Apache 2.0](LICENSE). Версии 0.2.0 и 0.3.0 (пакеты NuGet и исходники по тегам) выпущены под MIT и остаются под ней; Apache-2.0 действует с версии, в которой это изменение будет выпущено ([CHANGELOG.md](CHANGELOG.md)). diff --git a/RELEASING.md b/RELEASING.md index 217e078..87aa91b 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -1,8 +1,9 @@ # Выпуск версии 1. Поднимите `Version` в [Directory.Build.props](Directory.Build.props). Версия общая для всех проектов. -2. Перенесите записи из раздела «Не выпущено» в [CHANGELOG.md](CHANGELOG.md) под заголовок новой версии с датой и поправьте ссылки внизу файла. -3. Проверьте локально: +2. Перенесите записи из раздела «Не выпущено» в [CHANGELOG.md](CHANGELOG.md) под заголовок новой версии с датой и поправьте ссылки внизу файла. Workflow сверяет только тег с `Version` и наличие раздела версии в `CHANGELOG.md`. +3. Обновите упоминания версии в документации, они не подставляются автоматически: `Версия ...` и `PackageReference` в [README.md](README.md), `PackageReference` в [docs/pilot-test-host.md](docs/pilot-test-host.md). Найти их: `git grep -n "<предыдущая версия>" -- README.md docs`. +4. Проверьте локально: ```powershell dotnet build PilotTestingTools.sln -c Release @@ -11,19 +12,19 @@ ``` Файлы релиза появятся в `artifacts/`: архив плагина-хоста, CLI, инспектор, два пакета `.nupkg` с символами `.snupkg` и `SHA256SUMS.txt`. -4. Закоммитьте изменения, поставьте тег и отправьте его: +5. Закоммитьте изменения, поставьте тег и отправьте его: ```powershell - git tag -a v0.2.0 -m "v0.2.0" - git push origin main v0.2.0 + git tag -a v<версия> -m "v<версия>" + git push origin main v<версия> ``` -5. Workflow [release.yml](.github/workflows/release.yml) по тегу `v*` проверит, что версия тега совпадает с `Version`, соберёт и проверит решение, подготовит те же файлы и создаст на GitHub черновик релиза с пометкой pre-release. Описание берётся из раздела версии в `CHANGELOG.md`. Проверьте черновик и опубликуйте его. -6. Там же workflow отправляет пакеты в nuget.org через Trusted Publishing: на nuget.org настроена политика для репозитория `PilotOpenTools/PilotTestingTools` и файла `release.yml`, ключ API не хранится. Политика для приватного репозитория первое время действует временно, её нужно успеть использовать первым выпуском. Если публикация из workflow не прошла, отправьте пакеты вручную (нужен ключ API): +6. Workflow [release.yml](.github/workflows/release.yml) по тегу `v*` проверит, что версия тега совпадает с `Version`, соберёт и проверит решение, подготовит те же файлы и создаст на GitHub черновик релиза с пометкой pre-release. Описание берётся из раздела версии в `CHANGELOG.md`. Проверьте черновик и опубликуйте его. +7. Там же workflow отправляет пакеты в nuget.org через Trusted Publishing: на nuget.org настроена политика для репозитория `PilotOpenTools/PilotTestingTools` и файла `release.yml`, ключ API не хранится. Если публикация из workflow не прошла, отправьте пакеты вручную (нужен ключ API): ```powershell - dotnet nuget push artifacts/PilotTestHost.Sdk.0.2.0.nupkg --source https://api.nuget.org/v3/index.json --api-key <ключ> - dotnet nuget push artifacts/PilotUITesting.0.2.0.nupkg --source https://api.nuget.org/v3/index.json --api-key <ключ> + dotnet nuget push artifacts/PilotTestHost.Sdk.<версия>.nupkg --source https://api.nuget.org/v3/index.json --api-key <ключ> + dotnet nuget push artifacts/PilotUITesting.<версия>.nupkg --source https://api.nuget.org/v3/index.json --api-key <ключ> ``` Файлы `.snupkg` с символами лежат рядом, `dotnet nuget push` отправляет их вместе с пакетом. diff --git a/docs/pilot-ui-testing.md b/docs/pilot-ui-testing.md index 2895279..b5d10f6 100644 --- a/docs/pilot-ui-testing.md +++ b/docs/pilot-ui-testing.md @@ -2,7 +2,7 @@ Библиотека для сквозных UI-тестов модулей Pilot-ICE Enterprise / Pilot-BIM: тесты запускают (или подхватывают) настоящий клиент Pilot, прокликивают интерфейс через UI Automation (FlaUI) как пользователь и проверяют результат в базе через Ascon.Pilot.Server.Api. -Дополняет [PilotTestHost](pilot-test-host.md): тот выполняет тесты внутри процесса клиента на уровне SDK, а эта библиотека работает снаружи. +Дополняет [PilotTestHost](https://github.com/PilotOpenTools/PilotTestingTools/blob/main/docs/pilot-test-host.md): тот выполняет тесты внутри процесса клиента на уровне SDK, а эта библиотека работает снаружи. В библиотеке уже заготовлено то, что раньше каждый проект тестов писал сам: @@ -22,7 +22,7 @@ |--------|-----------| | `src/PilotUITesting` | библиотека (net48; FlaUI.UIA3 5.0, Ascon.Pilot.Server.Api 26.1, NUnit 4.3) | | `tests/PilotUITesting.Tests` | модульные тесты библиотеки (без клиента Pilot) и снимок публичного API | -| `tools/PilotUITesting.Inspector` | консольный инспектор: подробный дамп дерева UI Automation окон клиента, клики, ввод | +| `tools/PilotUITesting.Inspector` | консольный инспектор: дамп дерева UI Automation окон процесса и снимки экрана, запуск процесса, клики, выбор строки, ввод текста и клавиш, закрытие модальных окон (команды ниже, раздел «Инспектор») | ## Быстрый старт @@ -129,7 +129,7 @@ public class MyModuleTests : PilotUiTestBase ### Сохранённый вход клиента Клиент входит в базу сам, по сохранённому входу. Сохранить его можно при закрытом клиенте: `pilottest --login <сервер> <пользователь> <пароль>` -(см. [pilot-test-host.md](pilot-test-host.md)) или из кода, например в `[SetUpFixture]` до запуска клиента: +(см. [pilot-test-host.md](https://github.com/PilotOpenTools/PilotTestingTools/blob/main/docs/pilot-test-host.md)) или из кода, например в `[SetUpFixture]` до запуска клиента: ```csharp PilotClientLogin.Save(PilotUiConfig.Load(), "bot", password); // exe, клиент и serverUrl - из конфигурации @@ -203,6 +203,7 @@ dotnet test tests\PilotUITesting.Tests\PilotUITesting.Tests.csproj ``` PilotUITesting.Inspector dump [процесс=Ascon.Pilot.PilotBIM] [папка] [глубина] +PilotUITesting.Inspector shot [процесс=Ascon.Pilot.PilotBIM] [папка] PilotUITesting.Inspector start "C:\Program Files\ASCON\Pilot-BIM\Ascon.Pilot.PilotBIM.exe" [папка] PilotUITesting.Inspector click Ascon.Pilot.PilotEnterprise "id=AddTabButton|name=Кнопка|text=часть" [папка] [ждать мс] PilotUITesting.Inspector row Ascon.Pilot.PilotEnterprise "текст строки" [папка] @@ -211,6 +212,8 @@ PilotUITesting.Inspector keys Ascon.Pilot.PilotEnterprise "{ESC}" [папка] PilotUITesting.Inspector cancel Ascon.Pilot.PilotEnterprise [папка] [id1,id2] ``` +`dump` сохраняет дерево и снимок окон процесса, `shot` только снимки, `start` запускает процесс и через 15 с делает дамп, `click`, `row`, `type`, `keys` и `cancel` выполняют действие и затем делают дамп. `keys` отправляет клавиши в активное окно (имя процесса нужно только для дампа после нажатия). Без папки результат пишется в `%TEMP%\PilotUITesting`. + Инспектор включает осведомлённость о DPI, дамп подробный (класс, прямоугольник, HelpText, ItemStatus, ItemType, значение, паттерны). ## Что не проверено