mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
1ee2e8e0e0
* Updated to use new theme for docs site * Updated theme location * Removed librenms.css * Updated index page + re-added librenms.css * Use built in theme modification * flexbox grid, dump bootstrap * tidy up things * Added path and updated deploy script + mkdocs config * Removed db schmea changes * Updated to install python/pip 3 * Removed pip3 install * Pip3 install * Updated deploy-docs * Updated deploy-docs
71 lines
2.5 KiB
PHP
71 lines
2.5 KiB
PHP
<?php
|
|
/**
|
|
* DocTest.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 <http://www.gnu.org/licenses/>.
|
|
*
|
|
* @package LibreNMS
|
|
* @link http://librenms.org
|
|
* @copyright 2018 Neil Lathwood
|
|
* @author Neil Lathwood <gh+n@laf.io>
|
|
*/
|
|
|
|
namespace LibreNMS\Tests;
|
|
|
|
use Symfony\Component\Yaml\Yaml;
|
|
|
|
class DocTest extends TestCase
|
|
{
|
|
private $hidden_pages = [
|
|
'API/API-Docs.md',
|
|
'Alerting/Old_Templates.md',
|
|
'Extensions/Alerting.md',
|
|
'Extensions/Email-Alerting.md',
|
|
'Extensions/Graphite.md',
|
|
'Extensions/InfluxDB.md',
|
|
'Extensions/OpenTSDB.md',
|
|
'Extensions/Port-Description-Parser.md',
|
|
'Extensions/Prometheus.md',
|
|
'Extensions/RRDCached-Security.md',
|
|
'General/Contributing.md',
|
|
'General/Credits.md',
|
|
'Installation/Installation-(Debian-Ubuntu).md',
|
|
'Installation/Installation-(RHEL-CentOS).md',
|
|
'Installation/Installation-CentOS-6-Apache-Nginx.md',
|
|
'Installation/Installation-Ubuntu-1404-Apache.md',
|
|
'Installation/Installation-Ubuntu-1404-Lighttpd.md',
|
|
'Installation/Installation-Ubuntu-1404-Nginx.md',
|
|
'Installation/Installation-Ubuntu-1604-Apache.md',
|
|
'Installation/Installation-Ubuntu-1604-Nginx.md',
|
|
'Installation/Installing-LibreNMS.md',
|
|
'Support/Support-New-OS.md',
|
|
];
|
|
|
|
public function testDocExist()
|
|
{
|
|
$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");
|
|
});
|
|
}
|
|
}
|