opentf-toolkit-nightly 0.50.0.dev644__py3-none-any.whl → 0.50.0.dev653__py3-none-any.whl

opentf/commons/__init__.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Helpers for the OpenTestFactory orchestrator"""
+"""Helpers for the OpenTestFactory orchestrator services."""
 
 from typing import Any, Dict, List, Optional, Tuple, Union
 
@@ -331,29 +331,6 @@ def get_actor() -> Optional[str]:
     return None
 
 
-def run_app(app) -> None:
-    """Start the app.
-
-    Using waitress as the wsgi server.  The logging service is
-    configured to only show waitress errors and up messages.
-
-    Access logs are only displayed when in DEBUG mode.
-    """
-    context = app.config['CONTEXT']
-
-    from waitress import serve
-
-    if _get_debug_level(app.name) == 'DEBUG':
-        from paste.translogger import TransLogger
-
-        app = TransLogger(app, format=ACCESSLOG_FORMAT, setup_console_handler=False)
-    else:
-        logging.getLogger('waitress').setLevel('ERROR')
-        app.logger.info(f'Serving on http://{context["host"]}:{context["port"]}')
-
-    serve(app, host=context['host'], port=context['port'])
-
-
 class EventbusLogger(logging.Handler):
     """A Notification logger.
 
@@ -477,12 +454,81 @@ def make_app(
 
     app.config['CONTEXT'] = context
     app.config['CONFIG'] = config
-    app.config['DEBUG_LEVEL'] = os.environ.get('DEBUG_LEVEL', 'INFO')
     app.before_request(_make_authenticator(context))
     app.after_request(_add_securityheaders)
     return app
 
 
+def get_context_parameter(app: Flask, contextparam: str, default: int) -> int:
+    """Get an integer parameter from configuration context.
+
+    Exits with an error code of 2 if the parameter is not an integer.
+
+    # Required parameters
+
+    - app: a Flask object
+    - contextparam: a string
+    - default: an integer
+
+    # Returned value
+
+    An integer.  `default` if the context parameter is not defined.
+    """
+    try:
+        return int(app.config['CONTEXT'].get(contextparam, default))
+    except ValueError as err:
+        app.logger.error(
+            'Configuration parameter %s not an integer: %s', contextparam, str(err)
+        )
+        sys.exit(2)
+
+
+def get_context_service(app: Flask, service: str) -> Dict[str, Any]:
+    """Get service specification from configuration context.
+
+    Exits with an error code of 2 if the service is missing.
+
+    # Required parameters
+
+    - app: a Flask object
+    - service: a string
+
+    # Returned value
+
+    A dictionary.
+    """
+    if definition := app.config['CONTEXT'].get('services', {}).get(service):
+        return definition
+    app.logger.error(
+        '.services.{} specification missing in configuration context.',
+        service,
+    )
+    sys.exit(2)
+
+
+def run_app(app) -> None:
+    """Start the app.
+
+    Using waitress as the wsgi server.  The logging service is
+    configured to only show waitress errors and up messages.
+
+    Access logs are only displayed when in DEBUG mode.
+    """
+    context = app.config['CONTEXT']
+
+    from waitress import serve
+
+    if _get_debug_level(app.name) == 'DEBUG':
+        from paste.translogger import TransLogger
+
+        app = TransLogger(app, format=ACCESSLOG_FORMAT, setup_console_handler=False)
+    else:
+        logging.getLogger('waitress').setLevel('ERROR')
+        app.logger.info(f'Serving on http://{context["host"]}:{context["port"]}')
+
+    serve(app, host=context['host'], port=context['port'])
+
+
 ########################################################################
 ## Misc. helpers
 
@@ -498,7 +544,7 @@ def make_uuid():
 
 def make_status_response(
     reason: str, message: str, details: Optional[Dict[str, Any]] = None
-):
+) -> Response:
     """Return a new status response object.
 
     # Required parameters
@@ -512,7 +558,8 @@ def make_status_response(
 
     # Returned value
 
-    A _status_.  A status is a dictionary with the following entries:
+    A _flask.Response_.  Its body is a _status_ JSON object.  It has
+    the following entries:
 
     - kind: a string (`'Status'`)
     - apiVersion: a string (`'v1'`)

opentf/commons/expressions.py

@@ -25,7 +25,7 @@ from datetime import datetime
 
 STRING = r'(\'([^\']*)\')+'
 IDENTIFIER = r'^[a-zA-Z_][a-zA-Z0-9_-]*'
-NUMBER = r'^(0x[0-9a-fA-F]+)|(-?\d+(\.\d+)?)'
+NUMBER = r'^((0x[0-9a-fA-F]+)|(-?\d+(\.\d+)?))'
 OPERATOR = r'^(==|!=|!|<=|<|>=|>|\[|\]|\(|\)|\.|&&|\|\||~=|,)'
 
 INFIX_OPERATOR = ('==', '!=', '<=', '<', '>', '>=', '&&', '||', '~=')

opentf/scripts/startup.py

@@ -489,7 +489,7 @@ def main():
         with open(OPENTF_MANIFEST, 'r', encoding='utf-8') as manifest:
             conf = yaml.safe_load(manifest)
     except Exception as err:
-        logging.error('Reading SquashTF manifest failed: %s.', str(err))
+        logging.error('Reading OpenTestFactory Launcher Manifest failed: %s.', str(err))
         sys.exit(1)
 
     logging.info('Checking Configuration...')

opentf/toolkit/__init__.py

@@ -30,6 +30,7 @@ import yaml
 from opentf.commons import (
     make_app,
     run_app,
+    get_context_parameter,
     subscribe,
     unsubscribe,
     EXECUTIONCOMMAND,
@@ -324,18 +325,10 @@ def _watchdog(plugin, polling_delay):
 
 def _start_watchdog(plugin) -> None:
     """Set up a watchdog that monitors specified files for changes."""
-    try:
-        polling_delay = max(
-            WATCHDOG_POLLING_DELAY_SECONDS,
-            int(plugin.config['CONTEXT'].get(WATCHDOG_POLLING_DELAY_KEY, 0)),
-        )
-    except ValueError as err:
-        plugin.logger.error(
-            'Configuration parameter %s not an integer: %s.',
-            WATCHDOG_POLLING_DELAY_KEY,
-            str(err),
-        )
-        sys.exit(2)
+    polling_delay = max(
+        WATCHDOG_POLLING_DELAY_SECONDS,
+        get_context_parameter(plugin, WATCHDOG_POLLING_DELAY_KEY, 0),
+    )
 
     plugin.logger.info('Watchdog configuration:')
     plugin.logger.info(

opentf/toolkit/core.py

@@ -250,7 +250,7 @@ def attach_file(path: str, **kwargs) -> str:
     parameters:
 
     ```python
-    core.attach_file('/foo/bar.xml',type='text/xml', 'charset'='utf8')
+    core.attach_file('/foo/bar.xml',type='text/xml', charset='utf8')
     # gives ::attach type=text/xml, charset=utf-8::/foo/bar.xml
     """
     if kwargs:

