Coder Social home page Coder Social logo

artbear / 1bdd Goto Github PK

View Code? Open in Web Editor NEW
28.0 7.0 17.0 3.67 MB

1BDD для OneScript - консольный фреймворк, реализующий BDD для проекта OneScript. Для Windows и Linux.

License: Mozilla Public License 2.0

1C Enterprise 83.51% Gherkin 16.49%
bdd oscript

1bdd's Introduction

1BDD для OneScript

GitHub release Тестирование GitHub Workflow Status Статус Порога Качества Покрытие Технический долг Строки кода

Vanessa open-sourceChat on Telegram vanessa_opensource_chat или oscript_library Chat on Telegram oscript_library - в этих чатах вы можете задавать любые вопросы разработчикам и активным участникам.

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

Иными словами, это консольный фреймворк, реализующий BDD для проекта OneScript. Для Windows и Linux.

Идеи черпаются из проекта Cucumber.

Основная документация находится в каталоге документации

  • в т.ч. библиотека полезных стандартных шагов
  • API продукта

Ниже краткая информация о возможностях продукта.

Командная строка запуска

oscript bdd.os <features-path> [ключи]
oscript bdd.os <команда> <параметры команды> [ключи]

Возможные команды:
	<features-path> [ключи]
	или
	exec <features-path> [ключи]
		Выполняет сценарии BDD для Gherkin-спецификаций
		Параметры:
			features-path - путь к файлам *.feature.
			Можно указывать как каталоги, так и конкретные файлы.

			-fail-fast - Немедленное завершение выполнения на первом же не пройденном сценарии

			-name <ЧастьИмениСценария> - Выполнение сценариев, в имени которого есть указанная часть
			-junit-out <путь-файла-отчета> - выводить отчет тестирования в формате JUnit.xml

	gen <features-path> [ключи]
		Создает заготовки шагов для указанных Gherkin-спецификаций
		Параметры:
			features-path - путь к файлам *.feature.
				Можно указывать как каталог, так и конкретный файл.

Возможные общие ключи:
	-require <путь каталога или путь файла> - путь к каталогу фича-файлов или к фича-файлу, содержащим библиотечные шаги.
		Если эта опция не задана, загружаются все os-файлы шагов из каталога исходной фичи и его подкаталогов.
		Если опция задана, загружаются только os-файлы шагов из каталога фича-файлов или к фича-файла, содержащих библиотечные шаги.

	-out <путь лог-файла>
	-debug <on|off> - включает режим отладки (полный лог + остаются временные файлы)
	-verbose <on|off> - включается полный лог

Для подсказки по конкретной команде наберите bdd help <команда>.

Формат файла фичи

Файл фичи должен иметь расширение feature и написан согласно синтаксису языка Gherkin

Пример файла фичи

# language: ru

Функционал: Выполнение файловых операций
    Как Пользователь
    Я хочу иметь возможность выполнять различные файловые операции в тексте фич
    Чтобы я мог проще протестировать и автоматизировать больше действий на OneScript

Сценарий: Каталог проекта
    Допустим Я создаю временный каталог и сохраняю его в контекст
    И Я устанавливаю временный каталог как рабочий каталог
    Когда Я сохраняю каталог проекта в контекст
    Тогда Я показываю каталог проекта
    И Я показываю рабочий каталог

или

# language: ru

Функционал: Использование программного контекста
	Как Разработчик
	Я Хочу чтобы шаги разных сценариев могли обмениваться данными через програмнный контекст продукта

Сценарий: Первый сценарий

  Когда Я сохранил ключ "Ключ1" и значение 10 в программном контексте
  И я получаю ключ "Ключ1" и значение 10 из программного контекста

Сценарий: Следующий сценарий

  Тогда я получаю ключ "Ключ1" и значение 10 из программного контекста

Формат файла шагов

Это обычный os-скрипт, который располагает в подкаталоге step_definitions относительно файла фичи.

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

Также внутри файла шагов могут располагаться специальные методы-обработчики (хуки) событий ПередЗапускомСценария/ПослеЗапускаСценария

Пример файла шагов

// Реализация шагов BDD-фич/сценариев c помощью фреймворка https://github.com/artbear/1bdd

Перем БДД; //контекст фреймворка 1bdd

// Метод выдает список шагов, реализованных в данном файле-шагов
Функция ПолучитьСписокШагов(КонтекстФреймворкаBDD) Экспорт
	БДД = КонтекстФреймворкаBDD;

	ВсеШаги = Новый Массив;

	ВсеШаги.Добавить("ЯСохранилКлючИЗначениеВПрограммномКонтексте");
	ВсеШаги.Добавить("ЯПолучаюКлючИЗначениеИзПрограммногоКонтекста");

	Возврат ВсеШаги;
