Simple routing to use named pages instead of urls., (*1)
FeatureContext step definitions:
- Given I am on the :page page
- Given I am on the :page page on :device
- Given I am on the :page with the following params:
- Then I should be on the :arg1 page, (*2)
Features in Genesis\TestRouting\RoutingContxt class:
- ::getRoute() accepts a callback function that allows manipulation of url before returning final url.
- ::setAllRoutesFromExternalSource() provides a bridge for other routing mechanisms in place. You can re-use your existing application routing configuration.
- ::registerFile() register an external file containing all your route definitions. This call is typically contained in one of your context constructor files., (*3)
Features in RouteAssert class:
- ::page() assert whether a page resolved correctly to a url.
- ::uri() assert that you are on the correct uri.
- ::queryParams() assert that the a url holds the correct query params., (*4)
Release detail:
Major: Released first version of test routing.
Minor: Assertion library added. New calls for building up URL's.
Patch: Fix callable method break if no overriding method is defined., (*5)
default:
formatters:
pretty: true
suites:
default:
contexts:
- RoutingContext:
routesFilePath: ./features/bootstrap/Routing.php # relative path.
windowSizeDevice: desktop # set to default resolution for device on visit.
windowSizeRes: 1280x1024 # set to custom resolution on visit.
The routesFilePath should be a php file containing an array of routes like so:, (*6)
return [
'home page' => '/home',
'about us' => '/about-us'
];
You will be using the names assigned to routes to reference them in the feature files using the step definitions provided., (*7)
PHP - Adding a route
use Genesis\TestRouting\Routing;
Routing::addRoute('home page', '/home');
Get a route back
use Genesis\TestRouting\Routing;
$route = Routing::getRoute('home page');
Output: /home
Register the file that contains all your routing.
use Genesis\TestRouting\Routing;
Routing::registerFile('/my-routes.php');
use Genesis\TestRouting\Routing;
$route = Routing::getRoute('home page', function ($url) {
return $url . '?testing=1';
});
Output: /home?testing=1
Re-using your application routing configuration
use Genesis\TestRouting\Routing;
use MyApp\Routing\AppRouter;
$router = new AppRouter($routes);
// As long as it is an iterable, it will do.
$routes = $router->getAll();
Routing::setAllRoutesFromExternalSource($routes, function ($route, $index) {
// $route contains individual elements contained within routes. Just return the name and the url.
return [$route->getName() => $route->getUrl()];
});
Note: You can bypass the above by using the file data directly most of the time.
Integrating with the behat-sql-extension
Two ways to do this, either using the method below or extending the RoutingContext file to provide just the callback
while retaining all the rest of the features:, (*8)
Method 1:, (*9)
<?php
use Genesis\SQLExtensionWrapper\BaseProvider;
use Genesis\TestRouting\RoutingContext as Routing;
/**
* RoutingContext class.
*/
class RoutingContext extends Routing
{
/**
* @Override The bit that will replace ids n stuff within our routes.
*
* @return callable
*/
protected function getCallable(): callable
{
$sqlApi = BaseProvider::getApi();
return function ($url) use ($sqlApi) {
return $sqlApi->get('keyStore')->parseKeywordsInString($url);
};
}
}
Then register the above RoutingContext in behat.yml instead of the one provided by the extension., (*10)
Method 2:, (*11)
use Genesis\TestRouting\Routing;
$url = Routing::getRoute($pageName, function ($url) use ($sqlApi) {
// Parse out any database keywords with their values from the keystore for dynamic URLs.
return $sqlApi->get('keyStore')->parseKeywordsInString($url);
});
Wallogit.com
