labfreed 0.2.6a2__py3-none-any.whl → 0.2.6a4__py3-none-any.whl

labfreed/__init__.py

@@ -2,7 +2,7 @@
 Python implementation of LabFREED building blocks
 '''
 
-__version__ = "0.2.6a2"
+__version__ = "0.2.6a4"
 
 from labfreed.pac_id import *  # noqa: F403
 from labfreed.pac_cat import * # noqa: F403

labfreed/labfreed_infrastructure.py

@@ -194,9 +194,9 @@ class LabFREED_BaseModel(PDOC_Workaround_Base):
         formatted_msg = list()
         for m in self.validation_messages():
             if m.level == ValidationMsgLevel.ERROR:
-                color = 'red'
+                color = '#d70000'
             else:
-                color = 'orange'
+                color = '#d78700'
                 
             match target:
                 case 'markdown':
@@ -218,7 +218,7 @@ class LabFREED_BaseModel(PDOC_Workaround_Base):
                     br = '<br>'
                 
             serialized = str(self)
-            serialized.replace('\n', br)
+            serialized = serialized.replace('\n', br)
             emphazised_highlight = self._emphasize_in(m, serialized, fmt=fmt)
             emphazised_highlight = emphazised_highlight.replace('👈👉','') # removes two consecutive markers, to make it cleaner
             

labfreed/pac_id_resolver/cit_common.py

@@ -0,0 +1,82 @@
+from enum import Enum
+import re
+from labfreed.labfreed_infrastructure import LabFREED_BaseModel, ValidationMsgLevel, _quote_texts
+
+
+
+class ServiceType(Enum):
+    USER_HANDOVER_GENERIC = 'userhandover-generic'
+    ATTRIBUTE_SERVICE_GENERIC = 'attributes-generic'
+
+
+def _validate_service_name(service_name):
+    msg_dict = []
+    if not_allowed_chars := set(re.sub(r'[A-Za-z0-9\-\x20]', '', service_name)):
+        msg_dict.append( {
+                "level": ValidationMsgLevel.ERROR,
+                "msg": f'Service name ontains invalid characters {_quote_texts(not_allowed_chars)}',
+                "highlight_sub": not_allowed_chars
+            }
+        )
+    
+    if len(service_name) == 0 or len(service_name) > 255:
+        msg_dict.append( {
+                "level": ValidationMsgLevel.ERROR,
+                "msg": 'Service name must be at least one and maximum 255 characters long'
+            }
+        )
+    return msg_dict
+        
+    
+def _validate_application_intent(intent):
+    msg_dict = []
+    if re.fullmatch('.*-generic$',  intent):
+        msg_dict.append( {
+                "level": ValidationMsgLevel.ERROR,
+                "msg": "Application intent ends with '-generic'. This is not permitted, since it is reserved for future uses'",
+                "highlight_sub": [intent]
+            }
+        )
+
+    if not_allowed_chars := set(re.sub(r'[A-Za-z0-9\-]', '', intent)):
+        msg_dict.append( {
+                "level": ValidationMsgLevel.ERROR,
+                "msg": f'Application intent contains invalid characters {_quote_texts(not_allowed_chars)}',
+                "highlight_sub": not_allowed_chars
+            }
+        )
+        
+    if len(intent) == 0 or len(intent) > 255:
+        msg_dict.append( {
+                "level": ValidationMsgLevel.ERROR,
+                "source": f'Application intent  {intent}',
+                "msg": 'Must be at least one and maximum 255 characters long'
+            }
+        )
+    return msg_dict
+
+    
+def _validate_service_type(service_type):
+    msg_dict = []
+    if isinstance(service_type, ServiceType):
+            service_type= service_type.value
+    else:
+        service_type= service_type
+    allowed_types = [ServiceType.ATTRIBUTE_SERVICE_GENERIC.value, ServiceType.USER_HANDOVER_GENERIC.value]
+    if service_type not in allowed_types:
+        msg_dict.append( {
+                "level": ValidationMsgLevel.ERROR,
+                "msg": f'Invalid service type. Must be {_quote_texts(allowed_types)} must be at least one and maximum 255 characters long',
+                "highlight_sub": service_type
+            }
+        )
+    return msg_dict
+
+
+def _add_msg_to_cit_entry_model(msg_dict, model):
+    for m in msg_dict:
+        m.update({"source": model.service_name})
+        model._add_validation_message(**m)
+    return model
+    
+   

labfreed/pac_id_resolver/cit_v1.py

@@ -2,23 +2,73 @@
 from enum import Enum
 import logging
 import re
+import traceback
 
-from pydantic import Field
+from pydantic import Field, model_validator
 from labfreed.labfreed_infrastructure import LabFREED_BaseModel, ValidationMessage, ValidationMsgLevel
 from labfreed.pac_id.pac_id import PAC_ID
 from labfreed.pac_id_resolver.services import Service, ServiceGroup
+from labfreed.pac_id_resolver.cit_common import ( _add_msg_to_cit_entry_model, 
+                                                 _validate_service_name, 
+                                                 _validate_application_intent, 
+                                                 _validate_service_type,
+                                                 ServiceType)
 
-class ServiceType(Enum):
-    USER_HANDOVER_GENERIC = 'userhandover-generic'
-    ATTRIBUTE_SERVICE_GENERIC = 'attributes-generic'
 
 
 class CITEntry_v1(LabFREED_BaseModel):
     applicable_if: str = Field(..., min_length=1)
     service_name: str = Field(..., min_length=1)
     application_intent:str = Field(..., min_length=1)
-    service_type:ServiceType
+    service_type:ServiceType|str
     template_url:str = Field(..., min_length=1)
+    
+    
+    @model_validator(mode='after')
+    def _validate_model(self):
+        if self.applicable_if:
+            conditions = self.applicable_if.split(';')
+            for c in conditions:
+                if '=' in c:
+                    query, expected = c.split('=')
+                    query = query.strip()                      
+                else:
+                    query = c.strip()
+                    
+                try:
+                    # use this function to check if the pattern is valid. it returns a PatternError if not
+                    _find_pattern_in_pac(query, '')
+                except PatternError:
+                    self._add_validation_message(
+                        level=ValidationMsgLevel.ERROR,
+                        source=f'Service {self.service_name}',
+                        msg=f'Applicable if contains invalid pattern {query}',
+                        highlight_sub=query
+                    )
+                except Exception:
+                    pass # if no PatternError everything is fine
+        return self
+    
+    @model_validator(mode='after')
+    def _validate_service_name(self):
+        msg_dict= _validate_service_name(self.service_name)
+        return _add_msg_to_cit_entry_model(msg_dict, self)
+    
+    
+    @model_validator(mode='after')
+    def _validate_application_intent(self):
+        msg_dict= _validate_application_intent(self.application_intent)
+        return _add_msg_to_cit_entry_model(msg_dict, self)
+    
+    
+    @model_validator(mode='after')
+    def _validate_service_type(self):
+        msg_dict= _validate_service_type(self.service_type)
+        return _add_msg_to_cit_entry_model(msg_dict, self)
+    
+    
+    
+    
 
 
 class CIT_v1(LabFREED_BaseModel):
@@ -40,11 +90,34 @@ class CIT_v1(LabFREED_BaseModel):
                 continue
             
             cols = [c.strip() for c in line.split('\t')]
+            if len(cols) < 5:
+                logging.error(f'invalid line {line}')
+                msg = ValidationMessage(
+                    level=ValidationMsgLevel.ERROR,
+                    source='CIT line',
+                    source_id=0,
+                    msg=f'Invalid line in CIT. There are {5 - len(cols)} columns missing.',
+                    highlight_sub_patterns=line
+                )
+                errors.append(msg)
+                continue
+            if len(cols) > 5:
+                logging.error(f'invalid line {line}')
+                msg = ValidationMessage(
+                    level=ValidationMsgLevel.ERROR,
+                    source='CIT line',
+                    source_id=0,
+                    msg=f'Invalid line in CIT. There are {len(cols) -5} too many columns',
+                    highlight_sub_patterns=line
+                )
+                errors.append(msg)
+                continue
             try:
+                
                 entry = CITEntry_v1(
                                     service_name         = cols[0],
                                     application_intent   = cols[1],
-                                    service_type         = ServiceType(cols[2]),
+                                    service_type         = cols[2],
                                     applicable_if        = cols[3],
                                     template_url         = cols[4]
                                     )
@@ -52,23 +125,32 @@ class CIT_v1(LabFREED_BaseModel):
             except ValueError:
                 logging.error(f'invalid line {line}')
                 msg = ValidationMessage(
-                    level=ValidationMsgLevel.WARNING,
+                    level=ValidationMsgLevel.ERROR,
                     source='CIT line',
                     source_id=0,
-                    msg='Invalid line in CIT. Line was ignored. Remaining CIT is functional.',
+                    msg='Invalid line in CIT.',
                     highlight_sub_patterns=line
                 )
                 errors.append(msg)
 
-                      
         cit = CIT_v1(origin=origin, entries=entries)
+        if not cit.is_valid:
+            errors.insert(0, 
+                          ValidationMessage(
+                                level=ValidationMsgLevel.WARNING,
+                                source='CIT ',
+                                source_id=0,
+                                msg='Invalid lines in CIT. The lines were ignored. The rest of the CIT is still functional',
+                                highlight_sub_patterns=''
+                          )
+            )
         cit._validation_messages.extend(errors)
         cit._csv_original = csv
         return cit
     
     def evaluate_pac_id(self, pac:PAC_ID):
-        if not type(pac) is PAC_ID:
-            raise ValueError(f'CIT v1 does only handle PAC-IDs. PAC-CAT it does not know what to do')
+        if type(pac) is not PAC_ID:
+            raise ValueError('CIT v1 does only handle PAC-IDs. PAC-CAT it does not know what to do')
         cit_evaluated = ServiceGroup(origin=self.origin)   
         for e in self.entries:
             conditions = e.applicable_if.split(';')
@@ -76,18 +158,18 @@ class CIT_v1(LabFREED_BaseModel):
             for c in conditions:
                 if '=' in c:
                     query, expected = c.split('=')
-                    value = self._find_in_pac(query.strip(), pac)
+                    value = _find_pattern_in_pac(query.strip(), pac)
                     conditions_evaluated.append(value == expected.strip())
                 else:
                     query = c.strip()
-                    found = self._find_in_pac(query, pac)
+                    found = _find_pattern_in_pac(query, pac)
                     conditions_evaluated.append(found)
             is_applicable = all(conditions_evaluated)
                     
             if not is_applicable:
                 continue
 
-            url = re.sub(r"\{([^}]+)\}", lambda v: self._find_in_pac(v.group(0), pac), e.template_url)
+            url = re.sub(r"\{([^}]+)\}", lambda v: _find_pattern_in_pac(v.group(0), pac), e.template_url)
             cit_evaluated.services.append(Service(  
                                                     service_name=e.service_name,
                                                     application_intents= [ e.application_intent ],
@@ -97,49 +179,7 @@ class CIT_v1(LabFREED_BaseModel):
                             )            
         return cit_evaluated
     
-    def _find_in_pac(self, value, pac:PAC_ID):
-        pac_url =pac.to_url()
-        if value == '{isu}':
-            return pac.issuer
-        
-        elif value == '{pac}':
-            return pac_url.split('*')[0]
-        
-        elif value == '{id}':
-            m = re.match(r'^HTTPS://.+?/(.+?)(\*.*)*$', pac_url)
-            return m.group(1) if m else None
-        
-        elif m := re.match(r'\{idSeg(\d+)\}', value):
-            i = int(m.group(1)) - 1 # CIT is 1 based
-            seg = pac.identifier[i] if i < len(pac.identifier) else None
-            if seg:
-                return f"{(seg.key + ':') if seg.key else ''}{seg.value}"
-            
-        elif m := re.match(r'\{idVal(\w+)\}', value):
-            k = m.group(1)
-            seg = [s for s in pac.identifier if s.key and s.key == k]
-            if seg:
-                seg = seg[0]
-                return seg.value   
-            else:
-                return None 
-            
-        elif value == '{ext}':
-            m = re.match(r'^.*?(\*.*)*$', pac_url)
-            ext_str = m.group(1) if m else None
-            return m.group(1)[1:] if ext_str else None
-        
-        elif m := re.match(r'\{ext(\d+)\}', value):
-            i = int(m.group(1)) - 1 # CIT is 1 based
-            extensions = pac_url.split('*') 
-            extensions.pop(0)# first element is not extension
-            return extensions[i] if i < len(extensions) else None
-        else:
-            return None
-                
-
-            
-        
+  
     
     def __str__(self):
         if csv:=self._csv_original:
@@ -150,3 +190,56 @@ class CIT_v1(LabFREED_BaseModel):
         for e in self.entries:
             s += '\t'.join([e.service_name, e.application_intent, e.service_type.value, e.applicable_if, e.template_url]) + '\n'
         return s
+
+
+
+def _find_pattern_in_pac(value, pac:PAC_ID|str):
+    if not isinstance(pac, str):
+        pac_url =pac.to_url()
+    else:
+        pac_url = pac
+        
+    if value == '{isu}':
+        return pac.issuer
+    
+    elif value == '{pac}':
+        return pac_url.split('*')[0]
+    
+    elif value == '{id}':
+        m = re.match(r'^HTTPS://.+?/(.+?)(\*.*)*$', pac_url)
+        return m.group(1) if m else None
+    
+    elif m := re.match(r'\{idSeg(\d+)\}', value):
+        i = int(m.group(1)) - 1 # CIT is 1 based
+        seg = pac.identifier[i] if i < len(pac.identifier) else None
+        if seg:
+            return f"{(seg.key + ':') if seg.key else ''}{seg.value}"
+        
+    elif m := re.match(r'\{idVal(\w+)\}', value):
+        k = m.group(1)
+        seg = [s for s in pac.identifier if s.key and s.key == k]
+        if seg:
+            seg = seg[0]
+            return seg.value   
+        else:
+            return None 
+        
+    elif value == '{ext}':
+        m = re.match(r'^.*?(\*.*)*$', pac_url)
+        ext_str = m.group(1) if m else None
+        return m.group(1)[1:] if ext_str else None
+    
+    elif m := re.match(r'\{ext(\d+)\}', value):
+        i = int(m.group(1)) - 1 # CIT is 1 based
+        extensions = pac_url.split('*') 
+        extensions.pop(0)# first element is not extension
+        return extensions[i] if i < len(extensions) else None
+    else:
+        raise PatternError(f'{value} is not a recognized pattern for applicable if')
+    
+class PatternError(ValueError):
+    pass
+            
+
+        
+    

labfreed/pac_id_resolver/cit_v2.py

@@ -9,6 +9,12 @@ import jsonpath_ng.ext as jsonpath
 
 from labfreed.pac_id_resolver.services import Service, ServiceGroup
 from labfreed.labfreed_infrastructure import LabFREED_BaseModel, ValidationMsgLevel, _quote_texts
+from labfreed.pac_id_resolver.cit_common import ( _add_msg_to_cit_entry_model, 
+                                                 _validate_service_name, 
+                                                 _validate_application_intent, 
+                                                 _validate_service_type,
+                                                 ServiceType)
+
 
 __all__ = [
     "CIT_v2",
@@ -16,9 +22,6 @@ __all__ = [
     "CITEntry_v2"
 ]
 
-class ServiceType(Enum):
-    USER_HANDOVER_GENERIC = 'userhandover-generic'
-    ATTRIBUTE_SERVICE_GENERIC = 'attributes-generic'
 
 
 class CITEntry_v2(LabFREED_BaseModel):

{labfreed-0.2.6a2.dist-info → labfreed-0.2.6a4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: labfreed
-Version: 0.2.6a2
+Version: 0.2.6a4
 Summary: Python implementation of LabFREED building blocks
 Author-email: Reto Thürer <thuerer.r@buchi.com>
 Requires-Python: >=3.11

{labfreed-0.2.6a2.dist-info → labfreed-0.2.6a4.dist-info}/RECORD

@@ -1,5 +1,5 @@
-labfreed/__init__.py,sha256=5JS9oL9Mhmmw9OKT1GKsdngscLXm_eZ5TdM3fkc08wM,338
-labfreed/labfreed_infrastructure.py,sha256=2XxSe3Tmc9aiRjlJL7VjXi6gM3IfXOJfmWroc-JmV8M,10054
+labfreed/__init__.py,sha256=wKahqMhTOvdvcU9M6ARgaUBWlM0qEwE7q5qixgJXVsY,338
+labfreed/labfreed_infrastructure.py,sha256=EPDSCaGxWakAoPpHyc6ltf-pOuKyS5829lj_EG6wa74,10072
 labfreed/pac_cat/__init__.py,sha256=KNPtQzBD1XVohvG_ucOs7RJj-oi6biUTGB1k-T2o6pk,568
 labfreed/pac_cat/category_base.py,sha256=lFQNiTUukyhWdaSCAI7CZxLtj6kNtnBCE4UsePwsGqE,1801
 labfreed/pac_cat/pac_cat.py,sha256=AJUYDsyGOHy-sRRpXpY0awtbf3HCvn3RhMax6ofvYRA,5318
@@ -11,8 +11,9 @@ labfreed/pac_id/pac_id.py,sha256=IWXYlKFjQKB_9U5bINWC5_Lb5pcVbuleocvGs79A28w,530
 labfreed/pac_id/url_parser.py,sha256=TAQHxFf7Li8GA517mfOivmnJAJgh782oaSDzmOOkyTE,5942
 labfreed/pac_id/url_serializer.py,sha256=3D5pwcAP4ZrCQ22BRtxIwqWrFtZuY9913hCLPJNeyPI,2845
 labfreed/pac_id_resolver/__init__.py,sha256=RNBlrDOSR42gmSNH9wJVhK_xwEX45cvTKVgWW2bjh7Q,113
-labfreed/pac_id_resolver/cit_v1.py,sha256=SAI6W9FgJV4wirDN1CZqYKy6wCI8bkHgHmhgnp9vMU8,5965
-labfreed/pac_id_resolver/cit_v2.py,sha256=J7KsYUKSz4k7lqSHmLnouRY-etEbwmcj35O5SqVRm-o,11594
+labfreed/pac_id_resolver/cit_common.py,sha256=xEkSSumj_IYgnXn3yKvoTBbgExnIfPY7E-RHU-7pcX8,2905
+labfreed/pac_id_resolver/cit_v1.py,sha256=cC-fGWmPxhUMylZYn3MBDrr9Ds1oL6-j88Pw03csB9k,9436
+labfreed/pac_id_resolver/cit_v2.py,sha256=NCJqhYH5viF6iFCmryHhoQXmuKAyFMxgHvvzo4eBAgI,11838
 labfreed/pac_id_resolver/resolver.py,sha256=SQlATlaUsmS6EZlEMyBQsp00ixpN3r-3V5pMXcvHYCw,2739
 labfreed/pac_id_resolver/services.py,sha256=TPoH6YlSwa0hmawHpOiMwIpBAinhoRhMSoexop0YscI,2462
 labfreed/qr/__init__.py,sha256=fdKwP6W2Js--yMbBUdn-g_2uq2VqPpfQJeDLHsMDO-Y,61
@@ -38,7 +39,7 @@ labfreed/well_known_keys/labfreed/well_known_keys.py,sha256=nqk66kHdSwJTJfMKlP-x
 labfreed/well_known_keys/unece/UneceUnits.json,sha256=kwfQSp_nTuWbADfBBgqTWrvPl6XtM5SedEVLbMJrM7M,898953
 labfreed/well_known_keys/unece/__init__.py,sha256=MSP9lmjg9_D9iqG9Yq2_ajYfQSNS9wIT7FXA1c--59M,122
 labfreed/well_known_keys/unece/unece_units.py,sha256=gNDQk6KGl-nGMf9Ycq_fQ8P2xxKITgLkcQWPd4H49gI,1630
-labfreed-0.2.6a2.dist-info/licenses/LICENSE,sha256=gHFOv9FRKHxO8cInP3YXyPoJnuNeqrvcHjaE_wPSsQ8,1100
-labfreed-0.2.6a2.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-labfreed-0.2.6a2.dist-info/METADATA,sha256=yWuY2nBPwWR4OQYG01HmNw30yOLNKZuYaXwN45x5ia8,18616
-labfreed-0.2.6a2.dist-info/RECORD,,
+labfreed-0.2.6a4.dist-info/licenses/LICENSE,sha256=gHFOv9FRKHxO8cInP3YXyPoJnuNeqrvcHjaE_wPSsQ8,1100
+labfreed-0.2.6a4.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+labfreed-0.2.6a4.dist-info/METADATA,sha256=WvHpUfPKFYz537qACQir3e4tmkngdiHU6E_7APE-jg8,18616
+labfreed-0.2.6a4.dist-info/RECORD,,