linspector/uplink
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Seperated environment vars from configuration to exclusive object and added a seperate URL (/environment) for requesting data from the HTTP server.

Browse source
This commit is contained in:
Johannes Findeisen 2022-09-10 01:09:38 +02:00
commit c319417ee3
7 changed files with 136 additions and 75 deletions
Download patch file Download diff file Expand all files Collapse all files

21
bin/uplink
View file

@ -36,6 +36,7 @@ import sys
import time import time
from uplink.configuration import Configuration from uplink.configuration import Configuration
from uplink.environment import Environment
from uplink.uplink import Uplink from uplink.uplink import Uplink
""" """
@ -48,7 +49,7 @@ MINOR changes are "just-in-time" changes or small enhancements which should not
documentation. documentation.
FIXES should never affect anything else then stability or security. FIXES should never affect anything else then stability or security.
""" """
__version__ = '0.8.4.2' __version__ = '0.9.0.0'
__author__ = 'Johannes Findeisen <you@hanez.org>' __author__ = 'Johannes Findeisen <you@hanez.org>'
logger = logging.getLogger('uplink') logger = logging.getLogger('uplink')
@ -108,15 +109,17 @@ def main():
logger.error(str('[uplink] configuration error: {0}'.format(err))) logger.error(str('[uplink] configuration error: {0}'.format(err)))
sys.exit(1) sys.exit(1)
environment = Environment()
# To be more cross-platform compatible maybe changes are needed: # To be more cross-platform compatible maybe changes are needed:
# https://stackoverflow.com/questions/4271740/how-can-i-use-python-to-get-the-system-hostname # https://stackoverflow.com/questions/4271740/how-can-i-use-python-to-get-the-system-hostname
configuration.set_env_var('_hostname', socket.gethostname()) environment.set_env_var('_hostname', socket.gethostname())
configuration.set_env_var('__version__', __version__) environment.set_env_var('__version__', __version__)
configuration.set_env_var('_internal_start_date', time.strftime('%Y-%m-%d %H:%M:%S', environment.set_env_var('_internal_start_date', time.strftime('%Y-%m-%d %H:%M:%S',
time.localtime(calendar.timegm(time.gmtime())))) time.localtime(calendar.timegm(time.gmtime()))))
configuration.set_env_var('_internal_start_timestamp', calendar.timegm(time.gmtime())) environment.set_env_var('_internal_start_timestamp', calendar.timegm(time.gmtime()))
# interval set in args is overriding configuration and default # interval set in args is overriding configuration and default
if args.interval: if args.interval:
@ -157,7 +160,7 @@ def main():
configuration.set_httpserver(True) configuration.set_httpserver(True)
try: try:
u = Uplink(configuration) u = Uplink(configuration, environment)
except Exception as err: except Exception as err:
logger.error(str('[uplink] core error! {0}'.format(err))) logger.error(str('[uplink] core error! {0}'.format(err)))
sys.exit(1) sys.exit(1)
@ -178,13 +181,13 @@ def main():
from threading import Thread from threading import Thread
if configuration.get_httpserver(): if configuration.get_httpserver():
from uplink.httpserver import HTTPServer from uplink.httpserver import HTTPServer
s = HTTPServer(configuration) s = HTTPServer(configuration, environment)
st = Thread(target=s.run_server, daemon=True) st = Thread(target=s.run_server, daemon=True)
st.start() st.start()
if configuration.get_speedtest(): if configuration.get_speedtest():
from uplink.speedtest import Speedtest from uplink.speedtest import Speedtest
se = Speedtest(configuration) se = Speedtest(configuration, environment)
ste = Thread(target=se.run_speedtest, daemon=True) ste = Thread(target=se.run_speedtest, daemon=True)
ste.start() ste.start()

16
uplink/configuration.py
View file

@ -31,15 +31,11 @@ class Configuration:
def __init__(self, configuration): def __init__(self, configuration):
self.__configuration = configuration self.__configuration = configuration
self.__base_configuration = None
self.__database_host = None self.__database_host = None
self.__database_name = None self.__database_name = None
self.__database_password = None self.__database_password = None
self.__database_port = 3306 self.__database_port = 3306
self.__database_user = None self.__database_user = None
# environment vars which can be set dynamically at runtime. these vars are shared across all
# objects and readable and writable by all of them.
self.__env = {}
self.__httpserver = False self.__httpserver = False
self.__httpserver_host = '127.0.0.1' self.__httpserver_host = '127.0.0.1'
self.__httpserver_port = 1042 self.__httpserver_port = 1042
@ -182,15 +178,6 @@ class Configuration:
def get_database_user(self): def get_database_user(self):
return self.__database_user return self.__database_user
def get_env(self):
return self.__env
def get_env_var(self, key):
if key in self.__env:
return self.__env[key]
else:
return False
def get_httpserver(self): def get_httpserver(self):
return self.__httpserver return self.__httpserver
@ -249,9 +236,6 @@ class Configuration:
return self.__uplinks return self.__uplinks
# set methods # set methods
def set_env_var(self, key, value):
self.__env[key] = value
def set_httpserver(self, value): def set_httpserver(self, value):
self.__httpserver = value self.__httpserver = value

