opentf-toolkit-nightly 0.55.0.dev938__py3-none-any.whl → 0.55.0.dev950__py3-none-any.whl

opentf/commons/__init__.py

@@ -585,7 +585,10 @@ def is_uuid(uuid: str) -> bool:
 
 
 def make_status_response(
-    reason: str, message: str, details: Optional[Dict[str, Any]] = None
+    reason: str,
+    message: str,
+    details: Optional[Dict[str, Any]] = None,
+    silent: bool = False,
 ) -> Response:
     """Return a new status response object.
 
@@ -597,6 +600,7 @@ def make_status_response(
     # Optional parameters:
 
     - details: a dictionary or None (None by default)
+    - silent: a boolean (False by default)
 
     # Returned value
 
@@ -613,10 +617,11 @@ def make_status_response(
     - code: an integer (derived from `reason`)
     """
     code = REASON_STATUS[reason]
-    if code // 100 == 4:
-        logging.warning(message)
-    elif code // 100 == 5:
-        logging.error(message)
+    if not silent:
+        if code // 100 == 4:
+            logging.warning(message)
+        elif code // 100 == 5:
+            logging.error(message)
     return make_response(
         {
             'kind': 'Status',

opentf/commons/datasources.py

@@ -14,7 +14,8 @@
 
 """Test case metadata retrieval helpers"""
 
-from typing import Any, Dict, Generator, List, Optional, Set
+from typing import Any, Dict, List, Optional
+
 from collections import defaultdict
 
 from opentf.commons.expressions import evaluate_bool
@@ -68,17 +69,14 @@ def _as_list(what) -> List[str]:
 ## Datasource: Testcases
 
 
-def in_scope(expr: str, contexts: Dict[str, Any], scopes_errors: Set[str]) -> bool:
-    """Safely evaluate quality gate scope."""
+def in_scope(expr: str, contexts: Dict[str, Any]) -> bool:
+    """Safely evaluate datasource scope."""
     try:
         return evaluate_bool(expr, contexts)
     except ValueError as err:
-        msg = f'Invalid conditional {expr}: {err}.'
-        scopes_errors.add(msg)
+        raise ValueError(f'Invalid conditional {expr}: {err}.')
     except KeyError as err:
-        msg = f'Nonexisting context entry in expression {expr}: {err}.'
-        scopes_errors.add(msg)
-    return False
+        raise ValueError(f'Nonexisting context entry in expression {expr}: {err}.')
 
 
 def get_testresults(events: List[Dict[str, Any]]) -> List[Dict[str, Any]]:
@@ -300,10 +298,9 @@ def _get_timestamp(
 
 def _get_testresult_timestamps(
     events: List[Dict[str, Any]],
-    testresults: List[Dict[str, Any]],
-    testcase_metadata: Dict[str, Any],
+    testcases: Dict[str, Any],
 ):
-    """Set timestamp for each testcase in testcase_metadata.
+    """Set timestamp for each testcase in testcases.
 
     The timestamp is the one of the originating ProviderResult.
     """
@@ -314,19 +311,42 @@ def _get_testresult_timestamps(
     }
 
     origins_results = defaultdict(list)
-    for item in testresults:
-        for result in item['spec']['testResults']:
-            origins_results[result['attachment_origin']].append(result['id'])
+    for uuid, data in testcases.items():
+        origins_results[data['execution']].append(uuid)
 
     for event in filter(lambda event: event['kind'] == 'ExecutionResult', events):
         for attachment in event['metadata'].get('attachments', {}).values():
             if attachment['uuid'] in origins_results:
                 timestamp = _get_timestamp(event, providerid_creationtimestamps)
                 for result_id in origins_results[attachment['uuid']]:
-                    testcase_metadata[result_id]['timestamp'] = timestamp
+                    testcases[result_id]['timestamp'] = timestamp
 
 
-def get_testcases(events: List[Dict[str, Any]]) -> Dict[str, Dict[str, Any]]:
+def _make_testcase_from_testresult(
+    item: Dict[str, Any], execution_id: str, labels: Dict[str, Any], scope: str
+) -> Dict[str, Any]:
+    testcase = {
+        'name': item['name'],
+        'status': item['status'],
+        'duration': item.get('duration', 0),
+        'execution': execution_id,
+        'test': labels.copy(),
+    }
+    testcase['test']['status'] = item['status']
+    if item['status'] in FAILURE_STATUSES:
+        for key in DETAILS_KEYS:
+            if item.get(key):
+                testcase[key] = item[key]
+    if item.get('errorsList'):
+        testcase['errorsList'] = item['errorsList']
+    if not in_scope(scope, testcase):
+        return {}
+    return testcase
+
+
+def get_testcases(
+    events: List[Dict[str, Any]], scope: str = 'true'
+) -> Dict[str, Dict[str, Any]]:
     """Extract metadata for each test result.
 
     Test results are Notification events with a `.spec.testResults`
@@ -344,12 +364,13 @@ def get_testcases(events: List[Dict[str, Any]]) -> Dict[str, Dict[str, Any]]:
     - name: a string, the test case name
     - status: a string, the test case status
     - duration: a string, the test case execution time in ms
+    - execution: a string, the test case execution (=related attachment) uuid
     - timestamp: a string, provider creation timestamp
     - test: a dictionary, the test case metadata
     - failureDetails|errorDetails|warningDetails: a dictionary with test
       case failure details
-    - errorsList: a Robot Framework specific list with execution general
-      errors
+    - errorsList: a provider generated attachment specific list with execution general
+      errors (currently for Robot Framework only)
 
     `testcases` is a dictionary of entries like:
 
@@ -358,7 +379,8 @@ def get_testcases(events: List[Dict[str, Any]]) -> Dict[str, Dict[str, Any]]:
         "name": "<<<[Test suite#]Test case name>>>",
         "status": "<<<SUCCESS|FAILURE|ERROR|SKIPPED>>>",
         "duration": "<<<test execution time in ms>>>",
-        "timestamp": "<<<provider creation timestamp>>>"
+        "timestamp": "<<<provider creation timestamp>>>",
+        "execution": "<<<execution ID>>>",
         "test": {
             "job": "<<<job name>>>",
             "uses": "<<<provider function>>>",
@@ -384,39 +406,32 @@ def get_testcases(events: List[Dict[str, Any]]) -> Dict[str, Dict[str, Any]]:
     # Raised exceptions
 
     A _ValueError_ exception is raised if there were no test results in
-    `events`.
+    `events` or some scope errors occured retrieving test results.
     """
-    testcases = {}
-    results = False
     if _uses_inception(events):
         testresults = _get_inception_testresults(events)
     else:
         testresults = get_testresults(events)
 
+    if not testresults:
+        raise ValueError('No test results in events.')
+
+    testcases = {}
     for testresult in testresults:
-        results = True
-        labels = _get_testresult_labels(
-            testresult['metadata']['attachment_origin'][0], events
-        )
+        execution_id = testresult['metadata']['attachment_origin'][0]
+        labels = _get_testresult_labels(execution_id, events)
         if not labels:
             continue
-        for testcase in testresult['spec']['testResults']:
-            testcases[testcase['id']] = {
-                'name': testcase['name'],
-                'status': testcase['status'].lower(),
-                'duration': testcase.get('duration', 0),
-                'test': labels.copy(),
-            }
-            testcases[testcase['id']]['test']['status'] = testcase['status']
-            data = {}
-            if testcase['status'] in FAILURE_STATUSES:
-                data = {key: testcase[key] for key in DETAILS_KEYS if testcase.get(key)}
-            if testcase.get('errorsList'):
-                data['errorsList'] = testcase['errorsList']
-            testcases[testcase['id']].update(data)
-    if not results:
-        raise ValueError('No test results in events.')
-    _get_testresult_timestamps(events, testresults, testcases)
+        for item in testresult['spec']['testResults']:
+            if testcase := _make_testcase_from_testresult(
+                item, execution_id, labels, scope
+            ):
+                testcases[item['id']] = testcase
+    if not testcases:
+        raise ValueError(f'No test cases matching scope `{scope}`.')
+
+    _get_testresult_timestamps(events, testcases)
+
     return testcases
 
 
@@ -424,9 +439,7 @@ def get_testcases(events: List[Dict[str, Any]]) -> Dict[str, Dict[str, Any]]:
 ## Datasource: Tags
 
 
-def get_tags(
-    events: List[Dict[str, Any]], testcase_metadata: Optional[Dict[str, Any]] = None
-) -> Dict[str, Any]:
+def get_tags(events: List[Dict[str, Any]], scope: str = 'true') -> Dict[str, Any]:
     """Extract metadata for each execution environment tag.
 
     # Required parameters:
@@ -452,7 +465,7 @@ def get_tags(
     ```
     """
     try:
-        testcase_metadata = testcase_metadata or get_testcases(events)
+        testcase_metadata = get_testcases(events, scope)
     except ValueError as err:
         raise ValueError(str(err) + ' Cannot extract metadata for tags.')
     tags = {}
@@ -471,7 +484,7 @@ def get_tags(
 ## Datasource: Jobs
 
 
-def _evaluate_test_results(jobs_testcases: Dict[str, Any]) -> Dict[str, Any]:
+def _evaluate_test_results(jobs_testcases: Dict[str, Any]) -> Dict[str, Dict[str, int]]:
     """Summarize job testcases.
 
     # Returned value
@@ -494,9 +507,7 @@ def _evaluate_test_results(jobs_testcases: Dict[str, Any]) -> Dict[str, Any]:
     return summaries
 
 
-def get_jobs(
-    events: List[Dict[str, Any]], testcase_metadata: Optional[Dict[str, Any]] = None
-) -> Dict[str, Any]:
+def get_jobs(events: List[Dict[str, Any]], scope: str = 'true') -> Dict[str, Any]:
     """Extract metadata for each job.
 
     # Required parameters:
@@ -534,7 +545,7 @@ def get_jobs(
     ```
     """
     try:
-        testcase_metadata = testcase_metadata or get_testcases(events)
+        testcase_metadata = get_testcases(events, scope)
     except ValueError as err:
         raise ValueError(str(err) + ' Cannot extract metadata for jobs.')
     jobs_testcases = _get_sorted_testcases(testcase_metadata, ['test', 'job'])
@@ -555,7 +566,7 @@ def get_jobs(
             job['metadata']['name'],
             {
                 'runs-on': job['runs-on'],
-                'counts': {k.lower(): v for k, v in results[job_name].items()},
+                'counts': results[job_name],
                 'variables': {
                     name: value for name, value in job.get('variables', {}).items()
                 },

{opentf_toolkit_nightly-0.55.0.dev938.dist-info → opentf_toolkit_nightly-0.55.0.dev950.dist-info}/METADATA

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

{opentf_toolkit_nightly-0.55.0.dev938.dist-info → opentf_toolkit_nightly-0.55.0.dev950.dist-info}/RECORD

@@ -1,7 +1,7 @@
-opentf/commons/__init__.py,sha256=ITzg1zfZgA5-4wvmJfjLN94_Z06HeMl0szd6dalrrKY,21839
+opentf/commons/__init__.py,sha256=KRY8ShQw_0ZZ0oEOiKi4-xnWofE_QsFjEe1T8wUxJ-w,21952
 opentf/commons/auth.py,sha256=bM2Z3kxm2Wku1lKXaRAIg37LHvXWAXIZIqjplDfN2P8,15899
 opentf/commons/config.py,sha256=GmvInVnUsXIwlNfgTQeQ_pPs97GeGTGn2S2QZEFwss8,7828
-opentf/commons/datasources.py,sha256=OkPp0allFp-G9qBkU4Fxc6aGiytkMO3Xr3KLl4E5zWM,18234
+opentf/commons/datasources.py,sha256=EIssc6CyC8s5FYVZtdEo7IpCQxX92mFntYWmsoO62go,18412
 opentf/commons/expressions.py,sha256=A68F27Our8oVVphUrRvB5haSlqj2YCrH2OxHPNLBio4,19251
 opentf/commons/pubsub.py,sha256=7khxAHVZiwJRcwIBJ6MPR-f3xY9144-2eNLROwq5F-4,5894
 opentf/commons/schemas.py,sha256=lokZCU-wmsIkzVA-TVENtC7Io_GmYxrP-FQaOOowg4s,4044
@@ -48,8 +48,8 @@ opentf/scripts/startup.py,sha256=Da2zo93pBWbdRmj-wgekgLcF94rpNc3ZkbvR8R0w8XY,212
 opentf/toolkit/__init__.py,sha256=g3DiTZlSvvzZWKgM8qU47muLqjQrpWZ6M6PWZ-sBsvQ,19610
 opentf/toolkit/channels.py,sha256=Cng3b4LUsxvCHUbp_skys9CFcKZMfcKhA_ODg_EAlIE,17156
 opentf/toolkit/core.py,sha256=L1fT4YzwZjqE7PUXhJL6jSVQge3ohBQv5UBb9DAC6oo,9320
-opentf_toolkit_nightly-0.55.0.dev938.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-opentf_toolkit_nightly-0.55.0.dev938.dist-info/METADATA,sha256=1FipCBdX1nal-7wQEMhR1QrdYvJUuPMAGcEPjLAzDco,1945
-opentf_toolkit_nightly-0.55.0.dev938.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-opentf_toolkit_nightly-0.55.0.dev938.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
-opentf_toolkit_nightly-0.55.0.dev938.dist-info/RECORD,,
+opentf_toolkit_nightly-0.55.0.dev950.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opentf_toolkit_nightly-0.55.0.dev950.dist-info/METADATA,sha256=gT2hqExdA5awFpPmq43fIso434TuFdAQOrSlqz1EsG4,1945
+opentf_toolkit_nightly-0.55.0.dev950.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+opentf_toolkit_nightly-0.55.0.dev950.dist-info/top_level.txt,sha256=_gPuE6GTT6UNXy1DjtmQSfCcZb_qYA2vWmjg7a30AGk,7
+opentf_toolkit_nightly-0.55.0.dev950.dist-info/RECORD,,