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

Added info on how to perform unit testing

Browse Source
This commit is contained in:
Neil Lathwood
2016-09-15 20:58:49 +01:00
parent 96a57587e9
commit 88b331909b
2 changed files with 45 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/Support/FAQ.md
View File

@@ -185,6 +185,8 @@ This file will usually set the variables for $version and $hardware gained from
**html/images/os/$os.png**
This is a 32x32 png format image of the OS you are adding support for.
You will also need to supply a test unit within `tests/OSDiscoveryTest.php`. Please see [Support-New-OS](Support-New-OS.md) for further information.
#### <a name="faq20"> What information do you need to add a new OS?</a>
Please provide the following output as seperate non-expiring pastebin.com links.

50
doc/Support/Support-New-OS.md
View File

@@ -12,7 +12,7 @@ If we have the MIB, we can copy the file into the default directory:
/opt/librenms/mibs
```
### New OS definition
#### New OS definition
Let's begin to declare the new OS in LibreNMS. At first we modify the definition file located here:
```bash
@@ -35,7 +35,7 @@ $config['os'][$os]['over'][2]['text'] = 'Memory Usage';
//The icon described before is the image we have to create and put in the directory html/images/os
```
### Discovery OS
#### Discovery OS
We create a new file named as our OS definition and in this directory:
@@ -49,7 +49,7 @@ Look at other files to get help in the code structure.
<?php
if (!$os) {
if (strstr($sysDescr, 'Pulse Connect Secure')) {
if (str_contains($sysDescr, 'Pulse Connect Secure')) {
$os = 'pulse';
}
}
@@ -105,9 +105,9 @@ Polling
At this step we should see all the values retrieved in LibreNMS.
#### FULL SUPPORT FOR A NEW OS
### Full support for a new OS
### MIB
#### MIB
At first we copy the MIB file into the default directory:
@@ -128,7 +128,7 @@ snmpget -v2c -c public -OUsb -m PULSESECURE-PSG-MIB -M /opt/librenms/mibs -t 30
iveCpuUtil.0 = Gauge32: 28
```
### New OS definition
#### New OS definition
Let's begin to declare the new OS in LibreNMS. At first we modify the definition file located here:
```bash
@@ -161,7 +161,7 @@ $config['graph_types']['device']['pulse_sessions']['order'] = '0';
$config['graph_types']['device']['pulse_sessions']['descr'] = 'Active Sessions';
```
### Discovery OS
#### Discovery OS
We create a new file named as our OS definition and in this directory:
@@ -416,3 +416,39 @@ Polling
```
At this step we should see all the values retrieved in LibreNMS.
### OS Test units
We have a testing unit for new OS', please ensure you add a test for any new OS' or updates to existing OS discovery.
The OS test unit file is located `tests/OSDiscoveryTest.php`. An example of this is as follows:
```php
public function testZxr10()
{
$this->checkOS('zxr10', 'ZTE Ethernet Switch ZXR10 5250-52TM-H, Version: V2.05.11B23');
}
```
This test looks for the sysDescr of `ZTE Ethernet Switch ZXR10 5250-52TM-H, Version: V2.05.11B23` and if it matches
the `zxr10` OS discovery file then the check will pass.
A slightly more complicated test would be:
```php
public function testAiros()
{
$this->checkOS('airos', 'Linux', '.1.3.6.1.4.1.10002.1');
$this->checkOS('airos', 'Linux', '.1.3.6.1.4.1.41112.1.4');
$mockSnmp = array(
'dot11manufacturerName.5' => 'Ubiquiti',
);
$this->checkOS('airos', 'Linux', '', $mockSnmp);
}
```
The first two `$this->checkOS` calls pass on both a `sysDescr` value (`Linux`) and a `sysObjectID`.
The third call uses another snmp response (although fake) which the specific OS discovery for `airos` relies on.
You can run `scripts/pre-commit.php -u` to run the unit tests to check your code.