Behat analysis extension

Introduction

Well, I always start asking "why?" when encoutering some crazy project. So, I will start by answering this trivial question.

I've simply realised that the more a project grows, the more its FeatureContext also grows! Some of the ones I've worked on have more than 1000 lines of code and it suffers from the same maintainability issues than any other huge class. Many great tools already exists to provide solution against this drawback: OOP, SubContexts, PageObjectContext, ...

But still, sometimes you need to look at your past and try to improve what you've done and that's why I've done this extension!

This extension provides some basic analysis about your step definitions. For the moment, it focuses on rarely used steps and similar ones.

Installation

Define dependencies in your composer.json:

{
    "require": {
        ...

            "gquemener/behat-analysis-extension": "~1.0"
    }
}

Install/update your vendors:

    $ curl http://getcomposer.org/installer | php
    $ php composer.phar install

Activate extension by specifying its class in your behat.yml:

    # behat.yml
    default:
        # ...
        extensions:
            Behat\AnalysisExtension\Extension: ~

Usage

After installation, a new analysis formatter should be available. Then, run your feature suite using it:

    $ bin/behat -fanalysis --dry-run

NB: It's recommended (but not mandatory) to run the analysis using the --dry-run option to accelerate the report generation.

Example

    $ bin/behat -fanalysis --dry-run
        ---------------------------------------------------------------------- 70
        ---------------------------------------------------------------------- 140
        ---------------------------------------------------------------------- 210
        ---------------------------------------------------------------------- 280
        ---------------------------------------------------------------------- 350
        ------------------------
        
        58 scenarios (58 skipped)
        374 steps (374 skipped)
        
        Behat Steps Analysis
        ====================
        40 steps were used once.
        The most used step is /^I am logged in as "([^"]*)"$/ with 58 calls.
        Some steps might be merged to reduce their implementation redundancy:
          - /^I am on the "([^"]*)" attribute page$/ and /^I am on the "([^"]*)" product page$/
          - /^I enable the product$/ and /^I disable the product$/
          - /^I enable the product$/ and /^I save the product$/
          - /^an enabled "([^"]*)" product$/ and /^a disabled "([^"]*)" product$/

Contribution

It is more than welcome as always!

Feel free to contact me on twitter @GildasQ or through the issue system.

gquemener / behat-analysis-extension Goto Github PK