{opentf_toolkit_nightly-0.50.0.dev644.dist-info → opentf_toolkit_nightly-0.50.0.dev653.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: opentf-toolkit-nightly
-Version: 0.50.0.dev644
+Version: 0.50.0.dev653
 Summary: OpenTestFactory Orchestrator Toolkit
 Home-page: https://gitlab.com/henixdevelopment/open-source/opentestfactory/python-toolkit
 Author: Martin Lafaix
@@ -17,8 +17,8 @@ Classifier: License :: OSI Approved :: Apache Software License
 Requires-Python: >= 3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: requests (>=2.28)
-Requires-Dist: PyJWT[crypto] (>=2.6)
+Requires-Dist: requests (>=2.31)
+Requires-Dist: PyJWT[crypto] (>=2.7)
 Requires-Dist: PyYAML (>=6)
 Requires-Dist: Flask (>=2.2.3)
 Requires-Dist: jsonschema (>=4.17)

{opentf_toolkit_nightly-0.50.0.dev644.dist-info → opentf_toolkit_nightly-0.50.0.dev653.dist-info}/RECORD

@@ -1,7 +1,7 @@
-opentf/commons/__init__.py,sha256=ish0cuVYcj8g8bQy5cbt64QCe-50WBlj7_7jglZPVt4,18783
+opentf/commons/__init__.py,sha256=DfoMjN4P_PgV37l7HM8qBywGO-r4l0RirKpSXlyz-iE,19986
 opentf/commons/auth.py,sha256=ADMygTSGy6voOQUAD9EtusPR_hgJ6jUK_uJE8CCpBoE,14481
 opentf/commons/config.py,sha256=lvxacmFxxQ8Va0qepx-ld7taCpjOr4l-NjDBOTrzrE4,3510
-opentf/commons/expressions.py,sha256=geFdZeHGB-l0IEGImS2oHbhqJhMxXaHSAknFqWrqBgs,18980
+opentf/commons/expressions.py,sha256=F8oJgLB0LjqIJOfDHhw2MXY5CQuX7GksJZijY7K-TLc,18982
 opentf/commons/pubsub.py,sha256=_Psa3wdE_OB6wDHhUwr9zdxHpu5rSz19qtpM1Qo2WsY,5675
 opentf/commons/schemas.py,sha256=kMhZH47dpBk_HDMZk-1AlTb1dIYF-N6SPiEUmkEtWX0,3909
 opentf/commons/selectors.py,sha256=yj7Os7_8osvOssKUxi8d4tpKSMKBAa5hM81TWKjIADI,5521
@@ -41,12 +41,12 @@ opentf/schemas/opentestfactory.org/v1beta1/ServiceConfig.json,sha256=m5ZgWAKbutu
 opentf/schemas/opentestfactory.org/v1beta1/Workflow.json,sha256=QZ8mM9PhzsI9gTmwmKTWYNoRn--rtcM3L0PzgnPBfMU,15424
 opentf/schemas/opentestfactory.org/v1beta2/ServiceConfig.json,sha256=rEvK2YWL5lG94_qYgR_GnLWNsaQhaQ-2kuZdWJr5NnY,3517
 opentf/scripts/launch_java_service.sh,sha256=FRYrQD704VWLGXQ3QI-M3m77olXexB0vVEwzyiKLkxc,1579
-opentf/scripts/startup.py,sha256=46UL6uCBXId3z3009bIIOD-inFEKrgg3allNQQYFIZs,18703
-opentf/toolkit/__init__.py,sha256=s2HZLnfWPIvkfLWboWPT4JwfBNH-8kZd9XMsZ5Tibsk,19303
+opentf/scripts/startup.py,sha256=CjKrFqbLyDKdUca-fWB-QkDURjdypkbrBUpEFNy3qQo,18719
+opentf/toolkit/__init__.py,sha256=J8lC8gH952aspCnroErgaoqxsDBaNNAgiorfP8c5e3c,19088
 opentf/toolkit/channels.py,sha256=caUaZIRHp9D4BoJRtFug-M6tsjxrp3TDPaBxPlPghos,16121
-opentf/toolkit/core.py,sha256=wLu2fvcahExR6MYAwzsLJnG-tdO0wg6_LZ2NxHeUdvA,7314
-opentf_toolkit_nightly-0.50.0.dev644.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-opentf_toolkit_nightly-0.50.0.dev644.dist-info/METADATA,sha256=fqaL6LveGoy170PIl3VLDm1oF1qufNLSogFGBgAeBsQ,1981
-opentf_toolkit_nightly-0.50.0.dev644.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-opentf_toolkit_nightly-0.50.0.dev644.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
-opentf_toolkit_nightly-0.50.0.dev644.dist-info/RECORD,,
+opentf/toolkit/core.py,sha256=40S-pUKXWidbI4JwkmQjGq46WlxJshj6d-wEl4e5TxU,7312
+opentf_toolkit_nightly-0.50.0.dev653.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentf_toolkit_nightly-0.50.0.dev653.dist-info/METADATA,sha256=lXf9Al4eFwdGJ-673DrzSYO8u6UZeF6GT5eFdVDFoUo,1981
+opentf_toolkit_nightly-0.50.0.dev653.dist-info/WHEEL,sha256=AtBG6SXL3KF_v0NxLf0ehyVOh0cold-JbJYXNGorC6Q,92
+opentf_toolkit_nightly-0.50.0.dev653.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
+opentf_toolkit_nightly-0.50.0.dev653.dist-info/RECORD,,

{opentf_toolkit_nightly-0.50.0.dev644.dist-info → opentf_toolkit_nightly-0.50.0.dev653.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.40.0)
+Generator: bdist_wheel (0.41.0)
 Root-Is-Purelib: true
 Tag: py3-none-any