КонецФункции

// Реализация шагов

// Процедура выполняется перед запуском каждого сценария
Процедура ПередЗапускомСценария(Знач Узел) Экспорт

КонецПроцедуры

// Процедура выполняется после завершения каждого сценария
Процедура ПослеЗапускаСценария(Знач Узел) Экспорт

КонецПроцедуры

//Я сохранил ключ "Ключ1" и значение 10 в программном контексте
Процедура ЯСохранилКлючИЗначениеВПрограммномКонтексте(Знач Ключ, Знач Значение) Экспорт
	БДД.СохранитьВКонтекст(Ключ, Значение);
КонецПроцедуры

//я получаю ключ "Ключ1" и значение 10 из программного контекста
Процедура ЯПолучаюКлючИЗначениеИзПрограммногоКонтекста(Знач Ключ, Знач ОжидаемоеЗначение) Экспорт
	НовоеЗначение = БДД.ПолучитьИзКонтекста(Ключ);
	Ожидаем.Что(НовоеЗначение).Равно(ОжидаемоеЗначение);
КонецПроцедуры

API фреймворка

Есть несколько вариантов использования API фреймворка из кода реализации шагов.

Основная документация по шагам находится в каталоге документации

Стандартная библиотека

Стандартные библиотечные шаги, подключаемые автоматически для любой фичи, находятся в каталоге features/lib

  • ВыполнениеКоманд.feature - выполнение команд системы и запуск процессов
  • ФайловыеОперации.feature - создание файлов/каталогов, их копирование, анализ содержимого файлов

Основная документация по шагам находится в каталоге документации

Расширения для Visual Studio Code

Для Visual Studio Code созданы расширения, облегчающие работу с файлами фич:

  • Snippets and Syntax Highlight for Gherkin (Cucumber) - подсветка синтаксиса и автодополнение ключевых слов Gherkin.
  • Gherkin step autocomplete - автодополнение шагов в файлах фич. У этого расширения есть настройка gherkin-autocomplete.featureLibraries, которая позволяет подключить внешние по отношению к проекту библиотеки шагов (например, установленную вместе с 1bdd). По Shift+F12/Shift+Alt+F12 можно перейти к реализации текущего шага - если она есть в текущем проекте и/или внешних библиотеках.

1bdd's People

Contributors

240596448 avatar artbear avatar evilbeaver avatar gitter-badger avatar nixel2007 avatar pumbaeo avatar realmaxa avatar theshadowco avatar zeratulayuris avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

1bdd's Issues

Общий контекст при выполнении различных шагов и фич

Originally reported by: artbear (Bitbucket: artbear, GitHub: artbear)


https://cucumber.io/docs/reference#background

Проверить поведение

  • два сценария с общим background
  • использование разных background в одной фиче для проверки выполнения только одного background
  • совместное использование background и структуры сценария

При выполнении фич из каталога показывать сводный отчет по выполнению

Originally reported by: artbear (Bitbucket: artbear, GitHub: artbear)


Итоговое число фич, сценариев и шагов

4 Функциональность ( 4 Пройден, 0 Не реализован, 0 Сломался, 0 Не выполнялся )
6 Сценарий ( 6 Пройден, 0 Не реализован, 0 Сломался, 0 Не выполнялся )
19 Шаг ( 19 Пройден, 0 Не реализован, 0 Сломался, 0 Не выполнялся )

Свободное описание в тексте фичи

Originally reported by: artbear (Bitbucket: artbear, GitHub: artbear)


Пример using_descriptions.feature из доки cucumber-ruby

Feature: Using descriptions to give features context

  When writing your feature files its very helpful to use description
  text at the beginning of the feature file, to write a preamble to the
  feature describing clearly exactly what the feature does.

  You can also write descriptions attached to individual scenarios - see
  the examples below for how this can be used.

  It's possible to have your descriptions run over more than one line,
  and you can have blank lines too. As long as you don't start a line
  with a Given, When, Then, Background:, Scenario: or similar, you're
  fine: otherwise Gherkin will start to pay attention.

Использование параметров Строка с кавычками внутри апострофов

Originally reported by: artbear (Bitbucket: artbear, GitHub: artbear)


Сценарий: Использование параметров Строка с кавычками внутри апострофов
    Когда я передаю параметр 'Начало "ВнутриКавычек" Конец'
    Тогда я получаю параметр с типом "Строка"

