diff --git a/CHANGELOG.md b/CHANGELOG.md index 617ea03..2d41013 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ * Fix processing of `Info` endpoint services. * Update pytest to use environment variables for server credentials. * Address pylint and mypy findings. +* [Development Tool] Docker Compose file for creating test Horizon instance. **Full Changelog**: https://github.com/mmahacek/PyONMS/compare/v0.1.3...v0.1.4 diff --git a/test_container/docker-compose.yml b/test_container/docker-compose.yml new file mode 100644 index 0000000..8809166 --- /dev/null +++ b/test_container/docker-compose.yml @@ -0,0 +1,77 @@ +--- +volumes: + data-postgres: {} + data-opennms: {} + data-config: {} + + +services: + database: + image: postgres:15 + container_name: database + environment: + TZ: 'America/New_York' + POSTGRES_USER: 'postgres' + POSTGRES_PASSWORD: 'my-postgres-password' + volumes: + - 'data-postgres:/var/lib/postgresql/data' + healthcheck: + test: [ "CMD-SHELL", "pg_isready -U postgres" ] + interval: 10s + timeout: 3s + retries: 3 + networks: + monitor_net: + ipv4_address: 172.20.0.5 + + horizon: + image: opennms/horizon:33.0.9 + container_name: horizon + environment: + TZ: 'America/New_York' + POSTGRES_HOST: 'database' + POSTGRES_PORT: 5432 + POSTGRES_USER: 'postgres' + POSTGRES_PASSWORD: 'my-postgres-password' + OPENNMS_DBNAME: 'opennms-core-db' + OPENNMS_DBUSER: 'opennms' + OPENNMS_DBPASS: 'my-opennms-db-password' + volumes: + - data-opennms:/opennms-data + - data-config:/opt/opennms/etc + - ./opennms-etc-overlay:/opt/opennms-etc-overlay + command: ["-s"] + ports: + - '8980:8980/tcp' + healthcheck: + test: [ 'CMD', 'curl', '-f', '-I', 'http://localhost:8980/opennms/login.jsp' ] + interval: 1m + timeout: 5s + retries: 3 + networks: + monitor_net: + ipv4_address: 172.20.0.6 + + node1: + image: polinux/snmpd:alpine + container_name: node1 + volumes: + - ./snmpd.conf:/etc/snmp/snmpd.conf + networks: + monitor_net: + ipv4_address: 172.20.0.10 + + node2: + image: polinux/snmpd:alpine + container_name: node2 + volumes: + - ./snmpd.conf:/etc/snmp/snmpd.conf + networks: + monitor_net: + ipv4_address: 172.20.0.11 + +networks: + monitor_net: + ipam: + config: + - subnet: 172.20.0.0/24 diff --git a/test_container/opennms-etc-overlay/imports/first.xml b/test_container/opennms-etc-overlay/imports/first.xml new file mode 100644 index 0000000..aef6a5a --- /dev/null +++ b/test_container/opennms-etc-overlay/imports/first.xml @@ -0,0 +1,7 @@ + + + + + + + diff --git a/test_container/opennms-etc-overlay/imports/main.xml b/test_container/opennms-etc-overlay/imports/main.xml new file mode 100644 index 0000000..ff6d4c7 --- /dev/null +++ b/test_container/opennms-etc-overlay/imports/main.xml @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/test_container/snmpd.conf b/test_container/snmpd.conf new file mode 100644 index 0000000..6d0dbcc --- /dev/null +++ b/test_container/snmpd.conf @@ -0,0 +1,192 @@ +############################################################################### +# +# EXAMPLE.conf: +# An example configuration file for configuring the Net-SNMP agent ('snmpd') +# See the 'snmpd.conf(5)' man page for details +# +# Some entries are deliberately commented out, and will need to be explicitly activated +# +############################################################################### +# +# AGENT BEHAVIOUR +# + +# Listen for connections from the local system only +agentAddress udp:0.0.0.0:161 +# Listen for connections on all interfaces (both IPv4 *and* IPv6) +#agentAddress udp:161,udp6:[::1]:161 + + + +############################################################################### +# +# SNMPv3 AUTHENTICATION +# +# Note that these particular settings don't actually belong here. +# They should be copied to the file /var/net-snmp/snmpd.conf +# and the passwords changed, before being uncommented in that file *only*. +# Then restart the agent + +# createUser authOnlyUser MD5 "remember to change this password" +# createUser authPrivUser SHA "remember to change this one too" DES +# createUser internalUser MD5 "this is only ever used internally, but still change the password" + +# If you also change the usernames (which might be sensible), +# then remember to update the other occurances in this example config file to match. + + + +############################################################################### +# +# ACCESS CONTROL +# + + # system + hrSystem groups only +view systemonly included .1.3.6.1.2.1.1 +view systemonly included .1.3.6.1.2.1.25.1 +view systemonly included .1 + + # Full access from the local host +#rocommunity public localhost + # Default access to basic system info + rocommunity public default -V systemonly + + # Full access from an example network + # Adjust this network address to match your local + # settings, change the community string, + # and check the 'agentAddress' setting above +#rocommunity secret 10.0.0.0/16 + + # Full read-only access for SNMPv3 + rouser authOnlyUser + # Full write access for encrypted requests + # Remember to activate the 'createUser' lines above +#rwuser authPrivUser priv + +# It's no longer typically necessary to use the full 'com2sec/group/access' configuration +# r[ou]user and r[ow]community, together with suitable views, should cover most requirements + +############################################################################### +# +# SYSTEM INFORMATION +# + +# Note that setting these values here, results in the corresponding MIB objects being 'read-only' +# See snmpd.conf(5) for more details +sysLocation Sitting on the Dock of the Bay +sysContact Me + # Application + End-to-End layers +sysServices 72 + + +# +# Process Monitoring +# + # At least one 'mountd' process +proc mountd + # No more than 4 'ntalkd' processes - 0 is OK +proc ntalkd 4 + # At least one 'sendmail' process, but no more than 10 +proc sendmail 10 1 + +# Walk the UCD-SNMP-MIB::prTable to see the resulting output +# Note that this table will be empty if there are no "proc" entries in the snmpd.conf file + + +# +# Disk Monitoring +# + # 10MBs required on root disk, 5% free on /var, 10% free on all other disks +disk / 10000 +disk /var 5% +includeAllDisks 10% + +# Walk the UCD-SNMP-MIB::dskTable to see the resulting output +# Note that this table will be empty if there are no "disk" entries in the snmpd.conf file + + +# +# System Load +# + # Unacceptable 1-, 5-, and 15-minute load averages +load 12 10 5 + +# Walk the UCD-SNMP-MIB::laTable to see the resulting output +# Note that this table *will* be populated, even without a "load" entry in the snmpd.conf file + + + +############################################################################### +# +# ACTIVE MONITORING +# + + # send SNMPv1 traps + trapsink localhost public + # send SNMPv2c traps +#trap2sink localhost public + # send SNMPv2c INFORMs +#informsink localhost public + +# Note that you typically only want *one* of these three lines +# Uncommenting two (or all three) will result in multiple copies of each notification. + + +# +# Event MIB - automatically generate alerts +# + # Remember to activate the 'createUser' lines above +iquerySecName internalUser +rouser internalUser + # generate traps on UCD error conditions +defaultMonitors yes + # generate traps on linkUp/Down +linkUpDownNotifications yes + + + +############################################################################### +# +# EXTENDING THE AGENT +# + +# +# Arbitrary extension commands +# + extend test1 /bin/echo Hello, world! + extend-sh test2 echo Hello, world! ; echo Hi there ; exit 35 +#extend-sh test3 /bin/sh /tmp/shtest + +# Note that this last entry requires the script '/tmp/shtest' to be created first, +# containing the same three shell commands, before the line is uncommented + +# Walk the NET-SNMP-EXTEND-MIB tables (nsExtendConfigTable, nsExtendOutput1Table +# and nsExtendOutput2Table) to see the resulting output + +# Note that the "extend" directive supercedes the previous "exec" and "sh" directives +# However, walking the UCD-SNMP-MIB::extTable should still returns the same output, +# as well as the fuller results in the above tables. + + +# +# "Pass-through" MIB extension command +# +#pass .1.3.6.1.4.1.8072.2.255 /bin/sh PREFIX/local/passtest +#pass .1.3.6.1.4.1.8072.2.255 /usr/bin/perl PREFIX/local/passtest.pl + +# Note that this requires one of the two 'passtest' scripts to be installed first, +# before the appropriate line is uncommented. +# These scripts can be found in the 'local' directory of the source distribution, +# and are not installed automatically. + +# Walk the NET-SNMP-PASS-MIB::netSnmpPassExamples subtree to see the resulting output + + +# +# AgentX Sub-agents +# + # Run as an AgentX master agent + master agentx + # Listen for network connections (from localhost) + # rather than the default named socket /var/agentx/master +#agentXSocket tcp:localhost:705 diff --git a/tests/conftest.py b/tests/conftest.py index 04f73d1..0fc3d56 100755 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -25,7 +25,7 @@ def vcr_config(): @pytest.fixture def test_instance() -> PyONMS: return PyONMS( - hostname=os.getenv("onms_host", "http://localhost:8980/opennms"), - username=os.getenv("onms_user", "admin"), - password=os.getenv("onms_pass", "admin"), + hostname=os.getenv("test_host", "http://localhost:8980/opennms"), + username=os.getenv("test_user", "admin"), + password=os.getenv("test_pass", "admin"), )