mustrd 0.2.0__py3-none-any.whl → 0.2.0a1__py3-none-any.whl

mustrd/steprunner.py

@@ -1,166 +0,0 @@
-"""
-MIT License
-
-Copyright (c) 2023 Semantic Partners Ltd
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-"""
-
-import json
-
-from . import logger_setup
-from multimethods import MultiMethod, Default
-from .namespace import MUST, TRIPLESTORE
-from rdflib import Graph, URIRef
-from .mustrdRdfLib import execute_select as execute_select_rdflib
-from .mustrdRdfLib import execute_construct as execute_construct_rdflib
-from .mustrdRdfLib import execute_update as execute_update_rdflib
-from .mustrdAnzo import upload_given as upload_given_anzo
-from .mustrdAnzo import execute_update as execute_update_anzo
-from .mustrdAnzo import execute_construct as execute_construct_anzo
-from .mustrdAnzo import execute_select as execute_select_anzo
-from .mustrdGraphDb import upload_given as upload_given_graphdb
-from .mustrdGraphDb import execute_update as execute_update_graphdb
-from .mustrdGraphDb import execute_construct as execute_construct_graphdb
-from .mustrdGraphDb import execute_select as execute_select_graphdb
-from .spec_component import AnzoWhenSpec, WhenSpec
-
-log = logger_setup.setup_logger(__name__)
-
-
-def dispatch_upload_given(triple_store: dict, given: Graph):
-    ts = triple_store['type']
-    log.info(f"dispatch_upload_given to {ts}")
-    return ts
-
-
-upload_given = MultiMethod('upload_given', dispatch_upload_given)
-
-
-@upload_given.method(TRIPLESTORE.RdfLib)
-def _upload_given_rdflib(triple_store: dict, given: Graph):
-    triple_store["given"] = given
-
-
-@upload_given.method(TRIPLESTORE.GraphDb)
-def _upload_given_graphdb(triple_store: dict, given: Graph):
-    upload_given_graphdb(triple_store, given)
-
-
-@upload_given.method(TRIPLESTORE.Anzo)
-def _upload_given_anzo(triple_store: dict, given: Graph):
-    upload_given_anzo(triple_store, given)
-
-
-def dispatch_run_when(spec_uri: URIRef, triple_store: dict, when: WhenSpec):
-    ts = triple_store['type']
-    query_type = when.queryType
-    log.info(f"dispatch_run_when to SPARQL type {query_type} to {ts}")
-    return ts, query_type
-
-
-run_when = MultiMethod('run_when', dispatch_run_when)
-
-
-@run_when.method((TRIPLESTORE.Anzo, MUST.UpdateSparql))
-def _anzo_run_when_update(spec_uri: URIRef, triple_store: dict, when: AnzoWhenSpec):
-    return execute_update_anzo(triple_store, when.value, when.bindings)
-
-
-@run_when.method((TRIPLESTORE.Anzo, MUST.ConstructSparql))
-def _anzo_run_when_construct(spec_uri: URIRef, triple_store: dict, when: AnzoWhenSpec):
-    return execute_construct_anzo(triple_store, when.value, when.bindings)
-
-
-@run_when.method((TRIPLESTORE.Anzo, MUST.SelectSparql))
-def _anzo_run_when_select(spec_uri: URIRef, triple_store: dict, when: AnzoWhenSpec):
-    return execute_select_anzo(triple_store, when.value, when.bindings)
-
-
-@run_when.method((TRIPLESTORE.GraphDb, MUST.UpdateSparql))
-def _graphdb_run_when_update(spec_uri: URIRef, triple_store: dict, when: WhenSpec):
-    return execute_update_graphdb(triple_store, when.value, when.bindings)
-
-
-@run_when.method((TRIPLESTORE.GraphDb, MUST.ConstructSparql))
-def _graphdb_run_when_construct(spec_uri: URIRef, triple_store: dict, when: WhenSpec):
-    return execute_construct_graphdb(triple_store, when.value, when.bindings)
-
-
-@run_when.method((TRIPLESTORE.GraphDb, MUST.SelectSparql))
-def _graphdb_run_when_select(spec_uri: URIRef, triple_store: dict, when: WhenSpec):
-    return execute_select_graphdb(triple_store, when.value, when.bindings)
-
-
-@run_when.method((TRIPLESTORE.RdfLib, MUST.UpdateSparql))
-def _rdflib_run_when_update(spec_uri: URIRef, triple_store: dict, when: WhenSpec):
-    return execute_update_rdflib(triple_store, triple_store["given"], when.value, when.bindings)
-
-
-@run_when.method((TRIPLESTORE.RdfLib, MUST.ConstructSparql))
-def _rdflib_run_when_construct(spec_uri: URIRef, triple_store: dict, when: WhenSpec):
-    return execute_construct_rdflib(triple_store, triple_store["given"], when.value, when.bindings)
-
-
-@run_when.method((TRIPLESTORE.RdfLib, MUST.SelectSparql))
-def _rdflib_run_when_select(spec_uri: URIRef, triple_store: dict, when: WhenSpec):
-    return execute_select_rdflib(triple_store, triple_store["given"], when.value, when.bindings)
-
-
-@run_when.method((TRIPLESTORE.Anzo, MUST.AnzoQueryDrivenUpdateSparql))
-def _multi_run_when_anzo_query_driven_update(spec_uri: URIRef, triple_store: dict, when: AnzoWhenSpec):
-    # run the parameters query to obtain the values for the template step and put them into a dictionary
-    query_parameters = json.loads(execute_select_anzo(triple_store, when.paramQuery, None))
-    if len(query_parameters['results']['bindings']) > 0:
-        # replace the anzo query placeholders with the input and output graphs
-        when_template = when.queryTemplate.replace(
-            "${usingSources}",
-            f"USING <{triple_store['input_graph']}> \nUSING <{triple_store['output_graph']}>").replace(
-            "${targetGraph}", f"<{triple_store['output_graph']}>")
-
-        # for each set of parameters insert their values into the template an run it
-        for params in query_parameters['results']['bindings']:
-            when_query = when_template
-            for param in params:
-                if params[param].get('datatype'):
-                    value = params[param]['value']
-                else:
-                    if params[param]['type'] == 'uri':
-                        value = '<' + params[param]['value'] + '>'
-                    else:
-                        value = '"' + params[param]['value'] + '"'
-                when_query = when_query.replace("${" + param + "}", value)
-            result = execute_update_anzo(triple_store, when_query, None)
-        return result
-
-
-@run_when.method(Default)
-def _multi_run_when_default(spec_uri: URIRef, triple_store: dict, when: WhenSpec):
-    if when.queryType == MUST.AskSparql:
-        log.warning(f"Skipping {spec_uri}, SPARQL ASK not implemented.")
-        msg = "SPARQL ASK not implemented."
-    elif when.queryType == MUST.DescribeSparql:
-        log.warning(f"Skipping {spec_uri}, SPARQL DESCRIBE not implemented.")
-        msg = "SPARQL DESCRIBE not implemented."
-    elif triple_store['type'] not in [TRIPLESTORE.Anzo, TRIPLESTORE.GraphDb, TRIPLESTORE.RdfLib]:
-        msg = f"{when.queryType} not implemented for {triple_store['type']}"
-    else:
-        log.warning(f"Skipping {spec_uri},  {when.queryType} is not a valid SPARQL query type.")
-        msg = f"{when.queryType} is not a valid SPARQL query type."
-    raise NotImplementedError(msg)

