https://github.com/marcortola/behat-seo-contexts
Behat extension for testing some On-Page SEO factors: meta title/description, canonical, hreflang, meta robots, robots.txt, redirects, sitemap validation, HTML validation, performance...
https://github.com/marcortola/behat-seo-contexts
behat-context canonicalization hreflang-checker html-validation meta-tags robots-txt seo sitemap-validation
Last synced: 5 months ago
JSON representation
Behat extension for testing some On-Page SEO factors: meta title/description, canonical, hreflang, meta robots, robots.txt, redirects, sitemap validation, HTML validation, performance...
- Host: GitHub
- URL: https://github.com/marcortola/behat-seo-contexts
- Owner: marcortola
- License: mit
- Created: 2018-11-03T17:30:45.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-11-28T19:39:58.000Z (over 3 years ago)
- Last Synced: 2025-09-22T02:23:44.847Z (9 months ago)
- Topics: behat-context, canonicalization, hreflang-checker, html-validation, meta-tags, robots-txt, seo, sitemap-validation
- Language: PHP
- Homepage:
- Size: 150 KB
- Stars: 13
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Behat SEO Contexts
[](https://github.com/marcortola/behat-seo-contexts/releases)
[](https://travis-ci.org/marcortola/behat-seo-contexts)
[](https://scrutinizer-ci.com/g/marcortola/behat-seo-contexts)
**Behat extension for testing some On-Page SEO factors.**
Includes contexts for testing:
* title / meta description
* canonical
* hreflang
* meta robots
* robots.txt
* indexation: tests meta robots + robots.txt + X-Robots-Tag header
* redirects
* sitemap validation (inc. multilanguage)
* HTML validation
* assets performance
* accessibility
* UX
* more...
Installation
------------
Basic requirements:
* PHP 7.1+
* Behat 3+
* Mink + Mink extension
### How to install it
1. [Install Composer](https://getcomposer.org/download/)
2. Execute:
```
$ composer require marcortola/behat-seo-contexts --dev
```
3. Add the Context you need to `behat.yml`:
```yaml
# behat.yml
default:
# ...
suites:
default:
contexts:
- MarcOrtola\BehatSEOContexts\Context\MetaContext
- MarcOrtola\BehatSEOContexts\Context\LocalizationContext
- MarcOrtola\BehatSEOContexts\Context\RobotsContext
- MarcOrtola\BehatSEOContexts\Context\IndexationContext
- MarcOrtola\BehatSEOContexts\Context\RedirectContext
- MarcOrtola\BehatSEOContexts\Context\SitemapContext
- MarcOrtola\BehatSEOContexts\Context\HTMLContext
- MarcOrtola\BehatSEOContexts\Context\PerformanceContext
- MarcOrtola\BehatSEOContexts\Context\SocialContext
- MarcOrtola\BehatSEOContexts\Context\AccessibilityContext
- MarcOrtola\BehatSEOContexts\Context\UXContext
```
### Featured steps
##### MetaContext
```gherkin
Then the page canonical should not be empty
Then the page canonical should be :expectedCanonicalUrl
Then the page title should not be empty
Then the page title should be :expectedTitle
Then the page meta description should not be empty
Then the page meta description should be :expectedMetaDescription
Then the page meta robots should be noindex
Then the page meta robots should not be noindex
```
##### LocalizationContext
```gherkin
Then the page hreflang markup should be valid
```
##### RobotsContext
```gherkin
Given I am a :crawlerUserAgent crawler
Then I should not be able to crawl :resource
Then I should be able to crawl :resource
Then I should be able to get the sitemap URL
```
##### IndexationContext
```gherkin
Then the page should be indexable
Then the page should not be indexable
```
##### RedirectContext
```gherkin
Given I follow redirects
Given I do not follow redirects
Then I should be redirected to :url
```
##### SitemapContext
```gherkin
Given the sitemap :sitemapUrl
Then the sitemap should be valid
Then the index sitemap should be valid
Then the multilanguage sitemap should be valid
Then the index sitemap should have a child with URL :childSitemapUrl
Then /^the sitemap should have ([0-9]+) children$/
Then the multilanguage sitemap should pass Google validation
Then the sitemap URLs should be alive
Then /^(\d+) random sitemap URLs? should be alive$/
```
##### HTMLContext
```gherkin
Then the page HTML markup should be valid
Then /^the page HTML5 doctype declaration should (not |)be valid$
```
##### PerformanceContext
```gherkin
Then /^browser cache should be enabled for (.+\..+|external|internal) (png|jpeg|gif|ico|js|css) resources$/
Then /^Javascript code should load (async|defer)$/
Then HTML code should be minified
Then CSS code should be minified
Then Javascript code should be minified
Then CSS code should load deferred
Then critical CSS code should exist in head
```
##### SocialContext
```gherkin
Then /^the (Twitter|Facebook) Open Graph data should satisfy (minimum|full) requirements$/
```
##### AccessibilityContext
```gherkin
Then the images should have alt text
```
##### UXContext
```gherkin
Then the site should be responsive
Then the site should not be responsive
```
### Examples
This library is self-tested, and you can find examples inside the [features directory](./tests/features).
Feel free to explore it to discover each step definition.
Useful tips
------------
* Use [Symfony KernelDriver](https://github.com/Behat/Symfony2Extension) for improving the performance if you are working in a Symfony project.