mirror of
https://gitlab.com/d3tn/ud3tn.git
synced 2026-08-20 13:28:22 +02:00
cf727900db
As discussed in !214 we add a validation based on `argparse` so the user receives a nice error message when trying to pass an empty string to an argument for which this is not valid. Signed-off-by: Felix Walter <felix.walter@d3tn.com>
142 lines
3.8 KiB
Python
142 lines
3.8 KiB
Python
#!/usr/bin/env python3
|
|
# SPDX-License-Identifier: BSD-3-Clause OR Apache-2.0
|
|
# encoding: utf-8
|
|
|
|
import argparse
|
|
import logging
|
|
import os
|
|
import sys
|
|
|
|
DEFAULT_CONFIG_AGENT_ID_DTN = "config"
|
|
DEFAULT_CONFIG_AGENT_ID_IPN = "9000"
|
|
|
|
|
|
def initialize_logger(verbosity: int):
|
|
log_level = {
|
|
0: logging.WARN,
|
|
1: logging.INFO,
|
|
}.get(verbosity, logging.DEBUG)
|
|
logging.basicConfig(
|
|
level=log_level,
|
|
format="%(asctime)s %(levelname)s: %(message)s",
|
|
)
|
|
return logging.getLogger(sys.argv[0])
|
|
|
|
|
|
def argparse_non_empty_str(value):
|
|
"""An argparse type validation function to exclude the empty string."""
|
|
if value is None or value.strip() == "":
|
|
raise argparse.ArgumentTypeError("must not be empty")
|
|
return value
|
|
|
|
|
|
def add_common_parser_arguments(parser):
|
|
add_agentid_parser_argument(parser)
|
|
add_secret_parser_argument(parser)
|
|
add_socket_group_parser_arguments(parser)
|
|
add_verbosity_parser_argument(parser)
|
|
|
|
|
|
def add_agentid_parser_argument(parser):
|
|
parser.add_argument(
|
|
"-a", "--agentid",
|
|
default=None,
|
|
type=argparse_non_empty_str,
|
|
help="the agent id to register with uD3TN (default: random UUID)",
|
|
)
|
|
|
|
|
|
def add_keepalive_parser_argument(parser):
|
|
|
|
def _range_limited_keepalive(argument):
|
|
try:
|
|
keepalive = int(argument)
|
|
except ValueError:
|
|
raise argparse.ArgumentTypeError("keepalive value must be integer")
|
|
if keepalive < 0 or keepalive > 86400:
|
|
raise argparse.ArgumentTypeError(
|
|
"invalid keepalive value, must be in range [0, 86400]"
|
|
)
|
|
return keepalive
|
|
|
|
parser.add_argument(
|
|
"-k", "--keepalive-seconds",
|
|
type=_range_limited_keepalive,
|
|
default=0,
|
|
help=(
|
|
"amount of seconds after which µD3TN should send a keepalive "
|
|
"message to the receiving end (default: disabled)"
|
|
),
|
|
)
|
|
|
|
|
|
def add_secret_parser_argument(parser):
|
|
parser.add_argument(
|
|
"--secret",
|
|
default=None,
|
|
help="the AAP secret to authenticate the endpoint (default: generate)",
|
|
)
|
|
parser.add_argument(
|
|
"--secret-var",
|
|
default=None,
|
|
type=argparse_non_empty_str,
|
|
help=(
|
|
"an environment variable containing the AAP secret to "
|
|
"authenticate the endpoint (default: generate)"
|
|
),
|
|
)
|
|
|
|
|
|
def add_socket_group_parser_arguments(parser):
|
|
socket_group = parser.add_mutually_exclusive_group()
|
|
socket_group.add_argument(
|
|
"--socket",
|
|
metavar="PATH",
|
|
default="ud3tn.aap2.socket",
|
|
type=argparse_non_empty_str,
|
|
help=(
|
|
"AAP 2.0 UNIX domain socket to connect to "
|
|
"(default: ud3tn.aap2.socket)"
|
|
),
|
|
)
|
|
socket_group.add_argument(
|
|
"--tcp",
|
|
nargs=2,
|
|
metavar=("IP", "PORT"),
|
|
type=argparse_non_empty_str,
|
|
help="AAP 2.0 TCP socket to connect to",
|
|
)
|
|
|
|
|
|
def add_verbosity_parser_argument(parser):
|
|
parser.add_argument(
|
|
"-v", "--verbosity",
|
|
action="count",
|
|
default=0,
|
|
help="increase output verbosity"
|
|
)
|
|
|
|
|
|
def get_node_eid_prefix(eid):
|
|
if eid[0:6] == "dtn://":
|
|
return "dtn://" + eid.split("/")[2] + "/"
|
|
elif eid[0:4] == "ipn:":
|
|
return eid.split(".")[0] + "."
|
|
else:
|
|
raise ValueError("Cannot determine the node prefix for the given EID.")
|
|
|
|
|
|
def get_config_eid(eid):
|
|
return get_node_eid_prefix(eid) + (
|
|
DEFAULT_CONFIG_AGENT_ID_DTN
|
|
if eid[0] == "d" # get_node_eid_prefix already checks everything else
|
|
else DEFAULT_CONFIG_AGENT_ID_IPN
|
|
)
|
|
|
|
|
|
def get_secret_from_args(args):
|
|
if args.secret_var is not None:
|
|
return os.environ[args.secret_var]
|
|
elif args.secret is not None:
|
|
return args.secret
|
|
return None
|