qa-tools/qa-tools.github.io

QA-Tools Website

QA-Tools

QA-Tools is a set of quality assurance tools to be used during acceptance tests writing on PHP.

Library implements PageObject pattern, used in variety of testing frameworks (e.g. Selenium browser automation framework).

Website and Documentation

• Website: https://qa-tools.github.io/
• Documentation: https://qa-tools.readthedocs.io/
• Demo using PHPUnit: https://github.com/qa-tools/phpunit-example/

Asking Questions

Feel free to ask any questions and share your experiences in the Chat Room and help to improve the documentation.

Installation

• execute this command to add dependencies: php composer.phar require qa-tools/qa-tools:^1.0

Requirements

• Composer
• MinkExtension, when Behat is used.
• QA-Tools / PHPUnit Extension, when PHPUnit is used.
• Mink in other cases.

Contributing

See CONTRIBUTING file.

License

QA-Tools is released under the BSD-3-Clause License. See the bundled LICENSE file for details.

qa-tools.github.io's Issues

Replace example code with link to Demo

1. remove sub-pages from http://www.qa-tools.io/examples/ page
2. on the http://www.qa-tools.io/examples/ page show link to demo project - https://github.com/qa-tools/phpunit-example

This would solve problem, where example code is duplicated.

Extension point explanation

• if a new element is to be added, then where to do it (for HtmlElements)
• creating custom locators (can use BEM as example)
• best practices in new element creation
• element location: xpath or CSS?

Correct page creation code

On following pages:

• http://www.qa-tools.io/examples/01-PageObject/
• http://www.qa-tools.io/examples/02-HtmlElements/
• http://www.qa-tools.io/examples/03-BEM/

the page instantiation code is way outdated.

we need to (for each page):

1. show how to create page factory (with and without a config)
2. put page factory into the page (instead of session)
3. make a note that getPage shouldn't be used yet

Create "Getting Started" page

We need to create "Getting Started" page were library usage will be described from top to bottom (with Behat and with PHPUnit):

1. installing via Composer
2. create test case (for PHPUnit)
3. writing first test that uses session (for PHPUnit)
4. configuring via .behat.yml (for Behat)
5. adding connecting QATools to your FeatureContext

Describe all annotation usage

Create a separate page explaining every annotation type and their possible usage/restrictions.

Write documentation for ReadTheDocs

We need to write documentation and I think that https://readthedocs.org/ is the right place to do it. The only problem is that they are using reStructured Text (RST) format and not Markdown (MD), but we can work something out.

Example: http://behat-page-object-extension.readthedocs.org/en/latest/index.html

Describe how library works

Describe how library works:

• major players
• proxies
• Mink
• element locators
• element decorators
• annotation handling

Annotations in depth

Describe each annotation and all use cases with small examples on one page.

Currently we only have names of annotations and large example which doesn't cover 100% use cases.

Create alert/warning/note styles

Currently we only have .message class that shows basic message. I think that we also should have .alert, .note and .warning classes (like on Confluence) to show corresponding messages.

They can be used to notify the reader of important stuff on a page first.