opentf-toolkit-nightly 0.62.0.dev1283__py3-none-any.whl → 0.62.0.dev1286__py3-none-any.whl

opentf/commons/config.py

@@ -25,14 +25,14 @@ from logging.config import dictConfig
 import yaml
 
 from .exceptions import ConfigError
-from .schemas import validate_schema, SERVICECONFIG
+from .schemas import read_and_validate, SERVICECONFIG
 
 
 ########################################################################
 
 NOTIFICATION_LOGGER_EXCLUSIONS = 'eventbus'
 
-DEFAULT_CONTEXT = {
+DEFAULT_CONTEXT: Dict[str, Any] = {
     'host': '127.0.0.1',
     'port': 443,
     'ssl_context': 'adhoc',
@@ -46,6 +46,21 @@ DEBUG_LEVELS = {'CRITICAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG', 'NOTSET'}
 
 
 def make_argparser(description: str, configfile: str) -> argparse.ArgumentParser:
+    """Make an argument parser.
+
+    The configured argument parser includes definitions for all commons
+    command-line parameters.  It can be extended with additional
+    parameters.
+
+    # Required parameters
+
+    - description: a string, the parser description
+    - configfile: a string, the default configuration file name
+
+    # Returned value
+
+    An argument parser, configured.
+    """
     parser = argparse.ArgumentParser(description=description)
     parser.add_argument('--descriptor', help='alternate descriptor file')
     parser.add_argument(
@@ -98,7 +113,34 @@ def make_argparser(description: str, configfile: str) -> argparse.ArgumentParser
 
 
 def configure_logging(name: str, debug_level: str) -> None:
-    logging_conf = {
+    """Configure logging.
+
+    The logging configuration is driven by the `debug_level` parameter.
+
+    A `wsgi` handler is defined, that will log messages to the WSGI
+    stream.
+
+    You can use the `OPENTF_LOGGING_REDIRECT` environment variable to
+    redirect the logs to a specific stream.
+
+    If `name` is not in `NOTIFICATION_LOGGER_EXCLUSIONS`, an `eventbus`
+    handler is added.  It will post log messages to the event bus as
+    `Notification` events.
+
+    The configured format is:
+
+    `[%(asctime)s] %(levelname)s in {name}: %(message)s`
+
+    # Required parameters
+
+    - name: a string, the service name
+    - debug_level: a string, the log level
+
+    # Returned value
+
+    None.
+    """
+    logging_conf: Dict[str, Any] = {
         'version': 1,
         'formatters': {
             'default': {
@@ -126,41 +168,57 @@ def configure_logging(name: str, debug_level: str) -> None:
     dictConfig(logging_conf)
 
 
-def _read_configfile(
-    argsconfig: Optional[str], configfile: str
-) -> Tuple[str, Dict[str, Any]]:
-    try:
-        filename = argsconfig or configfile
-        with open(filename, 'r', encoding='utf-8') as cnf:
-            config = yaml.safe_load(cnf)
-        if not isinstance(config, dict):
-            raise ValueError('Config file is not an object.')
-        return filename, config
-    except Exception as err:
-        raise ConfigError(f'Could not get configfile "{filename}", aborting: {err}.')
-
-
 def read_config(
-    argsconfig: Optional[str],
-    argscontext: Optional[str],
+    altconfig: Optional[str],
+    altcontext: Optional[str],
     configfile: str,
-    defaultcontext,
-    schema,
+    defaultcontext: Optional[Dict[str, Any]],
+    schema: Optional[str],
 ) -> Tuple[Dict[str, Any], Dict[str, Any]]:
-    if argsconfig is None and not os.path.isfile(configfile):
-        if argscontext:
+    """Read service configuration.
+
+    If not None, the `alt` parameters are used to override the default
+    ones.
+
+    # Required parameters
+
+    - altconfig: a string (the configuration file location) or None
+    - altcontext: a string (the context name) or None
+    - configfile: a string, the configuration file name
+    - defaultcontext: a dictionary (the default context) or None
+    - schema: a string (the schema that validates the configuration)
+      or None
+
+    If `altcontext` is None, returns the current context as specified
+    in the service configuration.
+
+    If `schema` is None, uses SERVICECONFIG as the default schema.
+
+    # Returned value
+
+    A pair of dictionaries.  The first item is the context, the second
+    item is the complete configuration.
+
+    # Raised exceptions
+
+    A _ConfigError_ exception is raised if the configuration file cannot
+    be read or if the configuration file is invalid.
+    """
+    if altconfig is None and not os.path.isfile(configfile):
+        if altcontext:
             raise ConfigError(
                 'Cannot specify a context when using default configuration.'
             )
         context = defaultcontext or DEFAULT_CONTEXT
         config = {}
     else:
-        configfile, config = _read_configfile(argsconfig, configfile)
-        valid, extra = validate_schema(schema or SERVICECONFIG, config)
-        if not valid:
-            raise ConfigError(f'Config file "{configfile}" is invalid: {extra}.')
+        configfile = altconfig or configfile
+        try:
+            config = read_and_validate(configfile, schema or SERVICECONFIG)
+        except (ValueError, OSError) as err:
+            raise ConfigError(f'Could not read configfile "{configfile}": {err}.')
 
-        context_name = argscontext or config['current-context']
+        context_name = altcontext or config['current-context']
         try:
             context = get_named(context_name, config['contexts'])['context']
         except ValueError as err:
@@ -169,11 +227,32 @@ def read_config(
 
 
 def read_descriptor(
-    argsdescriptor: Optional[str], descriptor: Any
+    altdescriptor: Optional[str], descriptor: Optional[str]
 ) -> Tuple[str, List[Dict[str, Any]]]:
+    """Read service descriptor.
+
+    If `altdescriptor` is None, the descriptor is read from the module
+    where the function is called.  If `descriptor` is None, the default
+    descriptor name is `service.yaml`.
+
+    # Required parameter
+
+    - altdescriptor: a string, the descriptor file location or None
+    - descriptor: a string, the descriptor file name or None
+
+    # Returned value
+
+    A pair (filename, manifests) where filename is the descriptor file
+    name and manifests is a list of dictionaries.
+
+    # Raised exceptions
+
+    A _ConfigError_ exception is raised if the descriptor file cannot
+    be read.
+    """
     try:
-        if argsdescriptor:
-            filename = argsdescriptor
+        if altdescriptor:
+            filename = altdescriptor
         else:
             for frame in inspect.stack():
                 if frame.frame.f_code.co_name == '<module>':
@@ -187,12 +266,17 @@ def read_descriptor(
         with open(filename, 'r', encoding='utf-8') as definition:
             manifests = list(yaml.safe_load_all(definition))
         return filename, manifests
+    except ConfigError:
+        raise
     except Exception as err:
         raise ConfigError(f'Could not get descriptor "{filename}", aborting: {err}.')
 
 
 def get_named(name: str, entries: List[Dict[str, Any]]) -> Dict[str, Any]:
-    """Get an entry from a list of entries.
+    """Get an entry from a list of dictionaries.
+
+    Matching entries are those with a 'name' entry equal to the
+    requested name.
 
     # Required parameters
 
@@ -219,7 +303,7 @@ def get_named(name: str, entries: List[Dict[str, Any]]) -> Dict[str, Any]:
 def get_debug_level(name: str) -> str:
     """Get service log level.
 
-    Driven by environment variables.  If `{service name}_DEBUG_LEVEL` is
+    Driven by environment variables.  If `{name}_DEBUG_LEVEL` is
     defined, this value is used.  If not, if `DEBUG_LEVEL` is set, then
     it is used.  Otherwise, returns `INFO`.
 

opentf/commons/schemas.py

@@ -1,4 +1,4 @@
-# Copyright (c) Henix, Henix.fr
+# Copyright (c) 2023 Henix, Henix.fr
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,13 +14,14 @@
 
 """Helpers for the OpenTestFactory schemas."""
 
-from typing import Any, Dict, Tuple
+from typing import Any, Dict, Optional, Tuple
 
 import json
 import logging
 import os
 
 from jsonschema import Draft201909Validator, ValidationError
+from yaml import safe_load
 
 import opentf.schemas
 
@@ -68,8 +69,8 @@ INSIGHT_COLLECTOR = 'opentestfactory.org/v1alpha1/InsightCollector'
 ########################################################################
 # JSON Schema Helpers
 
-_schemas = {}
-_validators = {}
+_schemas: Dict[str, Dict[str, Any]] = {}
+_validators: Dict[str, Draft201909Validator] = {}
 
 SCHEMAS_ROOT_DIRECTORY = list(opentf.schemas.__path__)[0]
 
@@ -99,19 +100,21 @@ def get_schema(name: str) -> Dict[str, Any]:
             ) as schema:
                 _schemas[name] = json.loads(schema.read())
         except Exception as err:
-            logging.error('Could not read schema %s: %s', name, err)
+            logging.error('Could not read schema "%s": %s', name, err)
             raise
     return _schemas[name]
 
 
-def _validator(schema: str):
+def _validator(schema: str) -> Draft201909Validator:
     if schema not in _validators:
         _validators[schema] = Draft201909Validator(get_schema(schema))
     return _validators[schema]
 
 
-def validate_schema(schema, instance) -> Tuple[bool, Any]:
-    """Return True if instance validates schema.
+def validate_schema(
+    schema: str, instance: Dict[str, Any]
+) -> Tuple[bool, Optional[str]]:
+    """Return (True, None) if instance validates schema.
 
     # Required parameters
 
@@ -122,14 +125,40 @@ def validate_schema(schema, instance) -> Tuple[bool, Any]:
 
     A (bool, Optional[str]) pair.  If `instance` is a valid instance of
     `schema`, returns `(True, None)`.  If not, returns `(False, error)`.
-
-    # Raised exceptions
-
-    If an error occurs while reading the schema, the initial exception
-    is logged and raised again.
     """
     try:
         _validator(schema).validate(instance=instance)
     except ValidationError as err:
-        return False, err
+        return False, str(err)
     return True, None
+
+
+def read_and_validate(filename: str, schema: str) -> Dict[str, Any]:
+    """Read and validate a configuration file.
+
+    # Required parameters
+
+    - filename: a string, the configuration file name
+    - schema: a string, the schema to validate the configuration
+
+    # Returned value
+
+    A dictionary, the configuration.
+
+    # Raised exceptions
+
+    An _OSError_ exception is raised if the configuration file cannot
+    be read.
+
+    A _ValueError_ exception is raised if the configuration file is
+    invalid.
+    """
+    with open(filename, 'r', encoding='utf-8') as cnf:
+        config = safe_load(cnf)
+
+    if not isinstance(config, dict):
+        raise ValueError('Config file is not an object.')
+    valid, extra = validate_schema(schema or SERVICECONFIG, config)
+    if not valid:
+        raise ValueError(f'Config file "{filename}" is invalid: {extra}.')
+    return config

{opentf_toolkit_nightly-0.62.0.dev1283.dist-info → opentf_toolkit_nightly-0.62.0.dev1286.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: opentf-toolkit-nightly
-Version: 0.62.0.dev1283
+Version: 0.62.0.dev1286
 Summary: OpenTestFactory Orchestrator Toolkit
 Home-page: https://gitlab.com/henixdevelopment/open-source/opentestfactory/python-toolkit
 Author: Martin Lafaix

{opentf_toolkit_nightly-0.62.0.dev1283.dist-info → opentf_toolkit_nightly-0.62.0.dev1286.dist-info}/RECORD

@@ -1,10 +1,10 @@
 opentf/commons/__init__.py,sha256=thcqhAp--rYDw-JIBIkgpaLu1kEk3pyPJz8brx7f7vU,22599
 opentf/commons/auth.py,sha256=gXRp_0Tf3bfd65F4QiQmh6C6vR9y3ugag_0DSvozJFk,15898
-opentf/commons/config.py,sha256=_8WzSaeB0yjGRa8mTQ69OASyUSbKZbwNOiKpMp2jFwI,7842
+opentf/commons/config.py,sha256=RVSSdQhMle4oCo_z_AR2EQ4U6sUjSxw-qVBtjKuJVfo,10219
 opentf/commons/exceptions.py,sha256=7dhUXO8iyAbqVwlUKxZhgRzGqVcb7LkG39hFlm-VxIA,2407
 opentf/commons/expressions.py,sha256=jM_YKXVOFhvOE2aE2IuacuvxhIsOYTFs2oQkpcbWR6g,19645
 opentf/commons/pubsub.py,sha256=M0bvajR9raUP-xe5mfRjdrweZyHQw1_Qsy56gS-Sck4,7676
-opentf/commons/schemas.py,sha256=cjyPXRhRIPQauCdy9zGRaOkqdVcklz47JnljTTLNpq8,4254
+opentf/commons/schemas.py,sha256=u1TdoGFNWoslWV7foBqXPgkGTQtRZWtXTr_PEd_TsFY,5189
 opentf/commons/selectors.py,sha256=R7y1E_5yP1zsz40eNy1buk464SaKVH5dCcRZnEYkdpU,7136
 opentf/schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 opentf/schemas/abac.opentestfactory.org/v1alpha1/Policy.json,sha256=JXsfNAPSEYggeyaDutSQBeG38o4Bmcr70dPLWWeqIh8,2105
@@ -58,8 +58,8 @@ opentf/scripts/startup.py,sha256=vOGxl7xBcp1-_LsAKiOmeOqFl2iT81A2XRrXBLUrNi4,227
 opentf/toolkit/__init__.py,sha256=mYeJPZ92ulbTBItqEsZgF4nnuRh6G19QPY3Jxc92ifc,23028
 opentf/toolkit/channels.py,sha256=whLfPVT5PksVlprmoeb2ktaZ3KEhqyryUCVWBJq7PeY,24308
 opentf/toolkit/core.py,sha256=fqnGgaYnuVcd4fyeNIwpc0QtyUo7jsKeVgdkBfY3iqo,9443
-opentf_toolkit_nightly-0.62.0.dev1283.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-opentf_toolkit_nightly-0.62.0.dev1283.dist-info/METADATA,sha256=higuBX2Pumx06AjFYWQWbInDjMYdHyt0ftbhZJmmkls,2192
-opentf_toolkit_nightly-0.62.0.dev1283.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-opentf_toolkit_nightly-0.62.0.dev1283.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
-opentf_toolkit_nightly-0.62.0.dev1283.dist-info/RECORD,,
+opentf_toolkit_nightly-0.62.0.dev1286.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentf_toolkit_nightly-0.62.0.dev1286.dist-info/METADATA,sha256=_LVp3XnOgkbwM-JnwBA7EiqniPxVpA6bfZGfhdBZW_o,2192
+opentf_toolkit_nightly-0.62.0.dev1286.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+opentf_toolkit_nightly-0.62.0.dev1286.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
+opentf_toolkit_nightly-0.62.0.dev1286.dist-info/RECORD,,