vanessa-automation

Открытый чат проекта https://gitter.im/vanessa-automation Build Status

BDD for 1С:Enterprise

  • Текущий релиз в ветке Master: 1.2.023
  • Разработка ведется в ветке Develop.
  • Телеграм канал, где можно обсудить Ванессу и всё, что связано с тестированием в 1С.

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

  1. Чтобы работала сборка epf надо установить OneScript версии 1.0.20 или выше.
  2. Также, чтобы работала разборка epf надо установить платформу 1С:Предприятие 8.3.10.
  3. Для запуска сборки epf из исходников надо запустить Compile.bat.
  4. Скрипты по сборке/разборке файлов взяты отсюда.
  5. Также скачать Vanessa-Automation можно с помощью команды: opm install vanessa-automation
  6. Сборку Vanessa-Automation-Single можно скачать с помощью команды: opm install vanessa-automation-single

Чтобы зафиксировать изменения epf файлов, нужно запустить Decompile.bat.

Проект использует принцип формирования автодокументации в формате Markdown и видео:

Чтобы у вас работало автосоздание видеоинструкций необходимо установить дополнительный софт. Инструкция здесь. Также по автовидеоинструкциям есть вот это замечательное видео.

Список отличий проекта Vanessa-automation от проекта ADD можно посмотреть тут.

Порядок установки Vanessa-Automation под Windows:

  • интерпретатор 1Script - для работы с иходными файлами 1С с помощью проекта Precommit1C
  • утилита Allure - для формирования отчётов о результатах прохождения тестов

Все должно быть установлено так, чтобы быть доступным через переменную %PATH%

Клонируйте данный репозиторий с помощью ms-git

git clone https://github.com/Pr-Mex/vanessa-automation.git

Инициализируйте подмодули репозитория с помощью ms-git

git submodule update --init --recursive

При использовании SourceTree используйте команду Clone (Клонировать)

Обязательно ознакомьтесь с:

Описание простого использования

  • пишем feature файлы в формате Gherkin - обычно используется редактор Notepad++, Sublime IDE (Vanessa Extension) или связанный проект vanessa-bdd-editor

# encoding: utf-8
# language: ru

Функционал: Запуск и получение результатов запуска сценариев
Как любой разработчик продукта
Я хочу иметь возможность запустить проверку сценариев поведения на конфигурации 1С:Предприятие

# Контекст сценария выполняется всегда перед каждым сценарием

Контекст:
Когда существует разрабатываемая мною конфигурация 1С
И существуют требования заказчика к ожидаемому поведения в каталоге ".\features"

# Каждый сценарий состоит из последовательных связанных шагов

Сценарий: Запуск в консольном режиме
Дано Пусть существует файл ".\vb-execute-profile.json"
И в переменную окружения V83PATH установлено значение "C:\Program Files (x86)\1cv8\8.3.6.2151\bin\1cv8.exe"
Когда я запускаю командную строку '%V83PATH% /Execute .\vanessa-automation.epf /C"StartFeaturePlayer;VBParams=.\vb-execute-profile.json'
Тогда появляется файл с результатами '.\BuildStatus.log'
И в каталоге ".\allurereport" существует HTML отчет о результатах проверки сценариев

Сценарий: Запуск в интерактивном режиме
Дано Пусть я открыл обработку "vanessa-automation.epf"
Когда Я нажал кнопку "Загрузить фичи из каталога"
И указал каталог с требованиями заказчика равным ".\features"
И затем нажал кнопку "Сгенерировать шаблоны обработок"
Также в каталоге ".\features" возникли epf файлы идентичные имени feature файла
И при нажатии кнопки "Запустить сценарии" я вижу автоматизированный запуск обработок с признаком "pending" (ожидает реализации)

Классический вариант использования (без интерактивного режима)

Фактически классический вариант использования представляет собой следующий рутинный порядок:

  • зафиксировали требования к информационной системе;
  • создали автоматизированные сценарии проверки в виде epf файлов;
  • наполнили шаги сценариев (сниппеты) кодом проверки поведения;
  • запустили сценарии проверки поведения и убедились, что они НЕ работают;
  • разработали функционал;
  • запустили сценарии проверки поведения;
  • убедились что сценарии проверки работают и отчет о проверки показывает "Зелёный" статус.

Использование в режиме проверки поведения пользовательского интерфейса

Для команд уже имеющих функционал или производящих доработку типовых конфигураций в интерфейсе Taxi, действует упрощенный порядок использования:

  • зафиксировали требования к информационной системе;
  • создали автоматизированные сценарии проверки в виде epf файлов;
  • разработали управляемые формы или рабочие столы конфигурации в режиме прототипирования;
  • запустили запись интерактивных действий пользователя в режиме менеджера тестирования;
  • получившимся кодом наполнили обработки проверки поведения;
  • дополнили код проверки, кодом проверки данных если это необходимо;
  • разработали основной функционал;
  • запустили сценарии проверки поведения;
  • убедились что сценарии проверки работают и отчет о проверки показывает "Зелёный" статус.

