SaveTest TMS Plugin для VS Code

Расширение VS Code для работы с тест-кейсами в формате SaveTest TMS. Предоставляет удобное создание, редактирование и валидацию YAML файлов тест-кейсов с визуальным редактором.

Основные Возможности

Создание и редактирование

• Инициализация проекта - Автоматическое создание базовой структуры проекта
• Команды создания - Быстрое создание test suite и test case
• Сниппеты - Готовые шаблоны для всех структурных элементов
• Горячие клавиши - Ускоренная работа с часто используемыми командами
• Автогенерация UUID - Автоматическое создание уникальных идентификаторов

Валидация и подсказки

• Валидация JSON Schema - Проверка структуры и типов данных в YAML файлах
• Автодополнение - Подсказки для полей и значений
• Hover подсказки - Описания полей при наведении
• Диагностика - Отображение ошибок в панели Problems
• Quick Fix - Автоматическое исправление распространенных ошибок

Визуальный редактор

• Три режима отображения - Сплит, только дерево, только детали
• Создание кейсов - Создание кейсов с правильной структурой
• Поиск и фильтрация - Быстрый поиск по тест-кейсам
• Drag & Drop - Изменение порядка тест-кейсов
• Поддержка общих кейсов - Создание и применение общих кейсов
• Параметризация - Добавление параметров с различными значениями
• Вложения - Прикрепление вспомогательных файлов к тест-кейсу

Шаблоны

• Пользовательские шаблоны - Настройка шаблонов для любых сущностей через файл конфигурации .save-test

Система знаний

• Нативная поддержка - Автоматическое создание при инициализации проекта
• Классическая разметка - Для статей используется Markdown разметка

Начало работы

Инициализация проекта

1. Откройте папку проекта в VS Code
2. Откройте палитру команд (Ctrl+Shift+P / Cmd+Shift+P)
3. Выполните команду >SaveTest: Инициализировать проект

В результате будет создана следующая структура:

tests/
├── attach/               # Папка для вложений
|
├── test-case/            # Папка с файлами тестовых наборов
|   └── test-suite.yaml   # Пример набора с тест-кейсами
|
└── common-case/          # Папка с общими кейсами
    └── common-case.yaml  # Пример набора с общими кейсами

docs/
└── wiki_example/         # Примеры документации для вики
    └── example.md        # Пример markdown файла для вики

.save-test                # Конфигурация проекта

Создание Test Suite

1. Щелкните правой кнопкой мыши на директории в проводнике
2. Выберите SaveTest: Создать Test Suite
3. Файл test-suite.yaml будет создан автоматически

Работа с тест-кейсами

Через визуальный редактор

1. Откройте файл test-suite.yaml
2. Нажмите на иконку редактора (сплит с лупой) в правом верхнем углу

Через YAML редактор

1. Используйте сниппеты (начните вводить test-case и нажмите Tab)
2. Используйте горячие клавиши:
   • Ctrl+Shift+T/Cmd+Shift+T - Вставить короткий тест-кейс
   • Ctrl+Shift+Alt+T/Cmd+Shift+Alt+T - Вставить полный тест-кейс
   • Ctrl+Shift+S/Cmd+Shift+S - Вставить шаг

Команды

Команды в Command Palette (Ctrl+Shift+P / Cmd+Shift+P)

• SaveTest: Инициализировать проект - Создать структуру проекта
• SaveTest: Создать Test Suite - Создать новый test suite
• SaveTest: Валидировать - Проверить уникальность идентификаторов и валидировать все YAML файлы
• SaveTest: Обновить дерево - Обновить Tree View
• SaveTest: Открыть визуальный редактор - Открыть визуальный редактор для текущего файла

Контекстное меню директории

• SaveTest: Создать Test Suite - Создать test suite в выбранной директории

Контекстное меню редактора (в YAML файлах)

• SaveTest: Генерировать UUID - Сгенерировать UUID
• SaveTest: Вставить тест-кейс (короткий) - Вставить короткий шаблон тест-кейса
• SaveTest: Вставить тест-кейс (полный) - Вставить полный шаблон тест-кейса со всеми полями
• SaveTest: Вставить шаг - Вставить шаг тест-кейса
• SaveTest: Вставить предусловие - Вставить предусловие
• SaveTest: Вставить постусловие - Вставить постусловие
• SaveTest: Вставить итерацию - Вставить итерацию с параметрами
• SaveTest: Вставить общий кейс - Вставить ссылку на общий кейс
• SaveTest: Вставить вложение - Вставить вложение

Полный список команд смотри на вкладке FEATURES -> Commands

Структура Test Suite

suite_id: "uuid"                          # Обязательно, формат UUID
suite_name: "Название"                    # Обязательно
description: "Описание"                   # Опционально
status: "new|in progress|done|archived"   # Опционально
created_at: "2024-01-01T00:00:00Z"        # Опционально, ISO 8601
created_by: "автор"                       # Опционально
test_cases:                               # Обязательно, массив
  - case_id: "uuid"                       # Обязательно, формат UUID
    title: "Название"                     # Обязательно
    description: "Описание"               # Опционально
    estimatedTime: "2m"                   # Опционально
    priority: "high|medium|low"           # Опционально
    tags:                                 # Опционально
      - "тег1"
      - "тег2"
    environment:                          # Опционально
      - name: "Браузер"
        value: "Chrome"
    pre-conditions:                       # Опционально
      - action: "Действие"
        expected_result: "Результат"
    steps:                                # Опционально
      - action: "Действие"
        expected_result: "Результат"
    post-conditions:                      # Опционально
      - action: "Действие"
        expected_result: "Результат"

Разработано командой SaveLink
По вопросам и предложениям: info@save-link.ru