librenms/tests/OSModulesTest.php

<?php
/**
 * OSModulesTest.php
 *
 * Test discovery and poller modules
 *
 * 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  2017 Tony Murray
 * @author     Tony Murray <murraytony@gmail.com>
 */

namespace LibreNMS\Tests;

use LibreNMS\Config;
use LibreNMS\Device\Processor;
use LibreNMS\Util\ModuleTestHelper;

class OSModulesTest extends DBTestCase
{
    /**
     * Test all modules for a particular OS
     *
     * @group os
     * @dataProvider dumpedDataProvider
     * @param string $target_os name of the (and variant) to test
     * @param string $filename file name of the json data
     * @param array $modules modules to test for this os
     */
    public function testOS($target_os, $filename, $modules)
    {
        $this->requreSnmpsim();  // require snmpsim for tests
        global $snmpsim;

        $file = Config::get('install_dir') . '/' . $filename;
        $expected_data = json_decode(file_get_contents($file), true);

        list($os, $variant) = explode('_', $target_os, 2);

        $helper = new ModuleTestHelper($modules, $os, $variant);
        $helper->setQuiet();

        $results = $helper->generateTestData($snmpsim, true);

        foreach ($modules as $module) {
            $this->assertEquals(
                $expected_data[$module]['discovery'],
                $results[$module]['discovery'],
                "OS $target_os: Discovered $module data does not match that found in $filename\n"
                . $helper->getLastDiscoveryOutput()
                . "\nOS $target_os: Polled $module data does not match that found in $filename"
            );

            $this->assertEquals(
                $expected_data[$module]['poller'] == 'matches discovery' ? $expected_data[$module]['discovery'] : $expected_data[$module]['poller'],
                $results[$module]['poller'],
                "OS $target_os: Polled $module data does not match that found in $filename\n"
                . $helper->getLastPollerOutput()
                . "\nOS $target_os: Polled $module data does not match that found in $filename"
            );
        }
    }


    public function dumpedDataProvider()
    {
        $install_dir = Config::get('install_dir');
        $dump_files = glob("$install_dir/tests/data/*.json");
        $data = array();
        $modules = getenv('TEST_MODULES') ? explode(',', getenv('TEST_MODULES')) : array();

        foreach ($dump_files as $file) {
            $os = basename($file, '.json');
            $short_file = str_replace($install_dir.'/', '', $file);
            $data_modules = array_keys(json_decode(file_get_contents($file), true));

            if (count(array_diff($modules, $data_modules)) !== 0) {
                continue;  // no test data for selected modules
            }

            $test_modules = empty($modules) ? $data_modules : array_intersect($modules, $data_modules);

            $data[$os] = array(
                $os,
                $short_file,
                $test_modules,
            );
        }

        return $data;
    }
}