Кастомные поля

Кастомные поля — это произвольные пары «ключ-значение», которые вы можете добавлять к тест-кейсам. Как и в случае с тегами, смысл названия поля и его значения будет зависеть от того проекта, в котором это поле используется.

Вы можете использовать кастомные поля для:

• группировки тест-кейсов и результатов тестов по определенным значениям в категории;
• поиска тест-кейсов и результатов тестов с помощью фильтров;
• фильтрации тест-кейсов и результатов тестов с помощью AQL-запросов (например, при создании тест-планов).

Чтобы создать кастомное поле и начать его использовать:

1. Cоздайте кастомное поле на уровне инстанса ТестОпс.
2. Добавьте кастомное поле в проект ТестОпс.
3. Добавьте глобальные или проектные значения кастомных полей.
4. Отредактируйте значения кастомных полей для тест-кейсов вручную или автоматически.

Примечание

Чтобы управлять кастомными полями и их значениями на уровне инстанса и проектов ТестОпс, необходима глобальная роль «Администратор» и проектная роль «Владелец проекта».

Системные кастомные поля

При создании проекта ТестОпс автоматически добавляет в него набор системных кастомных полей:

• Epic, Feature и Story — используются по умолчанию в группировке по кастомным полям Features;
• Suite — используется по умолчанию в группировке по кастомным полям Suites;
• Component — по умолчанию не используется, но часто применяется в пользовательских группировках по кастомным полям и фильтрах.

Системные кастомные поля расположены в разделе Администрирование → Кастомные поля и дублируются в разделе Настройки → Кастомные поля. Их нельзя переименовать, удалить из проекта или инстанса ТестОпс, но вы можете добавить или удалить для них маппинги (см. Установка значений автоматически).

ТестОпс создает маппинги для системных кастомных полей автоматически. Эти маппинги совпадают с теми значениями, которые используются в большинстве адаптеров Allure.

Создание кастомного поля

Перед тем, как вы начнете использовать кастомное поле в конкретном проекте, его должен создать администратор вашего инстанса ТестОпс.

Чтобы создать кастомное поле:

1. Перейдите в раздел Администрирование → Кастомные поля.

2. Нажмите + Поле.

3. Заполните поля:

   • Название — введите название кастомного поля.
   • Тип — нажмите на выпадающий список и выберите тип кастомного поля: Одиночный выбор или Множественный выбор.

   Важно

   После создания кастомного поля нельзя изменить его тип.

4. Нажмите Создать.

Чтобы переименовать существующее кастомное поле, в правом верхнем углу нажмите ⋯ → Переименовать.

Добавление кастомного поля в проект

После того, как администратор создаст кастомное поле, добавьте его в проект. Это может сделать владелец проекта в настройках проекта или администратор инстанса ТестОпс в разделе Администрирование.

1. Перейдите в раздел Администрирование → Кастомные поля.
2. Откройте карточку кастомного поля, которое вы хотите добавить в проект.
3. Перейдите на вкладку Проекты.
4. Нажмите Добавить к проектам.
5. В появившемся окне выберите проекты, в которые нужно добавить выбранное поле, и нажмите Добавить.

Обязательное поле

Обязательное поле — это параметр, при котором пользователь должен указывать значение кастомного поля в каждом тест-кейсе проекта.

Параметр Обязательное поле для кастомного поля может установить:

• администратор инстанса — для всех проектов, в которых добавлено это кастомное поле, или для каждого проекта отдельно;
• владелец проекта — только для своего проекта.

1. Перейдите в раздел Администрирование → Кастомные поля.
2. Откройте карточку кастомного поля, которое вы хотите сделать обязательным.
3. Нажмите ⋯ в правом верхнем углу или перейдите на вкладку Проекты и нажмите ⋯ рядом с названием проекта.
4. Включите переключатель Обязательное поле.

Важно

Владелец проекта не может отключить параметр Обязательное поле, активированный администратором.

Особенности обязательного поля:

• Обязательное поле всегда отображается в карточке тест-кейса.
• Если обязательное поле не заполнено, появляется сообщение «Нет значений».
• Пользователь не может сохранить изменения в настройках кастомных полей, пока не заполнит все обязательные поля.

Добавление значений кастомного поля

Есть два вида значений кастомных полей:

• глобальное значение — создается администратором инстанса и доступно во всех проектах, в которых используется соответствующее кастомное поле;
• проектное значение — создается, как правило, владельцем проекта и доступно только в этом проекте.

1. Перейдите в раздел Администрирование → Кастомные поля.
2. Откройте карточку кастомного поля, для которого хотите добавить значение.
3. На вкладке Глобальные значения нажмите + Значение.
4. Заполните поле Название и при необходимости активируйте параметр Значение по умолчанию.
5. Нажмите Создать.

Администратор инстанса может преобразовать проектные значения в глобальные. Для этого:

1. Перейдите в раздел Администрирование → Кастомные поля.
2. Откройте карточку кастомного поля, значение которого хотите сделать глобальным.
3. Перейдите на вкладку Проектные значения.
4. Нажмите ⋯ рядом со значением и выберите Сделать глобальным.

Блокировка значений

Блокировка значений — это параметр, при котором пользователь может выбирать в кастомных полях только предопределенные глобальные и проектные значения.

Параметр Блокировка значений для кастомного поля может включить:

• администратор инстанса — для всех проектов, в которых добавлено это поле, или для каждого проекта отдельно;
• владелец проекта — только для своего проекта.

Важно

Невозможно включить параметр Блокировка значений для пустого поля.

1. Перейдите в раздел Администрирование → Кастомные поля.
2. Откройте карточку кастомного поля, значения которого вы хотите заблокировать.
3. Нажмите ⋯ в правом верхнем углу или перейдите на вкладку Проекты и нажмите ⋯ рядом с названием проекта.
4. Включите переключатель Блокировка значений.

Важно

Если администратор инстанса включил параметр Блокировка значений для кастомного поля, владелец проекта не может:

• отключить этот параметр в настройках проекта;
• создать новые значения для этого кастомного поля.

Значение по умолчанию

Глобальное или проектное значение кастомного поля можно установить как Значение по умолчанию — оно будет присваиваться автоматически новым тест-кейсам в проектах, в которых используется это кастомное поле.

Значение по умолчанию может установить владелец проекта в настройках проекта или администратор инстанса ТестОпс в разделе Администрирование.

1. Перейдите в раздел Администрирование → Кастомные поля.
2. Откройте карточку кастомного поля, значение которого хотите сделать значением по умолчанию.
3. На вкладке Глобальные значения нажмите ⋯ рядом с названием глобального значения и нажмите Использовать по умолчанию.

Важно

Проектное значение по умолчанию приоритетнее глобального. Если на уровне проекта нет значения по умолчанию, используется глобальное значение по умолчанию.

Объединение значений

Администратор может объединить в разделе Администрирование одно или несколько проектных значений:

• с существующим глобальным значением;
• в новое глобальное значение.

Владелец проекта может объединить в настройках проекта одно или несколько проектных значений:

• с существующим глобальным значением;
• с существующим проектным значением;
• в новое проектное значение.

Важно

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

1. Перейдите в раздел Администрирование → Кастомные поля.

2. Откройте карточку кастомного поля, значение которого хотите объединить.

3. Перейдите на вкладку Проектные значения.

4. Рядом с названием нужного значения нажмите ⋯ → Объединить.

5. Выполните одно из действий:

   • Выберите название существующего глобального значения из списка и нажмите Да, объединить.
   • Нажмите Новое глобальное значение и создайте новое глобальное значение поля для объединения.

Установка значений кастомного поля в тест-кейсах

Установите значение кастомного поля для тест-кейса одним из следующих способов:

• вручную для одного или нескольких тест-кейсов (поддерживается по умолчанию для ручного тестирования; можно настроить для автоматизированного тестирования);
• вручную с помощью группировки по кастомным полям (поддерживается как для ручного, так и для автоматизированного тестирования);
• автоматически (поддерживается только для автоматизированного тестирования).

Совет

Чтобы устанавливать значения кастомных полей вручную для автоматизированных тест-кейсов, измените источник обновления для каждого из этих полей в вашем проекте.

Установка значения вручную для одного или нескольких тест-кейсов

Установка значения вручную для одного тест-кейса

Чтобы добавить значение кастомного поля к тест-кейсу:

1. Перейдите в раздел Тест-кейсы вашего проекта.
2. Откройте карточку нужного тест-кейса.
3. В правой части экрана найдите секцию Кастомные поля и нажмите иконку карандаша.
4. Напротив названия нужного кастомного поля в поле Значение нажмите на выпадающий список и выберите одно или несколько значений.
5. Нажмите Отправить.

Аналогичным способом вы можете удалить одно или несколько значений кастомного поля из тест-кейса.

Установка значения вручную для нескольких тест-кейсов

Чтобы добавить значения кастомных полей сразу к нескольким тест-кейсам, используйте панель массовых операций и выберите ⋯ → Добавить метаданные → Значения кастомных полей. В результате:

• ТестОпс добавит указанные значения в каждый выбранный тест-кейс.
• Существующие значения изменены не будут.

Чтобы удалить значения кастомных полей сразу из нескольких тест-кейсов, используйте панель массовых операций и выберите ⋯ → Удалить метаданные → Значения кастомных полей. В результате:

• ТестОпс удалит значения кастомных полей только из тех тест-кейсов, в которых есть выбранное значение.
• Другие значения изменены не будут.

Установка значений вручную с помощью группировки по кастомным полям

Группировка по кастомным полям — функциональная возможность ТестОпс, позволяющая группировать тест-кейсы в категории по значениям их кастомных полей. Каждая категория соответствует одному значению кастомного поля.

