Joomla! Documentation - User contributions [en]

Testing Joomla Extensions with Codeception

2015-02-10T12:46:06Z

Kshitij1995: /* Structure of a test */

<nowiki>Note: this page is under construction</nowiki>

== What is Codeception? ==
Codeception PHP Testing Framework is designed to work just out of the box. This means its installation requires minimal steps and no external dependencies preinstalled (except PHP, of course). Only one configuration step should be taken and you are ready to test your web application from an eye of actual user.

== Why Use Codeception? ==
''Why use Codeception when we already have Selenium IDE?''

Codeception works great with Selenium. But with Codeception you can write your tests in PHP. The main reason is: Selenium IDE tests are tightly bound to XPath locators. If you ever change anything in layout tests will fall. Codeception locators are more stable. You can use names, labels, button names and CSS to match elements on page.

'''Features'''
* Selenium WebDriver integration
* Elements matched by name, CSS, XPath
* PageObjects and StepObjects included
* Powered by PHPUnit
* Data Cleanup
* Parallel Execution of tests
* BDD-style readable tests

== Structure of a test ==
The testing framework is built on the three layered testing architecture

1. '''Page Objects'''
Each page on your application has a class which we call page objects, each page class will have information about the URL, fields, Text present on the page. We use the best possible selector for any field on the page

2. '''Step Objects'''
Step Objects are classes which contains steps which are to be executed on the application to perform certain operations, step objects make use of page objects to perform thoose actions.

3. '''Cept Class'''
Cept or Test, it is the main class which contains steps of execution for the tests, Cept Class will call Step Class functions which will indirectly make use of page objects to perform operations

== Setting Up Codeception ==
=== setting up the repository ===
'''clone the directory'''

# Fork [https://github.com/joomla-projects/com_localise com_localise]
#
# Git clone git@github.com:*your-github-profile-name*/com_localise.git

=== Testing with Codeception ===

There are two ways to get and run codeception, via PHAR or via Composer.

*'''Codeception.phar'''

Linux Machine : wget http://codeception.com/codecept.phar

