jest-rdf

Jest test utilities for RDFJS, including several new matchers.

Installation

$ yarn install --save-dev jest-rdf

Configuration

In order to use matchers in your tests, you'll have to make sure that they are imported. This can be done by adding the following entry to your Jest configuration:

"jest": {
  "setupFilesAfterEnv": [ "jest-rdf" ]
}

If you are already using an existing test framework script file, make sure to add jest-rdf as follows to your file:

...
require('jest-rdf');

Optional: Typescript typings configuration

If you are using TypeScript, possibly in combination with ts-jest, you will need to import the typings of this package to make the TS compiler recognise the new matchers.

For this, include the following import at the top of each applicable test file:

import "jest-rdf";

API

toBeRdfIsomorphic

Check if two RDF graphs are isomorphic. An RDF graph is represented as an iterable of quads where the order of quads is not important.

const g1 = [
  quad(blankNode('b1'), namedNode('p1'), namedNode('o1'), namedNode('g1')),
  quad(blankNode('b1'), namedNode('p2'), namedNode('o2'), namedNode('g2')),
];
const g2 = [
  quad(blankNode('b2'), namedNode('p2'), namedNode('o2'), namedNode('g2')),
  quad(blankNode('b2'), namedNode('p1'), namedNode('o1'), namedNode('g1')),
];
expect(g1).toBeRdfIsomorphic(g2);
expect(dataset(g1)).toBeRdfIsomorphic(dataset(g2));

Also supports nested quads:

const g1 = [
  quad(quad(blankNode('b1'), namedNode('p1'), namedNode('o1'), namedNode('g1')), namedNode('p1'), namedNode('o1'), namedNode('g1')),
  quad(blankNode('b1'), namedNode('p2'), namedNode('o2'), namedNode('g2')),
];
const g2 = [
  quad(quad(blankNode('b2'), namedNode('p2'), namedNode('o2'), namedNode('g2')), namedNode('p2'), namedNode('o2'), namedNode('g2')),
  quad(blankNode('b2'), namedNode('p1'), namedNode('o1'), namedNode('g1')),
];
expect(g1).toBeRdfIsomorphic(g2);
expect(dataset(g1)).toBeRdfIsomorphic(dataset(g2));

toEqualRdfQuad

Check if two RDF Quads are equal.

Terms are compared under the semantics of toEqualRdfTerm.

const q1 = quad(namedNode('s1'), namedNode('p1'), namedNode('o1'), namedNode('g1'));
const q2 = quad(namedNode('s2'), namedNode('p2'), namedNode('o2'), namedNode('g2'));
expect(q1).toEqualRdfQuad(q2);

toEqualRdfQuadArray

Check if two RDF Quad arrays are equal.

Quads are compared under the semantics of toEqualRdfQuad.

const q1 = quad(namedNode('s1'), namedNode('p1'), namedNode('o1'), namedNode('g1'));
const q2 = quad(namedNode('s2'), namedNode('p2'), namedNode('o2'), namedNode('g2'));
expect([q1]).toEqualRdfQuadArray([q2]);

toEqualRdfTerm

Check if two RDF Terms are equal.

Blank nodes are always considered equal.

expect(namedNode('t1')).toEqualRdfTerm(namedNode('t2'));

toEqualRdfTermArray

Check if two RDF Term arrays are equal.

Terms are compared under the semantics of toEqualRdfTerm.

expect([namedNode('t1'), namedNode('t2')]).toEqualRdfTermArray([namedNode('t2'), namedNode('t3')]);

toBeRdfDatasetContaining

Check if a dataset contains all of the given quads.

const q1 = quad(namedNode('s1'), namedNode('p1'), namedNode('o1'), namedNode('g1'));
const q2 = quad(namedNode('s2'), namedNode('p2'), namedNode('o2'), namedNode('g2'));
const d = dataset([q1, q2]);
expect(d).toBeRdfDatasetContaining(q1);
expect(d).toBeRdfDatasetContaining(q1, q2);

toBeRdfDatasetMatching

Check if a dataset contains exactly the given amount of matching quads (default 1).

const q1 = quad(namedNode('s'), namedNode('p1'), namedNode('o1'), namedNode('g1'));
const q2 = quad(namedNode('s'), namedNode('p2'), namedNode('o2'), namedNode('g2'));
const d = dataset([q1, q2]);
expect(d).toBeRdfDatasetMatching({ subject: namedNode('s'), predicate: namedNode('p1') });
expect(d).toBeRdfDatasetMatching({ subject: namedNode('s') }, 2);

toBeRdfDatasetOfSize

Check if a dataset contains exactly the given amount of quads.

const q = quad(namedNode('s1'), namedNode('p1'), namedNode('o1'), namedNode('g1'));
const d = dataset([q]);
expect(d).toBeRdfDatasetOfSize(1);

License

This software is written by Ruben Taelman.

This code is released under the MIT license.

NSeydoux/jest-rdf