Merge pull request #77 from blackdotraven/feat_new_confighelper

feat: new confighelper with env support

Author: blackdotraven

README.md

@@ -16,6 +16,28 @@ We decided to opensource it as an easy-to-setup software after some requests.
     - dect-wip-ommsync checks for newly paired handsets and creates temporary voip accounts for calling the self-registration code.
     - dect-wip-mitel-phonebook provides an endpoint for mitel dect handsets to lookup phonebook entries 
 
+## Configuration and Environment Variables
+The main config `dect-wip.ini` is in `/etc/dect-wip.ini` by default.
+
+Config location can be overridden with env-variable `CONFIG_PATH`(WSGI/Dev-Mode) or commandline argument `--config-file` (DEV-Mode).
+
+All settings in `dect-wip.ini` can be overridden via env-variable (in all caps) in the following order:
+- `FROM_FILE_{SECTION}_{KEY}`
+- `{SECTION}_{KEY}`
+- Config-File
+
+For example:
+- `FROM_FILE_EVENT_TOKEN_PREFIX`
+- `EVENT_TOKEN_PREFIX`
+```
+[event]
+token_prefix = 01990
+```
+
+The prefix `FROM_FILE_` will read the contents of that file and uses it as variable value.
+
+Values specified via env-variables can be omitted in `dect-wip.ini`. A config-file need to be present, but it can be empty.
+
 ## how to contribute
 - This is a fun-project! We don't get paid for this and we might have higher response times
 - Fetch a unassigned issue, ask if you don't know anything or are unsure

services/dect-wip-mitel-phonebook/_setup_venv.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+if [ ! -d "venv/" ]; then
+  python3 -mvenv venv
+  source venv/bin/activate
+  pip3 install --upgrade pip
+  pip3 install -r requirements.txt
+fi

services/dect-wip-mitel-phonebook/_start_app.sh

@@ -1,13 +1,8 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 echo "working in $(pwd)"
 
-if [ ! -d "venv/" ]; then
-  python3 -mvenv venv
-  source venv/bin/activate
-  pip3 install --upgrade pip
-  pip3 install -r requirements.txt
-fi
+./_setup_venv.sh
 
 source venv/bin/activate
-python3 phonebook.py
+gunicorn phonebook:init_wsgi\(\)

services/dect-wip-mitel-phonebook/_start_devapp.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+echo "working in $(pwd)"
+
+./_setup_venv.sh
+
+source venv/bin/activate
+python3 phonebook.py

services/dect-wip-mitel-phonebook/gunicorn.conf.py

@@ -0,0 +1,10 @@
+from tools.confighelper import DectWIPConfig
+from os import environ
+
+_config = DectWIPConfig(config_path=environ.get('CONFIG_PATH', '/etc/dect-wip.ini'))
+
+# starting gunicorn config here
+
+bind = f'{_config.mitelphonebook_listen_ip}:{_config.mitelphonebook_port}'
+accesslog = _config.gunicorn_accesslogfile
+errorlog = _config.gunicorn_errorlogfile

services/dect-wip-mitel-phonebook/phonebook.py

@@ -1,13 +1,10 @@
+import os
 from flask import Flask, request, render_template_string
 import requests
-import os
-import configparser
 import click
+from tools.confighelper import DectWIPConfig
 
-dect_wip_ip = os.getenv('DECT_WIP_URL', '127.0.0.1:8080')
-port = int(os.getenv('DECT_WIP_PHONEBOOK_PORT', '8082'))
 app = Flask(__name__)
-config = configparser.ConfigParser()
 
 xsi_template = """<?xml version="1.0" encoding="UTF-8"?>
 <Personal xmlns="http://schema.broadsoft.com/xsi">
@@ -27,7 +24,7 @@ def return_phonebook(caller):
     search_index = int(search_index)-1 # let search_index start at 0 not 1
     search_results_count = int(request.args.get('results'))
 
-    if always_search_with_contains:
+    if config.mitelphonebook_always_search_with_contains:
         if not search_string.startswith('*'):
             print(f'config.ini phonebook always_search_with_contains is true --> converting {search_string} to *{search_string}')
             search_string = f'*{search_string}'
@@ -38,9 +35,9 @@ def return_phonebook(caller):
     search_string = search_string.replace('*','%')
 
     if search_string == '':
-        names_and_extensions = requests.get(f"http://{dect_wip_ip}/api/v1/phonebook").json()
+        names_and_extensions = requests.get(f"http://{config.dect_wip_internal_ip}:{config.dect_wip_port}/api/v1/phonebook").json()
     else:
-        names_and_extensions = requests.get(f"http://{dect_wip_ip}/api/v1/phonebook?search={search_string}").json() 
+        names_and_extensions = requests.get(f"http://{config.dect_wip_internal_ip}:{config.dect_wip_port}/api/v1/phonebook?search={search_string}").json()
 
     print(f"{caller} searched for {search_string}, index={search_index}, results_count={search_results_count}")
 
@@ -55,21 +52,18 @@ def init(config_path):
 
     # setup global config
 
-    global always_search_with_contains
+    global config
 
-    config.read(config_path)
-    always_search_with_contains = config.getboolean('phonebook', 'always_search_with_contains')
+    config = DectWIPConfig(config_path=config_path)
 
 @click.command()
-@click.option('--config', 'config_path', envvar='CONFIG', default='/etc/dect-wip.ini', help='optional config location')
+@click.option('--config', 'config_path', envvar='CONFIG_PATH', default='/etc/dect-wip.ini', help='optional config location')
 def init_dev(config_path):
-    # TODO: refactor config.ini and ENV
     init(config_path)
-    app.run(host='0.0.0.0', port=port, debug=False, use_reloader=True)
+    app.run(host=config.mitelphonebook_listen_ip, port=config.mitelphonebook_port, debug=False, use_reloader=True)
 
 def init_wsgi():
-    config_path = os.getenv('CONFIG', '/etc/dect-wip.ini')
-    init(config_path)
+    init(os.environ.get('CONFIG_PATH', '/etc/dect-wip.ini'))
     return app
 
 if __name__ == '__main__':

services/dect-wip-mitel-phonebook/requirements.txt

@@ -1,2 +1,3 @@
 flask
 requests
+gunicorn

services/dect-wip-mitel-phonebook/tools

@@ -0,0 +1 @@
+../../tools

services/dect-wip-ommsync/_setup_venv.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+if [ ! -d "venv/" ]; then
+  python3 -mvenv venv
+  source venv/bin/activate
+  pip3 install --upgrade pip
+  pip3 install -r requirements.txt
+fi

services/dect-wip-ommsync/_start_app.sh

@@ -1,13 +1,8 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 echo "working in $(pwd)"
 
-if [ ! -d "venv/" ]; then
-  python3 -mvenv venv
-  source venv/bin/activate
-  pip3 install --upgrade pip
-  pip3 install -r requirements.txt
-fi
+./_setup_venv.sh
 
 source venv/bin/activate
-python3 dect-wip-ommsync.py
+gunicorn dect-wip-ommsync:init_wsgi\(\)