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

Improve trap testing (#14546)

Browse Source 
* Improve trap testing
Add helper log() to Trap
Avoid saving to the database at all

* style

* Move all traps to $trap->log()

* Update tests

* Lint and style fixes

* Use correct partial mock call

* more style

* Add docs

* debug in ci

* use the correct log function....................

* all, I guess

* not the first??

* 3rd?

* use event_id to order
This commit is contained in:
Tony Murray
2022-11-05 14:43:54 -05:00
committed by GitHub
parent 7f3301caa4
commit 26318dc4b3
197 changed files with 2349 additions and 3870 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
doc/Developing/SNMP-Traps.md
View File

@@ -41,7 +41,6 @@ namespace LibreNMS\Snmptrap\Handlers;
use App\Models\Device;
use LibreNMS\Interfaces\SnmptrapHandler;
use LibreNMS\Snmptrap\Trap;
use Log;
class ColdBoot implements SnmptrapHandler
{
@@ -55,13 +54,13 @@ class ColdBoot implements SnmptrapHandler
*/
public function handle(Device $device, Trap $trap)
{
Log::event('SNMP Trap: Device ' . $device->displayName() . ' cold booted', $device->device_id, 'reboot', 4);
$trap->log('SNMP Trap: Device ' . $device->displayName() . ' cold booted', $device->device_id, 'reboot', 4);
}
}
```
where number on the end of the row `Log::event` means color of the eventlog:
where number on the end means color of the eventlog:
```
1 green
@@ -88,8 +87,7 @@ event log entries within the handle function.
```php
$trap->getDevice(); // gets Device model for the device associated with this trap
$trap->getHostname(); // gets hostname sent with the trap
$trap->getIp(); // gets source IP of this trap
$trap->ip; // gets source IP of this trap
$trap->getTrapOid(); // returns the string you registered your class with
```
@@ -112,5 +110,36 @@ $trap->findOids('ifDescr'); // returns all oid keys containing the string
If the above isn't adequate, you can get the entire trap text:
```php
$trap->getRaw();
$trap->raw;
```
### Tests
Submitting new traps requires them to be fully tested. You can find many examples in the
`tests/Feature/SnmpTraps/` directory.
Here is a basic example of a test that trap handler only creates a log message.
If your trap modifies the database, you should also test that it does so.
```php
<?php
namespace LibreNMS\Tests\Feature\SnmpTraps;
class ColdStratTest extends SnmpTrapTestCase
{
public function testColdStart(): void
{
$this->assertTrapLogsMessage(rawTrap: <<<'TRAP'
{{ hostname }}
UDP: [{{ ip }}]:44298->[192.168.5.5]:162
DISMAN-EVENT-MIB::sysUpTimeInstance 0:0:1:12.7
SNMPv2-MIB::snmpTrapOID.0 SNMPv2-MIB::coldStart
TRAP,
log: 'SNMP Trap: Device {{ hostname }} cold booted', // The log message sent
failureMessage: 'Failed to handle SNMPv2-MIB::coldStart', // an informative message to let user know what failed
args: [4, 'reboot'], // the additional arguments to the log method
);
}
}
```