mustrd/templates/md_ResultList_leaf_template.jinja

@@ -1,19 +0,0 @@
-<table class="table">
-    <thead>
-        <tr>
-            <th scope="col">module</th>
-            <th scope="col">class</th>
-            <th scope="col">test</th>
-            <th scope="col">status</th>
-        <tr>
-    </thead>
-    <tbody>
-    {% for  result in result_list -%}
-        <tr>
-            <td>{{result.module_name}}</td>
-            <td>{{result.class_name}}</td>
-            <td>{{result.test_name}}</td>
-            <td>{{result.status}}</td>
-        </tr>
-    {% endfor %}</tbody>
-</table>

mustrd/templates/md_ResultList_template.jinja

@@ -1,9 +0,0 @@
-
-{% for  result in result_list %}
-<details>
-{{environment.get_template("md_stats_template.jinja").render(name = result.name, stats = result.stats)}}
-<ul>
-{{result.render()}}
-</ul>
-</details>
-{% endfor %}

mustrd/templates/md_stats_template.jinja

@@ -1,3 +0,0 @@
-<summary>
-{{name}}: <br/> total: {{stats.count}}, success: {{stats.success_count}}, fail: {{stats.fail_count}}, skipped: {{stats.skipped_count}}
-</summary>

mustrd/test/test_mustrd.py

@@ -1,5 +0,0 @@
-from mustrd.mustrdTestPlugin import run_test_spec
-
-
-def test_unit(unit_tests):
-    assert run_test_spec(unit_tests.unit_test)

mustrd-0.2.0.dist-info/METADATA

