Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,19 @@

## [Не выпущено]

### Добавлено

- `PilotUiTestBase.ClientAccount`: тесты класса под другим пользователем клиента (учётка из `accounts`, у учётки - необязательный `clientUser` для сверки подписи профиля). Работающий клиент закрывается, записывается вход учётки, после класса клиент закрывается и прежний сохранённый вход возвращается.
- `PilotApp.QuitRunning(config)` и `PilotClientLogin.SettingsPath(config)`.
- `PilotChat` (`PilotPage.Chat()`) и раздел каталога `PilotIds.Chat`: отправка сообщения, лента сообщений, щелчок по ссылке в сообщении. Разведано на Pilot-BIM 26.20.
- `PilotServerClient.GetCommonSetting` и `SetCommonSetting`: общие настройки базы для оргединицы, запись с ожиданием, что сервер её вернул.
- `PilotCommonSettingsWindow.FeatureRows(ключ)`: строки конфигураций одной настройки.

### Исправлено

- `SetAttributesAndWait` с пустым массивом (оргединицы, строки) ждал до таймаута: сервер хранит пустой массив как отсутствие значения.
- `PilotApp.StartOrAttach` изредка падал с `NullReferenceException` сразу после запуска клиента (FlaUI читает главный модуль процесса, которого ещё нет). Теперь подключение ждёт загрузки процесса, а если процесс сразу завершился, сообщает код выхода и путь к журналу клиента.

## [0.4.0] - 2026-11-15

### Изменено
Expand Down
24 changes: 22 additions & 2 deletions docs/pilot-ui-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,17 @@ public class MyModuleTests : PilotUiTestBase
| `PilotToolbar` | панель команд | кнопка по id = имя из построителя (и у модулей), `IsEnabled/IsChecked/IsHidden` из ItemStatus, меню кнопки `<id>ContextMenu`, скрытые кнопки через «…» |
| `PilotMenu` | меню | контекстное (клавиша «Меню» или правый клик), кнопки панели, главное; `Click("id", "id подпункта")`, `ClickText(...)`, `Items()` |
| `PilotCard` | карточка атрибутов | в любом окне и области: `Set`, `Choose`, `SetDate`, `PickReference`, `AddOrgUnit`, `ObligatoryAttributes` - с проверкой введённого; в справочнике уже отмеченная строка не нажимается повторно (клик снял бы отметку), выбор без изменений закрывается «Отменой» (`PilotReferenceBook.Submit`) |
| `PilotChat` | `page.Chat()` | панель чата Pilot в области страницы (вкладка «Чаты», чат объекта, чат в представлении модуля): `Send(текст)` с ожиданием сообщения в ленте, `Messages()`, `WaitMessage(текст)`, `ClickLink(адрес)` - щелчок мышью в первую строку ссылки в сообщении |
| `UiGrid` | таблица | `RowCount`, `Columns()`, `Cell(строка, колонка)`, `FindRow`, `SelectRow` (FieldName или подпись колонки) |
| `PilotMessageBox`, `PilotErrorWindow`, `WindowsFileDialog` | стандартные окна | `Answer(Yes/No/Cancel/Ok)` по фактическому набору кнопок; текст ошибки; открыть файл |
| `By`, `Wait`, `UiActions` | ядро | селекторы; ожидания `Wait.Until(() => …)` без таймаута (описание - из текста условия), `Wait.Stays`; действия над найденным элементом для page object'ов модулей |
| `PilotServerClient` | `Server` | прежнее + `…AndWait` (подтверждение чтением и мгновенный отказ, если сервер отклонил изменение), `DeletePermanently`, `WaitDescendant`, `TaskAttachments`, `Errors` |
| `PilotServerClient` | `Server` | прежнее + `…AndWait` (подтверждение чтением и мгновенный отказ, если сервер отклонил изменение), `DeletePermanently`, `WaitDescendant`, `TaskAttachments`, `Errors`, общие настройки `GetCommonSetting/SetCommonSetting(ключ, значение, оргединица)` (нужен администратор базы) |
| `PilotSandbox` | `TestData` | корень «{префикс} {класс} {время}» в корне базы, `CreateFolder/CreateDocument/Create`, `Unique(...)`, `Track(id)`; после класса удаляет окончательно и проверяет: поддерево корня, объекты из `Track` с их поддеревьями и объекты, которые тест удалил из песочницы в корзину (находятся по наборам изменений прогона и атрибуту `Delete_source`). Объект старше песочницы и его предки не удаляются (сервер удалил бы его вместе с родителем) - это отчёт об ошибке уборки. Удалённое в корзину через интерфейс под другим пользователем уборка видит, только если учётка Server API - администратор (иначе - предупреждение) |

