// 
//     Licensed to the Apache Software Foundation (ASF) under one
//     or more contributor license agreements.  See the NOTICE file
//     distributed with this work for additional information
//     regarding copyright ownership.  The ASF licenses this file
//     to you under the Apache License, Version 2.0 (the
//     "License"); you may not use this file except in compliance
//     with the License.  You may obtain a copy of the License at
// 
//       http://www.apache.org/licenses/LICENSE-2.0
// 
//     Unless required by applicable law or agreed to in writing,
//     software distributed under the License is distributed on an
//     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
//     KIND, either express or implied.  See the License for the
//     specific language governing permissions and limitations
//     under the License.
//

= Тестирование с помощью PHPUnit и Selenium
:jbake-type: tutorial
:jbake-tags: tutorials 
:jbake-status: published
:icons: font
:syntax: true
:source-highlighter: pygments
:toc: left
:toc-title:
:description: Тестирование с помощью PHPUnit и Selenium - Apache NetBeans
:keywords: Apache NetBeans, Tutorials, Тестирование с помощью PHPUnit и Selenium

IDE NetBeans для PHP поддерживает автоматические тесты link:http://www.phpunit.de[+PHPUnit+]. За счет PHPUnit, IDE NetBeans обеспечивает покрытие кода для PHP, схожее с покрытием кода, обеспечиваемым IDE для Python. Вывод теста отображается в том же окне вывода, имеющем множество функций, которое используется средствами запуска тестов JUnit и Python среды IDE.

IDE NetBeans также поддерживает переносимую платформу тестирования Selenium в сочетании с PHPUnit. Подключаемый модуль Selenium доступен из центра обновления. При установке этот подключаемый модуль добавляет сервер Selenium к зарегистрированным серверам среды IDE, а также добавляет параметры тестирования Selenium к меню PHP.

*Для работы с этим учебным курсом требуется следующее программное обеспечение и ресурсы.*

|===
|Программное обеспечение или материал |Требуемая версия 

|link:https://netbeans.org/downloads/index.html[+IDE NetBeans+] |Пакет загрузки PHP 

|Система PHP, включая PEAR |Версия 5. 

|Веб-сервер |Рекомендуется использовать HTTP-сервер Apache 2.2.
 

|link:http://www.phpunit.de[+PHPUnit+] |Версия 3.4.0 и более поздние. 

|link:http://www.phpunit.de/manual/current/en/skeleton-generator.html[+Генератор схемы PHPUnit+] |Версия PHPUnit. 
|===


[[installing-phpunit]]
== Установка PHPUnit

Используйте PEAR для установки PHPUnit, как описано в link:http://www.phpunit.de/manual/current/en/installation.html[+документации по PHPUnit+] и генератор схемы PHPUnit, как описано в link:http://www.phpunit.de/manual/current/en/skeleton-generator.html[+документации по генератору схемы+]. Следует установить версию PHPUnit 3.4.0 или выше. Специальная настройка не требуется. После установки PHPUnit среда NetBeans сможет распознать это средство тестирования. Обратите внимание на то, что вместе с механизмом PHP должен быть установлен PEAR. Также следует учитывать, что согласно документации по PHPUnit это средство тестирования обычно устанавливается в локальный каталог PEAR. В документации указывается путь  ``/usr/lib/php/PHPUnit`` , однако в XAMPP для Windows используется путь  ``XAMPP_HOME\php\PEAR\PHPUnit`` .

Чтобы проверить, распознает ли среда IDE NetBeans установочный комплект PHPUnit, откройте "Сервис" > "Параметры" (в ОС Mac откройте "Параметры NetBeans") и просмотрите окно "PHP". Откройте вкладку "Модульное тестирование". Должны отобразиться пути к сценариям PHPUnit и генератору схемы. Если сценарий отсутствует, щелкните 'Поиск' рядом с пустым полем. IDE выполнит поиск сценария в локальной системе. В качестве альтернативы можно нажать кнопку "Обзор" и выполнить поиск сценария.


image::images/unittesting-options.png[]


[[create-test]]
== Создание и выполнение тестов PHPUnit

В IDE NetBeans поддерживается создания и запуск тестов PHPUnit во всех классах PHP в файле. Для обеспечения работы генератора тестов дайте файлу PHP имя, идентичное имени первого класса файла.

