Support for APC PDU Outlet traps (#10162)

* Support for APC PDU Outlet traps * Add tests * Remove unused $ipv4 from tests
2024-10-07 16:52:45 +00:00 · 2019-04-30 04:40:09 +02:00
parent 5c6a9ab623
commit ca18cf4176
5 changed files with 231 additions and 0 deletions
--- a/LibreNMS/Snmptrap/Handlers/ApcPduOutletOff.php
+++ b/LibreNMS/Snmptrap/Handlers/ApcPduOutletOff.php
@@ -0,0 +1,46 @@
+<?php
+/**
+ * ApcPduOutletOff.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 <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ */
+
+namespace LibreNMS\Snmptrap\Handlers;
+
+use App\Models\Device;
+use LibreNMS\Interfaces\SnmptrapHandler;
+use LibreNMS\Snmptrap\Trap;
+use Log;
+
+class ApcPduOutletOff implements SnmptrapHandler
+{
+    /**
+     * Handle snmptrap.
+     * Data is pre-parsed and delivered as a Trap.
+     *
+     * @param Device $device
+     * @param Trap $trap
+     * @return void
+     */
+    public function handle(Device $device, Trap $trap)
+    {
+        $outlet = $trap->getOidData($trap->findOid('PowerNet-MIB::mtrapargsInteger.0'));
+        Log::event("APC PDU: Outlet has turned off: $outlet", $device->device_id, 'trap', 4);
+    }
+}
--- a/LibreNMS/Snmptrap/Handlers/ApcPduOutletOn.php
+++ b/LibreNMS/Snmptrap/Handlers/ApcPduOutletOn.php
@@ -0,0 +1,46 @@
+<?php
+/**
+ * ApcPduOutletOn.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 <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ */
+
+namespace LibreNMS\Snmptrap\Handlers;
+
+use App\Models\Device;
+use LibreNMS\Interfaces\SnmptrapHandler;
+use LibreNMS\Snmptrap\Trap;
+use Log;
+
+class ApcPduOutletOn implements SnmptrapHandler
+{
+    /**
+     * Handle snmptrap.
+     * Data is pre-parsed and delivered as a Trap.
+     *
+     * @param Device $device
+     * @param Trap $trap
+     * @return void
+     */
+    public function handle(Device $device, Trap $trap)
+    {
+        $outlet = $trap->getOidData($trap->findOid('PowerNet-MIB::mtrapargsInteger.0'));
+        Log::event("APC PDU: Outlet has been turned on: $outlet", $device->device_id, 'trap', 4);
+    }
+}
--- a/LibreNMS/Snmptrap/Handlers/ApcPduOutletReboot.php
+++ b/LibreNMS/Snmptrap/Handlers/ApcPduOutletReboot.php
@@ -0,0 +1,46 @@
+<?php
+/**
+ * ApcPduOutletReboot.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 <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ */
+
+namespace LibreNMS\Snmptrap\Handlers;
+
+use App\Models\Device;
+use LibreNMS\Interfaces\SnmptrapHandler;
+use LibreNMS\Snmptrap\Trap;
+use Log;
+
+class ApcPduOutletReboot implements SnmptrapHandler
+{
+    /**
+     * Handle snmptrap.
+     * Data is pre-parsed and delivered as a Trap.
+     *
+     * @param Device $device
+     * @param Trap $trap
+     * @return void
+     */
+    public function handle(Device $device, Trap $trap)
+    {
+        $outlet = $trap->getOidData($trap->findOid('PowerNet-MIB::mtrapargsInteger.0'));
+        Log::event("APC PDU: Outlet has rebooted: $outlet", $device->device_id, 'trap', 4);
+    }
+}
--- a/config/snmptraps.php
+++ b/config/snmptraps.php
@@ -38,5 +38,8 @@ return [
        'FORTINET-CORE-MIB::fnTrapMemThreshold' => \LibreNMS\Snmptrap\Handlers\FnTrapMemThreshold::class,
        'FORTINET-FORTIMANAGER-FORTIANALYZER-MIB::fmTrapLogRateThreshold' => \LibreNMS\Snmptrap\Handlers\FmTrapLogRateThreshold::class,
        'FORTINET-FORTIMANAGER-FORTIANALYZER-MIB::fmTrapLogAlert' => \LibreNMS\Snmptrap\Handlers\FmTrapLogAlert::class,
+        'PowerNet-MIB::outletOn' => \LibreNMS\Snmptrap\Handlers\ApcPduOutletOn::class,
+        'PowerNet-MIB::outletOff' => \LibreNMS\Snmptrap\Handlers\ApcPduOutletOff::class,
+        'PowerNet-MIB::outletReboot' => \LibreNMS\Snmptrap\Handlers\ApcPduOutletReboot::class,
    ]
 ];
