Skip to main content

A Spec By Example framework for RDF and SPARQL, Inspired by Cucumber.

Project description

mustrd

coverage badge

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 to 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 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, or mustrd@semanticpartners.com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mustrd-0.2.6.tar.gz (37.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mustrd-0.2.6-py3-none-any.whl (49.5 kB view details)

Uploaded Python 3

File details

Details for the file mustrd-0.2.6.tar.gz.

File metadata

  • Download URL: mustrd-0.2.6.tar.gz
  • Upload date:
  • Size: 37.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.7 Darwin/23.6.0

File hashes

Hashes for mustrd-0.2.6.tar.gz
Algorithm Hash digest
SHA256 0270a35211118c6418048f19e83e776f17f5d9c646f5138d515bc213a323fe52
MD5 8a3d3bebc9d31ddc884a7cd1297be3be
BLAKE2b-256 ad7305dc1d9deddb8a575eae15ec12b38d0039647e8155224d1501056a7828d8

See more details on using hashes here.

File details

Details for the file mustrd-0.2.6-py3-none-any.whl.

File metadata

  • Download URL: mustrd-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 49.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.7 Darwin/23.6.0

File hashes

Hashes for mustrd-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 cc3dcc33626d88179151121448831c6e817fa8fef6b7c9e78a6141056d9ff82d
MD5 052fe7c727caf2c133402e099d525851
BLAKE2b-256 99a44159ac3505be03c1e0d700648914bd7898df8ece4e3b28eb8faecc34ef92

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page