Базовый класс `PilotUiTestBase` дополнительно даёт `Step(...)` (журнал шагов), `RequireTypes(...)`, `OpenExplorer(...)`, `Track(...)`
(вкладка или представление модуля закроется после теста/класса), `RestoreFileAfterTests(путь)`, `AssertNoPilotErrors()`,
`AssertNoPluginErrors()`, `NewOutputPath(имя)`.
`AssertNoPluginErrors()`, `NewOutputPath(имя)`, `ServerAs(учётка)` (Server API под другим пользователем) и `ClientAccount`
(клиент в тестах класса под другим пользователем, см. «Клиент под другим пользователем»).

## Каталог идентификаторов

Expand Down Expand Up @@ -135,6 +137,24 @@ public class MyModuleTests : PilotUiTestBase
PilotClientLogin.Save(PilotUiConfig.Load(), "bot", password); // exe, клиент и serverUrl - из конфигурации
```

### Клиент под другим пользователем

Класс тестов, которому нужен клиент под другим пользователем (например, без прав администратора), переопределяет `ClientAccount` -
имя учётки из ключа `accounts`:

```csharp
protected override string ClientAccount => "worker";
```

```json
"accounts": { "worker": { "login": "ui_worker", "password": "…", "clientUser": "ui_worker (Сотрудник)" } }
```

Перед запуском клиента работающий клиент закрывается (`PilotApp.QuitRunning`, «-quit»), в настройки записывается вход учётки, а подпись
кнопки профиля сверяется с её `clientUser` (вместо общего `clientUser`). После всех тестов класса клиент закрывается и прежний сохранённый
вход возвращается побайтно - следующий класс запускает клиент под своим пользователем. Учётки нет - тесты класса пропускаются.
Пароль учётки, как и другие, лучше держать в `pilot-ui-tests.local.json` или `PILOT_UI_ACCOUNT_<ИМЯ>_LOGIN/_PASSWORD`.

`StartOrAttach` не ждёт `clientStartTimeoutSeconds`, если клиент не войдёт: сразу бросает исключение с причиной, когда процесс клиента
завершился, когда у клиента нет сохранённого входа (`ConnectionState:NoSettings`, «Необходимо настроить соединение») и когда
в `client.log` записано исключение, после которого клиент перестаёт подключаться (неверный пароль, другая версия сервера).
Expand Down
125 changes: 125 additions & 0 deletions src/PilotUITesting/Client/Controls/PilotChat.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
using System;
using System.Collections.Generic;
using System.Drawing;
using System.Linq;
using FlaUI.Core.AutomationElements;
using FlaUI.Core.Definitions;
using PilotUITesting.Uia;

namespace PilotUITesting.Client
{
/// <summary>
/// Панель чата Pilot (<see cref="PilotIds.Chat"/>): вкладка «Чаты», окно чата объекта, чат объекта в представлении модуля.
/// Сообщения - строки ленты (Name = текст сообщения), ссылки в тексте - Hyperlink с адресом в Name.
/// Берётся через <see cref="PilotPage.Chat"/>.
/// </summary>
public sealed class PilotChat
{
private readonly Func<AutomationElement> _container;
private readonly string _description;

internal PilotChat(Func<AutomationElement> container, string description)
{
_container = container;
_description = description;
}

/// <summary>Панель чата (ChatView); нет за <see cref="Wait.DefaultTimeout"/> - исключение.</summary>
public AutomationElement Root => Wait.For(() => _container()?.TryById(PilotIds.Chat.Container), Wait.DefaultTimeout, "панель чата в " + _description);

/// <summary>Тексты сообщений ленты, которые сейчас есть в дереве UI Automation, в порядке ленты (системные - тоже).</summary>
public IReadOnlyList<string> Messages()
{
return MessageItems().Select(m => m.SafeName()).ToList();
}

/// <summary>Дождаться сообщения с точным текстом (Name строки ленты, без нормализации); timeout null - <see cref="Wait.DefaultTimeout"/>.</summary>
public AutomationElement WaitMessage(string text, TimeSpan? timeout = null)
{
if (text == null)
{
throw new ArgumentNullException(nameof(text));
}
return Wait.ForStrict(() => MessageItems().LastOrDefault(m => m.SafeName() == text), timeout ?? Wait.DefaultTimeout,
$"сообщение «{text}» в чате ({_description})", () => "сообщения: " + string.Join(" | ", Messages().Select(m => "«" + m + "»")));
}

/// <summary>
/// Отправить сообщение: текст в поле нового сообщения (ValuePattern), «Отправить» после того, как она стала доступна,
/// и дождаться в ленте нового сообщения с этим текстом (прежние сообщения с тем же текстом не засчитываются).
/// Пустой чат объекта (ещё без сообщений) создаётся первым сообщением. Текст сравнивается точно - без пробелов по краям.
/// </summary>
public AutomationElement Send(string text, TimeSpan? timeout = null)
{
if (string.IsNullOrWhiteSpace(text) || text.Trim() != text)
{
throw new ArgumentException("Нужен текст сообщения без пробелов по краям (сообщение в ленте сравнивается точно)", nameof(text));
}
AutomationElement root = Root;
List<AutomationElement> before = MessageItems().Where(m => m.SafeName() == text).ToList();
UiActions.SetValue(root.ById(PilotIds.Chat.NewMessage, Wait.DefaultTimeout), text, "поле нового сообщения чата (" + _description + ")");
AutomationElement send = root.ById(PilotIds.Chat.Send, Wait.DefaultTimeout);
Wait.Until(() => UiQuery.Read(() => send.IsEnabled, Wait.DefaultTimeout, "доступность «Отправить»"), Wait.DefaultTimeout, "«Отправить» доступна");
UiActions.Click(send, "«Отправить» в чате (" + _description + ")");
return Wait.ForStrict(() => MessageItems().LastOrDefault(m => m.SafeName() == text && !before.Any(m.Equals)), timeout ?? Wait.DefaultTimeout,
$"новое сообщение «{text}» в чате ({_description})", () => "сообщения: " + string.Join(" | ", Messages().Select(m => "«" + m + "»")));
}

/// <summary>
/// Щёлкнуть мышью по ссылке с адресом <paramref name="address"/> в тексте последнего сообщения, где она есть.
/// Мышью, а не Invoke: Invoke ссылки WPF через UI Automation выполняется синхронно и не возвращает управление, пока
/// обработчик перехода (модальное окно, долгая навигация) не завершится. Щелчок - в первую строку ссылки (TextPattern
/// текста сообщения): длинная ссылка переносится, и в центре её общего прямоугольника текста может не быть.
/// </summary>
public void ClickLink(string address, TimeSpan? timeout = null)
{
if (string.IsNullOrEmpty(address))
{
throw new ArgumentException("Нужен адрес ссылки", nameof(address));
}
(AutomationElement item, AutomationElement text, AutomationElement link) found = (null, null, null);
Wait.ForStrict(() =>
{
found = MessageItems()
.Select(m => (m, m.TryById(PilotIds.Chat.MessageText)))
.Where(p => p.Item2 != null)
.Select(p => (p.m, p.Item2, p.Item2.FindDescendantBfs(e => e.SafeControlType() == ControlType.Hyperlink && e.SafeName() == address, 3)))
.LastOrDefault(p => p.Item3 != null);
return found.link;
},
timeout ?? Wait.DefaultTimeout, $"ссылка «{address}» в сообщениях чата ({_description})",
() => "сообщения: " + string.Join(" | ", Messages().Select(m => "«" + m + "»")));
string description = $"ссылка «{address}» в чате ({_description})";
// сообщение за краем ленты: строки ссылки были бы вне видимой части, и щелчок попал бы в соседний элемент
UiQuery.Read(() =>
{
found.item.Patterns.ScrollItem.PatternOrDefault?.ScrollIntoView();
return true;
}, Wait.DefaultTimeout, "прокрутка к сообщению со ссылкой");
Rectangle line = FirstLine(found.text, found.link);
if (line.IsEmpty)
{
UiActions.Click(found.link, description);
return;
}
UiAct.ClickAt(found.link, new Point(line.X + Math.Min(line.Width / 2, 20), line.Y + line.Height / 2), description);
}

/// <summary>Прямоугольник первой строки ссылки на экране; пустой - текст сообщения не отдаёт строки (нет TextPattern).</summary>
private static Rectangle FirstLine(AutomationElement text, AutomationElement link)
{
Rectangle[] lines = UiQuery.Read(() => text.Patterns.Text.PatternOrDefault?.RangeFromChild(link)?.GetBoundingRectangles(), Wait.DefaultTimeout,
"строки ссылки в тексте сообщения") ?? new Rectangle[0];
return lines.FirstOrDefault(r => r.Width > 0 && r.Height > 0);
}

// без ожидания панели: вызывается в опросах с таймаутом вызывающего
private IEnumerable<AutomationElement> MessageItems()
{
AutomationElement list = _container()?.TryById(PilotIds.Chat.Container)?.TryById(PilotIds.Chat.Messages);
return list == null
? Enumerable.Empty<AutomationElement>()
: list.SafeChildren().Where(c => c.SafeControlType() == ControlType.ListItem);
}
}
}
36 changes: 36 additions & 0 deletions src/PilotUITesting/Client/Ids/PilotIds.Chat.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
namespace PilotUITesting.Client
{
public static partial class PilotIds
{
/// <summary>
/// Панель чата (ChatView): вкладка «Чаты», окно чата объекта, чат объекта в представлении модуля (IChatControlsProvider.GetObjectChatsControl).
/// [Д] дамп Pilot-BIM 26.20, чат замечания в представлении модуля.
/// </summary>
public static class Chat
{
/// <summary>(Custom, класс ChatView) [Д] дамп.</summary>
public const string Container = "AUIDChatView";

/// <summary>Лента сообщений (List, ListView); сообщения - ListItem, Name = текст сообщения [Д] дамп.</summary>
public const string Messages = "messagesListControl";

/// <summary>Текст сообщения (Document, RichTextBox); ссылки в нём - Hyperlink, Name = адрес [Д] дамп.</summary>
public const string MessageText = "messageText";

/// <summary>Автор сообщения (Text) с Hyperlink имени пользователя [Д] дамп.</summary>
public const string MessageAuthor = "authorTextBlock";

/// <summary>Системное сообщение («… добавил(а) … в чат») (Text) [Д] дамп.</summary>
public const string SystemMessage = "chatSystemTextBlock";

/// <summary>Поле нового сообщения (Edit, ValuePattern) [Д] дамп.</summary>
public const string NewMessage = "newMessageTextBox";

/// <summary>«Отправить (Ctrl+Enter)» (Button); недоступна, пока поле сообщения пусто [Д] дамп.</summary>
public const string Send = "sendButton";

/// <summary>Добавить вложения (Button) [Д] дамп.</summary>
public const string AddAttachment = "addAttachmentButton";
}
}
}
Loading