Кто пишет feature файлы ?

Обратите внимание, что фактически feature файлы могут писать все участники команды:

  • менеджер проекта - если обнаружил что заказчику необходимо новое поведение;
  • бизнес или системный аналитик - на основе собранных требований и технических заданий;
  • ведущий разработки - если обнаружил, что требования недостаточно структурированы;
  • архитектор или эксперт 1С - если текущие сценарии некорректно спроектированы с точки зрения метаданных.
  • тестироровщик - когда пишет сценарии для проверки поведения

Если вы не уверены в правильности ожидаемого поведения, используйте для этого системы тэгов, как то:

  • "@Draft@" - черновик требования
  • "@Предварительно" - начальные заметки

и подобные им обозначения

Файл профиля запуска обработки

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

Текущие параметры запуска:

  • Каталог фич - каталог где собраны требования заказчика описанные на языке Gherkin
  • ВыполнитьСценарии - признак того, что необходимо запустить выполнение сценариев
  • ДелатьОтчетВФорматеАллюр - признак того, что необходимо формировать HTML отчёт о результатах проверки
  • КаталогOutputAllureБазовый - адрес каталога для где будет формироваться HTML отчёт
  • ЗавершитьРаботуСистемы - признак того, что окончанию работы необходимо завершить работу 1С предприятия
  • ВыгружатьСтатусВыполненияСценариевВФайл - признак, что необходимо формировать файл с финальным статусом проверки
  • ПутьКФайлуДляВыгрузкиСтатуасВыполненияСценариев - по данному пути будет сформирован файл со статусом проверки (обычно используется на серверах сборки для автоматизированного указания статуса сборки)
  • СписокТеговИсключение - массив текстовых тэгов, для исключения из проверки (используется например для черновиков сценариев и требований)
  • СписокТеговОтбор - массив текстовых тэгов для запуска проверки поведения по сценариям, содержащим любой из указанных тэгов

Пример подобного JSON файла можно найти здесь

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

%V83PATH% /Execute C:\vanessa-automation\vanessa-automation.epf /C"StartFeaturePlayer;VBParams=C:\VBParams.json"

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

Загрузка глобальных переменных из внешнего файла

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

Чтобы воспользоваться этой функциональности, нужно выполнить следующее:

  1. У себя в каталоге с обработкой ванессы создать файл user_settings.json. Сам файл user_settings.json должен отвечать специальному формату:
{
    "userSettings": [
        {
            "user": "USERNAME_1",
            "settings": {
                "ИМЯ_ПЕРЕМЕННОЙ_1": "ЗНАЧЕНИЕ_ПЕРЕМЕННОЙ_1",
                "ИМЯ_ПЕРЕМЕННОЙ_2": "ЗНАЧЕНИЕ_ПЕРЕМЕННОЙ_2",
            }
        },
        {
            "user": "USERNAME_2",
            "settings": {
                "ИМЯ_ПЕРЕМЕННОЙ_1": "ЗНАЧЕНИЕ_ПЕРЕМЕННОЙ_1",
                "ИМЯ_ПЕРЕМЕННОЙ_2": "ЗНАЧЕНИЕ_ПЕРЕМЕННОЙ_2",
            }
        }
    ]
}
  1. В свойства user поставить доменное (локальное) имя пользователя, для которого должны применяться настройки. Именно по этому свойству будет определяться, какие пользовательские настройки нужно загружать.

  2. В свойстве settings прописать конкретные настройки для каждого пользователя. Состав настроек необязательно должен совпадать между пользователями, для какого-то пользователя настройки могут отсутствовать.

  3. Открыть обработку AD - файл user_settings.json подтянется автоматически из каталога, в котором находится AD (поле каталог инструментов на вкладке Сервис). Если такого файла нет, то загрузка молча игнорируется. Имеется возможность указать свой каталог загрузки настроек, он подчиняется свойству Каталог проекта на вкладке Сервис.

Если файл найден, то на основании текущего имени пользователя компьютера или домена (которое определяется через WShell скрипт), ищутся настройки текущего пользователя и загружаются только они. Если настройки не найдены, то выводится предупредительное сообщение.

ЧаВо

Находится здесь

Замечания:

  • пожелания к использованию можно фиксировать в виде Github Issues;

Родительский проект

Полезные ссылки:

Лицензии

  • основная лицензия продукта - BSD v3
  • лицензии стороннего кода - Apache License, GitHub CLA, Freeware, etc

Доступные версии пакета

В разработке

Репозиторий

https://github.com/oscript-library/vanessa-automation

Актуальная версия

vanessa-automation-1.2.28