Сайт

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

Для начала работы с плагином:

  1. Откройте корневую папку проекта.
  2. Откройте палитру команд, нажав клавишу F1 или сочетание клавиш Ctrl+Shift+P.
  3. Выполните команду SaveTest: Инициализировать проект.
  4. Дождитесь сообщения об успешной инициализации.

Инфо

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

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

Структура проекта

Созданный проект имеет следующую структуру:

tests/                      # Корневой каталог тестовых артефактов
├── attach/                 # Вложения
├── test-case/              # Тестовые наборы
│   └── test-suite.yaml     
└── common-case/            # Общие кейсы
    └── common-case.yaml    

docs/                       # Документация проекта в Markdown
└── wiki_example/
    └── example.md          # Пример статьи wiki

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

Структура тестовых наборов

При инициализации проекта автоматически создаются тестовые наборы в YAML-формате. Подробнее о структуре файла читайте в разделе YAML-формат.

В форматах Gherkin и Python часть атрибутов SaveTest хранится в декораторах или тегах:

  • # savetest_status:, # savetest_author:, # savetest_created_at: — метаданные набора.
  • # savetest_case_* — метаданные кейса.

Подробнее о структуре форматов читайте в соответствующих разделах Gherkin-формат и Python-формат.

Инфо

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

Wiki

При инициализации проекта создается пример статьи docs/wiki_example/example.md.
Специальных команд wiki в плагине нет: статьи редактируются как обычные Markdown-файлы.

Файл конфигурации

В файле конфигурации хранятся настройки проекта и шаблоны для создания новых элементов. Это позволяет централизованно управлять параметрами среды и структурой тестовых артефактов. Подробнее про шаблоны читайте в разделе Шаблоны.