Неверная передача параметров, если в одном шаге есть обычные параметры и параметры из таблицы примеров

Функционал: Структура сценария
    Как Разработчик
    Я Хочу чтобы файл фичи со структурой сценария успешно выполнялся и параметры правильно передавались

    Структура сценария: Проверяю передачу параметров <Что> и <Куда>

        Когда я передаю параметр <Что>
        Тогда я получаю параметр "Минимальный"

        Когда я передаю параметр <Куда>
        Тогда я получаю параметр "Туда"

    Примеры:
      | Что       | Куда|
      | Минимальный | Туда|

Структура сценария: Проверяю передачу параметров <Что> и <Куда>

    Когда я передаю параметр <Что>
    Тогда я получаю параметр "Минимальный"

    Когда я передаю параметр <Куда>
    Тогда я получаю параметр "Туда"

Примеры:
  | Что       | Куда|
  | Минимальный | Туда|

Структура сценария: Проверяю передачу обычных параметров и параметров из таблицы в одном шаге

    Когда я передаю два параметра разных типов <Параметр> и 1
    Тогда я в первом параметре получаю значение с типом "Строка"
    И я в втором параметре получаю значение с типом "Число"

    Примеры:
      | Параметр       |
      | Значение |

Исправить баг падения тестов, внесенный коммитом c7c1844 (ветка bug-34)

Originally reported by: artbear (Bitbucket: artbear, GitHub: artbear)


Commit: c7c18440626254fdde105666fdfdbe6bdaf031c4 [c7c1844]
Parents: 860051a9ed
Author: Artur Ayukhanov <[email protected]>
Date: 6 мая 2016 г. 20:33:28
Исправлена ошибка по неверному использования параметров чисел и дат see #17

datatables.feature

Originally reported by: artbear (Bitbucket: artbear, GitHub: artbear)


Пример gherkin3/.../datatables.feature

#!gherkin

Feature: DataTables

  Scenario: minimalistic
    Given a simple data table
      | foo | bar |
      | boz | boo |
    And a data table with a single cell
      | foo |
    And a data table with different fromatting
      |   foo|bar|    boz    |    
    And a data table with an empty cell
      |foo||boz|
    And a data table with comments and newlines inside
      | foo | bar |

      | boz  | boo  |
      # this is a comment
      | boz2 | boo2 |

Различные варианты многострочного текста или вложенных строк

Originally reported by: artbear (Bitbucket: artbear, GitHub: artbear)


Пример из Gherkin

#!gherkin

Feature: DocString variations

  Scenario: minimalistic
    Given a simple DocString
      """
      first line (no indent)
        second line (indented with two spaces)
      third line was empty
      """
    Given a DocString with content type
      """xml
      <foo>
        <bar />
      </foo>
      """
    And a DocString with wrong indentation
      """
    wrongly indented line
      """
    And a DocString with alternative separator
      ```
      first line
      second line
      ```
    And a DocString with normal separator inside
      ```
      first line
      """
      third line
      ```
    And a DocString with alternative separator inside
      """
      first line
      ```
      third line
      """
    And a DocString with escaped separator inside
      """
      first line
      \"\"\"
      third line
      """ 

Переделать передачу контекста от фреймворка исполнителям шагов фич

Функция ПолучитьИсполнителяШагов(Знач ФайлИсполнителя)
    Лог.Отладка("Ищу исполнителя шагов в файле "+ФайлИсполнителя.ПолноеИмя);

    Если Не ФайлИсполнителя.Существует() Тогда
        Возврат Неопределено;
    КонецЕсли;

    ИсполнительШагов = ЗагрузитьСценарий(ФайлИсполнителя.ПолноеИмя, Контекст); // !!!!!
    Возврат ИсполнительШагов;
КонецФункции // ПолучитьИсполнителяШагов()

Обеспечить уникальные ключи для пересекающих множеств типа ВозможныеКлючевыеСлова, ВозможныеТипыШагов и т.д.

Originally reported by: artbear (Bitbucket: artbear, GitHub: artbear)


Чтобы не возникала ситуация, когда ВозможныеКлючевыеСлова.Сценарий = ВозможныеТипыШагов.Сценарий
т.к. это может приводить к трудноуловимым ошибкам в коде


ПередЗапускомСценария/ПослеЗапускаСценария

Originally reported by: artbear (Bitbucket: artbear, GitHub: artbear)


  • генерация
  • выполнение
  • выполнение контекста после хука ПередЗапускомСценария

https://github.com/cucumber/cucumber-js/blob/master/features/background.feature

