PHPackages                             mbhsoft/codeception-sitemap-module - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. mbhsoft/codeception-sitemap-module

ActiveLibrary

mbhsoft/codeception-sitemap-module
==================================

Parse and validate sitemap.xml files

3.0.0(3y ago)012PHPPHP ^8.0

Since Jun 2Pushed 3y ago1 watchersCompare

[ Source](https://github.com/MbhSoft/codeception-sitemap-module)[ Packagist](https://packagist.org/packages/mbhsoft/codeception-sitemap-module)[ RSS](/packages/mbhsoft-codeception-sitemap-module/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (8)Versions (16)Used By (0)

Codeception Sitemap Module
==========================

[](#codeception-sitemap-module)

This package provides parsing and validation of sitemap.xml files.

Fork from [portrino/codeception-sitemap-module](https://github.com/portrino/codeception-sitemap-module)

Installation
------------

[](#installation)

You need to add the repository into your composer.json file

```
    composer require --dev mbhsoft/codeception-sitemap-module
```

Usage
-----

[](#usage)

You can use this module as any other Codeception module, by adding 'Sitemap' to the enabled modules in your Codeception suite configurations.

### Enable module and setup the configuration variables

[](#enable-module-and-setup-the-configuration-variables)

The `url` could be set in config file directly or via an environment variable: `%BASE_URL%`

```
modules:
    enabled:
        - Sitemap:
            depends: PhpBrowser
            url: ADD_YOUR_BASE_URL_HERE
```

You could also configure the guzzle instance of the sitemap parser package. For example to disable SSL certification checks:

```
modules:
    enabled:
      - Sitemap:
          sitemapParser:
            guzzle:
              verify: false
```

Update Codeception build

```
  codecept build
```

### Implement the cept / cest

[](#implement-the-cept--cest)

```
    $I->wantToTest('If sitemap is valid.');

    $I->amOnPage('sitemap_index.xml');

    // validation against https://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd
    // sitemap will be retrieved from: http:///sitemap.xml, where http:/// is configured in module config
    $I->seeSiteMapIsValid('sitemap.xml');

    // validation against https://www.sitemaps.org/schemas/sitemap/0.9/siteindex.xsd
    // siteindex will be retrieved from: http:///sitemap_index.xml, where http:/// is configured in module config
    $I->seeSiteIndexIsValid('sitemap_index.xml');

    // validate url occurence (also recursively through siteindex files!)

    // complete url
    $I->seeSiteMapContainsUrl('sitemap_index.xml', 'https://www.domain.tld/foo/bar/');

    // without base_url (checks if one of the sitemap urls contains the path)
    $I->seeSiteMapContainsUrlPath('sitemap.xml', '/foo/bar');

    // via response object
    $I->seeSiteMapResponseContainsUrlPath('/bar/');
    $I->seeSiteMapResponseContainsUrlPath('/foo/');

```

Authors
-------

[](#authors)

[![](https://avatars0.githubusercontent.com/u/726519?s=40&v=4)](https://avatars0.githubusercontent.com/u/726519?s=40&v=4)[![](https://avatars.githubusercontent.com/u/1684986?s=40&v=4)](https://avatars.githubusercontent.com/u/1684986?s=40&v=4)

- **André Wuttig** - *Initial work, Unit Tests, Documentation* - [aWuttig](https://github.com/aWuttig)
- **Marc Bastian Heinrichs** - *Bugfixes, Acceptance tests, Migration to GitHub actions, Upgrade for Codeception v4* [Mabahe](https://github.com/Mabahe)

See also the list of [contributors](https://github.com/portrino/codeception-sitemap-module/graphs/contributors) who participated in this project.

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity76

Established project with proven stability

 Bus Factor1

Top contributor holds 51.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~181 days

Recently: every ~466 days

Total

12

Last Release

1278d ago

Major Versions

0.3.5 → 2.0.02022-11-17

2.0.1 → 3.0.02022-11-17

PHP version history (2 changes)2.0.0PHP ^7.4

3.0.0PHP ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/f49bce751a579cd33cc1e04e9be86ffbaf5869778533050383f7329d42d3f808?d=identicon)[Mabahe](/maintainers/Mabahe)

---

Top Contributors

[![aWuttig](https://avatars.githubusercontent.com/u/726519?v=4)](https://github.com/aWuttig "aWuttig (27 commits)")[![Mabahe](https://avatars.githubusercontent.com/u/1684986?v=4)](https://github.com/Mabahe "Mabahe (23 commits)")[![tgriessbach](https://avatars.githubusercontent.com/u/11647324?v=4)](https://github.com/tgriessbach "tgriessbach (2 commits)")

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/mbhsoft-codeception-sitemap-module/health.svg)

```
[![Health](https://phpackages.com/badges/mbhsoft-codeception-sitemap-module/health.svg)](https://phpackages.com/packages/mbhsoft-codeception-sitemap-module)
```

###  Alternatives

[magento/magento2-functional-testing-framework

Magento2 Functional Testing Framework

15511.5M30](/packages/magento-magento2-functional-testing-framework)[lucatume/wp-browser

A set of Codeception modules to test WordPress projects.

6343.8M153](/packages/lucatume-wp-browser)[codeception/module-cli

Codeception module for testing basic shell commands and shell output

149.8M162](/packages/codeception-module-cli)[guncha25/drupal-codeception

Codeception toolset for Drupal testing.

17131.1k2](/packages/guncha25-drupal-codeception)[mlambley/swagception

Validate your API against Swagger 2.0 using Codeception

4629.4k1](/packages/mlambley-swagception)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)