@@ -1,97 +0,0 @@
-Metadata-Version: 2.1
-Name: mustrd
-Version: 0.2.0
-Summary: A Spec By Example framework for RDF and SPARQL, Inspired by Cucumber.
-Home-page: https://github.com/Semantic-partners/mustrd
-License: MIT
-Author: John Placek
-Author-email: john.placek@semanticpartners.com
-Requires-Python: ==3.11.7
-Classifier: Framework :: Pytest
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: English
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Software Development :: Quality Assurance
-Classifier: Topic :: Software Development :: Testing
-Classifier: Topic :: Utilities
-Requires-Dist: Jinja2 (==3.1.3)
-Requires-Dist: beautifulsoup4 (>=4.11.1,<5.0.0)
-Requires-Dist: colorama (==0.4.6)
-Requires-Dist: colorlog (>=6.7.0,<7.0.0)
-Requires-Dist: coverage (==7.4.3)
-Requires-Dist: flake8 (==7.0.0)
-Requires-Dist: multimethods-py (>=0.5.3,<0.6.0)
-Requires-Dist: openpyxl (>=3.1.2,<4.0.0)
-Requires-Dist: pandas (>=1.5.2,<2.0.0)
-Requires-Dist: pyanzo (>=3.3.10,<4.0.0)
-Requires-Dist: pyshacl (>=0.23.0,<0.24.0)
-Requires-Dist: pytest (>=7.2.0,<8.0.0)
-Requires-Dist: rdflib (>=6.3.2,<7.0.0)
-Requires-Dist: requests (>=2.28.2,<3.0.0)
-Requires-Dist: tabulate (>=0.9.0,<0.10.0)
-Requires-Dist: toml (>=0.10.2,<0.11.0)
-Requires-Dist: tomli (>=2.0.1,<3.0.0)
-Requires-Dist: urllib3 (==1.26.15)
-Project-URL: Repository, https://github.com/Semantic-partners/mustrd
-Description-Content-Type: text/plain
-
-== Mustrd
-
-// tag::body[]
-
-image::https://github.com/Semantic-partners/mustrd/raw/python-coverage-comment-action-data/badge.svg[Coverage badge,link="https://github.com/Semantic-partners/mustrd/tree/python-coverage-comment-action-data"]
-
-=== Why?
-
-How do you know your SPARQL, whether it's in a pipeline, or a query, is doing what you intend? 
-
-As much as we love RDF and SPARQL and Semantic Tech in general, we found a small gap in tooling which would give us that certainty. 
-
-We missed the powerful testing frameworks that have evolved in imperative languages that help ensure you've written code that does what you think it should. 
-
-We wanted to be able to:
-
-* setup data scenarios and ensure queries worked as expected
-* setup edge cases for queries and ensure they still work
-* isolate small sparql enrichment / transformation steps and to know we're only INSERTing what we intend
-
-Enter MustRD. 
-
-=== What?
-
-MustRD is a Spec-By-Example ontology, with a reference python implementation, inspired by the likes of Cucumber. 
-
-It's designed to be triplestore/SPARQL engine agnostic (aren't open standards *wonderful*!). 
-
-=== What it is NOT
-MustRD is nothing to do with SHACL, or an alternative to it. In fact, we use SHACL for some of our features. 
-
-SHACL provides validation around data. 
-
-MustRD provides validation around data transformations. 
-
-=== How?
-You define your specs in ttl, or trig files. 
-We use the SBE approach of *Given*, *When*, *Then* to define starting dataset, an action, and a set of expectations. We build up a set of data. 
-Then, depending on whether your SPARQL is a CONSTRUCT, SELECT or a INSERT/DELETE, we run it, and compare results against a set of expectations (*Then*) that are defined in the same way as a *Given* .
-Alternatively, you could define your *Then*
-
-* as an explicit ASK, or
-* select; or 
-* in a higher-order expectation language like you will be used to in various platforms, a set of expectations.
-
-
-=== When?
-
-Soon. It's a work in progress, and we're building the things *we* need for the projects we work on at multiple clients, with multiple vendor stacks. 
-We already think it's useful, but it might not meet *your* needs, out of the box. 
-
-We invite you to try it, see where it doesn't fit, and raise an issue, or even better, a PR! If you need something custom, please check out our consultancy rates, and we might be able to prioritise a new feature for you.
-
-== Support
-We're a specialist consultancy in Semantic Tech, we're putting this out in case it's useful, but if you need more support, kindly contact our business team on info@semanticpartners.com
-
-// tag::body[]
-include::src/README.adoc[tags=body]
-

mustrd-0.2.0.dist-info/RECORD

