mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Run docs tests when only docs are modified. (#11483)

Browse Source
This commit is contained in:
Tony Murray
2020-04-25 21:43:03 -05:00
committed by GitHub
parent cd9e5327bd
commit d4225806a8
2 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
scripts/pre-commit.php
View File

@ -98,6 +98,7 @@ $completed_tests = array(
'style' => false,
'unit' => false,
);
$docs_only = false;
if ($os = check_opt($options, 'os', 'o')) {
// enable unit tests, snmpsim, and db
@ -136,7 +137,11 @@ if (!empty($changed_files) && $map['php'] === 0 && $map['os-php'] === 0) {
// If we have no php files and no OS' found then also skip unit checks.
if (!empty($changed_files) && $map['php'] === 0 && empty($map['os']) && !$os) {
putenv('SKIP_UNIT_CHECK=1');
if ($map['docs'] > 0) {
$docs_only = true;
} else {
putenv('SKIP_UNIT_CHECK=1');
}
}
// If we have more than 4 (arbitrary number) of OS' then blank them out
@ -162,7 +167,7 @@ foreach (array_keys($options) as $opt) {
echo 'Only checking os: ' . implode(', ', (array)$os) . PHP_EOL;
}
$ret = run_check('unit', $passthru, $command_only, compact('fail_fast', 'os', 'module'));
$ret = run_check('unit', $passthru, $command_only, compact('fail_fast', 'os', 'module', 'docs_only'));
}
if ($fail_fast && $ret !== 0 && $ret !== 250) {
@ -352,6 +357,10 @@ function check_unit($passthru = false, $command_only = false, $options = array()
$phpunit_cmd .= " --group os --filter '/::test[A-Za-z]+$|::test[A-Za-z]+ with data set \"$filter.*\"$/'";
}
if ($options['docs_only']) {
$phpunit_cmd .= " --group docs";
}
if ($options['module']) {
$phpunit_cmd .= ' tests/OSModulesTest.php';
}

5
tests/DocsTest.php
View File

@ -62,7 +62,10 @@ class DocsTest extends TestCase
'Installation/Ubuntu-image.md',
'Installation/CentOS-image.md',
];
/**
* @group docs
*/
public function testDocExist()
{
$mkdocs = Yaml::parse(file_get_contents(__DIR__ . '/../mkdocs.yml'));