*Создание и выполнение тестов PHPUnit для класса:*

1. Создайте проект PHP с именем "Calculator". В этом проекте создайте файл с именем  ``calculator.php`` . Введите или вставьте в этот файл класс Calculator из раздела link:http://www.phpunit.de/manual/current/en/skeleton-generator.html[+"Skeleton Generator" документации PHPUnit+].

[source,php]
----

<?php
class Calculator
{
    public function add($a, $b)
    {
        return $a + $b;
    }
}
?>
----


. Добавьте блок комментариев с link:http://sebastian-bergmann.de/archives/628-Improved-Skeleton-Generator-in-PHPUnit-3.html[+аннотацией @assert+], а также пример входных и выходных данных. Обратите внимание – в этот пример включено одно неверное подтверждение.

[source,php]
----

<?php
class Calculator
{
    /**
     * @assert (0, 0) == 0
     * @assert (0, 1) == 1
     * @assert (1, 0) == 1
     * @assert (1, 1) == 2
     * @assert (1, 2) == 4
     */
    public function add($a, $b)
    {
        return $a + $b;
    }
}
?>
----

NOTE:  Можно использовать завершение кода аннотаций для добавления аннотаций `@assert`. Для перемещения между параметрами используйте клавишу табуляции, или нажмите Enter после ввода значения параметра.


image::images/assert-cc.png[]image::images/assert-cc-complete.png[]


. В окне "Проекты" правой кнопкой мыши щелкните узел Calculator.php и выберите команду "Сервис" > "Создать тесты PHPUnit". Обратите внимание на то, что тесты для всех файлов в проекте можно создавать в контекстном меню для узла "Исходные файлы".


image::images/create-tests.png[]


. При первом создании тестов в диалоговом окне выводится вопрос о каталоге, в котором следует сохранить файлы тестов. В этом примере функция "Обзор" используется для создания папки  ``tests`` . 


image::images/test-directory.png[]

NOTE:  Пользователи могут написать для проекта несколько тестов вручную. Если создано несколько тестов, вы можете отсортировать их в подпапки каталога файлов тестов, такие как "Важные" или "Быстрые". Тесты можно запустить во вложенной папке, щелкнув правой кнопкой мыши эту папку и выбрав 'Выполнить тесты'.


image::images/test-in-folder.png[]


. В среде IDE в файле с именем CalculatorTest.php создается базовый класс, который отображается в окне "Проекты" и открывается в редакторе. 


image::images/test-class-in-project.png[]

Обратите внимание на то, что тест создается для каждой аннотации  ``@assert`` .


[source,php]
----

    /**
     * Generated from @assert (1, 1) == 2.
     */
    public function testAdd4()
    {
        $this->assertEquals(
          2,
          $this->object->add(1, 1)
        );
    }
----


. Можно выполнить тестирование отдельного файла или целого проекта. Для тестирования проекта щелкните правой кнопкой мыши родительский узел проекта и выберите команду "Тестировать" или нажмите сочетание клавиш ALT+F6. Для тестирования файла Calculator.php щелкните правой кнопкой узел файла и выберите 'Тестировать' или нажмите Ctrl-F6/⌘-F6. В этом примере существует только один класс в одном файле, так что результаты являются идентичными. Среда IDE выполняет тесты и отображает результаты в окне "Результаты теста". 


image::images/test-results-narrow.png[]

Более подробная текстовая версия результатов отображается в окне "Вывод".


image::images/test-result-output.png[]


== Использование групп тестирования

Можно выбрать, какие группы тестирования будут выполняться при запуске набора тестов. Например, некоторые тесты могут выполняться только в производственной среде, а другие — как в производственной среде, так и в среде разработки. Тесты первого вида вы поместите в группу  ``production`` , а второго — в группы  ``production``  и  ``development`` . При запуске набора тестов в среде разработки вы выбираете для выполнения только группу тестирования  ``development`` .

Необходимо активировать группы тестирования для проекта PHP до использования этих групп на каком-либо из файлов данного проекта.

Чтобы отметить тест в качестве части группы тестирования, добавьте к методу теста аннотацию  ``@group [group name]`` .

*Создание и выполнение групп тестирования.*

