erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

bridge: bridge can now be set using environment variable:

Browse source 
The `LIBERVIA_BRIDGE_NAME` environment variable can now be used to specify the bridge to
use. If set and different from empty string, the environment has precedence over config
file value.

For `pb` bridge, the following environment variable can also be used:

- LIBERVIA_BRIDGE_PB_CONNECTION_TYPE
- LIBERVIA_BRIDGE_PB_HOST
- LIBERVIA_BRIDGE_PB_PORT
This commit is contained in:
Goffi 2021-08-28 15:26:02 +02:00
commit 547eb9feba
6 changed files with 47 additions and 61 deletions
Download patch file Download diff file Expand all files Collapse all files

16
sat/bridge/bridge_constructor/constructors/pb/pb_core_template.py
View file

@ -19,6 +19,7 @@
import dataclasses
from functools import partial
from pathlib import Path
from twisted.spread import jelly, pb
from twisted.internet import reactor
@ -106,12 +107,8 @@ class Bridge(object):
log.info("Init Perspective Broker...")
self.root = PBRoot()
conf = config.parseMainConf()
conn_type = config.getConfig(
conf,
"",
"bridge_pb_connection_type",
"unix_socket"
)
getConf = partial(config.getConf, conf, "bridge_pb", "")
conn_type = getConf("connection_type", "unix_socket")
if conn_type == "unix_socket":
local_dir = Path(config.getConfig(conf, "", "local_dir")).resolve()
socket_path = local_dir / "bridge_pb"
@ -120,12 +117,7 @@ class Bridge(object):
str(socket_path), pb.PBServerFactory(self.root), mode=0o600
)
elif conn_type == "socket":
port = int(config.getConfig(
conf,
"",
"bridge_pb_port",
8789
))
port = int(getConf("port", 8789))
log.info(f"using TCP Socket at port {port}")
reactor.listenTCP(port, pb.PBServerFactory(self.root))
else:

22
sat/bridge/bridge_constructor/constructors/pb/pb_frontend_template.py
View file

@ -140,29 +140,15 @@ class Bridge(object):
def bridgeConnect(self, callback, errback):
factory = pb.PBClientFactory()
conf = config.parseMainConf()
conn_type = config.getConfig(
conf,
"",
"bridge_pb_connection_type",
"unix_socket"
)
getConf = partial(config.getConf, conf, "bridge_pb", "")
conn_type = getConf("connection_type", "unix_socket")
if conn_type == "unix_socket":
local_dir = Path(config.getConfig(conf, "", "local_dir")).resolve()
socket_path = local_dir / "bridge_pb"
reactor.connectUNIX(str(socket_path), factory)
elif conn_type == "socket":
host = int(config.getConfig(
conf,
"",
"bridge_pb_host",
"localhost"
))
port = int(config.getConfig(
conf,
"",
"bridge_pb_port",
8789
))
host = getConf("host", "localhost")
port = int(getConf("port", 8789))
reactor.connectTCP(host, port, factory)
else:
raise ValueError(f"Unknown pb connection type: {conn_type!r}")

16
sat/bridge/pb.py
View file

@ -19,6 +19,7 @@
import dataclasses
from functools import partial
from pathlib import Path
from twisted.spread import jelly, pb
from twisted.internet import reactor
@ -106,12 +107,8 @@ class Bridge(object):
log.info("Init Perspective Broker...")
self.root = PBRoot()
conf = config.parseMainConf()
conn_type = config.getConfig(
conf,
"",
"bridge_pb_connection_type",
"unix_socket"
)
getConf = partial(config.getConf, conf, "bridge_pb", "")
conn_type = getConf("connection_type", "unix_socket")
if conn_type == "unix_socket":
local_dir = Path(config.getConfig(conf, "", "local_dir")).resolve()
socket_path = local_dir / "bridge_pb"
@ -120,12 +117,7 @@ class Bridge(object):
str(socket_path), pb.PBServerFactory(self.root), mode=0o600
)
elif conn_type == "socket":
port = int(config.getConfig(
conf,
"",
"bridge_pb_port",
8789
))
port = int(getConf("port", 8789))
log.info(f"using TCP Socket at port {port}")
reactor.listenTCP(port, pb.PBServerFactory(self.root))
else:

5
sat/core/sat_main.py
View file

@ -85,7 +85,10 @@ class SAT(service.Service):
trigger.TriggerManager()
)
bridge_name = self.memory.getConfig("", "bridge", "dbus")
bridge_name = (
os.getenv("LIBERVIA_BRIDGE_NAME")
or self.memory.getConfig("", "bridge", "dbus")
)
bridge_module = dynamic_import.bridge(bridge_name)
if bridge_module is None:

27
sat/tools/config.py
View file

@ -23,6 +23,7 @@
import os
import csv
import json
from typing import Any
from configparser import ConfigParser, DEFAULTSECT, NoOptionError, NoSectionError
from xdg import BaseDirectory
from sat.core.log import getLogger
@ -142,3 +143,29 @@ def getConfig(config, section, name, default=None):
except ValueError as e:
raise exceptions.ParsingError("Error while parsing data: {}".format(e))
return value
def getConf(
conf: ConfigParser,
prefix: str,
section: str,
name: str,
default: Any
) -> Any:
"""Get configuration value from environment or config file
@param str: prefix to use for the varilable name (see `name` below)
@param section: config section to use
@param name: unsuffixed name.
For environment variable, `LIBERVIA_<prefix>_` will be prefixed (and name
will be set to uppercase).
For config file, `<prefix>_` will be prefixed (and DEFAULT section will be
used).
Environment variable has priority over config values. If Environment variable
is set but empty string, config value will be used.
@param default: default value to use if varilable is set neither in environment,
nor in config
"""
# XXX: This is a temporary method until parameters are refactored
value = os.getenv(f"LIBERVIA_{prefix}_{name}".upper())
return value or getConfig(conf, section, f"{prefix}_{name}", default)

22
sat_frontends/bridge/pb.py
View file

@ -140,29 +140,15 @@ class Bridge(object):
def bridgeConnect(self, callback, errback):
factory = pb.PBClientFactory()
conf = config.parseMainConf()
conn_type = config.getConfig(
conf,
"",
"bridge_pb_connection_type",
"unix_socket"
)
getConf = partial(config.getConf, conf, "bridge_pb", "")
conn_type = getConf("connection_type", "unix_socket")
if conn_type == "unix_socket":
local_dir = Path(config.getConfig(conf, "", "local_dir")).resolve()
socket_path = local_dir / "bridge_pb"
reactor.connectUNIX(str(socket_path), factory)
elif conn_type == "socket":
host = int(config.getConfig(
conf,
"",
"bridge_pb_host",
"localhost"
))
port = int(config.getConfig(
conf,
"",
"bridge_pb_port",
8789
))
host = getConf("host", "localhost")
port = int(getConf("port", 8789))
reactor.connectTCP(host, port, factory)
else:
raise ValueError(f"Unknown pb connection type: {conn_type!r}")