mustrd 0.2.6__tar.gz → 0.2.6.2__tar.gz

{mustrd-0.2.6 → mustrd-0.2.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mustrd
-Version: 0.2.6
+Version: 0.2.6.2
 Summary: A Spec By Example framework for RDF and SPARQL, Inspired by Cucumber.
 Home-page: https://github.com/Semantic-partners/mustrd
 License: MIT
@@ -42,7 +42,7 @@ Description-Content-Type: text/markdown
 # mustrd
 
 
-[<img src="https://github.com/Semantic-partners/mustrd/raw/python-coverage-comment-action-data/badge.svg" alt="coverage badge">](https://github.com/Semantic-partners/mustrd/tree/python-coverage-comment-action-data)
+[<img src="https://github.com/Semantic-partners/mustrd/raw/python-coverage-comment-action-data/badge.svg?sanitize=true" alt="coverage badge">](https://github.com/Semantic-partners/mustrd/tree/python-coverage-comment-action-data)
 
 ### Why?
 

{mustrd-0.2.6 → mustrd-0.2.6.2}/README.md

@@ -1,7 +1,7 @@
 # mustrd
 
 
-[<img src="https://github.com/Semantic-partners/mustrd/raw/python-coverage-comment-action-data/badge.svg" alt="coverage badge">](https://github.com/Semantic-partners/mustrd/tree/python-coverage-comment-action-data)
+[<img src="https://github.com/Semantic-partners/mustrd/raw/python-coverage-comment-action-data/badge.svg?sanitize=true" alt="coverage badge">](https://github.com/Semantic-partners/mustrd/tree/python-coverage-comment-action-data)
 
 ### Why?
 

mustrd-0.2.6.2/mustrd/README.adoc

@@ -0,0 +1,33 @@
+= Developer helper
+// tag::body[]
+
+== Try it out
+
+Ensure you have python3 installed, before you begin.
+To install the necessary dependencies, run the following command from the project root.
+
+`pip3 install  -r requirements.txt`
+
+Run the following command to execute the accompanying tests specifications.
+
+`python3 src/run.py -v -p "test/test-specs" -g "test/data" -w "test/data" -t "test/data"`
+
+You will see some warnings. Do not worry, some tests specifications are invalid and intentionally skipped.
+
+For a brief explanation of the meaning of these options use the help option.
+
+`python3 src/run.py --help`
+
+== Run the tests
+
+Run `pytest` from the project root.
+
+== Additional Notes for Developers
+Mustrd remains very much under development. It is anticipated that additional functionality and triplestore support will be added over time. The project uses https://python-poetry.org/docs/[Poetry] to manage dependencies so it will be necessary to have this installed to contribute towards the project. The link contains instructions on how to install and use this.
+As the project is actually built from the requirements.txt file at the project root, it is necessary to export dependencies from poetry to this file before committing and pushing changes to the repository, using the following command.
+
+`poetry export -f requirements.txt --without-hashes > requirements.txt`
+
+
+
+// end::body[]

{mustrd-0.2.6 → mustrd-0.2.6.2}/mustrd/mustrd.py

@@ -636,6 +636,30 @@ def get_then_update(spec_uri: URIRef, spec_graph: Graph) -> Graph:
 
     return expected_results
 
+def write_result_diff_to_log(res):
+    if isinstance(res, UpdateSpecFailure) or isinstance(res, ConstructSpecFailure):
+        log.info(f"{Fore.RED}Failed {res.spec_uri} {res.triple_store}")
+        log.info(f"{Fore.BLUE} In Expected Not In Actual:")
+        log.info(res.graph_comparison.in_expected_not_in_actual.serialize(format="ttl"))
+        log.info(f"{Fore.RED} in_actual_not_in_expected")
+        log.info(res.graph_comparison.in_actual_not_in_expected.serialize(format="ttl"))
+        log.info(f"{Fore.GREEN} in_both")
+        log.info(res.graph_comparison.in_both.serialize(format="ttl"))
+
+    if isinstance(res, SelectSpecFailure):
+        log.info(f"{Fore.RED}Failed {res.spec_uri} {res.triple_store}")
+        log.info(res.message)
+        log.info(res.table_comparison.to_markdown())
+    if isinstance(res, SpecPassedWithWarning):
+        log.info(f"{Fore.YELLOW}Passed with warning {res.spec_uri} {res.triple_store}")
+        log.info(res.warning)
+    if isinstance(res, TripleStoreConnectionError) or isinstance(res, SparqlExecutionError) or \
+            isinstance(res, SparqlParseFailure):
+        log.info(f"{Fore.RED}Failed {res.spec_uri} {res.triple_store}")
+        log.info(res.exception)
+    if isinstance(res, SpecSkipped):
+        log.info(f"{Fore.YELLOW}Skipped {res.spec_uri} {res.triple_store}")
+        log.info(res.message)
 
 def calculate_row_difference(df1: pandas.DataFrame,
                              df2: pandas.DataFrame) -> pandas.DataFrame:

{mustrd-0.2.6 → mustrd-0.2.6.2}/mustrd/mustrdTestPlugin.py

@@ -32,7 +32,7 @@ from pytest import Session
 
 from mustrd.TestResult import ResultList, TestResult, get_result_list
 from mustrd.utils import get_mustrd_root
-from mustrd.mustrd import get_triple_store_graph, get_triple_stores
+from mustrd.mustrd import write_result_diff_to_log, get_triple_store_graph, get_triple_stores
 from mustrd.mustrd import Specification, SpecSkipped, validate_specs, get_specs, SpecPassed, run_spec
 from mustrd.namespace import MUST, TRIPLESTORE, MUSTRDTEST
 from typing import Union
@@ -331,4 +331,6 @@ def run_test_spec(test_spec):
     if result_type == SpecSkipped:
         # FIXME: Better exception management
         pytest.skip("Unsupported configuration")
-    return result_type == SpecPassed
+    if result_type != SpecPassed:
+        write_result_diff_to_log(result)
+    return result_type == SpecPassed

{mustrd-0.2.6 → mustrd-0.2.6.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mustrd"
-version = "0.2.6"
+version = "0.2.6.2"
 description = "A Spec By Example framework for RDF and SPARQL, Inspired by Cucumber."
 authors = ["John Placek <john.placek@semanticpartners.com>",
     "Juliane Piñeiro-Winkler <juliane.pineiro-winkler@semanticpartners.com>",