Background allows you to add some context to the scenarios in a
single feature. A Background is much like a scenario containing a
number of steps. The difference is when it is run. The background is
run before each of your scenarios but after any of your Before
Hooks.


Использовать библиотеки для повторного использования шагов

Originally reported by: artbear (Bitbucket: artbear, GitHub: artbear)


  • Для выполнения шагов
-r, --require LIBRARY|DIR        Require files before executing the features. If this
                                     option is not specified, all *.rb files that are
                                     siblings or below the features will be loaded auto-
                                     matically. Automatic loading is disabled when this
                                     option is specified, and all loading becomes explicit.
                                     Files under directories named "support" are always
                                     loaded first.
                                     This option can be specified multiple times.

Падение шагов приводит к падению сценария, а падение сценария позволяет работать следующему сценарию в фиче

Originally reported by: artbear (Bitbucket: artbear, GitHub: artbear)


Падение шагов приводит к падению сценария, а падение сценария позволяет работать следующему сценарию в фиче


Нужно генерить правильные имена параметров

Originally reported by: artbear (Bitbucket: artbear, GitHub: artbear)


сейчас генерятся следующие строки

//получаю 10 и сумму12
//##ПолучаюИ
Процедура ПолучаюИ(10,сумму12) Экспорт
         ВызватьИсключение "Не реализовано.";
КонецПроцедуры

/я передаю параметр 11.02.2010
//##ЯПередаюПараметр
Процедура ЯПередаюПараметр(11.02.2010) Экспорт
         ВызватьИсключение "Не реализовано.";
КонецПроцедуры

Нужно исправить на Процедура ПолучаюИ(Парам1, Парам2) Экспорт


В readme.md непонятно для чего

... bdd.os предназначен.
Для кого аббревиатура BDD ниочем не говорит, пройдут мимо.
Не написано, что делают команды exec и generate
Не написано, в каких каталогах какие файлы будут искаться а потом класться.

Выбрать подходящие команды из командой строки cucumber

Originally reported by: artbear (Bitbucket: artbear, GitHub: artbear)


https://github.com/cucumber/cucumber-js/blob/master/docs/cli.md
https://cucumber.io/docs/reference
https://github.com/cucumber/cucumber-js
http://cucumber.github.io/cucumber-js/
https://github.com/cucumber/cucumber-js/blob/master/features/background.feature
http://docs.behat.org/en/v3.0/guides/1.gherkin.html

Usage: cucumber [options] [ [FILE|DIR|URL][:LINE[:LINE]*] ]+