1. В окне "Проекты" правой кнопкой мыши щелкните узел "Калькулятор" и выберите "Свойства". Откроется раздел "Свойства проекта".
2. В разделе "Свойства проекта" выберите категорию PhpUnit. Выберите "Запрос групп тестирования перед выполнением тестов". Нажмите кнопку "ОК".

image::images/test-group-properties.png[]


. Откройте файл  ``CalculatorTest.php``  в редакторе.


. Для методов  ``testAdd`` ,  ``testAdd3``  и  ``testAdd5``  добавьте аннотацию  ``@group production`` .

image::images/production-group-annotation.png[]


. Для методов  ``testAdd2``  и  ``testAdd4``  добавьте аннотации  ``@group production``  и  ``@group development`` . image:images/production-development-group-code.png[]


. Правой кнопкой мыши щелкните узел  ``Calculator.php``  и выберите "Тестировать". Откроется диалоговое окно выбора групп тестирования для выполнения. Выберите "разработка" и нажмите клавишу "ОК". Среда IDE выполняет только те тесты, которые имеют аннотацию  ``@group development`` .

image::images/select-test-group.png[]

Дополнительные сведения о группах тестов PhpUnit в IDE NetBeans см. IDE NetBeans для публикации в блоге link:http://blogs.oracle.com/netbeansphp/entry/using_phpunit_test_groups[+Использование групп тестов единиц PHP+].


[[result-windows]]
== Результаты теста и вывод среды IDE

Результаты тестов PHPUnit отображаются в двух окнах среды IDE – "Результаты теста" и "Вывод". Окно "Результаты теста" имеет графическую панель и краткую текстовую панель. Окно "Вывод" предоставляет более подробную текстовую версию выходных данных. В этом разделе окна "Результаты теста" и "Вывод" рассматриваются более подробно.

В окне "Результаты теста" отображаются сведения о тестах со сбоями из следующих местоположений:

* Сообщения на панели пользовательского интерфейса, связанные с записью дерева для теста со сбоем
* Текст правой панели со ссылками на строки кода теста со сбоем
* Текст всплывающей подсказки, отображающийся при наведении курсора на тест со сбоем в панели пользовательского интерфейса


image::images/test-results-tooltip.png[]

На левой стороне окна "Результаты теста" расположены следующие кнопки:

* Повторное выполнение теста image:images/rerun-button.png[];
* Показать неуспешные тесты image:images/show-failed.png[]
* Показать успешные тесты image:images/show-passed.png[]
* Показать завершенные тесты, содержащие ошибки image:images/show-error.png[]
* Переход между отображением следующего результата теста image:images/next-test-button.png[] или предыдущего результата теста image:images/previous-test-button.png[].

В окне "Вывод" отображаются все выходные данные сценария PHPUnit. Использование этой функции целесообразно, если причину ошибки невозможно установить с помощью информации в окне "Результаты теста". Как и окно "Результаты теста", окно "Вывод" содержит ссылки на строку класса теста с ошибкой. Также включает в себя кнопки на левой стороне для повторного выполнения теста и для открытия окна параметров PHP.image:images/options-link-button.png[]


image::images/test-result-output.png[]


[[code-coverage]]
== Охват кода

IDE NetBeans для PHP обеспечивает покрытие кода вместе с поддержкой PHPUnit. (Среда IDE также предлагает покрытие кода для Python). Функция покрытия кода проверяет, все ли используемые методы покрываются тестами PHPUnit. В этом разделе мы увидим, как работает покрытие кода для существующего класса Calculator.

*Использование функции покрытия кода:*

1. Откройте Calculator.php и добавьте дубликат функции  ``add``  с именем  ``add2`` . При этом класс  ``Calculator``  должен выглядеть примерно таким образом:

[source,php]
----

<?php
class Calculator {
    /**
     * @assert (0, 0) == 0
     * @assert (0, 1) == 1
     * @assert (1, 0) == 1
     * @assert (1, 1) == 2
     * @assert (1, 2) == 4
     */
    public function add($a, $b) {
        return $a + $b;
    }

    public function add2($a, $b) {
        return $a + $b;
    }

}    
?>

----


. Щелкните узел проекта правой кнопкой мыши. В контекстном меню выберите команду "Охват кода" > "Сбор и отображения охвата кода". По умолчанию панель "Отобразить панель редактора" также выбрана. 

image::images/turn-on-code-coverage.png[]