Windows Machine: Download from [http://codeception.com/install codecept.phar]

Step1 : php ./codecept.phar build

*'''Using Composer'''

You need to have Composer in your system, if not download it from here: https://getcomposer.org/

Step 1: composer update

Step 2: run Codeception by doing: php vendor/codeception/codeception/codecept build

'''Update Repository'''

Step 1: git submodule init

step 2: git submodule update

=== Running the Test ===

Rename tests/acceptance.suite.dist.yml to tests/acceptance.suite.yml
<source lang="bash">
Step 1: Modify the configuration at tests/acceptance.suite.yml to fit your server details.
</source>
Find the instructions in this file : [https://github.com/redCOMPONENT-COM/redCORE/blob/develop/tests/acceptance.suite.dist.yml Instructions]
<source lang="bash">
Step 2: php codecept.phar run
</source>
with --steps to see a step-by-step report on the performed actions.

<source lang="bash">
php codecept.phar run --steps
</source>

with --html. This command will run all tests for all suites, displaying the steps, and building HTML and XML reports. Reports will be store in tests/_output/ directory.

<source lang="bash">
php codecept.phar run --html
</source>

To activate the debug mode in Codeception just add the parameter --debug when you run the tests:

<source lang="bash">
php codecept.phar run acceptance --debug 1stInstallTestCept.php
</source>

== Best Practices at Testing ==
=== When do not use contains ===
We do not recommend to use the function contains on XPath because is not specific and can create false positives at tests.
See: https://github.com/joomla-projects/GSOC-Webdriver_system_tests_for_CMS/pull/99#issuecomment-69004191

[[Category:Automated Testing]]

Testing Joomla Extensions with Codeception

2015-02-09T22:04:46Z

Kshitij1995: /* Testing with Codeception */

Testing Joomla Extensions with Codeception

2015-02-09T21:57:10Z

Kshitij1995: /* setting up the repository */

<nowiki>Note: this page is under construction</nowiki>

== What is Codeception? ==
Codeception PHP Testing Framework is designed to work just out of the box. This means its installation requires minimal steps and no external dependencies preinstalled (except PHP, of course). Only one configuration step should be taken and you are ready to test your web application from an eye of actual user.

== Why Use Codeception? ==
''Why use Codeception when we already have Selenium IDE?''

Codeception works great with Selenium. But with Codeception you can write your tests in PHP. The main reason is: Selenium IDE tests are tightly bound to XPath locators. If you ever change anything in layout tests will fall. Codeception locators are more stable. You can use names, labels, button names and CSS to match elements on page.

'''Features'''
* Selenium WebDriver integration
* Elements matched by name, CSS, XPath
* PageObjects and StepObjects included
* Powered by PHPUnit
* Data Cleanup
* Parallel Execution of tests
* BDD-style readable tests

== Structure of a test ==
The testing framework is built on the three layered testing architecture

1. '''Page Objects'''
Each page on your application has a class which we call page objects, each page class will have information about the URL, fields, Text present on the page. We use the best possible selector for any field on the page

2. '''Step Objects'''
Step Objects are classes which contains steps which are to be executed on the application to perform certain operations, step objects make use of page objects to perform thoose actions.

3. '''Cept Class'''
Cept or Test, it is the main class which contains steps of execution for the tests, Cept Class will call Step Class functions which will indirectly make use of page objects to perform operations

== Setting Up Codeception ==
=== setting up the repository ===
'''clone the directory'''

# Fork [https://github.com/joomla-projects/com_localise com_localise]
#
# Git clone git@github.com:*your-github-profile-name*/com_localise.git

=== Testing with Codeception ===

There are two ways to get and run codeception, via PHAR or via Composer.

'''Codeception.phar'''

Linux Machine : wget http://codeception.com/codecept.phar

Windows Machine: Download from [http://codeception.com/install codecept.phar]

Step1 : php ./codecept.phar build

'''Using Composer'''

You need to have Composer in your system, if not download it from here: https://getcomposer.org/

Step 1: composer update

Step 2: run Codeception by doing: php vendor/codeception/codeception/codecept build

'''Update Repository'''

Step 1: git submodule init

step 2: git submodule update

=== Running the Test ===

Rename tests/acceptance.suite.dist.yml to tests/acceptance.suite.yml
<source lang="bash">
Step 1: Modify the configuration at tests/acceptance.suite.yml to fit your server details.
</source>
Find the instructions in this file : [https://github.com/redCOMPONENT-COM/redCORE/blob/develop/tests/acceptance.suite.dist.yml Instructions]
<source lang="bash">
Step 2: php codecept.phar run
</source>
with --steps to see a step-by-step report on the performed actions.

<source lang="bash">
php codecept.phar run --steps
</source>

with --html. This command will run all tests for all suites, displaying the steps, and building HTML and XML reports. Reports will be store in tests/_output/ directory.

<source lang="bash">
php codecept.phar run --html
</source>

To activate the debug mode in Codeception just add the parameter --debug when you run the tests:

<source lang="bash">
php codecept.phar run acceptance --debug 1stInstallTestCept.php
</source>

== Best Practices at Testing ==
=== When do not use contains ===
We do not recommend to use the function contains on XPath because is not specific and can create false positives at tests.
See: https://github.com/joomla-projects/GSOC-Webdriver_system_tests_for_CMS/pull/99#issuecomment-69004191

[[Category:Automated Testing]]

Testing Joomla Extensions with Codeception

2015-02-09T21:53:51Z

Kshitij1995:

<nowiki>Note: this page is under construction</nowiki>

== What is Codeception? ==
Codeception PHP Testing Framework is designed to work just out of the box. This means its installation requires minimal steps and no external dependencies preinstalled (except PHP, of course). Only one configuration step should be taken and you are ready to test your web application from an eye of actual user.

== Why Use Codeception? ==
''Why use Codeception when we already have Selenium IDE?''

Codeception works great with Selenium. But with Codeception you can write your tests in PHP. The main reason is: Selenium IDE tests are tightly bound to XPath locators. If you ever change anything in layout tests will fall. Codeception locators are more stable. You can use names, labels, button names and CSS to match elements on page.

'''Features'''
* Selenium WebDriver integration
* Elements matched by name, CSS, XPath
* PageObjects and StepObjects included
* Powered by PHPUnit
* Data Cleanup
* Parallel Execution of tests
* BDD-style readable tests

== Structure of a test ==
The testing framework is built on the three layered testing architecture

1. '''Page Objects'''
Each page on your application has a class which we call page objects, each page class will have information about the URL, fields, Text present on the page. We use the best possible selector for any field on the page

2. '''Step Objects'''
Step Objects are classes which contains steps which are to be executed on the application to perform certain operations, step objects make use of page objects to perform thoose actions.

3. '''Cept Class'''
Cept or Test, it is the main class which contains steps of execution for the tests, Cept Class will call Step Class functions which will indirectly make use of page objects to perform operations

== Setting Up Codeception ==
=== setting up the repository ===
'''clone the directory'''

1.fork [https://github.com/joomla-projects/com_localise com_localise]

2.git clone git@github.com:*your-github-profile-name*/com_localise.git

=== Testing with Codeception ===

There are two ways to get and run codeception, via PHAR or via Composer.

'''Codeception.phar'''

Linux Machine : wget http://codeception.com/codecept.phar

Windows Machine: Download from [http://codeception.com/install codecept.phar]

Step1 : php ./codecept.phar build

'''Using Composer'''

You need to have Composer in your system, if not download it from here: https://getcomposer.org/

Step 1: composer update

Step 2: run Codeception by doing: php vendor/codeception/codeception/codecept build

'''Update Repository'''

Step 1: git submodule init

step 2: git submodule update

=== Running the Test ===

Rename tests/acceptance.suite.dist.yml to tests/acceptance.suite.yml
<source lang="bash">
Step 1: Modify the configuration at tests/acceptance.suite.yml to fit your server details.
</source>
Find the instructions in this file : [https://github.com/redCOMPONENT-COM/redCORE/blob/develop/tests/acceptance.suite.dist.yml Instructions]
<source lang="bash">
Step 2: php codecept.phar run
</source>
with --steps to see a step-by-step report on the performed actions.

<source lang="bash">
php codecept.phar run --steps
</source>

with --html. This command will run all tests for all suites, displaying the steps, and building HTML and XML reports. Reports will be store in tests/_output/ directory.

<source lang="bash">
php codecept.phar run --html
</source>

To activate the debug mode in Codeception just add the parameter --debug when you run the tests:

<source lang="bash">
php codecept.phar run acceptance --debug 1stInstallTestCept.php
</source>

== Best Practices at Testing ==
=== When do not use contains ===
We do not recommend to use the function contains on XPath because is not specific and can create false positives at tests.
See: https://github.com/joomla-projects/GSOC-Webdriver_system_tests_for_CMS/pull/99#issuecomment-69004191

[[Category:Automated Testing]]

Testing Joomla Extensions with Codeception

2015-01-12T15:41:14Z

Kshitij1995:

<nowiki>Note: this page is under construction</nowiki>

== What is Codeception? ==
Codeception PHP Testing Framework is designed to work just out of the box. This means its installation requires minimal steps and no external dependencies preinstalled (except PHP, of course). Only one configuration step should be taken and you are ready to test your web application from an eye of actual user.

== Structure of a test ==
The testing framework is built on the three layered testing architecture

1. '''Page Objects'''
Each page on your application has a class which we call page objects, each page class will have information about the URL, fields, Text present on the page. We use the best possible selector for any field on the page

2. '''Step Objects'''
Step Objects are classes which contains steps which are to be executed on the application to perform certain operations, step objects make use of page objects to perform thoose actions.

3. '''Cept Class'''
Cept or Test, it is the main class which contains steps of execution for the tests, Cept Class will call Step Class functions which will indirectly make use of page objects to perform operations

== Setting Up Codeception ==
=== setting up the repository ===
'''clone the directory'''

1.fork [https://github.com/joomla-projects/com_localise com_localise]

2.git clone git@github.com:*your-github-profile-name*/com_localise.git

=== Testing with Codeception ===

There are two ways to get and run codeception, via PHAR or via Composer.

'''Codeception.phar'''

Linux Machine : wget http://codeception.com/codecept.phar

Windows Machine: Download from [http://codeception.com/install codecept.phar]

Step1 : php ./codecept.phar build

'''Using Composer'''

You need to have Composer in your system, if not download it from here: https://getcomposer.org/

Step 1: composer update

Step 2: run Codeception by doing: php vendor/codeception/codeception/codecept build

'''Update Repository'''

Step 1: git submodule init

step 2: git submodule update

=== Running the Test ===

Rename tests/acceptance.suite.dist.yml to tests/acceptance.suite.yml
<source lang="bash">
Step 1: Modify the configuration at tests/acceptance.suite.yml to fit your server details.
</source>
Find the instructions in this file : [https://github.com/redCOMPONENT-COM/redCORE/blob/develop/tests/acceptance.suite.dist.yml Instructions]
<source lang="bash">
Step 2: php codecept.phar run
</source>
with --steps to see a step-by-step report on the performed actions.

<source lang="bash">
php codecept.phar run --steps
</source>

with --html. This command will run all tests for all suites, displaying the steps, and building HTML and XML reports. Reports will be store in tests/_output/ directory.

<source lang="bash">
php codecept.phar run --html
</source>

To activate the debug mode in Codeception just add the parameter --debug when you run the tests:

<source lang="bash">
php codecept.phar run acceptance --debug 1stInstallTestCept.php
</source>

== Best Practices at Testing ==
=== When do not use contains ===
We do not recommend to use the function contains on XPath because is not specific and can create false positives at tests.
See: https://github.com/joomla-projects/GSOC-Webdriver_system_tests_for_CMS/pull/99#issuecomment-69004191

[[Category:Automated Testing]]

Testing Joomla Extensions with Codeception

2015-01-12T08:23:30Z

Kshitij1995:

<nowiki>Note: this page is under construction</nowiki>

== What is Codeception? ==
Codeception PHP Testing Framework is designed to work just out of the box. This means its installation requires minimal steps and no external dependencies preinstalled (except PHP, of course). Only one configuration step should be taken and you are ready to test your web application from an eye of actual user.

== Structure of a test ==
The testing framework is built on the three layered testing architecture

1. '''Page Objects'''
Each page on your application has a class which we call page objects, each page class will have information about the URL, fields, Text present on the page. We use the best possible selector for any field on the page

2. '''Step Objects'''
Step Objects are classes which contains steps which are to be executed on the application to perform certain operations, step objects make use of page objects to perform thoose actions.

3. '''Cept Class'''
Cept or Test, it is the main class which contains steps of execution for the tests, Cept Class will call Step Class functions which will indirectly make use of page objects to perform operations

== Setting Up Codeception ==
=== setting up the repository ===
'''clone the directory'''

1.fork [https://github.com/joomla-projects/com_localise com_localise]

2.git clone git@github.com:*your-github-profile-name*/com_localise.git

=== Testing with Codeception ===

There are two ways to get and run codeception, via PHAR or via Composer.

'''Codeception.phar'''

Linux Machine : wget http://codeception.com/codecept.phar

Windows Machine: Download from [http://codeception.com/install codecept.phar]

Step1 : php ./codecept.phar build

'''Using Composer'''

You need to have Composer in your system, if not download it from here: https://getcomposer.org/

Step 1: composer update

Step 2: run Codeception by doing: php vendor/codeception/codeception/codecept build

'''Update Repository'''

Step 1: git submodule init

step 2: git submodule update

=== Running the Test ===

Rename tests/acceptance.suite.dist.yml to tests/acceptance.suite.yml
<source lang="bash">
Step 1: Modify the configuration at tests/acceptance.suite.yml to fit your server details.<br />
</source>
Find the instructions in this file : [https://github.com/redCOMPONENT-COM/redCORE/blob/develop/tests/acceptance.suite.dist.yml Instructions]
<source lang="bash">
Step 2: php codecept.phar run
</source>
with --steps to see a step-by-step report on the performed actions.

<source lang="bash">
php codecept.phar run --steps
</source>

with --html. This command will run all tests for all suites, displaying the steps, and building HTML and XML reports. Reports will be store in tests/_output/ directory.

<source lang="bash">
php codecept.phar run --html
</source>

To activate the debug mode in Codeception just add the parameter --debug when you run the tests:

<source lang="bash">
php codecept.phar run acceptance --debug 1stInstallTestCept.php
</source>

== Best Practices at Testing ==
=== When do not use contains ===
We do not recommend to use the function contains on XPath because is not specific and can create false positives at tests.
See: https://github.com/joomla-projects/GSOC-Webdriver_system_tests_for_CMS/pull/99#issuecomment-69004191

[[Category:Automated Testing]]

Testing Joomla Extensions with Codeception

2015-01-12T08:19:38Z

Kshitij1995: adding new content

<nowiki>Note: this page is under construction</nowiki>

== What is Codeception? ==
Codeception PHP Testing Framework is designed to work just out of the box. This means its installation requires minimal steps and no external dependencies preinstalled (except PHP, of course). Only one configuration step should be taken and you are ready to test your web application from an eye of actual user.

== Structure of a test ==
The testing framework is built on the three layered testing architecture

1. '''Page Objects'''
Each page on your application has a class which we call page objects, each page class will have information about the URL, fields, Text present on the page. We use the best possible selector for any field on the page

2. '''Step Objects'''
Step Objects are classes which contains steps which are to be executed on the application to perform certain operations, step objects make use of page objects to perform thoose actions.

3. '''Cept Class'''
Cept or Test, it is the main class which contains steps of execution for the tests, Cept Class will call Step Class functions which will indirectly make use of page objects to perform operations

== Setting Up Codeception ==
=== setting up the repository ===
'''clone the directory'''

1.fork [https://github.com/joomla-projects/com_localise com_localise]

2.git clone git@github.com:*your-github-profile-name*/com_localise.git

=== Testing with Codeception ===

There are two ways to get and run codeception, via PHAR or via Composer.

'''Codeception.phar'''

Linux Machine : wget http://codeception.com/codecept.phar

Windows Machine: Download from [http://codeception.com/install codecept.phar]

Step1 : php ./codecept.phar build

'''Using Composer'''

You need to have Composer in your system, if not download it from here: https://getcomposer.org/

Step 1: composer update

Step 2: run Codeception by doing: php vendor/codeception/codeception/codecept build

'''Update Repository'''

Step 1: git submodule init

step 2: git submodule update

=== Running the Test ===

Rename tests/acceptance.suite.dist.yml to tests/acceptance.suite.yml
<source lang="bash">
Step 1: Modify the configuration at tests/acceptance.suite.yml to fit your server details.<br />
</source>
Find the instructions in this file : [https://github.com/redCOMPONENT-COM/redCORE/blob/develop/tests/acceptance.suite.dist.yml Instructions]
<source lang="bash">
Step 2: php codecept.phar run
</source>
with --steps to see a step-by-step report on the performed actions.
php codecept.phar run --steps

with --html. This command will run all tests for all suites, displaying the steps, and building HTML and XML reports. Reports will be store in tests/_output/ directory.
php codecept.phar run --html

To activate the debug mode in Codeception just add the parameter --debug when you run the tests:

<source lang="bash">
php codecept.phar run acceptance --debug 1stInstallTestCept.php
</source>

== Best Practices at Testing ==
=== When do not use contains ===
We do not recommend to use the function contains on XPath because is not specific and can create false positives at tests.
See: https://github.com/joomla-projects/GSOC-Webdriver_system_tests_for_CMS/pull/99#issuecomment-69004191

[[Category:Automated Testing]]

Testing Joomla Extensions with Codeception

2014-12-29T18:41:25Z

Kshitij1995: /* Structure of a test */

Testing Joomla Extensions with Codeception

2014-12-29T16:37:04Z

Kshitij1995: /* What is Codeception? */