PilotTestHost.Sdk 0.3.0

PilotTestHost

Хост для тестов, выполняющихся внутри клиента Pilot (Pilot-ICE Enterprise / Pilot-BIM). Аналог RevitTestHost: SDK-объекты Pilot живут только в процессе клиента, поэтому тесты, трогающие IObjectsRepository и прочие сервисы, запускаются в самом клиенте.

Состав

• PilotTestHost.Sdk - контракты для тестовых проектов: [PilotFact], ITestContext, IPilotTestLogger.
• PilotTestHost.Plugin - плагин-хост (PilotTestHost.ext2): пункт меню «PilotTestHost → Run Tests», дискавери тестовых сборок, запуск, JSON-отчёт + окно-сводка.

Как это работает

1. Плагин-хост деплоится в %LocalAppData%\ASCON\<клиент>\Development\PilotTestHost\ (Debug-сборка делает это сама).
2. Тестовые сборки (*Tests.dll) кладутся в подпапку Tests\ рядом с плагином - вместе со своими зависимостями (assert-библиотека, сборка тестируемого плагина).
3. В клиенте: меню PilotTestHost → Run Tests. Результаты - окно-сводка + %TEMP%\PilotTestHost\results_*.json.

Тестовые dll грузятся через Assembly.LoadFrom в домен клиента: после пересборки тестов клиент нужно перезапустить.

Как написать тест

using PilotTestHost.Sdk;

public class MyPluginTests
{
    [PilotFact]
    public void Repository_Has_Types(ITestContext ctx)
    {
        var types = ctx.Repository.GetTypes().ToList();
        ctx.Logger.Info($"типов в базе: {types.Count}");
        if (types.Count == 0) throw new Exception("в базе нет типов");
    }

    [PilotFact(Skip = "пример пропуска")]
    public void Not_Ready_Yet() { }
}

Правила: публичный класс с публичным конструктором без параметров; публичный экземплярный void-метод без параметров или с одним ITestContext. Async-методы тестов не поддерживаются. Задачи Pilot SDK ждите через ctx.Await(task) (по умолчанию до 30 с, свой таймаут - вторым аргументом): тест выполняется в UI-потоке клиента, SDK доставляет результаты через этот поток, поэтому task.Wait() и .Result зависают, а Await прокручивает диспетчер. Assert-библиотека - любая (исключения с Assert/Xunit/FluentAssertions в имени типа классифицируются как Failed, прочие - Error).

Тестовый проект ссылается на PilotTestHost.Sdk без копирования сборки в выходную папку - обе стороны должны использовать один экземпляр SDK-сборки (её деплоит хост). Через пакет NuGet:

<PackageReference Include="PilotTestHost.Sdk" Version="0.3.0" ExcludeAssets="runtime" />

Пакет сам копирует тесты после сборки в Debug в Tests\ плагина-хоста тех клиентов (Pilot-ICE Enterprise, Pilot-BIM), где хост установлен: все *.dll и *.pdb выходной папки, кроме Ascon.Pilot.* и PilotTestHost.Sdk.*. Свою цель копирования из проекта можно убрать. Свойства: PilotTestHostDeploy (false - не копировать, true - копировать и в другой конфигурации), PilotTestHostDirIce, PilotTestHostDirBim (папки хоста).

Через ссылку на проект (параметр Private работает только у ProjectReference):

<ProjectReference Include="<путь к PilotTestingTools>\src\PilotTestHost.Sdk\PilotTestHost.Sdk.csproj">
  <Private>false</Private>
</ProjectReference>

Внешний запуск (CLI)

dotnet run --project src\PilotTestHost.Cli -- [--client <exe>] [--filter "Ns.Class.*"] [--output report.json] [--timeout-minutes 30]

CLI запускает клиент Pilot с переменными окружения PILOTTESTHOST_CLI=1, PILOTTESTHOST_OUTPUT, PILOTTESTHOST_FILTER. Хост при старте видит CLI-режим, дожидается готовности клиента (репозиторий отвечает - до 5 минут на автологин), гоняет тесты, пишет отчёт и завершает процесс клиента.

Требование: у клиента должен быть сохранён вход. Сохранить его (клиент закрыт):

pilottest [--client <exe>] --login http://host:5545/database bot <пароль>

Пароль шифруется методом самого клиента (ProtectedDataEx из Ascon.Pilot.Common.dll в папке клиента) под текущим пользователем Windows: открытый пароль в настройках клиент не принимает и показывает «Необходимо настроить соединение». Пароль - читается из stdin, чтобы не оставлять его в истории команд. --login только сохраняет вход, тесты не запускает.

Перед запуском CLI проверяет, что клиент ещё не запущен (второй экземпляр сразу закрывается). Во время ожидания он читает %APPDATA%\ASCON\<клиент>\Logs\client.log и сразу останавливает прогон, если клиент записал исключение, после которого перестаёт подключаться к серверу (неверный пароль - PilotSecurityAccessDeniedException, другая версия сервера - VersionMatchException). Если отчёт не появился, печатаются последние строки журнала.

Коды возврата: 0 - все зелёные; N - количество failed+errored; 101 - инфраструктура (клиент не найден, уже запущен, не вошёл в базу, таймаут, нет отчёта, вход не сохранён); 102 - фатальная ошибка прогона.

По умолчанию ищутся Ascon.Pilot.PilotEnterprise.exe (ICE), затем Ascon.Pilot.PilotBIM.exe.

Фазы

• Фаза 1: UI-запуск, JSON-отчёт, окно-сводка.
• Фаза 2: CLI (headless-запуск клиента, env-протокол, фильтр, коды возврата).
• Фаза 3: [PilotTheory], фикстуры, TRX-отчёт.