mustrd 0.1.0__py3-none-any.whl

src/namespace.py

@@ -0,0 +1,118 @@
+"""
+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.
+"""
+
+from rdflib import URIRef
+from rdflib.namespace import DefinedNamespace, Namespace
+
+
+class MUST(DefinedNamespace):
+    _NS = Namespace("https://mustrd.com/model/")
+
+    # test configuration
+    TestConfig: URIRef
+    hasTestFunction: URIRef
+    hasSpecPath: URIRef
+    hasDataPath: URIRef
+    triplestoreSpecPath: URIRef
+    filterOnTripleStore: URIRef
+
+    # Specification classes
+    TestSpec: URIRef
+    SelectSparql: URIRef
+    ConstructSparql: URIRef
+    UpdateSparql: URIRef
+    AnzoQueryDrivenUpdateSparql: URIRef
+    AskSparql: URIRef
+    DescribeSparql: URIRef
+
+    # Specification properties
+    given: URIRef
+    when: URIRef
+    then: URIRef
+    inputGraph: URIRef 
+    outputGraph: URIRef # anzo specials? 
+    dataSource: URIRef
+    file: URIRef
+    fileName: URIRef
+    queryFolder: URIRef
+    queryName: URIRef
+    dataSourceUrl: URIRef
+    queryText: URIRef
+    queryType: URIRef
+    hasStatement: URIRef
+    hasRow: URIRef
+    hasBinding: URIRef
+    variable: URIRef
+    boundValue: URIRef
+    focus:URIRef
+
+    # Specification data sources
+    TableDataset: URIRef
+    StatementsDataset: URIRef
+    FileDataset: URIRef
+    HttpDataset: URIRef
+    TextSparqlSource: URIRef
+    FileSparqlSource: URIRef
+    FolderSparqlSource: URIRef
+    FolderDataset: URIRef
+    EmptyGraph: URIRef
+    EmptyTable: URIRef
+    InheritedDataset: URIRef
+
+    # runner uris
+    fileSource: URIRef
+    loadedFromFile: URIRef
+    specSourceFile: URIRef
+
+    # Triple store config parameters
+    url: URIRef
+    port: URIRef
+    username: URIRef
+    password: URIRef
+    inputGraph: URIRef
+    repository: URIRef
+
+    # RDFLib
+    RdfLib: URIRef
+    RdfLibConfig: URIRef
+
+    # Anzo
+    Anzo: URIRef
+    AnzoConfig: URIRef
+    AnzoGraphmartDataset: URIRef
+    AnzoQueryBuilderSparqlSource: URIRef
+    AnzoGraphmartStepSparqlSource: URIRef
+    AnzoGraphmartLayerSparqlSource: URIRef
+    AnzoGraphmartQueryDrivenTemplatedStepSparqlSource: URIRef
+    anzoQueryStep: URIRef
+    anzoGraphmartLayer: URIRef
+
+    
+    graphmart: URIRef
+    layer: URIRef
+    gqeURI: URIRef
+
+    # GraphDb
+    GraphDb: URIRef
+    GraphDbConfig: URIRef

src/plugin.py

@@ -0,0 +1,56 @@
+from typing import Dict
+from mustrdTestPlugin import MustrdTestPlugin, TestConfig
+from utils import get_project_root
+from rdflib import RDF, Graph
+from namespace import MUST
+from collections import defaultdict
+
+project_root = get_project_root()
+
+
+def pytest_addoption(parser):
+    group = parser.getgroup("md summary")
+    group.addoption(
+        "--md",
+        action="store",
+        dest="mdpath",
+        metavar="path",
+        default=None,
+        help="create md summary file at that path.",
+    )
+    group.addoption(
+        "--config",
+        action="store",
+        dest="configpath",
+        metavar="path",
+        default=None,
+        required=True,
+        help="Ttl file containing the list of test to construct.",
+    )
+    return
+
+
+def pytest_configure(config) -> None:
+
+    # Read configuration file
+    test_configs: Dict[str, TestConfig] = defaultdict(lambda: defaultdict(list))
+    config_graph = Graph().parse(project_root / config.getoption("configpath"))
+    for test_config_subject in config_graph.subjects(predicate=RDF.type, object=MUST.TestConfig):
+        test_function = get_config_param(config_graph, test_config_subject, MUST.hasTestFunction, str)
+        spec_path = get_config_param(config_graph, test_config_subject, MUST.hasSpecPath, str)
+        data_path = get_config_param(config_graph, test_config_subject, MUST.hasDataPath, str)
+        triplestore_spec_path = get_config_param(config_graph, test_config_subject, MUST.triplestoreSpecPath, str)
+        filter_on_tripleStore = list(config_graph.objects(subject=test_config_subject,
+                                                          predicate=MUST.filterOnTripleStore))
+
+        test_configs[test_function] = TestConfig(test_function=test_function,
+                                                 spec_path=spec_path, data_path=data_path,
+                                                 triplestore_spec_path=triplestore_spec_path,
+                                                 filter_on_tripleStore=filter_on_tripleStore)
+
+    config.pluginmanager.register(MustrdTestPlugin(config.getoption("mdpath"), test_configs))
+
+
+def get_config_param(config_graph, config_subject, config_param, convert_function):
+    raw_value = config_graph.value(subject=config_subject, predicate=config_param, any=True)
+    return convert_function(raw_value) if raw_value else None

