librenms/tests/DocsTest.php
Jellyfrog 2b3575a5e9
Laravel 10.x Shift (#14995)
* Apply code style

* Remove explicit call to register policies

* Shift core files

* Shift config files

* Default config files

In an effort to make upgrading the constantly changing config files
easier, Shift defaulted them and merged your true customizations -
where ENV variables may not be used.

* Bump Laravel dependencies

* Add type hints for Laravel 10

* Shift cleanup

* wip

* wip

* sync translation

* Sync back config

* Public Path Binding

* QueryException

* monolog

* db::raw

* monolog

* db::raw

* fix larastan collections

* fix phpstan bug looping forever

* larastan errors

* larastan: fix column type

* styleci

* initialize array

* fixes

* fixes

---------

Co-authored-by: Shift <shift@laravelshift.com>
2023-05-24 22:21:54 +02:00

62 lines
1.9 KiB
PHP

<?php
/**
* DocsTest.php
*
* Tests for Docs.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* @link https://www.librenms.org
*
* @copyright 2018 Neil Lathwood
* @author Neil Lathwood <gh+n@laf.io>
*/
namespace LibreNMS\Tests;
use Symfony\Component\Yaml\Yaml;
class DocsTest extends TestCase
{
private $hidden_pages = [
'General/Changelogs/2013.md',
'General/Changelogs/2014.md',
'General/Changelogs/2015.md',
'General/Changelogs/2016.md',
'General/Changelogs/2017.md',
'General/Changelogs/2018.md',
'General/Changelogs/2019.md',
'General/Changelogs/2020.md',
];
/**
* @group docs
*/
public function testDocExist(): void
{
$mkdocs = Yaml::parse(file_get_contents(__DIR__ . '/../mkdocs.yml'));
$dir = __DIR__ . '/../doc/';
$files = str_replace($dir, '', rtrim(`find $dir -name '*.md'`));
// check for missing pages
collect(explode(PHP_EOL, $files))
->diff(collect($mkdocs['nav'])->flatten()->merge($this->hidden_pages)) // grab defined pages and diff
->each(function ($missing_doc) {
$this->fail("The doc $missing_doc doesn't exist in mkdocs.yml, please add it to the relevant section");
});
$this->expectNotToPerformAssertions();
}
}