librenms / librenms

tests/Feature/SnmpTraps/MgmtTrapNmsEventTest.php

<?php
/**
 * MgmtTrapNmsEventTest.php
 *
 * -Description-
 *
 * Tests NMS Event Traps sent by Ekinops Optical Networking products.
 *
 * 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/>.
 *
 *
 * Tests JnxVpnPwDown and JnxVpnPwUp traps from Juniper devices.
 *
 * @link       https://www.librenms.org
 *
 * @copyright  2020 KanREN, Inc
 * @author     Heath Barnhart <hbarnhart@kanren.net>
 */

namespace LibreNMS\Tests\Feature\SnmpTraps;

use App\Models\Device;
use LibreNMS\Snmptrap\Dispatcher;
use LibreNMS\Snmptrap\Trap;

class MgmtTrapNmsEventTest extends SnmpTrapTestCase
{
    public function testEvent()
    {
        $device = Device::factory()->create(); /** @var Device $device */
        $alarm = self::genEkiEvent();
        $slotNum = $alarm['slotNum'];
        $srcPm = $alarm['srcPm'];
        $reason = $alarm['reason'];

        $trapText = "$device->hostname
UDP: [$device->ip]:60057->[10.0.0.1]:162
DISMAN-EVENT-MIB::sysUpTimeInstance 159:19:33:14.42
SNMPv2-MIB::snmpTrapOID.0 EKINOPS-MGNT2-NMS-MIB::mgnt2TrapNMSEvent
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogNotificationId 132
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogObjectClassIdentifier chassis
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogSourcePm $srcPm
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogBoardNumber $slotNum
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogSourcePortType None
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogSourcePortNumber 0
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogEventType activityLog
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogSourceType event
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogReason $reason
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogAdditionalText 
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogTime 2020-8-10,14:22:5
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogNodeControllerIpAddress 0.0.0.0
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogChassisId $device->ip";

        $trap = new Trap($trapText);

        $msg = "Event on slot $slotNum, $srcPm Reason: $reason";

        \Log::shouldReceive('event')->once()->with($msg, $device->device_id, 'trap', 2);

        $this->assertTrue(Dispatcher::handle($trap), 'Could not handle mgnt2TrapNMSEvent trap');
    }

    //Test alarm with addtional text supplied.
    public function testEventAddText()
    {
        $device = Device::factory()->create(); /** @var Device $device */
        $alarm = self::genEkiEvent();
        $slotNum = $alarm['slotNum'];
        $srcPm = $alarm['srcPm'];
        $reason = $alarm['reason'];
        $add = $alarm['addText'];

        $trapText = "$device->hostname
UDP: [$device->ip]:60057->[10.0.0.1]:162
DISMAN-EVENT-MIB::sysUpTimeInstance 159:19:33:14.42
SNMPv2-MIB::snmpTrapOID.0 EKINOPS-MGNT2-NMS-MIB::mgnt2TrapNMSEvent
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogNotificationId 132
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogObjectClassIdentifier chassis
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogSourcePm $srcPm
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogBoardNumber $slotNum
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogSourcePortType None
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogSourcePortNumber 0
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogEventType activityLog
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogSourceType event
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogReason $reason
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogAdditionalText $add
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogTime 2020-8-10,14:22:5
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogNodeControllerIpAddress 0.0.0.0
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogChassisId $device->ip";

        $trap = new Trap($trapText);

        $msg = "Event on slot $slotNum, $srcPm Reason: $reason Additional info: $add";

        \Log::shouldReceive('event')->once()->with($msg, $device->device_id, 'trap', 2);

        $this->assertTrue(Dispatcher::handle($trap), 'Could not handle mgnt2TrapNMSEvent trap with additional text');
    }

    //Event trap on a specific port
    public function testEventPort()
    {
        $device = Device::factory()->create(); /** @var Device $device */
        $alarm = self::genEkiEvent();
        $slotNum = $alarm['slotNum'];
        $srcPm = $alarm['srcPm'];
        $reason = $alarm['reason'];
        $add = $alarm['addText'];

The assignment to $add is dead and can be removed.

        $portType = $alarm['portType'];
        $portNum = $alarm['portNum'];

        $trapText = "$device->hostname
UDP: [$device->ip]:60057->[10.0.0.1]:162
DISMAN-EVENT-MIB::sysUpTimeInstance 159:19:33:14.42
SNMPv2-MIB::snmpTrapOID.0 EKINOPS-MGNT2-NMS-MIB::mgnt2TrapNMSEvent
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogNotificationId 132
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogObjectClassIdentifier port
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogSourcePm $srcPm
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogBoardNumber $slotNum
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogSourcePortType $portType
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogSourcePortNumber $portNum
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogEventType activityLog
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogSourceType event
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogReason $reason
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogAdditionalText 
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogTime 2020-8-10,14:22:5
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogNodeControllerIpAddress 0.0.0.0
EKINOPS-MGNT2-NMS-MIB::mgnt2EventLogChassisId $device->ip";

        $trap = new Trap($trapText);

        $msg = "Event on slot $slotNum, $srcPm Port: $portType $portNum. Reason: $reason";

        \Log::shouldReceive('event')->once()->with($msg, $device->device_id, 'trap', 2);

        $this->assertTrue(Dispatcher::handle($trap), 'Could not handle mgnt2TrapNMSEvent trap with a specficied port');
    }

    public static function genEkiEvent()
    {
        $alarm['slotNum'] = rand(1, 32);

$alarm was never initialized. Although not strictly required by PHP, it is generally a good practice to add $alarm = array(); before regardless.

        $alarm['srcPm'] = str_shuffle('0123456789abcdefg');
        $alarm['reason'] = str_shuffle('0123456789abcdefg');
        $alarm['portType'] = str_shuffle('0123456789abcdefg');
        $alarm['portNum'] = rand(1, 32);
        $alarm['addText'] = str_shuffle('0123456789abcdefg');

        return $alarm;
    }
}