Files
librenms-librenms/LibreNMS/Polling/ModuleStatus.php
Tony Murray 0a5c174f4f Fix test regressions introduced while tests were broken (#16399)
* AuthSSOTest: clear roles cache

* PollingJob: When a poller module doesn't exist, return null instead of false.  Skip all other checks and disable polling in that case.

* Sensors: Guess high and low limits separately as needed

* Sensors: drac test psu current data was wrong, referencing the snmprec, 8 / 10 and 0 / 10 should be the values
NOTE: drac is messed up and runs a billion snmp queriess for no reason

* please phpstan

* Sensors: limits reference old code
move to "creating"

* Fix gw-eydfa accidental assignment

* Fix ies5000 test data now that the bad state is removed

* Fix ies5000 test data part 2

* Move sensor discovery reset into discover_device()

* infinera remove duplicate sensor (also a lot of trailing whitespace apparently)

* Fix innovaphone bad yaml discovery

* module tests should be using null when test data doesn't exist, not an empty array

* When discovery or polling is not supported, dump null instead of an array.
Account for nulls in testing

* update ISE serial

* Janitza was seemingly wrong before

* Remove some private data

* bgp-peers requires ipv4-addresses and ipv6-addresses for bgpPeerIface

* fix polycomLens broken state sensor discovery

* Raritan pdu and pdu2 test data was combined in one test file, split it out

* scs-ks duplicate temperature sensor indexes

* sentry3 someone tried to avoid breaking stuff but just broke things more

* smartos-dcp-m fix incorrect numeric oids

* ssu2000 apparently test data was wrong, must have fixed a bug in the code.

* timos remove duplicate dbm sensor definitions

* bgpPeerIface is working in tests now

* Fix moxa-etherdevice when mibs are a bit different

* xw_to_dbm negative values should return null

* Update cisco test data due previous fixes/changes

* One more bgpPeerIface

* Add orderBy to ospf module db dumps

* Remove links test data for now

* Improve handling of bad data in ipv6-addresses module
2024-09-23 10:11:05 -05:00

98 lines
2.5 KiB
PHP

<?php
/**
* ModuleStatus.php
*
* -Description-
*
* 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 2023 Tony Murray
* @author Tony Murray <murraytony@gmail.com>
*/
namespace LibreNMS\Polling;
use App\Models\Device;
class ModuleStatus
{
public function __construct(
public ?bool $global,
public ?bool $os = null,
public ?bool $device = null,
public ?bool $manual = null,
) {
}
public function isEnabled(): bool
{
if ($this->global === null) {
return false; // this module does not have polling
}
if ($this->manual !== null) {
return $this->manual;
}
if ($this->device !== null) {
return $this->device;
}
if ($this->os !== null) {
return $this->os;
}
return $this->global;
}
public function reason(): string
{
if ($this->manual !== null) {
return 'manually';
}
if ($this->device !== null) {
return 'by device';
}
if ($this->os !== null) {
return 'by OS';
}
return 'globally';
}
public function isEnabledAndDeviceUp(Device $device, bool $check_snmp = true): bool
{
if ($check_snmp && $device->snmp_disable) {
return false;
}
return $this->isEnabled() && $device->status;
}
public function __toString(): string
{
return sprintf('Module %s: Global %s | OS %s | Device %s | Manual %s',
$this->isEnabled() ? 'enabled' : 'disabled',
$this->global ? '+' : '-',
$this->os === null ? ' ' : ($this->os ? '+' : '-'),
$this->device === null ? ' ' : ($this->device ? '+' : '-'),
$this->manual === null ? ' ' : ($this->manual ? '+' : '-'),
);
}
}