--- a/tests/Feature/SnmpTraps/ApcPduOutletTest.php
+++ b/tests/Feature/SnmpTraps/ApcPduOutletTest.php
@@ -0,0 +1,90 @@
+<?php
+/**
+ * ApcPduOutletTest.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 <http://www.gnu.org/licenses/>.
+ *
+ * @package    LibreNMS
+ * @link       http://librenms.org
+ */
+
+namespace LibreNMS\Tests\Feature\SnmpTraps;
+
+use App\Models\Device;
+use App\Models\Ipv4Address;
+use LibreNMS\Snmptrap\Dispatcher;
+use LibreNMS\Snmptrap\Trap;
+use LibreNMS\Tests\LaravelTestCase;
+
+class ApcPduOutletTest extends LaravelTestCase
+{
+    public function testOutletOff()
+    {
+        $device = factory(Device::class)->create();
+
+        $trapText = "$device->hostname
+UDP: [$device->ip]:161->[192.168.5.5]:162
+DISMAN-EVENT-MIB::sysUpTimeInstance 84:21:45:07.07
+SNMPv2-MIB::snmpTrapOID.0 PowerNet-MIB::outletOff
+PowerNet-MIB::mtrapargsInteger.0 2
+PowerNet-MIB::mtrapargsString.0 \"An outlet has turned on. If the outlet number is 0, then all outlets have turned on.\"
+SNMPv2-MIB::snmpTrapEnterprise.0 PowerNet-MIB::apc";
+
+        $message = "APC PDU: Outlet has turned off: 2";
+        \Log::shouldReceive('event')->once()->with($message, $device->device_id, 'trap', 4);
+
+        $trap = new Trap($trapText);
+        $this->assertTrue(Dispatcher::handle($trap), 'Could not handle outletOff trap');
+    }
+
+    public function testOutletOn()
+    {
+        $device = factory(Device::class)->create();
+
+        $trapText = "$device->hostname
+UDP: [$device->ip]:161->[192.168.5.5]:162
+DISMAN-EVENT-MIB::sysUpTimeInstance 84:21:45:07.07
+SNMPv2-MIB::snmpTrapOID.0 PowerNet-MIB::outletOn
+PowerNet-MIB::mtrapargsInteger.0 2
+PowerNet-MIB::mtrapargsString.0 \"An outlet has turned on. If the outlet number is 0, then all outlets have turned on.\"
+SNMPv2-MIB::snmpTrapEnterprise.0 PowerNet-MIB::apc";
+
+        $message = "APC PDU: Outlet has been turned on: 2";
+        \Log::shouldReceive('event')->once()->with($message, $device->device_id, 'trap', 4);
+
+        $trap = new Trap($trapText);
+        $this->assertTrue(Dispatcher::handle($trap), 'Could not handle outletOn trap');
+    }
+
+    public function testOutletReboot()
+    {
+        $device = factory(Device::class)->create();
+
+        $trapText = "$device->hostname
+UDP: [$device->ip]:161->[192.168.5.5]:162
+DISMAN-EVENT-MIB::sysUpTimeInstance 84:21:45:07.07
+SNMPv2-MIB::snmpTrapOID.0 PowerNet-MIB::outletReboot
+PowerNet-MIB::mtrapargsInteger.0 2
+PowerNet-MIB::mtrapargsString.0 \"An outlet has rebooted. If the outlet number is 0, then all outlets have rebooted.\"
+SNMPv2-MIB::snmpTrapEnterprise.0 PowerNet-MIB::apc";
+
+        $message = "APC PDU: Outlet has rebooted: 2";
+        \Log::shouldReceive('event')->once()->with($message, $device->device_id, 'trap', 4);
+
+        $trap = new Trap($trapText);
+        $this->assertTrue(Dispatcher::handle($trap), 'Could not handle outletReboot trap');
+    }
+}