. Панель покрытия кода теперь отображается в нижней части редактора. Поскольку тестирование покрытия кода еще не выполнялось, на панели редактора отображается значение покрытия, равное 0%. (Это значение также отображается при нажатии на кнопку "Очистить" для очистки результатов теста). 

image::images/editor-bar-before.png[]


. Выберите команду "Тестировать" для тестирования открытого файла или "Все тесты" для запуска всех тестов по проекту. Отобразится окно "Результаты теста". Кроме того, на панели "Покрытие кода" отобразится процент задействованных в тестах операторов исполняемого кода. Задействованный код в окне редактора выделяется зеленым цветом, а незадействованный код – красным цветом.

WARNING: При повторном создании файлов теста ПОСЛЕ добавления функции add2 тесты PHPUnit выполняться не будут. Причиной этого является то, что PHPUnit создает две конфликтующие функции testAdd2. Не разграничивайте функции добавляемыми в конце номерами, если планируете использовать PHPUnit для нескольких подобных функций. См. link:http://www.phpunit.de/ticket/701[+документацию по PHPUnit+].


image::images/editor-bar-after.png[]


. На панели редактора щелкните элемент "Отчет...". Отобразится отчет "Покрытие кода", в котором будут показаны результаты всех тестов, выполненных для проекта. Кнопки в отчете позволяют очищать результаты, повторно выполнять тесты или отключать покрытие кода (нажмите кнопку "Готово"). 

image::images/code-coverage-report.png[]


. Разработчик может добавить другой класс в проект, удалить и заново создать файлы теста, а также еще раз изучить отчет о покрытии кода. Будет показан новый класс. В следующем отчете класс  ``Calculator``  снова содержит функцию, не включенную в тесты. 

image::images/code-coverage-report2.png[]


[[project-specific-configurations]]
== Использование вариантов настройки для отдельных проектов

В среде IDE для проекта можно выбрать следующие особые варианты настройки:

* файл начальной загрузки;
* файл настройки в формате XML;
* набор тестов.
* Пользовательский сценарий PHPUnit

*Настройка конфигурации, связанной с проектом.*

1. Щелкните правой кнопкой мыши узел проекта или узел проекта "Файлы тестов", а затем выберите пункт меню "Свойства". В результате откроется диалоговое окно "Свойства".

image::images/project-ctxmenu.png[]


. Выберите в нем категорию "PHPUnit". Откроется диалоговое окно, в котором можно выбрать особый файл начальной загрузки, конфигурацию XML, сценарий PHPUnit или файл набора тестов.

image::images/proj-properties.png[]


. Пользователи, не знакомые со структурой начальной нагрузки или файлами конфигурации XML можно использовать IDE NetBeans для создания основы. Инструкции по использованию диалогового доступны при выборе 'Справка'. 

image::images/proj-properties-selected.png[]

_Вариант начальной загрузки_ требуется для проектов, в которых используется собственный загрузчик классов, например, посредством реализации магической функции  ``__autoload()`` . Вариант начальной загрузки используется также при необходимости включения файла, содержащего, например, глобальные константы, которые используются несколькими классами в проекте, в будущем.

_Файл XML настройки_ позволяет определить параметры, используемые в вызове из командной строки. В link:http://www.phpunit.de/manual/3.3/en/appendixes.configuration.html[+руководстве по PHPUnit+] имеется полное введение. С помощью файла XML настройки также можно определить параметры  ``php.ini``  и глобальные переменные для тестов. Параметр начальной загрузки может быть указан и в файле XML настройки.

Если установлен _особый набор тестов_, он запускается при каждом выборе пункта меню "Выполнить > Тестирование проекта". Это особенно удобно, если требуется запустить только подмножество всех тестов, либо если требуется использовать недавно реализованные функции PHPUnit, которые необходимо добавлять вручную, например источники данных. Следует отметить, что существует возможность создавать любое количество наборов тестов и запускать их по отдельности; для этого нужно щелкнуть файл в проводнике проектов и выбрать пункт меню "Выполнить". Во избежание недоразумений при использовании особого набора тестов выдается предупреждение. Это предупреждение выводится в окне "Результаты теста" и в окне вывода.