Вы можете перетаскивать тест-кейсы по одному между категориями, менять значение кастомного поля у всех тест-кейсов в категории, создавать новые тест-кейсы сразу с нужным значением кастомного поля. Подробнее см. Группировка по кастомным полям → Добавление тест-кейсов в категорию группировки по кастомным полям.

Установка значений автоматически

1. Перейдите в раздел Настройки → Кастомные поля.

2. Откройте карточку кастомного поля, значение которого должно загружаться из результатов тестов.

3. На вкладке Маппинг нажмите + Маппинг.

4. В появившемся окне введите ключ маппинга, который вы будете использовать в вашем коде, и нажмите Создать.

5. Используйте этот ключ в вашем коде для установки значений кастомного поля.

   Пример на Java:

   @Test
   public void testAuthentication() {
     Allure.label("component", "Core");
     Allure.label("version", "1.23");
     // ...
   }

   Использование ключей маппинга зависит от используемого языка и фреймворка. Вы можете найти больше информации об этом в справочнике адаптера Allure, который вы используете.

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

Изменение источника обновления кастомных полей для автоматизированных тест-кейсов

В ручных тест-кейсах единственным источником обновления кастомных полей являются данные, которые вводят участники проекта через интерфейс ТестОпс.

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

• Тест-кейс — значения обновляются вручную через интерфейс ТестОпс. Этот вариант используется по умолчанию для всех кастомных полей, если у них нет настроенного маппинга.
• Результаты тестов — значения обновляются автоматически из результатов тестов. Этот вариант используется по умолчанию, если у кастомного поля настроен маппинг.

Чтобы устанавливать значение кастомного поля с настроенным маппингом вручную через интерфейс ТестОпс, а не указывать в результатах тестов, измените источник метаданных для этого поля:

1. Откройте ваш проект ТестОпс.
2. Перейдите в раздел Настройки → Кастомные поля.
3. Откройте карточку кастомного поля, для которого ранее был настроен маппинг.
4. Перейдите на вкладку Маппинг.
5. Нажмите иконку настроек справа от + Маппинг и выберите источник метаданных Тест-кейс.

Удаление и восстановление кастомного поля

Кастомное поле можно удалить как из конкретного проекта, так и на уровне всего инстанса ТестОпс. При удалении на уровне инстанса кастомное поле перемещается в список Удаленные, из которого его можно восстановить или удалить навсегда.

Удаление кастомного поля из проекта

Удаление кастомного поля из проекта доступно в настройках проекта его владельцу и администратору инстанса ТестОпс в разделе Администрирование.

Важно

Чтобы удалить кастомное поле из проекта, необходимо предварительно удалить его из всех тест-кейсов и группировок по кастомным полям в этом проекте.

После удаления кастомного поля на уровне проекта оно останется доступным в других проектах ТестОпс и на уровне всего инстанса.

Чтобы удалить кастомное поле из проекта:

1. Перейдите в раздел Администрирование → Кастомные поля.
2. Откройте карточку нужного кастомного поля.
3. Перейдите на вкладку Проекты.
4. Напротив нужного проекта нажмите ⋯ → Удалить из проекта.
5. Нажмите Удалить.

При необходимости вы можете вернуть кастомное поле в проект, добавив его повторно.

Удаление кастомного поля на уровне инстанса

Удаление кастомного поля на уровне инстанса ТестОпс доступно только администратору инстанса в разделе Администрирование.

Важно

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

После удаления кастомного поля на уровне инстанса оно становится недоступным во всех проектах инстанса, включая тест-кейсы и группировки по кастомным полям.

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

1. Перейдите в раздел Администрирование → Кастомные поля.
2. Откройте карточку нужного кастомного поля.
3. В правом верхнем углу нажмите ⋯ → Удалить.
4. Нажмите Удалить.

Примечание

Группировки по кастомным полям, содержащие удаленное поле, перестанут отображаться в списках тест-кейсов и результатов тестов. Чтобы использовать группировку, замените или удалите кастомное поле в ее настройках.

Восстановление кастомного поля из списка удаленных полей

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

1. Перейдите в раздел Администрирование → Кастомные поля → вкладка Удаленные.
2. Откройте карточку нужного кастомного поля.
3. В правом верхнем углу нажмите Восстановить.
4. Нажмите Восстановить.

Кастомное поле со всеми значениями вернется в список Активные и появится во всех проектах, в которые оно было добавлено до удаления, включая тест-кейсы и группировки по кастомным полям.

Удаление кастомного поля из списка удаленных полей

Важно

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

Чтобы удалить кастомное поле навсегда:

1. Перейдите в раздел Администрирование → Кастомные поля → вкладка Удаленные.
2. Откройте карточку нужного кастомного поля.
3. В правом верхнем углу нажмите Удалить навсегда.
4. Нажмите Удалить.