Examples:
cucumber examples/i18n/en/features
cucumber @rerun.txt (See --format rerun)
cucumber examples/i18n/it/features/somma.feature:6:98:113
cucumber -s -i http://rubyurl.com/eeCl

    -r, --require LIBRARY|DIR        Require files before executing the features. If this
                                     option is not specified, all *.rb files that are
                                     siblings or below the features will be loaded auto-
                                     matically. Automatic loading is disabled when this
                                     option is specified, and all loading becomes explicit.
                                     Files under directories named "support" are always
                                     loaded first.
                                     This option can be specified multiple times.
        --i18n LANG                  List keywords for in a particular language
                                     Run with "--i18n help" to see all languages
        --fail-fast                  Exit immediately following the first failing scenario
    -f, --format FORMAT              How to format features (Default: pretty). Available formats:
                                       debug       : For developing formatters - prints the calls made to the listeners.
                                       html        : Generates a nice looking HTML report.
                                       json        : Prints the feature as JSON
                                       json_pretty : Prints the feature as prettified JSON
                                       junit       : Generates a report similar to Ant+JUnit.
                                       pretty      : Prints the feature as is - in colours.
                                       progress    : Prints one character per scenario.
                                       rerun       : Prints failing files with line numbers.
                                       stepdefs    : Prints All step definitions with their locations. Same as
                                                     the usage formatter, except that steps are not printed.
                                       usage       : Prints where step definitions are used.
                                                     The slowest step definitions (with duration) are
                                                     listed first. If --dry-run is used the duration
                                                     is not shown, and step definitions are sorted by
                                                     filename instead.
                                     Use --format rerun --out rerun.txt to write out failing
                                     features. You can rerun them with cucumber @rerun.txt.
                                     FORMAT can also be the fully qualified class name of
                                     your own custom formatter. If the class isn't loaded,
                                     Cucumber will attempt to require a file with a relative
                                     file name that is the underscore name of the class name.
                                     Example: --format Foo::BarZap -> Cucumber will look for
                                     foo/bar_zap.rb. You can place the file with this relative
                                     path underneath your features/support directory or anywhere
                                     on Ruby's LOAD_PATH, for example in a Ruby gem.
        --init                       Initializes folder structure and generates conventional files for
                                     a Cucumber project.
    -o, --out [FILE|DIR]             Write output to a file/directory instead of STDOUT. This option
                                     applies to the previously specified --format, or the
                                     default format if no format is specified. Check the specific
                                     formatter's docs to see whether to pass a file or a dir.
    -t, --tags TAG_EXPRESSION        Only execute the features or scenarios with tags matching TAG_EXPRESSION.
                                     Scenarios inherit tags declared on the Feature level. The simplest
                                     TAG_EXPRESSION is simply a tag. Example: --tags @dev. When a tag in a tag
                                     expression starts with a ~, this represents boolean NOT. Example: --tags ~@dev.
                                     A tag expression can have several tags separated by a comma, which represents
                                     logical OR. Example: --tags @dev,@wip. The --tags option can be specified
                                     several times, and this represents logical AND. Example: --tags @foo,~@bar --tags @zap.
                                     This represents the boolean expression (@foo || !@bar) && @zap.

                                     Beware that if you want to use several negative tags to exclude several tags
                                     you have to use logical AND: --tags ~@fixme --tags ~@buggy.

                                     Positive tags can be given a threshold to limit the number of occurrences.
                                     Example: --tags @qa:3 will fail if there are more than 3 occurrences of the @qa tag.
                                     This can be practical if you are practicing Kanban or CONWIP.
    -n, --name NAME                  Only execute the feature elements which match part of the given name.
                                     If this option is given more than once, it will match against all the
                                     given names.
    -e, --exclude PATTERN            Don't run feature files or require ruby files matching PATTERN
    -p, --profile PROFILE            Pull commandline arguments from cucumber.yml which can be defined as
                                     strings or arrays.  When a 'default' profile is defined and no profile
                                     is specified it is always used. (Unless disabled, see -P below.)
                                     When feature files are defined in a profile and on the command line
                                     then only the ones from the command line are used.
    -P, --no-profile                 Disables all profile loading to avoid using the 'default' profile.
    -c, --[no-]color                 Whether or not to use ANSI color in the output. Cucumber decides
                                     based on your platform and the output destination if not specified.
    -d, --dry-run                    Invokes formatters without executing the steps.
                                     This also omits the loading of your support/env.rb file if it exists.
    -m, --no-multiline               Don't print multiline strings and tables under steps.
    -s, --no-source                  Don't print the file and line of the step definition with the steps.
    -i, --no-snippets                Don't print snippets for pending steps.
    -I, --snippet-type TYPE          Use different snippet type (Default: regexp). Available types:
                                     classic: Snippets without parentheses. Note that these cause a warning from modern versions of Ruby. e.g. Given /^missing step$/
                                     percent: Snippets with percent regexp e.g. Given %r{^missing step$}
                                     regexp : Snippets with parentheses    e.g. Given(/^missing step$/)
    -q, --quiet                      Alias for --no-snippets --no-source.
        --no-duration                Don't print the duration at the end of the summary
    -b, --backtrace                  Show full backtrace for all errors.
    -S, --strict                     Fail if there are any undefined or pending steps.
    -w, --wip                        Fail if there are any passing scenarios.
    -v, --verbose                    Show the files and features loaded.
    -g, --guess                      Guess best match for Ambiguous steps.
    -l, --lines LINES                Run given line numbers. Equivalent to FILE:LINE syntax
    -x, --expand                     Expand Scenario Outline Tables in output.
        --order TYPE[:SEED]          Run examples in the specified order. Available types:
                                       [defined]     Run scenarios in the order they were defined (default).
                                       [random]      Shuffle scenarios before running.
                                     Specify SEED to reproduce the shuffling from a previous run.
                                       e.g. --order random:5738
        --version                    Show version.
    -h, --help                       You're looking at it.

Использовать библиотеки для исключения повторной генерации шагов

Нужно сделать фичи:

  • Первичная генерация
    • Генерация шагов, если передана одна библиотечная фича
    • Генерация шагов, если передан каталог библиотечных фич
    • Генерация шагов, если библиотечная фича находится в одном каталоге с фичей
    • Генерация шагов, если библиотечная фича находится в подчиненном каталоге по отношению к фиче
  • Повторная генерация:
    • Генерация шагов, если передана одна библиотечная фича
    • Генерация шагов, если передан каталог библиотечных фич
    • Генерация шагов, если библиотечная фича находится в одном каталоге с фичей
    • Генерация шагов, если библиотечная фича находится в подчиненном каталоге по отношению к фиче

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.