_Пользовательский сценарий PHPUnit _ можно использовать для проекта, вместо сценария по умолчанию, выбранного в 'Сервис' > 'Параметры'. Пользовательский сценарий PHPUnit может включать в себя любые переключатели командной строки, описанные в link:http://www.phpunit.de/manual/3.7/en/textui.html[+руководстве по PHPUnit+].

 
[[selenium]]
== Запуск тестов на платформе Selenium

Selenium – это переносимая платформа тестирования программного обеспечения для веб-приложений. Тесты могут быть созданы в виде таблиц HTML или написаны с помощью различных популярных языков программирования. Тесты запускаются напрямую в большинстве современных браузеров. Selenium может развертываться в системах Windows, Linux и Macintosh. Дополнительные сведения приведены на link:http://docs.seleniumhq.org[+веб-сайте Selenium+].

В IDE NetBeans имеется подключаемый модуль, включающий сервер Selenium. Этот подключаемый модуль позволяет выполнять тесты Selenium в PHP, веб-приложениях или проектах Maven. Чтобы запустить тесты Selenium в PHP, следует установить пакет Testing Selenium в системе PHP.

*Запуск тестов Selenium в PHP:*

1. Откройте командную строку и запустите команду  ``pear install Testing_Selenium-beta`` .  `` PHP_HOME/php/PEAR``  должен быть добавлен к пути. Если команда выполнена успешно, то командная строка отобразит текст  ``install ok: channel://pear.php.net/Testing_Selenium-0.4.3`` .
2. В среде IDE откройте меню "Сервис" > "Подключаемые модули" и установите модуль Selenium для PHP.
3. В окне "Проекты" правой кнопкой мыши щелкните узел проекта для проекта Calculator. Выберите команду "Создать" > "Прочие". Откроется мастер создания файла. Выберите параметр "Selenium" и нажмите кнопку "Далее". 

image::images/new-selenium.png[]


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


. Примите параметры по умолчанию на странице "Имя и местоположение" и нажмите кнопку "Готово". Новый файл теста Selenium откроется в редакторе и появится в окне "Проекты". 

image::images/selenium-test-in-project.png[]


. Элемент "Выполнить тесты Selenium" добавлен в контекстное меню проекта. Щелкните этот элемент, и результаты теста Selenium отобразятся в окне "Результаты теста", как и для тестов PHPUnit.


[[more-exercises]]
== Дополнительные упражнения

Ниже приведены дополнительные мысли для исследования:

* Добавьте второй класс к Calculator.php, такой как класс  ``Calculator2`` , выполняющий умножение $a на $b. Удаление и восстановление тестов.
* При работе с link:./wish-list-tutorial-main-page.html[+учебным курсом по созданию приложения CRUD+], состоящего из нескольких частей, создайте тест Selenium для итогового проекта.
link:/about/contact_form.html?to=3&subject=Feedback:PHPUnit and Selenium on NB 6.7[+Отправить отзыв по этому учебному курсу+]


Для отправки комментариев и предложений, получения поддержки и новостей о последних разработках, связанных с PHP IDE NetBeans link:../../../community/lists/top.html[+присоединяйтесь к списку рассылки users@php.netbeans.org+]. Зеркало этого списка находится на link:http://forums.netbeans.org/[+форумах IDE NetBeans+].


== Дополнительные сведения

Дополнительные сведения о тестировании PHP в IDE NetBeans см. в следующих ресурсах:

* link:http://blogs.oracle.com/netbeansphp/entry/phpunit_support_added[+Блог среды NetBeans для PHP: добавлена поддержка PHPUnit+]
* link:http://blogs.oracle.com/netbeansphp/entry/ui_for_phpunit_support[+Блог среды NetBeans для PHP: поддержка пользовательского интерфейса для PHPUnit+]
* link:http://blogs.oracle.com/netbeansphp/entry/code_coverage_for_php_why[+Блог среды NetBeans для PHP: покрытие кода для PHP – почему нет?+]
* link:http://blogs.oracle.com/netbeansphp/entry/recent_improvements_in_phpunit_support[+Блог NetBeans для PHP: последние усовершенствования поддержки PHPUnit+]
* link:http://wiki.netbeans.org/SeleniumPluginPHP[+Wiki IDE NetBeans: подключаемый модуль для PHP+]
* link:./debugging.html[+Отладка исходного кода PHP в IDE NetBeans+]

link:../../trails/php.html[+Возврат к учебной карте PHP+]