src/run.py

@@ -0,0 +1,106 @@
+"""
+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 argparse
+import logger_setup
+import sys
+import os
+from rdflib import Graph
+from mustrd import get_triple_store_graph, run_specs, get_triple_stores, review_results, validate_specs, get_specs
+from pathlib import Path
+from namespace import MUST
+from utils import get_project_root
+import logging 
+log = logger_setup.setup_logger(__name__)
+
+
+def parse_args() -> argparse.Namespace:
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-p", "--put", help="Path under test - required", required=True)
+    parser.add_argument("-v", "--verbose", help="verbose logging", action='store_true')
+    parser.add_argument("-c", "--config", help="Path to triple store configuration", default=None)
+    parser.add_argument("-d", "--data", help="Path to test data", default=None)
+    parser.add_argument("-g", "--given", help="Override path for given files", default=None)
+    parser.add_argument("-w", "--when", help="Override path for when files", default=None)
+    parser.add_argument("-t", "--then", help="Override path for then files", default=None)
+
+    return parser.parse_args()
+
+
+# https://github.com/Semantic-partners/mustrd/issues/108
+def main(argv):
+    #given_path = when_path = then_path = None
+    project_root = get_project_root()
+    run_config = {}
+    args = parse_args()
+    run_config["spec_path"] = Path(args.put)
+    log.info(f"Path under test is { run_config['spec_path']}")
+
+    verbose = args.verbose
+    if verbose:
+        log.info(f"Verbose set")
+        run_config["verbose"] = True
+
+    if args.config:
+        triplestore_spec_path = Path(args.config)
+        log.info(f"Path for triple store configuration is {triplestore_spec_path}")
+        triple_stores = get_triple_stores(get_triple_store_graph(triplestore_spec_path))
+    else:
+        log.info(f"No triple store configuration added, running default configuration")
+        triple_stores = [{'type': MUST.RdfLib}]
+    log.info("Triple Stores: " + str(triple_stores))
+    if args.data:
+        run_config["data_path"] = Path(args.data)
+    else:
+        run_config["data_path"] = Path(args.put)
+    log.info(f"Path for test data folder is {run_config['data_path']}")
+
+    if args.given:
+        run_config["given_path"] = Path(args.given)
+        log.info(f"Path for given folder is {run_config['given_path']}")
+
+    if args.when:
+        run_config["when_path"] = Path(args.when)
+        log.info(f"Path for when folder is {run_config['when_path']}")
+
+    if args.then:
+        run_config["then_path"] = Path(args.then)
+        log.info(f"Path for then folder is {run_config['then_path']}")
+
+    shacl_graph = Graph().parse(Path(os.path.join(project_root, "model/mustrdShapes.ttl")))
+    ont_graph = Graph().parse(Path(os.path.join(project_root, "model/ontology.ttl")))
+
+    valid_spec_uris, spec_graph, invalid_spec_results = \
+        validate_specs(run_config, triple_stores, shacl_graph, ont_graph)
+
+    specs, skipped_spec_results = \
+        get_specs(valid_spec_uris, spec_graph, triple_stores, run_config)
+
+    results = invalid_spec_results + skipped_spec_results + run_specs(specs)
+
+    review_results(results, verbose)
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])