opentf-toolkit-nightly 0.50.0.dev702__py3-none-any.whl → 0.50.0.dev705__py3-none-any.whl

opentf/commons/__init__.py

@@ -35,7 +35,7 @@ from .config import (
     make_argparser,
     configure_logging,
     read_config,
-    read_manifest,
+    read_descriptor,
     get_named,
 )
 from .auth import (
@@ -209,7 +209,7 @@ def _get_contextparameter_spec(app: Flask, name: str) -> Optional[Dict[str, Any]
     """
     if PARAMETERS_KEY not in app.config:
         app.config[PARAMETERS_KEY] = []
-        for manifest in app.config['MANIFEST']:
+        for manifest in app.config['DESCRIPTOR']:
             if manifest.get('metadata', {}).get('name', '').lower() != app.name.lower():
                 continue
             app.config[PARAMETERS_KEY] += manifest.get('spec', {}).get(
@@ -407,7 +407,7 @@ def make_app(
     configfile: str,
     schema: Optional[str] = None,
     defaultcontext: Optional[Dict[str, Any]] = None,
-    manifest: Optional[Union[str, Dict[str, Any], List[Dict[str, Any]]]] = None,
+    descriptor: Optional[Union[str, Dict[str, Any], List[Dict[str, Any]]]] = None,
 ) -> Flask:
     """Create a new app.
 
@@ -421,7 +421,7 @@ def make_app(
 
     - schema: a string or None (None by default)
     - defaultcontext: a dictionary or None (None by default)
-    - manifest: a filename, a dictionary or a list of dictionaries or
+    - descriptor: a filename, a dictionary or a list of dictionaries or
       None (None by default)
 
     # Returned value
@@ -431,7 +431,7 @@ def make_app(
 
     `CONFIG` is a dictionary, the complete config file.  `CONTEXT` is a
     subset of `CONFIG`, the current entry in `CONFIG['context']`.  It is
-    also a dictionary.  `MANIFEST` is the service manifest.
+    also a dictionary.  `DESCRIPTOR` is the service descriptor.
 
     # Raised Exception
 
@@ -447,8 +447,9 @@ def make_app(
             args.config, args.context, configfile, defaultcontext, schema
         )
 
-        if args.manifest is not None or manifest is None or isinstance(manifest, str):
-            _, manifest = read_manifest(args.manifest, manifest)
+        if args.descriptor or descriptor is None or isinstance(descriptor, str):
+            _, descriptor = read_descriptor(args.descriptor, descriptor)
+
         if args.host:
             context['host'] = args.host
         if args.port:
@@ -463,7 +464,9 @@ def make_app(
 
     app.config['CONTEXT'] = context
     app.config['CONFIG'] = config
-    app.config['MANIFEST'] = manifest if isinstance(manifest, list) else [manifest]
+    app.config['DESCRIPTOR'] = (
+        descriptor if isinstance(descriptor, list) else [descriptor]
+    )
     app.before_request(_make_authenticator(context))
     app.after_request(_add_securityheaders)
     return app

opentf/commons/config.py

@@ -48,7 +48,7 @@ class ConfigError(Exception):
 
 def make_argparser(description: str, configfile: str) -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(description=description)
-    parser.add_argument('--manifest', help='alternate manifest file')
+    parser.add_argument('--descriptor', help='alternate descriptor file')
     parser.add_argument(
         '--config', help=f'alternate config file (default to {configfile})'
     )
@@ -131,14 +131,14 @@ def _read_configfile(
     argsconfig: Optional[str], configfile: str
 ) -> Tuple[str, Dict[str, Any]]:
     try:
-        configfile = argsconfig or configfile
-        with open(configfile, 'r', encoding='utf-8') as cnf:
+        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 configfile, config
+        return filename, config
     except Exception as err:
-        raise ConfigError(f'Could not get configfile "{configfile}", aborting: {err}.')
+        raise ConfigError(f'Could not get configfile "{filename}", aborting: {err}.')
 
 
 def read_config(
@@ -169,27 +169,27 @@ def read_config(
     return context, config
 
 
-def read_manifest(
-    argsmanifest: Optional[str], manifest: Any
+def read_descriptor(
+    argsdescriptor: Optional[str], descriptor: Any
 ) -> Tuple[str, List[Dict[str, Any]]]:
     try:
-        if argsmanifest:
-            manifestfile = argsmanifest
+        if argsdescriptor:
+            filename = argsdescriptor
         else:
             for frame in inspect.stack():
                 if frame.frame.f_code.co_name == '<module>':
                     break
             else:
                 raise ConfigError('Could not get module location, aborting.')
-            manifestfile = os.path.join(
+            filename = os.path.join(
                 os.path.dirname(frame.filename),
-                manifest or 'service.yaml',
+                descriptor or 'service.yaml',
             )
-        with open(manifestfile, 'r', encoding='utf-8') as definition:
+        with open(filename, 'r', encoding='utf-8') as definition:
             manifests = list(yaml.safe_load_all(definition))
-        return manifestfile, manifests
+        return filename, manifests
     except Exception as err:
-        raise ConfigError(f'Could not get manifest "{manifestfile}", aborting: {err}.')
+        raise ConfigError(f'Could not get descriptor "{filename}", aborting: {err}.')
 
 
 def get_named(name: str, entries: List[Dict[str, Any]]) -> Dict[str, Any]:

opentf/toolkit/__init__.py

@@ -409,7 +409,7 @@ def run_plugin(plugin):
         context[SUBSCRIPTION_KEY] = []
         context[INPUTS_KEY] = {}
         if context[KIND_KEY] == PROVIDERCOMMAND:
-            for manifest in plugin.config['MANIFEST']:
+            for manifest in plugin.config['DESCRIPTOR']:
                 metadata = manifest.get('metadata', {})
                 if metadata.get('name', '').lower() != plugin.name.lower():
                     continue
@@ -445,7 +445,7 @@ def make_plugin(
     provider: Optional[Handler] = None,
     providers: Optional[Dict[str, Handler]] = None,
     publisher: Optional[Handler] = None,
-    manifest=None,
+    descriptor=None,
     schema=None,
     configfile=None,
 ):
@@ -454,7 +454,7 @@ def make_plugin(
     One and only one of `channel`, `generator`, `provider`, `providers`,
     or `publisher` must be specified.
 
-    If no `manifest` is specified, there must be `plugin.yaml` file in
+    If no `descriptor` is specified, there must be `plugin.yaml` file in
     the same directory as the caller source file.  If none is found the
     execution stops.
 
@@ -472,8 +472,8 @@ def make_plugin(
 
     # Optional parameters
 
-    - manifest: a dictionary or a list of dictionaries or None (None by
-      default)
+    - descriptor: a dictionary or a list of dictionaries or None (None
+      by default)
     - schema: a string or None (None by default)
     - configfile: a string or None (None by default)
 
@@ -522,9 +522,9 @@ def make_plugin(
         raise ValueError(
             "One and only one of 'channel', 'generator', 'provider', 'providers', or 'publisher' is required."
         )
-    if not (manifest is None or isinstance(manifest, (dict, list))):
+    if not (descriptor is None or isinstance(descriptor, (dict, list))):
         raise ValueError(
-            "'manifest', if specified, must be a dictionary or a list of dictionaries."
+            "'descriptor', if specified, must be a dictionary or a list of dictionaries."
         )
 
     kind = (
@@ -542,7 +542,7 @@ def make_plugin(
         description,
         configfile=configfile or f'conf/{name}.yaml',
         schema=schema,
-        manifest=manifest if manifest is not None else 'plugin.yaml',
+        descriptor=descriptor if descriptor is not None else 'plugin.yaml',
     )
     plugin.route('/inbox', methods=['POST'])(process_inbox)
     plugin.config['CONTEXT'][KIND_KEY] = kind

{opentf_toolkit_nightly-0.50.0.dev702.dist-info → opentf_toolkit_nightly-0.50.0.dev705.dist-info}/METADATA

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

{opentf_toolkit_nightly-0.50.0.dev702.dist-info → opentf_toolkit_nightly-0.50.0.dev705.dist-info}/RECORD

@@ -1,6 +1,6 @@
-opentf/commons/__init__.py,sha256=GAAWjd9yKan0HPA3cMFCtZ7wecB-K6hzcjDQDN6s9DM,22024
+opentf/commons/__init__.py,sha256=06GO6FXo0zq7IJzDr4718FQ5IIze6EyReC0UACF3L0M,22063
 opentf/commons/auth.py,sha256=ADMygTSGy6voOQUAD9EtusPR_hgJ6jUK_uJE8CCpBoE,14481
-opentf/commons/config.py,sha256=y9TWJCdBPaWt0CRY-WxjfCe8OPEdqz8KgiWbuYwkgns,7016
+opentf/commons/config.py,sha256=CJ3xGc9dmva08zek9FIMqFHkgwoPOukiXmafN2nm000,7006
 opentf/commons/expressions.py,sha256=dKcYYc7j3laueZEcV00djvE7UFPLMiUTNeNvKGla3cQ,19069
 opentf/commons/pubsub.py,sha256=_Psa3wdE_OB6wDHhUwr9zdxHpu5rSz19qtpM1Qo2WsY,5675
 opentf/commons/schemas.py,sha256=kMhZH47dpBk_HDMZk-1AlTb1dIYF-N6SPiEUmkEtWX0,3909
@@ -42,11 +42,11 @@ opentf/schemas/opentestfactory.org/v1beta1/Workflow.json,sha256=QZ8mM9PhzsI9gTmw
 opentf/schemas/opentestfactory.org/v1beta2/ServiceConfig.json,sha256=rEvK2YWL5lG94_qYgR_GnLWNsaQhaQ-2kuZdWJr5NnY,3517
 opentf/scripts/launch_java_service.sh,sha256=Ut_STdFqMhTV7cekPVp4JkBTqZKcJSAh1UNUn9Ylv3g,2427
 opentf/scripts/startup.py,sha256=CjKrFqbLyDKdUca-fWB-QkDURjdypkbrBUpEFNy3qQo,18719
-opentf/toolkit/__init__.py,sha256=HRh7YRtjlkqL_RJfAsEuVJGLHLEYFYkJUJj4We4ZwLM,18351
+opentf/toolkit/__init__.py,sha256=4bL02Q3DgtMWZhaCvlJ7eOp9rPGIG9p-xNcs8hynhhQ,18371
 opentf/toolkit/channels.py,sha256=GGIPuUN7sFM_FwoqbUgLk7smggLty3rSDZTma5jAAt4,16185
 opentf/toolkit/core.py,sha256=40S-pUKXWidbI4JwkmQjGq46WlxJshj6d-wEl4e5TxU,7312
-opentf_toolkit_nightly-0.50.0.dev702.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-opentf_toolkit_nightly-0.50.0.dev702.dist-info/METADATA,sha256=zc-MJXw11sEliv2F92kh8gu9UgLXjJO1lb1cD4QQLm8,1965
-opentf_toolkit_nightly-0.50.0.dev702.dist-info/WHEEL,sha256=5sUXSg9e4bi7lTLOHcm6QEYwO5TIF1TNbTSVFVjcJcc,92
-opentf_toolkit_nightly-0.50.0.dev702.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
-opentf_toolkit_nightly-0.50.0.dev702.dist-info/RECORD,,
+opentf_toolkit_nightly-0.50.0.dev705.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentf_toolkit_nightly-0.50.0.dev705.dist-info/METADATA,sha256=2BuuxKrik9f7f_7FliEYZwaqUaov-XJbjPyIzAe4Er4,1965
+opentf_toolkit_nightly-0.50.0.dev705.dist-info/WHEEL,sha256=5sUXSg9e4bi7lTLOHcm6QEYwO5TIF1TNbTSVFVjcJcc,92
+opentf_toolkit_nightly-0.50.0.dev705.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
+opentf_toolkit_nightly-0.50.0.dev705.dist-info/RECORD,,