55
uplink/environment.py Normal file
View file

@ -0,0 +1,55 @@
# Copyright (c) 2022 Johannes Findeisen <you@hanez.org>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is furnished
# to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice (including the next
# paragraph) shall be included in all copies or substantial portions of the
# Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
# OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
# OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
import re
import socket
from logging import getLogger
logger = getLogger('uplink')
"""
This is experimental because you can set what you want but if a env key you set already exists it
will be overwritten. But it is an easy and maybe secure way to to set runtime variables which should
not affect the execution of uplink but may be required variables to execute to your wanted
configuration. Core functionality must not be affected when using this class!
"""
class Environment:
def __init__(self):
# environment vars which can be set dynamically at runtime. these vars are shared across all
# objects and readable and writable by all of them.
self.__env = {}
def get_env_var(self, key):
if key in self.__env:
return self.__env[key]
else:
logger.info('environment var "' + key + '" not found! could be that is set late at '
'runtime. if you encounter errors executing '
'uplink, something is wrong in the code. '
'please consider to report this as a bug! btw. '
'INFO is not an ERROR!')
return False
def set_env_var(self, key, value):
self.__env[key] = value

24
uplink/httpserver.py
View file

@ -31,8 +31,9 @@ logger = getLogger('uplink')
class HTTPServer: class HTTPServer:
def __init__(self, configuration): def __init__(self, configuration, environment):
self.__configuration = configuration self.__configuration = configuration
self.__environment = environment
@cherrypy.expose @cherrypy.expose
def index(self): def index(self):
@ -41,13 +42,25 @@ class HTTPServer:
@cherrypy.expose @cherrypy.expose
def configuration(self): def configuration(self):
return '<!DOCTYPE html><html><head><title>[uplink-' + \ return '<!DOCTYPE html><html><head><title>[uplink-' + \
self.__configuration.get_env_var("__version__") + '@' + \ self.__environment.get_env_var("__version__") + '@' + \
self.__configuration.get_env_var("_hostname") + '] configuration</title><meta ' + \ self.__environment.get_env_var("_hostname") + '] configuration</title><meta ' + \
'http-equiv="refresh" content="60"></head><body><pre ' + \ 'http-equiv="refresh" content="60"></head><body><pre ' + \
'style="border:2px solid black;background:#1d2021;color:#f0751a;">' + \ 'style="border:2px solid black;background:#1d2021;color:#f0751a;">' + \
json.dumps(vars(self.__configuration), sort_keys=True, indent=4) + \ json.dumps(vars(self.__configuration), sort_keys=True, indent=4) + \
'</pre></body></html>' '</pre></body></html>'
@cherrypy.expose
def environment(self):
return '<!DOCTYPE html><html><head><title>[uplink-' + \
self.__environment.get_env_var("__version__") + '@' + \
self.__environment.get_env_var("_hostname") + '] environment</title><meta ' + \
'http-equiv="refresh" content="60"></head><body><pre ' + \
'style="border:2px solid black;background:#1d2021;color:#f0751a;">' + \
json.dumps(vars(self.__environment), sort_keys=True, indent=4) + \
'</pre></body></html>'
@cherrypy.expose @cherrypy.expose
def playground(self): def playground(self):
return 'My Playground!' return 'My Playground!'
@ -65,6 +78,11 @@ class HTTPServer:
'tools.response_headers.on': True, 'tools.response_headers.on': True,
'tools.response_headers.headers': [('Content-Type', 'text/html')], 'tools.response_headers.headers': [('Content-Type', 'text/html')],
}, },
'/environment': {
# 'request.dispatch': cherrypy.dispatch.MethodDispatcher(),
'tools.response_headers.on': True,
'tools.response_headers.headers': [('Content-Type', 'text/html')],
},
'/playground': { '/playground': {
# 'tools.staticdir.on': True, # 'tools.staticdir.on': True,
# 'tools.staticdir.dir': './public' # 'tools.staticdir.dir': './public'

2
uplink/notification.py
View file

@ -27,7 +27,7 @@ logger = getLogger('uplink')
class Notification: class Notification:
def __init__(self, configuration): def __init__(self, configuration, environment):
self.__configuration = configuration self.__configuration = configuration
#self.__state_machine = gammu.StateMachine() #self.__state_machine = gammu.StateMachine()
#self.__state_machine.ReadConfig( #self.__state_machine.ReadConfig(

13
uplink/speedtest.py
View file

@ -29,8 +29,9 @@ logger = getLogger('uplink')
class Speedtest: class Speedtest:
def __init__(self, configuration): def __init__(self, configuration, environment):
self.__configuration = configuration self.__configuration = configuration
self.__environment = environment
self.__speedtest_maximum_speed = None self.__speedtest_maximum_speed = None
self.__speedtest_average_speed = None self.__speedtest_average_speed = None
@ -39,11 +40,11 @@ class Speedtest:
def run_speedtest(self): def run_speedtest(self):
while True: while True:
tmp_time = time.localtime(calendar.timegm(time.gmtime())) tmp_time = time.localtime(calendar.timegm(time.gmtime()))
self.__configuration.set_env_var('_speedtest_last_run_date', self.__environment.set_env_var('_speedtest_last_run_date',
time.strftime('%Y-%m-%d %H:%M:%S', time.strftime('%Y-%m-%d %H:%M:%S',
tmp_time)) tmp_time))
self.__configuration.set_env_var('_speedtest_last_run_timestamp', self.__environment.set_env_var('_speedtest_last_run_timestamp',
calendar.timegm(time.gmtime())) calendar.timegm(time.gmtime()))
start = time.perf_counter() start = time.perf_counter()
@ -65,15 +66,15 @@ class Speedtest:
total_mbps += mbps total_mbps += mbps
self.__speedtest_average_speed = total_mbps / total_chunks self.__speedtest_average_speed = total_mbps / total_chunks
self.__configuration.set_env_var('_speedtest_average_speed_megabyte_per_second', self.__environment.set_env_var('_speedtest_average_speed_megabyte_per_second',
str(round(self.__speedtest_average_speed))) str(round(self.__speedtest_average_speed)))
self.__speedtest_maximum_speed = maximum_speed self.__speedtest_maximum_speed = maximum_speed
self.__configuration.set_env_var('_speedtest_maximum_speed_megabyte_per_second', self.__environment.set_env_var('_speedtest_maximum_speed_megabyte_per_second',
str(round(self.__speedtest_maximum_speed))) str(round(self.__speedtest_maximum_speed)))
self.__speedtest_time_elapsed = time.perf_counter() - start self.__speedtest_time_elapsed = time.perf_counter() - start
self.__configuration.set_env_var('_speedtest_time_elapsed', self.__environment.set_env_var('_speedtest_time_elapsed',
str(self.__speedtest_time_elapsed)) str(self.__speedtest_time_elapsed))
logger.info('speedtest average: ' + str(self.__speedtest_average_speed) + logger.info('speedtest average: ' + str(self.__speedtest_average_speed) +
', max: ' + str(self.__speedtest_maximum_speed) + ', max: ' + str(self.__speedtest_maximum_speed) +

80
uplink/uplink.py
View file

@ -23,7 +23,6 @@
# be optional too. Also reinvent SQLite as database backend. # be optional too. Also reinvent SQLite as database backend.
import calendar import calendar
import logging
import socket import socket
import time import time
@ -39,9 +38,10 @@ logger = getLogger('uplink')
class Uplink(Daemon): class Uplink(Daemon):
def __init__(self, configuration): def __init__(self, configuration, environment):
super().__init__(configuration.get_pid_file()) super().__init__(configuration.get_pid_file())
self.__configuration = configuration self.__configuration = configuration
self.__environment = environment
def fetch_data(self, i): def fetch_data(self, i):
timestamp = calendar.timegm(time.gmtime()) timestamp = calendar.timegm(time.gmtime())
@ -49,68 +49,68 @@ class Uplink(Daemon):
date_formatted = time.strftime('%Y-%m-%d', local_time) date_formatted = time.strftime('%Y-%m-%d', local_time)
time_formatted = time.strftime('%H:%M:%S', local_time) time_formatted = time.strftime('%H:%M:%S', local_time)
self.__configuration.set_env_var('_internal_last_run_date', date_formatted + ' ' + self.__environment.set_env_var('_internal_last_run_date', date_formatted + ' ' +
time_formatted) time_formatted)
self.__configuration.set_env_var('_internal_last_run_timestamp', timestamp) self.__environment.set_env_var('_internal_last_run_timestamp', timestamp)
uplink = self.__configuration.get_uplink(i) uplink = self.__configuration.get_uplink(i)
if 'primary' in uplink: if 'primary' in uplink:
self.__configuration.set_env_var('_uplink_' + uplink['identifier'] + '_primary', self.__environment.set_env_var('_uplink_' + uplink['identifier'] + '_primary',
uplink['primary']) uplink['primary'])
if self.__configuration.get_env_var('_uplink_' + uplink['identifier'] + if self.__environment.get_env_var('_uplink_' + uplink['identifier'] +
'_fail_count') is False: '_fail_count') is False:
self.__configuration.set_env_var('_uplink_' + uplink['identifier'] + self.__environment.set_env_var('_uplink_' + uplink['identifier'] +
'_fail_count', 0) '_fail_count', 0)
if self.__configuration.get_env_var('_uplink_' + uplink['identifier'] + if self.__environment.get_env_var('_uplink_' + uplink['identifier'] +
'_fail_overall_count') is False: '_fail_overall_count') is False:
self.__configuration.set_env_var('_uplink_' + uplink['identifier'] + self.__environment.set_env_var('_uplink_' + uplink['identifier'] +
'_fail_overall_count', 0) '_fail_overall_count', 0)
try: try:
fritz_connection = FritzStatus(address=uplink['ip'], fritz_connection = FritzStatus(address=uplink['ip'],
password=uplink['password']) password=uplink['password'])
if fritz_connection.is_connected: if fritz_connection.is_connected:
self.__configuration.set_env_var('_uplink_' + uplink['identifier'] + self.__environment.set_env_var('_uplink_' + uplink['identifier'] +
'_fail_count', 0) '_fail_count', 0)
self.__configuration.set_env_var('_uplink_' + uplink['identifier'] + self.__environment.set_env_var('_uplink_' + uplink['identifier'] +
'_last_success_date', date_formatted + ' ' + '_last_success_date', date_formatted + ' ' +
time_formatted) time_formatted)
self.__configuration.set_env_var('_uplink_' + uplink['identifier'] + self.__environment.set_env_var('_uplink_' + uplink['identifier'] +
'_last_success_timestamp', timestamp) '_last_success_timestamp', timestamp)
self.__configuration.set_env_var('_uplink_' + uplink['identifier'] + self.__environment.set_env_var('_uplink_' + uplink['identifier'] +
'_status', 'UP') '_status', 'UP')
status = 'UP' status = 'UP'
else: else:
fail_count = self.__configuration.get_env_var('_uplink_' + uplink['identifier'] + fail_count = self.__configuration.get_env_var('_uplink_' + uplink['identifier'] +
'_fail_count') '_fail_count')
fail_count += 1 fail_count += 1
self.__configuration.set_env_var('_uplink_' + uplink['identifier'] + '_fail_count', self.__environment.set_env_var('_uplink_' + uplink['identifier'] + '_fail_count',
fail_count) fail_count)
fail_overall_count = self.__configuration.get_env_var('_uplink_' + fail_overall_count = self.__environment.get_env_var('_uplink_' +
uplink['identifier'] + uplink['identifier'] +
'_fail_overall_count') '_fail_overall_count')
fail_overall_count += 1 fail_overall_count += 1
self.__configuration.set_env_var('_uplink_' + uplink['identifier'] + self.__environment.set_env_var('_uplink_' + uplink['identifier'] +
'_fail_overall_count', fail_overall_count) '_fail_overall_count', fail_overall_count)
self.__configuration.set_env_var('_uplink_' + uplink['identifier'] + self.__environment.set_env_var('_uplink_' + uplink['identifier'] +
'_last_fail_date', date_formatted + ' ' + '_last_fail_date', date_formatted + ' ' +
time_formatted) time_formatted)
self.__configuration.set_env_var('_uplink_' + uplink['identifier'] + self.__environment.set_env_var('_uplink_' + uplink['identifier'] +
'_last_fail_timestamp', timestamp) '_last_fail_timestamp', timestamp)
self.__configuration.set_env_var('_uplink_' + uplink['identifier'] + self.__environment.set_env_var('_uplink_' + uplink['identifier'] +
'_status', 'DOWN') '_status', 'DOWN')
status = 'DOWN' status = 'DOWN'
@ -161,13 +161,13 @@ class Uplink(Daemon):
def run(self): def run(self):
if self.__configuration.get_http_server(): if self.__configuration.get_http_server():
from uplink.httpserver import HTTPServer from uplink.httpserver import HTTPServer
hs = HTTPServer(self.__configuration) hs = HTTPServer(self.__configuration, self.__environment)
hst = Thread(target=hs.run_server, daemon=True) hst = Thread(target=hs.run_server, daemon=True)
hst.start() hst.start()
if self.__configuration.get_speedtest(): if self.__configuration.get_speedtest():
from uplink.speedtest import Speedtest from uplink.speedtest import Speedtest
st = Speedtest(self.__configuration) st = Speedtest(self.__configuration, self.__environment)
stt = Thread(target=st.run_speedtest, daemon=True) stt = Thread(target=st.run_speedtest, daemon=True)
stt.start() stt.start()