edno/codeception-browsermob

Codeception extension providing BrowserMob Proxy capabilities

Codeception BrowserMob Proxy

, _(*1)

The Codeception module for BrowserMob Proxy., _(*2)

Roadmap

• [x] 0.1: Initial version based on library PHPBrowserMobProxy by chartjes with limited support of BrowserMob Proxy legacy API and no Littleproxy support.
• [ ] 0.2: New PHP BrowserMob Proxy with full REST API support (Jetty and Littleproxy) and proxy auto-configuration feature.
• [ ] 0.3: Full integration with Codeception modules PhpBrowser and WebDriver

Minimum Requirements

• Codeception 2.2
• PHP 7.2
• BrowserMob Proxy 2.0

Installation

The module can be installed using Composer., _(*3)

$ composer require edno/codeception-browsermob

Be sure to enable the module as shown in configuration below., _(*4)

Configuration

Enabling BrowserMob is done in your configuration file .yml., _(*5)

module:
    enabled:
        - Codeception\Extension\BrowserMob
            host: 'localhost'
            port: 8080

Parameters

BrowserMob support following configuration parameters:, _(*6)

URLs whitelisting, _(*7)

`code`: HTTP status code for URLs that do not match patterns, _(*8)

<, _(*9)

p>patterns: array of whitelisted URLs patterns, _(*10)

<, _(*11)

p> | | blacklist | array |, _(*12)

URLs blacklisting, _(*13)

`code`: HTTP status code for URLs that match patterns, _(*14)

<, _(*15)

p>patterns: array of blacklisted URLs patterns, _(*16)

<, _(*17)

p> | | limits | array | Bandwidth limits through the proxy (see BrowserMob Proxy REST API)| | timeouts | array | Proxy timeouts (see BrowserMob Proxy REST API) | | basicAuth | array |, _(*18)

Sets automatic basic authentication a list of domains, _(*19)

`domain`: domain name, _(*20)

`options`:HTTP authentication parameters using format *`name: value`* (see [BrowserMob Proxy REST API](https://github.com/lightbody/browsermob-proxy#rest-api)), _(*21)

| | dns | array |, _(*22)

Internal proxy DNS using pairs of domain/IP to map, _(*23)

`domain`: domain name, _(*24)

`ip`: matching IP, _(*25)

| | retry | integer | Number of times a method will be retried [default = 0] |, _(*26)

Example, _(*27)

modules:
    config:
        Codeception\Extension\BrowserMob:
            host: 'localhost'
            port: 9090
            autostart: true
            whitelist:
                code: 404
                patterns:
                    - 'http://codeception.com/'
            limits:
                downstreamKbps: 12
                upstreamKbps: 12
                latency: 1
            timeouts:
                request: 10
                read: 10
                connection: 10
                dns: 10
            basicAuth:
                - domain: example.local
                  options:
                      username: myUsername
                      password: myPassword
            dns:
                - domain: example.local
                  ip: 127.0.0.1
                - domain: wikipedia.org
                  ip: 192.168.1.1
            retry: 3

Documentation

The module documentation is available in the wiki., _(*28)

For more information on how to use BrowserMob proxy, refer to BrowserMob Proxy REST API documentation., _(*29)