Updates for XPATH Queries

Author: kaleanych

ted_sws/core/model/manifestation.py

@@ -35,6 +35,7 @@ class SPARQLQueryRefinedResultType(Enum):
     INVALID = "invalid"
     ERROR = "error"
     WARNING = "warning"
+    UNKNOWN = "unknown"
 
 
 class Manifestation(PropertyBaseModel):
@@ -224,6 +225,7 @@ class SPARQLQueryResult(PropertyBaseModel):
     fields_covered: Optional[bool] = True
     missing_fields: Optional[List[str]] = []
     error: Optional[str]
+    message: Optional[str]
     identifier: Optional[str]
 
     class Config:

ted_sws/core/model/validation_report.py

@@ -30,6 +30,7 @@ class SPARQLValidationSummaryCountReport(PropertyBaseModel):
     warning: Optional[QueryValidationSummaryCountReportStatus] = QueryValidationSummaryCountReportStatus()
     invalid: Optional[QueryValidationSummaryCountReportStatus] = QueryValidationSummaryCountReportStatus()
     error: Optional[QueryValidationSummaryCountReportStatus] = QueryValidationSummaryCountReportStatus()
+    unknown: Optional[QueryValidationSummaryCountReportStatus] = QueryValidationSummaryCountReportStatus()
 
 
 class SPARQLSummaryQuery(PropertyBaseModel):

ted_sws/mapping_suite_processor/services/conceptual_mapping_generate_sparql_queries.py

@@ -26,13 +26,15 @@
 SPARQL_PREFIX_LINE = 'PREFIX {prefix}: <{value}>'
 SPARQL_LOGGER_NAME = "SPARQL"
 
+SPARQL_XPATH_SEPARATOR = " ;; "
+
 
 def get_sparql_prefixes(sparql_q: str) -> list:
     finds: list = re.findall(SPARQL_PREFIX_PATTERN, sparql_q)
     return sorted(set(finds))
 
 
-def concat_field_xpath(base_xpath: str, field_xpath: str, separator: str = ", ") -> str:
+def concat_field_xpath(base_xpath: str, field_xpath: str, separator: str = SPARQL_XPATH_SEPARATOR) -> str:
     base_xpath = base_xpath if not pd.isna(base_xpath) else ''
     field_xpath = field_xpath if not pd.isna(field_xpath) else ''
     return separator.join(
@@ -137,7 +139,7 @@ def sparql_validation_generator(data: pd.DataFrame, base_xpath: str, controlled_
               f"{e_form_bt_name}” in eForms. The corresponding XML element is " \
               f"{concat_field_xpath(base_xpath, field_xpath)}. " \
               f"The expected ontology instances are epo: {class_path} .\n" \
-              f"#xpath: {concat_field_xpath(base_xpath, field_xpath, separator=',')}" \
+              f"#xpath: {concat_field_xpath(base_xpath, field_xpath, separator=SPARQL_XPATH_SEPARATOR)}" \
               "\n" + "\n" + "\n".join(prefixes) + "\n\n" \
                                                   f"ASK WHERE {{ " \
                                                   f"{subject_type_display}" \

ted_sws/notice_validator/resources/templates/sparql_query_results_report.jinja2

@@ -124,7 +124,7 @@
             </tr>
             </thead>
             <tbody>
-            {% for _value in ['valid', 'unverifiable', 'warning', 'invalid', 'error']  %}
+            {% for _value in ['valid', 'unverifiable', 'warning', 'invalid', 'error', 'unknown']  %}
             <tr>
                 {% set _results = validation_results | selectattr("result", "equalto", _value) | list | count %}
                 <td class="strong {{ _value }}">{{ _value }}</td>
@@ -187,8 +187,16 @@
                         </ol>
                         </li>
                     {% endif %}
+                    {% if result.message and (result.message|length > 0) %}
+                        <li>
+                            <hr>
+                            <h4 class="info strong">MESSAGE:</h4>
+                            {{ result.message }}
+                        </li>
+                    {% endif %}
                     {% if result.error and (result.error|length > 0) %}
                         <li>
+                            <hr>
                             <h4 class="danger strong">ERROR:</h4>
                             {{ result.error }}
                         </li>

ted_sws/notice_validator/resources/templates/sparql_summary_report.jinja2

@@ -1,4 +1,4 @@
-{% set result_values = ['valid', 'unverifiable', 'warning', 'invalid', 'error'] %}
+{% set result_values = ['valid', 'unverifiable', 'warning', 'invalid', 'error', 'unknown'] %}
 
 <!DOCTYPE html>
 <html lang="en">

ted_sws/notice_validator/services/sparql_test_suite_runner.py

@@ -12,6 +12,7 @@
     ReportNotice
 from ted_sws.core.model.validation_report_data import ReportPackageNoticeData
 from ted_sws.data_manager.adapters.repository_abc import NoticeRepositoryABC, MappingSuiteRepositoryABC
+from ted_sws.mapping_suite_processor.services.conceptual_mapping_generate_sparql_queries import SPARQL_XPATH_SEPARATOR
 from ted_sws.notice_transformer.adapters.notice_transformer import NoticeTransformer
 from ted_sws.notice_validator.adapters.sparql_runner import SPARQLRunner
 from ted_sws.notice_validator.resources.templates import TEMPLATE_METADATA_KEY
@@ -58,8 +59,9 @@ def _sparql_query_from_file_resource(cls, file_resource: FileResource) -> SPARQL
             if QUERY_METADATA_TITLE in metadata else DEFAULT_QUERY_TITLE
         description = metadata[QUERY_METADATA_DESCRIPTION] \
             if QUERY_METADATA_DESCRIPTION in metadata else DEFAULT_QUERY_DESCRIPTION
-        xpath = metadata[QUERY_METADATA_XPATH].split(",") if QUERY_METADATA_XPATH in metadata and metadata[
-            QUERY_METADATA_XPATH] else DEFAULT_QUERY_XPATH
+        xpath = metadata[QUERY_METADATA_XPATH].split(
+            SPARQL_XPATH_SEPARATOR
+        ) if QUERY_METADATA_XPATH in metadata and metadata[QUERY_METADATA_XPATH] else DEFAULT_QUERY_XPATH
         query = cls._sanitize_query(file_resource.file_content)
         return SPARQLQuery(title=title, description=description, xpath=xpath, query=query)
 
@@ -223,6 +225,9 @@ def generate_sparql_validation_summary_report(report_notices: List[ReportNotice]
                 elif validation.result == SPARQLQueryRefinedResultType.ERROR.value:
                     validation_query_result.aggregate.error.count += 1
                     validation_query_result.aggregate.error.notices.append(notice_data)
+                elif validation.result == SPARQLQueryRefinedResultType.UNKNOWN.value:
+                    validation_query_result.aggregate.unknown.count += 1
+                    validation_query_result.aggregate.unknown.notices.append(notice_data)
 
                 if not found_validation_query_result:
                     report.validation_results.append(validation_query_result)