Skip to content

Commit

Permalink
Файлы документации. Смена кодировки
Browse files Browse the repository at this point in the history
  • Loading branch information
@sokolovsky
sokolovsky committed May 5, 2017
1 parent a0ea873 commit 28fc5b0
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 34 deletions.
34 changes: 17 additions & 17 deletions doc/install.md
View file
Original file line number Diff line number Diff line change
@@ -1,43 +1,43 @@
##### [Главная страница](../readme.md)
##### [Главная страница](../readme.md)

# Установка и настройка
# Установка и настройка

## Composer

Подключение модуля необходимо проводить находясь в DOCUMENT_ROOT проекта:
Подключение модуля необходимо проводить находясь в DOCUMENT_ROOT проекта:

```
composer require worksolutions/bitrix-module-bunit
```

Команда перенесет файлы модуля в папку `/bitrix/modules/ws.bunit`
Следующим шагом будет регистрация модуля в ядре Битрикс:
Команда перенесет файлы модуля в папку `/bitrix/modules/ws.bunit`
Следующим шагом будет регистрация модуля в ядре Битрикс:

```
composer run-script post-install-cmd -d bitrix/modules/ws.bunit
```

Либо со страницы "Установленные решения", минуя командную строку:
Либо со страницы "Установленные решения", минуя командную строку:
```
/bitrix/admin/partner_modules.php?lang=ru
```

## Marketplace

Модуль доступен, но не опубликован на маркетплейс Битрикса. Маркетплейс используется только как площадка установки и обновления модуля через web интерфе. Основной лощадкой поддержки модуля является [github](https://github.com/worksolutions/bitrix-module-bunit/blob/master/readme.md).
Модуль доступен, но не опубликован на маркетплейс Битрикса. Маркетплейс используется только как площадка установки и обновления модуля через web интерфе. Основной лощадкой поддержки модуля является [github](https://github.com/worksolutions/bitrix-module-bunit/blob/master/readme.md).

Для установки в адресную строку сайта, после доменного имени, прописать:
Для установки в адресную строку сайта, после доменного имени, прописать:

```
/bitrix/admin/update_system_partner.php?addmodule=ws.bunit
```

Установка модуля осуществляется без установки параметров.
Установка модуля осуществляется без установки параметров.

## Файл настройки
## Файл настройки

Для начала работы отредактировать файл ```КОРЕНЬ_ПРОЕКТА/bitrix/php_interface/bunit/config.php```.
После установки он выглядит так:
Для начала работы отредактировать файл ```КОРЕНЬ_ПРОЕКТА/bitrix/php_interface/bunit/config.php```.
После установки он выглядит так:
```php
<?php

Expand Down Expand Up @@ -74,11 +74,11 @@ $config->set(
);
```

Основная настройка состоит из двух пунктов: ```db```, ```folder```.
Основная настройка состоит из двух пунктов: ```db```, ```folder```.

1. ```db``` - содержит параметры доступов баз данных, как оригинальной так и тестовой. В случае если описание тестовой базы данных отсутствует, при проходе тестов будет использоваться основная база данных проекта.
2. ```folder``` - указывает на каталог содержащий тестовые классы. По умолчанию определен текущий каталог: ```КОРЕНЬ_ПРОЕКТА/bitrix/php_interface/bunit/```
1. ```db``` - содержит параметры доступов баз данных, как оригинальной так и тестовой. В случае если описание тестовой базы данных отсутствует, при проходе тестов будет использоваться основная база данных проекта.
2. ```folder``` - указывает на каталог содержащий тестовые классы. По умолчанию определен текущий каталог: ```КОРЕНЬ_ПРОЕКТА/bitrix/php_interface/bunit/```

## Каталог тестовых классов
## Каталог тестовых классов

Каталог тестовых классов может также содержать подкаталоги для удобного группирования тестов. Все файлы тестов должны иметь в названии постфикс ```TestCase```. Например: *CardAddingTestCase.php*. Файлы название которых не удовлетворяет правилу подключения не будут подключены при проходе тестов. Это удобно в тех случаях когда выделяются файлы с какими-то данными которые нужно подключить при тестировании в определенных местах тестов, а не подключать их автоматически при запуске.
Каталог тестовых классов может также содержать подкаталоги для удобного группирования тестов. Все файлы тестов должны иметь в названии постфикс ```TestCase```. Например: *CardAddingTestCase.php*. Файлы название которых не удовлетворяет правилу подключения не будут подключены при проходе тестов. Это удобно в тех случаях когда выделяются файлы с какими-то данными которые нужно подключить при тестировании в определенных местах тестов, а не подключать их автоматически при запуске.
34 changes: 17 additions & 17 deletions doc/running.md
View file
Original file line number Diff line number Diff line change
@@ -1,56 +1,56 @@
##### [Главная страница](../readme.md)
##### [Главная страница](../readme.md)

# Запуск тестов
# Запуск тестов

Запуск тестов происходит только через интерфейс командной строки. Файл для запуска содержится в каталоге ```КОРЕНЬ_ПРОЕКТА/bitrix/tools/bunit```.
Функционал командной строки модуля состоит из нескольких функций: *помощь, запуск и работа с клонированием данных в тестовую базу данных*.
Запуск тестов происходит только через интерфейс командной строки. Файл для запуска содержится в каталоге ```КОРЕНЬ_ПРОЕКТА/bitrix/tools/bunit```.
Функционал командной строки модуля состоит из нескольких функций: *помощь, запуск и работа с клонированием данных в тестовую базу данных*.

## Функция помощи
## Функция помощи

Функция помощи кратко описывает взаимодействие с модулем тестирования.
Функция помощи кратко описывает взаимодействие с модулем тестирования.

```$ php bunit help```

![](img/function-help.png)


## Запуск тестов
## Запуск тестов

Для запуска тестов используется функция ```run``` которая так же может содержать доплнительный параметры, в зависимости от требований к выполнению тестов.
Для запуска тестов используется функция ```run``` которая так же может содержать доплнительный параметры, в зависимости от требований к выполнению тестов.

```$ php bunit run```

*Запуск всех тестов. Успешный проход.*
*Запуск всех тестов. Успешный проход.*

![](img/success-result-small.png)

*Запуск всех тестов. Есть тесты отмеченные как пропущенные.*
*Запуск всех тестов. Есть тесты отмеченные как пропущенные.*

![](img/skipped-result.png)

*Запуск группы тестов.* Используется параметр ```label```
*Запуск группы тестов.* Используется параметр ```label```

```$ php bunit run -label=component```

![](img/group-result.png)

*При тестировании выявлены ошибки.*
*При тестировании выявлены ошибки.*

![](img/error-result.png)

## Работа с клонированием в тестовую базу данных
## Работа с клонированием в тестовую базу данных

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

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

##### Сохранение снимка оригинальной базы данных во временное хранилище
##### Сохранение снимка оригинальной базы данных во временное хранилище

```$ php bunit db create```

![](img/db-create.png)

##### Восстановление данных тестовой базы данных из созданного снимка оригинальной бд
##### Восстановление данных тестовой базы данных из созданного снимка оригинальной бд

```$ php bunit db update```

Expand Down

0 comments on commit 28fc5b0

Please sign in to comment.