@@ -1,32 +0,0 @@
-mustrd/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mustrd/logger_setup.py,sha256=AXTXiiyQ4E_SyqNaKlLsZlkkKr_YJfJZ0N4PEoN7d7E,1630
-mustrd/model/catalog-v001.xml,sha256=jgD6VOxR6A8izzr3ZmL4AzaTZ5cVwsvt618MTuRlGBk,386
-mustrd/model/mustrdShapes.ttl,sha256=BR-9fAwGpQt6glfPpDB0Xx3vFXMt_UTQwi469o6aWUo,9709
-mustrd/model/mustrdTestOntology.ttl,sha256=W7IRbPKrhpYFweZvc9QH8gdjBiuZMHKETIuHBepLnYw,2034
-mustrd/model/mustrdTestShapes.ttl,sha256=Bcof6p7MtzO2L6H1DWB1hibLSix7Dxo-z6HlFcG31M8,842
-mustrd/model/ontology.ttl,sha256=JF6LG5-T7tbi3QfmJcEFQcFo-rQT0CTYGg7PEmuzINY,17303
-mustrd/model/test-resources/resources.ttl,sha256=7z1P4qJwuqRdmHzKd_mhnUIs-aQoSQxas7yDCwKYarc,1558
-mustrd/model/triplestoreOntology.ttl,sha256=87leTcKot45AgcCGfJLEwbY9rsuRGHbYbnTFeijrzOk,6199
-mustrd/model/triplestoreshapes.ttl,sha256=qiLzbclGDzueH5GCKANEwMM9VxOmswu42FiSnITATeQ,1876
-mustrd/mustrd.py,sha256=H-j5s3qQmcmJ9g39Q9z5z075HJ5iMapM8OcY8HgcwJs,35081
-mustrd/mustrdAnzo.py,sha256=yGoNf93n9MeKMqef8H0qm-1HKvnKm1PO-spekATL6XM,10632
-mustrd/mustrdGraphDb.py,sha256=KNXXYyZjYm_IZaeuuxlPBP-XyX9hZ5UvrdxshKnZhwo,5599
-mustrd/mustrdQueryProcessor.py,sha256=fpEzD0R7rGy2ktOBSiUpNGevxMSVJxKfxnR3BAg4yRk,6357
-mustrd/mustrdRdfLib.py,sha256=LeS-uArlxQwsM-7lrJyp8O8m-6VgxsR1BlpxsOCNePs,2129
-mustrd/mustrdTestPlugin.py,sha256=SsTkwrs0n1lvHvuiyQs-z4dsXnjB7p3d6aFWR8_jLV8,15035
-mustrd/namespace.py,sha256=3zJbdWEji_2SkhasHK3J2UO3am_phNKDwAFk2htXRYM,3765
-mustrd/README.adoc,sha256=y6tY7YDFB6f-vICYJyPN8n615BKLm49lRqqWFWiqrzg,12620
-mustrd/run.py,sha256=r3FS_iAuXYpENbbrLfgymGUP4dx-ZGJ_Y2ZvnZdL9dg,4380
-mustrd/spec_component.py,sha256=bmfHGE_8uy9yIcbvflWnhEeCW9SCbw86k0E22GQAelk,33304
-mustrd/steprunner.py,sha256=n3k4O2SjsLUEG5QOxLG8Z8D3iH9PJzzR63dIV2KHcBE,7555
-mustrd/templates/md_ResultList_leaf_template.jinja,sha256=un1XMeNO9xLcry-DmTQ2QoWoTM5Q5CkVUV_LS4O7sHM,526
-mustrd/templates/md_ResultList_template.jinja,sha256=RrTaPN1obsTEpG5BjQp7BV9iBFzZOXHwslgvyC0hDKY,211
-mustrd/templates/md_stats_template.jinja,sha256=DlNfH9eoEFVHQmvp6QNbQv36cqRLyBkqG1ITOHb_Yu8,157
-mustrd/test/test_mustrd.py,sha256=Q2qTTY--I0wfhgHW7hnkIoV3t_sUTXm8xMmirJaFc7o,129
-mustrd/TestResult.py,sha256=q5BnvRxhfCEEY062rHasnA61AeKR4oXXs5z8lASvx1o,4986
-mustrd/utils.py,sha256=fuvdLE20MdkJtY5atBiU8-u7sVcq1mzIYF0gTcw1UMk,1424
-mustrd-0.2.0.dist-info/entry_points.txt,sha256=v7V7sN0_L1aB4Ug_9io5axlQSeJ1C0tNrQWwdXdV58s,50
-mustrd-0.2.0.dist-info/LICENSE,sha256=OwjAcbL4HsENdMen1iYR23HH7OEn899oCt100xUo0Zo,1099
-mustrd-0.2.0.dist-info/METADATA,sha256=0_uSxV7kB9BlUOd14aTILn9waE18kPWVueSPzjFp8-I,4130
-mustrd-0.2.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-mustrd-0.2.0.dist-info/RECORD,,

mustrd-0.2.0.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[pytest11]
-mustrd_plugin=mustrd.mustrdTestPlugin
-